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

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

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

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.

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	Properties that should be sorted by in the format `property,property(,ASC\|DESC)`. Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. `?sort=firstname&sort=lastname,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.

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].

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].

Path

Type

Optional

Description

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.

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].

Path

Type

Optional

Description

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.eyJqdGkiOiJrTWs1d2FUTjI4bU1hS05wbGh3V0R3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU2OGM2MjZjLTFiODktNDI1NS1hYTdiLTJlZDJhZjI2ZjBmNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE1NSwiZXhwIjoxNjIwMTUxNzU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRjYTViMjlmLTRjMWYtNDhhNC1hYWRhLWJlMTYyYmZhZTQwMVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE1NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.XZiBxnUCD7N_4__jJ6mjvjshPuiRCxcKzK3Lst0rwPHDajWqjiPhVmdPEnYtTHSr10cDxSjZMzoa512PlOPSA9aujCFKPpLGDQao5bnLGK0g1UJgjCQ6IFdrT_OeYHj1OW6maLn0-I6NEe6CYxB3XAepcqA-HFKJ5KAZWRdMCkmoFOl4zWNmD3xpP116WyAtHk75Z1v2bUyZ6wKhXNYhGVTjQRzm2uCS2AF8gvkmEBuyxxbwjpO5L-bysD97wjdbahBzeG6h806_y_z9ZnfDTdVQQF4YHqgMpG8ftsRqe2IDYsL_ebcYjEzU5VF2RxobZj6gSoE7CPpJ54x_GkPxjg'

Example response

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

{
  "_embedded" : {
    "dataCenters" : [ {
      "id" : "1488d6e7-c38c-49ee-a892-b9913d2515ba",
      "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/1488d6e7-c38c-49ee-a892-b9913d2515ba"
        }
      }
    } ]
  },
  "_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

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
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

Path

Type

Optional

Description

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.

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].

Path

Type

Optional

Description

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.eyJqdGkiOiJ5OTlRR0drSHI1eVN4VFN3dzBUUEF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU3OTMyYjJlLTJlOGMtNDhjZS1iN2RjLWQ3ODZjNWZlNzcxNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE1NSwiZXhwIjoxNjIwMTUxNzU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjljYWM3YWFiLTk3M2UtNDliYS04MGY1LWE2N2UwNzA2MzY4NFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE1NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.qNfx5Gs_Kpo46QDHFgCNiFBDFSUeijylpGMFS6DVvWR9Rs4eKlKr7EOGAAGqPnuv5ysMX-wNe_YM6qenKtAH4UltgIpsgGW7AZs9cWGeadrTfm1O06pvcGdT_btuJARDPRb4f3vDF29oqfgeZpbgto-qG74frsOa5OsMK6d_shln7RQdqde6HaY0vXplYjFMjxZb_9hM_kEjFJtKvuEZUZgbeFMdRK5OEwnfOm9N8hSmc4PW1X9ni_jvJ3qFkSRICpS06D8GU1wC1XEcM4YEvi-dyRZUPbDw4yY0mfiOfVLaswkPwpT-W-0KMQ6NBCzfDhuN3WOMkVLzrO1PVNmmkA'

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

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	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	io.netfoundry.core.validation.ResourceSecret.
networkController.zitiPassword	String	true	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
networkController.provider	String	true
networkController.ipAddress	String	true
networkController.providerId	String	true
networkController.dataCenterId	String	true
networkController.userData	String	true
networkController.locationMetadataId	String	true
networkController.port	Integer	true

Path

Type

Optional

Description

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

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

io.netfoundry.core.validation.ResourceSecret.

networkController.zitiPassword

String

true

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

networkController.provider

String

true

networkController.ipAddress

String

true

networkController.providerId

String

true

networkController.dataCenterId

String

true

networkController.userData

String

true

networkController.locationMetadataId

String

true

networkController.port

Integer

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.

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	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	io.netfoundry.core.validation.ResourceSecret.
networkController.zitiPassword	String	true	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
networkController.provider	String	true
networkController.ipAddress	String	true
networkController.providerId	String	true
networkController.dataCenterId	String	true
networkController.userData	String	true
networkController.locationMetadataId	String	true
networkController.port	Integer	true

Path

Type

Optional

Description

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

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

io.netfoundry.core.validation.ResourceSecret.

networkController.zitiPassword

String

true

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

networkController.provider

String

true

networkController.ipAddress

String

true

networkController.providerId

String

true

networkController.dataCenterId

String

true

networkController.userData

String

true

networkController.locationMetadataId

String

true

networkController.port

Integer

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.eyJqdGkiOiI4a053YXF4TU96azRsR21MbXRvODZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgzNWU4NjdiLWViNWItNGNiNS05NTYzLWYzZWI3M2Y5Mzg2MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA4MywiZXhwIjoxNjIwMTUxNjgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU5MzliYTUxLTlkMTItNDk2Yy04YWViLTIxNmNmOGZkMDc3Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.mPvBS2YETdIlFfKV6_-cdabblfqMfwh5MxruPBAJdnr2VDz838KVoFB7ocs3ggHlfrk9skKu9npUhNFPzVrqbUsb_Ybxwtn5tZMRHVuUfTxrjgRHogt53kGIR5hkCQy-x4RRmoXDSG950SuFcaigXrxhM2Rf8WjZT1l7PDJ2-spx3xNnXylA8jttRhIBGDWMTWQk60D-ZLK-pa4Y0851G2wTnQjet66fxYdkntu6DSDEXp8K1jn4YeC1w1FbVQzeUjZKuIrP60vw3hD63jsN3L7B1rebshJ4UbjTcp2Fmgh-awzYsdqBopwdk8B_PBGpKU_Pv833iK1netRqBNc94w'

Example response

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

{
  "_embedded" : {
    "networkList" : [ {
      "id" : "0c0f6525-ba90-47ea-bd89-d8057ffab5a8",
      "ownerIdentityId" : "39a42977-cf6f-4c74-9a47-0385ac1c0571",
      "createdBy" : "39a42977-cf6f-4c74-9a47-0385ac1c0571",
      "createdAt" : "2021-05-04T17:08:03.031906Z",
      "updatedAt" : "2021-05-04T17:08:03.031906Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-05-04T17:08:03.031744Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "c3e99b69-228a-4d2f-b00f-6b4a921d5fc4",
        "ownerIdentityId" : null,
        "networkId" : "0c0f6525-ba90-47ea-bd89-d8057ffab5a8",
        "domainName" : null,
        "name" : "ncb41d467c-fd9d-4644-a221-8c537139f67a",
        "hostId" : "e872c666-5839-434c-bd1f-d9745a6df375",
        "status" : "PROVISIONING",
        "createdAt" : "2021-05-04T17:08:03.033904Z",
        "updatedAt" : "2021-05-04T17:08:03.033904Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "10.20.30.40",
        "providerId" : "i-fd1239sdv",
        "dataCenterId" : "718d905a-238a-4fb5-8f8b-3d5df72e664a",
        "userData" : null,
        "locationMetadataId" : "d6ced489-bd09-4d03-bf7b-4ec2076255cf",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=0c0f6525-ba90-47ea-bd89-d8057ffab5a8"
        }
      }
    }, {
      "id" : "134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e",
      "ownerIdentityId" : "39a42977-cf6f-4c74-9a47-0385ac1c0571",
      "createdBy" : "39a42977-cf6f-4c74-9a47-0385ac1c0571",
      "createdAt" : "2021-05-04T17:08:03.030836Z",
      "updatedAt" : "2021-05-04T17:08:03.031428Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-05-04T17:08:03.030519Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.2.1",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "8559f30f-d752-4442-94ed-e363a4e43ec8",
        "ownerIdentityId" : null,
        "networkId" : "134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e",
        "domainName" : null,
        "name" : "nc6c6e2d5f-dcbe-4b44-9b22-69b5a928ae8a",
        "hostId" : "c22694f8-f0a9-47b6-924d-b0ebf00528e6",
        "status" : "PROVISIONED",
        "createdAt" : "2021-05-04T17:08:03.033340Z",
        "updatedAt" : "2021-05-04T17:08:03.033340Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "1.2.3.4",
        "providerId" : "i-9sdv23h90",
        "dataCenterId" : "76b5a77e-a529-4645-803a-a4de32b47433",
        "userData" : null,
        "locationMetadataId" : "49d14ed4-188a-41e0-96e6-774f6a65b990",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=134b9b76-c3f5-4c8b-a9e5-d8a0678ab98e"
        }
      }
    }, {
      "id" : "1d6a0e48-cf1b-4490-be13-5a1ee7ecd089",
      "ownerIdentityId" : "e7e80e0a-443f-4eca-868e-240532fa5bac",
      "createdBy" : "e7e80e0a-443f-4eca-868e-240532fa5bac",
      "createdAt" : "2021-05-04T17:08:02.945010Z",
      "updatedAt" : "2021-05-04T17:08:02.945617Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-05-04T17:08:02.944708Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.2.1",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "76f1c39e-8a4e-48c5-a1c4-fd1e8ac0c941",
        "ownerIdentityId" : null,
        "networkId" : "1d6a0e48-cf1b-4490-be13-5a1ee7ecd089",
        "domainName" : null,
        "name" : "ncb747abf4-f7ca-4bca-95d6-9aa3f7afa66d",
        "hostId" : "6295598c-fd17-41fe-9e84-a1cc4847596b",
        "status" : "PROVISIONED",
        "createdAt" : "2021-05-04T17:08:02.947478Z",
        "updatedAt" : "2021-05-04T17:08:02.947478Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "1.2.3.4",
        "providerId" : "i-9sdv23h90",
        "dataCenterId" : "759ef0b3-7993-406b-ad8c-708937fd07e0",
        "userData" : null,
        "locationMetadataId" : "06a3e304-c66d-4083-86a8-eeb2c0adec94",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=1d6a0e48-cf1b-4490-be13-5a1ee7ecd089"
        }
      }
    }, {
      "id" : "2679e17d-24c1-466e-a135-15928e005e4f",
      "ownerIdentityId" : "6f2c8229-ac02-4b94-a4ac-47513039fa76",
      "createdBy" : "6f2c8229-ac02-4b94-a4ac-47513039fa76",
      "createdAt" : "2021-05-04T17:08:03.162267Z",
      "updatedAt" : "2021-05-04T17:08:03.162267Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-05-04T17:08:03.162098Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "f6c93ad9-7665-4405-96de-ffd97f9b0f89",
        "ownerIdentityId" : null,
        "networkId" : "2679e17d-24c1-466e-a135-15928e005e4f",
        "domainName" : null,
        "name" : "nc5d244476-c157-44db-b305-c703dc933605",
        "hostId" : "ed5ddbbc-c7d9-4a82-bdc3-60e4657bbc91",
        "status" : "PROVISIONING",
        "createdAt" : "2021-05-04T17:08:03.164264Z",
        "updatedAt" : "2021-05-04T17:08:03.164264Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "10.20.30.40",
        "providerId" : "i-fd1239sdv",
        "dataCenterId" : "14863e6c-fb27-4660-a186-5272c9c28411",
        "userData" : null,
        "locationMetadataId" : "12309f99-27b6-40e6-86e3-3441c09001eb",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=2679e17d-24c1-466e-a135-15928e005e4f"
        }
      }
    }, {
      "id" : "2cb03f46-812c-441c-924f-e8c9b9b69ffa",
      "ownerIdentityId" : "80bed8a0-9b11-43a8-bd31-fedb6cda420f",
      "createdBy" : "80bed8a0-9b11-43a8-bd31-fedb6cda420f",
      "createdAt" : "2021-05-04T17:08:02.557049Z",
      "updatedAt" : "2021-05-04T17:08:02.557049Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-05-04T17:08:02.556874Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "a9b26b61-fcd2-4540-9b4e-3deb3e7a124c",
        "ownerIdentityId" : null,
        "networkId" : "2cb03f46-812c-441c-924f-e8c9b9b69ffa",
        "domainName" : null,
        "name" : "nc3b3fa092-9f2a-4950-83c3-aa794eabf90c",
        "hostId" : "e8531a13-de1a-445d-a80c-5e59075ac689",
        "status" : "PROVISIONING",
        "createdAt" : "2021-05-04T17:08:02.559424Z",
        "updatedAt" : "2021-05-04T17:08:02.559424Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "10.20.30.40",
        "providerId" : "i-fd1239sdv",
        "dataCenterId" : "d398b9ec-471e-48c4-895c-9120cf005905",
        "userData" : null,
        "locationMetadataId" : "8d871789-4885-48a7-aaac-51de77b19a27",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=2cb03f46-812c-441c-924f-e8c9b9b69ffa"
        }
      }
    }, {
      "id" : "3595aafd-27de-4394-b7be-4823a5a4c66c",
      "ownerIdentityId" : "6f2c8229-ac02-4b94-a4ac-47513039fa76",
      "createdBy" : "6f2c8229-ac02-4b94-a4ac-47513039fa76",
      "createdAt" : "2021-05-04T17:08:03.162681Z",
      "updatedAt" : "2021-05-04T17:08:03.163038Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-05-04T17:08:03.162532Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "networkController" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=3595aafd-27de-4394-b7be-4823a5a4c66c"
        }
      }
    }, {
      "id" : "4ebbe7da-271c-49e8-bea4-7944856a8511",
      "ownerIdentityId" : "80bed8a0-9b11-43a8-bd31-fedb6cda420f",
      "createdBy" : "80bed8a0-9b11-43a8-bd31-fedb6cda420f",
      "createdAt" : "2021-05-04T17:08:02.557488Z",
      "updatedAt" : "2021-05-04T17:08:02.557847Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-05-04T17:08:02.557334Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "networkController" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=4ebbe7da-271c-49e8-bea4-7944856a8511"
        }
      }
    }, {
      "id" : "762c434d-c91b-436d-854d-b3768d183824",
      "ownerIdentityId" : "244e23d5-dfd3-4de3-bec2-05b9537bc82e",
      "createdBy" : "244e23d5-dfd3-4de3-bec2-05b9537bc82e",
      "createdAt" : "2021-05-04T17:08:02.981133Z",
      "updatedAt" : "2021-05-04T17:08:02.981760Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-05-04T17:08:02.980791Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.2.1",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "22016200-f5dd-4dca-93fd-df3af1b82a35",
        "ownerIdentityId" : null,
        "networkId" : "762c434d-c91b-436d-854d-b3768d183824",
        "domainName" : null,
        "name" : "nc7d257eae-3a26-499d-ac0b-bb44ad318e12",
        "hostId" : "0da959cb-ce1c-4a69-b53c-5dabbe6540e9",
        "status" : "PROVISIONED",
        "createdAt" : "2021-05-04T17:08:02.983735Z",
        "updatedAt" : "2021-05-04T17:08:02.983735Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "1.2.3.4",
        "providerId" : "i-9sdv23h90",
        "dataCenterId" : "04585928-071b-4b56-8d68-5fde522dd703",
        "userData" : null,
        "locationMetadataId" : "b4a8a109-bfe7-4ca1-9f22-195a4a558bb6",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/762c434d-c91b-436d-854d-b3768d183824"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=762c434d-c91b-436d-854d-b3768d183824"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=762c434d-c91b-436d-854d-b3768d183824"
        }
      }
    }, {
      "id" : "76cb73f0-ced6-4a34-a3e0-8257657b5eea",
      "ownerIdentityId" : "244e23d5-dfd3-4de3-bec2-05b9537bc82e",
      "createdBy" : "244e23d5-dfd3-4de3-bec2-05b9537bc82e",
      "createdAt" : "2021-05-04T17:08:02.982686Z",
      "updatedAt" : "2021-05-04T17:08:02.983080Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-05-04T17:08:02.982530Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "networkController" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=76cb73f0-ced6-4a34-a3e0-8257657b5eea"
        }
      }
    }, {
      "id" : "8b3bae5f-24c6-43d4-a035-acfac087e1f1",
      "ownerIdentityId" : "39a42977-cf6f-4c74-9a47-0385ac1c0571",
      "createdBy" : "39a42977-cf6f-4c74-9a47-0385ac1c0571",
      "createdAt" : "2021-05-04T17:08:03.032313Z",
      "updatedAt" : "2021-05-04T17:08:03.032700Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-05-04T17:08:03.032163Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "networkController" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=8b3bae5f-24c6-43d4-a035-acfac087e1f1"
        }
      }
    }, {
      "id" : "9e86948b-3951-469e-a06b-bd4150c52bc6",
      "ownerIdentityId" : "e7e80e0a-443f-4eca-868e-240532fa5bac",
      "createdBy" : "e7e80e0a-443f-4eca-868e-240532fa5bac",
      "createdAt" : "2021-05-04T17:08:02.946483Z",
      "updatedAt" : "2021-05-04T17:08:02.946844Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-05-04T17:08:02.946326Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "networkController" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=9e86948b-3951-469e-a06b-bd4150c52bc6"
        }
      }
    }, {
      "id" : "a996aa00-bdd1-4385-baae-e7e0171ef8ec",
      "ownerIdentityId" : "e7e80e0a-443f-4eca-868e-240532fa5bac",
      "createdBy" : "e7e80e0a-443f-4eca-868e-240532fa5bac",
      "createdAt" : "2021-05-04T17:08:02.946075Z",
      "updatedAt" : "2021-05-04T17:08:02.946075Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-05-04T17:08:02.945910Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "79fe6419-a8b9-419e-8259-43786597c3fd",
        "ownerIdentityId" : null,
        "networkId" : "a996aa00-bdd1-4385-baae-e7e0171ef8ec",
        "domainName" : null,
        "name" : "ncfd825b19-4f90-4c16-a564-9111f2bbfe46",
        "hostId" : "8cfa041b-d71c-437f-90a9-ef9b10ab4e6d",
        "status" : "PROVISIONING",
        "createdAt" : "2021-05-04T17:08:02.948032Z",
        "updatedAt" : "2021-05-04T17:08:02.948032Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "10.20.30.40",
        "providerId" : "i-fd1239sdv",
        "dataCenterId" : "2ba56215-e5a6-4dae-934f-0c0d671de184",
        "userData" : null,
        "locationMetadataId" : "aea483e7-d33c-4c41-a36c-65c122aa4876",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=a996aa00-bdd1-4385-baae-e7e0171ef8ec"
        }
      }
    }, {
      "id" : "ac57f9c5-d3fa-4b80-a194-ed6911b182ef",
      "ownerIdentityId" : "74373e58-2620-4346-bbb2-342b8976d0e0",
      "createdBy" : "74373e58-2620-4346-bbb2-342b8976d0e0",
      "createdAt" : "2021-05-04T17:08:03.063415Z",
      "updatedAt" : "2021-05-04T17:08:03.091668Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Upload Test Network",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.1.0-59578434",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "494d9eea-7cc3-467d-8774-056108675f95",
        "ownerIdentityId" : null,
        "networkId" : "ac57f9c5-d3fa-4b80-a194-ed6911b182ef",
        "domainName" : "f7e2af59-8570-406a-a5f9-2a9e5f0318ce.sandbox.netfoundry.io",
        "name" : "NCAWSi-testncinstance",
        "hostId" : "75d274b7-d710-4bd4-84b8-b01f26c940a3",
        "status" : "PROVISIONED",
        "createdAt" : "2021-05-04T17:08:03.079791Z",
        "updatedAt" : "2021-05-04T17:08:03.086830Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "1.2.3.4",
        "providerId" : "i-testncinstance",
        "dataCenterId" : "c7b4f3e1-79ae-436f-8c99-11ee247300e5",
        "userData" : null,
        "locationMetadataId" : "0e660fff-72ad-4b6d-850c-9960a25ea2ca",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=ac57f9c5-d3fa-4b80-a194-ed6911b182ef"
        }
      }
    }, {
      "id" : "bd6032bd-76e4-4efa-9e97-e24ad988a57f",
      "ownerIdentityId" : "244e23d5-dfd3-4de3-bec2-05b9537bc82e",
      "createdBy" : "244e23d5-dfd3-4de3-bec2-05b9537bc82e",
      "createdAt" : "2021-05-04T17:08:02.982265Z",
      "updatedAt" : "2021-05-04T17:08:02.982265Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-05-04T17:08:02.982074Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "2a74338b-2407-4197-991a-dbdcdebd835e",
        "ownerIdentityId" : null,
        "networkId" : "bd6032bd-76e4-4efa-9e97-e24ad988a57f",
        "domainName" : null,
        "name" : "nce30c7d39-9c50-4021-8027-9abb6ff8e442",
        "hostId" : "d125adfd-afb6-4482-9fe2-ca2f0f40bbf5",
        "status" : "PROVISIONING",
        "createdAt" : "2021-05-04T17:08:02.984306Z",
        "updatedAt" : "2021-05-04T17:08:02.984306Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "10.20.30.40",
        "providerId" : "i-fd1239sdv",
        "dataCenterId" : "5bf26956-07a7-420c-b969-2db0aa6acb72",
        "userData" : null,
        "locationMetadataId" : "c51b5da0-e179-49c1-956b-1f1de010935e",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=bd6032bd-76e4-4efa-9e97-e24ad988a57f"
        }
      }
    }, {
      "id" : "c65e6012-2e95-4e01-a412-b23c4e9dc14b",
      "ownerIdentityId" : "80bed8a0-9b11-43a8-bd31-fedb6cda420f",
      "createdBy" : "80bed8a0-9b11-43a8-bd31-fedb6cda420f",
      "createdAt" : "2021-05-04T17:08:02.555542Z",
      "updatedAt" : "2021-05-04T17:08:02.556522Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-05-04T17:08:02.554791Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.2.1",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "8d9d2385-96e6-42f5-a012-8d82de0ace70",
        "ownerIdentityId" : null,
        "networkId" : "c65e6012-2e95-4e01-a412-b23c4e9dc14b",
        "domainName" : null,
        "name" : "nc5579f9c3-45d4-42ad-ab77-162a3ec238fd",
        "hostId" : "04f30d1c-18b3-4eed-b330-ec1b8ff502f2",
        "status" : "PROVISIONED",
        "createdAt" : "2021-05-04T17:08:02.558700Z",
        "updatedAt" : "2021-05-04T17:08:02.558700Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "1.2.3.4",
        "providerId" : "i-9sdv23h90",
        "dataCenterId" : "15a3b332-914d-4d9a-8cec-b10757ca1c8c",
        "userData" : null,
        "locationMetadataId" : "089b306c-116b-4b75-88e0-79e1505139b7",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=c65e6012-2e95-4e01-a412-b23c4e9dc14b"
        }
      }
    }, {
      "id" : "d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441",
      "ownerIdentityId" : "ff69e683-b1a7-42b1-8ec8-923d7bcceef9",
      "createdBy" : "ff69e683-b1a7-42b1-8ec8-923d7bcceef9",
      "createdAt" : "2021-05-04T17:08:02.785809Z",
      "updatedAt" : "2021-05-04T17:08:02.842628Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Test Network Yaml",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.1.0-59578434",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "ce8c4559-6666-43a5-a9d2-edaa48474281",
        "ownerIdentityId" : null,
        "networkId" : "d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441",
        "domainName" : "d505b856-33b0-402b-97f0-3553ad23d183.sandbox.netfoundry.io",
        "name" : "NCAWSi-testncinstance",
        "hostId" : "e389d74d-80d8-489a-be82-7ceecef7afd5",
        "status" : "PROVISIONED",
        "createdAt" : "2021-05-04T17:08:02.828269Z",
        "updatedAt" : "2021-05-04T17:08:02.836387Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "1.2.3.4",
        "providerId" : "i-testncinstance",
        "dataCenterId" : "9698719d-3eef-4781-9be6-cf582baeb432",
        "userData" : null,
        "locationMetadataId" : "97c4e47e-83e6-4f4a-9f2a-f59a7b9e03d2",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=d13bdbb0-ff8d-4c5b-a3d0-4b81ee2bd441"
        }
      }
    }, {
      "id" : "f16e3f44-6e18-47d0-8d5f-efe2d386b8a0",
      "ownerIdentityId" : "6f2c8229-ac02-4b94-a4ac-47513039fa76",
      "createdBy" : "6f2c8229-ac02-4b94-a4ac-47513039fa76",
      "createdAt" : "2021-05-04T17:08:03.161216Z",
      "updatedAt" : "2021-05-04T17:08:03.161806Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-05-04T17:08:03.160911Z",
      "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
      "size" : "small",
      "productVersion" : "7.2.1",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "9469a1e1-8c26-4157-804e-8cc0d740328d",
        "ownerIdentityId" : null,
        "networkId" : "f16e3f44-6e18-47d0-8d5f-efe2d386b8a0",
        "domainName" : null,
        "name" : "nc1f14afe3-77a0-4804-bc11-e4cda9539028",
        "hostId" : "89106d05-8f77-4a0a-8176-1e695150ccd6",
        "status" : "PROVISIONED",
        "createdAt" : "2021-05-04T17:08:03.163687Z",
        "updatedAt" : "2021-05-04T17:08:03.163687Z",
        "deletedAt" : null,
        "deletedBy" : null,
        "provider" : "AWS",
        "ipAddress" : "1.2.3.4",
        "providerId" : "i-9sdv23h90",
        "dataCenterId" : "d87fa2c5-bf34-4788-b1eb-7120e6c0fc08",
        "userData" : null,
        "locationMetadataId" : "8c492498-b0cb-4a2a-833b-bc3200dbab39",
        "port" : 443
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=f16e3f44-6e18-47d0-8d5f-efe2d386b8a0"
        }
      }
    } ]
  },
  "_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

Parameter	Type	Optional	Description
id	Object	false	Client must have `read` action on the annotated resource.

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	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	io.netfoundry.core.validation.ResourceSecret.
networkController.zitiPassword	String	true	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
networkController.provider	String	true
networkController.ipAddress	String	true
networkController.providerId	String	true
networkController.dataCenterId	String	true
networkController.userData	String	true
networkController.locationMetadataId	String	true
networkController.port	Integer	true

Path

Type

Optional

Description

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

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

io.netfoundry.core.validation.ResourceSecret.

networkController.zitiPassword

String

true

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

networkController.provider

String

true

networkController.ipAddress

String

true

networkController.providerId

String

true

networkController.dataCenterId

String

true

networkController.userData

String

true

networkController.locationMetadataId

String

true

networkController.port

Integer

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.

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/762c434d-c91b-436d-854d-b3768d183824' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJHb01rV1ByRFNXNVBEeDd3Z1g5dTlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhhN2YyYWVkLTNiZWMtNGQzNi05NTVlLTI1ZDBkOGIxYmFhYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA4MiwiZXhwIjoxNjIwMTUxNjgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgzYzU3ODg2LTRhZDktNDBmNi05NDAzLTlkNDhjOTIwNzQxZlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA4Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.bMRszX0nrMUGsJtDhur_b73cvVRl4biZjhg5i3LVQBYnx-jsOWhyGt2-4nmICc_Z-mukbDz9jmUybtDkRY6mE8jYEA9SaiO1HwusNyy0rczRPNvX0vSICaMcJE5CyACJOqVoBwHJCVbMQb0oUD3Hgc_w-w9mWY_Fgmiw0uukRU8g09KYmRlQBJLSzUWkRP0I7FBIZSARgzTAuR3iNalac6ClkiMZA6z4CKoSYrpx-I1dgkCNoYxu4RTlwUjr-RAFBohpVvedKW2tY8lz9JNe6DvryTZn06GSJ1Ypov1muBq-KnvgNttY21S8Tx2phC-gYBLe5U4Ogq4ryBbzAI9r3g'

Example response

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

{
  "id" : "762c434d-c91b-436d-854d-b3768d183824",
  "ownerIdentityId" : "244e23d5-dfd3-4de3-bec2-05b9537bc82e",
  "createdBy" : "244e23d5-dfd3-4de3-bec2-05b9537bc82e",
  "createdAt" : "2021-05-04T17:08:02.981133Z",
  "updatedAt" : "2021-05-04T17:08:02.981760Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "ACME Network2021-05-04T17:08:02.980791Z",
  "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
  "size" : "small",
  "productVersion" : "7.2.1",
  "status" : "PROVISIONED",
  "o365BreakoutCategory" : "NONE",
  "networkController" : {
    "id" : "22016200-f5dd-4dca-93fd-df3af1b82a35",
    "ownerIdentityId" : null,
    "networkId" : "762c434d-c91b-436d-854d-b3768d183824",
    "domainName" : null,
    "name" : "nc7d257eae-3a26-499d-ac0b-bb44ad318e12",
    "hostId" : "0da959cb-ce1c-4a69-b53c-5dabbe6540e9",
    "status" : "PROVISIONED",
    "createdAt" : "2021-05-04T17:08:02.983735Z",
    "updatedAt" : "2021-05-04T17:08:02.983735Z",
    "deletedAt" : null,
    "deletedBy" : null,
    "provider" : "AWS",
    "ipAddress" : "1.2.3.4",
    "providerId" : "i-9sdv23h90",
    "dataCenterId" : "04585928-071b-4b56-8d68-5fde522dd703",
    "userData" : null,
    "locationMetadataId" : "b4a8a109-bfe7-4ca1-9f22-195a4a558bb6",
    "port" : 443
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/762c434d-c91b-436d-854d-b3768d183824"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=762c434d-c91b-436d-854d-b3768d183824"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=762c434d-c91b-436d-854d-b3768d183824"
    }
  }
}

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

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[].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].
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	Client must have `create` action under the annotated resource. io.netfoundry.common.util.validation.ValidAs.
endpoints[].name	String	true	io.netfoundry.common.util.validation.ValidAs.
endpoints[].enrollmentMethod	Object	true
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
appWans	Array[Object]	true
appWans[].networkId	String	true	Client must have `create` action under the annotated resource. io.netfoundry.common.util.validation.ValidAs.
appWans[].name	String	true	io.netfoundry.common.util.validation.ValidAs.
appWans[].endpointAttributes	Array[String]	true	io.netfoundry.common.util.validation.ValidAs.
appWans[].serviceAttributes	Array[String]	true	io.netfoundry.common.util.validation.ValidAs.
appWans[].postureCheckAttributes	Array[String]	true	io.netfoundry.common.util.validation.ValidAs.
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].
postureChecks[].attributes	Array[String]	true	io.netfoundry.common.util.validation.ValidAs.
postureChecks[].data	Object	true	io.netfoundry.common.util.validation.ValidAs.
postureChecks[].data.domains	Array[String]	false
postureChecks[].data.macAddresses	Array[String]	false
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, Android, iOS, Linux, macOS].
postureChecks[].data.process.path	String	false
postureChecks[].data.process.hashes	Array[String]	true
postureChecks[].data.process.signerFingerprint	String	true

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[].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

services[].configs[].configType

Object

true

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].

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

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

endpoints[].name

String

true

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

endpoints[].enrollmentMethod

Object

true

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

appWans

Array[Object]

true

appWans[].networkId

String

true

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

appWans[].name

String

true

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

appWans[].endpointAttributes

Array[String]

true

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

appWans[].serviceAttributes

Array[String]

true

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

appWans[].postureCheckAttributes

Array[String]

true

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

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].

postureChecks[].attributes

Array[String]

true

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

postureChecks[].data

Object

true

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

postureChecks[].data.domains

Array[String]

false

postureChecks[].data.macAddresses

Array[String]

false

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, Android, iOS, Linux, macOS].

postureChecks[].data.process.path

String

false

postureChecks[].data.process.hashes

Array[String]

true

postureChecks[].data.process.signerFingerprint

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.
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	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	io.netfoundry.core.validation.ResourceSecret.
networkController.zitiPassword	String	true	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
networkController.provider	String	true
networkController.ipAddress	String	true
networkController.providerId	String	true
networkController.dataCenterId	String	true
networkController.userData	String	true
networkController.locationMetadataId	String	true
networkController.port	Integer	true

Path

Type

Optional

Description

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

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

io.netfoundry.core.validation.ResourceSecret.

networkController.zitiPassword

String

true

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

networkController.provider

String

true

networkController.ipAddress

String

true

networkController.providerId

String

true

networkController.dataCenterId

String

true

networkController.userData

String

true

networkController.locationMetadataId

String

true

networkController.port

Integer

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.

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.eyJqdGkiOiJheU1neXRVNUFFNmRYQXVxRG4xb1ZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJiMDI5NzYxLTA5N2EtNDczYS04YmUwLTZlNWEwMjZmNzQzNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA4MywiZXhwIjoxNjIwMTUxNjgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA2MTQwMWI2LThhOTAtNDFjOS1iMTk3LTFhYjhlMDZiZTI3ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.D1BV-CVnrG_q3iQUxU8yXVGawrPuI0SlgHS5yx6GihyILDvcUAEwr9IVXQGuENdiXtdsvyeZxriF_yd2oUl2sqVU4QQtYvjXMBLgIhjSfmr9zB67dDW9IFMA9M9QvxrhmNXo1JnahzR8a2UI8b8zjM85SN55bLVx1JfRT3DsDJRRSTBo4oKTT_A9s0d5MWJcks8TkaJF-qaeL3u2RxI_ZXLtcYjs0hVVN2XKLSTEjqYrQfzanU1q4-pnkRxghci5t5EoWrXslF0G9WUi1UFbHGYMPPbcBX9oDP67sINezoxzA9A2dXdLVODgmkj5wp554bUPWovB3bxRvHY_Vdi88Q' \
    -d '{"networkGroupId":"c4a24222-4e03-4ba8-821f-ce15e42cd013","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" : "9589043e-6759-434f-b4d2-ef690870668e",
  "ownerIdentityId" : "2b029761-097a-473a-8be0-6e5a026f7435",
  "createdBy" : "2b029761-097a-473a-8be0-6e5a026f7435",
  "createdAt" : "2021-05-04T17:08:03.334774Z",
  "updatedAt" : "2021-05-04T17:08:03.334774Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Create Test Network",
  "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
  "size" : "small",
  "productVersion" : "7.1.0-59578434",
  "status" : "PROVISIONING",
  "o365BreakoutCategory" : "NONE",
  "networkController" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9589043e-6759-434f-b4d2-ef690870668e"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/91db616d-b7e2-4632-af48-d3a064e674c1",
      "profile" : "meta"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=9589043e-6759-434f-b4d2-ef690870668e"
    }
  }
}

Delete Network

DELETE /networks/{id}

Authorization

This endpoint requires delete action on the network resource type.

Path parameters

Parameter Type Optional Description

Parameter	Type	Optional	Description
id	Object	false	Client must have `delete` action on the annotated resource.

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	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	io.netfoundry.core.validation.ResourceSecret.
networkController.zitiPassword	String	true	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
networkController.provider	String	true
networkController.ipAddress	String	true
networkController.providerId	String	true
networkController.dataCenterId	String	true
networkController.userData	String	true
networkController.locationMetadataId	String	true
networkController.port	Integer	true

Path

Type

Optional

Description

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

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

io.netfoundry.core.validation.ResourceSecret.

networkController.zitiPassword

String

true

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

networkController.provider

String

true

networkController.ipAddress

String

true

networkController.providerId

String

true

networkController.dataCenterId

String

true

networkController.userData

String

true

networkController.locationMetadataId

String

true

networkController.port

Integer

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.

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/42abc436-b3a5-4dad-ab34-ae97fd110d03' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJRLWZFb25DLW0wT3RIeGFmYmtLRmVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQxMTBlOWIwLWFjNDgtNDM1Ni1iMGNhLTBlODZhNDYzZmY5MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA4MywiZXhwIjoxNjIwMTUxNjgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU3OTdiNWExLTRmMjYtNDUxMC1hYjhmLWEwZTA4MTFjNjVlOVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Ni7M1p9y3nWLNARoLHwPMU2mJk7DU-1O3tkpzdRtIDNZQS1o9cor0T4YZ_PSsn2DG2uA8LPLw7OUv4g1yp-vCQr3tmmXnPkNSJBN3DW3zptke1ZSig8e-Vphm66L_cNti-3EIXWHZlxAlvfqQdgfJi2DveKWiVe3_0VYlFEd4WiZcEIPtHvr_5_bnQeGlUdPDEaGvvkbeYOle_fv-86j2zIMVVI6d8SySrD9rZ2hQngy-PZymt1ZIQjdB316SaqP2Fjleojn5NeQol-594h2inOtYl7FgN5cUrurnIBdCCRnlFpGVSllVzhwm2KzUvXt71H8n_7Eze6FkIBVHIH73g'

Example response

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

{
  "id" : "42abc436-b3a5-4dad-ab34-ae97fd110d03",
  "ownerIdentityId" : "f221bc80-3d22-4ab8-90be-031648309945",
  "createdBy" : "f221bc80-3d22-4ab8-90be-031648309945",
  "createdAt" : "2021-05-04T17:08:03.710935Z",
  "updatedAt" : "2021-05-04T17:08:03.732657Z",
  "deletedBy" : "d110e9b0-ac48-4356-b0ca-0e86a463ff92",
  "deletedAt" : null,
  "name" : "ACME Network2021-05-04T17:08:03.710724Z",
  "networkGroupId" : "c4a24222-4e03-4ba8-821f-ce15e42cd013",
  "size" : "small",
  "productVersion" : "7.2.1",
  "status" : "DELETING",
  "o365BreakoutCategory" : "NONE",
  "networkController" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/29641854-f5b3-478f-9860-6e0a34c71bfe",
      "profile" : "meta"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=42abc436-b3a5-4dad-ab34-ae97fd110d03"
    }
  }
}

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
networkId	Object	true
name	String	true
zitiId	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

Parameter

Type

Optional

Description

networkId

Object

true

name

String

true

zitiId

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

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.
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

Path

Type

Optional

Description

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.

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

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.

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.
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

Path

Type

Optional

Description

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.

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

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.eyJqdGkiOiI0WFpzRUpHQWl0Rk52OFBjN0tyTExBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY5MTg5NWViLWQxNTUtNDdiOC1iZjUyLWMxYTNmMGE3ZDExNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA3MywiZXhwIjoxNjIwMTUxNjczLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjY2NWQzZDQ0LWEyMTAtNDY4Ni04NmYxLTA4ZjQ5N2JmNjQwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA3M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.DeGXNfsRgfrwUKae_GbDxbSfNmrhS2L-WlifwFbz6gtPLLW9QluORxuTWUzZZsuyPUzt7NksWqPY9Dr7ZMBLsOWPwuyakuPeG0-4AJMMP3JMX8yqS2eO3UX22594wdXmHEi2_2rtiSzEZNNlouRM4AELPRsCAzcvVatZVXOXhlsX1aF70rD7uMI5p6dTTecBUaIQvj_VWXKJZr7rbrDJ1xKnfDOIeXwJFeLlrDcVbx_JXWjJHZMhLPwYw9SmTGZDDZfTD-RUxS-jSw0AoJNg5S4uv5zYsApEd3307Yb2cy-paFKKX8wXUZaw8kfDvUtnAdK1qjkoSWD248e68UPrjQ'

Example response

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

{
  "_embedded" : {
    "endpointList" : [ {
      "id" : "5ff2f3b2-f242-472b-bb6f-7aa1953ace3d",
      "ownerIdentityId" : "60784ebb-a32f-484f-a2ef-0d4be3baa888",
      "createdBy" : "60784ebb-a32f-484f-a2ef-0d4be3baa888",
      "createdAt" : "2021-05-04T17:07:53.747625Z",
      "updatedAt" : "2021-05-04T17:07:53.747625Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "9a932c28-c8ce-420c-b51e-0fdd29b4b03c",
      "zitiId" : "5c4b3d26-1af2-4f48-ac4c-66e495cb2ea8",
      "name" : "Test_endpoint2021-05-04T17:07:53.747395Z",
      "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" : "2af7f7db-de1d-4c81-9965-153c53ef7138",
      "syncResourceId" : "syncresourceId",
      "attributes" : [ ],
      "sessionActive" : true,
      "jwt" : "jwthereupdb",
      "mfaEnabled" : false,
      "jwtExpiresAt" : "2021-05-04T17:07:53.749258Z",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9a932c28-c8ce-420c-b51e-0fdd29b4b03c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/5ff2f3b2-f242-472b-bb6f-7aa1953ace3d"
        }
      }
    } ]
  },
  "_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

Parameter	Type	Optional	Description
id	Object	false	Client must have `read` action on the annotated resource.

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.
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

Path

Type

Optional

Description

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.

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

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.

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/e43d1c8d-ef3b-4103-9eb6-a1c2dfb195e5' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJPZWF2Z013aUt0a2FDZFgzNGpVVHlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZjZDAwNDAxLTM2OTUtNGI4Mi04ZDUwLWY0NzkwYjkwYzkzOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA3NCwiZXhwIjoxNjIwMTUxNjc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRiNjE1N2ZiLWE5NGQtNGJlNS1iMDlhLTBjNmFlYmY5MWJlY1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Id0b98N5X4sVhLOm-KLWDswh8945rj38cYf7RLkwLetfDet0ZG3Y5N8l4tSF1zAyWHwjS-Mq_xeNrPmD16mFCzPX7GwoXK86ETj0jewV2obwHZP7_Btq516cdL6yvXWBJUk3uFU3LcBOmU3eyUC4YJvT2JFzkIdCFV7nolnfB50eunYZlWZinXnFKYVkg0ER-YTuMuI5WI5mt4ilfrSOHSBf032rd2v-mw7VmQgQzynaPUpUl7FtbewbJzm8TUnbeVt68xXpNxOLm2akWZ050IIqo3Omn6sr5E43ZZYaMUIJQ-NnN-Y7pJ3tVWWdnNGfNsmY0WdHB-GkZzQQEKwRyQ'

Example response

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

{
  "id" : "e43d1c8d-ef3b-4103-9eb6-a1c2dfb195e5",
  "ownerIdentityId" : "e3155f0d-8be0-476a-9cc1-b6db62dbcc86",
  "createdBy" : "e3155f0d-8be0-476a-9cc1-b6db62dbcc86",
  "createdAt" : "2021-05-04T17:07:54.554149Z",
  "updatedAt" : "2021-05-04T17:07:54.554149Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "7f089010-6533-4a86-9d4d-7dc6c233fd31",
  "zitiId" : "bc521bb3-33e9-496e-a518-3ad0c844973f",
  "name" : "Test_endpoint2021-05-04T17:07:54.553985Z",
  "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" : "9d98da1f-bf31-4526-9733-5b35259017e8",
  "syncResourceId" : "syncresourceId",
  "attributes" : [ ],
  "sessionActive" : true,
  "jwt" : "jwthereca",
  "mfaEnabled" : false,
  "jwtExpiresAt" : "2021-05-04T17:07:54.555020Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/7f089010-6533-4a86-9d4d-7dc6c233fd31",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/e43d1c8d-ef3b-4103-9eb6-a1c2dfb195e5"
    }
  }
}

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
networkId	Object	true
name	String	true
zitiId	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

Parameter

Type

Optional

Description

networkId

Object

true

name

String

true

zitiId

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

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.
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

Path

Type

Optional

Description

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.

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

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.

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=020bdffe-8572-4a34-8671-31a2c6c79a1d' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJIUTk2TFVOdHdGOHdMNHBFRk9ueXZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY1ZTM0MzY1LWFkNjctNDgzNC1hMjJjLTFlZGI4NzVkMGJiMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODAwMywiZXhwIjoxNjIwMTUxNjAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImE0MjYyZDQ1LWZjNzYtNDVlYS1iYzg1LTcwNjMxNTExODQzYVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODAwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.LjGGDcXqs6i5zHz-uJKtY0whGDpJA-fC5RKXSLLpL_H9w0q0EeCLzBb_N5bumFUsWGRu-LRl3oXUkYKafkbGYXtZpIcLcPTzP7zYKLHn95SOKYAxAjzl1LjuVLgL0lVkQ7TATb7UDEKgcySnC15lq6B1iqdkMJ1TIKDWNmJSugBk6rGwPyIDgjsviniDEL1MHI3Bph20TGBn5jYivKiRe6zoRW85JemLqtgaemwdZu1TcF0USwTcG-gsDRU44-r7WLHfv6sOGAyLkDcq5RrVCdU8mFADMppQba6NdcISxeaVsVO3mTEvwzSiL27sQDjXLsgRPYw46E7mHRTvGabTYg'

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

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

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.
enrollmentMethod	Object	true
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

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.

enrollmentMethod

Object

true

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

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.
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

Path

Type

Optional

Description

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.

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

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.

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.eyJqdGkiOiJ6ZUpCX1N5ZWwtVHBDWDVSUHlJeW9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg5MWJjZWQ3LWFmMjAtNGYzMy04YTVmLTZlMzMxOTgxODQ1MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA3NCwiZXhwIjoxNjIwMTUxNjc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFhODJhMGZkLTc3NTAtNDM3My1hZWE1LTEyMDNkNjUyNzEwNVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.H90THivh4i70ZeSoyqJyY_uHkt300bDWdERXf6OvArJ1LXsooVIhK_z89J3hVZ43QjYZGjDaMO4jzK-LL1kMGp_nlIe0SZ_P63IUSkBjcJLLGyUnrhTGzyxkJ5cc6gxB3-a8j64Zgvtl81AmI79i0i49s9XIcu7tOUlrRR8Bxr4LkTUV5LBfmGNH67sB6i71uV-b8uIfg8oeaPMAEjCGTRYEmF9-1TwS5agBGtZtBzrWkHUrDqRokGkqPcc5oD8imFVxxzIFcKKBz1iWmYt75aPI7swKaJ47cqlNh5KHu7hQADL0GjaqEOag01N_nsf18CSzjAPFprqGyNoZNv4sxQ' \
    -d '{"networkId":"4b38b462-c32b-479f-a02a-c5f2916e1a1c","name":"Test endpoint 02","enrollmentMethod":{"ott":true,"updb":null,"ottca":null},"attributes":["#clients"]}'

Example response

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

{
  "id" : "5443c90c-d85c-422f-8cb8-e4641fd26cc5",
  "ownerIdentityId" : "891bced7-af20-4f33-8a5f-6e3319818451",
  "createdBy" : "891bced7-af20-4f33-8a5f-6e3319818451",
  "createdAt" : "2021-05-04T17:07:54.042362Z",
  "updatedAt" : "2021-05-04T17:07:54.046414Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "4b38b462-c32b-479f-a02a-c5f2916e1a1c",
  "zitiId" : "a4bd7a02-2169-4356-a7ff-03936f9ff35e",
  "name" : "Test endpoint 02",
  "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-05-04T17:07:54.036574Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4b38b462-c32b-479f-a02a-c5f2916e1a1c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/5443c90c-d85c-422f-8cb8-e4641fd26cc5"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/4f694762-00e8-4d84-b1e9-1e19ba76e6ef",
      "profile" : "meta"
    }
  }
}

Patch Endpoint

PATCH /endpoints/{id}

Authorization

This endpoint requires update action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

Parameter	Type	Optional	Description
id	Object	false	Client must have `update` action on the annotated resource.

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

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.
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

Path

Type

Optional

Description

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.

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

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.

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/b5eae9fa-5467-412d-893d-544d6553fbff' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJRcllJN0lJWVFWNk9JemNSdjNZdUNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg5MGE2NGZlLWY5OTUtNDRlNy1iNzUzLTVmMzM0YzYwZTdmNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA3NCwiZXhwIjoxNjIwMTUxNjc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE4NWEyZmRiLTcxYWEtNDgzZS1hMGVhLTVkMmM1MmVmMmMwOFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.r1aoBGpA3JPRAC8UhHKvuZFt4oQvaZKfgWsASYtXa7yz5JvG3QhZHKBHQsF2J-xBZGD7bluWf0it2YcBBlOe9_FSI-2P4npRzToO7P04kxlqhilSNUi1-vMeD8Ly3_npRBv9wbrZ7QkglJH_iK2fITRYz5w-9_82HrO4Nh8FOtQ9dUeq3k1ErLOsxAPZWFmjrGvyftETnLjSG0qruOMUXwxfbXccKYH4ydMPCHxKrJ18VKxbHwla3A_twbaVUMkCoPkD9jIRU0wcqm3Hn4hBcaJdSxhkt75YP0vT4kFbkyHgj3RFWElU8tjzNLlWSl74y7tlOT-xHiFPRDXsGZ5MoA' \
    -d '{"name":"Test endpoint 02 updated"}'

Example response

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

{
  "id" : "b5eae9fa-5467-412d-893d-544d6553fbff",
  "ownerIdentityId" : "123c7631-3682-42c2-9e34-d20fdcb4dfa9",
  "createdBy" : "123c7631-3682-42c2-9e34-d20fdcb4dfa9",
  "createdAt" : "2021-05-04T17:07:54.492209Z",
  "updatedAt" : "2021-05-04T17:07:54.517121Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "90084b30-b450-4a12-bd17-e6147345cea7",
  "zitiId" : "7b644179-8f38-4002-9e1d-a7b805f531f1",
  "name" : "Test endpoint 02 updated",
  "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" : "ee8b32d6-4c75-4eb3-9591-7a2304695332",
  "syncResourceId" : "syncresourceId",
  "attributes" : [ ],
  "sessionActive" : true,
  "jwt" : "jwthereupdb",
  "mfaEnabled" : false,
  "jwtExpiresAt" : "2021-05-04T17:07:54.493428Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/90084b30-b450-4a12-bd17-e6147345cea7",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/b5eae9fa-5467-412d-893d-544d6553fbff"
    }
  }
}

Delete Endpoint

DELETE /endpoints/{id}

Authorization

This endpoint requires delete action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

Parameter	Type	Optional	Description
id	Object	false	Client must have `delete` action on the annotated resource.

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/839ad3f9-a1a1-40c7-a6b6-c93b727a4679' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJaNFdXWXVNRllsTUJoNDNuX0l0a0h3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkzOGQxZjUzLTA4YWEtNDA1Mi1hMjNhLWNiYTY1NThmNTZjMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA3NCwiZXhwIjoxNjIwMTUxNjc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImVmMjZmNDA3LWQ0Y2YtNGM0Zi05MGE2LThlMDI2NmU1NzI3MlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.tLvFWf6UEK0opfjIPXB-j9FKUiQzBs31iFWe73ALnav-8L0YPHTi7dFzxCaN9KLtiA-8jePHv6ZddHJIxBE9tkf3jSTtIUOIKUM1RMoa0nG8xBYTyMYRqAzKA-ad9o9cBjGfOMIG2jZpo-LYfY3UXqfT2VkGt4zhQqPzSNOuTdBAaCue68rDzh5hbjk-gY_3UcEj-V9G4pkxmY-yIMichyTcDDwv0SORJHVbUdfUYeEqyVMFPJ-hNxr_CW1r_QoBGngh4lO2FhpCin5hoGbwlWQMHcjjgGwR_q5y1pEStWtD6JYjd0_kQcBE1jMexq9rwAXipJoHmZdP7k4W3_enzw'

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
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

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

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
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
provider	String	true
ipAddress	String	true
providerId	String	true
dataCenterId	String	true
userData	String	true
locationMetadataId	String	true

Path

Type

Optional

Description

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

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

provider

String

true

ipAddress

String

true

providerId

String

true

dataCenterId

String

true

userData

String

true

locationMetadataId

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.

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
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
provider	String	true
ipAddress	String	true
providerId	String	true
dataCenterId	String	true
userData	String	true
locationMetadataId	String	true

Path

Type

Optional

Description

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

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

provider

String

true

ipAddress

String

true

providerId

String

true

dataCenterId

String

true

userData

String

true

locationMetadataId

String

true

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.eyJqdGkiOiJUVU9qUnJUV2hTemlPQllXY251U21BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJiMDU0NTg1LWU3ZDctNDQwYi1iNDZkLTI5NjU0ZDZlMzRjZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE0MCwiZXhwIjoxNjIwMTUxNzQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY5Y2ExNzBjLWMyZmUtNGU2My05NWE5LThmOGU0NzQyOGNmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.HavGmfwLdVkdNte8lGR2o-fc9AC2ALVhfM6THRS5x1-Oqf9AAtFlaVIbU2TJhBkvL3e1ZAgy1lyi_gkuHlJlrOXh7q6wpu7oEDz5hyy92MOg1mGUitankyDodawwJxWV4JyMel5Lw0FHhgP00H1TO4KylaleNJERtO6guvU9YZN8rVGHCbd0loScSVwNBYbaa2G1vq9X85da-OmOb2-7vofWj5FYCV8xu_dWEi8-a0rGL24c4XQ5chUSF_fAtyStJT5d_j_BXKPoYeuqL8g_Opn82NvliBX23Hdg6EOgMlb8CExbF8pF5hn6SwYvVyZfInivOAHeDpWCIjoshFUxSg'

Example response

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

{
  "_embedded" : {
    "edgeRouterList" : [ {
      "id" : "00550a25-9bed-41fb-9eba-cc37971eb12e",
      "hostId" : null,
      "ownerIdentityId" : "69591254-68c3-4752-90c1-42d905dd5a88",
      "createdBy" : "69591254-68c3-4752-90c1-42d905dd5a88",
      "createdAt" : "2021-05-04T17:09:00.428655Z",
      "updatedAt" : "2021-05-04T17:09:00.443126Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "ca4c334f-06bd-4734-9c71-11bfb50b06a4",
      "name" : "Test edge router 1620148140",
      "networkId" : "f7e393b4-bf68-452a-a4e4-cd6e5840367b",
      "jwt" : null,
      "linkListener" : false,
      "online" : false,
      "verified" : false,
      "status" : "ERROR",
      "attributes" : [ ],
      "provider" : null,
      "ipAddress" : null,
      "providerId" : null,
      "dataCenterId" : null,
      "userData" : null,
      "locationMetadataId" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f7e393b4-bf68-452a-a4e4-cd6e5840367b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/00550a25-9bed-41fb-9eba-cc37971eb12e"
        }
      }
    }, {
      "id" : "0124b4b9-2d86-4aae-9d81-e2c44fa48c0c",
      "hostId" : "e7010dfa-ef6f-49a7-93f6-653916dfc9cb",
      "ownerIdentityId" : "d51a508c-f0c0-490b-a9a0-5c85ab02baca",
      "createdBy" : "d51a508c-f0c0-490b-a9a0-5c85ab02baca",
      "createdAt" : "2021-05-04T17:09:00.571529Z",
      "updatedAt" : "2021-05-04T17:09:00.571529Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.571406Z",
      "networkId" : "8418a18b-cda0-4da4-a495-858a30033c9c",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "9ca5dcd8-a3af-4655-918b-7b50ee92944f",
      "userData" : null,
      "locationMetadataId" : "e00bbb02-75b3-49e7-ab94-34b3e3bd8c84",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8418a18b-cda0-4da4-a495-858a30033c9c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/0124b4b9-2d86-4aae-9d81-e2c44fa48c0c"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/e7010dfa-ef6f-49a7-93f6-653916dfc9cb"
        }
      }
    }, {
      "id" : "056f41df-f55a-485d-8702-b9e0ce85c743",
      "hostId" : "a7380b1e-caf1-42ff-8cc1-2bcd8e69a6e6",
      "ownerIdentityId" : "3ea55510-1fd4-4282-8e61-aa4093e56747",
      "createdBy" : "3ea55510-1fd4-4282-8e61-aa4093e56747",
      "createdAt" : "2021-05-04T17:09:00.334243Z",
      "updatedAt" : "2021-05-04T17:09:00.334243Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.334121Z",
      "networkId" : "f7e393b4-bf68-452a-a4e4-cd6e5840367b",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "7d5a8868-52fb-4723-9344-89bc02a90781",
      "userData" : null,
      "locationMetadataId" : "9df5e9c3-172e-497b-8bf4-430114398447",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f7e393b4-bf68-452a-a4e4-cd6e5840367b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/056f41df-f55a-485d-8702-b9e0ce85c743"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/a7380b1e-caf1-42ff-8cc1-2bcd8e69a6e6"
        }
      }
    }, {
      "id" : "06cf640a-7df1-4300-8977-1f9c42d4ed6d",
      "hostId" : "8599c7fc-1676-487a-be5c-04d031f78a4b",
      "ownerIdentityId" : "28ec4643-88ac-4033-8ad8-ad651792c06d",
      "createdBy" : "28ec4643-88ac-4033-8ad8-ad651792c06d",
      "createdAt" : "2021-05-04T17:09:00.288046Z",
      "updatedAt" : "2021-05-04T17:09:00.288046Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.287924Z",
      "networkId" : "094e661f-91b7-4cbc-9e27-41496b0a437b",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "a70c0533-8b53-4eb2-b9ad-df10e8be1958",
      "userData" : null,
      "locationMetadataId" : "b2612d7a-2920-4857-98ce-1c7e84208a3b",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/094e661f-91b7-4cbc-9e27-41496b0a437b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/06cf640a-7df1-4300-8977-1f9c42d4ed6d"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/8599c7fc-1676-487a-be5c-04d031f78a4b"
        }
      }
    }, {
      "id" : "085f3071-4b67-46d2-9d91-ab954d0e8f1f",
      "hostId" : "c29f51fe-e6b6-4c84-9f5f-93c2c9d3b8d8",
      "ownerIdentityId" : "c297d0d7-b442-41f5-969e-c1a0d275678a",
      "createdBy" : "c297d0d7-b442-41f5-969e-c1a0d275678a",
      "createdAt" : "2021-05-04T17:09:00.649135Z",
      "updatedAt" : "2021-05-04T17:09:00.672438Z",
      "deletedBy" : "6c52adbb-9293-4806-96c5-ef2d8940b680",
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.648995Z",
      "networkId" : "2aea320a-933e-4e64-ba5d-5f503f5396f2",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "ERROR",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "5da5e306-b515-46cb-a78f-7bd9b85afd7b",
      "userData" : null,
      "locationMetadataId" : "339a43b5-2e16-4b6f-870f-283b6ee52cc8",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2aea320a-933e-4e64-ba5d-5f503f5396f2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/085f3071-4b67-46d2-9d91-ab954d0e8f1f"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/c29f51fe-e6b6-4c84-9f5f-93c2c9d3b8d8"
        }
      }
    }, {
      "id" : "15aeb082-d24b-40e1-a2c4-f6c0d3ab855e",
      "hostId" : "ecb2b27c-8985-41e6-adb8-e81cfb3a65a6",
      "ownerIdentityId" : "5034d69a-98ee-4e6c-8251-ac351931c9b3",
      "createdBy" : "5034d69a-98ee-4e6c-8251-ac351931c9b3",
      "createdAt" : "2021-05-04T17:09:00.191125Z",
      "updatedAt" : "2021-05-04T17:09:00.191125Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.190930Z",
      "networkId" : "16042d7d-cc7e-4c5c-b52f-b431e7815096",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "3d524297-9c21-4ae2-88da-3afbc3e9a6ca",
      "userData" : null,
      "locationMetadataId" : "8f57d970-0419-48bc-9a81-81a534c0bd30",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/16042d7d-cc7e-4c5c-b52f-b431e7815096",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/15aeb082-d24b-40e1-a2c4-f6c0d3ab855e"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/ecb2b27c-8985-41e6-adb8-e81cfb3a65a6"
        }
      }
    }, {
      "id" : "1d73779e-4101-456c-abae-9b8f1b039ba9",
      "hostId" : null,
      "ownerIdentityId" : "ee2782dd-441c-404d-b297-e6992e0227c0",
      "createdBy" : "ee2782dd-441c-404d-b297-e6992e0227c0",
      "createdAt" : "2021-05-04T17:09:00.515567Z",
      "updatedAt" : "2021-05-04T17:09:00.525136Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "1554b88a-b817-4dc6-afb3-25b890705e62",
      "name" : "Test edge router 1620148140",
      "networkId" : "5c5cad2d-ea8d-4731-a955-91b988c9373e",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : false,
      "status" : "ERROR",
      "attributes" : [ ],
      "provider" : null,
      "ipAddress" : null,
      "providerId" : null,
      "dataCenterId" : null,
      "userData" : null,
      "locationMetadataId" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5c5cad2d-ea8d-4731-a955-91b988c9373e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/1d73779e-4101-456c-abae-9b8f1b039ba9"
        }
      }
    }, {
      "id" : "25a7442c-61b2-4ad5-95fd-a4d2c20be722",
      "hostId" : "c4a85abd-4a37-4a78-a721-9a183347874d",
      "ownerIdentityId" : "28ec4643-88ac-4033-8ad8-ad651792c06d",
      "createdBy" : "28ec4643-88ac-4033-8ad8-ad651792c06d",
      "createdAt" : "2021-05-04T17:09:00.289104Z",
      "updatedAt" : "2021-05-04T17:09:00.289104Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.288973Z",
      "networkId" : "094e661f-91b7-4cbc-9e27-41496b0a437b",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "fcfd328c-3bfe-48af-beaa-ff045923354f",
      "userData" : null,
      "locationMetadataId" : "d2b862f1-3ca4-4c0c-bd09-2f186c5ea166",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/094e661f-91b7-4cbc-9e27-41496b0a437b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/25a7442c-61b2-4ad5-95fd-a4d2c20be722"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/c4a85abd-4a37-4a78-a721-9a183347874d"
        }
      }
    }, {
      "id" : "28f95c69-4cab-45a6-b8a9-e0ac850f741b",
      "hostId" : "f91c0c23-c6d0-446a-b9de-b8d9472adafc",
      "ownerIdentityId" : "e537a080-0bfd-416c-85d1-0e8c860067b3",
      "createdBy" : "e537a080-0bfd-416c-85d1-0e8c860067b3",
      "createdAt" : "2021-05-04T17:09:00.607280Z",
      "updatedAt" : "2021-05-04T17:09:00.607280Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.607153Z",
      "networkId" : "df774533-4869-4017-b7b0-21a275e5b9ef",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "575c36ee-624e-44d3-b441-abe34365c25e",
      "userData" : null,
      "locationMetadataId" : "88ba0574-12b1-43e6-a93f-169dc473a106",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df774533-4869-4017-b7b0-21a275e5b9ef",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/28f95c69-4cab-45a6-b8a9-e0ac850f741b"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/f91c0c23-c6d0-446a-b9de-b8d9472adafc"
        }
      }
    }, {
      "id" : "2a3139d9-68d1-4392-89ce-889076f4cb46",
      "hostId" : "fcfa2349-7c96-4622-bc3f-17c81cca9aec",
      "ownerIdentityId" : "0e1c4073-660e-4620-8abb-a039379df6f8",
      "createdBy" : "0e1c4073-660e-4620-8abb-a039379df6f8",
      "createdAt" : "2021-05-04T17:09:00.501216Z",
      "updatedAt" : "2021-05-04T17:09:00.501216Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.501082Z",
      "networkId" : "5c5cad2d-ea8d-4731-a955-91b988c9373e",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "dbcc9b0f-dc13-442e-8556-a5df87b99527",
      "userData" : null,
      "locationMetadataId" : "501f360e-97f0-445d-845f-9612ff95a7db",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5c5cad2d-ea8d-4731-a955-91b988c9373e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/2a3139d9-68d1-4392-89ce-889076f4cb46"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/fcfa2349-7c96-4622-bc3f-17c81cca9aec"
        }
      }
    }, {
      "id" : "2b282dd6-a755-4a88-871c-2163a7c5eee9",
      "hostId" : "8e8462b2-b564-4d4b-89be-75e97650fd32",
      "ownerIdentityId" : "e537a080-0bfd-416c-85d1-0e8c860067b3",
      "createdBy" : "e537a080-0bfd-416c-85d1-0e8c860067b3",
      "createdAt" : "2021-05-04T17:09:00.606291Z",
      "updatedAt" : "2021-05-04T17:09:00.606291Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.606158Z",
      "networkId" : "df774533-4869-4017-b7b0-21a275e5b9ef",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "3aa32d02-8017-4bd4-b0cb-49af2ec19ddd",
      "userData" : null,
      "locationMetadataId" : "2e83b4da-83b8-4824-a5d4-8b3c7d440ac0",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df774533-4869-4017-b7b0-21a275e5b9ef",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/2b282dd6-a755-4a88-871c-2163a7c5eee9"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/8e8462b2-b564-4d4b-89be-75e97650fd32"
        }
      }
    }, {
      "id" : "2d29b574-bb92-4417-a8ee-416336ac65d1",
      "hostId" : "8d01e898-8ba5-4932-9023-5659ad2d1b32",
      "ownerIdentityId" : "c297d0d7-b442-41f5-969e-c1a0d275678a",
      "createdBy" : "c297d0d7-b442-41f5-969e-c1a0d275678a",
      "createdAt" : "2021-05-04T17:09:00.647807Z",
      "updatedAt" : "2021-05-04T17:09:00.647807Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.647682Z",
      "networkId" : "2aea320a-933e-4e64-ba5d-5f503f5396f2",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "0e461055-875e-4080-ba72-01e097f4146e",
      "userData" : null,
      "locationMetadataId" : "f9838c3c-7637-45e5-b87a-0b280789af24",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2aea320a-933e-4e64-ba5d-5f503f5396f2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/2d29b574-bb92-4417-a8ee-416336ac65d1"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/8d01e898-8ba5-4932-9023-5659ad2d1b32"
        }
      }
    }, {
      "id" : "36187167-175e-4cde-bb5b-9ef4e02700e3",
      "hostId" : "8621d55f-ffd3-4886-967a-cf20e98ee9a9",
      "ownerIdentityId" : "3ea55510-1fd4-4282-8e61-aa4093e56747",
      "createdBy" : "3ea55510-1fd4-4282-8e61-aa4093e56747",
      "createdAt" : "2021-05-04T17:09:00.332243Z",
      "updatedAt" : "2021-05-04T17:09:00.332243Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.332101Z",
      "networkId" : "f7e393b4-bf68-452a-a4e4-cd6e5840367b",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "a6a3606f-7df2-434d-a9f8-4b4308c5f202",
      "userData" : null,
      "locationMetadataId" : "635359d8-1caf-423d-aeaa-7e67a8513f63",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f7e393b4-bf68-452a-a4e4-cd6e5840367b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/36187167-175e-4cde-bb5b-9ef4e02700e3"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/8621d55f-ffd3-4886-967a-cf20e98ee9a9"
        }
      }
    }, {
      "id" : "429e3096-4c16-41b8-9ecb-988737bc3ad6",
      "hostId" : "b3ac94a6-27c7-44eb-abd7-2f0a8fe2134b",
      "ownerIdentityId" : "20bde087-3bb2-490d-93e9-7dc079d97072",
      "createdBy" : "20bde087-3bb2-490d-93e9-7dc079d97072",
      "createdAt" : "2021-05-04T17:09:00.713578Z",
      "updatedAt" : "2021-05-04T17:09:00.713578Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.713460Z",
      "networkId" : "4ff79241-9dd1-44c5-9f29-d9bce0e88fd6",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "9c99b7d5-ebfa-438e-adc9-fee4101a234d",
      "userData" : null,
      "locationMetadataId" : "e31a6bdb-7dc3-4083-921f-0aa80263ffb0",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4ff79241-9dd1-44c5-9f29-d9bce0e88fd6",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/429e3096-4c16-41b8-9ecb-988737bc3ad6"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/b3ac94a6-27c7-44eb-abd7-2f0a8fe2134b"
        }
      }
    }, {
      "id" : "48ce9e2d-1ec6-47f2-a27c-232630c71594",
      "hostId" : "7084f692-89a3-4c4d-8c47-b3cd74a042d7",
      "ownerIdentityId" : "0e1c4073-660e-4620-8abb-a039379df6f8",
      "createdBy" : "0e1c4073-660e-4620-8abb-a039379df6f8",
      "createdAt" : "2021-05-04T17:09:00.502189Z",
      "updatedAt" : "2021-05-04T17:09:00.502189Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.502059Z",
      "networkId" : "5c5cad2d-ea8d-4731-a955-91b988c9373e",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "1b290329-7871-4dc4-b42d-e801b5f16ef6",
      "userData" : null,
      "locationMetadataId" : "19523d0a-2a2c-4adf-871b-3ecb29fce711",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5c5cad2d-ea8d-4731-a955-91b988c9373e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/48ce9e2d-1ec6-47f2-a27c-232630c71594"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/7084f692-89a3-4c4d-8c47-b3cd74a042d7"
        }
      }
    }, {
      "id" : "4afd3b06-5a6b-44a2-b8af-46234e978db9",
      "hostId" : "75b91539-9c2c-46ce-9536-aa0e77ec3b3b",
      "ownerIdentityId" : "5034d69a-98ee-4e6c-8251-ac351931c9b3",
      "createdBy" : "5034d69a-98ee-4e6c-8251-ac351931c9b3",
      "createdAt" : "2021-05-04T17:09:00.193613Z",
      "updatedAt" : "2021-05-04T17:09:00.193613Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.193484Z",
      "networkId" : "16042d7d-cc7e-4c5c-b52f-b431e7815096",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "9a677add-a9d0-43b2-9195-8f03fbbe9fe9",
      "userData" : null,
      "locationMetadataId" : "50be9da7-c9b0-428f-a8ef-40f07d2f8b0a",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/16042d7d-cc7e-4c5c-b52f-b431e7815096",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/4afd3b06-5a6b-44a2-b8af-46234e978db9"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/75b91539-9c2c-46ce-9536-aa0e77ec3b3b"
        }
      }
    }, {
      "id" : "503f1d8f-63e0-4375-8ae2-d0163fd2e6a0",
      "hostId" : "e9ba0d26-35fc-4978-a2b1-6993b9f53037",
      "ownerIdentityId" : "6bdb0aa1-a6ad-4d51-b61f-d3212b7ce1fe",
      "createdBy" : "6bdb0aa1-a6ad-4d51-b61f-d3212b7ce1fe",
      "createdAt" : "2021-05-04T17:09:00.106500Z",
      "updatedAt" : "2021-05-04T17:09:00.106500Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.106372Z",
      "networkId" : "35a73b3e-e218-4b15-8156-abd8c3e78a6d",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "eb35e5d7-f1ac-4cae-920f-5cffdde39354",
      "userData" : null,
      "locationMetadataId" : "d8a99acc-5211-4dff-9915-783aa84f138c",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/35a73b3e-e218-4b15-8156-abd8c3e78a6d",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/503f1d8f-63e0-4375-8ae2-d0163fd2e6a0"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/e9ba0d26-35fc-4978-a2b1-6993b9f53037"
        }
      }
    }, {
      "id" : "5258a8c7-fa8e-421c-b491-51ce320b5233",
      "hostId" : "3dc9f4ae-1378-4df0-b142-8417699d689c",
      "ownerIdentityId" : "20bde087-3bb2-490d-93e9-7dc079d97072",
      "createdBy" : "20bde087-3bb2-490d-93e9-7dc079d97072",
      "createdAt" : "2021-05-04T17:09:00.712613Z",
      "updatedAt" : "2021-05-04T17:09:00.712613Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.712488Z",
      "networkId" : "4ff79241-9dd1-44c5-9f29-d9bce0e88fd6",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "e9b683a1-bd5e-4974-b0bc-3decf60fe05f",
      "userData" : null,
      "locationMetadataId" : "c4bcaa1e-af8e-4e07-93f5-d9233a43488a",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4ff79241-9dd1-44c5-9f29-d9bce0e88fd6",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/5258a8c7-fa8e-421c-b491-51ce320b5233"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/3dc9f4ae-1378-4df0-b142-8417699d689c"
        }
      }
    }, {
      "id" : "53fab620-1a98-4e88-b845-75d0519be8d3",
      "hostId" : "28a0c19a-ffc6-445e-b961-5e972374e852",
      "ownerIdentityId" : "3ea55510-1fd4-4282-8e61-aa4093e56747",
      "createdBy" : "3ea55510-1fd4-4282-8e61-aa4093e56747",
      "createdAt" : "2021-05-04T17:09:00.333286Z",
      "updatedAt" : "2021-05-04T17:09:00.333286Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.333166Z",
      "networkId" : "f7e393b4-bf68-452a-a4e4-cd6e5840367b",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "67acee65-940a-4702-a6bd-7d13bfc534de",
      "userData" : null,
      "locationMetadataId" : "e62f85f1-cf53-4ae5-ba9b-454d967bbd74",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f7e393b4-bf68-452a-a4e4-cd6e5840367b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/53fab620-1a98-4e88-b845-75d0519be8d3"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/28a0c19a-ffc6-445e-b961-5e972374e852"
        }
      }
    }, {
      "id" : "56a28015-f276-4fa3-a6c2-4b0ac530ef18",
      "hostId" : "1af69d6e-2c73-46c8-9ca5-31c539a5a4b4",
      "ownerIdentityId" : "5951ad06-2526-409f-ad64-7ba8f2abb846",
      "createdBy" : "5951ad06-2526-409f-ad64-7ba8f2abb846",
      "createdAt" : "2021-05-04T17:09:00.070356Z",
      "updatedAt" : "2021-05-04T17:09:00.070356Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.070225Z",
      "networkId" : "b4afd8b7-305b-4cbc-9e85-c9999d700003",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "3f3b6b5d-9c0e-41fa-8874-e56caa585f0c",
      "userData" : null,
      "locationMetadataId" : "917e96ce-1a9b-4e42-85ab-46a37f56023e",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b4afd8b7-305b-4cbc-9e85-c9999d700003",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/56a28015-f276-4fa3-a6c2-4b0ac530ef18"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/1af69d6e-2c73-46c8-9ca5-31c539a5a4b4"
        }
      }
    }, {
      "id" : "65dbde05-2b60-4211-b7ca-6db0f709d040",
      "hostId" : "76067316-98fb-4815-9f28-fcb426564529",
      "ownerIdentityId" : "f2d9bdc3-2101-4249-bd79-d72a3b5c6883",
      "createdBy" : "f2d9bdc3-2101-4249-bd79-d72a3b5c6883",
      "createdAt" : "2021-05-04T17:08:59.970519Z",
      "updatedAt" : "2021-05-04T17:08:59.970519Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:08:59.970401Z",
      "networkId" : "e9c0bfc0-814f-4a49-a630-be6e55539185",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "56b762a5-6c82-4aa5-aed8-7cc964652725",
      "userData" : null,
      "locationMetadataId" : "fb8e4ef2-7eba-4bd4-8daa-fa4b6b95b271",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e9c0bfc0-814f-4a49-a630-be6e55539185",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/65dbde05-2b60-4211-b7ca-6db0f709d040"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/76067316-98fb-4815-9f28-fcb426564529"
        }
      }
    }, {
      "id" : "88a901c7-f3b5-4759-ba24-97943d90991f",
      "hostId" : "cbe1d442-feb5-484e-bb24-01f53326da22",
      "ownerIdentityId" : "20bde087-3bb2-490d-93e9-7dc079d97072",
      "createdBy" : "20bde087-3bb2-490d-93e9-7dc079d97072",
      "createdAt" : "2021-05-04T17:09:00.711591Z",
      "updatedAt" : "2021-05-04T17:09:00.733332Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "Updated name",
      "networkId" : "4ff79241-9dd1-44c5-9f29-d9bce0e88fd6",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "0f0f4fac-3798-4720-87e6-2802e58dfb7c",
      "userData" : null,
      "locationMetadataId" : "8215d90f-8d5b-4237-a216-2e75beda4258",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4ff79241-9dd1-44c5-9f29-d9bce0e88fd6",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/88a901c7-f3b5-4759-ba24-97943d90991f"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/cbe1d442-feb5-484e-bb24-01f53326da22"
        }
      }
    }, {
      "id" : "89c82ba4-047d-4e44-8da6-86cb9487c762",
      "hostId" : "678e8f71-6e3e-4e3d-a607-9f7965ff9ec0",
      "ownerIdentityId" : "e537a080-0bfd-416c-85d1-0e8c860067b3",
      "createdBy" : "e537a080-0bfd-416c-85d1-0e8c860067b3",
      "createdAt" : "2021-05-04T17:09:00.608244Z",
      "updatedAt" : "2021-05-04T17:09:00.608244Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.608122Z",
      "networkId" : "df774533-4869-4017-b7b0-21a275e5b9ef",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "67ef9501-f5d6-4a58-9583-50ee1581050e",
      "userData" : null,
      "locationMetadataId" : "38fb9917-8247-41d5-b4e2-0e44bdda1a5b",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df774533-4869-4017-b7b0-21a275e5b9ef",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/89c82ba4-047d-4e44-8da6-86cb9487c762"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/678e8f71-6e3e-4e3d-a607-9f7965ff9ec0"
        }
      }
    }, {
      "id" : "8ee67a75-97a7-4250-925e-702e7e16fa8b",
      "hostId" : "29e3aaac-76b0-4e03-a935-ed378fd79f5d",
      "ownerIdentityId" : "5951ad06-2526-409f-ad64-7ba8f2abb846",
      "createdBy" : "5951ad06-2526-409f-ad64-7ba8f2abb846",
      "createdAt" : "2021-05-04T17:09:00.069352Z",
      "updatedAt" : "2021-05-04T17:09:00.069352Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.069220Z",
      "networkId" : "b4afd8b7-305b-4cbc-9e85-c9999d700003",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "92cf1073-53f3-4974-b49a-600748e53a8a",
      "userData" : null,
      "locationMetadataId" : "74ee0d42-c3f3-471d-b911-acd474633dfa",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b4afd8b7-305b-4cbc-9e85-c9999d700003",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/8ee67a75-97a7-4250-925e-702e7e16fa8b"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/29e3aaac-76b0-4e03-a935-ed378fd79f5d"
        }
      }
    }, {
      "id" : "8f2bf195-52ea-4db9-b510-c7e082943844",
      "hostId" : "4b0863cb-1bad-431f-84c4-d72615d9c5a1",
      "ownerIdentityId" : "d51a508c-f0c0-490b-a9a0-5c85ab02baca",
      "createdBy" : "d51a508c-f0c0-490b-a9a0-5c85ab02baca",
      "createdAt" : "2021-05-04T17:09:00.570594Z",
      "updatedAt" : "2021-05-04T17:09:00.570594Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.570471Z",
      "networkId" : "8418a18b-cda0-4da4-a495-858a30033c9c",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "7498a5d7-bdc2-4cfb-a49d-3308d0070d83",
      "userData" : null,
      "locationMetadataId" : "1455515f-d895-44b7-af82-f2b068a66154",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8418a18b-cda0-4da4-a495-858a30033c9c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/8f2bf195-52ea-4db9-b510-c7e082943844"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/4b0863cb-1bad-431f-84c4-d72615d9c5a1"
        }
      }
    }, {
      "id" : "924df0cb-b823-4408-9012-d3168ab0fc4f",
      "hostId" : "eac2a00d-17f6-4559-8866-c966d5a92286",
      "ownerIdentityId" : "6f6e96da-0812-4bb9-8e63-061b40643835",
      "createdBy" : "6f6e96da-0812-4bb9-8e63-061b40643835",
      "createdAt" : "2021-05-04T17:09:00.771614Z",
      "updatedAt" : "2021-05-04T17:09:00.771614Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.771495Z",
      "networkId" : "6fdf6236-39cd-4bb5-b79d-b7bbf4258b0b",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "0ffd37e0-9d96-4194-a02b-bb2427fd09c5",
      "userData" : null,
      "locationMetadataId" : "97b5fcce-a21c-43c9-8931-bff323bbcdf2",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6fdf6236-39cd-4bb5-b79d-b7bbf4258b0b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/924df0cb-b823-4408-9012-d3168ab0fc4f"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/eac2a00d-17f6-4559-8866-c966d5a92286"
        }
      }
    }, {
      "id" : "971621ad-143b-41db-b70e-98a62711d7f4",
      "hostId" : "449a8470-5256-4199-96aa-e5ce69e55bde",
      "ownerIdentityId" : "5034d69a-98ee-4e6c-8251-ac351931c9b3",
      "createdBy" : "5034d69a-98ee-4e6c-8251-ac351931c9b3",
      "createdAt" : "2021-05-04T17:09:00.192477Z",
      "updatedAt" : "2021-05-04T17:09:00.192477Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.192294Z",
      "networkId" : "16042d7d-cc7e-4c5c-b52f-b431e7815096",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "e3657c98-52a6-4579-ab1f-667448e94504",
      "userData" : null,
      "locationMetadataId" : "01b2d1b8-1c37-44ff-a51c-fa2e6f0eb449",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/16042d7d-cc7e-4c5c-b52f-b431e7815096",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/971621ad-143b-41db-b70e-98a62711d7f4"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/449a8470-5256-4199-96aa-e5ce69e55bde"
        }
      }
    }, {
      "id" : "9a4f39d3-adcd-4252-b406-55cd912cc269",
      "hostId" : "76987980-9b6c-4c96-8ff6-20669244251f",
      "ownerIdentityId" : "d51a508c-f0c0-490b-a9a0-5c85ab02baca",
      "createdBy" : "d51a508c-f0c0-490b-a9a0-5c85ab02baca",
      "createdAt" : "2021-05-04T17:09:00.569608Z",
      "updatedAt" : "2021-05-04T17:09:00.569608Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.569476Z",
      "networkId" : "8418a18b-cda0-4da4-a495-858a30033c9c",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "f32ce410-7c6d-4fda-bb06-14e04bebea83",
      "userData" : null,
      "locationMetadataId" : "e2db82a6-63d8-47a5-8a4f-95c03b2e85cf",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8418a18b-cda0-4da4-a495-858a30033c9c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/9a4f39d3-adcd-4252-b406-55cd912cc269"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/76987980-9b6c-4c96-8ff6-20669244251f"
        }
      }
    }, {
      "id" : "a6f2ceef-ad7d-4533-9c67-9f18ebf8d2b9",
      "hostId" : "f69f3941-2c5a-4acd-b682-8ae38e6fad10",
      "ownerIdentityId" : "6bdb0aa1-a6ad-4d51-b61f-d3212b7ce1fe",
      "createdBy" : "6bdb0aa1-a6ad-4d51-b61f-d3212b7ce1fe",
      "createdAt" : "2021-05-04T17:09:00.105499Z",
      "updatedAt" : "2021-05-04T17:09:00.105499Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.105363Z",
      "networkId" : "35a73b3e-e218-4b15-8156-abd8c3e78a6d",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "32fa55f5-fd88-4069-ab7e-fc4eadeb88c6",
      "userData" : null,
      "locationMetadataId" : "b24885ca-fecb-43aa-ac2c-10fb9c9aa380",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/35a73b3e-e218-4b15-8156-abd8c3e78a6d",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/a6f2ceef-ad7d-4533-9c67-9f18ebf8d2b9"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/f69f3941-2c5a-4acd-b682-8ae38e6fad10"
        }
      }
    }, {
      "id" : "b2b1dd89-0849-430c-8e91-4e6c08103a77",
      "hostId" : "9db8e1d0-2448-4055-a470-6c55aad5ab4f",
      "ownerIdentityId" : "6f6e96da-0812-4bb9-8e63-061b40643835",
      "createdBy" : "6f6e96da-0812-4bb9-8e63-061b40643835",
      "createdAt" : "2021-05-04T17:09:00.769645Z",
      "updatedAt" : "2021-05-04T17:09:00.769645Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.769518Z",
      "networkId" : "6fdf6236-39cd-4bb5-b79d-b7bbf4258b0b",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "e3ed8d2b-930e-422e-a849-74a625a0710c",
      "userData" : null,
      "locationMetadataId" : "5e416bc9-5b5c-402b-921c-11f7387c1e90",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6fdf6236-39cd-4bb5-b79d-b7bbf4258b0b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/b2b1dd89-0849-430c-8e91-4e6c08103a77"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/9db8e1d0-2448-4055-a470-6c55aad5ab4f"
        }
      }
    }, {
      "id" : "b3aa1112-54cb-4436-a730-3fe3ab764692",
      "hostId" : "98ceb981-4350-4188-94a8-fe21c752a407",
      "ownerIdentityId" : "7f991141-3e1b-4f2a-8a18-dbd02a2bcc62",
      "createdBy" : "7f991141-3e1b-4f2a-8a18-dbd02a2bcc62",
      "createdAt" : "2021-05-04T17:09:00.233329Z",
      "updatedAt" : "2021-05-04T17:09:00.233329Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.233180Z",
      "networkId" : "72b549c6-4734-4cb2-bcf5-ed5ae5d95c2e",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "6695a9df-d106-4f1b-9d98-e28343d8cae7",
      "userData" : null,
      "locationMetadataId" : "7876f2bf-8c79-4907-854d-98ee66a0c9ed",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/72b549c6-4734-4cb2-bcf5-ed5ae5d95c2e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/b3aa1112-54cb-4436-a730-3fe3ab764692"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/98ceb981-4350-4188-94a8-fe21c752a407"
        }
      }
    }, {
      "id" : "bf9d8b9a-3423-4b05-8a3e-0cc77f48b054",
      "hostId" : "426994b4-ef3d-49fa-96da-ca6b4f0f28f9",
      "ownerIdentityId" : "6bdb0aa1-a6ad-4d51-b61f-d3212b7ce1fe",
      "createdBy" : "6bdb0aa1-a6ad-4d51-b61f-d3212b7ce1fe",
      "createdAt" : "2021-05-04T17:09:00.107461Z",
      "updatedAt" : "2021-05-04T17:09:00.107461Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.107334Z",
      "networkId" : "35a73b3e-e218-4b15-8156-abd8c3e78a6d",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "867740b9-e1a7-4f54-bee7-fc65099bd8cc",
      "userData" : null,
      "locationMetadataId" : "5638c6b6-9d3d-43ee-b54a-8b72b2f5c784",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/35a73b3e-e218-4b15-8156-abd8c3e78a6d",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/bf9d8b9a-3423-4b05-8a3e-0cc77f48b054"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/426994b4-ef3d-49fa-96da-ca6b4f0f28f9"
        }
      }
    }, {
      "id" : "cf82d104-88a6-4dbf-a58c-bd412141eaf2",
      "hostId" : "db85034c-2d09-4e6f-811a-06f56217388f",
      "ownerIdentityId" : "28ec4643-88ac-4033-8ad8-ad651792c06d",
      "createdBy" : "28ec4643-88ac-4033-8ad8-ad651792c06d",
      "createdAt" : "2021-05-04T17:09:00.287018Z",
      "updatedAt" : "2021-05-04T17:09:00.287018Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.286888Z",
      "networkId" : "094e661f-91b7-4cbc-9e27-41496b0a437b",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "c45bbb8f-d56a-4d7b-8c10-5fcf3fbd6990",
      "userData" : null,
      "locationMetadataId" : "14735e04-9212-4f1a-8ff6-e7f3aad4c305",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/094e661f-91b7-4cbc-9e27-41496b0a437b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/cf82d104-88a6-4dbf-a58c-bd412141eaf2"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/db85034c-2d09-4e6f-811a-06f56217388f"
        }
      }
    }, {
      "id" : "d477b2cf-7bc0-42ea-9d09-991b5b0078af",
      "hostId" : "e20e8c35-0e80-418d-96e7-ec87cf143143",
      "ownerIdentityId" : "f2d9bdc3-2101-4249-bd79-d72a3b5c6883",
      "createdBy" : "f2d9bdc3-2101-4249-bd79-d72a3b5c6883",
      "createdAt" : "2021-05-04T17:08:59.967903Z",
      "updatedAt" : "2021-05-04T17:08:59.967903Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:08:59.967723Z",
      "networkId" : "e9c0bfc0-814f-4a49-a630-be6e55539185",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "6e9df613-d256-4dcb-a39b-531fc410de3f",
      "userData" : null,
      "locationMetadataId" : "6bb16a33-b10e-49e8-8b9f-e412124fabab",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e9c0bfc0-814f-4a49-a630-be6e55539185",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/d477b2cf-7bc0-42ea-9d09-991b5b0078af"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/e20e8c35-0e80-418d-96e7-ec87cf143143"
        }
      }
    }, {
      "id" : "d5db2bf4-6695-4468-9dda-7ee302dde8a2",
      "hostId" : "32c20b1a-c908-45fa-89f0-7ad1f3043169",
      "ownerIdentityId" : "5951ad06-2526-409f-ad64-7ba8f2abb846",
      "createdBy" : "5951ad06-2526-409f-ad64-7ba8f2abb846",
      "createdAt" : "2021-05-04T17:09:00.068298Z",
      "updatedAt" : "2021-05-04T17:09:00.068298Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.068130Z",
      "networkId" : "b4afd8b7-305b-4cbc-9e85-c9999d700003",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "49c9ce9b-83ff-44d6-b95f-c452700d2498",
      "userData" : null,
      "locationMetadataId" : "c5185b1c-be6a-4a14-bcb2-95cdb8590b7a",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b4afd8b7-305b-4cbc-9e85-c9999d700003",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/d5db2bf4-6695-4468-9dda-7ee302dde8a2"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/32c20b1a-c908-45fa-89f0-7ad1f3043169"
        }
      }
    }, {
      "id" : "de0c64ad-10ad-4d7b-9afd-007fc9ec6e9e",
      "hostId" : "80a81fca-5159-42ad-ab38-29066d1b02cc",
      "ownerIdentityId" : "c297d0d7-b442-41f5-969e-c1a0d275678a",
      "createdBy" : "c297d0d7-b442-41f5-969e-c1a0d275678a",
      "createdAt" : "2021-05-04T17:09:00.650156Z",
      "updatedAt" : "2021-05-04T17:09:00.650156Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.650030Z",
      "networkId" : "2aea320a-933e-4e64-ba5d-5f503f5396f2",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "6c677bd8-d8d3-455a-8d58-81ca6e18082b",
      "userData" : null,
      "locationMetadataId" : "5c027610-63c5-45ca-ba94-bf5cf6656b36",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2aea320a-933e-4e64-ba5d-5f503f5396f2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/de0c64ad-10ad-4d7b-9afd-007fc9ec6e9e"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/80a81fca-5159-42ad-ab38-29066d1b02cc"
        }
      }
    }, {
      "id" : "e271c95c-ec38-4033-b364-fc7d45c2b21c",
      "hostId" : "c57469cd-0e24-4b86-ad67-cf4d1c683429",
      "ownerIdentityId" : "7f991141-3e1b-4f2a-8a18-dbd02a2bcc62",
      "createdBy" : "7f991141-3e1b-4f2a-8a18-dbd02a2bcc62",
      "createdAt" : "2021-05-04T17:09:00.235455Z",
      "updatedAt" : "2021-05-04T17:09:00.235455Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-05-04T17:09:00.235284Z",
      "networkId" : "72b549c6-4734-4cb2-bcf5-ed5ae5d95c2e",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "d4d0d007-a0e4-40ca-a323-0945ffc6b4c9",
      "userData" : null,
      "locationMetadataId" : "d71eb1f2-c2ad-4980-9a42-4ee093aa582b",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/72b549c6-4734-4cb2-bcf5-ed5ae5d95c2e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/e271c95c-ec38-4033-b364-fc7d45c2b21c"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/c57469cd-0e24-4b86-ad67-cf4d1c683429"
        }
      }
    }, {
      "id" : "f13397ec-1c90-4288-b4e7-f11e09606077",
      "hostId" : "80e0b010-fa9a-4db6-b066-5d959faa06d1",
      "ownerIdentityId" : "6f6e96da-0812-4bb9-8e63-061b40643835",
      "createdBy" : "6f6e96da-0812-4bb9-8e63-061b40643835",
      "createdAt" : "2021-05-04T17:09:00.770646Z",
      "updatedAt" : "2021-05-04T17:09:00.770646Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.770526Z",
      "networkId" : "6fdf6236-39cd-4bb5-b79d-b7bbf4258b0b",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "0398bb2b-813e-418d-bd47-6ba00097f287",
      "userData" : null,
      "locationMetadataId" : "14e688c1-2d21-4cfb-baa2-726ffa9b1e54",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6fdf6236-39cd-4bb5-b79d-b7bbf4258b0b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/f13397ec-1c90-4288-b4e7-f11e09606077"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/80e0b010-fa9a-4db6-b066-5d959faa06d1"
        }
      }
    }, {
      "id" : "f1c27244-b4d4-451f-a969-1822b74fd7d5",
      "hostId" : "df171ad4-ee54-4b4b-b767-b74a2ff0f809",
      "ownerIdentityId" : "f2d9bdc3-2101-4249-bd79-d72a3b5c6883",
      "createdBy" : "f2d9bdc3-2101-4249-bd79-d72a3b5c6883",
      "createdAt" : "2021-05-04T17:08:59.969534Z",
      "updatedAt" : "2021-05-04T17:08:59.969534Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:08:59.969391Z",
      "networkId" : "e9c0bfc0-814f-4a49-a630-be6e55539185",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "fced6efa-34bb-414d-b4ec-706a22a25502",
      "userData" : null,
      "locationMetadataId" : "b09118f7-9b6a-456a-81c3-0e6c380ecc9a",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e9c0bfc0-814f-4a49-a630-be6e55539185",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/f1c27244-b4d4-451f-a969-1822b74fd7d5"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/df171ad4-ee54-4b4b-b767-b74a2ff0f809"
        }
      }
    }, {
      "id" : "f9edc2c9-8409-4b18-bcff-5c633cd2db52",
      "hostId" : "56b085be-63a4-47a1-bd60-7618e5645c2e",
      "ownerIdentityId" : "7f991141-3e1b-4f2a-8a18-dbd02a2bcc62",
      "createdBy" : "7f991141-3e1b-4f2a-8a18-dbd02a2bcc62",
      "createdAt" : "2021-05-04T17:09:00.234401Z",
      "updatedAt" : "2021-05-04T17:09:00.234401Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-05-04T17:09:00.234249Z",
      "networkId" : "72b549c6-4734-4cb2-bcf5-ed5ae5d95c2e",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "8bd719cb-1b21-474f-9017-c755159807c4",
      "userData" : null,
      "locationMetadataId" : "37813154-5a30-4add-9296-ca00b6269e4b",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/72b549c6-4734-4cb2-bcf5-ed5ae5d95c2e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/f9edc2c9-8409-4b18-bcff-5c633cd2db52"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/56b085be-63a4-47a1-bd60-7618e5645c2e"
        }
      }
    }, {
      "id" : "fa209a43-481d-4718-ab5c-2fc1e286f4e6",
      "hostId" : "9e4df1f3-71bd-485a-8161-8b22f8371a9d",
      "ownerIdentityId" : "0e1c4073-660e-4620-8abb-a039379df6f8",
      "createdBy" : "0e1c4073-660e-4620-8abb-a039379df6f8",
      "createdAt" : "2021-05-04T17:09:00.500140Z",
      "updatedAt" : "2021-05-04T17:09:00.500140Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-05-04T17:09:00.500008Z",
      "networkId" : "5c5cad2d-ea8d-4731-a955-91b988c9373e",
      "jwt" : null,
      "linkListener" : true,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "provider" : "AWS",
      "ipAddress" : "1.2.3.4",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "02968f4a-355d-4d80-9d0e-2c5ae857529b",
      "userData" : null,
      "locationMetadataId" : "a8e4f4e8-9b1d-4c6e-a2b2-ede48fd91991",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5c5cad2d-ea8d-4731-a955-91b988c9373e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/fa209a43-481d-4718-ab5c-2fc1e286f4e6"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/9e4df1f3-71bd-485a-8161-8b22f8371a9d"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 41,
    "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

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

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

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

provider

String

true

ipAddress

String

true

providerId

String

true

dataCenterId

String

true

userData

String

true

locationMetadataId

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/edge-routers/428d404b-7b51-4206-beb0-a3d10ab3ae6d' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJxdHdrc1ZBYUhib1pIS1ZJWEpwZFlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImExMjM4NzFhLTk3ZmEtNDc1ZC1hM2M4LWVjNmRmOTNmY2YxZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE0MCwiZXhwIjoxNjIwMTUxNzQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE5MWNjYjZmLWVhMGQtNGNiMC1iNzlhLWNiMTc0ZDI2NTc1MlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.qY95EjC6nEh3TGYBrP1qyCGm5KHraHAF_x4mpquXgQ039QQrTBGjZCS_50VaQXfeGQJ1ElinBkDHW_wHhLp3d4c76VWcvY76_YLZGZjDGPcRJQkqGfXFmqO1nHWjECMhYT2TQX5o0mvQnK6dsr9wJhgot6A8dO9DEtG6xJrzOP34ddz6x0CGmsqxN_h9t_5YqNUK52uISLWB5SMpRiD5KPtBh7ybLbsP5eBQ3phUrtMinr5m7zog65nNo0yyPri0Kq2UBjqUpw54NIa2DZTQhroKbT2rAKFLQNBZNRjgel_OY6YEi2-WJZGlhfgjTweOkFgE-iZaxbo4wRpo3bUHKQ'

Example response

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

{
  "id" : "428d404b-7b51-4206-beb0-a3d10ab3ae6d",
  "hostId" : "cbfa39f2-8067-4a56-8491-7f42da6013c4",
  "ownerIdentityId" : "0c5391e6-5d1d-4d0b-8080-6d99a1e30079",
  "createdBy" : "0c5391e6-5d1d-4d0b-8080-6d99a1e30079",
  "createdAt" : "2021-05-04T17:09:00.915414Z",
  "updatedAt" : "2021-05-04T17:09:00.915414Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "zitiEdgeRouterId01",
  "name" : "ACME_edge_router_2021-05-04T17:09:00.915288Z",
  "networkId" : "20c55e0e-024c-4dc8-a547-6267bfe87142",
  "jwt" : null,
  "linkListener" : true,
  "online" : false,
  "verified" : true,
  "status" : "PROVISIONING",
  "attributes" : [ ],
  "provider" : "AWS",
  "ipAddress" : "1.2.3.4",
  "providerId" : "i-89hawe3asdfew",
  "dataCenterId" : "de6e1fa5-6e69-4db5-8c3e-31862112f704",
  "userData" : null,
  "locationMetadataId" : "6709ce53-1a73-4345-ae65-3ccca269c388",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/20c55e0e-024c-4dc8-a547-6267bfe87142",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/428d404b-7b51-4206-beb0-a3d10ab3ae6d"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/cbfa39f2-8067-4a56-8491-7f42da6013c4"
    }
  }
}

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.

attributes

Array[String]

true

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

Response fields

Path

Type

Optional

Description

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

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

provider

String

true

ipAddress

String

true

providerId

String

true

dataCenterId

String

true

userData

String

true

locationMetadataId

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/edge-routers/' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiM0dRQm8xRzBIUG4yMXBvbEJtSjVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY5NTkxMjU0LTY4YzMtNDc1Mi05MGMxLTQyZDkwNWRkNWE4OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE0MCwiZXhwIjoxNjIwMTUxNzQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE3YjJkMGEyLWZiN2EtNDQ1Ni1iMWQ0LWQ2ODY5YTIzMzQzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ROywqlu1WTWydeyElDam-p-L2mDymVNYhpJCKCNLEsF47PLMZVst7-kktHSTOltXX0RN2rF04H7Fd6ZlKXxvQnp4mYFTuPVk7SvywKwvUS04LfS7Gtrhy368kvN8MAZG73yT-xuzLngd6yvPaLSfdUXXliwsV-sdUMIQMLiCNWetrFQDODWGmDxA4BARtf12gs6tYTvIhEg1wdek8FtJ4pxRI9hhyTqg2QjtnjPT9iajU1wzU2L3percITndWXLJjrhij37VKNvOp_z_xkQWPfGXo0BhKJnYRaBNpZxxBab9ZvJUyN1abHAWbkjpVzyFc5FFCWw6hDFsJ7nOEt3f_w' \
    -d '{"name":"Test edge router 1620148140","networkId":"f7e393b4-bf68-452a-a4e4-cd6e5840367b","dataCenterId":"5ba3bd60-702d-4c4e-a4a3-bb683c6ea4dd","linkListener":false,"attributes":[]}'

Example response

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

{
  "id" : "00550a25-9bed-41fb-9eba-cc37971eb12e",
  "hostId" : null,
  "ownerIdentityId" : "69591254-68c3-4752-90c1-42d905dd5a88",
  "createdBy" : "69591254-68c3-4752-90c1-42d905dd5a88",
  "createdAt" : "2021-05-04T17:09:00.428655Z",
  "updatedAt" : "2021-05-04T17:09:00.428655Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : null,
  "name" : "Test edge router 1620148140",
  "networkId" : "f7e393b4-bf68-452a-a4e4-cd6e5840367b",
  "jwt" : null,
  "linkListener" : false,
  "online" : false,
  "verified" : false,
  "status" : "NEW",
  "attributes" : [ ],
  "provider" : null,
  "ipAddress" : null,
  "providerId" : null,
  "dataCenterId" : null,
  "userData" : null,
  "locationMetadataId" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f7e393b4-bf68-452a-a4e4-cd6e5840367b",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/00550a25-9bed-41fb-9eba-cc37971eb12e"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/f505245d-e836-49d4-ab64-39c05f763058",
      "profile" : "meta"
    }
  }
}

Patch Edge Router

PATCH /edge-routers/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

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

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

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

provider

String

true

ipAddress

String

true

providerId

String

true

dataCenterId

String

true

userData

String

true

locationMetadataId

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/edge-routers/2ee80afe-1062-4b03-9b61-aee7f24bf3b1' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJCX3JuU21CdnAyQkRLYWk2X2dqTWpBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM3MDE1ZTQwLWEyN2UtNGIwYi1hN2JmLWYzZThjNGYwNTAzYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE0MCwiZXhwIjoxNjIwMTUxNzQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk4ZWY3ZTAxLTI4NzgtNGZmMi1hMTlkLTM3YWEyZTZjZTllYVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Us4j9Uf_K0u_NvmfLpzuzrZuQLhUPdTY7bjlqHQ8aYp8WMUmJFqd5IDKXGN9zjFnr-iFT6dI_0HP2w-c44Y2nTD51Qkm6ZQE6OqwCovNWeKy2K8k0TLrfVxCZfBJOpIYddWLiW63EaBTVn5hhXjVZfarguhkQ51h9Q9G9MOpvoB84UQB8tjye9Z0GtQUiM49RkA9autiXqEz_dcqEY2_Ar_NFh3gE2CuwopPArUzCn6ex2GNyim_27XVjUbMSCwCV4FkcuSMjqxz2n9c_dHP9sF-XCPj8fESvQGmVV9b_jHFmVu02A5d4cUPNHtTR9T-Onv1qmk4nItCfllMxeoMOA' \
    -d '{"name":"Updated name"}'

Example response

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

{
  "id" : "2ee80afe-1062-4b03-9b61-aee7f24bf3b1",
  "hostId" : "7d5afd19-d0ff-4f33-bfeb-de025ac28fd9",
  "ownerIdentityId" : "7bd324d5-0abc-41b8-aa67-6b4d52ddb0e5",
  "createdBy" : "7bd324d5-0abc-41b8-aa67-6b4d52ddb0e5",
  "createdAt" : "2021-05-04T17:09:00.869207Z",
  "updatedAt" : "2021-05-04T17:09:00.880530Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "zitiEdgeRouterId01",
  "name" : "Updated name",
  "networkId" : "05816234-7aa8-406a-856a-9dd2ff4de89c",
  "jwt" : null,
  "linkListener" : true,
  "online" : false,
  "verified" : true,
  "status" : "PROVISIONING",
  "attributes" : [ ],
  "provider" : "AWS",
  "ipAddress" : "1.2.3.4",
  "providerId" : "i-89hawe3asdfew",
  "dataCenterId" : "b62f4e62-32ac-4d33-aac8-54dfc91e4518",
  "userData" : null,
  "locationMetadataId" : "af53e327-e133-4583-ad42-5dd1731adb83",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/05816234-7aa8-406a-856a-9dd2ff4de89c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/2ee80afe-1062-4b03-9b61-aee7f24bf3b1"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/7d5afd19-d0ff-4f33-bfeb-de025ac28fd9"
    }
  }
}

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

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

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

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

provider

String

true

ipAddress

String

true

providerId

String

true

dataCenterId

String

true

userData

String

true

locationMetadataId

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/edge-routers/085f3071-4b67-46d2-9d91-ab954d0e8f1f' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJEazlYR29jVVZPYkZNZmctQmFWRTNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZjNTJhZGJiLTkyOTMtNDgwNi05NmM1LWVmMmQ4OTQwYjY4MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE0MCwiZXhwIjoxNjIwMTUxNzQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFjYWI3ZDc1LTdkMTQtNDllMy04MDFkLTViOTdmMThmZjBhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.j3wkxfupZb2pWJC2vXaNVuU-rFx_AP_lQuBg9MZakzBd4-f-f00MyPpYexnwEop76isX6iAGeIrVi15me6kMYpLVHoOKvypUU6HyUt_zkwUpzB0NPXS_Z7y25uHwY90I4DMjQfkWZrr9wS9wPirVKs1J5fRwkwQIJx6CnaQYcEGRtNu9UkX7qmbQY06tRaVMCREnKVvhFlQ6CEC0jWFawmBkvaHSsM8YtA76H4giRfO2B5vl0V0oDnJTO05pZs-mzvJsK4sIAXLf8B2RYrBWdDkJtdFOqJvYPQ_v5_CzQrtjmPu7Kagfz_ymUCVljSkiEqM6vxezpAxkAcziYdlarQ'

Example response

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

{
  "id" : "085f3071-4b67-46d2-9d91-ab954d0e8f1f",
  "hostId" : "c29f51fe-e6b6-4c84-9f5f-93c2c9d3b8d8",
  "ownerIdentityId" : "c297d0d7-b442-41f5-969e-c1a0d275678a",
  "createdBy" : "c297d0d7-b442-41f5-969e-c1a0d275678a",
  "createdAt" : "2021-05-04T17:09:00.649135Z",
  "updatedAt" : "2021-05-04T17:09:00.666066Z",
  "deletedBy" : "6c52adbb-9293-4806-96c5-ef2d8940b680",
  "deletedAt" : null,
  "zitiId" : "zitiEdgeRouterId02",
  "name" : "ACME edge router 02 2021-05-04T17:09:00.648995Z",
  "networkId" : "2aea320a-933e-4e64-ba5d-5f503f5396f2",
  "jwt" : null,
  "linkListener" : true,
  "online" : false,
  "verified" : true,
  "status" : "DELETING",
  "attributes" : [ ],
  "provider" : "AWS",
  "ipAddress" : "1.2.3.4",
  "providerId" : "i-89hawe3asdfew",
  "dataCenterId" : "5da5e306-b515-46cb-a78f-7bd9b85afd7b",
  "userData" : null,
  "locationMetadataId" : "339a43b5-2e16-4b6f-870f-283b6ee52cc8",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2aea320a-933e-4e64-ba5d-5f503f5396f2",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/085f3071-4b67-46d2-9d91-ab954d0e8f1f"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/18b80d68-26e5-4c77-9ca9-5797f19854f3",
      "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

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

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.eyJqdGkiOiJTdF9PeTg2aEN4VHBTeFV1c0Fha1Z3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBjMDM3MGY0LTMxMzAtNDgxYy04NDU5LTJlYWViNTk3ZjU4YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA1NSwiZXhwIjoxNjIwMTUxNjU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI3MTAwNjI1LTgzMDAtNDQ5ZC1hOTQwLTVkOTZjNjczOWQxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA1NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.DV_FpT_WOZUs5YUgtoAeYl9FWLqSXgIyHB63b60VTQnuV3xdCWDrXIDYBIyx4OS2Vg-g4CADVB462Wnc2NIV04n0B-ICgdLUywPc8czue0FJf9kaRmxFRRu8OGtbS7QE1IygJkl_q9OntLz1RF867m9tJKIqU9S9Zw4B2F9eXvWfMn301M6CPc2xMlDA9vDUo4ve8G4yMDszY5arUr8BAgZMEXV65DST1BRFdQ6fk_JPIpJ2Mp3uNyW6F1KBVYSguRkrIaoaqMiPv2C-iz1HimA16RoIY-wlYcLzwmMt1l3vKvFy_Fc7taqPqMOGyKBIvXJUGUYClfkSZTH5gY7DcQ'

Example response

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

{
  "_embedded" : {
    "edgeRouterPolicyList" : [ {
      "id" : "8685e400-e606-4430-88ed-d005ea2dc562",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:07:35.922720Z",
      "updatedAt" : "2021-05-04T17:07:35.922720Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "eadbdf5a-1a84-44bf-b39b-64c0b99615bd",
      "zitiId" : "65f7c21f-689f-4184-b654-c493892d12d2",
      "name" : "ACME edge router policy 2021-05-04T17:07:35.922551Z",
      "endpointAttributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/eadbdf5a-1a84-44bf-b39b-64c0b99615bd",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/8685e400-e606-4430-88ed-d005ea2dc562"
        }
      }
    } ]
  },
  "_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

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

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/7e07ac90-19f6-422b-b315-4288251e204d' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhaGV1S0pIdmdiWUN0S3lXNnZ1N0N3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY0NGIwNTE5LTViODktNGFjOS1iMTZkLTNiMGFjYjBiNmNkMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA1NiwiZXhwIjoxNjIwMTUxNjU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVkY2VmMDcwLWU2MmQtNDI0NC05OGVmLWY2NGFkNTIxNTc1ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA1Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.cZMnwbMa0NFjBZ-8vzmJgo_tivBQQ94bZ3h2da2bm_WR3jEOVqG7Ei5P4edb9Dh8zOpaa8ipky1-_12up-XtWPQnP48LM6xaR0Jo9SpBA1yqAwB-rrrR6Uh39zD--7eILNGnoeEqDc28XOrEeZd-JCWvQOmo0Wlj9Z3wN1o1FFYXIpZInRa_T4AVl1O-5f7oXTIUhjyGRHu7H6LTabNL0bBvLUezDw8F_PvmTZY-m7HsyxJLChIPPW9QkKe3wWdMqsVa3RuQfGnGxs17JQTV5QGv4tzbeg03gu6gBZ3IrqOhCipsHDwDn1xczsIT90epIEE5AHobzM1ChJ3pVPA0yA'

Example response

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

{
  "id" : "7e07ac90-19f6-422b-b315-4288251e204d",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-05-04T17:07:36.069040Z",
  "updatedAt" : "2021-05-04T17:07:36.069040Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "3a54563e-50b5-449f-81f8-f1370160a70c",
  "zitiId" : "6990c14f-06b3-45f9-baa6-f72ecb894313",
  "name" : "ACME edge router policy 2021-05-04T17:07:36.068915Z",
  "endpointAttributes" : [ ],
  "edgeRouterAttributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3a54563e-50b5-449f-81f8-f1370160a70c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/7e07ac90-19f6-422b-b315-4288251e204d"
    }
  }
}

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

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.eyJqdGkiOiJTTVBJM2ZlVE5RcWdqbFByU2NmQTV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZlMTNkN2MxLWQ5MDktNDI4MC1iODlkLWNhNDAyMDAzZTBlYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA1NiwiZXhwIjoxNjIwMTUxNjU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM1Y2E1MzZjLTBkY2MtNDVlOS1iNGZiLWZmOWI0NTMyZmM0ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA1Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ViotkY-Lw_bubxbfMn3nULPl1ZAFsSTOfSFo4UVDRGYsNej8vDVGsybHzg2eGhkE0ZXOkhvHZSUO-HFdZFshEBEqIGkf1BGXL4nGhxMJHmUW1YxCMrJ4mnyzGIZxUPyf3SaLA0ifSqvNXHU2hCaT3tXxIB8YYgqndyV_xAyl7Wf29TGs5NWLNaOEEV8_QWFijUX8c1-0-EfyuVuDPDWc_tXF58QzPkmU_zOFwPM0uQrPJywcRBngqv1ItsQX3CgaNGIQR1WQXwQX8EH2SbnWU8bu6lIA3ifxMyqXUYMgAFaM9yuXp-jfpizLj0i4gltcmLfkGdZyOIrN3jFVZ0vrQA' \
    -d '{"name":"Test edge router policy 1620148055","networkId":"dfd43a42-5dc4-4fb1-881a-f45407fcfb05","endpointAttributes":["#topclients"],"edgeRouterAttributes":["#westrouters","@ACME_edge_router_2021-05-04T17:07:35.986548Z"]}'

Example response

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

{
  "id" : "2d923b1e-6124-4cdf-8b96-8c250b98bdb8",
  "ownerIdentityId" : "fe13d7c1-d909-4280-b89d-ca402003e0ec",
  "createdBy" : "fe13d7c1-d909-4280-b89d-ca402003e0ec",
  "createdAt" : "2021-05-04T17:07:36.026411Z",
  "updatedAt" : "2021-05-04T17:07:36.029800Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "dfd43a42-5dc4-4fb1-881a-f45407fcfb05",
  "zitiId" : "3eab2f4f-653e-423f-942d-07de2a483f65",
  "name" : "Test edge router policy 1620148055",
  "endpointAttributes" : [ "#topclients" ],
  "edgeRouterAttributes" : [ "#westrouters", "@ACME_edge_router_2021-05-04T17:07:35.986548Z" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dfd43a42-5dc4-4fb1-881a-f45407fcfb05",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/2d923b1e-6124-4cdf-8b96-8c250b98bdb8"
    }
  }
}

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

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

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/877462fb-0e6d-4324-ac39-09f888a9e0e5' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1eHVLMkEtelRrOE5LemJUQXp0WlZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk4NTQ5ZjNjLTI1ZjItNDc3Zi1hMTFhLTVkNjZlNjUxY2YzNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA1NiwiZXhwIjoxNjIwMTUxNjU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImMzZTgwNTkzLTM4NTQtNGY1YS05MTdiLWQ5Yzc0NDc5ZmVjZlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA1Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jeBBvdyQfrEAXkrzvUsCrx-HT8_xWX-4u8rkFvfU5NNw6aHZyQj3xHlSU52vI1i30j_Oe1TFg-cNqWgBi6g2doku5k8RdlTkmMQx32cNvWeeAwUx_AhRafCModboxdtWPfgPtN1XrXde5LzUoXrlzXYQSMdc3XjhSfHf9bxRPkFgbGHjBUsjE0J14Qwbl8Tbc4GkjxM9TmsbyR0sWyGig54xaw7uyn4z5s_xcR-Hnq7JCGzZ6s6h3xF6CEOqqBJ9yrNsRjN4M6aXZUE3ccCQrcjgORW2cbory5VkuguPh_hMAnof3qvb94vI6yjHrKP0R7XahKhlLFJniS8kWEiL-g' \
    -d '{"name":"Updated edge router policy name","networkId":"bbece7e5-05e9-4f7e-bf14-b47ab0d07fb9","endpointAttributes":["#useastrouters"],"edgeRouterAttributes":["#usendpoints"]}'

Example response

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

{
  "id" : "877462fb-0e6d-4324-ac39-09f888a9e0e5",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-05-04T17:07:36.297382Z",
  "updatedAt" : "2021-05-04T17:07:36.309561Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "bbece7e5-05e9-4f7e-bf14-b47ab0d07fb9",
  "zitiId" : "c9e58bf5-2331-4ba3-91ff-350b2baacdec",
  "name" : "Updated edge router policy name",
  "endpointAttributes" : [ "#useastrouters" ],
  "edgeRouterAttributes" : [ "#usendpoints" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bbece7e5-05e9-4f7e-bf14-b47ab0d07fb9",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/877462fb-0e6d-4324-ac39-09f888a9e0e5"
    }
  }
}

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

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/ba77278b-a5cd-44e2-a9d5-f38b4061e4ce' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJYcnhnYnFKVk1IWjh5WTlSMVR4aGJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg2NGE4ZjUwLTZmNDAtNDQxMS04MDllLWNlODA3NzdjYTg2OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA1NiwiZXhwIjoxNjIwMTUxNjU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjEzMTJhZTJiLTdkZTktNDNjNS1iZjI1LWZhMTY2N2M5MGJhYlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA1Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.UVxxEvER_r3N9QOxN_ukNiVpjBLnAEwKSTg6w2bd4N62-3-LdH0QWeXzw5dz1dX0Oq6sZGQ__x0U5wMtZwZrt2npbk5dvwgY2H1zwjMMTQXfFjmhCYr5FSQpPvcCon70F2xPJWWhd2kpj18itqwby2g6uoE5FsqT1KqCXPEOWBakNUVYh_tKLJFxsnnk2FSRQA9atvr9kncjqD5FRh4npiF3dEDYYCCNaK9mYoxjWLSHWPVARTmiG346Yf2IcrBD8eGv94SY2HeFncRZcqfTaNToga8ClnBDVV8q0w0C4A69ZsbDJfM_23LwLFE1O5FB1fMqxEUyrenGfoZiTvaFPg'

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].

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

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].

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

String

false

networkId

String

false

zitiId

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

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

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.eyJqdGkiOiIwYUFWMGtZY2gtRHFPT25UanVtNVR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc1MWUyZmIxLWIxMDYtNGFkYi1hYTJlLWNjMzZkODM3YWFkMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODAxMCwiZXhwIjoxNjIwMTUxNjEwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImVkMzcyMmRjLWViOWMtNGVhMS1iZWNlLTkxODYwNzNjZjQzMFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODAxMH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.py5og2mgVJi1SK45Yp9HetE8fzV44xaGKnd5m7tQlXfAg2QnuU8rixOyqRJq7-rk1EK73i686dK_Fzj32CIt7Is5PGmtsbv53rEYfHA5VCq-5cjmueWQZBC6kjQhrKn7CTfnsCMYB6UaLEWtuTsX_ZDbRpyhuxm6IuAbNEriy7KPW9NUxKDnC5o2R4JHvzkaefySXv8_yIRa38PtF-ezMpFn-TQSL0Cmr_Vz6iu6GxvwkIa086yQUu_fh_hXJdL0-nHBBxUQ1IMQGea2S4Z7AGgtjX5B9841M0Won_Gv1xzLy4hcnmzMeX5M-7-WzOFpaB6BaNiclNoYsdI3-8YXXA'

Example response

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

{
  "_embedded" : {
    "serviceList" : [ {
      "id" : "00df4f42-dc4a-461f-aeff-511dbce97ea7",
      "networkId" : "5689a7c5-add5-48df-84b3-20a255464921",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.632266Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "c018640a-5edd-4c12-8918-7b100dd8d08e",
      "createdBy" : "83c54f9c-103b-4b31-aa26-88fb68729fca",
      "createdAt" : "2021-05-04T17:06:50.632408Z",
      "updatedAt" : "2021-05-04T17:06:50.632408Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5689a7c5-add5-48df-84b3-20a255464921",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/00df4f42-dc4a-461f-aeff-511dbce97ea7"
        }
      }
    }, {
      "id" : "0b5aed69-ffad-4548-ae8f-f13cb8d29c17",
      "networkId" : "1d54b5ee-8cb0-4c72-aa93-2a17260f6484",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.530678Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "cb2e0c57-a31f-40cc-b991-8ae8c28adc72",
      "createdBy" : "158b79ab-8820-4b2b-b3fb-1f9a8f4ae6ca",
      "createdAt" : "2021-05-04T17:06:50.530819Z",
      "updatedAt" : "2021-05-04T17:06:50.530819Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1d54b5ee-8cb0-4c72-aa93-2a17260f6484",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/0b5aed69-ffad-4548-ae8f-f13cb8d29c17"
        }
      }
    }, {
      "id" : "41ff29f9-b50b-4c74-8ec0-2fb59ee6911c",
      "networkId" : "4678f3d8-5d6c-48cf-b343-a445d58d44d1",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.418489Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "2f295c28-c315-44b5-9336-f9acce74faf9",
      "createdBy" : "ec73b4a8-5027-4755-ba6a-e6c5c7ae9fb7",
      "createdAt" : "2021-05-04T17:06:50.418714Z",
      "updatedAt" : "2021-05-04T17:06:50.418714Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4678f3d8-5d6c-48cf-b343-a445d58d44d1",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/41ff29f9-b50b-4c74-8ec0-2fb59ee6911c"
        }
      }
    }, {
      "id" : "6c01de27-b5e6-4949-9c7c-56eada6f2175",
      "networkId" : "7efadf52-29e8-4433-90c4-f65058d967c0",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.580602Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "6c84d888-9f9e-4874-bd5b-304de618db1e",
      "createdBy" : "c3319a62-7df3-47b3-8393-e4a9d1c2217f",
      "createdAt" : "2021-05-04T17:06:50.580748Z",
      "updatedAt" : "2021-05-04T17:06:50.580748Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/7efadf52-29e8-4433-90c4-f65058d967c0",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/6c01de27-b5e6-4949-9c7c-56eada6f2175"
        }
      }
    }, {
      "id" : "6f38acf6-8c72-43b5-8251-23e98030de9e",
      "networkId" : "4aad5ed4-bb92-474f-a508-bbe036dcaaab",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.829251Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "6ab951e7-1979-4ae7-ad7f-9736ed1853a2",
      "createdBy" : "da2e1700-4f05-4ba4-8fee-567c7da4b1ad",
      "createdAt" : "2021-05-04T17:06:50.829400Z",
      "updatedAt" : "2021-05-04T17:06:50.829400Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4aad5ed4-bb92-474f-a508-bbe036dcaaab",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/6f38acf6-8c72-43b5-8251-23e98030de9e"
        }
      }
    }, {
      "id" : "81ba53e5-6078-4983-9a00-52153ee9c229",
      "networkId" : "71404ee9-2a0d-4073-bf90-18ba2d950059",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.299831Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "b4a32603-77a0-4782-a6f7-d2b740dfb1ef",
      "createdBy" : "455e5188-f57c-4683-a009-933b726468c8",
      "createdAt" : "2021-05-04T17:06:50.299977Z",
      "updatedAt" : "2021-05-04T17:06:50.299977Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/71404ee9-2a0d-4073-bf90-18ba2d950059",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/81ba53e5-6078-4983-9a00-52153ee9c229"
        }
      }
    }, {
      "id" : "86fbdfdf-c2fb-4570-8a68-1962f97bf167",
      "networkId" : "ab573227-a622-4d7a-b587-27a32ff2ff82",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.933537Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "6fe0e917-678f-4f9e-8e32-ec1f765e2fc8",
      "createdBy" : "6b07cbb2-0a62-42c2-a17b-babef440d94e",
      "createdAt" : "2021-05-04T17:06:50.933679Z",
      "updatedAt" : "2021-05-04T17:06:50.933679Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ab573227-a622-4d7a-b587-27a32ff2ff82",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/86fbdfdf-c2fb-4570-8a68-1962f97bf167"
        }
      }
    }, {
      "id" : "b3aeb56e-16f8-4148-a417-3f6fe7d95d7c",
      "networkId" : "a24d1e11-5146-463c-b3d5-ec7f1708345f",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.477055Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "3a2ba2a6-f7f2-48f5-a50d-02f06e4364c8",
      "createdBy" : "7208cb93-3011-4006-9ed8-81b5f41eb453",
      "createdAt" : "2021-05-04T17:06:50.477198Z",
      "updatedAt" : "2021-05-04T17:06:50.477198Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a24d1e11-5146-463c-b3d5-ec7f1708345f",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/b3aeb56e-16f8-4148-a417-3f6fe7d95d7c"
        }
      }
    }, {
      "id" : "b46e497e-0718-4b49-8474-a942a22bed80",
      "networkId" : "4f3d556a-20d9-4065-952d-13cf136d2114",
      "zitiId" : "ziti-id-0",
      "name" : "Find Test Service",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "33e680c8-df57-46ae-855f-5b5f0922245d",
      "createdBy" : "25223bb4-b518-4267-889b-37f8e7e36d5f",
      "createdAt" : "2021-05-04T17:06:50.269185Z",
      "updatedAt" : "2021-05-04T17:06:50.269185Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4f3d556a-20d9-4065-952d-13cf136d2114",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/b46e497e-0718-4b49-8474-a942a22bed80"
        }
      }
    }, {
      "id" : "b64c61b5-0c5d-4465-b4ae-e6b9bf0246f8",
      "networkId" : "1740ffed-1b2c-41fa-8faa-72f89e7d5960",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.681041Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "d26dbb4f-c460-4fbc-8878-4cfd9113b110",
      "createdBy" : "e30d8f49-adee-4a48-acda-054d598b268b",
      "createdAt" : "2021-05-04T17:06:50.681184Z",
      "updatedAt" : "2021-05-04T17:06:50.681184Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1740ffed-1b2c-41fa-8faa-72f89e7d5960",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/b64c61b5-0c5d-4465-b4ae-e6b9bf0246f8"
        }
      }
    }, {
      "id" : "bc93a98f-bb31-4d03-9778-0e0a097ff413",
      "networkId" : "404e6d57-6905-4907-8187-bfa57b733dec",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.781065Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "d8d083eb-4eb0-482f-8d9e-ce18ac3fbef7",
      "createdBy" : "5e074737-94a3-464f-bb24-0e3be77208b2",
      "createdAt" : "2021-05-04T17:06:50.781213Z",
      "updatedAt" : "2021-05-04T17:06:50.781213Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/404e6d57-6905-4907-8187-bfa57b733dec",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/bc93a98f-bb31-4d03-9778-0e0a097ff413"
        }
      }
    }, {
      "id" : "c37b4dca-70c7-4dd4-91c4-658f9ecff5e0",
      "networkId" : "56c9be54-46e2-4762-be75-510d2163252c",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.731922Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "1d9e5445-b4bd-46f4-9e02-bdf72fe96293",
      "createdBy" : "8c747622-40c5-441a-bd3b-e0ec4d51322b",
      "createdAt" : "2021-05-04T17:06:50.732063Z",
      "updatedAt" : "2021-05-04T17:06:50.732063Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/56c9be54-46e2-4762-be75-510d2163252c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/c37b4dca-70c7-4dd4-91c4-658f9ecff5e0"
        }
      }
    }, {
      "id" : "ecd9a6b1-c7b7-45a3-a1d6-7d65e374ea44",
      "networkId" : "a96189c7-45b1-4034-bd6c-cbfc745937cd",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.881383Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "31102eef-c49c-4304-92ec-9b0187ca0006",
      "createdBy" : "4e136de1-c34f-4f6e-a7ba-aa2d24e242e1",
      "createdAt" : "2021-05-04T17:06:50.881530Z",
      "updatedAt" : "2021-05-04T17:06:50.881530Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a96189c7-45b1-4034-bd6c-cbfc745937cd",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/ecd9a6b1-c7b7-45a3-a1d6-7d65e374ea44"
        }
      }
    }, {
      "id" : "f0dc3799-c5bf-4bdd-8303-565799e283c0",
      "networkId" : "1cc85846-3d42-478f-a67b-6ee5bf0fadef",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-05-04T17:06:50.982703Z",
      "encryptionRequired" : true,
      "modelType" : null,
      "ownerIdentityId" : "45cae19d-bf1f-4334-97b1-ca03666014b1",
      "createdBy" : "4eab84e7-26ab-4cf8-8a75-fe3f77381f2a",
      "createdAt" : "2021-05-04T17:06:50.982853Z",
      "updatedAt" : "2021-05-04T17:06:50.982853Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "attributes" : [ ],
      "model" : null,
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1cc85846-3d42-478f-a67b-6ee5bf0fadef",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/f0dc3799-c5bf-4bdd-8303-565799e283c0"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 14,
    "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

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

String

false

networkId

String

false

zitiId

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

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

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

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services/957182f3-355d-41a3-abac-4b09dd7dcf61' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJneUQxT0x6MzhzTTBRQWZxOTFmWVFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcxMjUxNTRjLTcwYjYtNDU1Mi1iZDcwLTYxNDRmMTU2ZDI4MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE4NywiZXhwIjoxNjIwMTUxNzg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjlmNDFkMDNkLWI0NTMtNDU0OC05Njc1LTljZWYxMWMwZWY1OFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE4N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.JpsZlmedtoD4azP-nIHZGVvQMoUlEtSlRNiUnjyFzy4PC2sEDNgts6Xm9BFPNEc9Qz5fR-kfMtfFGGIdzE7f14f8Qv5WQovskM1p9rqB-uc9ClpL2WQ5R9giKNEKK7MWOwo70Ui_MorT4Jz2q1Cv2LpKFoEN2qd-ik5BYbV3XwBIDhH4QxnjLUV_pljy7ZM2dlPG6txWrCdGZopsr8Ns5EfPazFOr4J7Y5eATWdIrB9_r97Ghasd7VatZj58J8R_O1eelbA1l1mLDWIvtyj5LG9LqlIORVpDY646InpDeZ3P0Bnt1fcXdhbnyiVufwaEcgQCZmQb8A0Y9Od-Uzlg5w'

Example response

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

{
  "id" : "957182f3-355d-41a3-abac-4b09dd7dcf61",
  "networkId" : "04e285e2-ca66-4a1e-a58e-c5286f4bca7d",
  "zitiId" : "ziti.id.exhvaa7oq46",
  "name" : "My Service 54588105941570661",
  "encryptionRequired" : false,
  "modelType" : "TunnelerToSdk",
  "ownerIdentityId" : "f411891a-e602-40c8-bce9-3a1a3a01eb6c",
  "createdBy" : "f411891a-e602-40c8-bce9-3a1a3a01eb6c",
  "createdAt" : "2021-05-04T17:09:47.345155Z",
  "updatedAt" : "2021-05-04T17:09:47.362486Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "3ecd4f6b-1ffd-4311-aad8-558ce9cb1c3d" : "911cdcdf-791a-4f94-a1eb-5cf1a47352e2"
  },
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "model" : {
    "clientIngress" : {
      "host" : "myHost.com",
      "port" : 8989
    },
    "bindEndpointAttributes" : [ "#east-pop" ],
    "edgeRouterAttributes" : [ "#LA-dataCenter-ERs" ]
  },
  "authority" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/04e285e2-ca66-4a1e-a58e-c5286f4bca7d",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/957182f3-355d-41a3-abac-4b09dd7dcf61"
    }
  }
}

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

Client must have read action on the annotated resource.

configs[].configTypeName

String

true

configs[].configType

Object

true

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].

model

Object

true

Response fields

Path

Type

Optional

Description

String

false

networkId

String

false

zitiId

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

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

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.eyJqdGkiOiJZOTlJTTUxNzFwNWlMUVlxb2lPb0lRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY0MTE4OTFhLWU2MDItNDBjOC1iY2U5LTNhMWEzYTAxZWI2YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE4NywiZXhwIjoxNjIwMTUxNzg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ5MWVmNWI1LTM5MmYtNDI5My05YzIyLTcyZDkyNjBjMWM0OVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE4N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.e99ver0gy2jCEVh11ftCOYea32eV7VPEqYEwV8NuUxx2A2it3IzKaI7f2sxmg07Mmvv-7DE9jci_qqCduiUNQs1h_Oz6A9v51c5hJ_ckt51aFe9ofGvJ-EvEBeusO975oG-hYTaT8MFgCCngtQl1bzQgadLv5oP7wHKrtvZFH5rU4mJuDEJ9Ypw5z0MSTf7d5gkIvUaHKKAsZkfhduBoS5fZSbsu4kuoB_BXQmS3nEK8jDfbfNuSSUpHt8X4MEeWvu8eC2uNMXhb-OqedWWCC51KJ130y0MSLtirKhYIBZgk1BYNr8bn_OVikEOnW0HuSciWqQLpEg1SKDRy-lYbTw' \
    -d '{"networkId":"04e285e2-ca66-4a1e-a58e-c5286f4bca7d","name":"My Service 54588105941570661","encryptionRequired":false,"attributes":["#Attr-1","#Attr-2"],"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" : "957182f3-355d-41a3-abac-4b09dd7dcf61",
  "networkId" : "04e285e2-ca66-4a1e-a58e-c5286f4bca7d",
  "zitiId" : "ziti.id.exhvaa7oq46",
  "name" : "My Service 54588105941570661",
  "encryptionRequired" : false,
  "modelType" : "TunnelerToSdk",
  "ownerIdentityId" : "f411891a-e602-40c8-bce9-3a1a3a01eb6c",
  "createdBy" : "f411891a-e602-40c8-bce9-3a1a3a01eb6c",
  "createdAt" : "2021-05-04T17:09:47.345155Z",
  "updatedAt" : "2021-05-04T17:09:47.362486Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "3ecd4f6b-1ffd-4311-aad8-558ce9cb1c3d" : "911cdcdf-791a-4f94-a1eb-5cf1a47352e2"
  },
  "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

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

Client must have read action on the annotated resource.

configs[].configTypeName

String

true

configs[].configType

Object

true

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].

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

String

false

networkId

String

false

zitiId

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

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

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

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services/957182f3-355d-41a3-abac-4b09dd7dcf61' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJNVjVOcVA5eDdUZi16T2d0U3kwQ3lnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk4NGM1NjNlLWNlOTQtNDZjNS1hZjMyLWFmOGQwOGJkOTQ4MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE4OCwiZXhwIjoxNjIwMTUxNzg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU0ODk0OTg4LTNhYzQtNDhiOS04ZWM3LTMwN2MxM2FjZTNmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE4OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.lPSRCLRvmBbQgpuo77IalNtS1LUL8bOX4X4C9aE3JqyNZeInUs1vBhdXKpOrBvi3UHnDFS1Jgd29Du2jwu5SpYYpB2y1m-hIbgbyouIDZ9H91fwx2Qx9F-UAoGX79zi3XzUrISx1OMEKxNwxXYut4UczsStKNZuBNvc5vvPDz6WVtpLPnijaBW7h77dDKBNycn95omi1iCiTWrZlbNkfH8uhDi3h6s5dNFMR4cNbKfMySE6_4Sqk8D-sKKVti7jOGOehec0EMXfC6MZVlq0fGcmrL1bwwrhUt15AOvryMyalf48pY7SZ8J54igjUY8MdnlNHlx2X4HvcZVb2_oHYKQ' \
    -d '{"name":"Our Service 54588105941570661","encryptionRequired":true,"attributes":["#Attr-4","#Attr-2"],"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/hal+json
Content-Length: 1373

{
  "id" : "957182f3-355d-41a3-abac-4b09dd7dcf61",
  "networkId" : "04e285e2-ca66-4a1e-a58e-c5286f4bca7d",
  "zitiId" : "ziti.id.exhvaa7oq46",
  "name" : "Our Service 54588105941570661",
  "encryptionRequired" : true,
  "modelType" : "TunnelerToSdk",
  "ownerIdentityId" : "f411891a-e602-40c8-bce9-3a1a3a01eb6c",
  "createdBy" : "f411891a-e602-40c8-bce9-3a1a3a01eb6c",
  "createdAt" : "2021-05-04T17:09:47.345155Z",
  "updatedAt" : "2021-05-04T17:09:48.816431Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "3ecd4f6b-1ffd-4311-aad8-558ce9cb1c3d" : "911cdcdf-791a-4f94-a1eb-5cf1a47352e2"
  },
  "attributes" : [ "#Attr-4", "#Attr-2" ],
  "model" : {
    "clientIngress" : {
      "host" : "myHost.com",
      "port" : 8989
    },
    "bindEndpointAttributes" : [ "#east-pop" ],
    "edgeRouterAttributes" : [ "#LA-dataCenter-ERs" ]
  },
  "authority" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/04e285e2-ca66-4a1e-a58e-c5286f4bca7d",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/957182f3-355d-41a3-abac-4b09dd7dcf61"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/e36be9b2-07d8-4609-bbcf-236e0e9e3ffd",
      "profile" : "meta"
    }
  }
}

Delete Service

DELETE /services/{id}

Authorization

This endpoint requires delete action on the service resource type.

Path parameters

Parameter Type Optional Description

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

String

false

networkId

String

false

zitiId

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

encryptionRequired

Boolean

true

modelType

String

true

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

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

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services/957182f3-355d-41a3-abac-4b09dd7dcf61' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIwN2VHaUNKLUJNc2lDSkY2VEJjSUhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU3NDJiZTU2LWYxMTctNGEyNy04NTVmLWUwY2IyYjgwM2ZlYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE4OSwiZXhwIjoxNjIwMTUxNzg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImYyOWYxZTYxLWQ2NzMtNDNiMC1iNjU2LTYzMTI4YmM0MmRhY1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Kummt137wWgw_n44h4zj0jmwD-NIsGE_IAZ732t5_MKs8q9KW68WHTd6QSapf9swlH1NkSaBy_Tve1_h_3Y4qkb7-DvVc079ESNrV-1CJdg_QfxXQumMNdQXWRYLalps3WQ0TcXGigMiM8Y7Z3XX3R2R3ivXeoczPBZnnZBaXDgPdmSHMzA2zQkNi7jLfd2GnXSL2XPUuCmDJBYOCuewauM1RIUshMTakW-E__FKjSHRkyQe9k4VwuBanD5z96gKUZpR3-TKqNa0FfjyL_-LF_c9RSfgJw5ENqJBG2ty6scNAcch0mwCESKKEnhRKFz4SqVFG_F42Qez3-XBv49Vfw'

Example response

HTTP/1.1 202 Accepted
Content-Type: application/hal+json
Content-Length: 1358

{
  "id" : "957182f3-355d-41a3-abac-4b09dd7dcf61",
  "networkId" : "04e285e2-ca66-4a1e-a58e-c5286f4bca7d",
  "zitiId" : null,
  "name" : "Our Service 54588105941570661",
  "encryptionRequired" : true,
  "modelType" : "TunnelerToSdk",
  "ownerIdentityId" : "f411891a-e602-40c8-bce9-3a1a3a01eb6c",
  "createdBy" : "f411891a-e602-40c8-bce9-3a1a3a01eb6c",
  "createdAt" : "2021-05-04T17:09:47.345155Z",
  "updatedAt" : "2021-05-04T17:09:49.664965Z",
  "deletedBy" : "e742be56-f117-4a27-855f-e0cb2b803fec",
  "deletedAt" : "2021-05-04T17:09:49.636Z",
  "configIdByConfigTypeId" : {
    "3ecd4f6b-1ffd-4311-aad8-558ce9cb1c3d" : "911cdcdf-791a-4f94-a1eb-5cf1a47352e2"
  },
  "attributes" : [ ],
  "model" : {
    "clientIngress" : {
      "host" : "myHost.com",
      "port" : 8989
    },
    "bindEndpointAttributes" : [ ],
    "edgeRouterAttributes" : [ ]
  },
  "authority" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/04e285e2-ca66-4a1e-a58e-c5286f4bca7d",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/957182f3-355d-41a3-abac-4b09dd7dcf61"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/e2c5d77a-ee74-4acd-8cdb-d64cf685b09f",
      "profile" : "meta"
    }
  }
}

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

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

false

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

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

false

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.eyJqdGkiOiJuNVZPako5OGxsTTk4RDJneV9jOXNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg1ZGRmNTBhLWU0YjktNDJmNS1iYjBlLTEzYWY5YzRlZjhiMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA0OSwiZXhwIjoxNjIwMTUxNjQ5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImU3Yjg1YjIxLTFkZWEtNDNlMy1iYjJiLTcxZmMzZjIzMTE4M1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA0OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Cge7b6SCNSaFCqwwxNJ3UEJHnKKvGIATVILDcgA_luy2sQN7bDdpGcIjz1B7KslbKrEAG_OF1EKb9mnRpA7y0Q_cuEml4Ys6cOTMMVXrRAiwlvo2c574u2Pp2DGB3WuQGKFG6o5b4kTOhMXovMjHd5DwcKOP5y4QRfkvWfhCeNRasW_hdCuzHsKtwJ1tCs2xrNN6WROeNA2zuZsGZqnu_gVjKXdyxsjBNQeGucMKUlqWPrnLpeEeyilaihnn2ZIoc-bAlhoNH41oDVpoErAY3r2Gi5DLngsh8eg0t6YV40pYdPCPJdWsNaNgicUsMrqaH6Od5GIQ1OjV1EHvzsj7WQ'

Example response

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

{
  "_embedded" : {
    "appWanList" : [ {
      "id" : "0e267525-02ca-4c63-ac38-15c983db1623",
      "ownerIdentityId" : "722e31df-ba20-4a18-a70c-c2d6e540e5f0",
      "createdBy" : "722e31df-ba20-4a18-a70c-c2d6e540e5f0",
      "createdAt" : "2021-05-04T17:07:28.800914Z",
      "updatedAt" : "2021-05-04T17:07:28.800914Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-05-04T17:07:28.800796Z",
      "zitiId" : "d9c2a6b5-aab0-49f5-a34c-052278de1ec4",
      "networkId" : "ffd354d5-7fbf-4b6f-a419-ac5c877c32b1",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ffd354d5-7fbf-4b6f-a419-ac5c877c32b1",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/0e267525-02ca-4c63-ac38-15c983db1623"
        }
      }
    }, {
      "id" : "318cfec7-000c-4967-85eb-5df9fe6057ca",
      "ownerIdentityId" : "710229ef-c7ee-45e6-a47a-6c257e89d78c",
      "createdBy" : "710229ef-c7ee-45e6-a47a-6c257e89d78c",
      "createdAt" : "2021-05-04T17:07:29.010851Z",
      "updatedAt" : "2021-05-04T17:07:29.010851Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-05-04T17:07:29.010733Z",
      "zitiId" : "f0fa80ac-7d3a-4955-bf7d-8b2645d7c1c3",
      "networkId" : "18bdc9ed-123c-4f00-91b5-58f29cc99929",
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/18bdc9ed-123c-4f00-91b5-58f29cc99929",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/318cfec7-000c-4967-85eb-5df9fe6057ca"
        }
      }
    }, {
      "id" : "99c92a6d-68c9-44f3-9815-e3119f81b6c0",
      "ownerIdentityId" : "67fd9824-5843-4bfd-b7ce-9d5db0f630a1",
      "createdBy" : "67fd9824-5843-4bfd-b7ce-9d5db0f630a1",
      "createdAt" : "2021-05-04T17:07:28.900914Z",
      "updatedAt" : "2021-05-04T17:07:28.900914Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-05-04T17:07:28.900792Z",
      "zitiId" : "d53bf97a-9938-417a-a29a-a247304a3172",
      "networkId" : "c38cddcd-f44c-407b-b36e-519a982aada2",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c38cddcd-f44c-407b-b36e-519a982aada2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/99c92a6d-68c9-44f3-9815-e3119f81b6c0"
        }
      }
    }, {
      "id" : "beb2ad3b-77c1-457d-9617-9d3b843bdacc",
      "ownerIdentityId" : "62085ed2-121d-4f2f-9716-d8bd35fa69b2",
      "createdBy" : "62085ed2-121d-4f2f-9716-d8bd35fa69b2",
      "createdAt" : "2021-05-04T17:07:28.942040Z",
      "updatedAt" : "2021-05-04T17:07:28.956194Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Updated App Wan name",
      "zitiId" : "d0733064-ed75-4985-909f-6e72ba39f00d",
      "networkId" : "4dee0578-831b-4f92-bf54-3479fa34d144",
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4dee0578-831b-4f92-bf54-3479fa34d144",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/beb2ad3b-77c1-457d-9617-9d3b843bdacc"
        }
      }
    }, {
      "id" : "c7707b47-8012-4046-801d-880f94c9c504",
      "ownerIdentityId" : "fe5e75d4-63f8-4f61-9351-bdd6ca6a4d9d",
      "createdBy" : "fe5e75d4-63f8-4f61-9351-bdd6ca6a4d9d",
      "createdAt" : "2021-05-04T17:07:29.063997Z",
      "updatedAt" : "2021-05-04T17:07:29.063997Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-05-04T17:07:29.063884Z",
      "zitiId" : "cd7f33cf-60f4-4bca-a4cf-b9510044466d",
      "networkId" : "35e27441-8bc5-4bf6-b178-b0d76efc3c84",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/35e27441-8bc5-4bf6-b178-b0d76efc3c84",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/c7707b47-8012-4046-801d-880f94c9c504"
        }
      }
    } ]
  },
  "_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

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

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

false

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/63171fc0-020e-46a1-ac7d-55ee4d151bf6' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJudi1DeFdnNkJoeG0wZkdqTlN5dzdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUxMjZlMzFmLWMwYmYtNDQ5Yy04NTk4LTExMmJhNDU1MTJjMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA0OSwiZXhwIjoxNjIwMTUxNjQ5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImJkNGJlYmQ1LTc5NDktNDNkMi1iMGNjLTI1ZThmMDVlNmEyMVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA0OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.P7Mh1SrM-tP7BQnqCtaixRquOMgbnidUGudqi1rE8BRsDIvgG_uybmini-92tubet6lhqHPtQgFOO0HGSbjPCf_tURHfpnVQpRS5VCsvgOYQuBPWS_jgbDgHvDC5KhJGMGLtOfg50Em61uxM8l74rVWovMYkugqtel1hwwy8ORb6_l-XwTQv_W23lMaId0WRW2DKRyR6yItvDLlFjkCOrpjzAswnIBFngvH0N_HgZhoCDRNrFf9MZhpdp22laehV-O5ZQkseIsPabu9Y8iTYQoMtZvaNKCVcqqOLz_Hkt-s8SpaVNcgLVBk_C7cek0AVbJaww2mAI6hm0LP92YtLMA'

Example response

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

{
  "id" : "63171fc0-020e-46a1-ac7d-55ee4d151bf6",
  "ownerIdentityId" : "df8c3a8d-b1dc-4dbe-a86e-aa31ea484f5e",
  "createdBy" : "df8c3a8d-b1dc-4dbe-a86e-aa31ea484f5e",
  "createdAt" : "2021-05-04T17:07:29.121002Z",
  "updatedAt" : "2021-05-04T17:07:29.121002Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "ACME App Wan 2021-05-04T17:07:29.120887Z",
  "zitiId" : "b0285aef-4275-4b0b-9a6c-04b8050cc1ef",
  "networkId" : "f4fde436-251c-4b83-a0ad-b90bcc6d5b9c",
  "serviceAttributes" : [ ],
  "endpointAttributes" : [ ],
  "postureCheckAttributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f4fde436-251c-4b83-a0ad-b90bcc6d5b9c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/63171fc0-020e-46a1-ac7d-55ee4d151bf6"
    }
  }
}

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

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

false

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-05-04T17:06:06.455815Z,%3C2021-05-04T18:06:01.344362Z,%3E2021-05-04T16:06:01.344381Z' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyRk5aTDlfVG9GLVJuTEQtNlltVVlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVjYWJhMjNlLWI2YmMtNGE2YS1iMTJmLWJmNTkzMDRlNTc2YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0Nzk2OCwiZXhwIjoxNjIwMTUxNTY4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE4ZTc5MjMzLTJjZGYtNGVmMS1iM2NlLTJjMDJlZTNjNGVjMlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0Nzk2OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.RI0Y8dYQuEScUv4JwkW5b0OgHuM2Qyc6dQSLYB_YnwJfbQZzzUFdjqBE_ua0OjXC9o2mg_1OQoTe9obU9C_4Gh_z1IyO0pm-DNateRZAQZwtf1HG-Q6-qYFCmQAx9mtM23n3I8j_Q4Mu2GyAQLYml_ott__p3oG4CjpdkYY4J_a6WdomIoQrlAWGjK5umqL8yV1ihc54mCOAUHtKXbqt9nXVZ7E3Z_hBhytDHhGEVNHb2SmvufnQtLrhsMZFtQFmT5VlWkYYJLlEJQsGOsW118IXj-ayjbKoPfUs_0LxtnKNC7-3SpCz-viB0W7pLt4ggCq84gJNvvV0jC7m7JfM1w'

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

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.

endpointAttributes

Array[String]

true

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

serviceAttributes

Array[String]

true

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

postureCheckAttributes

Array[String]

true

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

Response fields

Path

Type

Optional

Description

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

false

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.eyJqdGkiOiJBVVF1Tl9pS05WSGZ3a2VHNWM0Mlh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJjNWM4YTFhLTFhOGItNDZhZi1hMzZlLWNhY2NmYzhjNGNlNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA0OSwiZXhwIjoxNjIwMTUxNjQ5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk4N2VlNDg5LWQwMDEtNGQzMS05ZjA4LTE0ZmQ4YzFkZjI5NVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA0OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.VBnJletC6cx49gMpVK4-mh0cxJXWoedLUTpqMWhgS7zB9FLCY3S3A1nRNLa6MGTSNkVkf2UEO1NzMnUiuGw3WOfft_abYMbq7_CckEhyP43NFWiOKJzW8afcenV0YMZmnsErGInRmAb5wUMidt1Tmr4B9-AuMUnH7IslFULE8W_ezZLrnAEktpsLImH-doHjSOQrynggVrds4g9kh2PPyTF8LQ33BMzohYs4Dl32MhuSbcq4kil07VXiDcaEc4ene89i2SgKeAdliEZdk7WvGqxD8ndGNog9TGD9b7OapC59M84cWaYcRScs3XtVPVZSRMdF0TDuklRlQPo1yEc9uQ' \
    -d '{"networkId":"01a69fa2-9cfe-4102-b21a-1c409366ebc9","name":"Test App Wan 1620148049","endpointAttributes":["#accessclients","@Test_endpoint2021-05-04T17:07:29.259744Z"],"serviceAttributes":["#service01"],"postureCheckAttributes":["#windows"]}'

Example response

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

{
  "id" : "dcba6684-a16c-4f10-ac82-8c9de35e9733",
  "ownerIdentityId" : "2c5c8a1a-1a8b-46af-a36e-caccfc8c4ce4",
  "createdBy" : "2c5c8a1a-1a8b-46af-a36e-caccfc8c4ce4",
  "createdAt" : "2021-05-04T17:07:29.294591Z",
  "updatedAt" : "2021-05-04T17:07:29.298248Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Test App Wan 1620148049",
  "zitiId" : "d80dae41-d1fd-45d0-85e3-3fa543991b23",
  "networkId" : "01a69fa2-9cfe-4102-b21a-1c409366ebc9",
  "serviceAttributes" : [ "#service01" ],
  "endpointAttributes" : [ "#accessclients", "@Test_endpoint2021-05-04T17:07:29.259744Z" ],
  "postureCheckAttributes" : [ "#windows" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/01a69fa2-9cfe-4102-b21a-1c409366ebc9",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/dcba6684-a16c-4f10-ac82-8c9de35e9733"
    }
  }
}

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

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.

endpointAttributes

Array[String]

true

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

serviceAttributes

Array[String]

true

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

postureCheckAttributes

Array[String]

true

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

noOp

Boolean

true

Response fields

Path

Type

Optional

Description

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

false

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/beb2ad3b-77c1-457d-9617-9d3b843bdacc' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJkcm85dk5PY2xSekhKWk5lTTNxTzNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ0NDBjZmI1LThlM2QtNDA2NS04MzJiLTI0MWNiYThhNTA5YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA0OCwiZXhwIjoxNjIwMTUxNjQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgxNmNlZGRiLTk5NjEtNGNkYi04ZDc0LTFiOGYxMmQ1OTUwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA0OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.CGyh8bGRDAjley7KM0L3x5u4q3Hr4lfDLS6V49O8C5r4Sag9yjhkJdeMuPIsK47_quarNzHZlTwfyQgd3lUj2ejGUTlJ3fmohDyaLUA-6GiLCSGFH6G4rEQqpQ_msG4jlfbVqNJdJGrUbxay4DfRuzoQPZ1hHm39j8E2Q53nISeh9Qs2hiNUw7bZrZMTkk-QZTYOI7hwLAoqeI-Tkzezhl_hmTKKbxQ-H14EGsgaWpv_1hqYyUiT_rTxkmIU_bTAlAnNEk52jn63eBGlzYe2nmAtMkf0VQVO-4LNkxqkeZ604TWs20dHvTxcCRyMBWZSzyDexVawJX1CqrMPTz-cNw' \
    -d '{"name":"Updated App Wan name","endpointAttributes":["#usendpoints"],"serviceAttributes":["#service03","#service02","#service01"],"postureCheckAttributes":["#windows"],"noOp":false}'

Example response

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

{
  "id" : "beb2ad3b-77c1-457d-9617-9d3b843bdacc",
  "ownerIdentityId" : "62085ed2-121d-4f2f-9716-d8bd35fa69b2",
  "createdBy" : "62085ed2-121d-4f2f-9716-d8bd35fa69b2",
  "createdAt" : "2021-05-04T17:07:28.942040Z",
  "updatedAt" : "2021-05-04T17:07:28.956194Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Updated App Wan name",
  "zitiId" : "d0733064-ed75-4985-909f-6e72ba39f00d",
  "networkId" : "4dee0578-831b-4f92-bf54-3479fa34d144",
  "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
  "endpointAttributes" : [ "#usendpoints" ],
  "postureCheckAttributes" : [ "#windows" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4dee0578-831b-4f92-bf54-3479fa34d144",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/beb2ad3b-77c1-457d-9617-9d3b843bdacc"
    }
  }
}

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

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/3c76ced7-96c3-4067-af7d-48c255925ed5' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJTSV9iNUZUbHBZZTF1MF9CYkdmUGlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE5NjEzZGU3LTNiNGYtNDIyZi05ZTA0LTg2Njc2OWMxZjFhNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODA0OCwiZXhwIjoxNjIwMTUxNjQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjNjMzQ2YjkwLTIzMmEtNGEzZi1iZDVhLWM3MTg2N2E3NDI2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODA0OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.hjs4glmB0q5sFxJgriJA38CO5d6qDdlRDCw12dtLUSkX4zA5tru7WaFblFlMQetrV4CeTZkecNGZXKiUm7E70AYO4CzeQbsvYaQ2Vl01ARZycD9wbjIYOGRZt92To_Mn4oJhjIti389fZF169rAV7KeoArg6DAyPbWUs8EMQ75JPiA8qrkMfHW7cS_jo2Q_b1QV7tG69fU9hh2K709wPFppOclX_24CMmSdmFkiTD5dVCdmzaLYN4MY7_rXZGbgGwauMYN6FkfQXaTlwtq2np-tO_gOHOGZtbIt1ppEnY18rpezSDU2l0ya2bKQwMTFNZemtMhEHB2xWr9obR9YQZQ'

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].

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

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].

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.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, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

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/posture-checks?type=MAC' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ5UmhHdjZsRzNJUGFKRVJlemE5dmNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ0NGE3YjA1LTVlM2ItNGQ3OC1iZjlmLWIwZDc0NDU3OGI2MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODAzNSwiZXhwIjoxNjIwMTUxNjM1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJhNmMxMzU0LWQ5OWMtNGZiOS1iMzlkLTMxZGVlODYzYTI5M1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODAzNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.WFzCDPJlFQyf3chsnZwFC5SD_5u61nEpdF3Q84O-yzVEvLEGAjU1ELT5DKotBQRsWjDgxV6N7Wvj8C3E-0XLBEDfncuXgBAJutpiDe_QY5Q-Pn1t-XHIpSvUEA7nuZYA-GWE-_fWeAQc4ppL5-yLZSBAWaDK7fHKKt-QqQQFFpslrgfpMiz7OVszjiXYu8fvo6mpgi0ur2VNmTWhy20Y23HJQbz4YVrnb4ipscaR7fCaY11xcJeq7gex98sq4k2oH0cEbjkIWFodCdan8EeKNmMXYRIT7NFcypBN0h4vlxkHm-FMER_Oyv515Nnj3WvZ3s7aNFrwN_-L7t_KPVfNwA'

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

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

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].

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.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, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

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/posture-checks/3d595e04-a83d-4815-857b-04e4deee0536' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJRYzU1V3VsS2tTX0RoaWZ6dWVtYWpnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRlMTY3ODU0LTY5ZDQtNDhhZC05MTBlLTA2NDIyOWQ1NGMxNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE2MywiZXhwIjoxNjIwMTUxNzYzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhjNTI4MDU4LTJhYzAtNGU4MS05OGExLWRjODRjODgyYzBiYlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE2M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.WGvgkdGorOwwa7ZU_1YwCUQe0f5ZRtpysKZfjCTLfyq2xOnL5DvM9jA7TQFYTL4gM4xp4_vEOCZzNGvyYeOzTlBus3rKEkxnqx0NQhMcnNuaISsS1ZWmlT2lRBovv4-V3WnhkIQTW_T30s9QrQbq8qzjXnM0aSHh14ous49053kXBDwz8qFHhCgZS8El8XsSzkEQa4pdXaIdsOve87Edl659oyQn27ya-QMzx63E9fUaoHZo4j6rPQylzZlFFnz-B2VfHV7CsUjPc3q_rLhVckMLzb5edUi2Xh9D4sigomR7_21rDyC59n2jOjwv7_QHkg_T6gePmqmdgmAOT6Upxw'

Example response

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

{
  "id" : "3d595e04-a83d-4815-857b-04e4deee0536",
  "zitiId" : "ziti.id.exhuz8pjws4",
  "name" : "My Posture Check 54588082522192964",
  "networkId" : "d7824b0e-a1a6-44d3-bf34-8eef66751024",
  "type" : "PROCESS",
  "ownerIdentityId" : "3e43a237-ac47-49c0-8a20-9c0ea13641cd",
  "createdBy" : "3e43a237-ac47-49c0-8a20-9c0ea13641cd",
  "createdAt" : "2021-05-04T17:09:23.327007Z",
  "updatedAt" : "2021-05-04T17:09:23.327007Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "data" : {
    "process" : {
      "osType" : "Windows",
      "path" : "c:\\programs",
      "hashes" : [ ],
      "signerFingerprint" : null
    }
  },
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d7824b0e-a1a6-44d3-bf34-8eef66751024",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/3d595e04-a83d-4815-857b-04e4deee0536"
    }
  }
}

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].

attributes

Array[String]

true

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

data

Object

true

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

data.domains

Array[String]

false

data.macAddresses

Array[String]

false

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, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

Response fields

Path

Type

Optional

Description

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].

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.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, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

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.eyJqdGkiOiJ3RndwZEszekFoeFNlYzlaYkd4ZjNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNlNDNhMjM3LWFjNDctNDljMC04YTIwLTljMGVhMTM2NDFjZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE2MywiZXhwIjoxNjIwMTUxNzYzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJiMjVhZWJkLTc4M2UtNGZlZi1hYjhlLTE0YzA5YjM4NzIyOVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE2M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.qRf4ApGLArMWjWUDpqAZYjzKkKIJ1ZQZKBZ6JDnepinUCQYhzKYGVJA8hXDumVY_E3m3oTajtJNWlUVsz5HLsNVDXoTFk6ZAj8GobKGk4yt_D4eVfDnldT4jmwG6mkzmqNSOYrZtG93GabV7ec0TV6fS0CS2im4wOdk7WHKdO_MAFQdlQqVUnJSs44jjyBcDdXDeY5yU-nUPvJjdL8UmReiZjOWqN_UKS9SeKQCGZLTRlHBh3cDYJUwH1KgJZBRzv9ajL332f4JIef3xMbo9NBZ_l_B4oVoonQLp7LsfhX-s3vMW7_KTvBj71zBnVWfzCjoB8gEfc5723l7XbgguXA' \
    -d '{"name":"My Posture Check 54588082522192964","networkId":"d7824b0e-a1a6-44d3-bf34-8eef66751024","type":"PROCESS","attributes":["#Attr-1","#Attr-2"],"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" : "3d595e04-a83d-4815-857b-04e4deee0536",
  "zitiId" : "ziti.id.exhuz8pjws4",
  "name" : "My Posture Check 54588082522192964",
  "networkId" : "d7824b0e-a1a6-44d3-bf34-8eef66751024",
  "type" : "PROCESS",
  "ownerIdentityId" : "3e43a237-ac47-49c0-8a20-9c0ea13641cd",
  "createdBy" : "3e43a237-ac47-49c0-8a20-9c0ea13641cd",
  "createdAt" : "2021-05-04T17:09:23.327007Z",
  "updatedAt" : "2021-05-04T17:09:23.327007Z",
  "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

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].

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.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, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

Response fields

Path

Type

Optional

Description

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].

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.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, Android, iOS, Linux, macOS].

data.process.path

String

false

data.process.hashes

Array[String]

true

data.process.signerFingerprint

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/posture-checks/3d595e04-a83d-4815-857b-04e4deee0536' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJuUExrUmVNZTItUUFld25RTU9vMjd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRkNGE4YjhkLTU3N2YtNGE0ZS05ZDVhLWJjYzM3NzdiOGI1OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE2NCwiZXhwIjoxNjIwMTUxNzY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjMyY2Q3M2E3LWNhNzgtNDdjMS1hZmE0LTlhNzJjY2YyNGQ0N1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.okq26ncuA64LvkuMzdcaNQQ6jlwdsKfYwnwEErBXCtNWIG_Ip_PntW3n0Q9Xtqhj9RdQebu62OjqwXcmtAXFLecpC45XAoXEV3noldf3ZGRdVQavdqqHWWPivbc0n0pfaVGx0VbZU3sxWw5Aa9F3bHRJO7ZgUi8Gv4a9RUUU-3LcKpH4mgEIwWDluhMGhAHR_2yn0RPoN7DHqLc1xR9s5Feamw4kDOrzSvrbBALVCKYKVXXVPnncNtf0Or6RcZ8m0jJHzyzSwvhVgO_HtetIrvnopUYVrlpPIqoqNmJwKSIs12kOQh6JX-JMHaeh9VLCdpo3ODcXb2vV5W3YKzddZA' \
    -d '{"name":"Our Service 54588082522192964","attributes":["#Attr-4","#Attr-2"]}'

Example response

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

{
  "id" : "3d595e04-a83d-4815-857b-04e4deee0536",
  "zitiId" : "ziti.id.exhuz8pjws4",
  "name" : "Our Service 54588082522192964",
  "networkId" : "d7824b0e-a1a6-44d3-bf34-8eef66751024",
  "type" : "PROCESS",
  "ownerIdentityId" : "3e43a237-ac47-49c0-8a20-9c0ea13641cd",
  "createdBy" : "3e43a237-ac47-49c0-8a20-9c0ea13641cd",
  "createdAt" : "2021-05-04T17:09:23.327007Z",
  "updatedAt" : "2021-05-04T17:09:24.499875Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-4", "#Attr-2" ],
  "data" : {
    "process" : {
      "osType" : "Windows",
      "path" : "c:\\programs",
      "hashes" : [ ],
      "signerFingerprint" : null
    }
  },
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d7824b0e-a1a6-44d3-bf34-8eef66751024",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/3d595e04-a83d-4815-857b-04e4deee0536"
    }
  }
}

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

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/3d595e04-a83d-4815-857b-04e4deee0536' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ4NDVBeHlFQVdOV3c0NUkzUUQ3LTJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjEzMTgxMDJmLTMzMGEtNGQzYS04NWIzLWE1YWJmNDMwYWIxOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODE2NCwiZXhwIjoxNjIwMTUxNzY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjY0ZjliN2YxLWYyMWQtNDY1Ny1iYTdkLTk1YmYyZDllNTAzYVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODE2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.mKA9w5sMoXBIvSJPaN8PGPxiiEjQVzuH6kZyHCW9E-rK1kJk5lSDR6WG6pVpDxtCU2zi3ff8en9ofFvBdVnF_0V5s4twoovj-UswGLHUNtgXUxPbrjAKt9_8EBC1ahiBj9YblvFi2RVRf5LpbaeVpDc5sIfZqkfjrFa6V4649BdmrP6JqUC41cLSztDR-XL_z9toLi7VASx1HWHmw5JQOgbbOCOuBha6oZvFtjItPWc-w7B7ViE3Yk92r8naVbmM58sxSTFk7Y_EEBWAi4G6XGUAVcCu_vd30fuGj6io1O_eHsFrWqqEKcXrMYIHM4Ejzck_be5WGrOcsttdJXEzjw'

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

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

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

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

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

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

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.eyJqdGkiOiJFdnNPWWxRczJfUnZLQWkzalB5QkZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZkNDViNDkwLTNiZmUtNGM0NS05ZDJjLTZjNTlhYjI5OWFhMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEzMywiZXhwIjoxNjIwMTUxNzMzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ4YjAwMGFjLTEyYjctNDNiYS1hMGRhLWU5NGY4YmM2YzQyYlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEzM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.rCghpHfOXdVQPv-49llXd90MWnkudJqEBWb9kNmEvV6Hch3jZl7gYsW9oInv7IX7y___C_bg4tPE6Xr0l9qOKK9CheuIBz1MSruXEA4N57Qb6PieJ4owwpHNw83oIqqHw6XdzUkp-tim902PtOChkoGmGX1thi_XAMuwqHfxDXBS7JU4lBTXlTGcRQ812rEwIg08h2mCK2rLIPo-6UQprg7-Vov8dXa3izwKvD4a6NJmKsQyzgNQqPZmsMxd28CMgyeBw8DygB2wT3uKCCENfO7RZ1c4zPLWf2ezaT4Usi1sNU_N8Abe7J4stFH6uzwzCjz8OnuKnzj4ojkQsqnd1w'

Example response

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

{
  "_embedded" : {
    "certificateAuthorityList" : [ {
      "id" : "09d7936d-856e-42f5-935e-cb9b3d0ffd1c",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:52.849730Z",
      "updatedAt" : "2021-05-04T17:08:52.849730Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "8df23fab-e767-4520-8856-a7dc26d882cc",
      "zitiId" : "16f96ed2-fb79-401c-bbdd-9d0289a7585a",
      "name" : "ACME CA NO 2021-05-04T17:08:52.849622Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8df23fab-e767-4520-8856-a7dc26d882cc",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/09d7936d-856e-42f5-935e-cb9b3d0ffd1c"
        }
      }
    }, {
      "id" : "17587ca4-123e-4b8f-b052-64c5122fa3b8",
      "ownerIdentityId" : "db117711-234d-443c-a8c0-a85ee5a0b13d",
      "createdBy" : "db117711-234d-443c-a8c0-a85ee5a0b13d",
      "createdAt" : "2021-05-04T17:08:52.902322Z",
      "updatedAt" : "2021-05-04T17:08:52.906564Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "95aa0529-1828-4aaa-acf5-f10b7120b2ae",
      "zitiId" : "8c7b2487-e5bc-4a0d-82f7-e879048750ec",
      "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-----",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/95aa0529-1828-4aaa-acf5-f10b7120b2ae",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/17587ca4-123e-4b8f-b052-64c5122fa3b8"
        }
      }
    }, {
      "id" : "18c12ee4-fcbe-4b16-b9ac-2d19b23c4678",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:52.810997Z",
      "updatedAt" : "2021-05-04T17:08:52.810997Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "a6154a10-278e-44a3-929c-03c337f693b4",
      "zitiId" : "7cec3aab-dc11-4b86-a97c-31d6187c6b13",
      "name" : "ACME CA NO 2021-05-04T17:08:52.810878Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a6154a10-278e-44a3-929c-03c337f693b4",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/18c12ee4-fcbe-4b16-b9ac-2d19b23c4678"
        }
      }
    }, {
      "id" : "22dde96e-fc90-4adc-84f5-2c17f0989f38",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:53.005665Z",
      "updatedAt" : "2021-05-04T17:08:53.005665Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "f1b3226f-55d0-49d7-b60c-84f3e6ef10ef",
      "zitiId" : "5e0fe783-ef6c-4c94-966a-e8a75b808e6a",
      "name" : "ACME CA NO 2021-05-04T17:08:53.005554Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f1b3226f-55d0-49d7-b60c-84f3e6ef10ef",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/22dde96e-fc90-4adc-84f5-2c17f0989f38"
        }
      }
    }, {
      "id" : "2fbea535-b751-4e22-ae07-4734ca8f145f",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:52.810314Z",
      "updatedAt" : "2021-05-04T17:08:52.810314Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "a6154a10-278e-44a3-929c-03c337f693b4",
      "zitiId" : "8023aded-6e3c-4941-9a97-5e586d0bd0cc",
      "name" : "ACME CA 2021-05-04T17:08:52.810135Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a6154a10-278e-44a3-929c-03c337f693b4",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/2fbea535-b751-4e22-ae07-4734ca8f145f"
        }
      }
    }, {
      "id" : "3f424c84-c20d-460d-bb75-6658f80e35ad",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:52.849334Z",
      "updatedAt" : "2021-05-04T17:08:52.849334Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "8df23fab-e767-4520-8856-a7dc26d882cc",
      "zitiId" : "d384e509-3db1-49e2-b5dd-90f0c409ffb4",
      "name" : "ACME CA 2021-05-04T17:08:52.849221Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8df23fab-e767-4520-8856-a7dc26d882cc",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/3f424c84-c20d-460d-bb75-6658f80e35ad"
        }
      }
    }, {
      "id" : "54beb861-d4e3-484f-be3a-cffb43a5aff0",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:53.092365Z",
      "updatedAt" : "2021-05-04T17:08:53.092365Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "6c336400-f40c-49cc-b8c4-3e443ac896d5",
      "zitiId" : "510cef47-d7a5-4e0c-a524-3db7bde41edd",
      "name" : "ACME CA NO 2021-05-04T17:08:53.092234Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6c336400-f40c-49cc-b8c4-3e443ac896d5",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/54beb861-d4e3-484f-be3a-cffb43a5aff0"
        }
      }
    }, {
      "id" : "56df2008-9c9b-4ac2-bf2e-d96051c96696",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:53.049841Z",
      "updatedAt" : "2021-05-04T17:08:53.049841Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "155aedb6-4fbc-4512-a156-5752fb0e3b35",
      "zitiId" : "fd945a0d-97f7-4f16-b17c-5a1e8f659aeb",
      "name" : "ACME CA 2021-05-04T17:08:53.049727Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/155aedb6-4fbc-4512-a156-5752fb0e3b35",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/56df2008-9c9b-4ac2-bf2e-d96051c96696"
        }
      }
    }, {
      "id" : "5d60b754-07bf-4014-8860-023235b80f93",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:53.091885Z",
      "updatedAt" : "2021-05-04T17:08:53.091885Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "6c336400-f40c-49cc-b8c4-3e443ac896d5",
      "zitiId" : "a7f36b6b-5d32-48ef-8d77-e3307d3f10d9",
      "name" : "ACME CA 2021-05-04T17:08:53.091765Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6c336400-f40c-49cc-b8c4-3e443ac896d5",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/5d60b754-07bf-4014-8860-023235b80f93"
        }
      }
    }, {
      "id" : "7e0918d2-028c-424d-b998-d9a97de49ebd",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:53.005236Z",
      "updatedAt" : "2021-05-04T17:08:53.005236Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "f1b3226f-55d0-49d7-b60c-84f3e6ef10ef",
      "zitiId" : "d0d5fcd0-e92d-44ed-a5c7-f6fcdb0c3308",
      "name" : "ACME CA 2021-05-04T17:08:53.005120Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f1b3226f-55d0-49d7-b60c-84f3e6ef10ef",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/7e0918d2-028c-424d-b998-d9a97de49ebd"
        }
      }
    }, {
      "id" : "8542839f-e4a2-430b-b665-f076e67a24e1",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:52.947798Z",
      "updatedAt" : "2021-05-04T17:08:52.947798Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "49ab56a6-3e21-4d4b-896e-7d2d5080f9b4",
      "zitiId" : "a9f3d3fe-2548-4a4a-9de3-3aab0a95379f",
      "name" : "ACME CA 2021-05-04T17:08:52.947666Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/49ab56a6-3e21-4d4b-896e-7d2d5080f9b4",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/8542839f-e4a2-430b-b665-f076e67a24e1"
        }
      }
    }, {
      "id" : "c5315d75-5a38-46e3-b285-f1082497f156",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:52.861933Z",
      "updatedAt" : "2021-05-04T17:08:52.861933Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "95aa0529-1828-4aaa-acf5-f10b7120b2ae",
      "zitiId" : "71200f4a-ecbb-48e7-8ded-0c93397f8093",
      "name" : "ACME CA NO 2021-05-04T17:08:52.861826Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/95aa0529-1828-4aaa-acf5-f10b7120b2ae",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/c5315d75-5a38-46e3-b285-f1082497f156"
        }
      }
    }, {
      "id" : "ce5845d9-0dd1-433d-938a-8e1254d6e86d",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:52.948239Z",
      "updatedAt" : "2021-05-04T17:08:52.948239Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "49ab56a6-3e21-4d4b-896e-7d2d5080f9b4",
      "zitiId" : "33c3838d-ffac-4d44-aa25-793ee479179a",
      "name" : "ACME CA NO 2021-05-04T17:08:52.948125Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/49ab56a6-3e21-4d4b-896e-7d2d5080f9b4",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/ce5845d9-0dd1-433d-938a-8e1254d6e86d"
        }
      }
    }, {
      "id" : "e03f96ac-db22-4725-9b9d-8679a6a70ade",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-05-04T17:08:52.861564Z",
      "updatedAt" : "2021-05-04T17:08:52.861564Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "95aa0529-1828-4aaa-acf5-f10b7120b2ae",
      "zitiId" : "411b75a6-62c0-4c6b-bc8e-3fea63eaa5d6",
      "name" : "ACME CA 2021-05-04T17:08:52.861446Z",
      "endpointAttributes" : [ ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "certPem" : "fakePem",
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/95aa0529-1828-4aaa-acf5-f10b7120b2ae",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/e03f96ac-db22-4725-9b9d-8679a6a70ade"
        }
      }
    } ]
  },
  "_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

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

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

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

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/016fa374-c956-4602-9c32-cad50745171b' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJWS0FQNldveE9FS3U2NTd4dWhHOWF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAyMjcwYTEzLTVlZDYtNDY5Yy1iNTY4LTY4OWNkM2Y2ZWM3NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEzMywiZXhwIjoxNjIwMTUxNzMzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA3ODNhYmZlLTJhZmQtNDZmZS1hMDRkLTc5MDcyNDQzZmRlZVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEzM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.hVFHZfU05KJiPbHBkMcpjxFu4GNQDi00iywgGYOcMrKj46AFCn5qsiiICzALNKjYFlH6UbqO0HW3CTBcP8Loh2EZ3Qrm9h2ti6PxyzqXwMMu7aucnxMZwQIDwrO5KEiSeJBQKAk1mLPy4GXqoDogs4Gp0bC4LpkYOHC7Qv2lu8eIKWtebRRWPTevkKVTl_qsj-hp7fb5tn8R6h-krR5m12eZaaL4X59QuW1afwBI0Ny8cmkNb-fQNFyQMShol-xOZ5iyjCfq4l2-eDKu-5opGYVyH63TipmfP55T3sxmNDMG72KbOEJwokq2jziMuWYjSHahIYPGgFSme24Nomr4FQ'

Example response

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

{
  "id" : "016fa374-c956-4602-9c32-cad50745171b",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-05-04T17:08:53.146766Z",
  "updatedAt" : "2021-05-04T17:08:53.146766Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "ae9ecd5b-60e0-46b9-ac31-c8c31cf6ce18",
  "zitiId" : "c6b0ee8c-b314-4faa-ace9-33b56db53c4a",
  "name" : "ACME CA 2021-05-04T17:08:53.146652Z",
  "endpointAttributes" : [ ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "fakePem",
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "verified" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ae9ecd5b-60e0-46b9-ac31-c8c31cf6ce18",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/016fa374-c956-4602-9c32-cad50745171b"
    }
  }
}

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

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

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

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.eyJqdGkiOiI2NHFHU2ZtbGcyb3cyWkZ4aFljTm13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRiMTE3NzExLTIzNGQtNDQzYy1hOGMwLWE4NWVlNWEwYjEzZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEzMiwiZXhwIjoxNjIwMTUxNzMyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImExNzczZTliLTQ1NzgtNDc0YS1hNDE1LTU1ZWU2ZWViYzVmNFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEzMn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.UXa-ballaqqBbu_5-luLaqgDMx1lEGgII0ZTAIH6tGT_F3INcdisCHbJqHmC_UqhamLAKR6u5yzZ_u8QZWlu378WQ210SmODeiFPQsOhNdhDOR-nfWRYbflrcrVBZaybyCYBCMVEJ75Cn_0JqAYt1kQHnVv-ssFlOyhHmiTNswNI4c9YhHuKTOyZN4tpqF3GL_0Fhup3Fwq7yeF0wnvJjXwDYlNp7d1Og_qFm4d7Thv9LfK86UaF0yns_fOiym5iUOhO9pKqjRkj0Ft4KyKEH3XdDNRNfrAxAJ46zwyLPmypEV0LfIxAI0JnFzMX8lqSoIbVujp4UC2Ntj6Ghcz4Tg' \
    -d '{"networkId":"95aa0529-1828-4aaa-acf5-f10b7120b2ae","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" : "17587ca4-123e-4b8f-b052-64c5122fa3b8",
  "ownerIdentityId" : "db117711-234d-443c-a8c0-a85ee5a0b13d",
  "createdBy" : "db117711-234d-443c-a8c0-a85ee5a0b13d",
  "createdAt" : "2021-05-04T17:08:52.902322Z",
  "updatedAt" : "2021-05-04T17:08:52.906564Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "95aa0529-1828-4aaa-acf5-f10b7120b2ae",
  "zitiId" : "8c7b2487-e5bc-4a0d-82f7-e879048750ec",
  "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-----",
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "verified" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/95aa0529-1828-4aaa-acf5-f10b7120b2ae",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/17587ca4-123e-4b8f-b052-64c5122fa3b8"
    }
  }
}

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

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

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

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

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/7e0918d2-028c-424d-b998-d9a97de49ebd/verify' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJIQ094N1Z5YmU2dVdBWUtUWngyNVVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM3MTFjZDg0LTNkZWYtNDRlNC1iMThhLTAxODdiNzQwNDk2MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEzMywiZXhwIjoxNjIwMTUxNzMzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjI2ZjcwOWM2LWZlMTItNDhlMy04M2IxLTY2NzIyNGQ3NDUxNlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEzM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.TOoMP7s4-BRwJ18qVUDwGnYlcX4ECP-vaKU1fqlzsgvwSjaoAnLZtNONQCS8_HLmHr6m5tCVf-ejtY7okQc5PNut6-hJ6CSQpz9IoQJrPziQJT0rm5U9sREVbQdsqjBlqXtvmdDdQIailRqwMdMXQwCRHRz3xVapKg3Kb3TvpwmttIJCv2ptr0yutF40sp_QynOoUbkYIUE9u_icEVet3u5dQPLIS9ljsB-jNsDnxEVMZ-FThwBo6B1nqlepLlNJQ-2PmF3-vZAKM4w9UlQG7Y9SfgpJQ4nNSuQ3v2B99faEMYETPlMvDamikOY6b7tHM1kz9TEEDuw3WLViavsKdg' \
    -d '<testcertverificationbody>'

Example response

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

{
  "id" : "7e0918d2-028c-424d-b998-d9a97de49ebd",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-05-04T17:08:53.005236Z",
  "updatedAt" : "2021-05-04T17:08:53.005236Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "f1b3226f-55d0-49d7-b60c-84f3e6ef10ef",
  "zitiId" : "d0d5fcd0-e92d-44ed-a5c7-f6fcdb0c3308",
  "name" : "ACME CA 2021-05-04T17:08:53.005120Z",
  "endpointAttributes" : [ ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "fakePem",
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "verified" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f1b3226f-55d0-49d7-b60c-84f3e6ef10ef",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/7e0918d2-028c-424d-b998-d9a97de49ebd"
    }
  }
}

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

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

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

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

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/8542839f-e4a2-430b-b665-f076e67a24e1' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJYRWlSVXZsMVhUbFpFMlVsX29QLUFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMwODEzMzAyLThlOWItNDliOC04NzA3LWIzZTMxM2U5MDkzMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEzMiwiZXhwIjoxNjIwMTUxNzMyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM2OWEwZWRmLWI5NjgtNDU0Ni1hMDY5LTU4YzIyOGI4YWQwYVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEzMn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.PI2AoVB65M1S9WNXaKTD_5lOrw2hOw5oj0mh7KwHkSceAiCAiLRZXnTrxpQsOfoFzCN6mZGAU2WQW9Oca6rBIdP15CHpswPMnED9IpOpGTVuGIRTwxlzNytmcT9dpOqShRIxcpMHEKCUZ1LSGFcLDJlfpVh7hIWXU9RjOi74TFYvLJGtcZhy4jTALZR4bP4lkpat3VqcPdoUjhl-jM-2D-NMV_4Q3EcXEOQ8wohcJLZmTTxEWmP_Y-DC4sUb43TrT5jzgsO-MXDda-MAeVUVRVdy8X7NWdG2SpuQ8kq_B0ycvBOUdbQB1Phs8iFcdcpMwpHyQF7JhsZYhxokI4T7vA' \
    -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" : "8542839f-e4a2-430b-b665-f076e67a24e1",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-05-04T17:08:52.947798Z",
  "updatedAt" : "2021-05-04T17:08:52.947798Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "49ab56a6-3e21-4d4b-896e-7d2d5080f9b4",
  "zitiId" : "a9f3d3fe-2548-4a4a-9de3-3aab0a95379f",
  "name" : "ACME CA 2021-05-04T17:08:52.947666Z",
  "endpointAttributes" : [ ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "fakePem",
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "verified" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/49ab56a6-3e21-4d4b-896e-7d2d5080f9b4",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/8542839f-e4a2-430b-b665-f076e67a24e1"
    }
  }
}

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

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/8da8dc10-3e9d-4f0c-a8c7-aa16eba31bea' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJrVGZNdzBHQnlPU2tUZGo4bVc5ZXpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkyOWI2YjI0LWNhMjItNGE2Ny05YmIyLWM4MmU4NTY1OTZiNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEzMywiZXhwIjoxNjIwMTUxNzMzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI2ZDRlYzdjLTYyYmQtNGRiYS04MzIyLThkM2ZjNGM4Zjk3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEzM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.dtzH4LOxzuBjkIYq6O4FC2j6rmm7Np06dloR6blbLdTzxn2WyFuFSf6zyZL60b6CXRMe5CyM089MQCLFEBZxUkRTfbQUArpapIeCSg4S_U6ZaZpWTjJAbdiGNeO2W_Spmpc2ydD_v9lsuafSiq_zyUGXzbQq-PPzwleoaVeAgPMheFjG1lKDqY_UgUL6hgYfWc6DQ5mZB-t4RtlEPJcNWXn7c1TmQAhNVJIvpOo5hzj8GTGreiDZV9Fd-pXxohVMGRYpDGcurPjmWGtehABS59LmZL--eanYx236FumbVN7cs5E5Ct0AA-zZ2GZzk3FQ79HYACoquPuBtALb0cuu9g'

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

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

true

serviceAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

authority

Object

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

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

true

serviceAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

authority

Object

false

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJjMU9nZVQ1N25WdDZWSTVoVS11Q1pRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI2MDlmYTg2LTEwYjMtNDkwZS1iMzU4LTE0NGVkMjM2ZDdkZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEwNCwiZXhwIjoxNjIwMTUxNzA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRhZjQzOTRkLTBhMmMtNGI1Yi04MmIzLWYwNjlkMDQ3MTc3OFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Ox9WsuNFiSuoqQK1OTDiDgEPGC5LdtEOoISmDlIEcbYJV4r8YSePSvS-nMH33o403Hggrv8zgujzLpfs8rysn-uQPa9XUKEOpxVWuWnPEfmYd2t3TES1TroohAUD0PKgraWW6iyWt0GJhllZ2MIGje_0VNdNvGapA9locifCBkRJ-jt0bC5COsToLrViYawANZVLlurmSut3-fKjG_H_pE5KYF4rxiLbQ1od739WFsynrEma5_ZKwGMCCwzsAX2g1za3gtWOObJSZQdk4J56ZekLR6Zi_2W3oKBJai8L9dv-xltjh71ECHYjigGNg_i4-0kZGnd__sjpvRg1lkD_KQ'

Example response

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

{
  "_embedded" : {
    "serviceEdgeRouterPolicyList" : [ {
      "id" : "81da135e-92b3-4802-8d0d-3b6a4998eb11",
      "networkId" : "30ad1b9b-f255-424e-8f20-52d71edf79dd",
      "zitiId" : "ziti.id.exhu83rnko6",
      "name" : "My Service Edge Router Policy 54588024041675973",
      "semantic" : "AnyOf",
      "ownerIdentityId" : "27fdc0a5-070d-46c6-ac45-b58a5d01c22d",
      "createdBy" : "27fdc0a5-070d-46c6-ac45-b58a5d01c22d",
      "createdAt" : "2021-05-04T17:08:24.239268Z",
      "updatedAt" : "2021-05-04T17:08:24.259922Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "serviceAttributes" : [ "#service-1", "#service-5" ],
      "edgeRouterAttributes" : [ "#router-3" ],
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/30ad1b9b-f255-424e-8f20-52d71edf79dd",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/81da135e-92b3-4802-8d0d-3b6a4998eb11"
        }
      }
    }, {
      "id" : "f3d79e90-a0e7-43ff-92c9-cc3fecbb0317",
      "networkId" : "d0917e31-a059-4e01-8966-5a96163c26fb",
      "zitiId" : "ziti.id.exhu856yivg",
      "name" : "My Service Edge Router Policy 54588024043480980",
      "semantic" : "AnyOf",
      "ownerIdentityId" : "f94257f0-642c-4cdb-8ef8-5ee95a177f02",
      "createdBy" : "f94257f0-642c-4cdb-8ef8-5ee95a177f02",
      "createdAt" : "2021-05-04T17:08:24.336871Z",
      "updatedAt" : "2021-05-04T17:08:24.341256Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "serviceAttributes" : [ "#service-1", "#service-5" ],
      "edgeRouterAttributes" : [ "#router-3" ],
      "authority" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d0917e31-a059-4e01-8966-5a96163c26fb",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/f3d79e90-a0e7-43ff-92c9-cc3fecbb0317"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

false

Client must have read action on the annotated resource.

Optional

Description

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

true

serviceAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

authority

Object

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/service-edge-router-policies/f3d79e90-a0e7-43ff-92c9-cc3fecbb0317' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJoS2tOS3pFbWZuem1mbEgxc2xlY0V3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc3MGZkZjA0LTljNDktNGE0ZS1hYzQ0LWJkZGY3M2ZjYjAwNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEwNCwiZXhwIjoxNjIwMTUxNzA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZmZmM1MTBjLTlkOWYtNDBkOC05NWMzLTM3YmVmMGQ4NTM3MFwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.KW68imbaN3KbpKb0_MYACq_BMAC1pFnjuJTCxbSpz9sjy2dGYVj4Dcwoli1wIym2c9Pccs0czbuZketogp8zBV6U1VhifgeRabvhhXtWjxZcbJSQufX8oGxdop-UsRxZlcdyxuwEYdephQdWGevQE0NnByUMtcMdv1gro3gjhCgFkIHEqHK448LHudFXv6a1tWJrIiVpSvy5ANmUBdZbt58sgp6_BMPLgqJa5_vdlmjQMVnrwa3VvYBmNhxTPbhpKsWOl0Jh3v4jI0i5nQDC_2fDUhs6b3Atr8muPOsNxdSiS5XbvnJ8V0mqYJ8R2htFrNUL06rHDzua14l2ZFqLvQ'

Example response

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

{
  "id" : "f3d79e90-a0e7-43ff-92c9-cc3fecbb0317",
  "networkId" : "d0917e31-a059-4e01-8966-5a96163c26fb",
  "zitiId" : "ziti.id.exhu856yivg",
  "name" : "My Service Edge Router Policy 54588024043480980",
  "semantic" : "AnyOf",
  "ownerIdentityId" : "f94257f0-642c-4cdb-8ef8-5ee95a177f02",
  "createdBy" : "f94257f0-642c-4cdb-8ef8-5ee95a177f02",
  "createdAt" : "2021-05-04T17:08:24.336871Z",
  "updatedAt" : "2021-05-04T17:08:24.341256Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "serviceAttributes" : [ "#service-2", "#service-1" ],
  "edgeRouterAttributes" : [ "#router-1", "#router-2" ],
  "authority" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d0917e31-a059-4e01-8966-5a96163c26fb",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/f3d79e90-a0e7-43ff-92c9-cc3fecbb0317"
    }
  }
}

Optional

Description

networkId

String

true

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

name

String

true

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

semantic

String

true

io.netfoundry.common.util.validation.ValidAs.
Must be one of [AllOf, AnyOf].

edgeRouterAttributes

Array[String]

true

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

serviceAttributes

Array[String]

true

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

Response fields

Path

Type

Optional

Description

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

true

serviceAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

authority

Object

false

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJoSHVtRG51OXVYZVdyMGJrdUplemNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY5NDI1N2YwLTY0MmMtNGNkYi04ZWY4LTVlZTk1YTE3N2YwMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEwNCwiZXhwIjoxNjIwMTUxNzA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImU3ZjViNWViLTQ2M2EtNGYxMi1iNGRkLTZlYjRkNmNkYTg5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.d_ZcRxrbwD282VZzKVEhy7hMYrNLf9evk-WGuHNqDWMDwuWCUtmvhyT0a6XaJTmiDJY7F4rxhR6nf3DaPGJfhp8Qxreb3YMEamlcKbUNC7uW-IHHEzKyVF_YMCudJlha9apsA2WUIwECgADtQYNOeWka9dmu5-4majpjp-eUJySzFZB1kvd9aKP4ZUxMito1C2JjyNZwKlAFU43ITCVnsn2F7sEHNlEgduufLH3iH5OtIOKkJOzmlAN1PguXTA_0P1j2NAyjwUfN0O-i8IQ5kxbVbd0NfkFnHu-k76jpAAnpVnjdzTM73J3EVfpyrL-AxxEQr8vTh0ja32taRBt2YA' \
    -d '{"networkId":"d0917e31-a059-4e01-8966-5a96163c26fb","name":"My Service Edge Router Policy 54588024043480980","semantic":"AnyOf","edgeRouterAttributes":["#router-1","#router-2"],"serviceAttributes":["#service-1","#service-2"]}'

Example response

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

{
  "id" : "f3d79e90-a0e7-43ff-92c9-cc3fecbb0317",
  "networkId" : "d0917e31-a059-4e01-8966-5a96163c26fb",
  "zitiId" : "ziti.id.exhu856yivg",
  "name" : "My Service Edge Router Policy 54588024043480980",
  "semantic" : "AnyOf",
  "ownerIdentityId" : "f94257f0-642c-4cdb-8ef8-5ee95a177f02",
  "createdBy" : "f94257f0-642c-4cdb-8ef8-5ee95a177f02",
  "createdAt" : "2021-05-04T17:08:24.336871Z",
  "updatedAt" : "2021-05-04T17:08:24.341256Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "serviceAttributes" : [ "#service-2", "#service-1" ],
  "edgeRouterAttributes" : [ "#router-1", "#router-2" ],
  "authority" : null
}

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.

semantic

String

true

io.netfoundry.common.util.validation.ValidAs.
Must be one of [AllOf, AnyOf].

serviceAttributes

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

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

true

serviceAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

authority

Object

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/service-edge-router-policies/f3d79e90-a0e7-43ff-92c9-cc3fecbb0317' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJpcXc5MDdOM0I2eFBIZ21kamNLZURnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYzZTQyNmIzLWE0MzYtNGNmYS1hYTc1LTIyZDY2NzhmNzY1YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEwNCwiZXhwIjoxNjIwMTUxNzA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImU1MDU2YzM5LTZiYTItNDFlYS1hMzUxLTU5YWQwZGUyZTE2MVwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.La3KB9mPzWVrzwhsMKgQgOCiYmwLHW1-rTOqHEplNKLP1ABuJD70HrgwD8xGJlhW0F2sBITchUBDNGFUOWHSMMSIKqZJz_PInEIBfoi09FoSgMwTE8HXWmJ6LcEatlCdsbGqFlgblJ_yt5ZruJdiT54Wvj52PFolkkEum1_eKq0bmMpdpRQHta_SHwSe53ASOQevkMPd7IdfZLews1qiFUiViIIHXR1yRAG5v3Xc7Jjhyt7QGt1wJePnreYizjhwnlbcxeqyykVIwrXWNPRABFP55G8ISf8G5p6kHS62_eafdAJNR6j1oEihzadfCz_RRzbmufoAzm0NgkGBhnYSZA' \
    -d '{"name":"My Service Edge Router Policy 54588024043480980","semantic":"AllOf","serviceAttributes":["#service-1","#service-5"],"edgeRouterAttributes":["#router-3"]}'

Example response

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

{
  "id" : "f3d79e90-a0e7-43ff-92c9-cc3fecbb0317",
  "networkId" : "d0917e31-a059-4e01-8966-5a96163c26fb",
  "zitiId" : "ziti.id.exhu856yivg",
  "name" : "My Service Edge Router Policy 54588024043480980",
  "semantic" : "AnyOf",
  "ownerIdentityId" : "f94257f0-642c-4cdb-8ef8-5ee95a177f02",
  "createdBy" : "f94257f0-642c-4cdb-8ef8-5ee95a177f02",
  "createdAt" : "2021-05-04T17:08:24.336871Z",
  "updatedAt" : "2021-05-04T17:08:24.341256Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "serviceAttributes" : [ "#service-1", "#service-5" ],
  "edgeRouterAttributes" : [ "#router-3" ],
  "authority" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d0917e31-a059-4e01-8966-5a96163c26fb",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/f3d79e90-a0e7-43ff-92c9-cc3fecbb0317"
    }
  }
}

false

Client must have delete action on the annotated resource.

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/f3d79e90-a0e7-43ff-92c9-cc3fecbb0317' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJtWkdFdzB1a01SVmhzQXluc0k5Z1BBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRjZDdmZGEzLWI3ZWMtNGY1Yy1hNWUxLTBmODNlMDIwNTU0NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYyMDE0ODEwNCwiZXhwIjoxNjIwMTUxNzA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjRiZWZhN2I2LWU4YmQtNGI3OS1iN2YwLTViODc5ZjZkNjgxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTYyMDE0ODEwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.dRqZUgGvalHdQuMw5c_zHw7QoVdtakDcTepFR-jfYvSf3qzCDfFp-q9ezu_SNtvXH3yB489K3mVrAWfZxHPAmkMEzI_xw8qKrtIlAXpVmyI5faiprANcJTcQ45wZUoQdiwDsRv4hVgq4mbxIh44hz8Wn5vVP0gbpRPXLF1HMb0jQeV2MFW-cnu4t6ILyr1ttgbnZv6zAYJjYMCMjynzWvDnLTC7kytmRFH8D7ihUwtLClwgP_99PB4pJfNSZQ-6DMNyCQcTT_3qaibPsUTiXwm8v_y_MYW4wzXcG2SR8-VXLCxVPZodVyKtTN3UIbSkibjvkhbh6WutcRFqTHG9aBw'

Example response

HTTP/1.1 200 OK

Type

Optional

Description

networkId

Object

true

name

String

true

zitiId

String

true

type

Object

true

Must be one of [Dial, Bind].

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

String

false

networkId

String

false

zitiId

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

type

String

false

Must be one of [Dial, Bind].

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

true

serviceAttributes

Array[String]

false

endpointAttributes

Array[String]

false

postureCheckAttributes

Array[String]

false

authority

Object

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

String

false

NetFoundry Network Management V2 Service Guide