Introduction

Welcome! This is the API reference for the NetFoundry Network Management Service (v2), a lexicon of all possible API operations and their parameters. More conceptually and procedurally oriented guides and code samples may be found by visiting the Developer Portal.

Overview

HTTP verbs

NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP verbs.

Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT

Used to update an existing resource, full updates only

PATCH

Used to update an existing resource, partial updates

DELETE

Used to delete an existing resource

HTTP status codes

NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP status codes.

Status code Usage

200 OK

The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.

201 Created

The request has been fulfilled and resulted in a new resource being created.

202 Accepted

The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services.

204 No Content

The server successfully processed the request, but is not returning any content.

400 Bad Request

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401 Unauthorized

The request lacks valid authentication credentials for the target resource.

403 Forbidden

The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource.

404 Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

Pagination

Paginated services will accept the following optional request parameters:

Table 1. Request parameters
Path Type Optional Description

page

Integer

true

Page you want to retrieve, 0 indexed and defaults to 0.

size

Integer

true

Size of the page you want to retrieve, defaults to 1000.

sort

String

true

Sort a list of resources by one or more of their properties e.g. ?sort=firstname,asc&sort=lastname,desc. The default order is asc.

Pagination response has following structure:

Table 2. Response structure
Path Type Optional Description

content

Array[Object]

false

Actual items.

totalElements

Integer

false

Total count.

totalPages

Integer

false

Total pages with current page size.

last

Boolean

false

If this page is the last one.

numberOfElements

Integer

false

Actual size of content array (number of items).

first

Boolean

false

If this page is the first one.

sort

Object

true

Sort information object.

size

Integer

false

Requested size of the page.

number

Integer

false

Page number.

empty

booloean

false

If this page is empty.

Content Types

You may request a content type or alternative representation or both for a resource or list of resources with the Accept header.

Request a Content Type

The default content type of a response is HAL+JSON when the Accept header is absent from the request. A table describing available types is below. Here’s an example of requesting a particular endpoint by ID as YAML.

Request
GET /core/v2/endpoints/{{endpointId}} HTTP/1.1
Accept: application/x-yaml
Response
id: "273a915a-50e4-4994-891e-56a33ce6449e"
ownerIdentityId: "6526771d-d0b4-4325-835a-b57caaa698dd"
createdBy: "6526771d-d0b4-4325-835a-b57caaa698dd"
createdAt:
  nano: 448425000
  epochSecond: 1616076528
updatedAt:
  nano: 661920000
  epochSecond: 1623109454
deletedBy: null
deletedAt: null
networkId: "5611d56c-cb91-4b8f-b658-9e066092ff0a"
zitiId: "uIWXyl94U"
name: "ACME Endpoint1"
typeId: "5b53fb49-51b1-4a87-a4e4-edda9716a970"
appId: null
appVersion: null
branch: "main"
revision: "80ece9482fdd"
type: "ziti-sdk-golang"
version: "v0.15.13"
arch: "amd64"
os: "darwin"
osRelease: "17.7.0"
osVersion: "Darwin Kernel Version 17.7.0: Thu Jun 21 22:53:14 PDT 2018; root:xnu-4570.71.2~1/RELEASE_X86_64"
hasApiSession: false
hasEdgeRouterConnection: false
sessionIdentityId: null
syncId: null
syncResourceId: null
attributes:
  - "#workFromAnywhere"
sessionActive: true
jwt: null
mfaEnabled: false
jwtExpiresAt: null
Notation MIME Type Description

HAL+JSON (default)

application/hal+json

If you request a single resource by ID then the top level of the response will describe that resource and have _links to related resources.

If you request a list of resources then response will have _embedded.{{type}}List where {{type}} is the type of resource e.g. endpointList and _links to resources that are related to the list, and each element will have _links to resources related to that individual resource. If there’s not at least one resource in the list, or when then the key _embedded will not be present.

JSON

application/json

Single resource: response is a JSON dictionary describing the resource

List of resources: response is a JSON list where each element describes an indivual resource.

YAML

application/x-yaml

Single resource: response is a YAML dictionary describing the resource

List of resources: response is a YAML list where each element describes an indivual resource.

CSV

text/csv

Comma-separated format where the first line is composed of column headers and subsequent lines each represent one resource.

Request a Representation

A representation is a way of filtering and transforming the properties that are returned for each resource. The default representation includes all resource properties. There is one alternative representation available at this time: the create representation includes only the properties that are necessary to create an identical resource. This is useful for things like as-code snapshots and cloning resources. You may append the as=create parameter to the default MIME type to change only the representation of the resources in the response.

Request
GET /core/v2/endpoints?networkId={{networkId}} HTTP/1.1
Accept:application/hal+json;as=create
Response
{
    "_embedded": {
        "createEndpointList": [
            {
              "name": "ACME Endpoint1",
              "enrollmentMethod": {
                "ott": true,
                "updb": null,
                "ottca": null
              },
              "attributes": [
                "#workFromAnywhere"
              ],
              "_links": {
                "network": {
                  "href": "https://gateway.production.netfoundry.io/core/v2/networks/5611d56c-cb91-4b8f-b658-9e066092ff0a",
                  "title": "ACME Network",
                  "profile": "parent"
                },
                "self": {
                  "href": "https://gateway.production.netfoundry.io/core/v2/endpoints/273a915a-50e4-4994-891e-56a33ce6449e"
                }
              }
            }
        ]
    }
}
Parameter Value Description

as

create

Only return the properties necessary to create the same resource.

Embed Child Resources

When requesting an individual or list of resources you may additionally request child resources be embedded in the response by sending query parameter embed=all or embed={{child}}. The valid names for child resources are the keys in _links, except things that are not children like self, network. The table below details how the format of the embedded lists varies depending upon the requested content-type. Embedding is always one level deep. Put another way, the network is like the trunk which may embed branch lists (e.g. edge routers), and branches may embed individual leaves (e.g. the edge router’s host).

Request

This example requests that the "edge-routers" child resource list be embedded in the response that describes a particular network.

GET /core/v2/networks/${networkId}?embed=edge-routers
Accept: application/hal+json
Response Template

The full response would be prohibitively verbose, and so this template will demonstrate the response structure for a single resource with embedded child list "edge-routers".

{
  {{ network properties }},
  "_embedded": {
    "edge-routers": {{ list of edge routers }}
  },
  "_links": {{ dictionary of related resources}}
}
Request

This example requests the "host" resource be embedded in each element of the list of edge routers

GET /core/v2/edge-routers?networkId=${networkId}&embed=host
Accept: application/hal+json
Response

The full response would be prohibitively verbose, and so this template will demonstrate the response structure for a list of resources with embedded child "host".

{
  "_embedded": {
    "edgeRouterList": [
      {
        {{ edge router 1 properties }},
        "_links": {{ edge router 1 links }},
        "_embedded": {
          "host": {{ edge router 1 host's properties }}
        }
      },
      {
        {{ edge router 2 properties }},
        "_links": {{ edge router 2 links }},
        "_embedded": {
          "host": {{ edge router 2 host's properties }}
        }
      }
    ]
  },
  "_links": {{ edge router list's links }},
  "page": {
    "size": 3500,
    "totalElements": 2,
    "totalPages": 1,
    "number": 0
  }
}
Notation MIME Type Embedded Format

HAL+JSON (default)

application/hal+json

The response has key _embedded which will itself have keys for each type of resource. For example, _embedded.endpoints and _embedded."edge-routers" are typical when requesting an embedded list of endpoints or edge routers for a particular network or list of networks.

JSON

application/json

Each requested, embedded list will appear in a top-level key e.g. .endpoints and ."edge-routers".

YAML

application/x-yaml

Each requested, embedded list will appear in a top-level key where the resource type has been transposed from kebab-case to camel-case e.g. edge-routers becomes top-level key edgeRouters.

CSV

text/csv

Heterogeneous embedded resources can not be expressed as CSV because they would require different column headers.

Backup a Network

You may combine techniques above for requesting embedded resources and the as=create representation to backup a network.

Request
GET /core/v2/network/{{networkId}}&embed=all
Accept: application/hal+json;as=create

Authentication

Authentication is delegated to an identity provider e.g. Cognito, Auth0, Okta. Use your API account credential to obtain an access token. Know more by reading the Authentication Guide.

Cognito

Follow this example if your authentication URL is for Amazon Cognito.

NETFOUNDRY_API_TOKEN=$( \ (1)
  curl --user ${NETFOUNDRY_CLIENT_ID}:${NETFOUNDRY_PASSWORD} \ (2)
    --request POST ${NETFOUNDRY_OAUTH_URL} \ (3)
    --header 'content-type: application/x-www-form-urlencoded' \
    --data 'grant_type=client_credentials&scope=https%3A%2F%2Fgateway.production.netfoundry.io%2F%2Fignore-scope' | \
      jq -r .access_token (4)
)
1 creates an environment variable NETFOUNDRY_API_TOKEN to hold the token after successful request. The contents of this variable will be used in all subsequent requests
2 substitute the client ID and password for your API account
3 substitute the authentication URL for your API account
4 extract the access token with jq (command-line JSON processor)

Auth0

Follow this example if your authentication URL is for Auth0.

NETFOUNDRY_API_TOKEN=$( \(1)
  curl \(2)
    --request POST \
    --silent \
    --show-error \
    --header 'content-type: application/json' \
    --data '{
        "client_id":"---redacted----",       (3)
        "client_secret": "---redacted----",  (4)
        "audience":"https://gateway.production.netfoundry.io/",
        "grant_type":"client_credentials"
    }' \
    https://netfoundry-production.auth0.com/oauth/token |\
    jq -r .access_token \(5)
) && echo $NETFOUNDRY_API_TOKEN (6)
1 creates an environment variable NETFOUNDRY_API_TOKEN to hold the token after successful request. The contents of this variable will be used in all subsequent requests
2 this example uses the cURL command to perform the request
3 you will need to insert your actual client ID
4 you will need to insert your actual secret
5 this example uses jq to parse the response from Auth0 and extract the token
6 this line prints the extracted token; it is included for convenience / debugging purposes only

API request using access token

Execute an http request per the example below (e.g. fetch networks). The access token is presented to the API via the Authorization header, which in turn leverages the NETFOUNDRY_API_TOKEN variable used in the previous example to store the extracted access token.

# get networks
curl https://gateway.production.netfoundry.io/core/v2/networks \ (1)
    --header "Authorization: Bearer ${NETFOUNDRY_API_TOKEN}"     (2)
1 the URL used to fetch networks (see also [Listing networks])
2 the Authorization header transmits the Bearer token

Resources

Data Centers

Find Data Centers

GET /data-centers

Authorization

This endpoint requires read action on the data-center resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

hostType

String

true

Must be one of [NC, ER].

productVersion

String

true

provider

String

true

Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCP, CUSTOMER].

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

true

address

String

true

city

String

true

stateCode

String

true

stateName

String

true

continentName

String

true

continentCode

String

true

countryName

String

true

countryCode

String

true

isp

String

true

lat

Decimal

true

lng

Decimal

true

locationCode

String

true

locationName

String

true

provider

String

true

Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCP, CUSTOMER].

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

Path Type Optional Description

id

String

true

address

String

true

city

String

true

stateCode

String

true

stateName

String

true

continentName

String

true

continentCode

String

true

countryName

String

true

countryCode

String

true

isp

String

true

lat

Decimal

true

lng

Decimal

true

locationCode

String

true

locationName

String

true

provider

String

true

Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCP, CUSTOMER].

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/data-centers' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJSMFNkeXJFZnIzWnZjOEJwVHRFeUx3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJjMDU4ODc3LTljOWUtNDAxNC1iMDY1LTJmNTdlZmFkMGI0NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMzMDAwNCwiZXhwIjoxNjI3MzMzNjA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImYxMGZjNTE5LWViOTctNDljYi1hYmMyLWU3OThhMjg3ZDFjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMzMDAwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.qv0nt9KK--X7JgC8lAjTy43nNZRJjlng3OqFtDS1Uat4xwB9q_vJCIAAsjkZe6NomroyXGnEg2Gfblr24ipokfetZJxftK-W5rEH0zg91UHR2rjPZRbTP_DnDzZ0JUtQ3vtTX2S6cNMNS-SNNHybrgxkRM3IGQgx8gK8p8_R0wh1dzLfi4V6fGPu4B2Pdoh8gpgdNd8-k7x6_TggFLk_lUp9TAPpDOJJaAmpoOiN-0C2rNUsnj25Vz9ZrU4WAUKjNbzeiFOS1FQ9ey1fenHQQDTs2G1h69vduKRk_FPiPUKe5osV0pKNsfWZTINgxey-eUX533EWQiRU2gaEFIEDyw'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 872

{
  "_embedded" : {
    "dataCenters" : [ {
      "id" : "c06c5d5b-85cb-438a-b135-86a764f1fb8f",
      "address" : null,
      "city" : null,
      "stateCode" : null,
      "stateName" : null,
      "continentName" : null,
      "continentCode" : null,
      "countryName" : null,
      "countryCode" : null,
      "isp" : null,
      "lat" : null,
      "lng" : null,
      "locationCode" : "us-east4-a",
      "locationName" : null,
      "provider" : "GCP",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/data-centers/c06c5d5b-85cb-438a-b135-86a764f1fb8f"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/data-centers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Network Configurations

Find Network Config Metadata

GET /network-configs

Authorization

This endpoint requires read action on the data-center resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

name

String

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

true

name

String

true

awsNetworkControllerSize

String

true

awsGatewaySize

String

true

awsTransferNodeSize

String

true

azureTransferNodeSize

String

true

alicloudTransferNodeSize

String

true

gcpTransferNodeSize

String

true

ocpTransferNodeSize

String

true

networkControllerVolumeSize

Integer

true

transferNodeVolumeSize

Integer

true

gatewayVolumeSize

Integer

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

Path Type Optional Description

id

String

true

address

String

true

city

String

true

stateCode

String

true

stateName

String

true

continentName

String

true

continentCode

String

true

countryName

String

true

countryCode

String

true

isp

String

true

lat

Decimal

true

lng

Decimal

true

locationCode

String

true

locationName

String

true

provider

String

true

Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCP, CUSTOMER].

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-configs' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ5N0hMYmhjc0p4RWpMQzBsMGUwSGpnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZjYmY3MmI3LTEzZmItNGFiMy1hODRmLWI0ZjViYTBlNTEwZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMzMDAwNCwiZXhwIjoxNjI3MzMzNjA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE1YzRkMjA1LTU0YWItNGVjYy05ODIxLWEwNzRlYmM5N2JiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMzMDAwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.B3dUSI2TCtNvBIcKrKy5wIZk89ANqMi5RaGnfHNmLdFgUZXVUQwZYc5mYw0HDtoyJFclU_Gr5Hb5DRdM7Ms2lMNa8JxOV2oS2bK1N4DAtk49wCNVoGEZmsYSfe-ZIrYaSVUWyRk8DsRequoyWTEq_TZMx4fGpFUvmTxmV63j7NFsjR5NYSL904yVgtHo-zc3BhY9r9SXtSqL41Mh_bKuyzNa32jV8VRR0msbtt9YbbOeuYTCelMwUMhdS24oJiTMmjm_tIxxFLOTlashPlrYcgoQ2Nh828HNA59GtIdQn0-Mmx1yed2OgPmwAQwdp-DITJVhytlisCthxlJTbBrV2w'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1692

{
  "_embedded" : {
    "networkConfigMetadataList" : [ {
      "id" : "2616da5c-4441-4c3d-a9a2-ed37262f2ef4",
      "name" : "small",
      "awsNetworkControllerSize" : "T2Small",
      "awsGatewaySize" : "T2Micro",
      "awsTransferNodeSize" : "T2Micro",
      "azureTransferNodeSize" : "Standard_B1s",
      "alicloudTransferNodeSize" : "ecs.t5-lc1m1.small",
      "gcpTransferNodeSize" : "n1-standard-1",
      "ocpTransferNodeSize" : "VM.Standard.E2.1",
      "networkControllerVolumeSize" : 20,
      "transferNodeVolumeSize" : 40,
      "gatewayVolumeSize" : 40,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-configs/2616da5c-4441-4c3d-a9a2-ed37262f2ef4"
        }
      }
    }, {
      "id" : "5df0ee05-2abd-4996-9261-f2da6c4d5c3a",
      "name" : "medium",
      "awsNetworkControllerSize" : "T2Medium",
      "awsGatewaySize" : "T2Medium",
      "awsTransferNodeSize" : "T2Medium",
      "azureTransferNodeSize" : "Standard_B1s",
      "alicloudTransferNodeSize" : "ecs.t5-lc1m1.small",
      "gcpTransferNodeSize" : "n1-standard-2",
      "ocpTransferNodeSize" : "VM.Standard.E2.2",
      "networkControllerVolumeSize" : 20,
      "transferNodeVolumeSize" : 40,
      "gatewayVolumeSize" : 40,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-configs/5df0ee05-2abd-4996-9261-f2da6c4d5c3a"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-configs"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Networks

Find Networks

GET /networks

Authorization

This endpoint requires read action on the network resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

findByName

String

true

findByNetworkGroupId

Object

true

productVersion

String

true

status

Object

true

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

network.size

String

true

locationCode

String

true

o365BreakoutCategory

Object

true

Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE].

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

networkGroupId

String

false

size

String

false

productVersion

Object

false

locationCode

String

false

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

sdsPassword

String

false

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

o365BreakoutCategory

String

false

Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE].

networkController

Object

true

Deprecated..

networkController.id

String

false

networkController.ownerIdentityId

String

true

networkController.networkId

String

false

networkController.domainName

String

true

networkController.name

String

false

networkController.hostId

String

false

networkController.zitiUserId

String

true

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

networkController.zitiPassword

String

true

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

networkController.status

String

true

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

networkController.createdAt

String

false

networkController.updatedAt

String

false

networkController.deletedAt

String

true

networkController.deletedBy

String

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

networkControllers

false

Link to the collection of network controllers within this Network.

edgeRouters

false

Link to the collection of edge-routers within this Network.

edgeRouterPolicies

false

Link to the collection of edge-router-policies within this Network.

endpoints

false

Link to the collection of endpoints within this Network.

services

false

Link to the collection of services within this Network.

appWans

false

Link to the collection of app-wans within this Network.

certificateAuthorities

false

Link to the collection of certificate-authorities within this Network.

hosts

false

Link to the collection of hosts within this Network.

Embedded resources

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

networkGroupId

String

false

size

String

false

productVersion

Object

false

locationCode

String

false

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

sdsPassword

String

false

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

o365BreakoutCategory

String

false

Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE].

networkController

Object

true

Deprecated..

networkController.id

String

false

networkController.ownerIdentityId

String

true

networkController.networkId

String

false

networkController.domainName

String

true

networkController.name

String

false

networkController.hostId

String

false

networkController.zitiUserId

String

true

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

networkController.zitiPassword

String

true

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

networkController.status

String

true

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

networkController.createdAt

String

false

networkController.updatedAt

String

false

networkController.deletedAt

String

true

networkController.deletedBy

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJBZUVuNDhTM0NvdnE1U1B2SU5kQ3hRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQxNGFiZTMyLWJhOGMtNDIwYS05ZjVmLWY1NzI2NmM4NWQ5ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTgwNiwiZXhwIjoxNjI3MzMzNDA2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM1ZDA3NGIxLWFkZGUtNDM5Ny05ODljLWRhMjAyZGZhODJlOFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTgwNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.RYMreo2dVbt_sDFTW-I-bj8X7g7df14dYDGFOUrW4fP0EV1bZqFD-RVK0TESfDHfW1bmHtsfdpermoWZuD8sYYNl_OFvTdIFgR1TvDj0Z0vR4MykZ-3uwDhtz59UmNXonsEnXT8jT8DKknKIt197w9CloGPxununnKvCos6hCevYlG57yx1s-bVdV286avn2TlEJxH2ltfRec9OX1B4p0aR75Ryjwx0QgqR-bNb-T30UsQKlH92IR6cHn80yOildQ2ZzQUdglgE3RQff8_ewE6gTdBrma0K5ZuuVB69h3FmMCWZX0Mm9fnfj1buxhKn9KN1agAU2FINAwxAH5APbdg'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 66441

{
  "_embedded" : {
    "networkList" : [ {
      "id" : "124b2b71-099a-427e-bdef-b7004ab3ac3b",
      "ownerIdentityId" : "4d7268a0-b9be-47ff-b234-8fffab7c9e39",
      "createdBy" : "4d7268a0-b9be-47ff-b234-8fffab7c9e39",
      "createdAt" : "2021-07-26T20:03:26.595600Z",
      "updatedAt" : "2021-07-26T20:03:26.596099Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-07-26T20:03:26.595347Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "networkController" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=124b2b71-099a-427e-bdef-b7004ab3ac3b"
        }
      }
    }, {
      "id" : "22b01151-45f3-411c-8433-1e65a7f8d8a1",
      "ownerIdentityId" : "a138f026-f050-49dc-a7b2-6222e2d085b4",
      "createdBy" : "a138f026-f050-49dc-a7b2-6222e2d085b4",
      "createdAt" : "2021-07-26T20:03:26.204674Z",
      "updatedAt" : "2021-07-26T20:03:26.205357Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-07-26T20:03:26.204368Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "networkController" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=22b01151-45f3-411c-8433-1e65a7f8d8a1"
        }
      }
    }, {
      "id" : "2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd",
      "ownerIdentityId" : "a138f026-f050-49dc-a7b2-6222e2d085b4",
      "createdBy" : "a138f026-f050-49dc-a7b2-6222e2d085b4",
      "createdAt" : "2021-07-26T20:03:26.201971Z",
      "updatedAt" : "2021-07-26T20:03:26.203057Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-07-26T20:03:26.201370Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "3c4ab4bb-11f0-4e02-bf73-5c418568b8f3",
        "ownerIdentityId" : null,
        "networkId" : "2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd",
        "domainName" : null,
        "name" : "nc5c40b2e6-1c8e-418c-b608-7673c94ff63c",
        "hostId" : "c5bbe42a-7473-4e4a-9b7a-241af43d2d5f",
        "status" : "PROVISIONED",
        "createdAt" : "2021-07-26T20:03:26.206569Z",
        "updatedAt" : "2021-07-26T20:03:26.206569Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
        }
      }
    }, {
      "id" : "2e2c275b-89d6-4b6c-84e5-fd6b2ab32980",
      "ownerIdentityId" : "2fe75616-06bc-42d2-9b8a-3d46502004ed",
      "createdBy" : "2fe75616-06bc-42d2-9b8a-3d46502004ed",
      "createdAt" : "2021-07-26T20:03:26.407126Z",
      "updatedAt" : "2021-07-26T20:03:26.408031Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-07-26T20:03:26.406600Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "1f3482e6-cf26-4c62-8c98-828053ceb88f",
        "ownerIdentityId" : null,
        "networkId" : "2e2c275b-89d6-4b6c-84e5-fd6b2ab32980",
        "domainName" : null,
        "name" : "nc11d05a21-8bee-4a13-8599-f079d38afc63",
        "hostId" : "2a6ed2d6-c2ce-4fcc-b8e9-182b67b85404",
        "status" : "PROVISIONED",
        "createdAt" : "2021-07-26T20:03:26.411087Z",
        "updatedAt" : "2021-07-26T20:03:26.411087Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=2e2c275b-89d6-4b6c-84e5-fd6b2ab32980"
        }
      }
    }, {
      "id" : "5350c17d-b9bc-4df3-bb14-2f11f84b94a8",
      "ownerIdentityId" : "6b73c660-0cb4-41fa-a382-e4753bd01888",
      "createdBy" : "6b73c660-0cb4-41fa-a382-e4753bd01888",
      "createdAt" : "2021-07-26T20:03:26.458465Z",
      "updatedAt" : "2021-07-26T20:03:26.490608Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Upload Test Network",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.1.0-59578434",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "90ed2e2f-d28e-4ccd-a5ef-6c0f0c009d50",
        "ownerIdentityId" : null,
        "networkId" : "5350c17d-b9bc-4df3-bb14-2f11f84b94a8",
        "domainName" : "ab88cf59-4fd3-4a1a-af69-e13e9aba7474.sandbox.netfoundry.io",
        "name" : "NCAWSi-testncinstance",
        "hostId" : "7df4d0fe-4650-4567-a26e-29b95d319a34",
        "status" : "PROVISIONED",
        "createdAt" : "2021-07-26T20:03:26.478072Z",
        "updatedAt" : "2021-07-26T20:03:26.485588Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=5350c17d-b9bc-4df3-bb14-2f11f84b94a8"
        }
      }
    }, {
      "id" : "567ea406-53b9-4ecd-9a7d-81567e12a537",
      "ownerIdentityId" : "008c44ba-16f3-46df-9b7b-7f93ccc6932e",
      "createdBy" : "008c44ba-16f3-46df-9b7b-7f93ccc6932e",
      "createdAt" : "2021-07-26T20:03:25.202319Z",
      "updatedAt" : "2021-07-26T20:03:25.202801Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-07-26T20:03:25.202096Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "networkController" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=567ea406-53b9-4ecd-9a7d-81567e12a537"
        }
      }
    }, {
      "id" : "6a300bbe-1a1b-4267-b5dc-8b5183b42c46",
      "ownerIdentityId" : "a138f026-f050-49dc-a7b2-6222e2d085b4",
      "createdBy" : "a138f026-f050-49dc-a7b2-6222e2d085b4",
      "createdAt" : "2021-07-26T20:03:26.203916Z",
      "updatedAt" : "2021-07-26T20:03:26.203916Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-07-26T20:03:26.203585Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "a5940874-8065-4c8f-a634-4b73f65b2ca9",
        "ownerIdentityId" : null,
        "networkId" : "6a300bbe-1a1b-4267-b5dc-8b5183b42c46",
        "domainName" : null,
        "name" : "ncf2e2e834-dafd-4c37-a222-85e49bc3b7ef",
        "hostId" : "6c38933f-fea2-468c-bad0-5cf7f48a45f4",
        "status" : "PROVISIONING",
        "createdAt" : "2021-07-26T20:03:26.207520Z",
        "updatedAt" : "2021-07-26T20:03:26.207520Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=6a300bbe-1a1b-4267-b5dc-8b5183b42c46"
        }
      }
    }, {
      "id" : "706938e0-00d9-4a85-a615-c040f4b6310c",
      "ownerIdentityId" : "4d7268a0-b9be-47ff-b234-8fffab7c9e39",
      "createdBy" : "4d7268a0-b9be-47ff-b234-8fffab7c9e39",
      "createdAt" : "2021-07-26T20:03:26.595031Z",
      "updatedAt" : "2021-07-26T20:03:26.595031Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-07-26T20:03:26.594795Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "9b41eae0-3bd0-45a6-bbd9-23e1be11953b",
        "ownerIdentityId" : null,
        "networkId" : "706938e0-00d9-4a85-a615-c040f4b6310c",
        "domainName" : null,
        "name" : "nc9d61248a-31b2-4716-ad6f-1c6754ab9cf1",
        "hostId" : "2df624d3-b8a5-4cb1-ad97-8c5be41f30ee",
        "status" : "PROVISIONING",
        "createdAt" : "2021-07-26T20:03:26.597677Z",
        "updatedAt" : "2021-07-26T20:03:26.597677Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=706938e0-00d9-4a85-a615-c040f4b6310c"
        }
      }
    }, {
      "id" : "7845670a-0451-43bb-8ca4-b0baffc73adb",
      "ownerIdentityId" : "1cf1ff5a-ee08-4550-a74b-d39339a6cf61",
      "createdBy" : "1cf1ff5a-ee08-4550-a74b-d39339a6cf61",
      "createdAt" : "2021-07-26T20:03:26.134147Z",
      "updatedAt" : "2021-07-26T20:03:26.134916Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-07-26T20:03:26.133684Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "228a2c1b-0c46-464d-bc5d-5861525a4a97",
        "ownerIdentityId" : null,
        "networkId" : "7845670a-0451-43bb-8ca4-b0baffc73adb",
        "domainName" : null,
        "name" : "ncbd7614d0-b937-4450-8000-c2c51108d853",
        "hostId" : "9b42eb29-49b4-4fc5-b784-c814c77c38c3",
        "status" : "PROVISIONED",
        "createdAt" : "2021-07-26T20:03:26.137953Z",
        "updatedAt" : "2021-07-26T20:03:26.137953Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=7845670a-0451-43bb-8ca4-b0baffc73adb"
        }
      }
    }, {
      "id" : "83d482d7-2d27-4484-90f7-e24cc9c2e007",
      "ownerIdentityId" : "008c44ba-16f3-46df-9b7b-7f93ccc6932e",
      "createdBy" : "008c44ba-16f3-46df-9b7b-7f93ccc6932e",
      "createdAt" : "2021-07-26T20:03:25.199808Z",
      "updatedAt" : "2021-07-26T20:03:25.201065Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-07-26T20:03:25.198303Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "02685b23-ac98-4f57-bbd2-d08a1cc83684",
        "ownerIdentityId" : null,
        "networkId" : "83d482d7-2d27-4484-90f7-e24cc9c2e007",
        "domainName" : null,
        "name" : "nc1f338d20-2304-4212-89f2-7b7325bf7ab0",
        "hostId" : "43fe5b4f-33bf-4435-9be9-94e8da94397f",
        "status" : "PROVISIONED",
        "createdAt" : "2021-07-26T20:03:25.203907Z",
        "updatedAt" : "2021-07-26T20:03:25.203907Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=83d482d7-2d27-4484-90f7-e24cc9c2e007"
        }
      }
    }, {
      "id" : "baf94baa-6b1f-425a-a5f3-f608e88216cb",
      "ownerIdentityId" : "f47aa50f-9644-43b7-9bdf-6f438816b881",
      "createdBy" : "f47aa50f-9644-43b7-9bdf-6f438816b881",
      "createdAt" : "2021-07-26T20:03:25.844799Z",
      "updatedAt" : "2021-07-26T20:03:25.930301Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Test Network Yaml",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.1.0-59578434",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "df1cff08-c5e6-4aac-84b6-ca6862988ed3",
        "ownerIdentityId" : null,
        "networkId" : "baf94baa-6b1f-425a-a5f3-f608e88216cb",
        "domainName" : "099846e7-90b2-4b2b-8478-f15bdea03f13.sandbox.netfoundry.io",
        "name" : "NCAWSi-testncinstance",
        "hostId" : "7813877f-1040-43db-97d2-8215a526c3e8",
        "status" : "PROVISIONED",
        "createdAt" : "2021-07-26T20:03:25.907008Z",
        "updatedAt" : "2021-07-26T20:03:25.920577Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=baf94baa-6b1f-425a-a5f3-f608e88216cb"
        }
      }
    }, {
      "id" : "bf984504-8fc2-4e40-a82d-4adca23e7451",
      "ownerIdentityId" : "4d7268a0-b9be-47ff-b234-8fffab7c9e39",
      "createdBy" : "4d7268a0-b9be-47ff-b234-8fffab7c9e39",
      "createdAt" : "2021-07-26T20:03:26.593666Z",
      "updatedAt" : "2021-07-26T20:03:26.594439Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-07-26T20:03:26.593226Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "bd6fb5f1-2aac-4d4b-92cd-f1d1fc64fc80",
        "ownerIdentityId" : null,
        "networkId" : "bf984504-8fc2-4e40-a82d-4adca23e7451",
        "domainName" : null,
        "name" : "ncca089493-b796-4dc2-9fd4-0ae1fa54fe85",
        "hostId" : "44d9da4a-f267-4b42-a066-723fc1ed3c3a",
        "status" : "PROVISIONED",
        "createdAt" : "2021-07-26T20:03:26.596985Z",
        "updatedAt" : "2021-07-26T20:03:26.596985Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=bf984504-8fc2-4e40-a82d-4adca23e7451"
        }
      }
    }, {
      "id" : "d8d39799-5f86-45c5-abf1-dc575afe7582",
      "ownerIdentityId" : "2fe75616-06bc-42d2-9b8a-3d46502004ed",
      "createdBy" : "2fe75616-06bc-42d2-9b8a-3d46502004ed",
      "createdAt" : "2021-07-26T20:03:26.408953Z",
      "updatedAt" : "2021-07-26T20:03:26.408953Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-07-26T20:03:26.408659Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "a590e4ec-598a-420f-985d-8d6ebcd9de5a",
        "ownerIdentityId" : null,
        "networkId" : "d8d39799-5f86-45c5-abf1-dc575afe7582",
        "domainName" : null,
        "name" : "nce1cbd924-32c9-4a9c-93e1-38fd8aefe47c",
        "hostId" : "064d2d28-f253-4284-b208-0f7b9fe751a1",
        "status" : "PROVISIONING",
        "createdAt" : "2021-07-26T20:03:26.411751Z",
        "updatedAt" : "2021-07-26T20:03:26.411751Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=d8d39799-5f86-45c5-abf1-dc575afe7582"
        }
      }
    }, {
      "id" : "eea05d13-e846-4e12-9de8-024051ba2a35",
      "ownerIdentityId" : "1cf1ff5a-ee08-4550-a74b-d39339a6cf61",
      "createdBy" : "1cf1ff5a-ee08-4550-a74b-d39339a6cf61",
      "createdAt" : "2021-07-26T20:03:26.136055Z",
      "updatedAt" : "2021-07-26T20:03:26.136717Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-07-26T20:03:26.135811Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "networkController" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=eea05d13-e846-4e12-9de8-024051ba2a35"
        }
      }
    }, {
      "id" : "f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5",
      "ownerIdentityId" : "2fe75616-06bc-42d2-9b8a-3d46502004ed",
      "createdBy" : "2fe75616-06bc-42d2-9b8a-3d46502004ed",
      "createdAt" : "2021-07-26T20:03:26.409729Z",
      "updatedAt" : "2021-07-26T20:03:26.410233Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-07-26T20:03:26.409414Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "networkController" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=f5acb2ef-2a3c-488f-b73f-2f19eb3c26c5"
        }
      }
    }, {
      "id" : "f9896d62-4511-48f6-b8a4-884990153a98",
      "ownerIdentityId" : "008c44ba-16f3-46df-9b7b-7f93ccc6932e",
      "createdBy" : "008c44ba-16f3-46df-9b7b-7f93ccc6932e",
      "createdAt" : "2021-07-26T20:03:25.201784Z",
      "updatedAt" : "2021-07-26T20:03:25.201784Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-07-26T20:03:25.201510Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "a982d336-566b-4eef-800e-2e2c275ca334",
        "ownerIdentityId" : null,
        "networkId" : "f9896d62-4511-48f6-b8a4-884990153a98",
        "domainName" : null,
        "name" : "nc0be91475-3770-40e1-8d02-88d99ea4deaa",
        "hostId" : "73b416ad-3604-435e-bbf3-3023dcc1bf66",
        "status" : "PROVISIONING",
        "createdAt" : "2021-07-26T20:03:25.204736Z",
        "updatedAt" : "2021-07-26T20:03:25.204736Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=f9896d62-4511-48f6-b8a4-884990153a98"
        }
      }
    }, {
      "id" : "fb4e2280-a60d-4d8e-8de2-24266612b8da",
      "ownerIdentityId" : "1cf1ff5a-ee08-4550-a74b-d39339a6cf61",
      "createdBy" : "1cf1ff5a-ee08-4550-a74b-d39339a6cf61",
      "createdAt" : "2021-07-26T20:03:26.135508Z",
      "updatedAt" : "2021-07-26T20:03:26.135508Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-07-26T20:03:26.135270Z",
      "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
      "size" : "small",
      "productVersion" : "7.3.30",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "7a94b3a0-c32a-4788-8519-facff0e2c37d",
        "ownerIdentityId" : null,
        "networkId" : "fb4e2280-a60d-4d8e-8de2-24266612b8da",
        "domainName" : null,
        "name" : "nc7aa8e7a1-424e-452d-8936-cc16714597bc",
        "hostId" : "878546d1-a218-4533-9bf4-9c01f6b58b92",
        "status" : "PROVISIONING",
        "createdAt" : "2021-07-26T20:03:26.138969Z",
        "updatedAt" : "2021-07-26T20:03:26.138969Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=fb4e2280-a60d-4d8e-8de2-24266612b8da"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 17,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Network

GET /networks/{id}

Authorization

This endpoint requires read action on the network resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

networkGroupId

String

false

size

String

false

productVersion

Object

false

locationCode

String

false

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

sdsPassword

String

false

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

o365BreakoutCategory

String

false

Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE].

networkController

Object

true

Deprecated..

networkController.id

String

false

networkController.ownerIdentityId

String

true

networkController.networkId

String

false

networkController.domainName

String

true

networkController.name

String

false

networkController.hostId

String

false

networkController.zitiUserId

String

true

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

networkController.zitiPassword

String

true

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

networkController.status

String

true

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

networkController.createdAt

String

false

networkController.updatedAt

String

false

networkController.deletedAt

String

true

networkController.deletedBy

String

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

networkControllers

false

Link to the collection of network controllers within this Network.

edgeRouters

false

Link to the collection of edge-routers within this Network.

edgeRouterPolicies

false

Link to the collection of edge-router-policies within this Network.

endpoints

false

Link to the collection of endpoints within this Network.

services

false

Link to the collection of services within this Network.

appWans

false

Link to the collection of app-wans within this Network.

certificateAuthorities

false

Link to the collection of certificate-authorities within this Network.

hosts

false

Link to the collection of hosts within this Network.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks/2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJISU9KeVh1TTVHbEMtMzI5VlVZdGdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdhMjQ0Y2RmLWI4OTAtNGJkMy04MDQ1LWQzZDlkZGIyYzliZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTgwNiwiZXhwIjoxNjI3MzMzNDA2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZlODg2NDRhLWUyMTItNDFhZi05NWE2LWQ5ZGM3NWFiNjc5ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTgwNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.nR-bo34wnYQMedOH2Y2yIbiz1ldrY9EJDkCtf7s-_5RvMG5m_MnqFPiawgqqa74U-wjEWroZCXMvpsEi6yOF7x7rAxO7dPzNQ6A4agyykuNRJyiE5-AE4R4XJ_RBNdoSNQSZGJ6xGBfBDO_5GbhhXCnnBPymLg-zkHZbwQLO5PuJ0MkjOviXPlq8r37FiExudKtwlUw_Yf2npRrOF-7F9JHXPHi7q9KHbsWRZwLk-gbEh_kgPcmr0xAZKxB5XltwHVIXnSBmzjITKc-wb4Y-4Eep9SddDKlLwLK4PCpKPBDTuxVec9ibBfIOlbyKHW_nGsXdWIKmqPXCLuEwYTDnPQ'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3698

{
  "id" : "2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd",
  "ownerIdentityId" : "a138f026-f050-49dc-a7b2-6222e2d085b4",
  "createdBy" : "a138f026-f050-49dc-a7b2-6222e2d085b4",
  "createdAt" : "2021-07-26T20:03:26.201971Z",
  "updatedAt" : "2021-07-26T20:03:26.203057Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "ACME Network2021-07-26T20:03:26.201370Z",
  "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
  "size" : "small",
  "productVersion" : "7.3.30",
  "status" : "PROVISIONED",
  "o365BreakoutCategory" : "NONE",
  "networkController" : {
    "id" : "3c4ab4bb-11f0-4e02-bf73-5c418568b8f3",
    "ownerIdentityId" : null,
    "networkId" : "2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd",
    "domainName" : null,
    "name" : "nc5c40b2e6-1c8e-418c-b608-7673c94ff63c",
    "hostId" : "c5bbe42a-7473-4e4a-9b7a-241af43d2d5f",
    "status" : "PROVISIONED",
    "createdAt" : "2021-07-26T20:03:26.206569Z",
    "updatedAt" : "2021-07-26T20:03:26.206569Z",
    "deletedAt" : null,
    "deletedBy" : null
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=2d178aea-0d66-4fea-b5f8-9ecce5d6e3bd"
    }
  }
}

Create Network

POST /networks

Authorization

This endpoint requires create action on the network resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkGroupId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

networkConfigMetadataId

String

true

Deprecated..

size

String

true

io.netfoundry.common.util.validation.ValidAs.

name

String

true

io.netfoundry.common.util.validation.ValidAs.

productVersion

Object

true

o365BreakoutCategory

String

true

Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE].

locationCode

String

true

io.netfoundry.common.util.validation.ValidAs.

edgeRouters

Array[Object]

true

edgeRouters[].name

String

true

io.netfoundry.common.util.validation.ValidAs.

edgeRouters[].networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

edgeRouters[].dataCenterId

String

true

edgeRouters[].hostSize

String

true

edgeRouters[].linkListener

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

edgeRouters[].tunnelerEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

edgeRouters[].attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

edgeRouterPolicies

Array[Object]

true

edgeRouterPolicies[].name

String

true

io.netfoundry.common.util.validation.ValidAs.

edgeRouterPolicies[].networkId

String

true

Client must have create action under the annotated resource.

edgeRouterPolicies[].endpointAttributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

edgeRouterPolicies[].edgeRouterAttributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

services

Array[Object]

true

services[].networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

services[].name

String

true

io.netfoundry.common.util.validation.ValidAs.

services[].encryptionRequired

Boolean

true

services[].configIds

Array[Object]

true

services[].configs

Array[Object]

true

services[].configs[].networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

services[].configs[].name

String

true

io.netfoundry.common.util.validation.ValidAs.

services[].configs[].configTypeId

String

true

A Config’s data must conform to a Config Type’s schema. When creating a Config, the client may specify the Config Type by id, name or have a dedicated Config Type created on the fly. This property allows for the specification of the Config Type by id.

Client must have read action on the annotated resource.

services[].configs[].configTypeName

String

true

A Config’s data must conform to a Config Type’s schema. When creating a Config, the client may specify the Config Type by id, name or have a dedicated Config Type created on the fly. This property allows for the specification of the Config Type by name.

services[].configs[].configType

Object

true

A Config’s data must conform to a Config Type’s schema. When creating a Config, the client may specify the Config Type by id, name or have a dedicated Config Type created on the fly. This property allows for the specification of the Config Type by supplying a create command object.

services[].configs[].configType.networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

services[].configs[].configType.name

String

true

io.netfoundry.common.util.validation.ValidAs.

services[].configs[].configType.schema

Object

true

io.netfoundry.common.util.validation.ValidAs.

services[].configs[].data

Object

true

services[].attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

services[].modelType

String

true

Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].

services[].model

Object

true

certificateAuthorities

Array[Object]

true

certificateAuthorities[].networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

certificateAuthorities[].name

String

true

io.netfoundry.common.util.validation.ValidAs.

certificateAuthorities[].autoCaEnrollmentEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

certificateAuthorities[].authEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

certificateAuthorities[].ottCaEnrollmentEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

certificateAuthorities[].certPem

String

false

Size must be between 100 and 2147483647 inclusive.

certificateAuthorities[].endpointAttributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

endpoints

Array[Object]

true

endpoints[].networkId

String

true

The UUID of the network in which to create the endpoint.

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

endpoints[].name

String

true

A display name allowing whitespace for the endpoint.

io.netfoundry.common.util.validation.ValidAs.

endpoints[].enrollmentMethod

Object

true

ott: "true" will return an enrollment token for use with the built-in Ziti CA
updb: string is a Ziti UPDB login username
ottca: string is UUID of an imported CA to use
.

endpoints[].enrollmentMethod.ott

Boolean

true

endpoints[].enrollmentMethod.updb

String

true

endpoints[].enrollmentMethod.ottca

String

true

endpoints[].attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

endpoints[].sessionIdentityId

String

true

endpoints[].syncId

String

true

endpoints[].syncResourceId

String

true

endpoints[].shareRegistration

Object

true

endpoints[].shareRegistration.id

String

false

Client must have update action on the annotated resource.

endpoints[].shareRegistration.toList

Array[String]

false

endpoints[].shareRegistration.ccList

Array[String]

true

endpoints[].shareRegistration.subject

String

true

endpoints[].shareRegistration.type

String

true

Must be one of [Email].

appWans

Array[Object]

true

appWans[].networkId

String

false

appWans[].name

String

false

appWans[].serviceAttributes

Array[String]

true

appWans[].endpointAttributes

Array[String]

true

appWans[].postureCheckAttributes

Array[String]

true

postureChecks

Array[Object]

true

postureChecks[].name

String

true

io.netfoundry.common.util.validation.ValidAs.

postureChecks[].networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

postureChecks[].type

String

true

io.netfoundry.common.util.validation.ValidAs.
Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI].

postureChecks[].attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

postureChecks[].data

Object

false

io.netfoundry.common.util.validation.ValidAs.

postureChecks[].data.domains

Array[String]

false

postureChecks[].data.macAddresses

Array[String]

false

postureChecks[].data.timeoutSeconds

Integer

true

The number of seconds before an MFA TOTP will need to be provided before the posture check begins to fail (optional) Defaults to 0 == no timeout. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature. This property will be null in all prior version networks. It may be null in legacy instances in an upgraded network.

Must be at least 0.

postureChecks[].data.promptOnWake

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports a "wake" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

postureChecks[].data.promptOnUnlock

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports an "unlock" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

postureChecks[].data.ignoreLegacyEndpoints

Boolean

true

Forces all other options to be ignored for legacy clients that do not support event state (optional) Defaults to false. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

postureChecks[].data.operatingSystems

Array[Object]

false

postureChecks[].data.operatingSystems[].type

String

false

Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer].

postureChecks[].data.operatingSystems[].versions

Array[String]

false

postureChecks[].data.process

Object

false

postureChecks[].data.process.osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

postureChecks[].data.process.path

String

false

postureChecks[].data.process.hashes

Array[String]

true

postureChecks[].data.process.signerFingerprint

String

true

postureChecks[].data.processes

Array[Object]

false

postureChecks[].data.processes[].osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

postureChecks[].data.processes[].path

String

false

postureChecks[].data.processes[].hashes

Array[String]

true

postureChecks[].data.processes[].signerFingerprints

Array[String]

true

postureChecks[].data.semantic

String

true

Must be one of [AllOf, AnyOf].

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

networkGroupId

String

false

size

String

false

productVersion

Object

false

locationCode

String

false

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

sdsPassword

String

false

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

o365BreakoutCategory

String

false

Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE].

networkController

Object

true

Deprecated..

networkController.id

String

false

networkController.ownerIdentityId

String

true

networkController.networkId

String

false

networkController.domainName

String

true

networkController.name

String

false

networkController.hostId

String

false

networkController.zitiUserId

String

true

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

networkController.zitiPassword

String

true

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

networkController.status

String

true

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

networkController.createdAt

String

false

networkController.updatedAt

String

false

networkController.deletedAt

String

true

networkController.deletedBy

String

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

networkControllers

false

Link to the collection of network controllers within this Network.

edgeRouters

false

Link to the collection of edge-routers within this Network.

edgeRouterPolicies

false

Link to the collection of edge-router-policies within this Network.

endpoints

false

Link to the collection of endpoints within this Network.

services

false

Link to the collection of services within this Network.

appWans

false

Link to the collection of app-wans within this Network.

certificateAuthorities

false

Link to the collection of certificate-authorities within this Network.

hosts

false

Link to the collection of hosts within this Network.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ0cHVmOVpxSnBLNm9HLTFwVWNVQ2VBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAzODA1ZjJhLTVmMGQtNDNhMS05YTFkLWQzOWE4YTM0MjBhOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTgwNiwiZXhwIjoxNjI3MzMzNDA2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjc5ZGE0NDBmLWEyZDctNDZiNi04NDk2LTNiMDgzYTQyNTFiMlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTgwNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.epi40Vzd4ynPJ-lUsIKzslqXn6qB7tyItO7SUuywXnRLh6QWVgAEFFF-lyceK_Hcmm1uu8QcTMjhjkA9tNx-d39KG5U25WqNaXygkKBBI1fVlxMliyUKE3SPLpaoU5yRtNJ9-QhGHVIgj8or-rHvPOXeGTUrWpRozdhS4QwNnWRCROXqJ6Ycmhp6fN2madyFghLxWOKjGoYNY8BeKYRf5SYcl3r0g7JnksE51EyQsdOdEAMXJwsZlfvj_Bfi3qShDhhF2-QHJ4IqO31-6wvdvqMOiuMsfTsMSGKeOpNohZ7krD4wH8LezQYTlWL0TS88ZTfDor6abIlVO7FYUjcKjw' \
    -d '{"networkGroupId":"55db243f-8cd1-4d48-9d98-1b4019ceb066","size":"small","name":"Create Test Network","o365BreakoutCategory":"NONE","locationCode":"us-east-1","edgeRouters":[],"edgeRouterPolicies":[],"services":[],"certificateAuthorities":[],"endpoints":[],"appWans":[],"postureChecks":[]}'

Example response

HTTP/1.1 202 Accepted
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3399

{
  "id" : "9b957321-f6cd-472b-a381-5db28bc7bc60",
  "ownerIdentityId" : "03805f2a-5f0d-43a1-9a1d-d39a8a3420a8",
  "createdBy" : "03805f2a-5f0d-43a1-9a1d-d39a8a3420a8",
  "createdAt" : "2021-07-26T20:03:26.959800Z",
  "updatedAt" : "2021-07-26T20:03:26.959800Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Create Test Network",
  "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
  "size" : "small",
  "productVersion" : "7.1.0-59578434",
  "status" : "PROVISIONING",
  "o365BreakoutCategory" : "NONE",
  "networkController" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/2c6bd25e-1ff9-46ac-b0d7-a765a3d82a08",
      "profile" : "meta"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=9b957321-f6cd-472b-a381-5db28bc7bc60"
    }
  }
}

Delete Network

DELETE /networks/{id}

Authorization

This endpoint requires delete action on the network resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

networkGroupId

String

false

size

String

false

productVersion

Object

false

locationCode

String

false

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

sdsPassword

String

false

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

o365BreakoutCategory

String

false

Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE].

networkController

Object

true

Deprecated..

networkController.id

String

false

networkController.ownerIdentityId

String

true

networkController.networkId

String

false

networkController.domainName

String

true

networkController.name

String

false

networkController.hostId

String

false

networkController.zitiUserId

String

true

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

networkController.zitiPassword

String

true

Deprecated..

io.netfoundry.core.validation.ResourceSecret.

networkController.status

String

true

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

networkController.createdAt

String

false

networkController.updatedAt

String

false

networkController.deletedAt

String

true

networkController.deletedBy

String

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

networkControllers

false

Link to the collection of network controllers within this Network.

edgeRouters

false

Link to the collection of edge-routers within this Network.

edgeRouterPolicies

false

Link to the collection of edge-router-policies within this Network.

endpoints

false

Link to the collection of endpoints within this Network.

services

false

Link to the collection of services within this Network.

appWans

false

Link to the collection of app-wans within this Network.

certificateAuthorities

false

Link to the collection of certificate-authorities within this Network.

hosts

false

Link to the collection of hosts within this Network.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks/e59ade07-d1c9-455a-abd2-470e72b0a170' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJQOHduS3Z1RWxJNDRjcWJGZUVWeG1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc5N2M5MGI2LWNhZWYtNDQwOC05ODNjLTM0M2IyNjQzNjU3OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTgwNywiZXhwIjoxNjI3MzMzNDA3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjc1YWYwZjRmLWMyNmQtNDk4Yi05MzQzLTBjMGY2MzM2YmRiYlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTgwN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.sIo6JVa1wDKsQYdmjUKU0HKja-RCTpxCLx50qNDhvB4jaPFwwCBDxC7kaA3Na5gryYyiM9SAECPnap4Dt2dpLtiMkaVGdXUmYraz37XsBAkqU9KTkUNnYlmixPyIcQB6hKy_poZsfEWk5klUciCL3i-t7mcOqpzDJM2fFpYK9laaSHHdAFQ-_ZOXDfGH7OvPwJ37BIkp8yYp6klCEyc8kbudQQ3SudMFiTNSQF2VqYw5KsAJ_3Uxa6McjQjnky9--9eHwTMta64jCbnKHtFfv7xbTPaccVQ1RUheBsmeCadyRV2RJOY_ho0X0GxtB4_u4BQXfDtQ7VOkSdDGrvn1Vg'

Example response

HTTP/1.1 202 Accepted
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3441

{
  "id" : "e59ade07-d1c9-455a-abd2-470e72b0a170",
  "ownerIdentityId" : "e74a3a29-d32d-4c7e-a8ba-cb41e1eeba62",
  "createdBy" : "e74a3a29-d32d-4c7e-a8ba-cb41e1eeba62",
  "createdAt" : "2021-07-26T20:03:27.760257Z",
  "updatedAt" : "2021-07-26T20:03:27.790109Z",
  "deletedBy" : "797c90b6-caef-4408-983c-343b26436579",
  "deletedAt" : null,
  "name" : "ACME Network2021-07-26T20:03:27.759877Z",
  "networkGroupId" : "55db243f-8cd1-4d48-9d98-1b4019ceb066",
  "size" : "small",
  "productVersion" : "7.3.30",
  "status" : "DELETING",
  "o365BreakoutCategory" : "NONE",
  "networkController" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/cca70e73-9691-4f76-8020-98a88779e676",
      "profile" : "meta"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=e59ade07-d1c9-455a-abd2-470e72b0a170"
    }
  }
}

Endpoints

Find Endpoints

GET /endpoints

Authorization

This endpoint requires read action on the endpoint resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

typeId

String

true

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

version

String

true

arch

String

true

os

String

true

osRelease

String

true

osVersion

String

true

hasApiSession

Boolean

true

hasEdgeRouterConnection

Boolean

true

syncId

Object

true

syncResourceId

String

true

sessionActive

String

true

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

attribute

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

typeId

String

true

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

os

String

true

osRelease

String

true

osVersion

String

true

hasApiSession

Boolean

true

hasEdgeRouterConnection

Boolean

true

sessionIdentityId

String

true

syncId

String

true

syncResourceId

String

true

attributes

Array[String]

false

sessionActive

Boolean

true

jwt

String

true

mfaEnabled

Boolean

true

jwtExpiresAt

String

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

typeId

String

true

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

os

String

true

osRelease

String

true

osVersion

String

true

hasApiSession

Boolean

true

hasEdgeRouterConnection

Boolean

true

sessionIdentityId

String

true

syncId

String

true

syncResourceId

String

true

attributes

Array[String]

false

sessionActive

Boolean

true

jwt

String

true

mfaEnabled

Boolean

true

jwtExpiresAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfa09wbktSb2xwWmdjV09YWFBpSTBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA0ZTNjM2M0LWU1ZjItNGJlYy05OTc5LTg2MzE5NDBkNjI0NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk0MCwiZXhwIjoxNjI3MzMzNTQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImUzMzNmMDJlLThkZmItNDkyYS04YjhmLTgwNTIyNjQ1ODc2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.QQv9P3ILjZ3lY4sdzAwYdOjFMMVrqeYUDLP0jJ_4GWoShXgO8O9Wjn_3-N1HnqRKaZ5UPkFaQPqM-AYs6EOL9LiVTKi2w6magkSGzaibDNzsI-v02z6riBzcJhz3CAVck1D1qUneIGKTYNzcw1LnwU1YHg-4kJRRz7yLsz06ykpJ-SHIplK4LkdgGLQSG2H3fzosiBOZZ3JJepBv9mgGpE667SksRvK9GYbKReoGexpVURaF_YpKFwd6b-N5bCOfAqUcGnE0KxG3RSlJBzqPsc-tTRhH9jDHgtsnzsggxhMcps-KM2h8eXtDk_7EyUk6BLx_vJXjEIe6ZZqzxy7Azw'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1811

{
  "_embedded" : {
    "endpointList" : [ {
      "id" : "f0647b22-8bc9-4209-8856-9664a821311c",
      "ownerIdentityId" : "164cb65b-6c5b-48b0-bc51-ed43944966ca",
      "createdBy" : "164cb65b-6c5b-48b0-bc51-ed43944966ca",
      "createdAt" : "2021-07-26T20:05:40.835281Z",
      "updatedAt" : "2021-07-26T20:05:40.835281Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "bc33c348-9ac4-4180-ba8d-bff71e00a950",
      "zitiId" : "90e01862-2b8f-41b9-a15a-6d358b00e868",
      "name" : "Test_endpoint2021-07-26T20:05:40.835062Z",
      "typeId" : "User",
      "appId" : "appId",
      "appVersion" : "appVersion",
      "branch" : "branch",
      "revision" : "revision",
      "type" : "type",
      "version" : "version",
      "arch" : "arch",
      "os" : "os",
      "osRelease" : "osRelease",
      "osVersion" : "osVersion",
      "hasApiSession" : false,
      "hasEdgeRouterConnection" : false,
      "sessionIdentityId" : null,
      "syncId" : "3ee3b840-eeb7-4f36-ac0d-9e53a78062ab",
      "syncResourceId" : "syncresourceId",
      "attributes" : [ ],
      "sessionActive" : true,
      "jwt" : "jwthere",
      "mfaEnabled" : false,
      "jwtExpiresAt" : "2021-07-26T20:05:40.835775Z",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bc33c348-9ac4-4180-ba8d-bff71e00a950",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/f0647b22-8bc9-4209-8856-9664a821311c"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Endpoint

GET /endpoints/{id}

Authorization

This endpoint requires read action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

typeId

String

true

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

os

String

true

osRelease

String

true

osVersion

String

true

hasApiSession

Boolean

true

hasEdgeRouterConnection

Boolean

true

sessionIdentityId

String

true

syncId

String

true

syncResourceId

String

true

attributes

Array[String]

false

sessionActive

Boolean

true

jwt

String

true

mfaEnabled

Boolean

true

jwtExpiresAt

String

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/3c8cad6f-e164-4477-803d-a473dfed503d' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfRTZqR2YwZVRSLV9LbE9qSHBad0N3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNjNDY0NGZmLWIxY2MtNGYyNi1hZWQ5LWE4MGMwMDA5ODlmOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk0MSwiZXhwIjoxNjI3MzMzNTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImJjMjYwMjIxLTY1OWQtNDJlMS1hNDA4LTVkYzZhNDMwODQ4OFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk0MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.eLemhJPkQpGGCM5UQYghN2FVgPgzACD1s9j0lkomhgGT5ClcMMTXa_YpMezRC1W_aF-867Y1dgP9vFN2nomeJNoJZT9pI8655HGG_FsexrvgNLhl_b5lTswLUmPconu_783nJsujTLsPgIh4gngPF17H9eQH-kC5Wwn8NEthgymvxWLLzxPurN6XzUtqQ67CIgRbL-T9iHCvWr4aBRGLmnZ3Ugpcik66jIQ18Epz2avoEXQTJ-EwfW6tMXEy4n6pQy6rWYLkpLxzw3P8S7LprPunGsJgM17zl7ig2dO18ULC7je6TnHhAR9axBsALAW54-lZSpl7YcWwpL67Oba2Mg'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1382

{
  "id" : "3c8cad6f-e164-4477-803d-a473dfed503d",
  "ownerIdentityId" : "a168bc19-90fb-4e43-b9fe-1e2124fc57e6",
  "createdBy" : "a168bc19-90fb-4e43-b9fe-1e2124fc57e6",
  "createdAt" : "2021-07-26T20:05:41.538273Z",
  "updatedAt" : "2021-07-26T20:05:41.538273Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "7414cfe7-5dba-46b6-b86a-12223f37cbf9",
  "zitiId" : "352d79ab-b4bc-4fe5-821f-75906156b4da",
  "name" : "Test_endpoint2021-07-26T20:05:41.538114Z",
  "typeId" : "User",
  "appId" : "appId",
  "appVersion" : "appVersion",
  "branch" : "branch",
  "revision" : "revision",
  "type" : "type",
  "version" : "version",
  "arch" : "arch",
  "os" : "os",
  "osRelease" : "osRelease",
  "osVersion" : "osVersion",
  "hasApiSession" : false,
  "hasEdgeRouterConnection" : false,
  "sessionIdentityId" : null,
  "syncId" : "00413846-60d3-4516-95f2-1cbb1c58dd9c",
  "syncResourceId" : "syncresourceId",
  "attributes" : [ ],
  "sessionActive" : true,
  "jwt" : "jwthereupdb",
  "mfaEnabled" : false,
  "jwtExpiresAt" : "2021-07-26T20:05:41.539389Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/7414cfe7-5dba-46b6-b86a-12223f37cbf9",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/3c8cad6f-e164-4477-803d-a473dfed503d"
    }
  }
}

Find Endpoints

GET /endpoints

Authorization

This endpoint requires read action on the endpoint resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

typeId

String

true

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

version

String

true

arch

String

true

os

String

true

osRelease

String

true

osVersion

String

true

hasApiSession

Boolean

true

hasEdgeRouterConnection

Boolean

true

syncId

Object

true

syncResourceId

String

true

sessionActive

String

true

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

attribute

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

typeId

String

true

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

os

String

true

osRelease

String

true

osVersion

String

true

hasApiSession

Boolean

true

hasEdgeRouterConnection

Boolean

true

sessionIdentityId

String

true

syncId

String

true

syncResourceId

String

true

attributes

Array[String]

false

sessionActive

Boolean

true

jwt

String

true

mfaEnabled

Boolean

true

jwtExpiresAt

String

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints?syncResourceId=8eca5a56-b933-443f-b180-3d3c83be76cf' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIza3lSSURoQUJWLVhienBldGU5VGx3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJiMmU3OWY0LWI3ZmItNDg1MC04NGE3LWY2MDlhODM0OTAyZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTgzNywiZXhwIjoxNjI3MzMzNDM3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImE0ODRlZmQwLTkyZDgtNGMwMi1iNWZkLWM1NzgyMGE2MGU0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTgzN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.TZ1ZkemjGSnahQkGfTu8Jm09PjlLmh1hjWaEPYS93AK6rEt5PeOsyUuw4mWjjTKZf3tkla7Rmf73meJKM17qGkZEZgttwK8JrzacMiluBBxmVb8s-mqIaq0r46g_WPdvGlhJcAKiVgYR0jUnsP1QqiL9n02Z8yq6Gdhr8VXIrRVjvLJaLpoekYX2zKp-hRfk2shtctOnL4ozCsaUj8MtziyTxEL5lh5tCjTD9K_72bE4dTFkNrD9ksl2TATHLG5-aNF-hfhjbZGYaBIaa7OO4jy3PMcGPGIqQVTX2_K_TubFOLfir5wJKUdnjm473P3UnQO94XDSCdNmngoPFrrY7g'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 217

{
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints"
    }
  },
  "page" : {
    "size" : 0,
    "totalElements" : 0,
    "totalPages" : 1,
    "number" : 0
  }
}

Create Endpoint

POST /endpoints

Create an endpoint identity with a unique name and particular role attributes that will match edge router and service policies. The identity may then be enrolled via the selected method and thereafter used with a client or server SDK, or with a tunneler to intercept or terminate service traffic.

Authorization

This endpoint requires create action on the endpoint resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

The UUID of the network in which to create the endpoint.

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

name

String

true

A display name allowing whitespace for the endpoint.

io.netfoundry.common.util.validation.ValidAs.

enrollmentMethod

Object

true

ott: "true" will return an enrollment token for use with the built-in Ziti CA
updb: string is a Ziti UPDB login username
ottca: string is UUID of an imported CA to use
.

enrollmentMethod.ott

Boolean

true

enrollmentMethod.updb

String

true

enrollmentMethod.ottca

String

true

attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

sessionIdentityId

String

true

syncId

String

true

syncResourceId

String

true

shareRegistration

Object

true

shareRegistration.id

String

false

Client must have update action on the annotated resource.

shareRegistration.toList

Array[String]

false

shareRegistration.ccList

Array[String]

true

shareRegistration.subject

String

true

shareRegistration.type

String

true

Must be one of [Email].

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

typeId

String

true

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

os

String

true

osRelease

String

true

osVersion

String

true

hasApiSession

Boolean

true

hasEdgeRouterConnection

Boolean

true

sessionIdentityId

String

true

syncId

String

true

syncResourceId

String

true

attributes

Array[String]

false

sessionActive

Boolean

true

jwt

String

true

mfaEnabled

Boolean

true

jwtExpiresAt

String

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI3SmhQUmtJMG5IcTU0M1JnR3F5WHBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJiZmYyNWI2LWMwYzctNGIxMi1hYzk2LTIxZTAyZmU5ZWE1OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk0MCwiZXhwIjoxNjI3MzMzNTQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ0ZjllZTI2LWQ3N2EtNDIyNi05NWEzLWVhNmQ5MDVjM2Y0OFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.CLLv4GbFb6nHWzpfVHe4AOpGnmP_KAOt2B87OCaKqiDep_Vz0moLiziWf9nTePs6vSBmko2N0Lp9GykBjOpFH-b2FFl0A2pGZWP6tJ-a_1JeF4pKe8qBQf8lodkTytKkMYrDawPQ8sBx79q7D9ILiNaVdfwV685NJCKHfsR-gFa6q94Z8amZpVsS5KlwIJpMzbPkBU6GzIIeS2U_PjFiFvWqhc5HDfL0M2sN3WwdEczKE_8e5mAXuJY7Gf7r5CsYSrAF7CTCubZI7LMmKR6G_16wpAdd3zWS4rI973usEGdgXAmJzhI_djhAk5hw8Z63yMtoVmPZVBDQtdCihiKHHw' \
    -d '{"networkId":"1e4deb28-0047-420f-bc9d-1a33a6b6b9c9","name":"Test endpoint 02","enrollmentMethod":{"ott":true,"updb":null,"ottca":null},"attributes":["#clients"],"shareRegistration":{"id":null,"toList":["fake@example.com"],"ccList":null,"subject":"New Endpoint!!","type":null}}'

Example response

HTTP/1.1 202 Accepted
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1480

{
  "id" : "a5ac6881-34ba-43e0-beea-ed95643f6551",
  "ownerIdentityId" : "bbff25b6-c0c7-4b12-ac96-21e02fe9ea59",
  "createdBy" : "bbff25b6-c0c7-4b12-ac96-21e02fe9ea59",
  "createdAt" : "2021-07-26T20:05:41.003715Z",
  "updatedAt" : "2021-07-26T20:05:41.006884Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "1e4deb28-0047-420f-bc9d-1a33a6b6b9c9",
  "zitiId" : "5728c944-f809-4000-b1fd-724eed343b1d",
  "name" : "Test endpoint 02",
  "typeId" : null,
  "appId" : "appId01",
  "appVersion" : "appVersion01",
  "branch" : "branch",
  "revision" : "rev01",
  "type" : "device",
  "version" : "version100",
  "arch" : "arch",
  "os" : "osd01",
  "osRelease" : "osrev01",
  "osVersion" : "ver01",
  "hasApiSession" : null,
  "hasEdgeRouterConnection" : null,
  "sessionIdentityId" : null,
  "syncId" : null,
  "syncResourceId" : null,
  "attributes" : [ "#clients" ],
  "sessionActive" : true,
  "jwt" : "jwthere",
  "mfaEnabled" : false,
  "jwtExpiresAt" : "2021-07-26T20:05:40.997910Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1e4deb28-0047-420f-bc9d-1a33a6b6b9c9",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/a5ac6881-34ba-43e0-beea-ed95643f6551"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/74aa5041-f609-4cf1-9c6a-4721847045f6",
      "profile" : "meta"
    }
  }
}

Patch Endpoint

PATCH /endpoints/{id}

Authorization

This endpoint requires update action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

io.netfoundry.common.util.validation.ValidAs.

attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

sessionIdentityId

Object

true

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

typeId

String

true

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

os

String

true

osRelease

String

true

osVersion

String

true

hasApiSession

Boolean

true

hasEdgeRouterConnection

Boolean

true

sessionIdentityId

String

true

syncId

String

true

syncResourceId

String

true

attributes

Array[String]

false

sessionActive

Boolean

true

jwt

String

true

mfaEnabled

Boolean

true

jwtExpiresAt

String

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/15882433-e897-4287-a35d-05cb44356aa6' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyT0lGdUxQdU1Id0ZBYlJlU3pOeF93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ4NTNmY2EzLTY3Y2YtNGNkMi04YWM5LWZkMmQwODAxNGVlNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk0MSwiZXhwIjoxNjI3MzMzNTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVjZmViYWMxLTYzNGMtNDQzMi05MTkyLTIwOTcxNWI0N2I0OVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk0MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.qPRiOIdzE2Ug1zXbicm452pOlqKZoLZzX7wzHJO16PWAHQ8i1LUf3Xb3arMCz8dmlXfF50CBbhMZWD1tHGvdTeP1tMZS81OwYox_gX1hNZ6-QLw5HhoLyLbDbcjcFQ96CJFUQd7QXNcQe_UNXkpM5OBawcnUTEzZuS64EJELvJIcJ7y9OkMVRIyP3NYbw1ZklSr2ONNU2otm9FeRadKoJK85ssW7wmePvQhNEgfR9eYZ-06L8E0HDTx-0E411mVxyraZSBTbnUkZKbq-c7iOePwKq44qFfW3zPLl8X-ctl1VluAxvnXwY6TZjDAbJJN4AleZzjTFxqEIRW-wPdvmsQ' \
    -d '{"name":"Test endpoint 02 updated"}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1362

{
  "id" : "15882433-e897-4287-a35d-05cb44356aa6",
  "ownerIdentityId" : "eb2b9552-a062-4e73-b239-9147c7dd8fc1",
  "createdBy" : "eb2b9552-a062-4e73-b239-9147c7dd8fc1",
  "createdAt" : "2021-07-26T20:05:41.478796Z",
  "updatedAt" : "2021-07-26T20:05:41.504018Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "3b358380-e63b-44b7-bfcf-b456a690d9a3",
  "zitiId" : "14bf2f2b-48e8-4108-b6d6-12094f43000a",
  "name" : "Test endpoint 02 updated",
  "typeId" : "User",
  "appId" : "appId",
  "appVersion" : "appVersion",
  "branch" : "branch",
  "revision" : "revision",
  "type" : "type",
  "version" : "version",
  "arch" : "arch",
  "os" : "os",
  "osRelease" : "osRelease",
  "osVersion" : "osVersion",
  "hasApiSession" : false,
  "hasEdgeRouterConnection" : false,
  "sessionIdentityId" : null,
  "syncId" : "9a007522-b50a-45a8-b66e-5ed62baa7d2b",
  "syncResourceId" : "syncresourceId",
  "attributes" : [ ],
  "sessionActive" : true,
  "jwt" : "jwthere",
  "mfaEnabled" : false,
  "jwtExpiresAt" : "2021-07-26T20:05:41.479463Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3b358380-e63b-44b7-bfcf-b456a690d9a3",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/15882433-e897-4287-a35d-05cb44356aa6"
    }
  }
}

Delete Endpoint

DELETE /endpoints/{id}

Authorization

This endpoint requires delete action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/9c16e150-c948-4097-82ce-ce5e37abf3a9' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJrcUZDWXFTNGRQZ1JTS1ByNlo1WXZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjlmNDQwZWJkLWEyZmUtNGIwMC1hZTdiLTg5OGQ1ZDk1ODNiNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk0MSwiZXhwIjoxNjI3MzMzNTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgzM2E2NmYwLTE5YzItNGYzNy1hNzA0LWFmMWM1ZjU4OTMwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk0MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.FDLDbjPM8m6zXCv8KSFUZtokZJRxtUNEvW5AVQx27x_0yDwrpHRAQHoDiWQcN8iZ5shVx0zxi4ozF0jYgdRvie15jOyvX_evm7yduH0viD3tWIfZa7nmydd-eJlPDz8jte3N0LkzE9zUYAh6RR7cnnBR38M7dAD5ZfaPEa2KMTn55BocGkERFwFnMLAGNhC_MnBp8WrrFeg5LLDeGV3SeJFXU-LvPQQZJH2og_O-CwoRe6Svo_rRPU3Rhdr3zl1CGFy86IcxtYtviPmRAbaTn5IJoPHg8Rvw5Le15FIHLH6EVXhJYcrzyBPH9aI08zjgQfOf0r_lm7qYDYtT66FS4Q'

Example response

HTTP/1.1 200 OK

Edge Routers

Find Edge Routers

GET /edge-routers

Authorization

This endpoint requires read action on the edge-router resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

dataCenterId

Object

true

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

linkListener

Boolean

true

tunnelerEnabled

Boolean

true

ipAddress

String

true

providerId

String

true

hostId

Object

true

online

Boolean

true

verified

Boolean

true

status

Object

true

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

attribute

Object

true

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

hostId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

jwt

String

true

linkListener

Boolean

true

tunnelerEnabled

Boolean

true

online

Boolean

true

verified

Boolean

true

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

attributes

Array[String]

false

registration

Object

true

registration.id

String

false

registration.networkId

String

false

registration.edgeRouterId

String

false

registration.registrationAttempts

Integer

true

registration.expiresAt

String

false

registration.issuedAt

String

false

registration.usedAt

String

true

registration.createdAt

String

false

registration.createdBy

String

false

registration.updatedAt

String

false

registration.deletedAt

String

true

registration.deletedBy

String

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

Path Type Optional Description

id

String

false

hostId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

jwt

String

true

linkListener

Boolean

true

tunnelerEnabled

Boolean

true

online

Boolean

true

verified

Boolean

true

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

attributes

Array[String]

false

registration

Object

true

registration.id

String

false

registration.networkId

String

false

registration.edgeRouterId

String

false

registration.registrationAttempts

Integer

true

registration.expiresAt

String

false

registration.issuedAt

String

false

registration.usedAt

String

true

registration.createdAt

String

false

registration.createdBy

String

false

registration.updatedAt

String

false

registration.deletedAt

String

true

registration.deletedBy

String

false

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJJSVd1NEVFcWlONWYwTXVkNkdzVFBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ4Y2UzMjRhLTZmODAtNGU4YS1hOTEwLTYxZGVjMjAwYzNlNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTgyMSwiZXhwIjoxNjI3MzMzNDIxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjY4MWE4ZTUyLThjNGQtNDM2YS1hMTQ0LWIwNzc3MDE0OTFhNFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTgyMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.kXyzEhxVY-gEUYXZFYxL1BmdmvuMxTtdgfIxurinYLAyZ-lErLR8Y-AxM1JIguMf6Fl4sFsXfyPiv_eM7aDMolt60emlb-Bb24CNm4UyaTuVDtLLp6Y2WIkinIG0ompXvPVnYXdrnkfQwWQf9JO2GOtSYlzxd0Wh4-O9qAuk5gkZ4z0eQ8c7SYYapcJfG1thYB8tnHyZyy1j7PVO3DBWQL7FleBjZd6xVl9AwQyLoKjpq2mslM65BdN4oO8b1QjaRp-XGLmsXqcETlUv0VKs3_XaxNXRKhsD9SevfEo18rTzZ_Oi9l2TepAqeOI-7k7UYOTq0P4-KqAObaWkvXwMNw'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 71222

{
  "_embedded" : {
    "edgeRouterList" : [ {
      "id" : "042f6c8f-1ae0-459c-940c-48cca0ba6784",
      "hostId" : "3156c6b0-59c3-4750-8759-09dc4e5f537a",
      "ownerIdentityId" : "50289a72-d0fb-4c72-a14f-5f8977baf6dd",
      "createdBy" : "50289a72-d0fb-4c72-a14f-5f8977baf6dd",
      "createdAt" : "2021-07-26T20:03:41.442898Z",
      "updatedAt" : "2021-07-26T20:03:41.442898Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.442714Z",
      "networkId" : "5a7dd052-26da-4a47-887f-80c88adcc085",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5a7dd052-26da-4a47-887f-80c88adcc085",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/042f6c8f-1ae0-459c-940c-48cca0ba6784"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/3156c6b0-59c3-4750-8759-09dc4e5f537a"
        }
      }
    }, {
      "id" : "0b7257bf-ac66-4e54-8bd7-e890a81b4622",
      "hostId" : "b3048659-4e07-471d-aee6-24bb17c0d08f",
      "ownerIdentityId" : "1f54475e-3d92-4dd7-8607-a4ef4267a4ae",
      "createdBy" : "1f54475e-3d92-4dd7-8607-a4ef4267a4ae",
      "createdAt" : "2021-07-26T20:03:40.914371Z",
      "updatedAt" : "2021-07-26T20:03:40.914371Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:40.914194Z",
      "networkId" : "b99f4958-ed28-4427-a823-403b4fa65170",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b99f4958-ed28-4427-a823-403b4fa65170",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/0b7257bf-ac66-4e54-8bd7-e890a81b4622"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/b3048659-4e07-471d-aee6-24bb17c0d08f"
        }
      }
    }, {
      "id" : "10575540-52ff-43d4-ab2d-3c1e0bdb0d99",
      "hostId" : "6301cea9-4dc6-469e-9ab2-6d3886ab6796",
      "ownerIdentityId" : "b04659fb-1534-466b-acb6-d6b2b4398e4f",
      "createdBy" : "b04659fb-1534-466b-acb6-d6b2b4398e4f",
      "createdAt" : "2021-07-26T20:03:41.067656Z",
      "updatedAt" : "2021-07-26T20:03:41.067656Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.067487Z",
      "networkId" : "4c8694fb-6a84-479f-bc2b-c2a88494c360",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "53aee448-0bd6-4fd0-88c2-42ca82b9f710",
        "networkId" : "4c8694fb-6a84-479f-bc2b-c2a88494c360",
        "edgeRouterId" : "10575540-52ff-43d4-ab2d-3c1e0bdb0d99",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.069114Z",
        "issuedAt" : "2021-07-26T20:03:41.069117Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.069305Z",
        "createdBy" : "b04659fb-1534-466b-acb6-d6b2b4398e4f",
        "updatedAt" : "2021-07-26T20:03:41.069305Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4c8694fb-6a84-479f-bc2b-c2a88494c360",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/10575540-52ff-43d4-ab2d-3c1e0bdb0d99"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/6301cea9-4dc6-469e-9ab2-6d3886ab6796"
        }
      }
    }, {
      "id" : "15a5a46a-2882-4f09-982d-845d639bb7a7",
      "hostId" : "077cc125-a1d1-4aa3-bc79-14f006a82a4f",
      "ownerIdentityId" : "b69ddff0-2a56-4201-9590-35f03650b21f",
      "createdBy" : "b69ddff0-2a56-4201-9590-35f03650b21f",
      "createdAt" : "2021-07-26T20:03:41.683968Z",
      "updatedAt" : "2021-07-26T20:03:41.683968Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.683790Z",
      "networkId" : "c9f7243e-4d56-47c0-ae9d-41df716a7a18",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c9f7243e-4d56-47c0-ae9d-41df716a7a18",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/15a5a46a-2882-4f09-982d-845d639bb7a7"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/077cc125-a1d1-4aa3-bc79-14f006a82a4f"
        }
      }
    }, {
      "id" : "169f35c6-423c-4505-b0d3-2325b2f82a83",
      "hostId" : "1396b74f-0c3f-4b43-bac1-2d483c3a854f",
      "ownerIdentityId" : "9e202ea9-2f04-4a05-ba93-49fbc3267212",
      "createdBy" : "9e202ea9-2f04-4a05-ba93-49fbc3267212",
      "createdAt" : "2021-07-26T20:03:41.498986Z",
      "updatedAt" : "2021-07-26T20:03:41.498986Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.498801Z",
      "networkId" : "356ebc75-22d2-44ed-b894-58bfd24c6441",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/356ebc75-22d2-44ed-b894-58bfd24c6441",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/169f35c6-423c-4505-b0d3-2325b2f82a83"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/1396b74f-0c3f-4b43-bac1-2d483c3a854f"
        }
      }
    }, {
      "id" : "20519ece-7f74-4421-83d4-d54f03f24c70",
      "hostId" : "f1371245-b1b1-4007-841c-8440f83a35c1",
      "ownerIdentityId" : "abd1ff40-8ab9-448b-b725-9d175c8dc825",
      "createdBy" : "abd1ff40-8ab9-448b-b725-9d175c8dc825",
      "createdAt" : "2021-07-26T20:03:41.384622Z",
      "updatedAt" : "2021-07-26T20:03:41.384622Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.384428Z",
      "networkId" : "20bcaf7a-c288-4a6d-b013-e4c7c22c1336",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/20bcaf7a-c288-4a6d-b013-e4c7c22c1336",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/20519ece-7f74-4421-83d4-d54f03f24c70"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/f1371245-b1b1-4007-841c-8440f83a35c1"
        }
      }
    }, {
      "id" : "32022f1e-efb4-4dde-97fe-f77e5ac0915a",
      "hostId" : "3fc94baf-bc60-40d9-b255-aae7d943919d",
      "ownerIdentityId" : "ba70b0ae-c096-44f5-8501-0cdf6ea58f5e",
      "createdBy" : "ba70b0ae-c096-44f5-8501-0cdf6ea58f5e",
      "createdAt" : "2021-07-26T20:03:40.973368Z",
      "updatedAt" : "2021-07-26T20:03:40.973368Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:40.973201Z",
      "networkId" : "a29c5ebc-8d66-405c-b246-392166a3adba",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "3d338b8f-ece8-4f13-b2cc-70b46a4451b8",
        "networkId" : "a29c5ebc-8d66-405c-b246-392166a3adba",
        "edgeRouterId" : "32022f1e-efb4-4dde-97fe-f77e5ac0915a",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:40.974845Z",
        "issuedAt" : "2021-07-26T20:03:40.974847Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:40.975029Z",
        "createdBy" : "ba70b0ae-c096-44f5-8501-0cdf6ea58f5e",
        "updatedAt" : "2021-07-26T20:03:40.975029Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a29c5ebc-8d66-405c-b246-392166a3adba",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/32022f1e-efb4-4dde-97fe-f77e5ac0915a"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/3fc94baf-bc60-40d9-b255-aae7d943919d"
        }
      }
    }, {
      "id" : "34b01fdf-6862-4c18-97a0-a2bb4fc4be97",
      "hostId" : "5b515159-0cdd-424e-9d8d-d0ec42ced0b2",
      "ownerIdentityId" : "f8f2357d-720b-46e9-a2c2-a051f566b002",
      "createdBy" : "f8f2357d-720b-46e9-a2c2-a051f566b002",
      "createdAt" : "2021-07-26T20:03:41.885Z",
      "updatedAt" : "2021-07-26T20:03:41.885Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.884831Z",
      "networkId" : "31134556-e155-4e93-9598-72055e48e29a",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "8531ebed-3db4-424c-938c-fb36f5bfbf46",
        "networkId" : "31134556-e155-4e93-9598-72055e48e29a",
        "edgeRouterId" : "34b01fdf-6862-4c18-97a0-a2bb4fc4be97",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.886504Z",
        "issuedAt" : "2021-07-26T20:03:41.886507Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.886695Z",
        "createdBy" : "f8f2357d-720b-46e9-a2c2-a051f566b002",
        "updatedAt" : "2021-07-26T20:03:41.886695Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/31134556-e155-4e93-9598-72055e48e29a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/34b01fdf-6862-4c18-97a0-a2bb4fc4be97"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/5b515159-0cdd-424e-9d8d-d0ec42ced0b2"
        }
      }
    }, {
      "id" : "34f43658-05bb-4daf-a8a9-db4cb5c14ff9",
      "hostId" : "6f623133-bcda-4b00-afa2-a59d4685bdd2",
      "ownerIdentityId" : "a145dd6f-a417-4546-86b6-edddab71f126",
      "createdBy" : "a145dd6f-a417-4546-86b6-edddab71f126",
      "createdAt" : "2021-07-26T20:03:40.998068Z",
      "updatedAt" : "2021-07-26T20:03:41.013424Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "9560bc94-d32e-4683-bf92-22f913d2bda5",
      "name" : "Reissue EdgeRouter Test 2021-07-26T20:03:40.978365Z",
      "networkId" : "a29c5ebc-8d66-405c-b246-392166a3adba",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : false,
      "status" : "PROVISIONED",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a29c5ebc-8d66-405c-b246-392166a3adba",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/34f43658-05bb-4daf-a8a9-db4cb5c14ff9"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/6f623133-bcda-4b00-afa2-a59d4685bdd2"
        }
      }
    }, {
      "id" : "354a3849-301e-4c68-9d17-c50221934668",
      "hostId" : "58178600-22b2-4f5e-8cc7-0eb7b3465d55",
      "ownerIdentityId" : "ba70b0ae-c096-44f5-8501-0cdf6ea58f5e",
      "createdBy" : "ba70b0ae-c096-44f5-8501-0cdf6ea58f5e",
      "createdAt" : "2021-07-26T20:03:40.971023Z",
      "updatedAt" : "2021-07-26T20:03:40.971023Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:40.970846Z",
      "networkId" : "a29c5ebc-8d66-405c-b246-392166a3adba",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a29c5ebc-8d66-405c-b246-392166a3adba",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/354a3849-301e-4c68-9d17-c50221934668"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/58178600-22b2-4f5e-8cc7-0eb7b3465d55"
        }
      }
    }, {
      "id" : "35ea0cdf-ba13-4ba2-a13f-50b3aa07ebf2",
      "hostId" : "826e359e-2b6e-43f3-9a97-479dad4a91b0",
      "ownerIdentityId" : "abd1ff40-8ab9-448b-b725-9d175c8dc825",
      "createdBy" : "abd1ff40-8ab9-448b-b725-9d175c8dc825",
      "createdAt" : "2021-07-26T20:03:41.387039Z",
      "updatedAt" : "2021-07-26T20:03:41.387039Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.386865Z",
      "networkId" : "20bcaf7a-c288-4a6d-b013-e4c7c22c1336",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "f1ef2baa-6337-4191-ba75-d4a9f5f7809e",
        "networkId" : "20bcaf7a-c288-4a6d-b013-e4c7c22c1336",
        "edgeRouterId" : "35ea0cdf-ba13-4ba2-a13f-50b3aa07ebf2",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.388500Z",
        "issuedAt" : "2021-07-26T20:03:41.388503Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.388679Z",
        "createdBy" : "abd1ff40-8ab9-448b-b725-9d175c8dc825",
        "updatedAt" : "2021-07-26T20:03:41.388679Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/20bcaf7a-c288-4a6d-b013-e4c7c22c1336",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/35ea0cdf-ba13-4ba2-a13f-50b3aa07ebf2"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/826e359e-2b6e-43f3-9a97-479dad4a91b0"
        }
      }
    }, {
      "id" : "396d1d00-938f-4ef4-8edc-d002f9933fdb",
      "hostId" : "0f52f9df-1211-474d-a0de-3086bc90126a",
      "ownerIdentityId" : "61454e9d-8e88-4d16-9ed0-9555018b06f4",
      "createdBy" : "61454e9d-8e88-4d16-9ed0-9555018b06f4",
      "createdAt" : "2021-07-26T20:03:41.734384Z",
      "updatedAt" : "2021-07-26T20:03:41.734384Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.734218Z",
      "networkId" : "dc17c061-0f7a-43cb-8844-33a4689e96e1",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "bb5d7c9e-7f36-4101-ba2e-f30462ca3d80",
        "networkId" : "dc17c061-0f7a-43cb-8844-33a4689e96e1",
        "edgeRouterId" : "396d1d00-938f-4ef4-8edc-d002f9933fdb",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.735803Z",
        "issuedAt" : "2021-07-26T20:03:41.735806Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.735980Z",
        "createdBy" : "61454e9d-8e88-4d16-9ed0-9555018b06f4",
        "updatedAt" : "2021-07-26T20:03:41.735980Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dc17c061-0f7a-43cb-8844-33a4689e96e1",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/396d1d00-938f-4ef4-8edc-d002f9933fdb"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/0f52f9df-1211-474d-a0de-3086bc90126a"
        }
      }
    }, {
      "id" : "40290313-71b6-424a-818d-35c4250def8a",
      "hostId" : "1d58aef3-a1d4-4cf4-9816-52da042c0c40",
      "ownerIdentityId" : "9e202ea9-2f04-4a05-ba93-49fbc3267212",
      "createdBy" : "9e202ea9-2f04-4a05-ba93-49fbc3267212",
      "createdAt" : "2021-07-26T20:03:41.500140Z",
      "updatedAt" : "2021-07-26T20:03:41.500140Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.499967Z",
      "networkId" : "356ebc75-22d2-44ed-b894-58bfd24c6441",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "bab92fcc-bb2c-4be7-9194-0fffd367ead2",
        "networkId" : "356ebc75-22d2-44ed-b894-58bfd24c6441",
        "edgeRouterId" : "40290313-71b6-424a-818d-35c4250def8a",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.501638Z",
        "issuedAt" : "2021-07-26T20:03:41.501642Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.501824Z",
        "createdBy" : "9e202ea9-2f04-4a05-ba93-49fbc3267212",
        "updatedAt" : "2021-07-26T20:03:41.501824Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/356ebc75-22d2-44ed-b894-58bfd24c6441",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/40290313-71b6-424a-818d-35c4250def8a"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/1d58aef3-a1d4-4cf4-9816-52da042c0c40"
        }
      }
    }, {
      "id" : "40e11554-0b78-4ab9-a0a8-39716b3708e6",
      "hostId" : "91b23a0c-a8ee-49b7-a4e9-77cdd18d09c3",
      "ownerIdentityId" : "61454e9d-8e88-4d16-9ed0-9555018b06f4",
      "createdBy" : "61454e9d-8e88-4d16-9ed0-9555018b06f4",
      "createdAt" : "2021-07-26T20:03:41.733209Z",
      "updatedAt" : "2021-07-26T20:03:41.733209Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.733033Z",
      "networkId" : "dc17c061-0f7a-43cb-8844-33a4689e96e1",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dc17c061-0f7a-43cb-8844-33a4689e96e1",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/40e11554-0b78-4ab9-a0a8-39716b3708e6"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/91b23a0c-a8ee-49b7-a4e9-77cdd18d09c3"
        }
      }
    }, {
      "id" : "4f9de36e-42bf-4b7e-ad81-eaa0d7592705",
      "hostId" : "be7d3868-d5b2-4f28-ab8f-639d4c9dd99b",
      "ownerIdentityId" : "9e202ea9-2f04-4a05-ba93-49fbc3267212",
      "createdBy" : "9e202ea9-2f04-4a05-ba93-49fbc3267212",
      "createdAt" : "2021-07-26T20:03:41.497770Z",
      "updatedAt" : "2021-07-26T20:03:41.497770Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.497585Z",
      "networkId" : "356ebc75-22d2-44ed-b894-58bfd24c6441",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/356ebc75-22d2-44ed-b894-58bfd24c6441",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/4f9de36e-42bf-4b7e-ad81-eaa0d7592705"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/be7d3868-d5b2-4f28-ab8f-639d4c9dd99b"
        }
      }
    }, {
      "id" : "5466107e-9123-4961-bb8a-8f804ad30865",
      "hostId" : "1b8a26c8-f49e-4884-b3b6-5c146bba52bc",
      "ownerIdentityId" : "1f54475e-3d92-4dd7-8607-a4ef4267a4ae",
      "createdBy" : "1f54475e-3d92-4dd7-8607-a4ef4267a4ae",
      "createdAt" : "2021-07-26T20:03:40.913187Z",
      "updatedAt" : "2021-07-26T20:03:40.913187Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:40.913001Z",
      "networkId" : "b99f4958-ed28-4427-a823-403b4fa65170",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b99f4958-ed28-4427-a823-403b4fa65170",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/5466107e-9123-4961-bb8a-8f804ad30865"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/1b8a26c8-f49e-4884-b3b6-5c146bba52bc"
        }
      }
    }, {
      "id" : "56c32519-71da-4d0e-9344-4d4538dd7a0f",
      "hostId" : null,
      "ownerIdentityId" : "b9c1d395-e325-4f96-aa95-96660a677019",
      "createdBy" : "b9c1d395-e325-4f96-aa95-96660a677019",
      "createdAt" : "2021-07-26T20:03:41.517923Z",
      "updatedAt" : "2021-07-26T20:03:41.528038Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "b5cc8570-5f5d-4a76-b5b8-1af1f7868990",
      "name" : "Test edge router 1627329821",
      "networkId" : "356ebc75-22d2-44ed-b894-58bfd24c6441",
      "jwt" : null,
      "linkListener" : false,
      "tunnelerEnabled" : false,
      "online" : false,
      "verified" : false,
      "status" : "ERROR",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/356ebc75-22d2-44ed-b894-58bfd24c6441",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/56c32519-71da-4d0e-9344-4d4538dd7a0f"
        }
      }
    }, {
      "id" : "5b712a7b-75ae-4edc-8e08-0e236683cea8",
      "hostId" : null,
      "ownerIdentityId" : "3adcc961-2cdc-4e25-bc25-ea47e58b4798",
      "createdBy" : "3adcc961-2cdc-4e25-bc25-ea47e58b4798",
      "createdAt" : "2021-07-26T20:03:40.779209Z",
      "updatedAt" : "2021-07-26T20:03:40.792825Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "eb27c83b-688d-4315-b5e9-36ae6904cf94",
      "name" : "Test edge router 1627329820",
      "networkId" : "4b697156-de61-4c4d-8cd1-6e6cbcca09b0",
      "jwt" : null,
      "linkListener" : false,
      "tunnelerEnabled" : false,
      "online" : false,
      "verified" : false,
      "status" : "ERROR",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4b697156-de61-4c4d-8cd1-6e6cbcca09b0",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/5b712a7b-75ae-4edc-8e08-0e236683cea8"
        }
      }
    }, {
      "id" : "61cac419-0a51-4434-95c4-c2a95abcbc18",
      "hostId" : "dd79ff75-5b32-4daf-a4fa-b01cb5a880a0",
      "ownerIdentityId" : "fc482a0b-5c3e-434c-8c83-7ecfb1d86dcc",
      "createdBy" : "fc482a0b-5c3e-434c-8c83-7ecfb1d86dcc",
      "createdAt" : "2021-07-26T20:03:41.599145Z",
      "updatedAt" : "2021-07-26T20:03:41.599145Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.598961Z",
      "networkId" : "f8b7b627-1b5a-4d57-bce3-f92fdd81a700",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f8b7b627-1b5a-4d57-bce3-f92fdd81a700",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/61cac419-0a51-4434-95c4-c2a95abcbc18"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/dd79ff75-5b32-4daf-a4fa-b01cb5a880a0"
        }
      }
    }, {
      "id" : "66e09b88-6d06-4e6a-b08d-47928beb7700",
      "hostId" : "70ba9836-f958-45ec-8ae5-7ba6d7c3349d",
      "ownerIdentityId" : "abd1ff40-8ab9-448b-b725-9d175c8dc825",
      "createdBy" : "abd1ff40-8ab9-448b-b725-9d175c8dc825",
      "createdAt" : "2021-07-26T20:03:41.385869Z",
      "updatedAt" : "2021-07-26T20:03:41.385869Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.385693Z",
      "networkId" : "20bcaf7a-c288-4a6d-b013-e4c7c22c1336",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/20bcaf7a-c288-4a6d-b013-e4c7c22c1336",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/66e09b88-6d06-4e6a-b08d-47928beb7700"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/70ba9836-f958-45ec-8ae5-7ba6d7c3349d"
        }
      }
    }, {
      "id" : "67c8d4a4-fe65-4c01-9d00-383ea380c80b",
      "hostId" : "25c2f72e-ff49-4812-a657-a96ff7244197",
      "ownerIdentityId" : "b04659fb-1534-466b-acb6-d6b2b4398e4f",
      "createdBy" : "b04659fb-1534-466b-acb6-d6b2b4398e4f",
      "createdAt" : "2021-07-26T20:03:41.066469Z",
      "updatedAt" : "2021-07-26T20:03:41.066469Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.066296Z",
      "networkId" : "4c8694fb-6a84-479f-bc2b-c2a88494c360",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4c8694fb-6a84-479f-bc2b-c2a88494c360",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/67c8d4a4-fe65-4c01-9d00-383ea380c80b"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/25c2f72e-ff49-4812-a657-a96ff7244197"
        }
      }
    }, {
      "id" : "6df0e42b-2f29-40dd-be76-bd1088dadb1c",
      "hostId" : "6c90c75e-509e-4932-8918-22efcdbf3d5c",
      "ownerIdentityId" : "4aeefe76-333f-44d7-a2a4-3d450c84acde",
      "createdBy" : "4aeefe76-333f-44d7-a2a4-3d450c84acde",
      "createdAt" : "2021-07-26T20:03:40.631099Z",
      "updatedAt" : "2021-07-26T20:03:40.631099Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:40.630879Z",
      "networkId" : "4b697156-de61-4c4d-8cd1-6e6cbcca09b0",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4b697156-de61-4c4d-8cd1-6e6cbcca09b0",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/6df0e42b-2f29-40dd-be76-bd1088dadb1c"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/6c90c75e-509e-4932-8918-22efcdbf3d5c"
        }
      }
    }, {
      "id" : "6e68f65a-0923-462d-8c15-3eed2894ea87",
      "hostId" : null,
      "ownerIdentityId" : "03ae07eb-bdfb-4e1b-a82d-def00d506aeb",
      "createdBy" : "03ae07eb-bdfb-4e1b-a82d-def00d506aeb",
      "createdAt" : "2021-07-26T20:03:41.619262Z",
      "updatedAt" : "2021-07-26T20:03:41.628704Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "48fff512-5a49-4d7e-830e-28bb79166e2f",
      "name" : "Test edge router 1627329821",
      "networkId" : "f8b7b627-1b5a-4d57-bce3-f92fdd81a700",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : false,
      "online" : false,
      "verified" : false,
      "status" : "ERROR",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f8b7b627-1b5a-4d57-bce3-f92fdd81a700",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/6e68f65a-0923-462d-8c15-3eed2894ea87"
        }
      }
    }, {
      "id" : "6eb6a1d8-040c-41d5-9cae-925bdda1f9d3",
      "hostId" : "736c1038-3097-449e-bf40-74d9e4966c7a",
      "ownerIdentityId" : "46e47558-8b77-4338-a1bb-c7f4d1956c25",
      "createdBy" : "46e47558-8b77-4338-a1bb-c7f4d1956c25",
      "createdAt" : "2021-07-26T20:03:41.964835Z",
      "updatedAt" : "2021-07-26T20:03:41.964835Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.964663Z",
      "networkId" : "ef50109c-cec4-4cdf-bf68-74c7f95f0d20",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "c7722169-a63b-4612-b298-7b8a77752afc",
        "networkId" : "ef50109c-cec4-4cdf-bf68-74c7f95f0d20",
        "edgeRouterId" : "6eb6a1d8-040c-41d5-9cae-925bdda1f9d3",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.966431Z",
        "issuedAt" : "2021-07-26T20:03:41.966434Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.966623Z",
        "createdBy" : "46e47558-8b77-4338-a1bb-c7f4d1956c25",
        "updatedAt" : "2021-07-26T20:03:41.966623Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ef50109c-cec4-4cdf-bf68-74c7f95f0d20",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/6eb6a1d8-040c-41d5-9cae-925bdda1f9d3"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/736c1038-3097-449e-bf40-74d9e4966c7a"
        }
      }
    }, {
      "id" : "6f38c364-b404-42ec-b7a8-9a2b7536a130",
      "hostId" : "e71ad4bf-79a0-4838-84a4-91ba338f430c",
      "ownerIdentityId" : "2fc68558-9b0d-4edd-9032-0ea3899ad3df",
      "createdBy" : "2fc68558-9b0d-4edd-9032-0ea3899ad3df",
      "createdAt" : "2021-07-26T20:03:41.115272Z",
      "updatedAt" : "2021-07-26T20:03:41.115272Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.115093Z",
      "networkId" : "2d59683f-65a4-457e-8740-7968c244c942",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2d59683f-65a4-457e-8740-7968c244c942",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/6f38c364-b404-42ec-b7a8-9a2b7536a130"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/e71ad4bf-79a0-4838-84a4-91ba338f430c"
        }
      }
    }, {
      "id" : "70c966ef-d823-415f-bb70-17a796cdedbe",
      "hostId" : "e3099f71-716e-4158-8592-c427a159ec7c",
      "ownerIdentityId" : "1f54475e-3d92-4dd7-8607-a4ef4267a4ae",
      "createdBy" : "1f54475e-3d92-4dd7-8607-a4ef4267a4ae",
      "createdAt" : "2021-07-26T20:03:40.915500Z",
      "updatedAt" : "2021-07-26T20:03:40.915500Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:40.915327Z",
      "networkId" : "b99f4958-ed28-4427-a823-403b4fa65170",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "8da90392-ea8e-411a-b233-0b79a61ef07b",
        "networkId" : "b99f4958-ed28-4427-a823-403b4fa65170",
        "edgeRouterId" : "70c966ef-d823-415f-bb70-17a796cdedbe",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:40.917292Z",
        "issuedAt" : "2021-07-26T20:03:40.917295Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:40.917476Z",
        "createdBy" : "1f54475e-3d92-4dd7-8607-a4ef4267a4ae",
        "updatedAt" : "2021-07-26T20:03:40.917476Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b99f4958-ed28-4427-a823-403b4fa65170",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/70c966ef-d823-415f-bb70-17a796cdedbe"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/e3099f71-716e-4158-8592-c427a159ec7c"
        }
      }
    }, {
      "id" : "7b11dbf9-1b5e-44e1-8fcb-d4e54e34ba4a",
      "hostId" : "4e1d39ed-bf87-4ded-b9e0-61d762552cb6",
      "ownerIdentityId" : "fc482a0b-5c3e-434c-8c83-7ecfb1d86dcc",
      "createdBy" : "fc482a0b-5c3e-434c-8c83-7ecfb1d86dcc",
      "createdAt" : "2021-07-26T20:03:41.600340Z",
      "updatedAt" : "2021-07-26T20:03:41.600340Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.600169Z",
      "networkId" : "f8b7b627-1b5a-4d57-bce3-f92fdd81a700",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f8b7b627-1b5a-4d57-bce3-f92fdd81a700",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/7b11dbf9-1b5e-44e1-8fcb-d4e54e34ba4a"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/4e1d39ed-bf87-4ded-b9e0-61d762552cb6"
        }
      }
    }, {
      "id" : "7f2c64bc-5c51-4dcf-8b64-5ec3e7cad354",
      "hostId" : "a987ea31-a15d-461e-9492-a9c9d55896d8",
      "ownerIdentityId" : "ba70b0ae-c096-44f5-8501-0cdf6ea58f5e",
      "createdBy" : "ba70b0ae-c096-44f5-8501-0cdf6ea58f5e",
      "createdAt" : "2021-07-26T20:03:40.972237Z",
      "updatedAt" : "2021-07-26T20:03:40.972237Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:40.972062Z",
      "networkId" : "a29c5ebc-8d66-405c-b246-392166a3adba",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a29c5ebc-8d66-405c-b246-392166a3adba",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/7f2c64bc-5c51-4dcf-8b64-5ec3e7cad354"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/a987ea31-a15d-461e-9492-a9c9d55896d8"
        }
      }
    }, {
      "id" : "88fe2ead-ce42-4253-891c-f414acd5dc3e",
      "hostId" : "c1a74139-e741-4f58-a900-e6db04a9bf42",
      "ownerIdentityId" : "b69ddff0-2a56-4201-9590-35f03650b21f",
      "createdBy" : "b69ddff0-2a56-4201-9590-35f03650b21f",
      "createdAt" : "2021-07-26T20:03:41.686346Z",
      "updatedAt" : "2021-07-26T20:03:41.686346Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.686172Z",
      "networkId" : "c9f7243e-4d56-47c0-ae9d-41df716a7a18",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "6e6fa2a9-cea2-41cd-b600-c8284e605434",
        "networkId" : "c9f7243e-4d56-47c0-ae9d-41df716a7a18",
        "edgeRouterId" : "88fe2ead-ce42-4253-891c-f414acd5dc3e",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.687789Z",
        "issuedAt" : "2021-07-26T20:03:41.687793Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.687973Z",
        "createdBy" : "b69ddff0-2a56-4201-9590-35f03650b21f",
        "updatedAt" : "2021-07-26T20:03:41.687973Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c9f7243e-4d56-47c0-ae9d-41df716a7a18",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/88fe2ead-ce42-4253-891c-f414acd5dc3e"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/c1a74139-e741-4f58-a900-e6db04a9bf42"
        }
      }
    }, {
      "id" : "8e14e276-9bc7-4e64-b104-9a91adaea7d0",
      "hostId" : "d19a8d93-bd2b-455a-a07f-cef0d23874bf",
      "ownerIdentityId" : "2fc68558-9b0d-4edd-9032-0ea3899ad3df",
      "createdBy" : "2fc68558-9b0d-4edd-9032-0ea3899ad3df",
      "createdAt" : "2021-07-26T20:03:41.117852Z",
      "updatedAt" : "2021-07-26T20:03:41.117852Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.117617Z",
      "networkId" : "2d59683f-65a4-457e-8740-7968c244c942",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "5b6551f2-b432-48a2-a383-84581e211701",
        "networkId" : "2d59683f-65a4-457e-8740-7968c244c942",
        "edgeRouterId" : "8e14e276-9bc7-4e64-b104-9a91adaea7d0",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.119650Z",
        "issuedAt" : "2021-07-26T20:03:41.119653Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.119851Z",
        "createdBy" : "2fc68558-9b0d-4edd-9032-0ea3899ad3df",
        "updatedAt" : "2021-07-26T20:03:41.119851Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2d59683f-65a4-457e-8740-7968c244c942",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/8e14e276-9bc7-4e64-b104-9a91adaea7d0"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/d19a8d93-bd2b-455a-a07f-cef0d23874bf"
        }
      }
    }, {
      "id" : "8f61d7a1-1945-4465-bd9a-88565817e842",
      "hostId" : "9308599e-9dc3-4ca9-9a22-707d77a47cdd",
      "ownerIdentityId" : "f8f2357d-720b-46e9-a2c2-a051f566b002",
      "createdBy" : "f8f2357d-720b-46e9-a2c2-a051f566b002",
      "createdAt" : "2021-07-26T20:03:41.882606Z",
      "updatedAt" : "2021-07-26T20:03:41.913268Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "Updated name",
      "networkId" : "31134556-e155-4e93-9598-72055e48e29a",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/31134556-e155-4e93-9598-72055e48e29a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/8f61d7a1-1945-4465-bd9a-88565817e842"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/9308599e-9dc3-4ca9-9a22-707d77a47cdd"
        }
      }
    }, {
      "id" : "9401570b-322b-44dc-a3a3-c66507b020a8",
      "hostId" : "039e05ef-3db1-4f35-a2d3-065092171063",
      "ownerIdentityId" : "b04659fb-1534-466b-acb6-d6b2b4398e4f",
      "createdBy" : "b04659fb-1534-466b-acb6-d6b2b4398e4f",
      "createdAt" : "2021-07-26T20:03:41.065256Z",
      "updatedAt" : "2021-07-26T20:03:41.065256Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.065077Z",
      "networkId" : "4c8694fb-6a84-479f-bc2b-c2a88494c360",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4c8694fb-6a84-479f-bc2b-c2a88494c360",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/9401570b-322b-44dc-a3a3-c66507b020a8"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/039e05ef-3db1-4f35-a2d3-065092171063"
        }
      }
    }, {
      "id" : "945bd1ac-9af2-4f13-807a-2699463c611c",
      "hostId" : "7af577fd-4caa-4057-b389-6640aa40730d",
      "ownerIdentityId" : "9f02362d-108a-475c-87bb-28fa256c10ba",
      "createdBy" : "9f02362d-108a-475c-87bb-28fa256c10ba",
      "createdAt" : "2021-07-26T20:03:41.338115Z",
      "updatedAt" : "2021-07-26T20:03:41.338115Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.337940Z",
      "networkId" : "a55018a4-0869-49bf-b9c3-c44104066a15",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a55018a4-0869-49bf-b9c3-c44104066a15",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/945bd1ac-9af2-4f13-807a-2699463c611c"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/7af577fd-4caa-4057-b389-6640aa40730d"
        }
      }
    }, {
      "id" : "9a0ae132-dbe5-4563-9e6a-40922914827a",
      "hostId" : "9c63ff5b-c1a0-4334-9c64-625ac574c7a2",
      "ownerIdentityId" : "9f02362d-108a-475c-87bb-28fa256c10ba",
      "createdBy" : "9f02362d-108a-475c-87bb-28fa256c10ba",
      "createdAt" : "2021-07-26T20:03:41.336891Z",
      "updatedAt" : "2021-07-26T20:03:41.336891Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.336717Z",
      "networkId" : "a55018a4-0869-49bf-b9c3-c44104066a15",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a55018a4-0869-49bf-b9c3-c44104066a15",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/9a0ae132-dbe5-4563-9e6a-40922914827a"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/9c63ff5b-c1a0-4334-9c64-625ac574c7a2"
        }
      }
    }, {
      "id" : "a5189fc2-d8db-42c2-94ba-c9b4f0b556e3",
      "hostId" : "10409ecf-47df-4443-ade2-d8f7b617fb37",
      "ownerIdentityId" : "2fc68558-9b0d-4edd-9032-0ea3899ad3df",
      "createdBy" : "2fc68558-9b0d-4edd-9032-0ea3899ad3df",
      "createdAt" : "2021-07-26T20:03:41.116428Z",
      "updatedAt" : "2021-07-26T20:03:41.116428Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.116262Z",
      "networkId" : "2d59683f-65a4-457e-8740-7968c244c942",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2d59683f-65a4-457e-8740-7968c244c942",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/a5189fc2-d8db-42c2-94ba-c9b4f0b556e3"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/10409ecf-47df-4443-ade2-d8f7b617fb37"
        }
      }
    }, {
      "id" : "a836e8de-e37f-4471-ba82-290cf2d922c3",
      "hostId" : "c13d5a49-4464-41eb-96ee-d9216b9e554b",
      "ownerIdentityId" : "4aeefe76-333f-44d7-a2a4-3d450c84acde",
      "createdBy" : "4aeefe76-333f-44d7-a2a4-3d450c84acde",
      "createdAt" : "2021-07-26T20:03:40.629142Z",
      "updatedAt" : "2021-07-26T20:03:40.629142Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:40.628847Z",
      "networkId" : "4b697156-de61-4c4d-8cd1-6e6cbcca09b0",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4b697156-de61-4c4d-8cd1-6e6cbcca09b0",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/a836e8de-e37f-4471-ba82-290cf2d922c3"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/c13d5a49-4464-41eb-96ee-d9216b9e554b"
        }
      }
    }, {
      "id" : "b66bbabe-4f22-4b83-8b05-e5b66885b4a8",
      "hostId" : "cdac1b1b-2f88-43b7-bd73-0d58d1b5f086",
      "ownerIdentityId" : "f8f2357d-720b-46e9-a2c2-a051f566b002",
      "createdBy" : "f8f2357d-720b-46e9-a2c2-a051f566b002",
      "createdAt" : "2021-07-26T20:03:41.883833Z",
      "updatedAt" : "2021-07-26T20:03:41.883833Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.883658Z",
      "networkId" : "31134556-e155-4e93-9598-72055e48e29a",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/31134556-e155-4e93-9598-72055e48e29a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/b66bbabe-4f22-4b83-8b05-e5b66885b4a8"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/cdac1b1b-2f88-43b7-bd73-0d58d1b5f086"
        }
      }
    }, {
      "id" : "c33d0d63-62a2-4828-9739-62edd32920b9",
      "hostId" : "9243aa08-bc12-46cc-9e6e-5758b29ee89c",
      "ownerIdentityId" : "46e47558-8b77-4338-a1bb-c7f4d1956c25",
      "createdBy" : "46e47558-8b77-4338-a1bb-c7f4d1956c25",
      "createdAt" : "2021-07-26T20:03:41.963617Z",
      "updatedAt" : "2021-07-26T20:03:41.963617Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.963441Z",
      "networkId" : "ef50109c-cec4-4cdf-bf68-74c7f95f0d20",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ef50109c-cec4-4cdf-bf68-74c7f95f0d20",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/c33d0d63-62a2-4828-9739-62edd32920b9"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/9243aa08-bc12-46cc-9e6e-5758b29ee89c"
        }
      }
    }, {
      "id" : "c7c0272f-1905-449b-82b3-8d0c99c89cc0",
      "hostId" : "95ef7332-5c40-4d5e-b561-04e4765eab15",
      "ownerIdentityId" : "fc482a0b-5c3e-434c-8c83-7ecfb1d86dcc",
      "createdBy" : "fc482a0b-5c3e-434c-8c83-7ecfb1d86dcc",
      "createdAt" : "2021-07-26T20:03:41.601489Z",
      "updatedAt" : "2021-07-26T20:03:41.601489Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.601318Z",
      "networkId" : "f8b7b627-1b5a-4d57-bce3-f92fdd81a700",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "81c41b1a-daac-440a-9ad5-7efc99837a30",
        "networkId" : "f8b7b627-1b5a-4d57-bce3-f92fdd81a700",
        "edgeRouterId" : "c7c0272f-1905-449b-82b3-8d0c99c89cc0",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.602971Z",
        "issuedAt" : "2021-07-26T20:03:41.602974Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.603150Z",
        "createdBy" : "fc482a0b-5c3e-434c-8c83-7ecfb1d86dcc",
        "updatedAt" : "2021-07-26T20:03:41.603150Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f8b7b627-1b5a-4d57-bce3-f92fdd81a700",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/c7c0272f-1905-449b-82b3-8d0c99c89cc0"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/95ef7332-5c40-4d5e-b561-04e4765eab15"
        }
      }
    }, {
      "id" : "cde2fa26-98a8-4a49-a812-b2b2b0a8f822",
      "hostId" : "2ffe99bc-26e5-4b2f-a5b8-14d7fe84d898",
      "ownerIdentityId" : "f6bba82a-280f-418b-afbb-e1d9951f1aeb",
      "createdBy" : "f6bba82a-280f-418b-afbb-e1d9951f1aeb",
      "createdAt" : "2021-07-26T20:03:41.796245Z",
      "updatedAt" : "2021-07-26T20:03:41.796245Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.796062Z",
      "networkId" : "e65deb15-29a9-4a3d-bc06-87841c132432",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e65deb15-29a9-4a3d-bc06-87841c132432",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/cde2fa26-98a8-4a49-a812-b2b2b0a8f822"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/2ffe99bc-26e5-4b2f-a5b8-14d7fe84d898"
        }
      }
    }, {
      "id" : "d110d0e4-4730-4b42-8a26-ee7aa322f70d",
      "hostId" : "abf7ebc6-6812-4e0a-aa8a-ae9437db6d60",
      "ownerIdentityId" : "4aeefe76-333f-44d7-a2a4-3d450c84acde",
      "createdBy" : "4aeefe76-333f-44d7-a2a4-3d450c84acde",
      "createdAt" : "2021-07-26T20:03:40.632546Z",
      "updatedAt" : "2021-07-26T20:03:40.632546Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:40.632332Z",
      "networkId" : "4b697156-de61-4c4d-8cd1-6e6cbcca09b0",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "43cdd4e1-935e-478b-babe-e9b87d375ca8",
        "networkId" : "4b697156-de61-4c4d-8cd1-6e6cbcca09b0",
        "edgeRouterId" : "d110d0e4-4730-4b42-8a26-ee7aa322f70d",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:40.634516Z",
        "issuedAt" : "2021-07-26T20:03:40.634520Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:40.634741Z",
        "createdBy" : "4aeefe76-333f-44d7-a2a4-3d450c84acde",
        "updatedAt" : "2021-07-26T20:03:40.634741Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4b697156-de61-4c4d-8cd1-6e6cbcca09b0",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/d110d0e4-4730-4b42-8a26-ee7aa322f70d"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/abf7ebc6-6812-4e0a-aa8a-ae9437db6d60"
        }
      }
    }, {
      "id" : "d437a252-4512-4911-a0e0-eb63fe113fd0",
      "hostId" : "207f18e1-d7af-4612-b8a1-54e40c5ac0ac",
      "ownerIdentityId" : "f6bba82a-280f-418b-afbb-e1d9951f1aeb",
      "createdBy" : "f6bba82a-280f-418b-afbb-e1d9951f1aeb",
      "createdAt" : "2021-07-26T20:03:41.798612Z",
      "updatedAt" : "2021-07-26T20:03:41.798612Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.798443Z",
      "networkId" : "e65deb15-29a9-4a3d-bc06-87841c132432",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "af1b1726-61f2-4432-a39a-5dca7468bff8",
        "networkId" : "e65deb15-29a9-4a3d-bc06-87841c132432",
        "edgeRouterId" : "d437a252-4512-4911-a0e0-eb63fe113fd0",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.800056Z",
        "issuedAt" : "2021-07-26T20:03:41.800059Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.800233Z",
        "createdBy" : "f6bba82a-280f-418b-afbb-e1d9951f1aeb",
        "updatedAt" : "2021-07-26T20:03:41.800233Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e65deb15-29a9-4a3d-bc06-87841c132432",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/d437a252-4512-4911-a0e0-eb63fe113fd0"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/207f18e1-d7af-4612-b8a1-54e40c5ac0ac"
        }
      }
    }, {
      "id" : "d72704f0-7d33-4eac-817f-2cd3928b961c",
      "hostId" : "0b9d5d77-b022-42b1-8f81-8994c0359239",
      "ownerIdentityId" : "f6bba82a-280f-418b-afbb-e1d9951f1aeb",
      "createdBy" : "f6bba82a-280f-418b-afbb-e1d9951f1aeb",
      "createdAt" : "2021-07-26T20:03:41.797427Z",
      "updatedAt" : "2021-07-26T20:03:41.830601Z",
      "deletedBy" : "3f421a18-8309-42aa-a311-7ac0eb87aa0d",
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.797258Z",
      "networkId" : "e65deb15-29a9-4a3d-bc06-87841c132432",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "ERROR",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e65deb15-29a9-4a3d-bc06-87841c132432",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/d72704f0-7d33-4eac-817f-2cd3928b961c"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/0b9d5d77-b022-42b1-8f81-8994c0359239"
        }
      }
    }, {
      "id" : "da7b41e8-3a9c-4006-a0ec-19b13a1cdaa2",
      "hostId" : "28c0cc97-b4af-440b-b0ec-9ee58c1b30fe",
      "ownerIdentityId" : "61454e9d-8e88-4d16-9ed0-9555018b06f4",
      "createdBy" : "61454e9d-8e88-4d16-9ed0-9555018b06f4",
      "createdAt" : "2021-07-26T20:03:41.731992Z",
      "updatedAt" : "2021-07-26T20:03:41.731992Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.731810Z",
      "networkId" : "dc17c061-0f7a-43cb-8844-33a4689e96e1",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dc17c061-0f7a-43cb-8844-33a4689e96e1",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/da7b41e8-3a9c-4006-a0ec-19b13a1cdaa2"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/28c0cc97-b4af-440b-b0ec-9ee58c1b30fe"
        }
      }
    }, {
      "id" : "e6d294c9-3b97-4b3d-98cd-853948774e47",
      "hostId" : "c4d96b45-5f45-4f36-8bd6-e1a42ba355e7",
      "ownerIdentityId" : "b69ddff0-2a56-4201-9590-35f03650b21f",
      "createdBy" : "b69ddff0-2a56-4201-9590-35f03650b21f",
      "createdAt" : "2021-07-26T20:03:41.685161Z",
      "updatedAt" : "2021-07-26T20:03:41.685161Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.684980Z",
      "networkId" : "c9f7243e-4d56-47c0-ae9d-41df716a7a18",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c9f7243e-4d56-47c0-ae9d-41df716a7a18",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/e6d294c9-3b97-4b3d-98cd-853948774e47"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/c4d96b45-5f45-4f36-8bd6-e1a42ba355e7"
        }
      }
    }, {
      "id" : "ed1ac156-5cf4-43e1-85b9-2a2d179475f2",
      "hostId" : "2d55c757-8175-4775-8c46-b2abadf04d1c",
      "ownerIdentityId" : "46e47558-8b77-4338-a1bb-c7f4d1956c25",
      "createdBy" : "46e47558-8b77-4338-a1bb-c7f4d1956c25",
      "createdAt" : "2021-07-26T20:03:41.962394Z",
      "updatedAt" : "2021-07-26T20:03:41.962394Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-07-26T20:03:41.962208Z",
      "networkId" : "ef50109c-cec4-4cdf-bf68-74c7f95f0d20",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ef50109c-cec4-4cdf-bf68-74c7f95f0d20",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/ed1ac156-5cf4-43e1-85b9-2a2d179475f2"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/2d55c757-8175-4775-8c46-b2abadf04d1c"
        }
      }
    }, {
      "id" : "fe64f044-92ca-402c-88d8-f9fe4a473ebd",
      "hostId" : "ed29de6a-dc66-4d26-8550-3ae23f65e657",
      "ownerIdentityId" : "50289a72-d0fb-4c72-a14f-5f8977baf6dd",
      "createdBy" : "50289a72-d0fb-4c72-a14f-5f8977baf6dd",
      "createdAt" : "2021-07-26T20:03:41.444090Z",
      "updatedAt" : "2021-07-26T20:03:41.444090Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-07-26T20:03:41.443913Z",
      "networkId" : "5a7dd052-26da-4a47-887f-80c88adcc085",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5a7dd052-26da-4a47-887f-80c88adcc085",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/fe64f044-92ca-402c-88d8-f9fe4a473ebd"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/ed29de6a-dc66-4d26-8550-3ae23f65e657"
        }
      }
    }, {
      "id" : "fe6f6248-7fd1-42f1-b361-a35c84b6c220",
      "hostId" : "53dd6292-f284-41ad-9d6a-fedf39c77ed4",
      "ownerIdentityId" : "9f02362d-108a-475c-87bb-28fa256c10ba",
      "createdBy" : "9f02362d-108a-475c-87bb-28fa256c10ba",
      "createdAt" : "2021-07-26T20:03:41.339256Z",
      "updatedAt" : "2021-07-26T20:03:41.339256Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.339074Z",
      "networkId" : "a55018a4-0869-49bf-b9c3-c44104066a15",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "55446d75-9152-4ebe-acaa-ea34aa8ccce6",
        "networkId" : "a55018a4-0869-49bf-b9c3-c44104066a15",
        "edgeRouterId" : "fe6f6248-7fd1-42f1-b361-a35c84b6c220",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.340688Z",
        "issuedAt" : "2021-07-26T20:03:41.340690Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.340866Z",
        "createdBy" : "9f02362d-108a-475c-87bb-28fa256c10ba",
        "updatedAt" : "2021-07-26T20:03:41.340866Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a55018a4-0869-49bf-b9c3-c44104066a15",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/fe6f6248-7fd1-42f1-b361-a35c84b6c220"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/53dd6292-f284-41ad-9d6a-fedf39c77ed4"
        }
      }
    }, {
      "id" : "ff792124-e016-4ea4-8268-9d4cf58f5066",
      "hostId" : "58c1bd9c-a280-46d7-beeb-21a471213766",
      "ownerIdentityId" : "50289a72-d0fb-4c72-a14f-5f8977baf6dd",
      "createdBy" : "50289a72-d0fb-4c72-a14f-5f8977baf6dd",
      "createdAt" : "2021-07-26T20:03:41.445247Z",
      "updatedAt" : "2021-07-26T20:03:41.445247Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-07-26T20:03:41.445070Z",
      "networkId" : "5a7dd052-26da-4a47-887f-80c88adcc085",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "registration" : {
        "id" : "c9ba35de-0468-405d-bd5a-c4c1db9d8c3c",
        "networkId" : "5a7dd052-26da-4a47-887f-80c88adcc085",
        "edgeRouterId" : "ff792124-e016-4ea4-8268-9d4cf58f5066",
        "registrationAttempts" : 0,
        "expiresAt" : "2021-07-29T20:03:41.446710Z",
        "issuedAt" : "2021-07-26T20:03:41.446713Z",
        "usedAt" : null,
        "createdAt" : "2021-07-26T20:03:41.446893Z",
        "createdBy" : "50289a72-d0fb-4c72-a14f-5f8977baf6dd",
        "updatedAt" : "2021-07-26T20:03:41.446893Z",
        "deletedAt" : null,
        "deletedBy" : null
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5a7dd052-26da-4a47-887f-80c88adcc085",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/ff792124-e016-4ea4-8268-9d4cf58f5066"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/58c1bd9c-a280-46d7-beeb-21a471213766"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 49,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edge Router

GET /edge-routers/{id}

Authorization

This endpoint requires read action on the edge-router resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

hostId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

jwt

String

true

linkListener

Boolean

true

tunnelerEnabled

Boolean

true

online

Boolean

true

verified

Boolean

true

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

attributes

Array[String]

false

registration

Object

true

registration.id

String

false

registration.networkId

String

false

registration.edgeRouterId

String

false

registration.registrationAttempts

Integer

true

registration.expiresAt

String

false

registration.issuedAt

String

false

registration.usedAt

String

true

registration.createdAt

String

false

registration.createdBy

String

false

registration.updatedAt

String

false

registration.deletedAt

String

true

registration.deletedBy

String

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/dfa091a1-9f86-497a-8e59-9b0be5f50db4' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJKbDR1X1ZLSWNfUFg4b1Rzb0RmV1R3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZiZjI5OTYwLWQwMTgtNGY5Yy04MGMxLTMwMzdiOTg1YjlkMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTgyMiwiZXhwIjoxNjI3MzMzNDIyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ5MTAxMmIyLThjMmUtNGQ5ZC1hZDkyLWY1N2U2MDkxYWYyOVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTgyMn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.StInPcbLEUuCRwJrhNuHCGUOHG6mAoyqvojweMpszMAUz3ZqJgKi56s0JkfWkzIXGviFDauu2Od175QSDHXyiV9Xqo_luhBp-8rKZ2nO1FdWrNZwIPrSHTSVOtWXRxGpWk3R9FlrUgzzcHI-Ueeq1-aIKODOIleVtSuMCdPDFUtEsRzEf8pMvKauUX8RdtB38a95jnU26ebz8j0XtwipMYjOGDrAPEeouU4FuKDMUSnBbMU0Fnvr3KiqFxreWcIayDKxamvPfckWW7a60fKWYiznvLGAiXRCzq-KSkq6ZmQGwOQzBTjgeks6Om1bFG8di5E2uNXBwTc8z8Bx5iiqug'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1149

{
  "id" : "dfa091a1-9f86-497a-8e59-9b0be5f50db4",
  "hostId" : "f67c7fbf-c92a-4ff4-ab9e-d7ae8c02ecb2",
  "ownerIdentityId" : "37b34280-bbe6-4c6c-b0ff-31abbb018f83",
  "createdBy" : "37b34280-bbe6-4c6c-b0ff-31abbb018f83",
  "createdAt" : "2021-07-26T20:03:42.251340Z",
  "updatedAt" : "2021-07-26T20:03:42.251340Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "zitiEdgeRouterId01",
  "name" : "ACME_edge_router_2021-07-26T20:03:42.251123Z",
  "networkId" : "e68e0f84-ef28-4bc4-8700-9fffe0ecffb1",
  "jwt" : null,
  "linkListener" : true,
  "tunnelerEnabled" : true,
  "online" : false,
  "verified" : true,
  "status" : "PROVISIONING",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e68e0f84-ef28-4bc4-8700-9fffe0ecffb1",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/dfa091a1-9f86-497a-8e59-9b0be5f50db4"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/f67c7fbf-c92a-4ff4-ab9e-d7ae8c02ecb2"
    }
  }
}

Create Edge Router

POST /edge-routers/

Authorization

This endpoint requires create action on the edge-router resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

io.netfoundry.common.util.validation.ValidAs.

networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

dataCenterId

String

true

hostSize

String

true

linkListener

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

tunnelerEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

Response fields

Path Type Optional Description

id

String

false

hostId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

jwt

String

true

linkListener

Boolean

true

tunnelerEnabled

Boolean

true

online

Boolean

true

verified

Boolean

true

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

attributes

Array[String]

false

registration

Object

true

registration.id

String

false

registration.networkId

String

false

registration.edgeRouterId

String

false

registration.registrationAttempts

Integer

true

registration.expiresAt

String

false

registration.issuedAt

String

false

registration.usedAt

String

true

registration.createdAt

String

false

registration.createdBy

String

false

registration.updatedAt

String

false

registration.deletedAt

String

true

registration.deletedBy

String

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJENnlXNldlUEpFbG5sbU1qajBCMmZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI5YzFkMzk1LWUzMjUtNGY5Ni1hYTk1LTk2NjYwYTY3NzAxOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTgyMSwiZXhwIjoxNjI3MzMzNDIxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA0NWM1YzU5LTFmYzgtNGQxYy04ZmM1LWI4NzhmNzczZjZhNFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTgyMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.KQOvt16g4G79Mv8FXmizTkFZye5PsZDeKdmIg1a30wwEkn7WL7IOIXg5ypES3Mx1aY7GsgjBgrfTQS7s9gvWFX_MJV_IMtNpHTXZL4epPn3vCVgqWlR8RSfFTsTBsHQzqd5MAywAZbPwmSQq7E_FSpgeZBT-GSOUzBXlwVSvOhG2hw0JTBtwW3jK4ORac_79eM4D3SSZFu-RQigwbv06miKq-QdwpLb5Sseii7b_hBCcLSmu3f8rOHnxRTRPwYJVwDJM8H3PQhGkhKt9rUkw2wlJeDi5Zl6pN7nVLvj53wXK-xHKfrxFODa7rSBNOq_xo6sHE7w4Cd5ncdSES49uhQ' \
    -d '{"name":"Test edge router 1627329821","networkId":"356ebc75-22d2-44ed-b894-58bfd24c6441","dataCenterId":"26cbe384-24ad-4b3b-a444-9372618f62cb","linkListener":false,"attributes":[]}'

Example response

HTTP/1.1 202 Accepted
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1107

{
  "id" : "56c32519-71da-4d0e-9344-4d4538dd7a0f",
  "hostId" : null,
  "ownerIdentityId" : "b9c1d395-e325-4f96-aa95-96660a677019",
  "createdBy" : "b9c1d395-e325-4f96-aa95-96660a677019",
  "createdAt" : "2021-07-26T20:03:41.517923Z",
  "updatedAt" : "2021-07-26T20:03:41.517923Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : null,
  "name" : "Test edge router 1627329821",
  "networkId" : "356ebc75-22d2-44ed-b894-58bfd24c6441",
  "jwt" : null,
  "linkListener" : false,
  "tunnelerEnabled" : false,
  "online" : false,
  "verified" : false,
  "status" : "NEW",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/356ebc75-22d2-44ed-b894-58bfd24c6441",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/56c32519-71da-4d0e-9344-4d4538dd7a0f"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/74c2156c-9fee-4097-b0ab-4066a95014cf",
      "profile" : "meta"
    }
  }
}

Update Edge Router

PATCH /edge-routers/{id}

Authorization

This endpoint requires update action on the edge-router resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

io.netfoundry.common.util.validation.ValidAs.

attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

Response fields

Path Type Optional Description

id

String

false

hostId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

jwt

String

true

linkListener

Boolean

true

tunnelerEnabled

Boolean

true

online

Boolean

true

verified

Boolean

true

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

attributes

Array[String]

false

registration

Object

true

registration.id

String

false

registration.networkId

String

false

registration.edgeRouterId

String

false

registration.registrationAttempts

Integer

true

registration.expiresAt

String

false

registration.issuedAt

String

false

registration.usedAt

String

true

registration.createdAt

String

false

registration.createdBy

String

false

registration.updatedAt

String

false

registration.deletedAt

String

true

registration.deletedBy

String

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/ffd0c30f-03e8-40c9-a0d2-d1e9bd5c882d' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJabnBLOTBFOGxRd3NGa2ZYakNfTUxnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjlhOGI0ZWM1LTk1YjUtNDllMy05M2I0LTM4ZDA5YTAxMzY4NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTgyMiwiZXhwIjoxNjI3MzMzNDIyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjEyMWU3NWJhLTlkOTYtNDBlNC1iNjNjLTJlMmJiOWM4YWUxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTgyMn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.og_9nfmuXa8ve5Y6cbRSF6iqHsvcHlIf15cSbVksBgzqQd_qEVIaWHMapu-6CXRby2TsOwye7D29hRlXCh5QZbnO7K-mw6ohLgaDm4_e2RypyX9GxWBlJuzKeBOySoKGNZziwlQIO0wtq0oov14vUgCR9Gtj8yjLszomdw4KaCIkL8lleT83fHx-tOT6dF5_6itt01XthE98P_xHxxgPIQ4A82mktQvXXxvsqt3Favj_sDR89toCwI8R4atwUC9C8--NCUfw8Mk4L0hzlt4vrOXDBWv1ZFaI6TN4jFNwLKgBCswW2MShKhs7oKpsSCyHDZYKXtrNFP_FJ0Hw2jBk4Q' \
    -d '{"name":"Updated name"}'

Example response

HTTP/1.1 202 Accepted
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1117

{
  "id" : "ffd0c30f-03e8-40c9-a0d2-d1e9bd5c882d",
  "hostId" : "770a3a7c-d7ec-4a90-937b-363b57fc8e99",
  "ownerIdentityId" : "b50da58d-056c-469b-b520-12499eca2020",
  "createdBy" : "b50da58d-056c-469b-b520-12499eca2020",
  "createdAt" : "2021-07-26T20:03:42.168503Z",
  "updatedAt" : "2021-07-26T20:03:42.187530Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "zitiEdgeRouterId01",
  "name" : "Updated name",
  "networkId" : "1afbc411-c50f-4dc5-9a31-c8552e540a2e",
  "jwt" : null,
  "linkListener" : true,
  "tunnelerEnabled" : true,
  "online" : false,
  "verified" : true,
  "status" : "PROVISIONING",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1afbc411-c50f-4dc5-9a31-c8552e540a2e",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/ffd0c30f-03e8-40c9-a0d2-d1e9bd5c882d"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/770a3a7c-d7ec-4a90-937b-363b57fc8e99"
    }
  }
}

Delete Edge Router

DELETE /edge-routers/{id}

Authorization

This endpoint requires delete action on the edge-router resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

hostId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

jwt

String

true

linkListener

Boolean

true

tunnelerEnabled

Boolean

true

online

Boolean

true

verified

Boolean

true

status

String

false

Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, REPLACING, DELETING, DELETED].

attributes

Array[String]

false

registration

Object

true

registration.id

String

false

registration.networkId

String

false

registration.edgeRouterId

String

false

registration.registrationAttempts

Integer

true

registration.expiresAt

String

false

registration.issuedAt

String

false

registration.usedAt

String

true

registration.createdAt

String

false

registration.createdBy

String

false

registration.updatedAt

String

false

registration.deletedAt

String

true

registration.deletedBy

String

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/d72704f0-7d33-4eac-817f-2cd3928b961c' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1TUxLUmtvOUYxZEV6UlkyT0V0SC13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNmNDIxYTE4LTgzMDktNDJhYS1hMzExLTdhYzBlYjg3YWEwZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTgyMSwiZXhwIjoxNjI3MzMzNDIxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFjYzE5OWVkLTNkODEtNDQ4ZS05MWM4LTBlYjYxNTJmNTUxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTgyMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.R2_QFr1nYocaZDPjnCylH2yy4gPxkmNYWS53vXL5AJdSUBtFSgxH-MnxrOyaW5QrQTg1DbQb6hn3-LsaQIgisrRf4ytPqCtZAhvNA9bRNenFwD8naCKq1O_ndZpTy2nGdqkB2pXxSaS3mY1RkejzUfpZKcygEbKBPjH_GPekZnQdq30zBd7yr-d2Kg8USpJkpWClZWPP5ylmx5gCEfTsTDz6GeMwoDNzDEB0h93Wyj8l_FOQL6cihE90AfOF4ZIpUKG3vD7udE_Zz4AbLxpYisRmwoYGGwCtNE_cgJ7i0U2lLpUyzxVfKILKcQmQDKrXNod9pks7BFkt85DGbMgnxw'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1213

{
  "id" : "d72704f0-7d33-4eac-817f-2cd3928b961c",
  "hostId" : "0b9d5d77-b022-42b1-8f81-8994c0359239",
  "ownerIdentityId" : "f6bba82a-280f-418b-afbb-e1d9951f1aeb",
  "createdBy" : "f6bba82a-280f-418b-afbb-e1d9951f1aeb",
  "createdAt" : "2021-07-26T20:03:41.797427Z",
  "updatedAt" : "2021-07-26T20:03:41.823407Z",
  "deletedBy" : "3f421a18-8309-42aa-a311-7ac0eb87aa0d",
  "deletedAt" : null,
  "zitiId" : "zitiEdgeRouterId02",
  "name" : "ACME edge router 02 2021-07-26T20:03:41.797258Z",
  "networkId" : "e65deb15-29a9-4a3d-bc06-87841c132432",
  "jwt" : null,
  "linkListener" : true,
  "tunnelerEnabled" : true,
  "online" : false,
  "verified" : true,
  "status" : "DELETING",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e65deb15-29a9-4a3d-bc06-87841c132432",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/d72704f0-7d33-4eac-817f-2cd3928b961c"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/645144a1-6516-4692-8f28-5f9f7dd70d8a",
      "profile" : "meta"
    }
  }
}

Edge Router Policies

Find Edge Router Policies

GET /edge-router-policies

Authorization

This endpoint requires read action on the edge-router-policy resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

attributeType

String

true

Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy].

attribute

Object

true

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJpRnkzbDB6T01PcDBnWVVhaXRvTTNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE1ZjA3OGQxLWVkNzgtNGZhMC05MjU2LWQ1ZWRmNTU4Mjg2NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk1NSwiZXhwIjoxNjI3MzMzNTU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU2NzZmNTJkLTAxY2EtNDgxYi04MjQ4LTdjNjIwMTAyN2MzNFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk1NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.BoNahMYVoZ7CfneLA89IXXF2rDCpINZkgj2DdtE4ESiOs9wu_WB95-5cccoSp1cmcMVN-rVrU5z5cOPR1_SPfDvpYg3axnMUHJKVqPuu7wVe2FbE5ypsRo7kaKvAXABZ2apb2YufvrwgyjK1FU8L19p68hsWJVb93ae6rZF8VQ_Kl0v0_gSz9onCSR7p_XWYzDPpHZM6-cRf74Ml1Bg9Xrb05_20t0zhCwyUZaY5UbCkM-IpB87EOJmou3VO6o414YOF-y9yh-W02JK8XbMlHUj0DP4P3yoN6gIoCTtkQaCc13d79AHXOf_z5c5_DarBuBvDadGLOdQt_-chSf2P-Q'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1182

{
  "_embedded" : {
    "edgeRouterPolicyList" : [ {
      "id" : "2c3b5748-4844-4a0c-9034-59c4a0e4bf47",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:05:55.346237Z",
      "updatedAt" : "2021-07-26T20:05:55.346237Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "d13b2078-d558-4005-821e-01ca7bebb367",
      "zitiId" : "7cee76a1-c563-4712-845e-c2bbd2a746a2",
      "name" : "ACME edge router policy 2021-07-26T20:05:55.346070Z",
      "endpointAttributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d13b2078-d558-4005-821e-01ca7bebb367",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/2c3b5748-4844-4a0c-9034-59c4a0e4bf47"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edge Router Policy

GET /edge-router-policies/{id}

Authorization

This endpoint requires read action on the edge-router-policy resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/cc61957a-bc6b-440e-89e5-563874eebcf6' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiSVRsMDdjZTNBSHM2WU9sTzgxaVdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU5YjE2ODJmLTRlZDMtNDAxYi1hZDFlLWZmYWNhMjMyNzA0MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk1NSwiZXhwIjoxNjI3MzMzNTU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBhM2YwNzkwLWVjNTktNGZiYS04ZjEwLWEwMGUwYTNmOWJkNlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk1NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ak2pZVdUjjO5-uDpbXfWZQ8lshqggCkgAdCw9wgDZN4AdEXnOVEKBc4lZ0bi9UJLgNDxiqXICVi5dLWRZaK__Y8ZcQAFGoFWqh_U3iFJ8-Y47gQrUqtukdXorEm_G7JSM64h8PhrhixOZ3NnvS0TucDEPa1ntJUTfHD_zechzI7VSJyCc3yOb4rPf3kmGE7taYHIHBaGZk4rAO3XmHdwpRfXuUaTnY0DoYJhTE98gbEr-YyQnO6Y4MPrnYopusXgk8DExAuBEhOjnq752lBHNCbL2RzLwhyhW80aULFsUKsFjQmsTZsp7kki7WwQGGMjXw-iTUu47MwPVOfBzGZhiQ'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 806

{
  "id" : "cc61957a-bc6b-440e-89e5-563874eebcf6",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-07-26T20:05:55.467459Z",
  "updatedAt" : "2021-07-26T20:05:55.467459Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "2dcc0734-c1f7-43d2-bc67-e48eabe74328",
  "zitiId" : "6496a973-5374-4d45-8cbf-e250d6b7c788",
  "name" : "ACME edge router policy 2021-07-26T20:05:55.467340Z",
  "endpointAttributes" : [ ],
  "edgeRouterAttributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2dcc0734-c1f7-43d2-bc67-e48eabe74328",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/cc61957a-bc6b-440e-89e5-563874eebcf6"
    }
  }
}

Create Edge Router Policy

POST /edge-router-policies

Authorization

This endpoint requires create action on the edge-router-policy resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

io.netfoundry.common.util.validation.ValidAs.

networkId

String

true

Client must have create action under the annotated resource.

endpointAttributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

edgeRouterAttributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1ZjJwd21MeEZGelh3NWFfeGUyaW5RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkwMDBjNGIwLTMwNjgtNDYxYy1hZDg1LTkzNzhmMTdhMzBjMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk1NSwiZXhwIjoxNjI3MzMzNTU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjkzYzhjMzNjLWY2NWYtNDkyOC1iZjVjLTUxNmY1NjkxZDYzNVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk1NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.P-b-2YgbMsW0F4Fh1aBHStSiBFRDJyBmRX5UL3HmRKKVUGjuC4x0Jgh9PfGQWI7nOBNg1wuogB-IF09JUHTMPKF8E57kM-R1T8AjomYKXwcX-im_A7YHw4Hr-K5CWVhFO5dZ5OlkWkyyzJlJlz9sZeZ7hCJ7C6cZmZb3ziGYsxU6bn3UTN11V2s49a4iekjv9Oz001CFxImie_sp52qjcsyYQQQT1wB1_UN4u3ncMRIFaD4SPaZ0qmK0xkqfkABDS4Xo1UlmLsUuqoPR_6UHjTrR3c_jSNUEftrNTc6J74cm_bcBmXAub8R-qqr19bXOQuyteWBQ3oSiheirsPVcnQ' \
    -d '{"name":"Test edge router policy 1627329955","networkId":"00d0b85a-c570-41dc-b067-7d0e1490efc9","endpointAttributes":["#topclients"],"edgeRouterAttributes":["@ACME_edge_router_2021-07-26T20:05:55.400333Z","#westrouters"]}'

Example response

HTTP/1.1 202 Accepted
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 935

{
  "id" : "f3423f95-7ea3-44db-956b-d8f50ee5fb76",
  "ownerIdentityId" : "9000c4b0-3068-461c-ad85-9378f17a30c0",
  "createdBy" : "9000c4b0-3068-461c-ad85-9378f17a30c0",
  "createdAt" : "2021-07-26T20:05:55.428676Z",
  "updatedAt" : "2021-07-26T20:05:55.431287Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "00d0b85a-c570-41dc-b067-7d0e1490efc9",
  "zitiId" : "be668993-c19b-4b18-9fda-a4b6938be6e3",
  "name" : "Test edge router policy 1627329955",
  "endpointAttributes" : [ "#topclients" ],
  "edgeRouterAttributes" : [ "@ACME_edge_router_2021-07-26T20:05:55.400333Z", "#westrouters" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/00d0b85a-c570-41dc-b067-7d0e1490efc9",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/f3423f95-7ea3-44db-956b-d8f50ee5fb76"
    }
  }
}

Update Edge Router Policy

PUT /edge-router-policies/{id}

Authorization

This endpoint requires update action on the edge-router-policy resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

io.netfoundry.common.util.validation.ValidAs.

networkId

String

true

io.netfoundry.common.util.validation.ValidAs.

endpointAttributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

edgeRouterAttributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/a3af7c13-79b5-410e-a87c-649f40b91a31' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJCTWZ0NlViSmctdnJXa0RZLXFkTjRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI3OGY4ZmZlLTg5NmMtNDc4OS1hMTZlLTQxOGQxN2JkZjMwYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk1NSwiZXhwIjoxNjI3MzMzNTU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI3ODhlN2MzLTM4N2EtNDY2ZC1hMWMxLTRlMDFiMzQyM2E1MFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk1NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.HkcIX73tBWGS_nnFrm9FCu62yHmPg9Gde-pSwjPbxTWb3GT3WZcxIxwZf15QfGmEouphNsCF2sNPL0vLeTzB3W1MMTBDEsqX5fp-lapkiPkThmM2fGMJX_KNN0oMC8ZJso3al6IE86BS54QoH754NouIuF22nOITkNW2cz0F0ZtaD0oipygqk0ey1915Z5uAs35_3q9Dl0nsB091IqVsPpAk2vQkPwGiGkZyVQ9FOdts0HiFb79Ckg3CDxVrtd9-pkKFcENvK0xAZYWUJL6zjPvDeX6qF7efoBmTxT_inAlKt6gW2uAROZ0Xhp8dO6pI_mlsIu_og1P7QN1XVJSxag' \
    -d '{"name":"Updated edge router policy name","networkId":"f49f16eb-496b-451f-8a74-f6bba837b631","endpointAttributes":["#useastrouters"],"edgeRouterAttributes":["#usendpoints"]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 818

{
  "id" : "a3af7c13-79b5-410e-a87c-649f40b91a31",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-07-26T20:05:55.670832Z",
  "updatedAt" : "2021-07-26T20:05:55.680045Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "f49f16eb-496b-451f-8a74-f6bba837b631",
  "zitiId" : "1e407ebc-f06a-4c76-a6a0-b2e6305285c1",
  "name" : "Updated edge router policy name",
  "endpointAttributes" : [ "#useastrouters" ],
  "edgeRouterAttributes" : [ "#usendpoints" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f49f16eb-496b-451f-8a74-f6bba837b631",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/a3af7c13-79b5-410e-a87c-649f40b91a31"
    }
  }
}

Delete Edge Router Policy

DELETE /edge-router-policies/{id}

Authorization

This endpoint requires delete action on the edge-router-policy resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/7db18bf0-55d4-4362-81e3-3b05c89cbdbc' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJycjBrZTFyMHpGY0wyZmN2NE1iTFZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNmOGRmMTQzLWVhZWYtNGViZi04ODc0LTY2ZDBmNzBmZDY1ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk1NSwiZXhwIjoxNjI3MzMzNTU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjZjM2I0YTE2LTFlZWMtNDEzYy1iZmY0LTRmOGJkMjQ0NzIyYlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk1NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.PfzYDirzwF3JZsQFWhqqXiLFjaJf1vRniCHFQzfoLuqJbLYF9ZHl67zgvG11Wiku4cPkZ7h1VggSeiNrLuY_jjfclG1tZXJS7BO6PUbJ92rPm_n0VJTgTnSwI8PSt0merdhnNB5M_lw7InJyTGfzXuf-CHj4jvOd3awk06a_k8NdW--T55oQDM4fbnRYVIHZW43yNkHxyvg_HnLrPwbOqJtAjkAxwoLwzbrAtFhETE1mTw07SpMhwO2Ip36WJkM-SU0tz8fniOD0tqYtwPcL_E8RKBgQkrRzjM40PHtavbBTlUoUjQm8HMblQnr-t5Aaq6Z9_uwhrWz8SNv3fAVK_g'

Example response

HTTP/1.1 200 OK

Services

Find Services

GET /services

Authorization

This endpoint requires read action on the service resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

encryptionRequired

Boolean

true

modelType

Object

true

Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

attribute

Object

true

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

networkId

String

false

zitiId

String

true

The id of this service within Ziti. This will be null when there is no Ziti Service matching this logical Service definition, which is the case during initial creation and destruction of the logical Service.

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

configIdByConfigTypeId

Map

false

attributes

Array[String]

false

model

Object

true

authority

Object

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

Path Type Optional Description

id

String

false

networkId

String

false

zitiId

String

true

The id of this service within Ziti. This will be null when there is no Ziti Service matching this logical Service definition, which is the case during initial creation and destruction of the logical Service.

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

configIdByConfigTypeId

Map

false

attributes

Array[String]

false

model

Object

true

authority

Object

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services?encrpytionRequired=true' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2cWFRc1phYVE3WS1RQlhDamdGazFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVhZDNiMTdkLWE2YmQtNDNmZi1hZDkzLTRhZjUzOWQwNTg5MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTg1OSwiZXhwIjoxNjI3MzMzNDU5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFjNGRkMTI2LTc5ODQtNDI0OC1hYTAyLTEzYzA0NzdmYzU3OFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTg1OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.P0YNbIu1ihTpDyYsbEi0hPZ1gud5aAkrNyaDgnUjFZrgFK5LoMVXf3eIzznxM8o1ykGskjQSZ_ZobOsPhkX5pvp_GpY-WVVUFZZKEmyksjlTKmcassrU0F1pVupf_eI94U7Lltxqbvfpdb-ejX8iVa7W77TlkJKhQwmD_KQlFH1BRNk7Sfsn0Q2ig1a7GyIKOe5pPIbUgVpv1pCg5vvaXLaqvEV-TS17p_hLjfDeOo5d24Hqb85d8oLeu5p_rFYjlsV8IjzaH8jDuz9KEmA9H5HAqYPNQF2PaEHxIF5eNWG5wgdjTtINy29jhZHIMA6lmsIy_qZjwdEHa2kDGGV0tA'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 15583

{
  "_embedded" : {
    "serviceList" : [ {
      "id" : "1c9bf180-97ac-4cb2-8a2c-127466f9219a",
      "networkId" : "ad195faa-854e-4d63-932d-c7fd363668b7",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.330907Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "2a8559de-4dc3-4e2d-a570-db0a36a26e78",
      "createdBy" : "71d346d3-9642-4a7b-98a6-1cdab122b8fc",
      "createdAt" : "2021-07-26T20:04:19.331037Z",
      "updatedAt" : "2021-07-26T20:04:19.331037Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ad195faa-854e-4d63-932d-c7fd363668b7",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/1c9bf180-97ac-4cb2-8a2c-127466f9219a"
        }
      }
    }, {
      "id" : "235b5bf3-20ef-49d0-b2fe-41712f6f6ac3",
      "networkId" : "b231ad2a-8d3d-4c90-9b25-0807e57c1ee1",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.378296Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "346a1827-0c6c-433f-b21d-39ed8b17d005",
      "createdBy" : "24e5ade9-5c68-491c-a7b5-3d4a54e62b69",
      "createdAt" : "2021-07-26T20:04:19.378426Z",
      "updatedAt" : "2021-07-26T20:04:19.378426Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b231ad2a-8d3d-4c90-9b25-0807e57c1ee1",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/235b5bf3-20ef-49d0-b2fe-41712f6f6ac3"
        }
      }
    }, {
      "id" : "3f56520c-49bf-4e02-8ed5-b90f8c3fd9b0",
      "networkId" : "2e52d591-6543-49ea-b50c-ced7b029ebf2",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.094993Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "085391f3-821f-4cde-a542-5c7c47ab356d",
      "createdBy" : "b4f1f7f3-69df-4de1-a261-45ebbac25011",
      "createdAt" : "2021-07-26T20:04:19.095130Z",
      "updatedAt" : "2021-07-26T20:04:19.095130Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2e52d591-6543-49ea-b50c-ced7b029ebf2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/3f56520c-49bf-4e02-8ed5-b90f8c3fd9b0"
        }
      }
    }, {
      "id" : "4e39559f-e073-457c-8a98-b7d0301163f6",
      "networkId" : "d852bdd4-8bb1-4178-a004-e3e5edea1924",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.593696Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "8471904c-c932-458b-a4f8-a0cab7f16d57",
      "createdBy" : "663a10b7-7936-4739-a758-027148611826",
      "createdAt" : "2021-07-26T20:04:19.593825Z",
      "updatedAt" : "2021-07-26T20:04:19.593825Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d852bdd4-8bb1-4178-a004-e3e5edea1924",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/4e39559f-e073-457c-8a98-b7d0301163f6"
        }
      }
    }, {
      "id" : "4f034627-0a3e-434b-bba4-6498f56fe411",
      "networkId" : "b9897427-bb74-4f16-8194-e5a4bd0e2b3e",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.286080Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "b49ec11a-940e-4bd9-89dc-29bc3701c076",
      "createdBy" : "82a974a9-081e-4180-96d0-6c001dfa933b",
      "createdAt" : "2021-07-26T20:04:19.286216Z",
      "updatedAt" : "2021-07-26T20:04:19.286216Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b9897427-bb74-4f16-8194-e5a4bd0e2b3e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/4f034627-0a3e-434b-bba4-6498f56fe411"
        }
      }
    }, {
      "id" : "5163f662-2b18-482f-b010-4d10507e0681",
      "networkId" : "df09a2a2-c469-421a-821e-a59584fc76ac",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.540496Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "56b75694-c4c6-4ed6-805b-9a8cf13b4204",
      "createdBy" : "4f8fc654-ac65-48f4-8909-65711ba6b705",
      "createdAt" : "2021-07-26T20:04:19.540685Z",
      "updatedAt" : "2021-07-26T20:04:19.540685Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df09a2a2-c469-421a-821e-a59584fc76ac",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/5163f662-2b18-482f-b010-4d10507e0681"
        }
      }
    }, {
      "id" : "56f0e4aa-308d-493e-a97b-548b8f8c2967",
      "networkId" : "13073209-54f5-4b51-abdc-570e5714f367",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.429011Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "18b5e9c4-ceec-4591-aa4c-ff8759c1bc37",
      "createdBy" : "ab9d0944-ee9e-452b-92d2-007df9a08b44",
      "createdAt" : "2021-07-26T20:04:19.429146Z",
      "updatedAt" : "2021-07-26T20:04:19.429146Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/13073209-54f5-4b51-abdc-570e5714f367",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/56f0e4aa-308d-493e-a97b-548b8f8c2967"
        }
      }
    }, {
      "id" : "689892cd-0569-4291-bd2a-feceedb0634b",
      "networkId" : "e2a48ef7-d3ff-467e-9592-2a87da8e44fc",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.473058Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "ed6ea46b-70a7-4c9c-9c33-6ae23ae26793",
      "createdBy" : "3184b6ba-86a2-44c3-980e-07574f43e791",
      "createdAt" : "2021-07-26T20:04:19.473215Z",
      "updatedAt" : "2021-07-26T20:04:19.473215Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e2a48ef7-d3ff-467e-9592-2a87da8e44fc",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/689892cd-0569-4291-bd2a-feceedb0634b"
        }
      }
    }, {
      "id" : "6b0464e0-9e72-4249-9b0d-4caf82c40435",
      "networkId" : "a5dac38a-879d-4dd5-81b2-980135775d3e",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.639659Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "b9b2fcb7-b512-4cf3-b5ae-c614188d208d",
      "createdBy" : "ef5d4002-792b-4c3b-ab7d-d40b6af35a0c",
      "createdAt" : "2021-07-26T20:04:19.639785Z",
      "updatedAt" : "2021-07-26T20:04:19.639785Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a5dac38a-879d-4dd5-81b2-980135775d3e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/6b0464e0-9e72-4249-9b0d-4caf82c40435"
        }
      }
    }, {
      "id" : "701a5c1b-7041-4491-af01-253145847b4d",
      "networkId" : "9fa2121e-ba4c-4172-be44-077c1c38f1e6",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.146319Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "9727eba7-cdf0-45b4-a4c2-0b56430629e2",
      "createdBy" : "4e19f213-6d82-4071-bcda-cb0d00029fd5",
      "createdAt" : "2021-07-26T20:04:19.146450Z",
      "updatedAt" : "2021-07-26T20:04:19.146450Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9fa2121e-ba4c-4172-be44-077c1c38f1e6",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/701a5c1b-7041-4491-af01-253145847b4d"
        }
      }
    }, {
      "id" : "830d72d1-a1b6-48aa-843e-af24c51f839a",
      "networkId" : "9fc67224-6ce1-4629-af85-57850d375fd6",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.190964Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "b630a1a8-1986-40f1-ad98-a80c7cf69de0",
      "createdBy" : "4321dc8e-b9d3-4672-85d2-3f14b4d01c90",
      "createdAt" : "2021-07-26T20:04:19.191095Z",
      "updatedAt" : "2021-07-26T20:04:19.191095Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9fc67224-6ce1-4629-af85-57850d375fd6",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/830d72d1-a1b6-48aa-843e-af24c51f839a"
        }
      }
    }, {
      "id" : "8ec14568-f611-42d0-ac9b-9f8723eb1d0b",
      "networkId" : "5a1a3657-e191-497c-bac4-d9f2665f8a95",
      "zitiId" : "ziti-id-29",
      "name" : "Find Test Service",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "daec2fd2-aed5-45e6-b911-c66fe8abd60e",
      "createdBy" : "91cd1a16-4f3f-4991-a918-d57cb7caf91d",
      "createdAt" : "2021-07-26T20:04:18.934392Z",
      "updatedAt" : "2021-07-26T20:04:18.934392Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5a1a3657-e191-497c-bac4-d9f2665f8a95",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/8ec14568-f611-42d0-ac9b-9f8723eb1d0b"
        }
      }
    }, {
      "id" : "cb24b491-91e4-4ba8-949e-6bbdcbd04a5e",
      "networkId" : "e83f8849-126b-48a7-9a81-1a9854c0fd95",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.238775Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "41c38625-37dc-4945-90e7-5a8e8986bf3c",
      "createdBy" : "78fca24a-6651-4abb-a5b1-32984e0041f9",
      "createdAt" : "2021-07-26T20:04:19.238918Z",
      "updatedAt" : "2021-07-26T20:04:19.238918Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e83f8849-126b-48a7-9a81-1a9854c0fd95",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/cb24b491-91e4-4ba8-949e-6bbdcbd04a5e"
        }
      }
    }, {
      "id" : "d05840c7-c588-4d35-bca0-c0fefbdeed65",
      "networkId" : "3bfa4de5-3d63-4282-8a26-592aafa6ac03",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:18.971375Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "d593fac0-bd37-44d5-a4bb-5600cd3a9a77",
      "createdBy" : "af1c7df9-894d-425e-ba74-884cd963aaa4",
      "createdAt" : "2021-07-26T20:04:18.971510Z",
      "updatedAt" : "2021-07-26T20:04:18.971510Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3bfa4de5-3d63-4282-8a26-592aafa6ac03",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/d05840c7-c588-4d35-bca0-c0fefbdeed65"
        }
      }
    }, {
      "id" : "d904c4b3-3f71-4178-ab45-0572c2e96e30",
      "networkId" : "5a158feb-cb81-4579-bebb-23b4686019bf",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-07-26T20:04:19.049677Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "8964b369-c140-47f5-9834-12b7e924a836",
      "createdBy" : "a50b4f15-97dc-40b1-b24f-8de3ff53d796",
      "createdAt" : "2021-07-26T20:04:19.049815Z",
      "updatedAt" : "2021-07-26T20:04:19.049815Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5a158feb-cb81-4579-bebb-23b4686019bf",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/d904c4b3-3f71-4178-ab45-0572c2e96e30"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 15,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Service

GET /services/{id}

Authorization

This endpoint requires read action on the service resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

networkId

String

false

zitiId

String

true

The id of this service within Ziti. This will be null when there is no Ziti Service matching this logical Service definition, which is the case during initial creation and destruction of the logical Service.

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

configIdByConfigTypeId

Map

false

attributes

Array[String]

false

model

Object

true

authority

Object

true

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services/f5869d3b-4c89-48cd-a3d8-d6979fab3534' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJKZ3ljYl96Uk5VVDF3MlotRl9vYnBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNkMzBjYTc0LTRkYmQtNGJkNi04MjFhLWEwZTI5M2RiN2Y2MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTkyMCwiZXhwIjoxNjI3MzMzNTIwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjkwZWM4NmY5LTZhNzAtNDU1ZS1iMzYxLTkxYTc4OGQ5M2I2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTkyMH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.cotlaKJx4s0YsyCxLjJmNAHXy0v1E5rtdtgUTLjeJUj_DkfcAB5fOHS9G9XcFk3RoFnN_B0zANHTXv2vjqdvz5rl3700TMkT72eWG7RmV_Ngr4h4_bb78l9blrlCiqqskoSEXg6mYsmWaFqHOFAizLbiBn2M7PG8aHHRrIUtahRqS77_MfyPEd4k0gMR0rLdy1r93bGYSE2C0oOmiYZ3gnT8E6-A0VYLE4_CY4ky9KOh4LZ3D-WdiKaHTRpSm7J1Q5RhFblPzyvx8R1WD5YETCCqgR6Kd_ONsqWN_fRU7z0qBvgQVl_QwCmf6FMuyG_iSKJ1sabKaVwHf24a-crBnQ'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 893

{
  "id" : "f5869d3b-4c89-48cd-a3d8-d6979fab3534",
  "networkId" : "c25c6a2f-056b-42e7-8d27-72e751694a2a",
  "zitiId" : "ziti.id.gw7lpnr9opq",
  "name" : "My Service 61769901172304795",
  "encryptionRequired" : false,
  "modelType" : "TunnelerToSdk",
  "ownerIdentityId" : "2b54a1df-9738-42d7-9a57-91579d3aaafc",
  "createdBy" : "2b54a1df-9738-42d7-9a57-91579d3aaafc",
  "createdAt" : "2021-07-26T20:05:20.009944Z",
  "updatedAt" : "2021-07-26T20:05:20.024955Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "01a2e606-f079-4477-b4e3-483122f6a26b" : "58b8b502-8075-4bec-b050-986fc4e450c7"
  },
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "model" : {
    "clientIngress" : {
      "host" : "myHost.com",
      "port" : 8989
    },
    "bindEndpointAttributes" : [ "#east-pop" ],
    "edgeRouterAttributes" : [ "#LA-dataCenter-ERs" ]
  },
  "authority" : null
}

Create Service

POST /services

Authorization

This endpoint requires create action on the service resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

name

String

true

io.netfoundry.common.util.validation.ValidAs.

encryptionRequired

Boolean

true

configIds

Array[Object]

true

configs

Array[Object]

true

configs[].networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

configs[].name

String

true

io.netfoundry.common.util.validation.ValidAs.

configs[].configTypeId

String

true

A Config’s data must conform to a Config Type’s schema. When creating a Config, the client may specify the Config Type by id, name or have a dedicated Config Type created on the fly. This property allows for the specification of the Config Type by id.

Client must have read action on the annotated resource.

configs[].configTypeName

String

true

A Config’s data must conform to a Config Type’s schema. When creating a Config, the client may specify the Config Type by id, name or have a dedicated Config Type created on the fly. This property allows for the specification of the Config Type by name.

configs[].configType

Object

true

A Config’s data must conform to a Config Type’s schema. When creating a Config, the client may specify the Config Type by id, name or have a dedicated Config Type created on the fly. This property allows for the specification of the Config Type by supplying a create command object.

configs[].configType.networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

configs[].configType.name

String

true

io.netfoundry.common.util.validation.ValidAs.

configs[].configType.schema

Object

true

io.netfoundry.common.util.validation.ValidAs.

configs[].data

Object

true

attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

modelType

String

true

Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].

model

Object

true

Response fields

Path Type Optional Description

id

String

false

networkId

String

false

zitiId

String

true

The id of this service within Ziti. This will be null when there is no Ziti Service matching this logical Service definition, which is the case during initial creation and destruction of the logical Service.

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

configIdByConfigTypeId

Map

false

attributes

Array[String]

false

model

Object

true

authority

Object

true

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJOWlBvVklUWExGM1QzbzNkbHBnYUN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJiNTRhMWRmLTk3MzgtNDJkNy05YTU3LTkxNTc5ZDNhYWFmYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTkxOSwiZXhwIjoxNjI3MzMzNTE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQzOWU0NDE5LWRkZWYtNGEwNC04NmUyLWJhZTI5M2M2OGVjY1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTkxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.sIoDg1nsP5qO9ie6sAtItDRUTwZWGQw4hK1tyhNhRWTZ9wp4sK0yvZzCTUfwn_nWjF4FHqnffjek4wje9LGGXAop7rYb4aTTtq-9aFHbFG1RmgIL8zYuewf6TBOS8vi2IWBSztmXBSRcg4bGsHoZ_ERjgf22fUKa9tYzuxaHagnGFZ5qjC6Qkp7IOPIS8ixL6abnjnm3rOVG-jrauPDVAEbvWf5-wZk_Cuae-2Z0JRzveSlxOGFTzNsDiP_s2p52UEcbadAIDLWFvRQFL3f19odchxJh0-MBFILlX28TQONWZmDhoaXyCQnmkGxMauliN-agzIqDmsHBa4gJWJYvpw' \
    -d '{"networkId":"c25c6a2f-056b-42e7-8d27-72e751694a2a","name":"My Service 61769901172304795","encryptionRequired":false,"attributes":["#Attr-2","#Attr-1"],"modelType":"TunnelerToSdk","model":{"clientIngress":{"host":"myHost.com","port":8989},"bindEndpointAttributes":["#east-pop"],"edgeRouterAttributes":["#LA-dataCenter-ERs"]}}'

Example response

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 893

{
  "id" : "f5869d3b-4c89-48cd-a3d8-d6979fab3534",
  "networkId" : "c25c6a2f-056b-42e7-8d27-72e751694a2a",
  "zitiId" : "ziti.id.gw7lpnr9opq",
  "name" : "My Service 61769901172304795",
  "encryptionRequired" : false,
  "modelType" : "TunnelerToSdk",
  "ownerIdentityId" : "2b54a1df-9738-42d7-9a57-91579d3aaafc",
  "createdBy" : "2b54a1df-9738-42d7-9a57-91579d3aaafc",
  "createdAt" : "2021-07-26T20:05:20.009944Z",
  "updatedAt" : "2021-07-26T20:05:20.024955Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "01a2e606-f079-4477-b4e3-483122f6a26b" : "58b8b502-8075-4bec-b050-986fc4e450c7"
  },
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "model" : {
    "clientIngress" : {
      "host" : "myHost.com",
      "port" : 8989
    },
    "bindEndpointAttributes" : [ "#east-pop" ],
    "edgeRouterAttributes" : [ "#LA-dataCenter-ERs" ]
  },
  "authority" : null
}

Update Service

PATCH /services/{id}

Authorization

This endpoint requires update action on the service resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

io.netfoundry.common.util.validation.ValidAs.

encryptionRequired

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

configIds

Array[Object]

true

If this property is set, then the {@link Service} will be updated to have the specified {@link Config}s. Leave this property null or omit it entirely if the intent is to leave the existing {@link Service#getConfigIdByConfigTypeId() Service Configs} as is. When set, {@link Config}s on the existing {@link Service} which are not present in this property will be removed from the {@link Service}, but the {@link Config} will still exist. A secondary request is required to remove the orphan {@link Config}. Note, any {@link CreateConfig}s specified in the {@link #configs} property will be added after this property is processed.

configs

Array[Object]

true

Zero to N {@link CreateConfig} specifications can be passing via this property as an indirect method of both creating and assigning a Config to this Service at the same time. Any existing Config’s on this Service are left as is; these are additive only. A Config that is created via a Service is presumed to be dedicated to that Service. The resulting Config will have the Service as it’s system component of authority.

configs[].networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

configs[].name

String

true

io.netfoundry.common.util.validation.ValidAs.

configs[].configTypeId

String

true

A Config’s data must conform to a Config Type’s schema. When creating a Config, the client may specify the Config Type by id, name or have a dedicated Config Type created on the fly. This property allows for the specification of the Config Type by id.

Client must have read action on the annotated resource.

configs[].configTypeName

String

true

A Config’s data must conform to a Config Type’s schema. When creating a Config, the client may specify the Config Type by id, name or have a dedicated Config Type created on the fly. This property allows for the specification of the Config Type by name.

configs[].configType

Object

true

A Config’s data must conform to a Config Type’s schema. When creating a Config, the client may specify the Config Type by id, name or have a dedicated Config Type created on the fly. This property allows for the specification of the Config Type by supplying a create command object.

configs[].configType.networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

configs[].configType.name

String

true

io.netfoundry.common.util.validation.ValidAs.

configs[].configType.schema

Object

true

io.netfoundry.common.util.validation.ValidAs.

configs[].data

Object

true

attributes

Array[String]

true

If this property is set, then the attributes assigned to the Service will be set to match those in this property.

io.netfoundry.common.util.validation.ValidAs.

modelType

String

true

A Service’s model type can not be changed after creation. This property should only be set when also providing a model property in the update request. Passing either property alone will result in an error. This property informs the server of the type of the model to expect in the peer model property of this update.

Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].

model

Object

true

If set, any changes in this model will be applied to the Service. Note, when passing a model you must also pass the peer modelType property to indicate to the server the type of model being passed. Passing one without the other will result in an error. Unlike the update request as a whole, the model property must be fully specified during an update request. Even under PATCH semantics, all properties within this model are required if submitting a model at all.

Response fields

Path Type Optional Description

id

String

false

networkId

String

false

zitiId

String

true

The id of this service within Ziti. This will be null when there is no Ziti Service matching this logical Service definition, which is the case during initial creation and destruction of the logical Service.

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

configIdByConfigTypeId

Map

false

attributes

Array[String]

false

model

Object

true

authority

Object

true

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services/f5869d3b-4c89-48cd-a3d8-d6979fab3534' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiItQkFTeWFoQVZ2NmRLek9HMkpqajl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU4ZTFlMjllLTBmOTQtNGEwMC05MjM2LTEzNjZhMmM2YWI5ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTkyMiwiZXhwIjoxNjI3MzMzNTIyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImVhNGZkOGE5LWQ1ZWYtNDFkNC1hMzhhLTIzYzUyN2YxNjBiNFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTkyMn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.PN0UtB_T3sLzLibVR4Pv0H4zfej0j1cHKJiosRpgXdDRKlYD5wc0jCwy6_MFb-XrNhcA71m80HInixRpT9zZJmXUAf1RAa1Nxx4Jyv-0wn2NUuu8IuJEe3t06gPsAOI5tAZ6yRK4fo3EuswEH8EuSrKuO-1cPd1hHbHi9KOhdPrAKSeju4vOb86ROxTEb68iyl3SZRU47ADhRaw7gIe1DNdmEo2ZYNPZYTBSyYyp79ICJ62FRnD6PjzhA3DQ5eGAI5d4zc3HQZgZznaUfWnPhHMnredMykCihEMoq3DVSxYQPjsQyJD3nPygf3dqCz2HV7aVe5wADpLUvlTXZfVHsw' \
    -d '{"name":"Our Service 61769901172304795","encryptionRequired":true,"attributes":["#Attr-2","#Attr-4"],"modelType":"TunnelerToSdk","model":{"clientIngress":{"host":"myHost.com","port":8989},"bindEndpointAttributes":["#east-pop"],"edgeRouterAttributes":["#LA-dataCenter-ERs"]}}'

Example response

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 893

{
  "id" : "f5869d3b-4c89-48cd-a3d8-d6979fab3534",
  "networkId" : "c25c6a2f-056b-42e7-8d27-72e751694a2a",
  "zitiId" : "ziti.id.gw7lpnr9opq",
  "name" : "Our Service 61769901172304795",
  "encryptionRequired" : true,
  "modelType" : "TunnelerToSdk",
  "ownerIdentityId" : "2b54a1df-9738-42d7-9a57-91579d3aaafc",
  "createdBy" : "2b54a1df-9738-42d7-9a57-91579d3aaafc",
  "createdAt" : "2021-07-26T20:05:20.009944Z",
  "updatedAt" : "2021-07-26T20:05:22.296211Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "01a2e606-f079-4477-b4e3-483122f6a26b" : "58b8b502-8075-4bec-b050-986fc4e450c7"
  },
  "attributes" : [ "#Attr-4", "#Attr-2" ],
  "model" : {
    "clientIngress" : {
      "host" : "myHost.com",
      "port" : 8989
    },
    "bindEndpointAttributes" : [ "#east-pop" ],
    "edgeRouterAttributes" : [ "#LA-dataCenter-ERs" ]
  },
  "authority" : null
}

Delete Service

DELETE /services/{id}

Authorization

This endpoint requires delete action on the service resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

networkId

String

false

zitiId

String

true

The id of this service within Ziti. This will be null when there is no Ziti Service matching this logical Service definition, which is the case during initial creation and destruction of the logical Service.

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

configIdByConfigTypeId

Map

false

attributes

Array[String]

false

model

Object

true

authority

Object

true

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services/f5869d3b-4c89-48cd-a3d8-d6979fab3534' -i -X DELETE \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJBVkcyd05CQmdrUlExQnY3MzFUb0dRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcyMTFlMDk5LTgyZDAtNDgzNy05NzBjLTAwNmQ0ZDdlZmE4NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTkyNCwiZXhwIjoxNjI3MzMzNTI0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZjOGNjMDQ3LTc5MmItNDk3OS1iMTM4LTU3NTUwZDk0ZmJmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTkyNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.kUcZxGoSuao3VwPxsE3-f4Avl2pAjOXILqK8r3gSTjWzAaduLqygPD-n8H2-G37VQxtYmbdZemVg-mdRWasdfGeVLf_mGiaO5A7xrpADAkf3GBN6e9JKKeTJlFhn4EJuqnPnSRMGjTbvR9dCqG-zlzRRak2Xb4I4MCKCLz0owhniAvMXKZsLXCl-ZvMWiCFIoB39plIqB8RDxLXB93crozIehn3PukHEHMDElErP-7SDsYRqnJN8AzwpKA67yoB7Nxw7fiqoEQau-4fREfCP2xaZq3kwokzmr4M1t5twzDo0oyaXQ1Q0xyF-KFN4QqdHnrYvlWkcg5kqcSg_KmXteg'

Example response

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 878

{
  "id" : "f5869d3b-4c89-48cd-a3d8-d6979fab3534",
  "networkId" : "c25c6a2f-056b-42e7-8d27-72e751694a2a",
  "zitiId" : null,
  "name" : "Our Service 61769901172304795",
  "encryptionRequired" : true,
  "modelType" : "TunnelerToSdk",
  "ownerIdentityId" : "2b54a1df-9738-42d7-9a57-91579d3aaafc",
  "createdBy" : "2b54a1df-9738-42d7-9a57-91579d3aaafc",
  "createdAt" : "2021-07-26T20:05:20.009944Z",
  "updatedAt" : "2021-07-26T20:05:24.543094Z",
  "deletedBy" : "7211e099-82d0-4837-970c-006d4d7efa86",
  "deletedAt" : "2021-07-26T20:05:24.340Z",
  "configIdByConfigTypeId" : {
    "01a2e606-f079-4477-b4e3-483122f6a26b" : "58b8b502-8075-4bec-b050-986fc4e450c7"
  },
  "attributes" : [ ],
  "model" : {
    "clientIngress" : {
      "host" : "myHost.com",
      "port" : 8989
    },
    "bindEndpointAttributes" : [ ],
    "edgeRouterAttributes" : [ ]
  },
  "authority" : null
}

App Wans

Find App Wans

GET /app-wans

Authorization

This endpoint requires read action on the app-wan resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

attributeType

String

true

Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy].

attribute

Object

true

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

zitiId

String

true

networkId

String

false

serviceAttributes

Array[String]

false

endpointAttributes

Array[String]

false

postureCheckAttributes

Array[String]

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

zitiId

String

true

networkId

String

false

serviceAttributes

Array[String]

false

endpointAttributes

Array[String]

false

postureCheckAttributes

Array[String]

false

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ0WF96TWcyUElOeFNqQi1YSTV0bFBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI5MTI0MmZiLTczOTAtNDgyMy1iNjk2LTE1NmZjYjY5NDAyOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk4MywiZXhwIjoxNjI3MzMzNTgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjEyNWJkNzRkLTY3ZjktNDE3Yy1hMjcyLTY4ZWY4NWIxMTAwOFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.K-lboJ9dXk2TDIIwdfj9IKc5yDR8jqPaYrHEP9D5zOwrLndyNAqS6gxLQflfogTfd-_R0py-95e5rXcdOv8WAPTPDIEul-pyKbf64lGP6hAltNdTZNsqVX647sa5a9w9dXFULLje9TxyQ4q86USmFYfD-407htvLpRbahBJveK3kQ4wkx0SdXVb_j6DRll-EYOH-GW8WAt3WSz6j46YDNaVFba05HMlS_11t4UlrYe8_ir71lvGp1Lxnyn0ifqE0y37Wt9WC7uHYX9BBDzGSF6QC9HKitJkDLfKFACkEuW5MWFqzUSNpQuSY37EAvR8sDho0DQ3ojgiqZrNtKdtA7Q'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 5305

{
  "_embedded" : {
    "appWanList" : [ {
      "id" : "11ba5dd2-46b3-4a9d-89a2-9770b28a55a7",
      "ownerIdentityId" : "07a5e3bd-b1c4-4abf-ad18-033d904a3dab",
      "createdBy" : "07a5e3bd-b1c4-4abf-ad18-033d904a3dab",
      "createdAt" : "2021-07-26T20:06:23.272826Z",
      "updatedAt" : "2021-07-26T20:06:23.282618Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-07-26T20:06:23.272723Z",
      "zitiId" : "46ced8b9-0ee7-4bde-88b0-7ae242ad258b",
      "networkId" : "6b94a0ed-7b4c-492a-abdb-7707bdbba309",
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6b94a0ed-7b4c-492a-abdb-7707bdbba309",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/11ba5dd2-46b3-4a9d-89a2-9770b28a55a7"
        }
      }
    }, {
      "id" : "6e939d31-98cd-4285-a051-78eec8905e95",
      "ownerIdentityId" : "80b79c88-0885-48a3-bba1-0d227c412de6",
      "createdBy" : "80b79c88-0885-48a3-bba1-0d227c412de6",
      "createdAt" : "2021-07-26T20:06:23.187595Z",
      "updatedAt" : "2021-07-26T20:06:23.187925Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-07-26T20:06:23.187485Z",
      "zitiId" : "bf85c7ab-3277-4c09-8544-8f2fc485b945",
      "networkId" : "1487b04e-6c17-419b-a619-2a46e9c3c594",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1487b04e-6c17-419b-a619-2a46e9c3c594",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/6e939d31-98cd-4285-a051-78eec8905e95"
        }
      }
    }, {
      "id" : "9c936dd1-fe9c-468e-aa8e-8af2a80f7572",
      "ownerIdentityId" : "018434aa-231a-4b47-a792-2c0cb4fed131",
      "createdBy" : "018434aa-231a-4b47-a792-2c0cb4fed131",
      "createdAt" : "2021-07-26T20:06:23.135343Z",
      "updatedAt" : "2021-07-26T20:06:23.135672Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-07-26T20:06:23.135238Z",
      "zitiId" : "5ddf4dd2-e4d7-4e33-8ed7-4a9c91d9d984",
      "networkId" : "13fe2ee3-1564-4ab2-a09d-a04307e8ff7e",
      "serviceAttributes" : [ "#service02", "#all" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/13fe2ee3-1564-4ab2-a09d-a04307e8ff7e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/9c936dd1-fe9c-468e-aa8e-8af2a80f7572"
        }
      }
    }, {
      "id" : "f88e498d-be91-45cf-aaea-fc58c576341a",
      "ownerIdentityId" : "976c59cd-44f9-4208-a31a-6fa2ce236741",
      "createdBy" : "976c59cd-44f9-4208-a31a-6fa2ce236741",
      "createdAt" : "2021-07-26T20:06:23.217513Z",
      "updatedAt" : "2021-07-26T20:06:23.228949Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Updated App Wan name",
      "zitiId" : "2460941c-f460-4047-baf8-c147bde4d900",
      "networkId" : "c8919aa2-f220-4bf5-b3db-77d92d3ee058",
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c8919aa2-f220-4bf5-b3db-77d92d3ee058",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/f88e498d-be91-45cf-aaea-fc58c576341a"
        }
      }
    }, {
      "id" : "fd689f7a-c8f0-48c2-8402-3f54c89f61ec",
      "ownerIdentityId" : "7e670023-238b-43d9-9a08-ad5864f30b0e",
      "createdBy" : "7e670023-238b-43d9-9a08-ad5864f30b0e",
      "createdAt" : "2021-07-26T20:06:23.334933Z",
      "updatedAt" : "2021-07-26T20:06:23.335272Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-07-26T20:06:23.334826Z",
      "zitiId" : "195a04c4-79a6-48c3-b5f8-9b89cee7de53",
      "networkId" : "cc7c41b8-d936-450a-becd-d639f37f6a70",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/cc7c41b8-d936-450a-becd-d639f37f6a70",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/fd689f7a-c8f0-48c2-8402-3f54c89f61ec"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}

Get App Wan

GET /app-wans/{id}

Authorization

This endpoint requires read action on the app-wan resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

zitiId

String

true

networkId

String

false

serviceAttributes

Array[String]

false

endpointAttributes

Array[String]

false

postureCheckAttributes

Array[String]

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/b9758fb0-fc39-4a47-b2d6-f8458051467f' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhYUZKTDE1YkpWdFRwU095LWFYZVFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJhMDc1MjQ3LThlM2QtNGNmZC1iMTVhLWRhNTUxYzM5OGZiOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk4MywiZXhwIjoxNjI3MzMzNTgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjZjODg0NjA1LWIzMzItNDczMC04Yzk1LTM3ZjE3MjEwYzJlZVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Gzpqo6vs2JSu15jUnbV8vpMrP-gvj3H0A572TJsq9YbOVrppyoeZM5kiMsLTt-LfYspGx4Qydn9XtuUUOhU-YmWI5adkJmLkNtHDa9VfJ_sA2jGuIXsHjFxnHHnc3oo39DYHGLnxBDmKyNAgF2cfCfGkoi9peOLgWLRAg9806z422qviFw-m-FvrvoWQ-_XbNgi4oOZ9MAwPamXCY1vYTVsoxRhouT2A6LERLzQKDlRY3zoLk_-Bglu-I1k_85BLR2zfIUdkCLKQfj3wzEkNCIoBWK1z6emprRU6BX8tak4udyN1BpZXwXZnQJrYvO0pB2rCSP0AUrJ7joyubQ7bSA'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 882

{
  "id" : "b9758fb0-fc39-4a47-b2d6-f8458051467f",
  "ownerIdentityId" : "d1763338-f341-4eea-93e8-1f35c56b751d",
  "createdBy" : "d1763338-f341-4eea-93e8-1f35c56b751d",
  "createdAt" : "2021-07-26T20:06:23.386085Z",
  "updatedAt" : "2021-07-26T20:06:23.386428Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "ACME App Wan 2021-07-26T20:06:23.385965Z",
  "zitiId" : "c5f9e6e6-6bf5-4720-a6b9-10bf1d14a278",
  "networkId" : "54822e40-d3d3-4497-a814-f108960b4802",
  "serviceAttributes" : [ ],
  "endpointAttributes" : [ ],
  "postureCheckAttributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/54822e40-d3d3-4497-a814-f108960b4802",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/b9758fb0-fc39-4a47-b2d6-f8458051467f"
    }
  }
}

Find App Wans

GET /app-wans

Authorization

This endpoint requires read action on the app-wan resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

attributeType

String

true

Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy].

attribute

Object

true

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

zitiId

String

true

networkId

String

false

serviceAttributes

Array[String]

false

endpointAttributes

Array[String]

false

postureCheckAttributes

Array[String]

false

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans?createdAt=%3E2021-07-26T20:04:04.066833Z,%3C2021-07-26T21:04:00.435741Z,%3E2021-07-26T19:04:00.435758Z' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJEWUUweFI2bnZtUUE1cWRBdlcyQkF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY0OWM0ZTI5LTU4MGItNDU3Mi05ZTI5LTZmZmQzOTQ2Yjk0MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTg0NSwiZXhwIjoxNjI3MzMzNDQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFhMWI5ODY1LTY0YjEtNGQ2MS05NDViLTg4YjQxYWMwMjc2N1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTg0NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.JXlx0qtjLkerPoLTiat_dDbcFYys2lJJu3PNW40wjxOj2rGCNgHFLXSjDjdzcMLo3qO8JXPM2-atrX3NefZU4G_HGUiN089ADWN-UNi_7Gi4UAeUuVois9FDnBaVxrI7releZ3Q-94DL1r8f67NVI5jYylXBdm1OFKFK4gSLu9s6EEVNL85nJbjLVgP7cAGS8qPr7enuQuvVn9JB0KL6-fWKv-2HMWqobcxnzce1X0K6GwpsQki5UHsVe93S7SyCmXC_JhDOySKcmJR61HQTcNcCtbVIZpN8VviOP3fS0fDOEEOlrB1XdOJQDBAABTMqJtCGob6Lfw7A5x7lCaR2LQ'

Example response

HTTP/1.1 400 Bad Request
Content-Type: application/hal+json
Content-Length: 149

{
  "traceId" : null,
  "errors" : [ "Too many filter parameters for createdAt" ],
  "status" : {
    "code" : 400,
    "label" : "Bad Request"
  }
}

Create App Wan

POST /app-wans

Authorization

This endpoint requires create action on the app-wan resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

false

name

String

false

serviceAttributes

Array[String]

true

endpointAttributes

Array[String]

true

postureCheckAttributes

Array[String]

true

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

zitiId

String

true

networkId

String

false

serviceAttributes

Array[String]

false

endpointAttributes

Array[String]

false

postureCheckAttributes

Array[String]

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJkeFBGMEc2MlhJS2VGMWh3b0IzQnBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE5MzZiNzk4LTdlOWItNDFjOS1hMjIyLTgxOTk0NDEwMTVkNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk4MywiZXhwIjoxNjI3MzMzNTgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhiMDU2MzQ2LTgzNjEtNDFkZC1hMjRjLTA5YjkyYjVkMWUwOVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.OxRyVD_GG-xaHCz4YlgY4IJxblB4mwEi8LiFH3XvoxngakiM5LwgBf5CWCKgEzxOAOhAWv_Tt15dR2uVlrL34b-o23qwDonTpB_3vHjUssTyDi0RVWHumuWJeWCyEcOWGtNe7E3g4f4wzV--VaOM_TyMU2WSKCzCnLdJpTS20DXsG3E6NEsSY0Ue73ktlmb-PuZr80sHKaSR9IwGACo_SD9AXMVhsSiS4esVzQ0zceN6OCWRm8yKQO7FQjtTAxbGyPJZIGGPjH8JHH4DT3S2mjKWFnIl93awB4WImYXP5mUQIMQYQVGfQDI5Q_KN8iJ4wkEYBsd6PX364sOcOxsHjQ' \
    -d '{"networkId":"eef976f3-6ed3-462a-a0a1-f854bfaa8480","name":"Test App Wan 1627329983","serviceAttributes":["#service01"],"endpointAttributes":["@Test_endpoint2021-07-26T20:06:23.484588Z","#accessclients"],"postureCheckAttributes":["#windows"]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 951

{
  "id" : "e26fac95-e19a-414b-ac4c-ce429023379f",
  "ownerIdentityId" : "a936b798-7e9b-41c9-a222-8199441015d6",
  "createdBy" : "a936b798-7e9b-41c9-a222-8199441015d6",
  "createdAt" : "2021-07-26T20:06:23.509036Z",
  "updatedAt" : "2021-07-26T20:06:23.512975Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Test App Wan 1627329983",
  "zitiId" : "e1f00f17-12cd-4dec-aa61-d1762cf60ebd",
  "networkId" : "eef976f3-6ed3-462a-a0a1-f854bfaa8480",
  "serviceAttributes" : [ "#service01" ],
  "endpointAttributes" : [ "@Test_endpoint2021-07-26T20:06:23.484588Z", "#accessclients" ],
  "postureCheckAttributes" : [ "#windows" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/eef976f3-6ed3-462a-a0a1-f854bfaa8480",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/e26fac95-e19a-414b-ac4c-ce429023379f"
    }
  }
}

Update App Wan

PUT /app-wans/{id}

Authorization

This endpoint requires update action on the app-wan resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

serviceAttributes

Array[String]

true

endpointAttributes

Array[String]

true

postureCheckAttributes

Array[String]

true

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

zitiId

String

true

networkId

String

false

serviceAttributes

Array[String]

false

endpointAttributes

Array[String]

false

postureCheckAttributes

Array[String]

false

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/f88e498d-be91-45cf-aaea-fc58c576341a' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ3SllGQzJmME9KY29WSVFJWUlISlZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ5ZjU4ZmFjLWQ0MGYtNDU5ZS1hNzcyLWI5NjAxNzkzNzViZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk4MywiZXhwIjoxNjI3MzMzNTgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImMyMzQ5ODgzLTVjZTYtNDNkZi1hMDU3LTBlNzdiYTNlNWUwYVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Xt37G6mkCWgSRhtBsUZ3Tjcm6Nm6SWin6vyo3ORWNS9ppS6GtVPbCHUIuC09pqfnWigKT0Gn2zK-FB1hXr1CTO7yjxPCwp3188rzoxtA3wocK0gOd_4aSNfms4ZBGU41WrP10enzQyfIi2LxO-it7zbz4flv65oi3cGhaRGT0WWq84IXjUTezDr7Lw_3D_MDHxyefpnpBmZem7TCAdKbtwit5UTTzx-A8un3YNS9uru51gDBrGiGvGYqEWg9vP-VSEt7d1myfgK1ZIwVZ-wFLzVpOsdGja6W2WfRNmjEm8JkZy_y_AWf4kEaB2tp1WP3YOkw-QORi8jdYPj99QK3aQ' \
    -d '{"name":"Updated App Wan name","serviceAttributes":["#service03","#service02","#service01"],"endpointAttributes":["#usendpoints"],"postureCheckAttributes":["#windows"]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 929

{
  "id" : "f88e498d-be91-45cf-aaea-fc58c576341a",
  "ownerIdentityId" : "976c59cd-44f9-4208-a31a-6fa2ce236741",
  "createdBy" : "976c59cd-44f9-4208-a31a-6fa2ce236741",
  "createdAt" : "2021-07-26T20:06:23.217513Z",
  "updatedAt" : "2021-07-26T20:06:23.228949Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Updated App Wan name",
  "zitiId" : "2460941c-f460-4047-baf8-c147bde4d900",
  "networkId" : "c8919aa2-f220-4bf5-b3db-77d92d3ee058",
  "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
  "endpointAttributes" : [ "#usendpoints" ],
  "postureCheckAttributes" : [ "#windows" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c8919aa2-f220-4bf5-b3db-77d92d3ee058",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/f88e498d-be91-45cf-aaea-fc58c576341a"
    }
  }
}

Delete App Wan

DELETE /app-wans/{id}

Authorization

This endpoint requires delete action on the app-wan resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/63ca3a4d-c770-48e2-bc65-2a5a7cc3283c' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJSMWhGcmtub25nV09sMlpjczNCb2F3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU0NjI1YWQ0LWRmY2QtNDU0Ny04ZWFmLWQ4MDdhYjYwMjYwMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk4MywiZXhwIjoxNjI3MzMzNTgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhhODdmZjA4LTg0NmEtNDY2NC04MmY2LWY4MzlmN2EyYzFiNFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.kqSB9u6aisCIvpTVrZUodMMH50_hPbYEKEFt09k4BKABReAVfteWutDpbn_ZCbrfaHVbLRy-qxUHJmKQHWWIj5ZSbErbqRN35lgfHJ9vmB-nhbLaBePjBvFGzP3t36ho5mULzXSkKaQZtsB1p3WdwyZWhQ0R4_uMLqUifh3YtW7TAYu43SbONCaCBSaS39wkubSH0v4wvXD2SGqcQLyUjVYoGhmJ-3VRMn91vm-5UBCETZ7e_85UzQkbcI-uV7JOGhg612x8onsRvcwlQDl5o7PiY0LRgGkAT2NSOW-GdemnFhrBopmLqrVB6AmPkHk-1K1bmaQlpeKznO3OxQrxRg'

Example response

HTTP/1.1 200 OK

Posture Checks

Find Posture Checks

GET /posture-checks

Authorization

This endpoint requires read action on the posture-check resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

type

Object

true

Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI].

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

attribute

Object

true

deleted

Object

true

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

zitiId

String

false

Size must be between 1 and 255 inclusive.

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

type

String

false

Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

attributes

Array[String]

false

data

Object

false

data.domains

Array[String]

false

data.macAddresses

Array[String]

false

data.timeoutSeconds

Integer

true

The number of seconds before an MFA TOTP will need to be provided before the posture check begins to fail (optional) Defaults to 0 == no timeout. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature. This property will be null in all prior version networks. It may be null in legacy instances in an upgraded network.

Must be at least 0.

data.promptOnWake

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports a "wake" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.promptOnUnlock

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports an "unlock" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.ignoreLegacyEndpoints

Boolean

true

Forces all other options to be ignored for legacy clients that do not support event state (optional) Defaults to false. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.operatingSystems

Array[Object]

false

data.operatingSystems[].type

String

false

Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer].

data.operatingSystems[].versions

Array[String]

false

data.process

Object

false

data.process.osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

data.processes

Array[Object]

false

data.processes[].osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.processes[].path

String

false

data.processes[].hashes

Array[String]

true

data.processes[].signerFingerprints

Array[String]

true

data.semantic

String

true

Must be one of [AllOf, AnyOf].

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks?type=MAC' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZTlB4elVWR3dVaGN0SjZBcDB0UlpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjlmNDc3ODA4LTg2ZjEtNDhjNy1hMTY3LTQwOGQ1MDgyNDlhZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTg5MSwiZXhwIjoxNjI3MzMzNDkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE0ZmE5NjQyLWZkZGMtNDczOS1hODk5LTllM2E2ZmYzNjljM1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTg5MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.E8A9qPdrwfnbbi9WdKrxS6Yn9Gj-6rb9OZM_ujn8V-L_6nAsGW_Zw5Fkxiq8mL3Y7oNgViadIy5oWFNVMEV5XQKRDKWaB6fhtkcXK5zP2C3L5fGbq1dlDlNwFeR1oSo4vgTyu3-L1IwdgVR9nordZqyIq11sCIHmOj8OxEqJGFnenZnNIcX5HGHMTKO6C6HIEUNJHtnYiMDb3R69iRQZZE0oHLKDXttjLl4j5ywXT_bdcWiH-7aDMg5UBIG7uPw9jahOJiuRYhfItZy0r9t_eTnFfODljPhAkFkMi1-VdGez5PUBesAow0o4GgBbmiewX5sII4XmaQgODJ2P0vRHvA'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 222

{
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks"
    }
  },
  "page" : {
    "size" : 0,
    "totalElements" : 0,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Posture Check

GET /posture-checks/{id}

Authorization

This endpoint requires read action on the posture-check resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

zitiId

String

false

Size must be between 1 and 255 inclusive.

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

type

String

false

Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

attributes

Array[String]

false

data

Object

false

data.domains

Array[String]

false

data.macAddresses

Array[String]

false

data.timeoutSeconds

Integer

true

The number of seconds before an MFA TOTP will need to be provided before the posture check begins to fail (optional) Defaults to 0 == no timeout. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature. This property will be null in all prior version networks. It may be null in legacy instances in an upgraded network.

Must be at least 0.

data.promptOnWake

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports a "wake" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.promptOnUnlock

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports an "unlock" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.ignoreLegacyEndpoints

Boolean

true

Forces all other options to be ignored for legacy clients that do not support event state (optional) Defaults to false. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.operatingSystems

Array[Object]

false

data.operatingSystems[].type

String

false

Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer].

data.operatingSystems[].versions

Array[String]

false

data.process

Object

false

data.process.osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

data.processes

Array[Object]

false

data.processes[].osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.processes[].path

String

false

data.processes[].hashes

Array[String]

true

data.processes[].signerFingerprints

Array[String]

true

data.semantic

String

true

Must be one of [AllOf, AnyOf].

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks/6930982e-8e0b-4a2c-916e-aa7fc235f602' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJIR1Ayc3JkN1QwSHhtQkNFNTA3QVFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZiYjAxNzQ0LTcxOWQtNDVkNS1iOWRkLWYwOWJlZmY5MDkxNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk5NywiZXhwIjoxNjI3MzMzNTk3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFjODhhMmRkLTNmNjUtNDM0OS1hNDQzLTM2MjJmZTZjZTM5ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk5N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.kjCUxAnj-Qde7nb1MCV52pDa06frcu4VpkHn415amdanWpQ8C1EDBDPtVReV4oUtoRwNt4jKu0FAg2cit8aD7HTuWebFPBc86TVUZ7ibC-TprkGFan6_Q-_faUdK6PRaemu-WT038iub-rrWzEvheytHlDBwnMXuu42J5BU5ARLiultw9W1J1eeP8XOlnOcrKVE9hB1WLQYNSYYQUgQQg410R--TW-bBNTVZDE7saiOUY_A1LaaAzK_8JxJZyctJvw0JVxcut-RS--gTt16lrEE8JYOAaeu7-mMCUqgOQNqxS7Nl5co-xzD1yktHEPz2xbxu1p_30GIdD2C62xMvCg'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 669

{
  "id" : "6930982e-8e0b-4a2c-916e-aa7fc235f602",
  "zitiId" : "ziti.id.gw7mp00c3qf",
  "name" : "My Posture Check 61769979083333692",
  "networkId" : "ad62ded3-ac14-470c-9609-a694edf88c38",
  "type" : "PROCESS",
  "ownerIdentityId" : "b8d5a4fb-1e83-48f0-b3dd-237621f69db2",
  "createdBy" : "b8d5a4fb-1e83-48f0-b3dd-237621f69db2",
  "createdAt" : "2021-07-26T20:06:36.953186Z",
  "updatedAt" : "2021-07-26T20:06:36.953186Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "data" : {
    "process" : {
      "osType" : "Windows",
      "path" : "c:\\programs",
      "hashes" : [ ],
      "signerFingerprint" : null
    }
  }
}

Create Posture Check

POST /posture-checks

Authorization

This endpoint requires create action on the posture-check resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

io.netfoundry.common.util.validation.ValidAs.

networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

type

String

true

io.netfoundry.common.util.validation.ValidAs.
Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI].

attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

data

Object

false

io.netfoundry.common.util.validation.ValidAs.

data.domains

Array[String]

false

data.macAddresses

Array[String]

false

data.timeoutSeconds

Integer

true

The number of seconds before an MFA TOTP will need to be provided before the posture check begins to fail (optional) Defaults to 0 == no timeout. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature. This property will be null in all prior version networks. It may be null in legacy instances in an upgraded network.

Must be at least 0.

data.promptOnWake

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports a "wake" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.promptOnUnlock

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports an "unlock" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.ignoreLegacyEndpoints

Boolean

true

Forces all other options to be ignored for legacy clients that do not support event state (optional) Defaults to false. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.operatingSystems

Array[Object]

false

data.operatingSystems[].type

String

false

Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer].

data.operatingSystems[].versions

Array[String]

false

data.process

Object

false

data.process.osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

data.processes

Array[Object]

false

data.processes[].osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.processes[].path

String

false

data.processes[].hashes

Array[String]

true

data.processes[].signerFingerprints

Array[String]

true

data.semantic

String

true

Must be one of [AllOf, AnyOf].

Response fields

Path Type Optional Description

id

String

false

zitiId

String

false

Size must be between 1 and 255 inclusive.

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

type

String

false

Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

attributes

Array[String]

false

data

Object

false

data.domains

Array[String]

false

data.macAddresses

Array[String]

false

data.timeoutSeconds

Integer

true

The number of seconds before an MFA TOTP will need to be provided before the posture check begins to fail (optional) Defaults to 0 == no timeout. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature. This property will be null in all prior version networks. It may be null in legacy instances in an upgraded network.

Must be at least 0.

data.promptOnWake

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports a "wake" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.promptOnUnlock

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports an "unlock" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.ignoreLegacyEndpoints

Boolean

true

Forces all other options to be ignored for legacy clients that do not support event state (optional) Defaults to false. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.operatingSystems

Array[Object]

false

data.operatingSystems[].type

String

false

Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer].

data.operatingSystems[].versions

Array[String]

false

data.process

Object

false

data.process.osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

data.processes

Array[Object]

false

data.processes[].osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.processes[].path

String

false

data.processes[].hashes

Array[String]

true

data.processes[].signerFingerprints

Array[String]

true

data.semantic

String

true

Must be one of [AllOf, AnyOf].

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI4eFo2TElvb1R3QTRSelNDUW1KcklnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI4ZDVhNGZiLTFlODMtNDhmMC1iM2RkLTIzNzYyMWY2OWRiMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk5NiwiZXhwIjoxNjI3MzMzNTk2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg2YWUzZjZkLTQ4MzItNGNmOC04MGI0LThiMzA2ZTEyMGZkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk5Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.GWHa7DNGZOZl58etwpuuEZjiruNr3C9NMxgR3rUqRECqFNZRHHml0_B-n_pNC0nQBaDCCaV6Pe9udciqZc4RQH-I0Bi4OyCZ03QbZioyCuYYW35saEcnrdGRP6q4KIyxR278dX9-XRQDb8Wa-uWbNRCtd2YZ-ZIJkILUYLqRVI4CwmUq3K6DdqiAJRGSRUZOALp1_2SQZ4uqIRCFJcHAy-sYiWRftb3tdlN5cpWQ5ZlXGUokoAdr_0wWZb0aBa6wsUS-dNaHeQ1gEICyIT9ZA8Yauq7e4dqWKClocYpcJAs3xk5vMBaRsmwgGMvCxl125pYneOqhHiNAHnYzxxPMfw' \
    -d '{"name":"My Posture Check 61769979083333692","networkId":"ad62ded3-ac14-470c-9609-a694edf88c38","type":"PROCESS","attributes":["#Attr-2","#Attr-1"],"data":{"process":{"osType":"Windows","path":"c:\\programs","hashes":null,"signerFingerprint":null}}}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 670

{
  "id" : "6930982e-8e0b-4a2c-916e-aa7fc235f602",
  "zitiId" : "ziti.id.gw7mp00c3qf",
  "name" : "My Posture Check 61769979083333692",
  "networkId" : "ad62ded3-ac14-470c-9609-a694edf88c38",
  "type" : "PROCESS",
  "ownerIdentityId" : "b8d5a4fb-1e83-48f0-b3dd-237621f69db2",
  "createdBy" : "b8d5a4fb-1e83-48f0-b3dd-237621f69db2",
  "createdAt" : "2021-07-26T20:06:36.953186Z",
  "updatedAt" : "2021-07-26T20:06:36.953186Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "data" : {
    "process" : {
      "osType" : "Windows",
      "path" : "c:\\programs",
      "hashes" : null,
      "signerFingerprint" : null
    }
  }
}

Update Posture Check

PATCH /posture-checks/{id}

Authorization

This endpoint requires update action on the posture-check resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

io.netfoundry.common.util.validation.ValidAs.

type

String

true

Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI].

attributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

ownerIdentityId

String

true

io.netfoundry.common.util.validation.ValidAs.

data

Object

true

data.domains

Array[String]

false

data.macAddresses

Array[String]

false

data.timeoutSeconds

Integer

true

The number of seconds before an MFA TOTP will need to be provided before the posture check begins to fail (optional) Defaults to 0 == no timeout. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature. This property will be null in all prior version networks. It may be null in legacy instances in an upgraded network.

Must be at least 0.

data.promptOnWake

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports a "wake" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.promptOnUnlock

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports an "unlock" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.ignoreLegacyEndpoints

Boolean

true

Forces all other options to be ignored for legacy clients that do not support event state (optional) Defaults to false. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.operatingSystems

Array[Object]

false

data.operatingSystems[].type

String

false

Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer].

data.operatingSystems[].versions

Array[String]

false

data.process

Object

false

data.process.osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

data.processes

Array[Object]

false

data.processes[].osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.processes[].path

String

false

data.processes[].hashes

Array[String]

true

data.processes[].signerFingerprints

Array[String]

true

data.semantic

String

true

Must be one of [AllOf, AnyOf].

Response fields

Path Type Optional Description

id

String

false

zitiId

String

false

Size must be between 1 and 255 inclusive.

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

type

String

false

Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

attributes

Array[String]

false

data

Object

false

data.domains

Array[String]

false

data.macAddresses

Array[String]

false

data.timeoutSeconds

Integer

true

The number of seconds before an MFA TOTP will need to be provided before the posture check begins to fail (optional) Defaults to 0 == no timeout. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature. This property will be null in all prior version networks. It may be null in legacy instances in an upgraded network.

Must be at least 0.

data.promptOnWake

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports a "wake" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.promptOnUnlock

Boolean

true

Reduces the current timeout to 5m (if not less than already) when an endpoint reports an "unlock" event (optional) Defaults to false. only supported in Ziti C SDK v0.20.0 and later. Individual ZDE/ZME clients may take time to update. If older endpoint are used with the new MFA options ignoreLegacyEndpoints allows administrators to decide how those clients should be treated. If ignoreLegacyEndpoints is true, they will not be subject to timeout or wake events. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.ignoreLegacyEndpoints

Boolean

true

Forces all other options to be ignored for legacy clients that do not support event state (optional) Defaults to false. Introduced in ziti v0.20.12 as part of the {@link ZitiFeature#postureCheck_mfa_timeoutSeconds} feature.

data.operatingSystems

Array[Object]

false

data.operatingSystems[].type

String

false

Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer].

data.operatingSystems[].versions

Array[String]

false

data.process

Object

false

data.process.osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

data.processes

Array[Object]

false

data.processes[].osType

String

false

Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].

data.processes[].path

String

false

data.processes[].hashes

Array[String]

true

data.processes[].signerFingerprints

Array[String]

true

data.semantic

String

true

Must be one of [AllOf, AnyOf].

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks/6930982e-8e0b-4a2c-916e-aa7fc235f602' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJQd1FyNVlDamxoTm1ESUdVUllTTmlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM2ZGJhMWM1LTlmYzUtNGNmZS05NTRjLWNjMGY0ZmE3NDA1MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk5OCwiZXhwIjoxNjI3MzMzNTk4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA3MmM1ZWIwLTA1ZjEtNGRkMi1iODFmLWIxMWI5NzZkYTNlM1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk5OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.C8Rvit4Bte9azMuTUQpCQBWaDyBjdlmZVWIb5ddQJMCVw3Jcol61QpUtxzbAIb5IuqXfryyaMFi-fIpM_ZyhUPh1t-fKndQcBG960iGaQTANSwkh4l4vFsDt-z9jZo5Z3hffY_h9CaGsp3ROgx_v4oBOOW0fnhDJnslwmaltQaZyjYJYCiDaeQx-tc6Zzs30pjq6183SrSSqLuAGvt2PUd2i8H-8_Pmh0yOwvk5CwGJ0MlyrxgSlSkdJVsvJAdPXsaDL9Vcf9FNKjKVAGYN75I07KxdRHGbbk5uYD0Oa5PrrifXc5Y1MSB9fBRAUmtt0brf7oCH2tJ5j2QIXiwIeow' \
    -d '{"name":"Our Service 61769979083333692","attributes":["#Attr-2","#Attr-4"]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 664

{
  "id" : "6930982e-8e0b-4a2c-916e-aa7fc235f602",
  "zitiId" : "ziti.id.gw7mp00c3qf",
  "name" : "Our Service 61769979083333692",
  "networkId" : "ad62ded3-ac14-470c-9609-a694edf88c38",
  "type" : "PROCESS",
  "ownerIdentityId" : "b8d5a4fb-1e83-48f0-b3dd-237621f69db2",
  "createdBy" : "b8d5a4fb-1e83-48f0-b3dd-237621f69db2",
  "createdAt" : "2021-07-26T20:06:36.953186Z",
  "updatedAt" : "2021-07-26T20:06:38.243338Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-4", "#Attr-2" ],
  "data" : {
    "process" : {
      "osType" : "Windows",
      "path" : "c:\\programs",
      "hashes" : [ ],
      "signerFingerprint" : null
    }
  }
}

Delete Posture Check

DELETE /posture-checks/{id}

Authorization

This endpoint requires delete action on the posture-check resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks/6930982e-8e0b-4a2c-916e-aa7fc235f602' -i -X DELETE \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJLUkZkR3VyNlBfNkV4dTlVN3h4d3ZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMxMzRlMDQyLTU1YTgtNDkxZi1iN2U3LTVkZGM2MWJlODFmYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk5OCwiZXhwIjoxNjI3MzMzNTk4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFkZDQzZTM2LTA1NTItNDFiZi05YzI1LWZlYjk4NDY4MDg3MVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk5OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.TfA7M3JIkFv83jTJ93HgNPkgemg7soYbqNt5UinUcT22aGV1QTQCTnbGMcJrTq5gC4Oh5b3p47BTep5eDhSH0Stm7gHAPGrUzt7vIKhmNjnygPeYbWM1UXATy48Jc3tKOfHWWq7oM_0eYUpt7bvsMbeZACBvJ6khDsd9VbP7DyzWUd4a8M0XpkuSi8g0LQQQJ5ZStTJhEoYrxLzL56RvmE2DcntEax39ChKO_mUbnMlCDh4xf5C7okY4uZ_lZJ1wP8bptzv1EypKbMJ3X1hiGrBsXxbd3XtI5hsSW3XYJIjEBoa0vFmTmYNIrf0H27gClV06fVJbC36vZVAdL9yrpw'

Example response

HTTP/1.1 200 OK

Certificate Authorities

Find Certificate Authorities

GET /certificate-authorities

Authorization

This endpoint requires read action on the certificate-authority resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

isAutoCaEnrollmentEnabled

Boolean

true

isOttCaEnrollmentEnabled

Boolean

true

isVerified

Boolean

true

isAuthEnabled

Boolean

true

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDcklCMDJPVC1iZlZLVHU1QXJ5RnhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ0N2EzOGI1LWRhM2ItNGQ0OC05NDYwLWI5MDc3OGY4MGI4YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk3NiwiZXhwIjoxNjI3MzMzNTc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjM0ZjY5ODEwLTdjYmYtNDY0NC04ZGNkLTJkNzBkZmJkZDEwZFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.s_lz1ZSe8aWgjvxcbmXNaN7dJj4_aN9ZrFzm2RbHHYrUm3pqZA5vizU2O1l3QpdUhSl018_XAP2zaeIUMRT12T1vjnL-R2S_EkBPwp5ANvw_0ozMjnBott6k0gGouHJsxksyW5etSHr9lq4R8sg0Xkvq4TBQvCNP2-NVXp6lGsvQ6NgzpPZtTFGiv8cRyNRIYI7k6K79q0CExFRK9E-MRK4WCJk_dr-eWMBtK0yMAnLSYXN1lEGlY8tMnPoPVV45cLs9cc8tA71zFFdgQoGIpI4yZ7a9RKG476XIa0nYyl-8cQZX_W65Z2-hMuyO0A_puprIMthwz49R3foWbVlkrQ'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 17353

{
  "_embedded" : {
    "certificateAuthorityList" : [ {
      "id" : "18336be9-8c86-4f27-9613-ec94377cd1e2",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.124326Z",
      "updatedAt" : "2021-07-26T20:06:16.124326Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "c034ece7-36ae-44a0-a311-23b8141e12c0",
      "zitiId" : "9824a43b-6ffe-4878-b785-da81f7039475",
      "name" : "ACME CA 2021-07-26T20:06:16.124167Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c034ece7-36ae-44a0-a311-23b8141e12c0",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/18336be9-8c86-4f27-9613-ec94377cd1e2"
        }
      }
    }, {
      "id" : "1e9ea794-8c9a-457c-947d-0784b970a247",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.290590Z",
      "updatedAt" : "2021-07-26T20:06:16.290590Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "e8966e2c-3991-46d6-87e6-aeb5641429ed",
      "zitiId" : "22cb98b7-ffd1-4e6b-ade6-0e402860273c",
      "name" : "ACME CA 2021-07-26T20:06:16.290478Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e8966e2c-3991-46d6-87e6-aeb5641429ed",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/1e9ea794-8c9a-457c-947d-0784b970a247"
        }
      }
    }, {
      "id" : "214c8b82-94e8-4f4c-a617-b21824aef27f",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.369495Z",
      "updatedAt" : "2021-07-26T20:06:16.369495Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "96dcef20-a606-4296-b4f2-6a75d75c849a",
      "zitiId" : "d73a97e0-1412-47a3-8f46-b231d1e20a58",
      "name" : "ACME CA NO 2021-07-26T20:06:16.369389Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/96dcef20-a606-4296-b4f2-6a75d75c849a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/214c8b82-94e8-4f4c-a617-b21824aef27f"
        }
      }
    }, {
      "id" : "28464663-e47b-4aeb-9943-b3413a0ba263",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.124896Z",
      "updatedAt" : "2021-07-26T20:06:16.124896Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "c034ece7-36ae-44a0-a311-23b8141e12c0",
      "zitiId" : "84f32889-0c49-4007-a8a7-17975f2b17db",
      "name" : "ACME CA NO 2021-07-26T20:06:16.124782Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c034ece7-36ae-44a0-a311-23b8141e12c0",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/28464663-e47b-4aeb-9943-b3413a0ba263"
        }
      }
    }, {
      "id" : "2da4691a-8bc5-44a1-b636-a462f3b6d8eb",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.331714Z",
      "updatedAt" : "2021-07-26T20:06:16.331714Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "17f8d763-2833-4f9d-a51a-c6d58cc4846d",
      "zitiId" : "656bb600-e5b1-42da-9d13-ea5b4d02ad9b",
      "name" : "ACME CA 2021-07-26T20:06:16.331607Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/17f8d763-2833-4f9d-a51a-c6d58cc4846d",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/2da4691a-8bc5-44a1-b636-a462f3b6d8eb"
        }
      }
    }, {
      "id" : "31fa9609-6171-4d3d-a952-04f2362f43de",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.290969Z",
      "updatedAt" : "2021-07-26T20:06:16.290969Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "e8966e2c-3991-46d6-87e6-aeb5641429ed",
      "zitiId" : "3818409e-d28d-45b9-94fb-579023bc12bc",
      "name" : "ACME CA NO 2021-07-26T20:06:16.290862Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e8966e2c-3991-46d6-87e6-aeb5641429ed",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/31fa9609-6171-4d3d-a952-04f2362f43de"
        }
      }
    }, {
      "id" : "4d8c1d74-841e-48b7-bf0c-196f479bea4a",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.168667Z",
      "updatedAt" : "2021-07-26T20:06:16.168667Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "0599e8e4-54f8-4a11-bb29-09958f854ab0",
      "zitiId" : "571d9ab7-c3c7-414e-944f-ab0d46f44b38",
      "name" : "ACME CA 2021-07-26T20:06:16.168565Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0599e8e4-54f8-4a11-bb29-09958f854ab0",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/4d8c1d74-841e-48b7-bf0c-196f479bea4a"
        }
      }
    }, {
      "id" : "604a4de4-519b-42c3-9300-bd553350ced6",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.156922Z",
      "updatedAt" : "2021-07-26T20:06:16.156922Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "76a8e9fd-3aa2-4813-89a5-fee19a8c8854",
      "zitiId" : "438f8280-d39d-49ba-8bc4-8e19706d82b4",
      "name" : "ACME CA 2021-07-26T20:06:16.156816Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/76a8e9fd-3aa2-4813-89a5-fee19a8c8854",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/604a4de4-519b-42c3-9300-bd553350ced6"
        }
      }
    }, {
      "id" : "78092841-d65c-437e-8e60-ba50bac48c6b",
      "ownerIdentityId" : "ef75511d-e1de-4744-9fea-986a89bfc18a",
      "createdBy" : "ef75511d-e1de-4744-9fea-986a89bfc18a",
      "createdAt" : "2021-07-26T20:06:16.205221Z",
      "updatedAt" : "2021-07-26T20:06:16.207113Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "0599e8e4-54f8-4a11-bb29-09958f854ab0",
      "zitiId" : "c06cf4da-d4dc-4685-bf9a-6674e415ae2a",
      "name" : "Test ca 02",
      "endpointAttributes" : [ "#secureclients" ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "-----BEGIN CERTIFICATE-----MIIEujCCAqKgAwIBAgIRAL9YVv7hhgdfje0+onHqzogwDQYJKoZIhvcNAQELBQAwczELMAkGA1UEBhMCVVMxEjAQBgNVBAcTCUNoYXJsb3R0ZTETMBEGA1UEChMKTmV0Rm91bmRyeTEQMA4GA1UECxMHQURWLURFVjEpMCcGA1UEAxMgTmV0Rm91bmRyeSwgSW5jLiBJbnRlcm1lZGlhdGUgQ0EwHhcNMjEwMTE1MjEwMDU3WhcNMjIwMTE1MjEwMTU3WjBcMQswCQYDVQQGEwJVUzESMBAGA1UEBxMJQ2hhcmxvdHRlMRMwEQYDVQQKEwpOZXRGb3VuZHJ5MRAwDgYDVQQLEwdBRFYtREVWMRIwEAYDVQQDEwlrWHdMajA0WFQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDJDRmC32XN31LU04Q4uh2uco+78sxCg8BzBbxQ7LrXRqdnfeuskoOx+b8OcA9Af4U9Co8rqrPaUR3y1bME5fIhZTFjesV3Z+V+dRyLlQQ6/tXybBwYeBUUwE/NSECx5jKXbLX3WgLISffxFToB5FVhX2okCkOPOOXiirKwUe9pCfWafnEJAevjH001nEMDh2Ir5Yny6PrU3SgRj9F1+aZ3kuattq89JybUofN1HHTGPOAUUzXIudhhFQC2HYGABGbxvoWBSFmM6i+oWHS9GOX5YnfApcbRDEiWHnGfQEPCOG3sRcA/NfPwV9wChyPMadgXNl+Pc9aFEOj20qmk/LK5AgMBAAGjYDBeMA4GA1UdDwEB/wQEAwIF4DAMBgNVHRMBAf8EAjAAMB0GA1UdDgQWBBRERYGCL0A1YBMCUbxwz4sAk6cfkTAfBgNVHSMEGDAWgBTFYtjJ5IqMPUdx6X0KdeZqZratzzANBgkqhkiG9w0BAQsFAAOCAgEAekd7/VB1nWpLa/2iu7xz8C0MPnkczH4qvWSgoJ7tJ+bXqT4+CL3T4jk7kRFxAj6YXDaTyrhzlwtNxmmH0fcJ0NNXF+86pAAJWbjzgpy20YOy++R4FgJM0Mai6FRDeec94BdFV90ZDxfQ7UJtV3DXtzZAVZGUMo/hsPWi0g2LzJxj2jScugjHBl5rbdc8eQdenAg4Es47dac7sF4XBLocYZeyei4LxaAgVW+R8RmU+VrJv8HcTiRaweo5/47DxYTCg69LvKThf/ow2nS+BW1bHEyD7EI++UuBk/qwoSEtjpMaXlPzN4hMk/Ht7JeifYvWloz2VgJQm8C7O4jplUcVmHkL2OgpGhXiEidA5w1xBInuohQQIK+jSFh7sxG/Ck0EVNIE9BfOc6hhM6emL0xFDoNdSXEGLs4Fm4IaazJJxREJZoB2Cb5c7MKvO6EMF08xG2JNf2P9QiQu6nWZFmyh3wUKY6/LW6YlOhPAmbQ/gu0q+0UuzgnJU61vrIedekDK8q4ePvFZDEsXKg+gA14d5eGh4dRrOqvUZtyE8r6g8vUveQsOpjt7BML6p7kSXW6OGe2K5FrnF2vhJSbHd/zb+VFhm355ssqubCpNpfnrHGoquQVbXJ3HyFEQ0i+BugEUDDE2lIofz/qlq9x+vtb13CMIy1w5WLo3pCVTsufnZmo=-----END CERTIFICATE-----",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0599e8e4-54f8-4a11-bb29-09958f854ab0",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/78092841-d65c-437e-8e60-ba50bac48c6b"
        }
      }
    }, {
      "id" : "9d24dd9c-ab94-4523-89a7-f7ef2db59ba3",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.369130Z",
      "updatedAt" : "2021-07-26T20:06:16.369130Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "96dcef20-a606-4296-b4f2-6a75d75c849a",
      "zitiId" : "e54f9b89-7135-4102-b999-0c7249685a58",
      "name" : "ACME CA 2021-07-26T20:06:16.369019Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/96dcef20-a606-4296-b4f2-6a75d75c849a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/9d24dd9c-ab94-4523-89a7-f7ef2db59ba3"
        }
      }
    }, {
      "id" : "a8a54c7e-ff65-47e4-9068-63651e3a747b",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.243602Z",
      "updatedAt" : "2021-07-26T20:06:16.243602Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "b5a6f4d3-b33a-4b17-995d-4a361d94cf6e",
      "zitiId" : "68cc55d2-7fa9-4f43-a760-6b9639c93c2e",
      "name" : "ACME CA NO 2021-07-26T20:06:16.243494Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b5a6f4d3-b33a-4b17-995d-4a361d94cf6e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/a8a54c7e-ff65-47e4-9068-63651e3a747b"
        }
      }
    }, {
      "id" : "b838c1f4-5847-42a3-a1e7-63352c24744b",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.243213Z",
      "updatedAt" : "2021-07-26T20:06:16.243213Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "b5a6f4d3-b33a-4b17-995d-4a361d94cf6e",
      "zitiId" : "065f8ceb-0b6b-4045-9b97-5ac2e421cd93",
      "name" : "ACME CA 2021-07-26T20:06:16.243101Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b5a6f4d3-b33a-4b17-995d-4a361d94cf6e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b838c1f4-5847-42a3-a1e7-63352c24744b"
        }
      }
    }, {
      "id" : "c2298970-7a0f-4753-a380-5f94d7e03cf5",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.157280Z",
      "updatedAt" : "2021-07-26T20:06:16.157280Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "76a8e9fd-3aa2-4813-89a5-fee19a8c8854",
      "zitiId" : "f2a24d16-f32f-4a67-b827-ba1dde3a3fac",
      "name" : "ACME CA NO 2021-07-26T20:06:16.157173Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/76a8e9fd-3aa2-4813-89a5-fee19a8c8854",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/c2298970-7a0f-4753-a380-5f94d7e03cf5"
        }
      }
    }, {
      "id" : "f5a74b8a-8cd5-47c7-b3dc-4e4710ae370d",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-07-26T20:06:16.169017Z",
      "updatedAt" : "2021-07-26T20:06:16.169017Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "0599e8e4-54f8-4a11-bb29-09958f854ab0",
      "zitiId" : "228c1b09-05df-4c67-a931-c2980b50a71c",
      "name" : "ACME CA NO 2021-07-26T20:06:16.168905Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "verified" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0599e8e4-54f8-4a11-bb29-09958f854ab0",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/f5a74b8a-8cd5-47c7-b3dc-4e4710ae370d"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 14,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Certificate Authority

GET /certificate-authorities/{id}

Authorization

This endpoint requires read action on the certificate-authority resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/2b4e6879-05e9-40a6-a714-1574f37da171' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJmbGd0RnBCUWlSWU1QZ0ZpTzNPcU1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc1ZDE2YTk0LTM5OWUtNDVkZS05NWYyLTJkZDE3YTlkMDRmYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk3NiwiZXhwIjoxNjI3MzMzNTc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVlN2JjNWZjLWJlNGMtNGMyMi1iMTlmLTBkMzlhOWIzOGZkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.aRNH2cGA9LCR60WPXAI2tdJ9-JHxZuxxI_c-EibbLR-V7bDQQjalydPVSPOTJcGyrxIYhpQk9BQVaQi89tJYSebVH2nsEbNfnWZA5yjQUHDcuPbXk9JFX2c56TXhY_wRruawsLVgecDQO4ikw0OiKeY7KthfjhAC9xtm2tlv5i4xZIhNDgHIu94ITySkWHKSiqniaTqVI2ezP-wMpdNOvPhQDY-UX6Ux_U9RRNln19gvDeDDXSILPeUv-cIGJAymt0BBotaYlNaCwobNHvwNfDj1dvk3-6jWlmabEpsgg3gM6qpshKcqKQIh-6p-48wO7oCMPr3y6Hyh-Bs9K-jBJA'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 976

{
  "id" : "2b4e6879-05e9-40a6-a714-1574f37da171",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-07-26T20:06:16.416481Z",
  "updatedAt" : "2021-07-26T20:06:16.416481Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "94cf74f9-d70c-4853-9e9f-046d14473581",
  "zitiId" : "f012a65e-394c-4348-9d25-e334c09c2288",
  "name" : "ACME CA 2021-07-26T20:06:16.416373Z",
  "endpointAttributes" : [ ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "fakePem",
  "verified" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/94cf74f9-d70c-4853-9e9f-046d14473581",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/2b4e6879-05e9-40a6-a714-1574f37da171"
    }
  }
}

Create Certificate Authority

POST /certificate-authorities

Authorization

This endpoint requires create action on the certificate-authority resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

Client must have create action under the annotated resource.
io.netfoundry.common.util.validation.ValidAs.

name

String

true

io.netfoundry.common.util.validation.ValidAs.

autoCaEnrollmentEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

authEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

ottCaEnrollmentEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

certPem

String

false

Size must be between 100 and 2147483647 inclusive.

endpointAttributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJNWHY5OGdJWmd4X1AwYnlSRjJ3eE1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVmNzU1MTFkLWUxZGUtNDc0NC05ZmVhLTk4NmE4OWJmYzE4YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk3NiwiZXhwIjoxNjI3MzMzNTc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg3NGJiMjg5LTg0MmMtNDdkMS05MDg0LTc0YzY0ZmE4NzNhNlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.UJADfo539T1zhpHh-rxCIqU9JiLoIGwJcSMUA6C469j0s2UT56_zj2i4tN2PvxrNlX8HfSJvdZOHqG9uTX2ex0OttclNM5ZevZGLPATDWrpwZ7esdXjEj_S7X3vXK-jpw3G1nG8Ahp2sEqVqvYxlYKCR_tWigh6c4LE1rLidd1lajzdanECOTcAe3It24nbM4AaxtWMfVCuyUKqFBwFxSDFPDAvED88BLAnaxg9RWvJsuCemn0CkpzMm-p3z1plzm8mBdUXqcewaKNekdXckfAlynchYbUPLZyGbjA0oEzI4BGF3me5TkEXbDhJI5fzHUfspH70nCecw6cXvFICYmQ' \
    -d '{"networkId":"0599e8e4-54f8-4a11-bb29-09958f854ab0","name":"Test ca 02","autoCaEnrollmentEnabled":true,"authEnabled":false,"ottCaEnrollmentEnabled":false,"certPem":"-----BEGIN CERTIFICATE-----\nMIIEujCCAqKgAwIBAgIRAL9YVv7hhgdfje0+onHqzogwDQYJKoZIhvcNAQELBQAw\nczELMAkGA1UEBhMCVVMxEjAQBgNVBAcTCUNoYXJsb3R0ZTETMBEGA1UEChMKTmV0\nRm91bmRyeTEQMA4GA1UECxMHQURWLURFVjEpMCcGA1UEAxMgTmV0Rm91bmRyeSwg\nSW5jLiBJbnRlcm1lZGlhdGUgQ0EwHhcNMjEwMTE1MjEwMDU3WhcNMjIwMTE1MjEw\nMTU3WjBcMQswCQYDVQQGEwJVUzESMBAGA1UEBxMJQ2hhcmxvdHRlMRMwEQYDVQQK\nEwpOZXRGb3VuZHJ5MRAwDgYDVQQLEwdBRFYtREVWMRIwEAYDVQQDEwlrWHdMajA0\nWFQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDJDRmC32XN31LU04Q4\nuh2uco+78sxCg8BzBbxQ7LrXRqdnfeuskoOx+b8OcA9Af4U9Co8rqrPaUR3y1bME\n5fIhZTFjesV3Z+V+dRyLlQQ6/tXybBwYeBUUwE/NSECx5jKXbLX3WgLISffxFToB\n5FVhX2okCkOPOOXiirKwUe9pCfWafnEJAevjH001nEMDh2Ir5Yny6PrU3SgRj9F1\n+aZ3kuattq89JybUofN1HHTGPOAUUzXIudhhFQC2HYGABGbxvoWBSFmM6i+oWHS9\nGOX5YnfApcbRDEiWHnGfQEPCOG3sRcA/NfPwV9wChyPMadgXNl+Pc9aFEOj20qmk\n/LK5AgMBAAGjYDBeMA4GA1UdDwEB/wQEAwIF4DAMBgNVHRMBAf8EAjAAMB0GA1Ud\nDgQWBBRERYGCL0A1YBMCUbxwz4sAk6cfkTAfBgNVHSMEGDAWgBTFYtjJ5IqMPUdx\n6X0KdeZqZratzzANBgkqhkiG9w0BAQsFAAOCAgEAekd7/VB1nWpLa/2iu7xz8C0M\nPnkczH4qvWSgoJ7tJ+bXqT4+CL3T4jk7kRFxAj6YXDaTyrhzlwtNxmmH0fcJ0NNX\nF+86pAAJWbjzgpy20YOy++R4FgJM0Mai6FRDeec94BdFV90ZDxfQ7UJtV3DXtzZA\nVZGUMo/hsPWi0g2LzJxj2jScugjHBl5rbdc8eQdenAg4Es47dac7sF4XBLocYZey\nei4LxaAgVW+R8RmU+VrJv8HcTiRaweo5/47DxYTCg69LvKThf/ow2nS+BW1bHEyD\n7EI++UuBk/qwoSEtjpMaXlPzN4hMk/Ht7JeifYvWloz2VgJQm8C7O4jplUcVmHkL\n2OgpGhXiEidA5w1xBInuohQQIK+jSFh7sxG/Ck0EVNIE9BfOc6hhM6emL0xFDoNd\nSXEGLs4Fm4IaazJJxREJZoB2Cb5c7MKvO6EMF08xG2JNf2P9QiQu6nWZFmyh3wUK\nY6/LW6YlOhPAmbQ/gu0q+0UuzgnJU61vrIedekDK8q4ePvFZDEsXKg+gA14d5eGh\n4dRrOqvUZtyE8r6g8vUveQsOpjt7BML6p7kSXW6OGe2K5FrnF2vhJSbHd/zb+VFh\nm355ssqubCpNpfnrHGoquQVbXJ3HyFEQ0i+BugEUDDE2lIofz/qlq9x+vtb13CMI\ny1w5WLo3pCVTsufnZmo=\n-----END CERTIFICATE-----","endpointAttributes":["#secureclients"]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2701

{
  "id" : "78092841-d65c-437e-8e60-ba50bac48c6b",
  "ownerIdentityId" : "ef75511d-e1de-4744-9fea-986a89bfc18a",
  "createdBy" : "ef75511d-e1de-4744-9fea-986a89bfc18a",
  "createdAt" : "2021-07-26T20:06:16.205221Z",
  "updatedAt" : "2021-07-26T20:06:16.207113Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "0599e8e4-54f8-4a11-bb29-09958f854ab0",
  "zitiId" : "c06cf4da-d4dc-4685-bf9a-6674e415ae2a",
  "name" : "Test ca 02",
  "endpointAttributes" : [ "#secureclients" ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "-----BEGIN CERTIFICATE-----MIIEujCCAqKgAwIBAgIRAL9YVv7hhgdfje0+onHqzogwDQYJKoZIhvcNAQELBQAwczELMAkGA1UEBhMCVVMxEjAQBgNVBAcTCUNoYXJsb3R0ZTETMBEGA1UEChMKTmV0Rm91bmRyeTEQMA4GA1UECxMHQURWLURFVjEpMCcGA1UEAxMgTmV0Rm91bmRyeSwgSW5jLiBJbnRlcm1lZGlhdGUgQ0EwHhcNMjEwMTE1MjEwMDU3WhcNMjIwMTE1MjEwMTU3WjBcMQswCQYDVQQGEwJVUzESMBAGA1UEBxMJQ2hhcmxvdHRlMRMwEQYDVQQKEwpOZXRGb3VuZHJ5MRAwDgYDVQQLEwdBRFYtREVWMRIwEAYDVQQDEwlrWHdMajA0WFQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDJDRmC32XN31LU04Q4uh2uco+78sxCg8BzBbxQ7LrXRqdnfeuskoOx+b8OcA9Af4U9Co8rqrPaUR3y1bME5fIhZTFjesV3Z+V+dRyLlQQ6/tXybBwYeBUUwE/NSECx5jKXbLX3WgLISffxFToB5FVhX2okCkOPOOXiirKwUe9pCfWafnEJAevjH001nEMDh2Ir5Yny6PrU3SgRj9F1+aZ3kuattq89JybUofN1HHTGPOAUUzXIudhhFQC2HYGABGbxvoWBSFmM6i+oWHS9GOX5YnfApcbRDEiWHnGfQEPCOG3sRcA/NfPwV9wChyPMadgXNl+Pc9aFEOj20qmk/LK5AgMBAAGjYDBeMA4GA1UdDwEB/wQEAwIF4DAMBgNVHRMBAf8EAjAAMB0GA1UdDgQWBBRERYGCL0A1YBMCUbxwz4sAk6cfkTAfBgNVHSMEGDAWgBTFYtjJ5IqMPUdx6X0KdeZqZratzzANBgkqhkiG9w0BAQsFAAOCAgEAekd7/VB1nWpLa/2iu7xz8C0MPnkczH4qvWSgoJ7tJ+bXqT4+CL3T4jk7kRFxAj6YXDaTyrhzlwtNxmmH0fcJ0NNXF+86pAAJWbjzgpy20YOy++R4FgJM0Mai6FRDeec94BdFV90ZDxfQ7UJtV3DXtzZAVZGUMo/hsPWi0g2LzJxj2jScugjHBl5rbdc8eQdenAg4Es47dac7sF4XBLocYZeyei4LxaAgVW+R8RmU+VrJv8HcTiRaweo5/47DxYTCg69LvKThf/ow2nS+BW1bHEyD7EI++UuBk/qwoSEtjpMaXlPzN4hMk/Ht7JeifYvWloz2VgJQm8C7O4jplUcVmHkL2OgpGhXiEidA5w1xBInuohQQIK+jSFh7sxG/Ck0EVNIE9BfOc6hhM6emL0xFDoNdSXEGLs4Fm4IaazJJxREJZoB2Cb5c7MKvO6EMF08xG2JNf2P9QiQu6nWZFmyh3wUKY6/LW6YlOhPAmbQ/gu0q+0UuzgnJU61vrIedekDK8q4ePvFZDEsXKg+gA14d5eGh4dRrOqvUZtyE8r6g8vUveQsOpjt7BML6p7kSXW6OGe2K5FrnF2vhJSbHd/zb+VFhm355ssqubCpNpfnrHGoquQVbXJ3HyFEQ0i+BugEUDDE2lIofz/qlq9x+vtb13CMIy1w5WLo3pCVTsufnZmo=-----END CERTIFICATE-----",
  "verified" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0599e8e4-54f8-4a11-bb29-09958f854ab0",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/78092841-d65c-437e-8e60-ba50bac48c6b"
    }
  }
}

Verify Certificate Authority

POST /certificate-authorities/{id}/verify

Authorization

This endpoint requires update action on the certificate-authority resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/1e9ea794-8c9a-457c-947d-0784b970a247/verify' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyelJHdl9hd3d1YWNvbnZpR1JMVnd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJhNzUxZmE0LWM4MDgtNDNiOS1iMzBkLTNlNmQ4ZmViNDYxOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk3NiwiZXhwIjoxNjI3MzMzNTc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImExZDQ3MjE3LTYxZjEtNGU0Ny1iMzZiLTJlM2I4YmEwMTI3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.AOgOPd29MN-nIwv66RpBfoj3Bv_Gfn-zMbUSKfeipO0Lb7RuBWvYiQr7Nq5iKCaxbw2ekpxv6t050lDEbYFf-EYdR_9EwtukqxWQlF2MyxCGqAtT3YcY6BXYoc_aaLkeXNNPUXKqr0qYR2oQT6nHZTB6cjBz6vWb6ky2pKsuh5WW0IaGlSqW3MWm7tIUyVTYwkIrhU9Idmo9qG4HxaICZNJHnYOCh8dkA_OP9cV3MeBKkgME5XEPG8cwD8yQCAcJ80EQke8A3GtfqzlW8YTzjKCk7Wko3clRIQPdBy2zMZHRy5DSg2wMrReKBe0mhJtAnJNI7izT78TldSW2hkPG4w' \
    -d '<testcertverificationbody>'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 976

{
  "id" : "1e9ea794-8c9a-457c-947d-0784b970a247",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-07-26T20:06:16.290590Z",
  "updatedAt" : "2021-07-26T20:06:16.290590Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "e8966e2c-3991-46d6-87e6-aeb5641429ed",
  "zitiId" : "22cb98b7-ffd1-4e6b-ade6-0e402860273c",
  "name" : "ACME CA 2021-07-26T20:06:16.290478Z",
  "endpointAttributes" : [ ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "fakePem",
  "verified" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e8966e2c-3991-46d6-87e6-aeb5641429ed",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/1e9ea794-8c9a-457c-947d-0784b970a247"
    }
  }
}

Patch Certificate Authority

PATCH /certificate-authorities/{id}

Authorization

This endpoint requires update action on the certificate-authority resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

io.netfoundry.common.util.validation.ValidAs.

autoCaEnrollmentEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

authEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

ottCaEnrollmentEnabled

Boolean

true

io.netfoundry.common.util.validation.ValidAs.

endpointAttributes

Array[String]

true

io.netfoundry.common.util.validation.ValidAs.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

Hypermedia links

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b838c1f4-5847-42a3-a1e7-63352c24744b' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJpVnlpa3BtRE92a3hqQ0hTOHRIcE9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjljYjEzMDhlLTNjZTQtNGViMi04MGM0LTUzZmQ5NTE0MGI4NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk3NiwiZXhwIjoxNjI3MzMzNTc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImJhMGM0M2ExLTYwNjYtNDE1Yy1hNmVlLWFjOTI0YzY5MjdhY1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.cnMmvlACA0PhLZwlvjeXl5VTLXZuuhgQcVwUC5SGDkgB3dKZud80Tax5MuUAZ-P4tCJfq8xiJ_9Vm3bFwtCj7XNCwkzPlrKczg33kNj8jKW0xPurV3shHHJd_DqlobQ0XNuFk0DNZde7JFSu2h7fLd-ZEteTIRIF0qvW1NAvx-ExNAAc6cmA4Qu5-YjkIYemMw-Qab9G6nNBJqxg7gGR3gTQ1nNom-Oy7yrY4TK6mS4ofbPWO3dicINxUaTXibAhM2EPPL7eTEHBArn2HRrGGZZU5qSEpihHsuxNA2_Gmwy7sDlxpm8Y8pZFyqhO_5F6eMWFX_dV18wsFpyPG-B8Vw' \
    -d '{"name":"Test ca 02 updated","endpointAttributes":[]}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 976

{
  "id" : "b838c1f4-5847-42a3-a1e7-63352c24744b",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-07-26T20:06:16.243213Z",
  "updatedAt" : "2021-07-26T20:06:16.243213Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "b5a6f4d3-b33a-4b17-995d-4a361d94cf6e",
  "zitiId" : "065f8ceb-0b6b-4045-9b97-5ac2e421cd93",
  "name" : "ACME CA 2021-07-26T20:06:16.243101Z",
  "endpointAttributes" : [ ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "fakePem",
  "verified" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b5a6f4d3-b33a-4b17-995d-4a361d94cf6e",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b838c1f4-5847-42a3-a1e7-63352c24744b"
    }
  }
}

Delete Certificate Authority

DELETE /certificate-authorities/{id}

Authorization

This endpoint requires delete action on the certificate-authority resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/8e4ace19-caa7-4e3b-9ee0-a5000b6f8031' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJNRWozUTVabGU3S2dBdEpJcnVVVVBRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkwYzM1ZDMwLTFlOWMtNGExMi1iNjdkLTg0ZWVjNDIzMTE3ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyNzMyOTk3NiwiZXhwIjoxNjI3MzMzNTc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjIzNGY0MjgxLTVlY2UtNGJiMi04NTE1LTZiY2QzM2Y3OGM2OFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyNzMyOTk3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.mxCmesEvA6IKwNXd0vUkGJZD7OlGAhv7WjiMLLhIdTbM1rqAKVdvrvNX8VMXFFWjAKBonog1R48-Hj6MwmLabqMSgi4a5pWl9D4BPvUF5XM7keq1vjyMAlpBeaJSA7mRrYhVIhkDbxGi-KXKSkTs2i9jJ0S0_ED8ogRtTKvkEybFMoaMfPK4B_e1pTy-KVeuao3CQp0YWvQx6b_jURjyS6bBiIBuZfy03Ic0U9DrYzZi_v43Fo1RdclLMGFfyaKARcu3Tuzm9Q7hoEPDWznVjuaVxJ4_dgLWB-PeCMz_nFKmCgCz3oB4bclXTlHVwdrz8T-3i-hkhcR1WndtfEgQnA'

Example response

HTTP/1.1 200 OK

Service Edge Router Policies

Find Service Edge Router Policies

GET /service-edge-router-policies

Authorization

This endpoint requires read action on the service-edge-router-policy resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

semantic

Object

true

Must be one of [AllOf, AnyOf].

ownerIdentityId

Object

true

createdBy

Object

true

deletedBy

Object

true

attributeType

String

true

Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy].

attribute

Object

true

createdAt

Object

true

updatedAt

Object

true

deletedAt

Object

true

Request fields

No request body.

Response fields

Standard paging response where content field is list of following objects:

Path Type Optional Description

id

String

false

networkId

String

false

zitiId

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

semantic

String

false

Must be one of [AllOf, AnyOf].

ownerIdentityId

String

false

createdBy

String

false

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String