Introduction

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

Overview

HTTP verbs

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

Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT

Used to update an existing resource, full updates only

PATCH

Used to update an existing resource, partial updates

DELETE

Used to delete an existing resource

HTTP status codes

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

Status code Usage

200 OK

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

201 Created

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

202 Accepted

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

204 No Content

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

400 Bad Request

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

401 Unauthorized

The request lacks valid authentication credentials for the target resource.

403 Forbidden

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

404 Not Found

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

Pagination

Paginated services will accept the following optional request parameters:

Table 1. Request parameters
Path Type Optional Description

page

Integer

true

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

size

Integer

true

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

sort

String

true

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

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

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

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.eyJqdGkiOiJEcVpfQlZJMDJsTVNyQkxSX0hZUmVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImExMjRhODRhLWE2OTctNGZlZS05NzcyLTdmMWRlZGM3MTk4OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5NjkzNywiZXhwIjoxNjE0MDAwNTM3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjlkMGVhYzEwLTUwZmMtNDZlMC05YWI2LWUzODdlMTNmYzk5ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5NjkzN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.seUtrNBsUw0Q3-ZwoedB44zeaB8RglgkZrpz82rXwSAh6MazZo8cZ5H4G63Az5ycK_9Ui3tH_hfjBUnL5WEqfxBAphdU2pxasDMhQ2gYbrv16NR0YDaaZCQE0n5lz-2nr150skTeHepqzw0k3OsTzowLcdAQ_ixYY0sXhtJBGPi1KwMXPdRu2g1kb-wx0J_0Ln4W1oQq99dHjnJGcHMDI1tUti08IAW_9VU5oi-aCpcbp5mhI7VyFC0rHHMJ_FGGOzXkNHUgpnVnX67NShe9vOlfNmPI-xXsz0ng7vaM9x6yarZhXEriRRcE14E3Q-5DP74qhnMMjhgq8_HPdi_jpw'

Example response

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

{
  "_embedded" : {
    "dataCenters" : [ {
      "id" : "083954bc-deb6-43e8-9108-de6b77f7c026",
      "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/083954bc-deb6-43e8-9108-de6b77f7c026"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/data-centers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Network Configurations

Find Network Config Metadata

GET /network-configs

Authorization

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

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

name

String

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

id

String

true

name

String

true

awsNetworkControllerSize

String

true

awsGatewaySize

String

true

awsTransferNodeSize

String

true

azureTransferNodeSize

String

true

alicloudTransferNodeSize

String

true

gcpTransferNodeSize

String

true

ocpTransferNodeSize

String

true

networkControllerVolumeSize

Integer

true

transferNodeVolumeSize

Integer

true

gatewayVolumeSize

Integer

true

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

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.eyJqdGkiOiJhX3Iwa0JmaGlRTFlrNmUzT1hiMElRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNiNDcwMTc4LWNkOWUtNGU1ZS1hZjU5LWM5ZjUyYzQ5MzNkOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5NjkzNywiZXhwIjoxNjE0MDAwNTM3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVhY2Q0YjViLWQzZGEtNGZkZi1hYzgyLTMwMDljY2QxM2U5N1wiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5NjkzN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.JjC6ZcCv4dbTH2VDyvk0LXxmdk2nR7EcyvLa8-TVTIWQD1kkO9BsI8DAyQnC7AC3y-In54qIowFLtFgfhgQtdMcBd49mRBb6LDUgdfJZU-sJpJPzWDaakhB_pM2W6b1Hbzb_CNkmuN--ADSMhlSpT6FaJHUUn8NNvfcgvkGLOcYzGfGCedSBw07kINrqNL7px4u4omLqfVN1GT9PuZ14JPotwHYuUSWwzUkY6AQAGj9y5dup806MgnK3rrUa59-B9Vz9ljWb5KAAs2cDsw30-fCdp89ExGD3Pwo5tWz28Y75DVL6caV0DEHetLVyK6xHV_Tds3PwAxG3dbH4aYQdug'

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

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

String

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

networkController.id

String

false

networkController.name

String

true

networkController.networkId

String

false

networkController.ipAddress

String

true

networkController.port

Integer

true

networkController.provider

String

true

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

networkController.providerId

String

true

networkController.locationMetadataId

String

true

networkController.userData

String

true

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

Path Optional Description

self

false

A canonical URI; The link to this resource.

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.

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

String

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

networkController.id

String

false

networkController.name

String

true

networkController.networkId

String

false

networkController.ipAddress

String

true

networkController.port

Integer

true

networkController.provider

String

true

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

networkController.providerId

String

true

networkController.locationMetadataId

String

true

networkController.userData

String

true

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

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJNbUFDWElxU040ZmtKMDE0dmNZQkxnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ0NmU3Mjk5LTE2YjUtNGZhOS1iNzYxLTkyOWIwYjljZTEwYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg3MiwiZXhwIjoxNjE0MDAwNDcyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ2MWQ5MjEyLTBiYTUtNDI2NC05YjJhLThmZDIxNDIxZGM2YlwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg3Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ccM3A3SIxS6-XlxzkYZfYLqAH5zTT0hIEntB1kqGiF27z_QcOO4k4JWbW8qQ54nqHXtPIbafDCfuy-yu2TtPvRs3mDjQyZc61lCgrrhVR1g3vRNm3yNBUGVagbPZ1uUPX-2Ta_EJ-IPXXnGkuy0SEZ1mYPpXC2IhY6qiD4i2lMz1fxvSxmajhxfGiH46ZZATCRxsSqOLuODnHnOTkYw5cS5M4AZ4cScfFrhDaS4STeP8eLpg8A8qNMa_Sr9rUVpRwoyg4Qk-3PPXqJGc0wK0y3s3-CSI_Mk7zHpYOIeKU2jAG5KOd1YiSHmFRJcCHPrcjCD6r7L13oNi7kQumXfHPQ'

Example response

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

{
  "_embedded" : {
    "networkList" : [ {
      "id" : "5cd7f252-2099-460b-ba51-00d4b6f3ed84",
      "ownerIdentityId" : "41c5605d-c6b9-4e85-9f07-4d730178c2f6",
      "createdBy" : "41c5605d-c6b9-4e85-9f07-4d730178c2f6",
      "createdAt" : "2021-02-22T12:27:51.904645Z",
      "updatedAt" : "2021-02-22T12:27:51.905602Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-02-22T12:27:51.903857Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.2.1",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5cd7f252-2099-460b-ba51-00d4b6f3ed84"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=5cd7f252-2099-460b-ba51-00d4b6f3ed84"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=5cd7f252-2099-460b-ba51-00d4b6f3ed84"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=5cd7f252-2099-460b-ba51-00d4b6f3ed84"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=5cd7f252-2099-460b-ba51-00d4b6f3ed84"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=5cd7f252-2099-460b-ba51-00d4b6f3ed84"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=5cd7f252-2099-460b-ba51-00d4b6f3ed84"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=5cd7f252-2099-460b-ba51-00d4b6f3ed84"
        }
      }
    }, {
      "id" : "480b5a5a-4208-4977-91bd-f1b37bc4c15e",
      "ownerIdentityId" : "41c5605d-c6b9-4e85-9f07-4d730178c2f6",
      "createdBy" : "41c5605d-c6b9-4e85-9f07-4d730178c2f6",
      "createdAt" : "2021-02-22T12:27:51.906131Z",
      "updatedAt" : "2021-02-22T12:27:51.906131Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-02-22T12:27:51.905922Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/480b5a5a-4208-4977-91bd-f1b37bc4c15e"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=480b5a5a-4208-4977-91bd-f1b37bc4c15e"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=480b5a5a-4208-4977-91bd-f1b37bc4c15e"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=480b5a5a-4208-4977-91bd-f1b37bc4c15e"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=480b5a5a-4208-4977-91bd-f1b37bc4c15e"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=480b5a5a-4208-4977-91bd-f1b37bc4c15e"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=480b5a5a-4208-4977-91bd-f1b37bc4c15e"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=480b5a5a-4208-4977-91bd-f1b37bc4c15e"
        }
      }
    }, {
      "id" : "3ee7235c-1323-45af-9d57-a077554eecd9",
      "ownerIdentityId" : "41c5605d-c6b9-4e85-9f07-4d730178c2f6",
      "createdBy" : "41c5605d-c6b9-4e85-9f07-4d730178c2f6",
      "createdAt" : "2021-02-22T12:27:51.906618Z",
      "updatedAt" : "2021-02-22T12:27:51.907051Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-02-22T12:27:51.906399Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3ee7235c-1323-45af-9d57-a077554eecd9"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=3ee7235c-1323-45af-9d57-a077554eecd9"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=3ee7235c-1323-45af-9d57-a077554eecd9"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=3ee7235c-1323-45af-9d57-a077554eecd9"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=3ee7235c-1323-45af-9d57-a077554eecd9"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=3ee7235c-1323-45af-9d57-a077554eecd9"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=3ee7235c-1323-45af-9d57-a077554eecd9"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=3ee7235c-1323-45af-9d57-a077554eecd9"
        }
      }
    }, {
      "id" : "343d8b39-62f1-49ff-9fc1-e3a272ce795b",
      "ownerIdentityId" : "2cad4fc5-4a7b-423c-bde0-3a58a8065dca",
      "createdBy" : "2cad4fc5-4a7b-423c-bde0-3a58a8065dca",
      "createdAt" : "2021-02-22T12:27:52.161817Z",
      "updatedAt" : "2021-02-22T12:27:52.185642Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Test Network Yaml",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.1.0-59578434",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/343d8b39-62f1-49ff-9fc1-e3a272ce795b"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=343d8b39-62f1-49ff-9fc1-e3a272ce795b"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=343d8b39-62f1-49ff-9fc1-e3a272ce795b"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=343d8b39-62f1-49ff-9fc1-e3a272ce795b"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=343d8b39-62f1-49ff-9fc1-e3a272ce795b"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=343d8b39-62f1-49ff-9fc1-e3a272ce795b"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=343d8b39-62f1-49ff-9fc1-e3a272ce795b"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=343d8b39-62f1-49ff-9fc1-e3a272ce795b"
        }
      }
    }, {
      "id" : "872aa984-5080-4281-837f-027d7e6a0b20",
      "ownerIdentityId" : "7a087a77-c381-4f64-aaed-8439d761d3b4",
      "createdBy" : "7a087a77-c381-4f64-aaed-8439d761d3b4",
      "createdAt" : "2021-02-22T12:27:52.330052Z",
      "updatedAt" : "2021-02-22T12:27:52.330810Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-02-22T12:27:52.329624Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.2.1",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/872aa984-5080-4281-837f-027d7e6a0b20"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=872aa984-5080-4281-837f-027d7e6a0b20"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=872aa984-5080-4281-837f-027d7e6a0b20"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=872aa984-5080-4281-837f-027d7e6a0b20"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=872aa984-5080-4281-837f-027d7e6a0b20"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=872aa984-5080-4281-837f-027d7e6a0b20"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=872aa984-5080-4281-837f-027d7e6a0b20"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=872aa984-5080-4281-837f-027d7e6a0b20"
        }
      }
    }, {
      "id" : "2f33d414-6a08-4471-9380-e8e264a7c051",
      "ownerIdentityId" : "7a087a77-c381-4f64-aaed-8439d761d3b4",
      "createdBy" : "7a087a77-c381-4f64-aaed-8439d761d3b4",
      "createdAt" : "2021-02-22T12:27:52.331411Z",
      "updatedAt" : "2021-02-22T12:27:52.331411Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-02-22T12:27:52.331186Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2f33d414-6a08-4471-9380-e8e264a7c051"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=2f33d414-6a08-4471-9380-e8e264a7c051"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=2f33d414-6a08-4471-9380-e8e264a7c051"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=2f33d414-6a08-4471-9380-e8e264a7c051"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=2f33d414-6a08-4471-9380-e8e264a7c051"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=2f33d414-6a08-4471-9380-e8e264a7c051"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=2f33d414-6a08-4471-9380-e8e264a7c051"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=2f33d414-6a08-4471-9380-e8e264a7c051"
        }
      }
    }, {
      "id" : "5463fa69-bcd5-41ef-a93b-ad75145ad438",
      "ownerIdentityId" : "7a087a77-c381-4f64-aaed-8439d761d3b4",
      "createdBy" : "7a087a77-c381-4f64-aaed-8439d761d3b4",
      "createdAt" : "2021-02-22T12:27:52.331881Z",
      "updatedAt" : "2021-02-22T12:27:52.332340Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-02-22T12:27:52.331685Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5463fa69-bcd5-41ef-a93b-ad75145ad438"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=5463fa69-bcd5-41ef-a93b-ad75145ad438"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=5463fa69-bcd5-41ef-a93b-ad75145ad438"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=5463fa69-bcd5-41ef-a93b-ad75145ad438"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=5463fa69-bcd5-41ef-a93b-ad75145ad438"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=5463fa69-bcd5-41ef-a93b-ad75145ad438"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=5463fa69-bcd5-41ef-a93b-ad75145ad438"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=5463fa69-bcd5-41ef-a93b-ad75145ad438"
        }
      }
    }, {
      "id" : "d779cc34-581c-44ef-9558-424b2be59c96",
      "ownerIdentityId" : "859c3505-a13c-41f5-98f0-f8321ee60ea0",
      "createdBy" : "859c3505-a13c-41f5-98f0-f8321ee60ea0",
      "createdAt" : "2021-02-22T12:27:52.374158Z",
      "updatedAt" : "2021-02-22T12:27:52.374925Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-02-22T12:27:52.373722Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.2.1",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d779cc34-581c-44ef-9558-424b2be59c96"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
        }
      }
    }, {
      "id" : "f864c602-69bb-45c6-b6a3-19e0693619cd",
      "ownerIdentityId" : "859c3505-a13c-41f5-98f0-f8321ee60ea0",
      "createdBy" : "859c3505-a13c-41f5-98f0-f8321ee60ea0",
      "createdAt" : "2021-02-22T12:27:52.375465Z",
      "updatedAt" : "2021-02-22T12:27:52.375465Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-02-22T12:27:52.375252Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f864c602-69bb-45c6-b6a3-19e0693619cd"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=f864c602-69bb-45c6-b6a3-19e0693619cd"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=f864c602-69bb-45c6-b6a3-19e0693619cd"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=f864c602-69bb-45c6-b6a3-19e0693619cd"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=f864c602-69bb-45c6-b6a3-19e0693619cd"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=f864c602-69bb-45c6-b6a3-19e0693619cd"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=f864c602-69bb-45c6-b6a3-19e0693619cd"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=f864c602-69bb-45c6-b6a3-19e0693619cd"
        }
      }
    }, {
      "id" : "bb9848db-1db2-4506-a88d-679a29469c4b",
      "ownerIdentityId" : "859c3505-a13c-41f5-98f0-f8321ee60ea0",
      "createdBy" : "859c3505-a13c-41f5-98f0-f8321ee60ea0",
      "createdAt" : "2021-02-22T12:27:52.375947Z",
      "updatedAt" : "2021-02-22T12:27:52.376381Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-02-22T12:27:52.375760Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bb9848db-1db2-4506-a88d-679a29469c4b"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=bb9848db-1db2-4506-a88d-679a29469c4b"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=bb9848db-1db2-4506-a88d-679a29469c4b"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=bb9848db-1db2-4506-a88d-679a29469c4b"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=bb9848db-1db2-4506-a88d-679a29469c4b"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=bb9848db-1db2-4506-a88d-679a29469c4b"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=bb9848db-1db2-4506-a88d-679a29469c4b"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=bb9848db-1db2-4506-a88d-679a29469c4b"
        }
      }
    }, {
      "id" : "f600c3bf-7ea0-4599-b52b-b1dae2cb755b",
      "ownerIdentityId" : "afd6b85f-34ae-4efe-b103-597ac4d1b208",
      "createdBy" : "afd6b85f-34ae-4efe-b103-597ac4d1b208",
      "createdAt" : "2021-02-22T12:27:52.439516Z",
      "updatedAt" : "2021-02-22T12:27:52.440227Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-02-22T12:27:52.439121Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.2.1",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f600c3bf-7ea0-4599-b52b-b1dae2cb755b"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=f600c3bf-7ea0-4599-b52b-b1dae2cb755b"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=f600c3bf-7ea0-4599-b52b-b1dae2cb755b"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=f600c3bf-7ea0-4599-b52b-b1dae2cb755b"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=f600c3bf-7ea0-4599-b52b-b1dae2cb755b"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=f600c3bf-7ea0-4599-b52b-b1dae2cb755b"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=f600c3bf-7ea0-4599-b52b-b1dae2cb755b"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=f600c3bf-7ea0-4599-b52b-b1dae2cb755b"
        }
      }
    }, {
      "id" : "580e16d0-bc33-4a10-9cf8-6b7e2ab23422",
      "ownerIdentityId" : "afd6b85f-34ae-4efe-b103-597ac4d1b208",
      "createdBy" : "afd6b85f-34ae-4efe-b103-597ac4d1b208",
      "createdAt" : "2021-02-22T12:27:52.440765Z",
      "updatedAt" : "2021-02-22T12:27:52.440765Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-02-22T12:27:52.440555Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/580e16d0-bc33-4a10-9cf8-6b7e2ab23422"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=580e16d0-bc33-4a10-9cf8-6b7e2ab23422"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=580e16d0-bc33-4a10-9cf8-6b7e2ab23422"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=580e16d0-bc33-4a10-9cf8-6b7e2ab23422"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=580e16d0-bc33-4a10-9cf8-6b7e2ab23422"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=580e16d0-bc33-4a10-9cf8-6b7e2ab23422"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=580e16d0-bc33-4a10-9cf8-6b7e2ab23422"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=580e16d0-bc33-4a10-9cf8-6b7e2ab23422"
        }
      }
    }, {
      "id" : "6c03a409-264f-4f88-b637-ff7eeffc2b47",
      "ownerIdentityId" : "afd6b85f-34ae-4efe-b103-597ac4d1b208",
      "createdBy" : "afd6b85f-34ae-4efe-b103-597ac4d1b208",
      "createdAt" : "2021-02-22T12:27:52.441264Z",
      "updatedAt" : "2021-02-22T12:27:52.441696Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-02-22T12:27:52.441051Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6c03a409-264f-4f88-b637-ff7eeffc2b47"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=6c03a409-264f-4f88-b637-ff7eeffc2b47"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=6c03a409-264f-4f88-b637-ff7eeffc2b47"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=6c03a409-264f-4f88-b637-ff7eeffc2b47"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=6c03a409-264f-4f88-b637-ff7eeffc2b47"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=6c03a409-264f-4f88-b637-ff7eeffc2b47"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=6c03a409-264f-4f88-b637-ff7eeffc2b47"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=6c03a409-264f-4f88-b637-ff7eeffc2b47"
        }
      }
    }, {
      "id" : "f6aa1f39-2a39-4813-b95e-02fc7eb7cd70",
      "ownerIdentityId" : "4075cebe-f713-495e-af26-00d2a72fd589",
      "createdBy" : "4075cebe-f713-495e-af26-00d2a72fd589",
      "createdAt" : "2021-02-22T12:27:52.475513Z",
      "updatedAt" : "2021-02-22T12:27:52.482112Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Upload Test Network",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.1.0-59578434",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f6aa1f39-2a39-4813-b95e-02fc7eb7cd70"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=f6aa1f39-2a39-4813-b95e-02fc7eb7cd70"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=f6aa1f39-2a39-4813-b95e-02fc7eb7cd70"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=f6aa1f39-2a39-4813-b95e-02fc7eb7cd70"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=f6aa1f39-2a39-4813-b95e-02fc7eb7cd70"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=f6aa1f39-2a39-4813-b95e-02fc7eb7cd70"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=f6aa1f39-2a39-4813-b95e-02fc7eb7cd70"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=f6aa1f39-2a39-4813-b95e-02fc7eb7cd70"
        }
      }
    }, {
      "id" : "a806bce8-3dd6-4e7a-8e07-d6d8af9090c3",
      "ownerIdentityId" : "92e0d3fc-af81-44f8-b9aa-13ba0e659d47",
      "createdBy" : "92e0d3fc-af81-44f8-b9aa-13ba0e659d47",
      "createdAt" : "2021-02-22T12:27:52.533865Z",
      "updatedAt" : "2021-02-22T12:27:52.534573Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network2021-02-22T12:27:52.533466Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.2.1",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a806bce8-3dd6-4e7a-8e07-d6d8af9090c3"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=a806bce8-3dd6-4e7a-8e07-d6d8af9090c3"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=a806bce8-3dd6-4e7a-8e07-d6d8af9090c3"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=a806bce8-3dd6-4e7a-8e07-d6d8af9090c3"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=a806bce8-3dd6-4e7a-8e07-d6d8af9090c3"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=a806bce8-3dd6-4e7a-8e07-d6d8af9090c3"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=a806bce8-3dd6-4e7a-8e07-d6d8af9090c3"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=a806bce8-3dd6-4e7a-8e07-d6d8af9090c3"
        }
      }
    }, {
      "id" : "a52d6590-dd6d-46f6-a6f4-bc7a0baf418e",
      "ownerIdentityId" : "92e0d3fc-af81-44f8-b9aa-13ba0e659d47",
      "createdBy" : "92e0d3fc-af81-44f8-b9aa-13ba0e659d47",
      "createdAt" : "2021-02-22T12:27:52.535105Z",
      "updatedAt" : "2021-02-22T12:27:52.535105Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network Unprovisioned 2021-02-22T12:27:52.534893Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONING",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a52d6590-dd6d-46f6-a6f4-bc7a0baf418e"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=a52d6590-dd6d-46f6-a6f4-bc7a0baf418e"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=a52d6590-dd6d-46f6-a6f4-bc7a0baf418e"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=a52d6590-dd6d-46f6-a6f4-bc7a0baf418e"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=a52d6590-dd6d-46f6-a6f4-bc7a0baf418e"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=a52d6590-dd6d-46f6-a6f4-bc7a0baf418e"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=a52d6590-dd6d-46f6-a6f4-bc7a0baf418e"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=a52d6590-dd6d-46f6-a6f4-bc7a0baf418e"
        }
      }
    }, {
      "id" : "e91ae786-d9ad-40fc-8007-4dda02b1fd5f",
      "ownerIdentityId" : "92e0d3fc-af81-44f8-b9aa-13ba0e659d47",
      "createdBy" : "92e0d3fc-af81-44f8-b9aa-13ba0e659d47",
      "createdAt" : "2021-02-22T12:27:52.535566Z",
      "updatedAt" : "2021-02-22T12:27:52.535997Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME Network With Breakout2021-02-22T12:27:52.535379Z",
      "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
      "size" : "small",
      "productVersion" : "7.0.0",
      "status" : "PROVISIONED",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e91ae786-d9ad-40fc-8007-4dda02b1fd5f"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=e91ae786-d9ad-40fc-8007-4dda02b1fd5f"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=e91ae786-d9ad-40fc-8007-4dda02b1fd5f"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=e91ae786-d9ad-40fc-8007-4dda02b1fd5f"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=e91ae786-d9ad-40fc-8007-4dda02b1fd5f"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=e91ae786-d9ad-40fc-8007-4dda02b1fd5f"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=e91ae786-d9ad-40fc-8007-4dda02b1fd5f"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=e91ae786-d9ad-40fc-8007-4dda02b1fd5f"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks{?findByName,findByNetworkGroupId,productVersion,status}",
      "templated" : true
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 17,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Network

GET /networks/{id}

Authorization

This endpoint requires read action on the network resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

networkGroupId

String

false

size

String

false

productVersion

String

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

networkController.id

String

false

networkController.name

String

true

networkController.networkId

String

false

networkController.ipAddress

String

true

networkController.port

Integer

true

networkController.provider

String

true

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

networkController.providerId

String

true

networkController.locationMetadataId

String

true

networkController.userData

String

true

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

Path Optional Description

self

false

A canonical URI; The link to this resource.

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.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks/d779cc34-581c-44ef-9558-424b2be59c96' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ2T056TUNGbFZwRDNfU0FwNGRZaGpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc4MGYwYTg0LTIwYmEtNGViYS1hMjE3LTdmNWZkMzI4ZDdmMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg3MiwiZXhwIjoxNjE0MDAwNDcyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjNiNTAyYjhjLTYyNzUtNDdiMS1hNmZhLTVmYmRiYmNhZWFjYlwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg3Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.syni0EH8c7d9vM9vG1aP_ukdawQ6u0Hd_cHJHj19T_c-6B5SUWwLslGeDbLIVyiJ-PYHA-V9-rXmXDb2MDjxrOvBTFMsSgxuHYOVnm_GGdjT8rzLbiaGz_ShQqu3wU3cKYcn8t-1_3fclhOnVuIVVwoSfmFSsybOBu7iVTO-ZzQWOXFd5at45rjAXtSMIcqJJ7FR_xRHZ9mmVWbNzbLbwqyYp2iErcuWJcTzHpu_KSlgPWZEUcar-FoOYvl9DhgSCGMsf3x-d08pXB_w9rtc5fG-vv2Bbs_BNYSGfM-0JGcQNjjXJGuja95YXjMm-wyBwXSLmbVU2YAxklFGpHQGaQ'

Example response

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

{
  "id" : "d779cc34-581c-44ef-9558-424b2be59c96",
  "ownerIdentityId" : "859c3505-a13c-41f5-98f0-f8321ee60ea0",
  "createdBy" : "859c3505-a13c-41f5-98f0-f8321ee60ea0",
  "createdAt" : "2021-02-22T12:27:52.374158Z",
  "updatedAt" : "2021-02-22T12:27:52.374925Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "ACME Network2021-02-22T12:27:52.373722Z",
  "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
  "size" : "small",
  "productVersion" : "7.2.1",
  "status" : "PROVISIONED",
  "o365BreakoutCategory" : "NONE",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d779cc34-581c-44ef-9558-424b2be59c96"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=d779cc34-581c-44ef-9558-424b2be59c96"
    }
  }
}

Create Network

POST /networks

Authorization

This endpoint requires create action on the network resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkGroupId

String

true

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

networkConfigMetadataId

String

true

Deprecated..

size

String

true

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

name

String

true

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

productVersion

String

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

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.

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

String

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

networkController.id

String

false

networkController.name

String

true

networkController.networkId

String

false

networkController.ipAddress

String

true

networkController.port

Integer

true

networkController.provider

String

true

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

networkController.providerId

String

true

networkController.locationMetadataId

String

true

networkController.userData

String

true

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

Path Optional Description

self

false

A canonical URI; The link to this resource.

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.

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.eyJqdGkiOiJsdThBbUVlSVl6TzlIUFNJNjJadzlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFjYmY5MDFkLWEyYjYtNDdiZi1iODBlLTY4ZDY2ODI0ZjJmNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg3MiwiZXhwIjoxNjE0MDAwNDcyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA1MGNiYTRiLWI5ZjgtNDU0Zi05YmJlLWU3ODk2OTA4YzUxOVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg3Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.r5HuNwa8gNnCx-o51sNfWdXe4Q9WuwweXcReDC8OrB7rGlkL5f0AFqzDu0O14584dY7QDhrBCvtud_lqgsZFpv19xTW9mEjEXk_NfBEgrj2M7CuYghAqpnJM9Jqw9WFYh3u85yR_PxLa-wXUoCvt76mQB6HkjufxBRBUlqkdxpYvbS6FA49rsxGj2LZHNDYMb0ssP-Ujx-zQJDBoRK5ma_KE_Yc41jGKguTcHP7YEcpFxHJh-RofEZuOPP6Oajhyw_sBZqLZgr9VhmXFRTl-f2rjRTbgJeobxuUxDSu90d6SxhbuNSGrlJ0ZstKYXGlBCzQ_KYrfmQDqtFp6XYe_sw' \
    -d '{"networkGroupId":"7cd8dc8e-0327-40b2-abbf-24149577fa2a","size":"small","name":"Create Test Network","o365BreakoutCategory":"NONE","locationCode":"us-east-1","edgeRouters":[],"edgeRouterPolicies":[],"services":[],"certificateAuthorities":[],"endpoints":[],"appWans":[]}'

Example response

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

{
  "id" : "c5530a48-b8aa-44bb-b885-50a4459e23e7",
  "ownerIdentityId" : "acbf901d-a2b6-47bf-b80e-68d66824f2f5",
  "createdBy" : "acbf901d-a2b6-47bf-b80e-68d66824f2f5",
  "createdAt" : "2021-02-22T12:27:52.769396Z",
  "updatedAt" : "2021-02-22T12:27:52.769396Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Create Test Network",
  "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
  "size" : "small",
  "productVersion" : "7.1.0-59578434",
  "status" : "PROVISIONING",
  "o365BreakoutCategory" : "NONE",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c5530a48-b8aa-44bb-b885-50a4459e23e7"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=c5530a48-b8aa-44bb-b885-50a4459e23e7"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=c5530a48-b8aa-44bb-b885-50a4459e23e7"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=c5530a48-b8aa-44bb-b885-50a4459e23e7"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=c5530a48-b8aa-44bb-b885-50a4459e23e7"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=c5530a48-b8aa-44bb-b885-50a4459e23e7"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=c5530a48-b8aa-44bb-b885-50a4459e23e7"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=c5530a48-b8aa-44bb-b885-50a4459e23e7"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/ca062f2c-8d05-453b-87f8-e95b92191fca",
      "profile" : "meta"
    }
  }
}

Delete Network

DELETE /networks/{id}

Authorization

This endpoint requires delete action on the network resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

networkGroupId

String

false

size

String

false

productVersion

String

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

networkController.id

String

false

networkController.name

String

true

networkController.networkId

String

false

networkController.ipAddress

String

true

networkController.port

Integer

true

networkController.provider

String

true

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

networkController.providerId

String

true

networkController.locationMetadataId

String

true

networkController.userData

String

true

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

Path Optional Description

self

false

A canonical URI; The link to this resource.

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.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks/7c82a546-6236-4efa-be00-bdc6532bee0b' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ1TUxmWVRfelhadE9pR0l1Y3ZZVXRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA3ZDUzNDNkLTNhN2YtNDExMC1iMmZkLWU5OGRkODgyYzZmYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg3MywiZXhwIjoxNjE0MDAwNDczLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImEzOGY2OTBiLTM2NjYtNDU3ZC1iMzk2LWNlNmRjYzg2ZTNkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg3M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Gu1_GTUsRbWijVuY4l7S3eomfIYrz2Q-0C7KQCtu5uW5Qm1ffMn9M8v0x7WSJjiC-yRqVuqOSKHBYu_IK7dtwQW_36dPlssQc7vZxEVOHWoN6Ptw5Ckuqc9a9futG7TMZwBQQtcweQG1G1J521Q__8c2haE3Pyj02TiuPoZXsNoMq5I_WcKDlwgqDjVCuAvaecBEIMuXZJDznomWfA_3WQgnM0LibdWTBktzkgsxI21uzqRUNPZmP_X6K-naLi0PFIdGqpsV6vRS1viPr7oetvHOKse1JVi1PE8BZGl_MOpjipYrIphN6nK85yzj43TqbUxtSNRP7vtIeguOKc8WVQ'

Example response

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

{
  "id" : "7c82a546-6236-4efa-be00-bdc6532bee0b",
  "ownerIdentityId" : "8d6525d3-e403-4028-8e14-5886e1a5ca3e",
  "createdBy" : "8d6525d3-e403-4028-8e14-5886e1a5ca3e",
  "createdAt" : "2021-02-22T12:27:53.738089Z",
  "updatedAt" : "2021-02-22T12:27:53.759601Z",
  "deletedBy" : "07d5343d-3a7f-4110-b2fd-e98dd882c6fc",
  "deletedAt" : null,
  "name" : "ACME Network2021-02-22T12:27:53.737888Z",
  "networkGroupId" : "7cd8dc8e-0327-40b2-abbf-24149577fa2a",
  "size" : "small",
  "productVersion" : "7.2.1",
  "status" : "DELETING",
  "o365BreakoutCategory" : "NONE",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/7c82a546-6236-4efa-be00-bdc6532bee0b"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=7c82a546-6236-4efa-be00-bdc6532bee0b"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=7c82a546-6236-4efa-be00-bdc6532bee0b"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=7c82a546-6236-4efa-be00-bdc6532bee0b"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=7c82a546-6236-4efa-be00-bdc6532bee0b"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=7c82a546-6236-4efa-be00-bdc6532bee0b"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=7c82a546-6236-4efa-be00-bdc6532bee0b"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=7c82a546-6236-4efa-be00-bdc6532bee0b"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/d52830e0-fa1b-4e50-b5a3-8595ee0554f5",
      "profile" : "meta"
    }
  }
}

Endpoints

Find Endpoints

GET /endpoints

Authorization

This endpoint requires read action on the endpoint resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

name

String

true

zitiId

String

true

hasApiSession

Boolean

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

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

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvZkNFR0xzUkR6bXBZVUFYNEZWc2xBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIxZmFiZjAzLWFlMGItNGUzZS04NzEzLWEyNWRlZDM3OTEyNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg5NSwiZXhwIjoxNjE0MDAwNDk1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImVhZTlmZDkxLTY3NTMtNGNkOC04ZTcwLWQ4YzI3ZjgxNDk4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg5NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.rdJaebGNreoohfn2x1cLoaVgZjLgsqBPbUZa3g91SJAdU0QkjiMpfhPFDV_Qhsi4xFhAZ2u3HQeUX6mGABYMn0dHmKwrFgm0DUw1z_MhNY8-GBTfHIh4leHdK8QMM5laeju5Qo-au4jBB8GOJs6u8jIgFM0Oi19tAIqApCjQgBPmkSSaVfOAr8dya0bwZe_0xzQP8daBgeOTbYzB0dq3vO7Tm3MAsPaLlydIqPg5PgU-_Uv4OinH43YULOz5g5jYM5El1Jndeb92L1zIANtpvlcylolP5C7CnBUCBy1ELdP90CIfvKXtDYhcTWK_mqb78wGbIqc0O0Bnx0vjAD7Hvg'

Example response

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

{
  "_embedded" : {
    "endpointList" : [ {
      "id" : "81cb3ddc-41a5-4f29-9104-caaf04ffc205",
      "ownerIdentityId" : "b97ba4a2-56b1-45bb-98ce-7647ac546680",
      "createdBy" : "b97ba4a2-56b1-45bb-98ce-7647ac546680",
      "createdAt" : "2021-02-22T12:28:15.221560Z",
      "updatedAt" : "2021-02-22T12:28:15.221560Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "e0aba630-4748-493a-9b76-4b0e6ff8108a",
      "zitiId" : "79a44564-a20d-4ab9-a44d-e6842cc14e14",
      "name" : "Test_endpoint2021-02-22T12:28:15.221314Z",
      "appId" : null,
      "appVersion" : null,
      "branch" : null,
      "revision" : null,
      "type" : null,
      "version" : null,
      "arch" : null,
      "os" : null,
      "osRelease" : null,
      "osVersion" : null,
      "hasApiSession" : false,
      "hasEdgeRouterConnection" : false,
      "sessionIdentityId" : null,
      "syncId" : null,
      "syncResourceId" : null,
      "attributes" : [ ],
      "sessionActive" : true,
      "jwt" : "jwthere",
      "mfaEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e0aba630-4748-493a-9b76-4b0e6ff8108a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/81cb3ddc-41a5-4f29-9104-caaf04ffc205"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Endpoint

GET /endpoints/{id}

Authorization

This endpoint requires read action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

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

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/cb420dc5-9171-4dc0-8bbd-5e69ad99b4a5' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvY1c5SFExd1pHbzJ0NU5KcVFXZzJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY5YmNiYzllLTM5Y2UtNDFkZC1hODAyLTFlNGJlODVkNDYxZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg5NiwiZXhwIjoxNjE0MDAwNDk2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFmMWY3MzZmLWVkN2UtNGQ3Yi04MzI3LTIzNTc2MjRiYmM4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg5Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.HA0QcHy19IViLQOLmdaYgIXeJmhF1NeOGuWFQHDNlRXsPtP_CdxiBIrfWXFO9ERqcMgVtkfnhwTd-qp5by8HRxhhJ_N76IPYqolXgRIG4V4GTpNeVZQJv9GUEEPECgkkewNRe8HYtTiG6oAtV0Ap2nPPrWC6U_NH0p4x54GbhXm3F8xda6OjxUzMokmi048If9lEwK9TLJu_LfaLv9sxRUP3hE8mqeFtq3B7cVK6d-igITAyovXERVAYW8HiHMgHwAs3kpOVwdx1RD_nHIG5dsRjLV9NaHV7fzPEnHgz5OdhYFlDc9AaUFWzGkW7o_4tt2w5ZO21ULtlmYMtB0hZ4Q'

Example response

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

{
  "id" : "cb420dc5-9171-4dc0-8bbd-5e69ad99b4a5",
  "ownerIdentityId" : "a0d73fdc-b721-4e0a-b868-ef30c30ce713",
  "createdBy" : "a0d73fdc-b721-4e0a-b868-ef30c30ce713",
  "createdAt" : "2021-02-22T12:28:16.230301Z",
  "updatedAt" : "2021-02-22T12:28:16.230301Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "4ee56aa5-f614-41c4-af37-eb2b7a90556c",
  "zitiId" : "40eeed1b-e1d1-4359-9676-e1ef8dcbb115",
  "name" : "Test_endpoint2021-02-22T12:28:16.230119Z",
  "appId" : null,
  "appVersion" : null,
  "branch" : null,
  "revision" : null,
  "type" : null,
  "version" : null,
  "arch" : null,
  "os" : null,
  "osRelease" : null,
  "osVersion" : null,
  "hasApiSession" : false,
  "hasEdgeRouterConnection" : false,
  "sessionIdentityId" : null,
  "syncId" : null,
  "syncResourceId" : null,
  "attributes" : [ ],
  "sessionActive" : true,
  "jwt" : "jwthere",
  "mfaEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4ee56aa5-f614-41c4-af37-eb2b7a90556c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/cb420dc5-9171-4dc0-8bbd-5e69ad99b4a5"
    }
  }
}

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

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

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.eyJqdGkiOiJESjVnbk5RcTRPY3BEZFN1ZlZ3ZTlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM5NDk5YjQxLWMyNzAtNGY1OS05MzM4LTU5MzE5ZmJlNTc1OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg5NSwiZXhwIjoxNjE0MDAwNDk1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjY0ZmM5NmU1LTMxOTItNDhmYS1hOGQyLTNkMmE2ZjYyNTYzZFwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg5NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.XmfyqeaoE5psNtbumHGVj7-obZg66lnZNK72CJEN7XeIyblAAVy4sw4AazbOFtQOdaYJOYBUWerzAtSIiEjNVUYrJAxNbezVcw_ZxsswzU2tnOFZ1YpwFJy6PCQztQ3dXIZWhtmpjYWocb2xButwnturb6FRfUGpPCQN9Aprtvy_fC_X5ElsmLM68uCLJq3O4RIUVhSbzIx9jDRxc-4aNkH6LtTEGECYOowpmUQNH4Byf5-O5wiEOWdNmvLaLxITPue09dtoA8c0gQlYjn6-W-766hYMa3LufnAjK8yuI4AOpS3HFAW8rkizyUrTTpc3WE9CQ-UT-V3I0zKGU1K4aA' \
    -d '{"networkId":"dae0daed-f78a-401d-9e4a-e8399a588a38","name":"Test endpoint 02","enrollmentMethod":{"ott":true,"updb":null,"ottca":null},"attributes":["#clients"]}'

Example response

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

{
  "id" : "9cb394fd-5f11-4a45-a96d-af1bde678877",
  "ownerIdentityId" : "39499b41-c270-4f59-9338-59319fbe5759",
  "createdBy" : "39499b41-c270-4f59-9338-59319fbe5759",
  "createdAt" : "2021-02-22T12:28:15.393859Z",
  "updatedAt" : "2021-02-22T12:28:15.394989Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "dae0daed-f78a-401d-9e4a-e8399a588a38",
  "zitiId" : "0bb05138-033d-4f7c-83be-db3e4241d79d",
  "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,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dae0daed-f78a-401d-9e4a-e8399a588a38",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/9cb394fd-5f11-4a45-a96d-af1bde678877"
    }
  }
}

Patch Endpoint

PATCH /endpoints/{id}

Authorization

This endpoint requires update action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

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

attributes

Array[String]

true

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

sessionIdentityId

Object

true

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

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

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/5f0152b0-ee2b-40e7-b510-4b6979e637b1' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNGpNdlpYYl9qcnVhNTRJYkk3Y2xnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBhOWI0NWM1LTA5NmQtNGEwMi1hZWUxLTMzNTI2MjVjMDVmMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg5NiwiZXhwIjoxNjE0MDAwNDk2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImMwNzU3MTEwLTMxMGEtNGIwYi04NmZhLWNhNjI0YjBjZDYxM1wiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg5Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.c3P0xDGa2SmUion5y3ZwUpf0-sgVQWGqZvyyHT6pllaTuAtupZTd-iVURmx83L833Vlk1i7tvFir7s-qI_Dz2NZqVSLIVB2yEKyyXbNFWW_IeOxJqs9yD81iZh5Zi8qCzLZ4bK89nK2ZQnf2ux8_e143bDRTVxtRoO6nqThRo-gUPHuzeKsB40GMLVx4Zj4mj2inafPddo5hs6mtlfCXyXP_eECEIA4Qgz5MNFYmpwZ6HEw0C5hPgxVtAybeTj3UWfLN_1O_bNIr_T57W1sRQ-ZwE9B_Res3rc6D5yj6bBaSmkeSWEmGui0pXK6xYcpvXaaQwtMVr44cGkXFF508iQ' \
    -d '{"name":"Test endpoint 02 updated"}'

Example response

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

{
  "id" : "5f0152b0-ee2b-40e7-b510-4b6979e637b1",
  "ownerIdentityId" : "3ad9d3cb-0a2f-4fde-9b3c-e615e87c1302",
  "createdBy" : "3ad9d3cb-0a2f-4fde-9b3c-e615e87c1302",
  "createdAt" : "2021-02-22T12:28:16.168136Z",
  "updatedAt" : "2021-02-22T12:28:16.194683Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "0743339d-ab5c-43bf-b458-2354310ce53c",
  "zitiId" : "e08fc454-1b85-44b1-ba8d-9dc9d30b4b00",
  "name" : "Test endpoint 02 updated",
  "appId" : null,
  "appVersion" : null,
  "branch" : null,
  "revision" : null,
  "type" : null,
  "version" : null,
  "arch" : null,
  "os" : null,
  "osRelease" : null,
  "osVersion" : null,
  "hasApiSession" : false,
  "hasEdgeRouterConnection" : false,
  "sessionIdentityId" : null,
  "syncId" : null,
  "syncResourceId" : null,
  "attributes" : [ ],
  "sessionActive" : true,
  "jwt" : "jwthere",
  "mfaEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0743339d-ab5c-43bf-b458-2354310ce53c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/5f0152b0-ee2b-40e7-b510-4b6979e637b1"
    }
  }
}

Delete Endpoint

DELETE /endpoints/{id}

Authorization

This endpoint requires delete action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/060b0dbc-8e7a-404c-a59d-b8c2ffa62d3d' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDTHZBci1CbUxZbW9za05xejU1ZTdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY5MjM2MjVkLTE5ZTctNDUyNC05NTAyLTljYzYyZGZiNzhiMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg5NiwiZXhwIjoxNjE0MDAwNDk2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBkMWEzNWRkLWU2NDAtNDJmOC1hMTZmLTk3ZGVkMzJmZGJhOFwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg5Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.qDPCLrsG2WPxyiTP1GWzIo7pj1SINtyxXCGNeGeX8eyDSrzB_gBXKJZvIoBjMyH7EpqgFa7VLX5LmIhXO-IQKFGxe5bNyuRhXQeIrgpC67Jwns_2kLpUNmsZ4mIuNIA6d8Ah6ZpvOMOIRr2v8XLNcv22wQxCPOMsLX3TgeZqliJPSl8MN6P5OEkrJmcpwA7voYGAi_T0CLpKrY8UKdW7JmlkBT1B2FXN3OPTVjWC2_GiKteZi_gGuT9Biw3LNxZcdxHY2PTLlPfrXEGQHTUqoUr8x-qraoKwZChHPj0I7NWNlGFFNDVQAP-Y_ieaF3J9rIGpRcmYTlzR-HD9Ipojuw'

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

status

Object

true

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

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

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

jwt

String

true

linkListener

Boolean

true

ipAddress

String

false

provider

String

false

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

providerId

String

false

dataCenterId

String

true

locationMetadataId

String

false

userData

String

false

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

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

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

jwt

String

true

linkListener

Boolean

true

ipAddress

String

false

provider

String

false

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

providerId

String

false

dataCenterId

String

true

locationMetadataId

String

false

userData

String

false

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

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.eyJqdGkiOiI2Z1ViaGdBY1RnRXd1eXpPS2VubmFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZkZTU4M2QyLWY4NDItNDNhZC1hY2YzLWM0NjgxYmU1MjJmMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk1MSwiZXhwIjoxNjE0MDAwNTUxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRkYTRlYjM2LTI4ZWMtNDFiZC1iNThiLTQxOTcwOGY5MGU3Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk1MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.W0y_b2s42BNeJPzmDaK4H3Pf_TjtiDilV0pCbshmBnhwH0o4e3OWDRyTkf_ACoXvfs0S3lWmfYKCCEwYs2JlZi-CfwtcDkgTTcXmKvKDJB8qBpoI1vXsDlcBPVSl_2wOinTl9vG-9JIc6bDoe1-Bp-qAfCICJNAbwScjOyFz0uR98I3qK4OK6aoiyvbeleMIDHYO4Zyo7G9qKNEznf7Kq28sT88qwpbCcICeMihhX0m5hKsBBBQTQWUjcnOGGkr8sSFl4Ypz_4ZB8A7ytqHJvtDCINXA94bktRBd0QvQfWivL3WbLJRgctE2quSGIQPSsLjrQ02P3Pmr8BL89rD2ig'

Example response

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

{
  "_embedded" : {
    "edgeRouterList" : [ {
      "id" : "0045330d-fdae-4be6-9d75-19ff8c3609c1",
      "ownerIdentityId" : "1d139620-20a0-4320-a752-716b954fdcd0",
      "createdBy" : "1d139620-20a0-4320-a752-716b954fdcd0",
      "createdAt" : "2021-02-22T12:29:10.800247Z",
      "updatedAt" : "2021-02-22T12:29:10.800247Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:10.800043Z",
      "networkId" : "b6b67853-663b-46c6-ba47-48a6345bc195",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "cfd586c4-d6f6-4ea2-9526-880bd8b2ac0b",
      "locationMetadataId" : "bca5d139-ed42-456c-a8f9-96ec47e3e6dc",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b6b67853-663b-46c6-ba47-48a6345bc195",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/0045330d-fdae-4be6-9d75-19ff8c3609c1"
        }
      }
    }, {
      "id" : "2d1170ee-7181-414d-a46f-a1cfe4e6d4ed",
      "ownerIdentityId" : "1d139620-20a0-4320-a752-716b954fdcd0",
      "createdBy" : "1d139620-20a0-4320-a752-716b954fdcd0",
      "createdAt" : "2021-02-22T12:29:10.800967Z",
      "updatedAt" : "2021-02-22T12:29:10.800967Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:10.800803Z",
      "networkId" : "b6b67853-663b-46c6-ba47-48a6345bc195",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "6480c823-15d0-4a65-9a31-957c868006b6",
      "locationMetadataId" : "bcfba790-2856-4d9f-81a0-03097a6f3c75",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b6b67853-663b-46c6-ba47-48a6345bc195",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/2d1170ee-7181-414d-a46f-a1cfe4e6d4ed"
        }
      }
    }, {
      "id" : "a2767dd8-4c49-44b6-ae26-57f628731dd3",
      "ownerIdentityId" : "1d139620-20a0-4320-a752-716b954fdcd0",
      "createdBy" : "1d139620-20a0-4320-a752-716b954fdcd0",
      "createdAt" : "2021-02-22T12:29:10.801414Z",
      "updatedAt" : "2021-02-22T12:29:10.801414Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:10.801267Z",
      "networkId" : "b6b67853-663b-46c6-ba47-48a6345bc195",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "1ddd49af-d841-4497-880b-afb7c3860352",
      "locationMetadataId" : "f384838c-19a6-4eeb-995c-6351299aa11d",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b6b67853-663b-46c6-ba47-48a6345bc195",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/a2767dd8-4c49-44b6-ae26-57f628731dd3"
        }
      }
    }, {
      "id" : "e1fa78a6-05f4-4b1d-a247-64fc7f9f25be",
      "ownerIdentityId" : "aa6da714-5cce-47e5-9773-de9694983597",
      "createdBy" : "aa6da714-5cce-47e5-9773-de9694983597",
      "createdAt" : "2021-02-22T12:29:10.854420Z",
      "updatedAt" : "2021-02-22T12:29:10.854420Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:10.854275Z",
      "networkId" : "71765dab-6d04-4769-a1a9-f457351f3ba3",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "64efa25b-3a32-474c-a7ca-94797544f10f",
      "locationMetadataId" : "0339c135-8d55-4fc5-a12e-fba93403b0ad",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/71765dab-6d04-4769-a1a9-f457351f3ba3",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/e1fa78a6-05f4-4b1d-a247-64fc7f9f25be"
        }
      }
    }, {
      "id" : "15ba1700-67cb-48e5-b293-8b1b55504b8f",
      "ownerIdentityId" : "aa6da714-5cce-47e5-9773-de9694983597",
      "createdBy" : "aa6da714-5cce-47e5-9773-de9694983597",
      "createdAt" : "2021-02-22T12:29:10.854866Z",
      "updatedAt" : "2021-02-22T12:29:10.854866Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:10.854721Z",
      "networkId" : "71765dab-6d04-4769-a1a9-f457351f3ba3",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "8b51f9a6-f625-44fd-adf1-c754cff2e393",
      "locationMetadataId" : "328cf3ac-0a88-4437-ba59-31aaa5da0c76",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/71765dab-6d04-4769-a1a9-f457351f3ba3",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/15ba1700-67cb-48e5-b293-8b1b55504b8f"
        }
      }
    }, {
      "id" : "adb7e528-b271-4431-bf1f-f6a939b0cb7f",
      "ownerIdentityId" : "aa6da714-5cce-47e5-9773-de9694983597",
      "createdBy" : "aa6da714-5cce-47e5-9773-de9694983597",
      "createdAt" : "2021-02-22T12:29:10.855280Z",
      "updatedAt" : "2021-02-22T12:29:10.855280Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:10.855139Z",
      "networkId" : "71765dab-6d04-4769-a1a9-f457351f3ba3",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "e8db46e2-2293-48e0-9d6a-d1cd48c705fc",
      "locationMetadataId" : "e2517ab1-f490-4349-9130-8453db5f15dc",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/71765dab-6d04-4769-a1a9-f457351f3ba3",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/adb7e528-b271-4431-bf1f-f6a939b0cb7f"
        }
      }
    }, {
      "id" : "c4915638-6a68-4c11-b638-571d70738c5f",
      "ownerIdentityId" : "36d4add3-50ff-4963-baf9-5b5af29b9512",
      "createdBy" : "36d4add3-50ff-4963-baf9-5b5af29b9512",
      "createdAt" : "2021-02-22T12:29:10.887369Z",
      "updatedAt" : "2021-02-22T12:29:10.887369Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:10.887227Z",
      "networkId" : "2e277cf0-db7d-4bc3-991b-f313989ba577",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "58feaa35-1f68-4b23-8336-48b344858c2c",
      "locationMetadataId" : "7655ebad-1418-4ab7-8907-9da5e8602559",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2e277cf0-db7d-4bc3-991b-f313989ba577",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/c4915638-6a68-4c11-b638-571d70738c5f"
        }
      }
    }, {
      "id" : "5ad1b2a6-d1bc-4569-8500-5ed5a4551e32",
      "ownerIdentityId" : "36d4add3-50ff-4963-baf9-5b5af29b9512",
      "createdBy" : "36d4add3-50ff-4963-baf9-5b5af29b9512",
      "createdAt" : "2021-02-22T12:29:10.887807Z",
      "updatedAt" : "2021-02-22T12:29:10.887807Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:10.887663Z",
      "networkId" : "2e277cf0-db7d-4bc3-991b-f313989ba577",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "7b07c814-bca2-4399-8081-30ada3142e37",
      "locationMetadataId" : "7fc14700-e8f2-4029-bcf2-e8d433f73acd",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2e277cf0-db7d-4bc3-991b-f313989ba577",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/5ad1b2a6-d1bc-4569-8500-5ed5a4551e32"
        }
      }
    }, {
      "id" : "a4dbd71f-711e-4dfe-8a9a-92ef79a9cac6",
      "ownerIdentityId" : "36d4add3-50ff-4963-baf9-5b5af29b9512",
      "createdBy" : "36d4add3-50ff-4963-baf9-5b5af29b9512",
      "createdAt" : "2021-02-22T12:29:10.888222Z",
      "updatedAt" : "2021-02-22T12:29:10.888222Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:10.888075Z",
      "networkId" : "2e277cf0-db7d-4bc3-991b-f313989ba577",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "dbc06148-a477-4e0e-92e6-680972f9e55f",
      "locationMetadataId" : "5756cb91-fa6f-473b-a3f0-f09acb6b54be",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2e277cf0-db7d-4bc3-991b-f313989ba577",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/a4dbd71f-711e-4dfe-8a9a-92ef79a9cac6"
        }
      }
    }, {
      "id" : "568d2918-28aa-4ccc-84de-61fc8d0375b0",
      "ownerIdentityId" : "53528e69-fa57-4e1b-95aa-4481dbfec5ac",
      "createdBy" : "53528e69-fa57-4e1b-95aa-4481dbfec5ac",
      "createdAt" : "2021-02-22T12:29:10.960900Z",
      "updatedAt" : "2021-02-22T12:29:10.960900Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:10.960745Z",
      "networkId" : "aa29d5c8-03a1-432a-a59b-11260354b19a",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "7801b6a8-b7b3-4ac9-8cb5-812f7456d13e",
      "locationMetadataId" : "b6f690f3-dda8-45d8-b881-2729de601ca8",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/aa29d5c8-03a1-432a-a59b-11260354b19a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/568d2918-28aa-4ccc-84de-61fc8d0375b0"
        }
      }
    }, {
      "id" : "61d31a08-b0dc-423f-bcfb-d3d4be675b79",
      "ownerIdentityId" : "53528e69-fa57-4e1b-95aa-4481dbfec5ac",
      "createdBy" : "53528e69-fa57-4e1b-95aa-4481dbfec5ac",
      "createdAt" : "2021-02-22T12:29:10.961354Z",
      "updatedAt" : "2021-02-22T12:29:10.961354Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:10.961202Z",
      "networkId" : "aa29d5c8-03a1-432a-a59b-11260354b19a",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "ca44d4d6-475e-49f5-a1ff-033f2cf6a361",
      "locationMetadataId" : "d5c627f7-3359-4b2a-a6bd-b2a33622a559",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/aa29d5c8-03a1-432a-a59b-11260354b19a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/61d31a08-b0dc-423f-bcfb-d3d4be675b79"
        }
      }
    }, {
      "id" : "de1cf851-4e72-45d8-9c28-4b7049e1b949",
      "ownerIdentityId" : "53528e69-fa57-4e1b-95aa-4481dbfec5ac",
      "createdBy" : "53528e69-fa57-4e1b-95aa-4481dbfec5ac",
      "createdAt" : "2021-02-22T12:29:10.961761Z",
      "updatedAt" : "2021-02-22T12:29:10.961761Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:10.961622Z",
      "networkId" : "aa29d5c8-03a1-432a-a59b-11260354b19a",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "c8f207be-222c-4923-8755-923a99c36aba",
      "locationMetadataId" : "6056cb2f-e6b3-4b84-94fc-4880ba5df729",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/aa29d5c8-03a1-432a-a59b-11260354b19a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/de1cf851-4e72-45d8-9c28-4b7049e1b949"
        }
      }
    }, {
      "id" : "3a59a0af-7908-49f4-bae8-a51791e663a6",
      "ownerIdentityId" : "245b265f-fd46-4fa1-8c27-af304c0cdf2f",
      "createdBy" : "245b265f-fd46-4fa1-8c27-af304c0cdf2f",
      "createdAt" : "2021-02-22T12:29:10.997577Z",
      "updatedAt" : "2021-02-22T12:29:10.997577Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:10.997434Z",
      "networkId" : "412a441e-4954-43d6-aab0-6b8e926fd865",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "88c7e8ae-635f-476f-9690-2e8335a9f5a6",
      "locationMetadataId" : "128d83c5-7e0f-4004-9674-41ded95434c1",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/412a441e-4954-43d6-aab0-6b8e926fd865",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/3a59a0af-7908-49f4-bae8-a51791e663a6"
        }
      }
    }, {
      "id" : "e5a3086a-555e-4697-a855-a25fb7ad9461",
      "ownerIdentityId" : "245b265f-fd46-4fa1-8c27-af304c0cdf2f",
      "createdBy" : "245b265f-fd46-4fa1-8c27-af304c0cdf2f",
      "createdAt" : "2021-02-22T12:29:10.998020Z",
      "updatedAt" : "2021-02-22T12:29:10.998020Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:10.997877Z",
      "networkId" : "412a441e-4954-43d6-aab0-6b8e926fd865",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "7405ddfc-a0b4-460f-8530-6084dddf2e47",
      "locationMetadataId" : "461c57b2-65ca-4a86-a434-ddf7123b746d",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/412a441e-4954-43d6-aab0-6b8e926fd865",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/e5a3086a-555e-4697-a855-a25fb7ad9461"
        }
      }
    }, {
      "id" : "60155461-4be3-4bcc-9724-2fa904e0d017",
      "ownerIdentityId" : "245b265f-fd46-4fa1-8c27-af304c0cdf2f",
      "createdBy" : "245b265f-fd46-4fa1-8c27-af304c0cdf2f",
      "createdAt" : "2021-02-22T12:29:10.998447Z",
      "updatedAt" : "2021-02-22T12:29:10.998447Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:10.998301Z",
      "networkId" : "412a441e-4954-43d6-aab0-6b8e926fd865",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "efc197c9-6524-43c8-84f7-8edd22c87d98",
      "locationMetadataId" : "5f214e78-8fa8-4a7f-8f1b-0a67b4b01c8a",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/412a441e-4954-43d6-aab0-6b8e926fd865",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/60155461-4be3-4bcc-9724-2fa904e0d017"
        }
      }
    }, {
      "id" : "847aac69-fff5-4462-8d64-3e55e7d01a3c",
      "ownerIdentityId" : "4c8dc1cd-5287-4e97-bd80-eb1c3f11193a",
      "createdBy" : "4c8dc1cd-5287-4e97-bd80-eb1c3f11193a",
      "createdAt" : "2021-02-22T12:29:11.040942Z",
      "updatedAt" : "2021-02-22T12:29:11.040942Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:11.040782Z",
      "networkId" : "676bb854-b333-4bdd-967f-c129fed4f572",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "f1d70cdf-1469-4b4b-b48b-d7fc2dab2c6e",
      "locationMetadataId" : "8cf0cd43-d94e-4396-988b-59b857121e48",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/676bb854-b333-4bdd-967f-c129fed4f572",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/847aac69-fff5-4462-8d64-3e55e7d01a3c"
        }
      }
    }, {
      "id" : "b3c90e45-874f-48c9-91e4-bf139b5c1d4f",
      "ownerIdentityId" : "4c8dc1cd-5287-4e97-bd80-eb1c3f11193a",
      "createdBy" : "4c8dc1cd-5287-4e97-bd80-eb1c3f11193a",
      "createdAt" : "2021-02-22T12:29:11.041397Z",
      "updatedAt" : "2021-02-22T12:29:11.041397Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:11.041254Z",
      "networkId" : "676bb854-b333-4bdd-967f-c129fed4f572",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "3a72cd36-f27f-4fad-a374-784a47a2c56a",
      "locationMetadataId" : "d1412c05-02a9-4a3f-984a-982a7fe4fe1d",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/676bb854-b333-4bdd-967f-c129fed4f572",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/b3c90e45-874f-48c9-91e4-bf139b5c1d4f"
        }
      }
    }, {
      "id" : "46f11273-3c0c-4e79-87df-b41d5f0c858c",
      "ownerIdentityId" : "4c8dc1cd-5287-4e97-bd80-eb1c3f11193a",
      "createdBy" : "4c8dc1cd-5287-4e97-bd80-eb1c3f11193a",
      "createdAt" : "2021-02-22T12:29:11.042199Z",
      "updatedAt" : "2021-02-22T12:29:11.042199Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:11.041678Z",
      "networkId" : "676bb854-b333-4bdd-967f-c129fed4f572",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "c597c9f6-be4e-41bd-bff2-26a5cd68d5c5",
      "locationMetadataId" : "2b66a508-e5e8-4168-a82e-f587a58cec02",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/676bb854-b333-4bdd-967f-c129fed4f572",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/46f11273-3c0c-4e79-87df-b41d5f0c858c"
        }
      }
    }, {
      "id" : "7cf0c300-573d-4828-a698-00eeca33768a",
      "ownerIdentityId" : "2c0e46de-6593-447f-b89c-de727f69e8a7",
      "createdBy" : "2c0e46de-6593-447f-b89c-de727f69e8a7",
      "createdAt" : "2021-02-22T12:29:11.314968Z",
      "updatedAt" : "2021-02-22T12:29:11.314968Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:11.314824Z",
      "networkId" : "bcb04c55-aeb0-4279-83eb-37aed1506f3a",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "28aad61d-b619-41c5-b3df-58e9a3313691",
      "locationMetadataId" : "e9ef6886-93cb-4f0a-99f2-4404d4f8065d",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bcb04c55-aeb0-4279-83eb-37aed1506f3a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/7cf0c300-573d-4828-a698-00eeca33768a"
        }
      }
    }, {
      "id" : "e130280e-65fc-445e-86bd-e45d7b5cd3ec",
      "ownerIdentityId" : "2c0e46de-6593-447f-b89c-de727f69e8a7",
      "createdBy" : "2c0e46de-6593-447f-b89c-de727f69e8a7",
      "createdAt" : "2021-02-22T12:29:11.315412Z",
      "updatedAt" : "2021-02-22T12:29:11.315412Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:11.315267Z",
      "networkId" : "bcb04c55-aeb0-4279-83eb-37aed1506f3a",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "fbf82856-f300-4182-a000-7e8275d4f896",
      "locationMetadataId" : "b30a864d-3636-4a4a-9c67-812735e144a8",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bcb04c55-aeb0-4279-83eb-37aed1506f3a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/e130280e-65fc-445e-86bd-e45d7b5cd3ec"
        }
      }
    }, {
      "id" : "b24b0a40-c87a-431a-a706-98f2bbb944e1",
      "ownerIdentityId" : "2c0e46de-6593-447f-b89c-de727f69e8a7",
      "createdBy" : "2c0e46de-6593-447f-b89c-de727f69e8a7",
      "createdAt" : "2021-02-22T12:29:11.315820Z",
      "updatedAt" : "2021-02-22T12:29:11.315820Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:11.315684Z",
      "networkId" : "bcb04c55-aeb0-4279-83eb-37aed1506f3a",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "65b2dd3c-14b3-4668-b5c2-ff60fdb911ef",
      "locationMetadataId" : "cd11c0e4-ea1b-4e00-b3c4-1567dbee2c93",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bcb04c55-aeb0-4279-83eb-37aed1506f3a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/b24b0a40-c87a-431a-a706-98f2bbb944e1"
        }
      }
    }, {
      "id" : "3d05b9b3-bc03-4d72-abce-f275e55fa155",
      "ownerIdentityId" : "9b050572-e585-41e3-bb22-1de72b306408",
      "createdBy" : "9b050572-e585-41e3-bb22-1de72b306408",
      "createdAt" : "2021-02-22T12:29:11.357847Z",
      "updatedAt" : "2021-02-22T12:29:11.357847Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:11.357701Z",
      "networkId" : "df3be372-e4dd-48e7-b57d-004b58e838b9",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "d99225c7-f045-495e-8022-0f0f113e0a0e",
      "locationMetadataId" : "d617d7fe-d70c-41ff-8d82-4250c5c51052",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df3be372-e4dd-48e7-b57d-004b58e838b9",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/3d05b9b3-bc03-4d72-abce-f275e55fa155"
        }
      }
    }, {
      "id" : "193d048a-159d-4e43-9ce9-f5c4ebe01796",
      "ownerIdentityId" : "9b050572-e585-41e3-bb22-1de72b306408",
      "createdBy" : "9b050572-e585-41e3-bb22-1de72b306408",
      "createdAt" : "2021-02-22T12:29:11.358286Z",
      "updatedAt" : "2021-02-22T12:29:11.358286Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:11.358146Z",
      "networkId" : "df3be372-e4dd-48e7-b57d-004b58e838b9",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "1d7c9f2b-aec7-44d8-8dfa-6483fa380d77",
      "locationMetadataId" : "25ad2e07-4a80-4128-a4b7-409ea6c5e385",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df3be372-e4dd-48e7-b57d-004b58e838b9",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/193d048a-159d-4e43-9ce9-f5c4ebe01796"
        }
      }
    }, {
      "id" : "c6bc7eba-addf-4f64-89c8-736f0d004a1e",
      "ownerIdentityId" : "9b050572-e585-41e3-bb22-1de72b306408",
      "createdBy" : "9b050572-e585-41e3-bb22-1de72b306408",
      "createdAt" : "2021-02-22T12:29:11.358703Z",
      "updatedAt" : "2021-02-22T12:29:11.358703Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:11.358560Z",
      "networkId" : "df3be372-e4dd-48e7-b57d-004b58e838b9",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "42ed5570-d1df-4bf8-a8cc-5f8b513a7ad6",
      "locationMetadataId" : "152d92e0-30f3-47ff-8535-5c34ea2a8c8c",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df3be372-e4dd-48e7-b57d-004b58e838b9",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/c6bc7eba-addf-4f64-89c8-736f0d004a1e"
        }
      }
    }, {
      "id" : "02dc6687-cc37-48eb-a065-50c04caf356b",
      "ownerIdentityId" : "f5b2bcc1-24d9-4414-b946-f781c30d520c",
      "createdBy" : "f5b2bcc1-24d9-4414-b946-f781c30d520c",
      "createdAt" : "2021-02-22T12:29:11.437409Z",
      "updatedAt" : "2021-02-22T12:29:11.445404Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "df4795c3-4934-470f-9182-df66d363234e",
      "name" : "Test edge router 1613996951",
      "networkId" : "df3be372-e4dd-48e7-b57d-004b58e838b9",
      "jwt" : null,
      "linkListener" : false,
      "ipAddress" : null,
      "provider" : null,
      "providerId" : null,
      "dataCenterId" : "3edc66ad-7067-45e8-b852-86d084bcff1a",
      "locationMetadataId" : null,
      "userData" : null,
      "online" : false,
      "verified" : false,
      "status" : "ERROR",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df3be372-e4dd-48e7-b57d-004b58e838b9",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/02dc6687-cc37-48eb-a065-50c04caf356b"
        }
      }
    }, {
      "id" : "ac718da7-5b57-483a-85dc-76275ab3d8c5",
      "ownerIdentityId" : "8d415a01-1691-41a6-a06c-b0c9bbdb1680",
      "createdBy" : "8d415a01-1691-41a6-a06c-b0c9bbdb1680",
      "createdAt" : "2021-02-22T12:29:11.481577Z",
      "updatedAt" : "2021-02-22T12:29:11.481577Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:11.481429Z",
      "networkId" : "149a7a4b-3bc2-4c33-b45f-4b68342cd405",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "dbf2e725-93aa-4a25-b075-0f100486dcae",
      "locationMetadataId" : "6dd557df-589c-4704-9edc-29361eb6eb53",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/149a7a4b-3bc2-4c33-b45f-4b68342cd405",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/ac718da7-5b57-483a-85dc-76275ab3d8c5"
        }
      }
    }, {
      "id" : "73e89d07-05c8-43ce-a534-2bbb9de43459",
      "ownerIdentityId" : "8d415a01-1691-41a6-a06c-b0c9bbdb1680",
      "createdBy" : "8d415a01-1691-41a6-a06c-b0c9bbdb1680",
      "createdAt" : "2021-02-22T12:29:11.482Z",
      "updatedAt" : "2021-02-22T12:29:11.482Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:11.481862Z",
      "networkId" : "149a7a4b-3bc2-4c33-b45f-4b68342cd405",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "e8dc7a78-9e33-45fa-9767-7839338c8bef",
      "locationMetadataId" : "72117e7f-3624-4fed-8b4d-3526d2d08a2a",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/149a7a4b-3bc2-4c33-b45f-4b68342cd405",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/73e89d07-05c8-43ce-a534-2bbb9de43459"
        }
      }
    }, {
      "id" : "2a37572c-3cf6-4e9b-99b0-6bdd0b559151",
      "ownerIdentityId" : "8d415a01-1691-41a6-a06c-b0c9bbdb1680",
      "createdBy" : "8d415a01-1691-41a6-a06c-b0c9bbdb1680",
      "createdAt" : "2021-02-22T12:29:11.482405Z",
      "updatedAt" : "2021-02-22T12:29:11.482405Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:11.482270Z",
      "networkId" : "149a7a4b-3bc2-4c33-b45f-4b68342cd405",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "03d27bd4-7e5a-4cdb-9fbb-5c2cee80e8ef",
      "locationMetadataId" : "c62d9dc4-620d-4d63-ab61-3eeecdcd67d3",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/149a7a4b-3bc2-4c33-b45f-4b68342cd405",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/2a37572c-3cf6-4e9b-99b0-6bdd0b559151"
        }
      }
    }, {
      "id" : "479f22f1-db35-40e2-9637-11553c4c4fc2",
      "ownerIdentityId" : "2706be0f-e5e5-42c1-9be1-a9bc96291d08",
      "createdBy" : "2706be0f-e5e5-42c1-9be1-a9bc96291d08",
      "createdAt" : "2021-02-22T12:29:11.492129Z",
      "updatedAt" : "2021-02-22T12:29:11.497332Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "f865852e-7727-4b23-b8a4-ad21edb2adc8",
      "name" : "Test edge router 1613996951",
      "networkId" : "149a7a4b-3bc2-4c33-b45f-4b68342cd405",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : null,
      "provider" : null,
      "providerId" : null,
      "dataCenterId" : "434bab8c-9f83-4d0e-b7ed-6a34d6e1e46b",
      "locationMetadataId" : null,
      "userData" : null,
      "online" : false,
      "verified" : false,
      "status" : "ERROR",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/149a7a4b-3bc2-4c33-b45f-4b68342cd405",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/479f22f1-db35-40e2-9637-11553c4c4fc2"
        }
      }
    }, {
      "id" : "39ddb7f7-303b-46f7-a144-385ec6419a2d",
      "ownerIdentityId" : "593f5353-ee7b-43a8-bec9-ea3cca79d56c",
      "createdBy" : "593f5353-ee7b-43a8-bec9-ea3cca79d56c",
      "createdAt" : "2021-02-22T12:29:11.529934Z",
      "updatedAt" : "2021-02-22T12:29:11.529934Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:11.529794Z",
      "networkId" : "1c1f87bd-2778-4afb-8dc3-7737d4ebcfce",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "16f91e85-4143-4efe-9869-00dcb5f88a39",
      "locationMetadataId" : "0cdfe3fb-3648-462f-9c0b-c6e4f3da0986",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1c1f87bd-2778-4afb-8dc3-7737d4ebcfce",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/39ddb7f7-303b-46f7-a144-385ec6419a2d"
        }
      }
    }, {
      "id" : "5665e679-68d3-4907-bd86-3f90694ec8a4",
      "ownerIdentityId" : "593f5353-ee7b-43a8-bec9-ea3cca79d56c",
      "createdBy" : "593f5353-ee7b-43a8-bec9-ea3cca79d56c",
      "createdAt" : "2021-02-22T12:29:11.530383Z",
      "updatedAt" : "2021-02-22T12:29:11.530383Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:11.530243Z",
      "networkId" : "1c1f87bd-2778-4afb-8dc3-7737d4ebcfce",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "5bb28d7a-df7d-490a-b6ee-81d43cbd9b7d",
      "locationMetadataId" : "c2fd23bd-1a9f-4ad5-9c25-4103c7ea13c4",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1c1f87bd-2778-4afb-8dc3-7737d4ebcfce",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/5665e679-68d3-4907-bd86-3f90694ec8a4"
        }
      }
    }, {
      "id" : "b3cfb281-73f2-4896-b10c-cd007162a193",
      "ownerIdentityId" : "593f5353-ee7b-43a8-bec9-ea3cca79d56c",
      "createdBy" : "593f5353-ee7b-43a8-bec9-ea3cca79d56c",
      "createdAt" : "2021-02-22T12:29:11.530797Z",
      "updatedAt" : "2021-02-22T12:29:11.530797Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:11.530656Z",
      "networkId" : "1c1f87bd-2778-4afb-8dc3-7737d4ebcfce",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "494fcaa3-9df3-4a1b-a55e-544059730d0e",
      "locationMetadataId" : "7c7ec115-82a5-4665-905b-af2308318a4e",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1c1f87bd-2778-4afb-8dc3-7737d4ebcfce",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/b3cfb281-73f2-4896-b10c-cd007162a193"
        }
      }
    }, {
      "id" : "9904d168-3c0c-4339-8a2d-b1239fdef78e",
      "ownerIdentityId" : "f99f69b7-a364-4f7d-8586-59f5ea650c2d",
      "createdBy" : "f99f69b7-a364-4f7d-8586-59f5ea650c2d",
      "createdAt" : "2021-02-22T12:29:11.563625Z",
      "updatedAt" : "2021-02-22T12:29:11.563625Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:11.563484Z",
      "networkId" : "26c28a51-693f-42f9-8997-cd120eb9169b",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "ea9cd715-51aa-49e1-bd03-fc1c788ab947",
      "locationMetadataId" : "5d437cdd-40b1-426c-ae8e-2ff8bbdcd78a",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/26c28a51-693f-42f9-8997-cd120eb9169b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/9904d168-3c0c-4339-8a2d-b1239fdef78e"
        }
      }
    }, {
      "id" : "af09172e-2156-44f9-ab3d-3fcc62bb4bc8",
      "ownerIdentityId" : "f99f69b7-a364-4f7d-8586-59f5ea650c2d",
      "createdBy" : "f99f69b7-a364-4f7d-8586-59f5ea650c2d",
      "createdAt" : "2021-02-22T12:29:11.564087Z",
      "updatedAt" : "2021-02-22T12:29:11.564087Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:11.563911Z",
      "networkId" : "26c28a51-693f-42f9-8997-cd120eb9169b",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "effb3465-85e9-47a6-93a3-97ee945431b8",
      "locationMetadataId" : "e95f641b-c2b5-4870-9ef1-e897ae22e21c",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/26c28a51-693f-42f9-8997-cd120eb9169b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/af09172e-2156-44f9-ab3d-3fcc62bb4bc8"
        }
      }
    }, {
      "id" : "dec0b305-5a24-4a55-b978-2b4b50764a14",
      "ownerIdentityId" : "f99f69b7-a364-4f7d-8586-59f5ea650c2d",
      "createdBy" : "f99f69b7-a364-4f7d-8586-59f5ea650c2d",
      "createdAt" : "2021-02-22T12:29:11.564649Z",
      "updatedAt" : "2021-02-22T12:29:11.564649Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:11.564442Z",
      "networkId" : "26c28a51-693f-42f9-8997-cd120eb9169b",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "f46c22ad-3f3c-46fd-8372-45f45fa2a1f1",
      "locationMetadataId" : "abc8bb98-b396-4ce0-84ca-543d500e8722",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/26c28a51-693f-42f9-8997-cd120eb9169b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/dec0b305-5a24-4a55-b978-2b4b50764a14"
        }
      }
    }, {
      "id" : "6b547f7a-0bb3-44a3-b2ef-d1c2afd4a6a6",
      "ownerIdentityId" : "327c5e22-3505-42d6-850a-5d38b925afe2",
      "createdBy" : "327c5e22-3505-42d6-850a-5d38b925afe2",
      "createdAt" : "2021-02-22T12:29:11.605185Z",
      "updatedAt" : "2021-02-22T12:29:11.605185Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:11.605036Z",
      "networkId" : "a72ad2a2-365b-49bb-aab2-3265c9e19266",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "9a43a46a-3d31-4a56-9b62-b23cbe907602",
      "locationMetadataId" : "5c0a83d1-01c3-4536-bd65-bda8070a9f8c",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a72ad2a2-365b-49bb-aab2-3265c9e19266",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/6b547f7a-0bb3-44a3-b2ef-d1c2afd4a6a6"
        }
      }
    }, {
      "id" : "4eb70b10-b062-4918-b779-731adce7494d",
      "ownerIdentityId" : "327c5e22-3505-42d6-850a-5d38b925afe2",
      "createdBy" : "327c5e22-3505-42d6-850a-5d38b925afe2",
      "createdAt" : "2021-02-22T12:29:11.605612Z",
      "updatedAt" : "2021-02-22T12:29:11.643297Z",
      "deletedBy" : "5bc2e979-2ec4-4a5d-887c-0b4f4b4317e1",
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:11.605473Z",
      "networkId" : "a72ad2a2-365b-49bb-aab2-3265c9e19266",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "7e5ca1c9-f26f-4331-aa5f-0183eee382e8",
      "locationMetadataId" : "e4758671-de1e-403a-9870-5c20797622ed",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "ERROR",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a72ad2a2-365b-49bb-aab2-3265c9e19266",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/4eb70b10-b062-4918-b779-731adce7494d"
        }
      }
    }, {
      "id" : "84fb5ec5-12db-4d6d-bc72-561d89241ed2",
      "ownerIdentityId" : "327c5e22-3505-42d6-850a-5d38b925afe2",
      "createdBy" : "327c5e22-3505-42d6-850a-5d38b925afe2",
      "createdAt" : "2021-02-22T12:29:11.606026Z",
      "updatedAt" : "2021-02-22T12:29:11.606026Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:11.605892Z",
      "networkId" : "a72ad2a2-365b-49bb-aab2-3265c9e19266",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "f8b371a9-65cb-418f-b18c-475f4d874a76",
      "locationMetadataId" : "ef160856-02b3-4563-a296-c434fa65abb9",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a72ad2a2-365b-49bb-aab2-3265c9e19266",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/84fb5ec5-12db-4d6d-bc72-561d89241ed2"
        }
      }
    }, {
      "id" : "495acd44-59ab-49b8-9f75-753065a44489",
      "ownerIdentityId" : "a565a997-20af-43d9-8044-e00863b4d3df",
      "createdBy" : "a565a997-20af-43d9-8044-e00863b4d3df",
      "createdAt" : "2021-02-22T12:29:11.678348Z",
      "updatedAt" : "2021-02-22T12:29:11.701448Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "Updated name",
      "networkId" : "9ecbe8ee-610d-4c7c-94a9-e8ad63d6d307",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "25b92178-9d61-4bf7-b8cc-b231980efc1c",
      "locationMetadataId" : "c2cd116c-3ec6-4a3c-b7b2-5c93a85ef3e3",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9ecbe8ee-610d-4c7c-94a9-e8ad63d6d307",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/495acd44-59ab-49b8-9f75-753065a44489"
        }
      }
    }, {
      "id" : "42512608-1be9-47bc-84ac-74e58fdb2c2e",
      "ownerIdentityId" : "a565a997-20af-43d9-8044-e00863b4d3df",
      "createdBy" : "a565a997-20af-43d9-8044-e00863b4d3df",
      "createdAt" : "2021-02-22T12:29:11.678838Z",
      "updatedAt" : "2021-02-22T12:29:11.678838Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:11.678688Z",
      "networkId" : "9ecbe8ee-610d-4c7c-94a9-e8ad63d6d307",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "347f6737-0886-4299-b0c2-c6c0b65b1ab5",
      "locationMetadataId" : "20bafeb7-4505-4a02-a5b9-a1cabba7b870",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9ecbe8ee-610d-4c7c-94a9-e8ad63d6d307",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/42512608-1be9-47bc-84ac-74e58fdb2c2e"
        }
      }
    }, {
      "id" : "326f7ff8-4cb8-4261-bf54-c940b8f0025f",
      "ownerIdentityId" : "a565a997-20af-43d9-8044-e00863b4d3df",
      "createdBy" : "a565a997-20af-43d9-8044-e00863b4d3df",
      "createdAt" : "2021-02-22T12:29:11.679275Z",
      "updatedAt" : "2021-02-22T12:29:11.679275Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:11.679126Z",
      "networkId" : "9ecbe8ee-610d-4c7c-94a9-e8ad63d6d307",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "ff6744f2-507d-4bca-934c-3c1bbb5fa182",
      "locationMetadataId" : "fc7ae0d7-b73f-4171-a0fa-9bb899ac0540",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9ecbe8ee-610d-4c7c-94a9-e8ad63d6d307",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/326f7ff8-4cb8-4261-bf54-c940b8f0025f"
        }
      }
    }, {
      "id" : "be1b95fb-82c2-4e77-b947-5dd880c5793b",
      "ownerIdentityId" : "35b7bc1c-3612-4952-9faa-e72f1375280c",
      "createdBy" : "35b7bc1c-3612-4952-9faa-e72f1375280c",
      "createdAt" : "2021-02-22T12:29:11.734605Z",
      "updatedAt" : "2021-02-22T12:29:11.734605Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId01",
      "name" : "ACME_edge_router_2021-02-22T12:29:11.734464Z",
      "networkId" : "85779f48-2b26-4a26-98ef-853143bef87b",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "ed9b5b51-3255-4302-b7b3-1b9afe95bf16",
      "locationMetadataId" : "913e2871-144b-4b19-93fa-8c61a2aa80b1",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/85779f48-2b26-4a26-98ef-853143bef87b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/be1b95fb-82c2-4e77-b947-5dd880c5793b"
        }
      }
    }, {
      "id" : "da0ce6ed-6bcb-4742-b02c-80787f7244a5",
      "ownerIdentityId" : "35b7bc1c-3612-4952-9faa-e72f1375280c",
      "createdBy" : "35b7bc1c-3612-4952-9faa-e72f1375280c",
      "createdAt" : "2021-02-22T12:29:11.735054Z",
      "updatedAt" : "2021-02-22T12:29:11.735054Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId02",
      "name" : "ACME edge router 02 2021-02-22T12:29:11.734908Z",
      "networkId" : "85779f48-2b26-4a26-98ef-853143bef87b",
      "jwt" : null,
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "7f020499-680b-4ccf-855e-8dadacb36420",
      "locationMetadataId" : "a5f6eb9f-11b1-4e18-9c13-56292e520936",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/85779f48-2b26-4a26-98ef-853143bef87b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/da0ce6ed-6bcb-4742-b02c-80787f7244a5"
        }
      }
    }, {
      "id" : "21e2886a-44a8-4396-afb2-e46777b11d7b",
      "ownerIdentityId" : "35b7bc1c-3612-4952-9faa-e72f1375280c",
      "createdBy" : "35b7bc1c-3612-4952-9faa-e72f1375280c",
      "createdAt" : "2021-02-22T12:29:11.735513Z",
      "updatedAt" : "2021-02-22T12:29:11.735513Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "zitiEdgeRouterId03",
      "name" : "ACME edge router 03 2021-02-22T12:29:11.735330Z",
      "networkId" : "85779f48-2b26-4a26-98ef-853143bef87b",
      "jwt" : "jwtdata",
      "linkListener" : true,
      "ipAddress" : "1.2.3.4",
      "provider" : "AWS",
      "providerId" : "i-89hawe3asdfew",
      "dataCenterId" : "be82c001-33cf-4aa6-8979-726ffc9ed33c",
      "locationMetadataId" : "9a61fbdb-4eec-4ad3-b094-1436158c42bb",
      "userData" : null,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONING",
      "attributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/85779f48-2b26-4a26-98ef-853143bef87b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/21e2886a-44a8-4396-afb2-e46777b11d7b"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 44,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edge Router

GET /edge-routers/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

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

ipAddress

String

false

provider

String

false

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

providerId

String

false

dataCenterId

String

true

locationMetadataId

String

false

userData

String

false

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

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/f4d2128c-887e-4c6b-a1e8-485bbffa8d6e' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJEc25xRWU2WC0xNnUxR2g3QlNBTVRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUxNmVlY2VkLTJlYWEtNDcxMi05NDIwLTllNDU3YWE4ZmY2YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk1MSwiZXhwIjoxNjE0MDAwNTUxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM0ZjQ3Yjc5LWEyYjUtNDRhYi05YTUxLWZjZTU2OTE3NGQ2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk1MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.n845dC3f3gx8ZXDkfmGw_d0tE4_D7aR4aemgTl5DGmXAn3KLi-bObG4iO654_2qVGopuBR9F_v9iDx4w8SMRAprOKL1iKI2gsTKGD03Lvu-IwESD-MIaJZavK6sfNIVVTXXCTviJM4w0umhxMwFhKzugskFL-wDqPU_JxQCgH12CzXDqZGnRnt9W7VcFVqn_5LQXY_GSv3lWzyPoJ9ed0z4IlhTyhNlcek8mqHbcBVh1RzbrWBlXzYGIJM9o7ve7AEu5M-R4XubF1BhIUkXsPlMfgpOXrJQ5FHEfd224UbUxeUEh5Gj7LCViHzy9a6HvI_7R8zDvwiAE-5z81QfSzQ'

Example response

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

{
  "id" : "f4d2128c-887e-4c6b-a1e8-485bbffa8d6e",
  "ownerIdentityId" : "b32c6353-a4f6-48be-9ca6-b34635bbb2a5",
  "createdBy" : "b32c6353-a4f6-48be-9ca6-b34635bbb2a5",
  "createdAt" : "2021-02-22T12:29:11.861150Z",
  "updatedAt" : "2021-02-22T12:29:11.861150Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "zitiEdgeRouterId01",
  "name" : "ACME_edge_router_2021-02-22T12:29:11.861004Z",
  "networkId" : "f94dc26f-ffca-4748-9fae-6f9f61428ea8",
  "jwt" : null,
  "linkListener" : true,
  "ipAddress" : "1.2.3.4",
  "provider" : "AWS",
  "providerId" : "i-89hawe3asdfew",
  "dataCenterId" : "f01fe8e7-5f46-4061-a7fe-a5ba5508cccd",
  "locationMetadataId" : "aa9a220e-01e4-4b8b-b4ff-89cdadd0e690",
  "userData" : null,
  "online" : false,
  "verified" : true,
  "status" : "PROVISIONING",
  "attributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f94dc26f-ffca-4748-9fae-6f9f61428ea8",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/f4d2128c-887e-4c6b-a1e8-485bbffa8d6e"
    }
  }
}

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

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

id

String

false

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

ipAddress

String

false

provider

String

false

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

providerId

String

false

dataCenterId

String

true

locationMetadataId

String

false

userData

String

false

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

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.eyJqdGkiOiJpbnhJdWpYVmRoOU9zbWl3aDJjN3hBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY1YjJiY2MxLTI0ZDktNDQxNC1iOTQ2LWY3ODFjMzBkNTIwYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk1MSwiZXhwIjoxNjE0MDAwNTUxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhlM2JkN2NkLTcxMmEtNGJlNS1iMWMzLWI5MDhhN2QxZmYwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk1MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.E86oxPVTUy7m_27K3MPfe2ro0--vfgJHn8iz2YrLPyzhZoI1PSzprF2r2oxkMmhhlkjT8AzEbtvNEwx7PcHOALXcvhT9funNj3gIni6_LKM9VdpC8toCUzOAG9ALmrMHWV3W9oOxdl0xG6bzpv7Qh4eAKATG1mJAOiamOW7L5Dv17KJAhUTQWVVXYWxIfb0fg848aU_zycJe63UuOGH4rqgiEP82tKOI4K4HzVV325CBMdxxNw0Q4vluh2fGUV3fXNWYYiq_VMqYeSsteTB1NCMAJPAVHYwsLU9RfjqGS7RQHpF0p7ZkHMM1cqHjhIWTwG6hOpucpZvTD1sj_xvCrg' \
    -d '{"name":"Test edge router 1613996951","networkId":"df3be372-e4dd-48e7-b57d-004b58e838b9","dataCenterId":"3edc66ad-7067-45e8-b852-86d084bcff1a","linkListener":false,"attributes":[]}'

Example response

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

{
  "id" : "02dc6687-cc37-48eb-a065-50c04caf356b",
  "ownerIdentityId" : "f5b2bcc1-24d9-4414-b946-f781c30d520c",
  "createdBy" : "f5b2bcc1-24d9-4414-b946-f781c30d520c",
  "createdAt" : "2021-02-22T12:29:11.437409Z",
  "updatedAt" : "2021-02-22T12:29:11.437409Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : null,
  "name" : "Test edge router 1613996951",
  "networkId" : "df3be372-e4dd-48e7-b57d-004b58e838b9",
  "jwt" : null,
  "linkListener" : false,
  "ipAddress" : null,
  "provider" : null,
  "providerId" : null,
  "dataCenterId" : "3edc66ad-7067-45e8-b852-86d084bcff1a",
  "locationMetadataId" : null,
  "userData" : null,
  "online" : false,
  "verified" : false,
  "status" : "NEW",
  "attributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df3be372-e4dd-48e7-b57d-004b58e838b9",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/02dc6687-cc37-48eb-a065-50c04caf356b"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/20e7ae6e-730f-40dd-a693-d692ba1ebde4",
      "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

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

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

attributes

Array[String]

true

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

Response fields

Path Type Optional Description

id

String

false

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

ipAddress

String

false

provider

String

false

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

providerId

String

false

dataCenterId

String

true

locationMetadataId

String

false

userData

String

false

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

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/66ff4d4c-3737-475e-b6b6-afebe3ff8068' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJMcFBzaUhNWmxRRWlDUlp1NVJ0NXR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA5ODViZjI5LWZmYmYtNDBhNC05OWMzLTZiNmFiM2U3ZjhkOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk1MSwiZXhwIjoxNjE0MDAwNTUxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjRkMzg3NjgwLTY4OWMtNDM3MS1hM2MyLWVhNzE4NzU2Y2I2OFwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk1MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.lhnKKOBNDyOXH98IABBCbwKezyJoEK3eQcQ95RHdeoKNKBpNTSFkHmcWD-E6xzMcP8NOWu8PeGbLZrLqXQq1jWGomaMOAK9AOt14FMFmXMU25PHnluy7PWb-S2ohKkH1AYBjsxptA0iAxXFg09FZcGewxsUJKqpHRZ0oD_GSMcdKWak5b7EKH07pIB82pQfScMbRuIv1KTQc1vtkMCRK2D6BbMJbjgW1t993X2Ex94cTnAtz8M6kCh-pUECJW1sStrluTlW-68S_q-S3JkG-DF_pDoIa37e-fdIv9oFz12ZqNm8lBaPOS3X2absIP7ZqHpbfE2r8xPcRw-Oc51csyw' \
    -d '{"name":"Updated name"}'

Example response

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

{
  "id" : "66ff4d4c-3737-475e-b6b6-afebe3ff8068",
  "ownerIdentityId" : "62b3217d-8d2b-4827-919e-c9791cf3c6f0",
  "createdBy" : "62b3217d-8d2b-4827-919e-c9791cf3c6f0",
  "createdAt" : "2021-02-22T12:29:11.817245Z",
  "updatedAt" : "2021-02-22T12:29:11.828352Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "zitiEdgeRouterId01",
  "name" : "Updated name",
  "networkId" : "0a76f3be-9c16-4401-99f1-82e069f9a8ec",
  "jwt" : null,
  "linkListener" : true,
  "ipAddress" : "1.2.3.4",
  "provider" : "AWS",
  "providerId" : "i-89hawe3asdfew",
  "dataCenterId" : "54554d58-fb35-4570-8135-7f77f3aa403d",
  "locationMetadataId" : "dfd8623c-6daf-4e7c-b957-dfcb789b7cb7",
  "userData" : null,
  "online" : false,
  "verified" : true,
  "status" : "PROVISIONING",
  "attributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0a76f3be-9c16-4401-99f1-82e069f9a8ec",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/66ff4d4c-3737-475e-b6b6-afebe3ff8068"
    }
  }
}

Delete Edge Router

DELETE /edge-routers/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

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

ipAddress

String

false

provider

String

false

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

providerId

String

false

dataCenterId

String

true

locationMetadataId

String

false

userData

String

false

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

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/4eb70b10-b062-4918-b779-731adce7494d' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJycE1vYlEtV0E5aXZzd3NPYlZ1OFl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjViYzJlOTc5LTJlYzQtNGE1ZC04ODdjLTBiNGY0YjQzMTdlMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk1MSwiZXhwIjoxNjE0MDAwNTUxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFkMTU0M2Y4LWZhYzktNDdmOC05YzgyLTRjODc4N2QxYjBiY1wiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk1MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.UNbow16hNFrUf2a_36AUBswocF0tem4ZDHzNispP_wyepM8yWs-fDf4g7cJl6PvaQm6f7aBPHIV5lfCIm-ZcMqoOzCB-F-bZhRALotYcfjWtupl0nIisDNxrJ-nJefIw9rT2CvZTxpD6JEXfgKIqApCPAtznK9VHCDXQ88IPrMIqyJi3jZbBt1u0WXohp59zPUUVtUsfqmWptqzyVZ93eyV_xUegw6lCpqG00Y6DEnivBi-q5PLjZdPXMFRCMJoskwih56XFMoYLMWqylwaenGbXN8XrgzZqup2LeNPDOEZXcrf6cgsX-FTUzDpchvDwNcm0vOmzJYhLsVFLTymWyw'

Example response

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

{
  "id" : "4eb70b10-b062-4918-b779-731adce7494d",
  "ownerIdentityId" : "327c5e22-3505-42d6-850a-5d38b925afe2",
  "createdBy" : "327c5e22-3505-42d6-850a-5d38b925afe2",
  "createdAt" : "2021-02-22T12:29:11.605612Z",
  "updatedAt" : "2021-02-22T12:29:11.618904Z",
  "deletedBy" : "5bc2e979-2ec4-4a5d-887c-0b4f4b4317e1",
  "deletedAt" : null,
  "zitiId" : "zitiEdgeRouterId02",
  "name" : "ACME edge router 02 2021-02-22T12:29:11.605473Z",
  "networkId" : "a72ad2a2-365b-49bb-aab2-3265c9e19266",
  "jwt" : null,
  "linkListener" : true,
  "ipAddress" : "1.2.3.4",
  "provider" : "AWS",
  "providerId" : "i-89hawe3asdfew",
  "dataCenterId" : "7e5ca1c9-f26f-4331-aa5f-0183eee382e8",
  "locationMetadataId" : "e4758671-de1e-403a-9870-5c20797622ed",
  "userData" : null,
  "online" : false,
  "verified" : true,
  "status" : "DELETING",
  "attributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a72ad2a2-365b-49bb-aab2-3265c9e19266",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/4eb70b10-b062-4918-b779-731adce7494d"
    },
    "process" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process/f7313f5f-89fc-4479-8e78-59a28d5d1392",
      "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

attributeType

String

true

Must be one of [APP_WAN, ENDPOINT, SERVICE, EDGE_ROUTER, EDGE_ROUTER_POLICY, CA, POSTURE_CHECK, SERVICE_EDGE_ROUTER_POLICY].

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.

endpointAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJHRFlFQmVXX3V2cUNZQ1h1ajVDTGdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcxZDYyYmE3LWM0ZTEtNDlmZC1iZmQ1LTYzNWZkZjJkYmY5NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg4OCwiZXhwIjoxNjE0MDAwNDg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImYyZmZlMDU4LThjYjAtNDUzNS05YjIwLWM1YTU1YTIzY2MzM1wiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg4OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Dme0WmSLM7iYxy1cH6k06KD9ZWhlvS75dz7OTN527lkO0DfH-gomWK2HV4qAnjJ1hmR-Bn9uUF9bZ2pdN1h-p3x08qGPgxkJ6ET0WIZsNna0jYaerCPQ1PJYN7KBREM2k57w3DvcKOEF81S4XrNCZcDwhfI8A1JMdvwaKRE2Ngg-MWEvyCMTqG7ims72r_mn2xfKCQR32Ct_I4aS7BkHdsXjVeVF-VH2Bc_mB5dBmKZVi93-cuf2FWSP1XYyn5HawG6C1wAKeu7trhWJyALY-jDFfMYvPK8d8h2cmcrXzEbgpjarQp0bOFA7bVRoAdd_Kcts6TgijEHBmGvWKc-S5g'

Example response

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

{
  "_embedded" : {
    "edgeRouterPolicyList" : [ {
      "id" : "f53e934b-0e54-4794-815d-6d662438e957",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:28:08.764624Z",
      "updatedAt" : "2021-02-22T12:28:08.764624Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "29c1fd36-d2db-4b99-a19e-85154126f9f9",
      "zitiId" : "1478ab80-e202-46dc-9f17-2afd707a7527",
      "name" : "ACME edge router policy 2021-02-22T12:28:08.764404Z",
      "endpointAttributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/29c1fd36-d2db-4b99-a19e-85154126f9f9",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/f53e934b-0e54-4794-815d-6d662438e957"
        }
      }
    }, {
      "id" : "a1ee692f-e135-4b92-9aa1-a7354734a15c",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:28:08.966417Z",
      "updatedAt" : "2021-02-22T12:28:08.966417Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "366d18e3-e7c4-44ca-b43b-cd69feca8b2c",
      "zitiId" : "b12e3cf4-3334-4be1-8c3f-c8a23841e569",
      "name" : "ACME edge router policy 2021-02-22T12:28:08.966259Z",
      "endpointAttributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/366d18e3-e7c4-44ca-b43b-cd69feca8b2c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/a1ee692f-e135-4b92-9aa1-a7354734a15c"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edge Router Policy

GET /edge-router-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

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/2491354d-8e74-4ab5-bdd5-2acaa546ce59' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzUExYUkFXM2QxSVFuU1hlYWE5TWx3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQxZWFlNmYxLTYyMjYtNGZhMS1hZDg4LWVhNDFlYjI5NjE5OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg4OSwiZXhwIjoxNjE0MDAwNDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk0MTVhMjNjLTUxNWQtNGZlZi04ZTM1LTk5ZDQ4MTcyZDg3NVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ra7f1Td2vmEjPsKBkCfm5T3NA9SWoyixpCM3sckEsrEfNTah9K9SrWNwK42LyAL2fGpKl7HRuF6lvYtWjzw4xQxUb4A97krXULN2l1SFPmFjrYitbxGjgv_oHUClxKsyNr8TjlNeOKgVm1Gr7H65vLeFMVd5m7NtLZfitqlVx9IhoPu5L7r4P2OYVb3egnIIaSeOxzwD0hXB5UtkMGDtSoaPdk0Jbc1ok_U4qgzSobiyqjvgAvGuZB74y6EwWrB6Y1wel-D9-b27RyUb1w55moL8GbVaW31wEUUv-ouKrfZO-rlUHzsg9vKd9lx8ji4CGRVJRL3e36b3LyCUDjMdAg'

Example response

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

{
  "id" : "2491354d-8e74-4ab5-bdd5-2acaa546ce59",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-02-22T12:28:09.089192Z",
  "updatedAt" : "2021-02-22T12:28:09.089192Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "ea91a272-f671-4e2e-9440-473c08db1a1e",
  "zitiId" : "7270ba9e-74ae-462f-ac1d-66557dd2e431",
  "name" : "ACME edge router policy 2021-02-22T12:28:09.089027Z",
  "endpointAttributes" : [ ],
  "edgeRouterAttributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ea91a272-f671-4e2e-9440-473c08db1a1e",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/2491354d-8e74-4ab5-bdd5-2acaa546ce59"
    }
  }
}

Create Edge Router Policy

POST /edge-router-policies

Authorization

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

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

networkId

String

true

Client must have create action under the annotated resource.

endpointAttributes

Array[String]

true

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

edgeRouterAttributes

Array[String]

true

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

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

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.eyJqdGkiOiJfOFA2dXB2STl2OG9ubWxoeXJoZXhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ0MjBlY2RmLTkyZGEtNDE1ZS1hM2Y4LTI1Mzg3ZTQ5YzQ3MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg4OSwiZXhwIjoxNjE0MDAwNDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImMxOWM3NDMxLWQ3Y2MtNDZmNC1hMTQ5LTRhOGExYjUzMGI0NVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.kasOgzdxMtR0cZIDjYdnwAmFWmy_RofQK2rUlV_gCH6eDbgO4II-OHYGBBnkaqWya8bt4ca5RVoSJktYomAEOtIz4sS-JRuLNyy3sCgY2Xg-ZPQSjPgMMc5ZBzTFDq5WSjGCMM-xxPmZlzqE9d-IBqtNna0n7OV_Cw3K3VBqrZ_kClpviT-3qO3dl4nic1RBE2OsZJG4b6BAtTgAf0xhjLlAanY6BDbw4jWFPhZotNnwlwdrix3apHY8yT5G5TkJzwrVOn3xuTxAhvMmtHr17qXWrnSK5DJEQrXMDc5gzTFx8bo1DeLx5fMeBW-TexA_papyIJu4abF2IwQQ2HnKeg' \
    -d '{"name":"Test edge router policy 1613996889","networkId":"029904fa-c347-46cb-b668-61964ebf4cf6","endpointAttributes":["#topclients"],"edgeRouterAttributes":["@ACME_edge_router_2021-02-22T12:28:09.011518Z","#westrouters"]}'

Example response

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

{
  "id" : "e2e6a384-c5ab-4c41-8c08-1642c48bfb39",
  "ownerIdentityId" : "d420ecdf-92da-415e-a3f8-25387e49c473",
  "createdBy" : "d420ecdf-92da-415e-a3f8-25387e49c473",
  "createdAt" : "2021-02-22T12:28:09.046215Z",
  "updatedAt" : "2021-02-22T12:28:09.050926Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "029904fa-c347-46cb-b668-61964ebf4cf6",
  "zitiId" : "b3a608ce-c270-4cbe-a60a-95e9416ae78e",
  "name" : "Test edge router policy 1613996889",
  "endpointAttributes" : [ "#topclients" ],
  "edgeRouterAttributes" : [ "@ACME_edge_router_2021-02-22T12:28:09.011518Z", "#westrouters" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/029904fa-c347-46cb-b668-61964ebf4cf6",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/e2e6a384-c5ab-4c41-8c08-1642c48bfb39"
    }
  }
}

Update Edge Router Policy

PUT /edge-router-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

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

networkId

String

true

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

endpointAttributes

Array[String]

true

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

edgeRouterAttributes

Array[String]

true

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

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

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/c6b84a42-7d35-45e8-a0df-d698186f8276' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJTSDVMQUdydHdwa01HQUtrWHl6bzBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM4NDdhNTIxLTM2MzQtNDY4NS05OGRiLWI2YzJjMTMzYzAyOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg4OSwiZXhwIjoxNjE0MDAwNDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjM1YTM0ZmQyLTRiZGEtNDQwMy05YzVmLTIxMmIyM2IzZWQxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.LoPwzQstC6raLDwG6xfrEUV-tXuSPTOyz-lPeTk4qhcbkD32_GR7LnnknpZGT1CF3ySlnJoQoZAdOWLOuaqYKgMKoYuszdo289vT00YK0dGtZ4NPdWGDvHyl8wF8chS2Y0SrTpL_pV5QP9I5Ixi6-TGDPLxwjkrbQ5-kNP24asNMXvJJ3BnjKALKZKat3v7pPiYcPg7sGzXFXjLrOHnnQqG5xX5BSXPu9Rhqragm-33YvHwFGF9i1l6bR6Tc2DhD_q4JzE6iuFyptRCR0QImL7qeX2Ug2ztzGZbpdFX0snjDHp5tdKiqNn5SSSxEvM1m_RZMwxX3_SHMb6lMV1aBOQ' \
    -d '{"name":"Updated edge router policy name","networkId":"003bc26a-97f8-4af4-a10e-58bebf313af8","endpointAttributes":["#useastrouters"],"edgeRouterAttributes":["#usendpoints"]}'

Example response

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

{
  "id" : "c6b84a42-7d35-45e8-a0df-d698186f8276",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-02-22T12:28:09.324036Z",
  "updatedAt" : "2021-02-22T12:28:09.337353Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "003bc26a-97f8-4af4-a10e-58bebf313af8",
  "zitiId" : "29f87fcc-3bcd-4c38-9e05-dbd0b006334b",
  "name" : "Updated edge router policy name",
  "endpointAttributes" : [ "#useastrouters" ],
  "edgeRouterAttributes" : [ "#usendpoints" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/003bc26a-97f8-4af4-a10e-58bebf313af8",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/c6b84a42-7d35-45e8-a0df-d698186f8276"
    }
  }
}

Delete Edge Router Policy

DELETE /edge-router-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/c945af94-74a9-4cd0-83c3-986493d58fa6' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJSWUhlby1zeGt5aVpTSEszaHZzTFJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAwMTExMGNmLTdkZGYtNGRmMC1hMzQ0LTQ3NjU2YjY1ZDU0MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg4OSwiZXhwIjoxNjE0MDAwNDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjlkN2ExMDQyLTBjNzQtNGRkOS04MDkwLTgxZjY5ODg1ZWM3Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.dJMAbFHiM01XVEBHGrDqtQIT875g8DV_-KicHqaXOzMQ5yJRL2JpK6UcjV52-v7mTmPvpD8_13Xr-76i4SV_QVFHXxAJgWdQM2lno1aBCPxVEn4kR_aZW0FrOISGHENDpmaZ5ySNafFQGDJNlsxFY21ecpfEXDRGeyFL7n6ccNj1VE1va15MYRk6vXaEya29US6yTGxo2cH70NxWQB0kVvHTCBL1Dy8zxN84p66wcofqA0vhdV5eArQqMm7fg7e0IFyfPjz73qzwaEvUapKy0EplDPWqt2aN0sKu_-XZz9HH82hAuFyYFeUjm8BdSK2A32QwYW18DBjIemqAL9IsBA'

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

egressRouterId

Object

true

clientHostName

String

true

serverHostName

String

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

egressRouterId

String

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

Must be one of [TCP, UDP].

encryptionRequired

Boolean

true

egressRouterName

String

true

endpoints

Array[String]

false

attributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

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

true

name

String

false

io.netfoundry.core.validation.ResourceName.

egressRouterId

String

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

Must be one of [TCP, UDP].

encryptionRequired

Boolean

true

egressRouterName

String

true

endpoints

Array[String]

false

attributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJXVkFzZm5nMDY3YV9JejhxZFVjVDd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZhMGEwZWEzLTA4MTUtNDRmMS05NGFjLWUxZWI0ZGZiMTY4MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk0MywiZXhwIjoxNjE0MDAwNTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjczOGU3YWRjLWVmNjEtNGM3MS1hYThmLTg5ZTI5NGE1YWRhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk0M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jcgOjeDT0hIGFZjLjJBVR5lpLniYZ4hfHeEPuXPX-Zk9Um7OpXofCgtzd4hueS1vBv-p4znKNvM2C_nmijhZlgtzoW3dwzsX3twblsPTE58-UAz5PaOjguZD8_s_SRYRO3u0fLRSbpAW3eoKViL3vzNbYQt4yGa21suxggAd36oUYylc3Npeb0YZrxIgfAUoEqJdaDA-x80MiyPIWBcazF1ESlFkc7ZL9U5yG0sAlkAivLtOZlifKbXuqDdxQxgMXEa8ZXjTmxVVKMxzyXOl5xbOYTW06ACSPG7UwlGTpZjEDAlaFZrOl0CWnuDXGJvObOyfZK6OeVm-evC8TrZxEQ'

Example response

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

{
  "_embedded" : {
    "serviceList" : [ {
      "id" : "0883da56-fa5e-4731-9b9d-7c79c2b9afdc",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.475966Z",
      "updatedAt" : "2021-02-22T12:29:03.475966Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "299c332c-fd36-4119-8ce1-3ab9fd7980d7",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-02-22T12:29:03.475736Z",
      "egressRouterId" : "6f06de11-75de-4825-b418-74b33e202435",
      "clientHostName" : "outlook.office.com",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/299c332c-fd36-4119-8ce1-3ab9fd7980d7",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/0883da56-fa5e-4731-9b9d-7c79c2b9afdc"
        }
      }
    }, {
      "id" : "8870b3a5-ae9a-4bee-baa4-3cf4d5e53eba",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.476706Z",
      "updatedAt" : "2021-02-22T12:29:03.476706Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "299c332c-fd36-4119-8ce1-3ab9fd7980d7",
      "zitiId" : "265dcccb-489a-4d38-bb87-9d53a79f5dfd",
      "name" : "ACME Service02 2021-02-22T12:29:03.476556Z",
      "egressRouterId" : "6f06de11-75de-4825-b418-74b33e202435",
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/299c332c-fd36-4119-8ce1-3ab9fd7980d7",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/8870b3a5-ae9a-4bee-baa4-3cf4d5e53eba"
        }
      }
    }, {
      "id" : "fea7498c-d815-40ce-9bd6-fe6a61971d38",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.477448Z",
      "updatedAt" : "2021-02-22T12:29:03.477448Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "299c332c-fd36-4119-8ce1-3ab9fd7980d7",
      "zitiId" : "3af2cde6-e457-4543-ad59-4cfc1e419f49",
      "name" : "ACME Service03 2021-02-22T12:29:03.477298Z",
      "egressRouterId" : "6f06de11-75de-4825-b418-74b33e202435",
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/299c332c-fd36-4119-8ce1-3ab9fd7980d7",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/fea7498c-d815-40ce-9bd6-fe6a61971d38"
        }
      }
    }, {
      "id" : "d1957acb-a60c-4941-adc6-3f5ceea390d7",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.478056Z",
      "updatedAt" : "2021-02-22T12:29:03.478056Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "299c332c-fd36-4119-8ce1-3ab9fd7980d7",
      "zitiId" : "zitiIdService04",
      "name" : "ACME Service04 2021-02-22T12:29:03.477923Z",
      "egressRouterId" : null,
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/299c332c-fd36-4119-8ce1-3ab9fd7980d7",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/d1957acb-a60c-4941-adc6-3f5ceea390d7"
        }
      }
    }, {
      "id" : "e5f28108-1340-43c7-9bd9-aa22f5b53396",
      "ownerIdentityId" : "6a79b525-a428-4baa-aa90-8bb7e2a6e5db",
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.535716Z",
      "updatedAt" : "2021-02-22T12:29:03.545012Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "299c332c-fd36-4119-8ce1-3ab9fd7980d7",
      "zitiId" : "dcefa0ec-9446-4d5b-a3aa-d27147c19723",
      "name" : "Test Service 1613996943",
      "egressRouterId" : null,
      "clientHostName" : "newclient.com",
      "clientPortRange" : "80",
      "serverHostName" : "newserver.com",
      "serverPortRange" : "80",
      "serverProtocol" : "UDP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ "965a040f-3f28-442d-ab3f-6b0e002d888d" ],
      "attributes" : [ "#service01" ],
      "edgeRouterAttributes" : [ "#accessrouters" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/299c332c-fd36-4119-8ce1-3ab9fd7980d7",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/e5f28108-1340-43c7-9bd9-aa22f5b53396"
        }
      }
    }, {
      "id" : "434bef9c-0d00-46da-8154-c3ef52a9b321",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.602009Z",
      "updatedAt" : "2021-02-22T12:29:03.616477Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "64537540-8f0c-4df6-bc9c-c19beb567117",
      "zitiId" : "zitiservice01",
      "name" : "Test Service 1613996943",
      "egressRouterId" : "8af62222-fdfe-4146-86c4-a53959e05717",
      "clientHostName" : "newclient.com",
      "clientPortRange" : "443",
      "serverHostName" : "newserver.com",
      "serverPortRange" : "443",
      "serverProtocol" : "UDP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#service01" ],
      "edgeRouterAttributes" : [ "#accessrouterswest", "#accessrouterseast" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/64537540-8f0c-4df6-bc9c-c19beb567117",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/434bef9c-0d00-46da-8154-c3ef52a9b321"
        }
      }
    }, {
      "id" : "21dfbbd2-74cc-4936-8671-1a710608c6d5",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.602513Z",
      "updatedAt" : "2021-02-22T12:29:03.602513Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "64537540-8f0c-4df6-bc9c-c19beb567117",
      "zitiId" : "256562dd-747c-4e83-bdea-e5dada0e7fd3",
      "name" : "ACME Service02 2021-02-22T12:29:03.602370Z",
      "egressRouterId" : "8af62222-fdfe-4146-86c4-a53959e05717",
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/64537540-8f0c-4df6-bc9c-c19beb567117",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/21dfbbd2-74cc-4936-8671-1a710608c6d5"
        }
      }
    }, {
      "id" : "3d02ba67-0365-492b-aba7-343d7bce0370",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.603172Z",
      "updatedAt" : "2021-02-22T12:29:03.603172Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "64537540-8f0c-4df6-bc9c-c19beb567117",
      "zitiId" : "52bdf6a3-170a-442a-b530-1dd67a350fb4",
      "name" : "ACME Service03 2021-02-22T12:29:03.603033Z",
      "egressRouterId" : "8af62222-fdfe-4146-86c4-a53959e05717",
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/64537540-8f0c-4df6-bc9c-c19beb567117",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/3d02ba67-0365-492b-aba7-343d7bce0370"
        }
      }
    }, {
      "id" : "28e99890-faae-4c55-a248-68c79e1cd02f",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.603784Z",
      "updatedAt" : "2021-02-22T12:29:03.603784Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "64537540-8f0c-4df6-bc9c-c19beb567117",
      "zitiId" : "zitiIdService04",
      "name" : "ACME Service04 2021-02-22T12:29:03.603652Z",
      "egressRouterId" : null,
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/64537540-8f0c-4df6-bc9c-c19beb567117",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/28e99890-faae-4c55-a248-68c79e1cd02f"
        }
      }
    }, {
      "id" : "d0f06554-e2ac-4192-b652-af3ab23d278c",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.661857Z",
      "updatedAt" : "2021-02-22T12:29:03.661857Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "a168caeb-8777-4da3-b68f-9e96c6a2e685",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-02-22T12:29:03.661710Z",
      "egressRouterId" : "cb47b3e8-a60b-4370-9e60-1ae9e2505770",
      "clientHostName" : "outlook.office.com",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a168caeb-8777-4da3-b68f-9e96c6a2e685",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/d0f06554-e2ac-4192-b652-af3ab23d278c"
        }
      }
    }, {
      "id" : "6f3b45c9-6ff4-4e38-9bba-9a5663114d16",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.662357Z",
      "updatedAt" : "2021-02-22T12:29:03.662357Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "a168caeb-8777-4da3-b68f-9e96c6a2e685",
      "zitiId" : "2f69b0db-44e0-41b4-9999-1972477f9ab6",
      "name" : "ACME Service02 2021-02-22T12:29:03.662222Z",
      "egressRouterId" : "cb47b3e8-a60b-4370-9e60-1ae9e2505770",
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a168caeb-8777-4da3-b68f-9e96c6a2e685",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/6f3b45c9-6ff4-4e38-9bba-9a5663114d16"
        }
      }
    }, {
      "id" : "0d0e797a-722a-42ab-909f-83f6e63c8689",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.662998Z",
      "updatedAt" : "2021-02-22T12:29:03.662998Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "a168caeb-8777-4da3-b68f-9e96c6a2e685",
      "zitiId" : "516563ff-a663-4aac-ac7e-6d74c1e22aee",
      "name" : "ACME Service03 2021-02-22T12:29:03.662865Z",
      "egressRouterId" : "cb47b3e8-a60b-4370-9e60-1ae9e2505770",
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a168caeb-8777-4da3-b68f-9e96c6a2e685",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/0d0e797a-722a-42ab-909f-83f6e63c8689"
        }
      }
    }, {
      "id" : "28a3a919-4cac-4187-9c82-aa56d60141af",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.663632Z",
      "updatedAt" : "2021-02-22T12:29:03.663632Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "a168caeb-8777-4da3-b68f-9e96c6a2e685",
      "zitiId" : "zitiIdService04",
      "name" : "ACME Service04 2021-02-22T12:29:03.663500Z",
      "egressRouterId" : null,
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a168caeb-8777-4da3-b68f-9e96c6a2e685",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/28a3a919-4cac-4187-9c82-aa56d60141af"
        }
      }
    }, {
      "id" : "5ca5d5df-4514-405c-970f-32e139adce9c",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.710582Z",
      "updatedAt" : "2021-02-22T12:29:03.710582Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "394f495e-63ab-423e-985b-28755092f6dd",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-02-22T12:29:03.710438Z",
      "egressRouterId" : "76a92c03-f43c-4bd1-b7a6-55bf15443262",
      "clientHostName" : "outlook.office.com",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/394f495e-63ab-423e-985b-28755092f6dd",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/5ca5d5df-4514-405c-970f-32e139adce9c"
        }
      }
    }, {
      "id" : "15637cdc-cbcd-4a48-8ad7-58affeb3d3e3",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.711109Z",
      "updatedAt" : "2021-02-22T12:29:03.711109Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "394f495e-63ab-423e-985b-28755092f6dd",
      "zitiId" : "91f5de44-d923-4e47-bde1-607bbf2e567d",
      "name" : "ACME Service02 2021-02-22T12:29:03.710962Z",
      "egressRouterId" : "76a92c03-f43c-4bd1-b7a6-55bf15443262",
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/394f495e-63ab-423e-985b-28755092f6dd",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/15637cdc-cbcd-4a48-8ad7-58affeb3d3e3"
        }
      }
    }, {
      "id" : "a3c0726e-cb51-4157-990e-0ad177663968",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.711774Z",
      "updatedAt" : "2021-02-22T12:29:03.711774Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "394f495e-63ab-423e-985b-28755092f6dd",
      "zitiId" : "2a4f05b0-b9c8-48d2-879b-b6a5d9ba55a3",
      "name" : "ACME Service03 2021-02-22T12:29:03.711632Z",
      "egressRouterId" : "76a92c03-f43c-4bd1-b7a6-55bf15443262",
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/394f495e-63ab-423e-985b-28755092f6dd",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/a3c0726e-cb51-4157-990e-0ad177663968"
        }
      }
    }, {
      "id" : "9374bc86-56c8-486e-af0f-17d2073ef78e",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.712421Z",
      "updatedAt" : "2021-02-22T12:29:03.722824Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "394f495e-63ab-423e-985b-28755092f6dd",
      "zitiId" : "zitiIdService04",
      "name" : "ACME Service04 2021-02-22T12:29:03.712288Z",
      "egressRouterId" : null,
      "clientHostName" : "newclient.com",
      "clientPortRange" : "443",
      "serverHostName" : "newserver.com",
      "serverPortRange" : "443",
      "serverProtocol" : "UDP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ "48f5e794-5d5b-4462-a202-18f2b06fac87" ],
      "attributes" : [ "#service01" ],
      "edgeRouterAttributes" : [ "#accessrouterswest", "#accessrouterseast" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/394f495e-63ab-423e-985b-28755092f6dd",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/9374bc86-56c8-486e-af0f-17d2073ef78e"
        }
      }
    }, {
      "id" : "862d0fd5-def3-4e6e-beb7-3c45ce376c8b",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.765774Z",
      "updatedAt" : "2021-02-22T12:29:03.765774Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "b1f22971-6d5b-4809-aeeb-8b45b3ad7209",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-02-22T12:29:03.765633Z",
      "egressRouterId" : "43fc786b-dc8c-478b-bc0a-35cdf82576ca",
      "clientHostName" : "outlook.office.com",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b1f22971-6d5b-4809-aeeb-8b45b3ad7209",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/862d0fd5-def3-4e6e-beb7-3c45ce376c8b"
        }
      }
    }, {
      "id" : "75da5908-909a-429f-b7ce-c9cd04c67408",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.766272Z",
      "updatedAt" : "2021-02-22T12:29:03.766272Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "b1f22971-6d5b-4809-aeeb-8b45b3ad7209",
      "zitiId" : "285de71e-7798-4250-92a0-41d7283d373a",
      "name" : "ACME Service02 2021-02-22T12:29:03.766136Z",
      "egressRouterId" : "43fc786b-dc8c-478b-bc0a-35cdf82576ca",
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b1f22971-6d5b-4809-aeeb-8b45b3ad7209",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/75da5908-909a-429f-b7ce-c9cd04c67408"
        }
      }
    }, {
      "id" : "711cf00a-694a-4548-82b8-15fad3fe1054",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.766915Z",
      "updatedAt" : "2021-02-22T12:29:03.766915Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "b1f22971-6d5b-4809-aeeb-8b45b3ad7209",
      "zitiId" : "0474cea1-ffc0-4601-9225-d8116ae91452",
      "name" : "ACME Service03 2021-02-22T12:29:03.766780Z",
      "egressRouterId" : "43fc786b-dc8c-478b-bc0a-35cdf82576ca",
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b1f22971-6d5b-4809-aeeb-8b45b3ad7209",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/711cf00a-694a-4548-82b8-15fad3fe1054"
        }
      }
    }, {
      "id" : "3bc02dc1-7b81-471a-ac55-0035b1e04024",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.767526Z",
      "updatedAt" : "2021-02-22T12:29:03.767526Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "b1f22971-6d5b-4809-aeeb-8b45b3ad7209",
      "zitiId" : "zitiIdService04",
      "name" : "ACME Service04 2021-02-22T12:29:03.767395Z",
      "egressRouterId" : null,
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b1f22971-6d5b-4809-aeeb-8b45b3ad7209",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/3bc02dc1-7b81-471a-ac55-0035b1e04024"
        }
      }
    }, {
      "id" : "efe1a400-d456-4d95-b171-992aa5c22525",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.791389Z",
      "updatedAt" : "2021-02-22T12:29:03.791389Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "c0c5f5e5-41a2-4810-9107-baed9709366b",
      "zitiId" : "zitiservice01",
      "name" : "ACME_Service01_2021-02-22T12:29:03.791247Z",
      "egressRouterId" : "c04c98cd-2445-48e7-9841-3c3f7d88fb3f",
      "clientHostName" : "outlook.office.com",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c0c5f5e5-41a2-4810-9107-baed9709366b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/efe1a400-d456-4d95-b171-992aa5c22525"
        }
      }
    }, {
      "id" : "11a6bf45-a791-48e1-9823-08c77d105c8e",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.791879Z",
      "updatedAt" : "2021-02-22T12:29:03.791879Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "c0c5f5e5-41a2-4810-9107-baed9709366b",
      "zitiId" : "99a10fe9-7bfc-42df-b2c2-c4beb253e073",
      "name" : "ACME Service02 2021-02-22T12:29:03.791739Z",
      "egressRouterId" : "c04c98cd-2445-48e7-9841-3c3f7d88fb3f",
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c0c5f5e5-41a2-4810-9107-baed9709366b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/11a6bf45-a791-48e1-9823-08c77d105c8e"
        }
      }
    }, {
      "id" : "c8aae101-4461-44e4-8eab-286e339b28a5",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.792570Z",
      "updatedAt" : "2021-02-22T12:29:03.792570Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "c0c5f5e5-41a2-4810-9107-baed9709366b",
      "zitiId" : "77553c88-c5c1-4fcc-a0fc-8c104012ab6f",
      "name" : "ACME Service03 2021-02-22T12:29:03.792406Z",
      "egressRouterId" : "c04c98cd-2445-48e7-9841-3c3f7d88fb3f",
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c0c5f5e5-41a2-4810-9107-baed9709366b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/c8aae101-4461-44e4-8eab-286e339b28a5"
        }
      }
    }, {
      "id" : "c462b66d-5046-4f37-b988-3513b68f7b9a",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "createdAt" : "2021-02-22T12:29:03.793184Z",
      "updatedAt" : "2021-02-22T12:29:03.793184Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "c0c5f5e5-41a2-4810-9107-baed9709366b",
      "zitiId" : "zitiIdService04",
      "name" : "ACME Service04 2021-02-22T12:29:03.793047Z",
      "egressRouterId" : null,
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "encryptionRequired" : false,
      "egressRouterName" : null,
      "endpoints" : [ ],
      "attributes" : [ "#clientservices" ],
      "edgeRouterAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c0c5f5e5-41a2-4810-9107-baed9709366b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/c462b66d-5046-4f37-b988-3513b68f7b9a"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 25,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Service

GET /services/{id}

Authorization

This endpoint requires read action on the service resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

egressRouterId

String

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

Must be one of [TCP, UDP].

encryptionRequired

Boolean

true

egressRouterName

String

true

endpoints

Array[String]

false

attributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

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/d0f06554-e2ac-4192-b652-af3ab23d278c' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ5eGxhUWRXbWRQdXF2THRHZE5MY193IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA3OTlhYTVhLTBhMjAtNDZhYi1hMzVlLThiNzg0OGNkOWY4ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk0MywiZXhwIjoxNjE0MDAwNTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY5OTdlNjk0LTZhODktNGY4NS05ODA4LWVjNWVhYTU5MWI3NVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk0M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ltkpLTFp6uiYkrREnxJHt2_vjx8WFss1TR-h4oNcKz0_34MNk60XhgdzYS7sGubv8yVQxrjEcr2awYPlexr5Bp-KFOsDKlNs_oWWTaWe9bSms8pyAHV4l058lk448Us-fz50AVlE6bCER8taLgt-zLfHwhi7IvH9kI4H_u--7ABYTZrm0R-B0ACyZ9a4Y9HFNOtfJz0T7LRClcT1lfV-OYDXaenrz723UWdVidl3J6HXjJfnrUL_GgL_kjTR6vSV0pEHeqb2jtFIF_LGhXBwMVEJW00c0ZoXUdqegj-iNjlrHixs43baPtekvRU_bJfiq_f4D8LY-3A8QPOW0NbftQ'

Example response

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

{
  "id" : "d0f06554-e2ac-4192-b652-af3ab23d278c",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-02-22T12:29:03.661857Z",
  "updatedAt" : "2021-02-22T12:29:03.661857Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "a168caeb-8777-4da3-b68f-9e96c6a2e685",
  "zitiId" : "zitiservice01",
  "name" : "ACME_Service01_2021-02-22T12:29:03.661710Z",
  "egressRouterId" : "cb47b3e8-a60b-4370-9e60-1ae9e2505770",
  "clientHostName" : "outlook.office.com",
  "clientPortRange" : "443",
  "serverHostName" : "server.com",
  "serverPortRange" : "443",
  "serverProtocol" : "TCP",
  "encryptionRequired" : false,
  "egressRouterName" : "ACME_edge_router_2021-02-22T12:29:03.659979Z",
  "endpoints" : [ ],
  "attributes" : [ ],
  "edgeRouterAttributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a168caeb-8777-4da3-b68f-9e96c6a2e685",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/d0f06554-e2ac-4192-b652-af3ab23d278c"
    }
  }
}

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

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.

egressRouterId

String

true

endpoints

Array[String]

true

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

attributes

Array[String]

true

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

edgeRouterAttributes

Array[String]

true

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

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

Must be one of [TCP, UDP].

encryptionRequired

Boolean

true

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

egressRouterName

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

true

name

String

false

io.netfoundry.core.validation.ResourceName.

egressRouterId

String

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

Must be one of [TCP, UDP].

encryptionRequired

Boolean

true

egressRouterName

String

true

endpoints

Array[String]

false

attributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

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' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJBN0lyQURiQ3VMQVJIS1NfUGhZbkN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjlkNDEyY2JhLWI3OGMtNDc5ZC1iYWI1LWE0ZjdiNjYxYjA2ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk0NCwiZXhwIjoxNjE0MDAwNTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFkMDQ3ZTY5LTQwZjgtNDQ2NC1iYTJkLWNjZDllNjQ3NTQ0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk0NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.eVGV-u4I_dz-i6K9sCMZ_pXQA47xBy6rxwZ0ymt0c9SuUSR_sSjP-jx7boNrIcV58RTx1r5X8YYejKwWs2rLK8Jopj7DfOwd0S4zabj1YkWyqn6mg4REwKd7nOPqUX1_Ah4M6QY2sW097ETVFdRd5_fbDMChTCLyLVJvYfVbENaRgFt0bQ7adGrgce5ESyG6qOtNuN99Ag4gI3-9If8TAPvh6RMen25UIN6ZR7eMUUSuWlinltJScXCxGgqXityxqAiBrMa28hzy6DoykTUtB9uDhreOSDMkqTGcFnGW0C8q4UgL2PRVKvnUNVj6QJ2AB2r5HSsLpQ8OkBosEPIrcA' \
    -d '{"name":"Test Service 1613996944","networkId":"45f65780-a3bb-457f-af69-2d64013108de","egressRouterId":"5a651e41-0c6a-49c4-8ff4-14f3a8a8d0a2","endpoints":[],"attributes":["#service01"],"edgeRouterAttributes":["#accessrouters"],"clientHostName":"newclient.com","clientPortRange":"80","serverHostName":"newserver.com","serverPortRange":"80","serverProtocol":"UDP","encryptionRequired":false}'

Example response

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

{
  "id" : "812b2c2e-ccb1-41fb-83c1-c8f228712e2e",
  "ownerIdentityId" : "9d412cba-b78c-479d-bab5-a4f7b661b06f",
  "createdBy" : null,
  "createdAt" : "2021-02-22T12:29:04.026386Z",
  "updatedAt" : "2021-02-22T12:29:04.039756Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "45f65780-a3bb-457f-af69-2d64013108de",
  "zitiId" : "04ffd90f-aa5c-40a5-b3f7-92b00e1b7895",
  "name" : "Test Service 1613996944",
  "egressRouterId" : "5a651e41-0c6a-49c4-8ff4-14f3a8a8d0a2",
  "clientHostName" : "newclient.com",
  "clientPortRange" : "80",
  "serverHostName" : "newserver.com",
  "serverPortRange" : "80",
  "serverProtocol" : "UDP",
  "encryptionRequired" : false,
  "egressRouterName" : null,
  "endpoints" : [ ],
  "attributes" : [ "#service01" ],
  "edgeRouterAttributes" : [ "#accessrouters" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/45f65780-a3bb-457f-af69-2d64013108de",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/812b2c2e-ccb1-41fb-83c1-c8f228712e2e"
    }
  }
}

Update Service

PUT /services/{id}

Authorization

This endpoint requires update action on the service resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

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

egressRouterId

String

true

endpoints

Array[String]

true

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

attributes

Array[String]

true

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

edgeRouterAttributes

Array[String]

true

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

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

Must be one of [TCP, UDP].

encryptionRequired

Boolean

true

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

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

egressRouterId

String

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

Must be one of [TCP, UDP].

encryptionRequired

Boolean

true

egressRouterName

String

true

endpoints

Array[String]

false

attributes

Array[String]

false

edgeRouterAttributes

Array[String]

false

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/434bef9c-0d00-46da-8154-c3ef52a9b321' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2d21qQTlRLUhFemFTM3gwYVF0UEFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJkNDBkN2I1LWFhMDgtNGY1NS04MTY2LTQ3NDZiZjI0NGMzYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk0MywiZXhwIjoxNjE0MDAwNTQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU3MTA0ODg3LTA5NjMtNGUzNy05YTc3LTg3NTc4ZTcxZmVkMlwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk0M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.kP6VvETyHIcuw-RgkM9iDaqTTchi4fOqkkQj39lJjwRfjB71pZsOdOgqmEtHr1Z5PN6xF-sIVWMDT75hfnHEdQJNo4d12hosbCY7RKCl4moRqwIWsD9a9H6Fq_KeyVmq2GFhJ1r367bv0J23OiMegOn80ddsqFUqyHqU2e-kY3c7NvPGfMFqVHjOSyQvRTW5IbplkFpDWQGICCur0RvWCd-oEkenGmP8zJ6f4aRymM8SyxzsMTfi3dVeUkviFWRYienLUhzTTStUlBZS6_D1W_Q05uqHC-tTs_OKCKQRb59lMTuPC87e9wlsxPccnScOKqkOEKzBVQEjfuzE3kwb_A' \
    -d '{"name":"Test Service 1613996943","egressRouterId":"8af62222-fdfe-4146-86c4-a53959e05717","attributes":["#service01"],"edgeRouterAttributes":["#accessrouterseast","#accessrouterswest"],"clientHostName":"newclient.com","clientPortRange":"443","serverHostName":"newserver.com","serverPortRange":"443","serverProtocol":"UDP","encryptionRequired":false}'

Example response

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

{
  "id" : "434bef9c-0d00-46da-8154-c3ef52a9b321",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-02-22T12:29:03.602009Z",
  "updatedAt" : "2021-02-22T12:29:03.616477Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "64537540-8f0c-4df6-bc9c-c19beb567117",
  "zitiId" : "zitiservice01",
  "name" : "Test Service 1613996943",
  "egressRouterId" : "8af62222-fdfe-4146-86c4-a53959e05717",
  "clientHostName" : "newclient.com",
  "clientPortRange" : "443",
  "serverHostName" : "newserver.com",
  "serverPortRange" : "443",
  "serverProtocol" : "UDP",
  "encryptionRequired" : false,
  "egressRouterName" : "ACME_edge_router_2021-02-22T12:29:03.600203Z",
  "endpoints" : [ ],
  "attributes" : [ "#service01" ],
  "edgeRouterAttributes" : [ "#accessrouterswest", "#accessrouterseast" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/64537540-8f0c-4df6-bc9c-c19beb567117",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/434bef9c-0d00-46da-8154-c3ef52a9b321"
    }
  }
}

Delete Service

DELETE /services/{id}

Authorization

This endpoint requires delete action on the service resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services/e6a84878-1b2d-4271-9449-c3799c3f87b3' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJwbC05SzQ0bjJfU3NMZlZLS2ROM2lnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUwOGI1M2FlLTNiNDAtNDExYy1hNGU1LTAyMjk5ZTg3MTk0YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk0NCwiZXhwIjoxNjE0MDAwNTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRkNTliZDIyLWE3YmItNDdhZC1hYjNkLWFhNTA0ZTFjZjg5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk0NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.g6MIc7IravlpZUIvykKMFG6XL2C3j1RcDpRL5Cd3KqG6Lsk674wSy3oX3c4xBPn0YVL1yMBF_rtOwqDl9Sn4u2gOE41HEfgvcSzYtA9UQ-P4VumIgPTPtIvdUhFrJY4yMdmaVkYlF90Lv8r7Zv_me9QpO5Qkdf-N3IZb2DlPhULPpySK8f8fviT4YkqD5ApntulYat796fjzuFD8y4XZb46npWSJWyxf68LdLu2PhxvY6MidtkmbI6MAvaHfDx_3sIAWXQfUcI4zycCcRxblHKmFlEICS8meiTEv8bV6WKP-wXnNHg3qKYn745ci10Eb3W_rmjTSNCWBE85eAVvhfw'

Example response

HTTP/1.1 200 OK

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

attributeType

String

true

Must be one of [APP_WAN, ENDPOINT, SERVICE, EDGE_ROUTER, EDGE_ROUTER_POLICY, CA, POSTURE_CHECK, SERVICE_EDGE_ROUTER_POLICY].

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

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

Path Optional Description

self

false

A canonical URI; The link to this resource.

network

false

Link to the Network within which this resource exists.

Embedded resources

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

zitiId

String

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.eyJqdGkiOiJSb1U1bzRtTm5UNGtmWDNuUzJCTWl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVhM2I3OTJmLWJiOTEtNDBhZS1hMTg5LWUwMjY5NTk5OGU2ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk2NCwiZXhwIjoxNjE0MDAwNTY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgyZmFiM2M5LThjZDAtNDA5Ni1hNWFlLThjNzU4ZjMwZjc1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.iHQFD-ZAQ8FIIIFlAll9-xBjSPVG-J_DT1s2vpY4YhEqBgxvtKQX4jbwhdr-TaYuaQ0RocFc1gPXCzJzGr3AZ3AuSPc2fhi1LDpqGSfj5Lrgj03AGQp2x88V8oi-fddFtsoonG_-PPXbS5jkIUq_RZm48PeQI2YJsBxJgeoOOArJ9-VP6XMZE18v9MjWB1Quzfu0r1Cao8IN_uYOsP8aJghbI21gaS0pbrG_VJOak4N-65aJjlXkYINi_XMjRhEWN1rCeZK19gWfohJpQanKo0JSQtTDG6MnlRn9DYc3B3qgM1eUWpIR8nGYfVAVf9NhSyEx5D5T4v7amnqEee0vyw'

Example response

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

{
  "_embedded" : {
    "appWanList" : [ {
      "id" : "c5fb95bb-02b1-4ced-8611-e671c2b0c7c8",
      "ownerIdentityId" : "20ea8741-5663-4583-9d18-92b01aa30f63",
      "createdBy" : "20ea8741-5663-4583-9d18-92b01aa30f63",
      "createdAt" : "2021-02-22T12:29:24.470479Z",
      "updatedAt" : "2021-02-22T12:29:24.470479Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-02-22T12:29:24.470358Z",
      "zitiId" : "b6dc04a4-d667-4626-9ebb-acf43ef9a73f",
      "networkId" : "96ef2094-f32c-42e3-b812-ef8a28c820bb",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/96ef2094-f32c-42e3-b812-ef8a28c820bb",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/c5fb95bb-02b1-4ced-8611-e671c2b0c7c8"
        }
      }
    }, {
      "id" : "17d69b1f-5486-48bf-bd0f-e71c8cfc2420",
      "ownerIdentityId" : "aabc4e5b-9b1d-4020-b115-0d508cc96ce3",
      "createdBy" : "aabc4e5b-9b1d-4020-b115-0d508cc96ce3",
      "createdAt" : "2021-02-22T12:29:24.542659Z",
      "updatedAt" : "2021-02-22T12:29:24.542659Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-02-22T12:29:24.542539Z",
      "zitiId" : "e0f0f488-036b-4348-b9f8-3248afa348fe",
      "networkId" : "e68d6159-10d1-49d2-8857-01f1cbc8281b",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e68d6159-10d1-49d2-8857-01f1cbc8281b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/17d69b1f-5486-48bf-bd0f-e71c8cfc2420"
        }
      }
    }, {
      "id" : "c1a955f9-4da6-4bff-96ec-fc543a9b4f84",
      "ownerIdentityId" : "9823027e-5e9d-4230-8710-8e37b2ae3b56",
      "createdBy" : "9823027e-5e9d-4230-8710-8e37b2ae3b56",
      "createdAt" : "2021-02-22T12:29:24.571284Z",
      "updatedAt" : "2021-02-22T12:29:24.580456Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Updated App Wan name",
      "zitiId" : "0cfeeaf0-df90-4e55-a8f4-ce622c946e2f",
      "networkId" : "a84e00af-0daf-4ec3-9053-aa1a04a4628c",
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a84e00af-0daf-4ec3-9053-aa1a04a4628c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/c1a955f9-4da6-4bff-96ec-fc543a9b4f84"
        }
      }
    }, {
      "id" : "35d8b1c4-ceda-4c6b-bddd-4f5543389b79",
      "ownerIdentityId" : "3d62a756-246e-47d8-bcc2-05aaf3a112fe",
      "createdBy" : "3d62a756-246e-47d8-bcc2-05aaf3a112fe",
      "createdAt" : "2021-02-22T12:29:24.622706Z",
      "updatedAt" : "2021-02-22T12:29:24.622706Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-02-22T12:29:24.622589Z",
      "zitiId" : "5e58ae4a-5746-4ab7-baf6-e32522a771c0",
      "networkId" : "6ff82f1e-7ab3-4a0e-a6e9-5fe675c54fd4",
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6ff82f1e-7ab3-4a0e-a6e9-5fe675c54fd4",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/35d8b1c4-ceda-4c6b-bddd-4f5543389b79"
        }
      }
    }, {
      "id" : "74fe2e3d-e315-4284-b7c0-7166f704ddf6",
      "ownerIdentityId" : "6c02bbee-ab89-4a08-9f86-7ae0a248a07a",
      "createdBy" : "6c02bbee-ab89-4a08-9f86-7ae0a248a07a",
      "createdAt" : "2021-02-22T12:29:24.662392Z",
      "updatedAt" : "2021-02-22T12:29:24.662392Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-02-22T12:29:24.662268Z",
      "zitiId" : "5a7eeb05-b3b6-46b6-aff2-da5faa9227ba",
      "networkId" : "e04cea73-34b4-45d6-bfe1-f4bef2886da2",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e04cea73-34b4-45d6-bfe1-f4bef2886da2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/74fe2e3d-e315-4284-b7c0-7166f704ddf6"
        }
      }
    }, {
      "id" : "493a3bd6-c8d2-4d09-9eff-ecd4429d6754",
      "ownerIdentityId" : "2602fdce-f77e-46c0-8ea6-b2bfc7947ffc",
      "createdBy" : "2602fdce-f77e-46c0-8ea6-b2bfc7947ffc",
      "createdAt" : "2021-02-22T12:29:24.801137Z",
      "updatedAt" : "2021-02-22T12:29:24.801137Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "ACME App Wan 2021-02-22T12:29:24.801016Z",
      "zitiId" : "a979c93b-3794-41d6-9042-6bd121e163dc",
      "networkId" : "c5830de2-23ae-4b04-a67c-3f8468d09828",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c5830de2-23ae-4b04-a67c-3f8468d09828",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/493a3bd6-c8d2-4d09-9eff-ecd4429d6754"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 6,
    "totalPages" : 1,
    "number" : 0
  }
}

Get App Wan

GET /app-wans/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

zitiId

String

false

networkId

String

false

serviceAttributes

Array[String]

false

endpointAttributes

Array[String]

false

postureCheckAttributes

Array[String]

false

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/aea58916-829c-4c45-a019-de415abc23b4' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJGcnhvS2JFLWlTcFdDNWJodVRZQW53IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRlNzkwYmM5LWUyYTQtNDMzZi1iNDgzLWM3YWU1YWQ0YjEwNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk2NCwiZXhwIjoxNjE0MDAwNTY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImJhYzNkMjc4LWJkOWMtNDM4ZC05ZGQ2LWU5NWY1N2M4MTVlZlwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.WEBcVXBkY_7pIzratCL-VVBU0Pf5yOLdofSGYUThyte3-zc5rqui7DWGRsTYHvXaXwKL9KlXjdUSnc35HLER4QKsxd9sF00_DyR-j5JDyV5Rz2-QKlMcTXUs2kEZ4y3VKMhnb5s8KZn8RZIWA7qiF3Q5wPMh0bpMufo99zDRw3a0rPkDh90PkQALpuWckOs9j_2W4NeABezIjx6RZme7rGP69BIsdVMPVbcKqkpiCkqTJ7RULlPOyZG1oKJLXBN4B78UkvDKAjMYWQhJyOFVu1hl_zdxiTdpgzOLMF66XKwSxAS3vHIKZsgVDp_rI-MPxMXCDAAH_mU2rue19S-oTg'

Example response

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

{
  "id" : "aea58916-829c-4c45-a019-de415abc23b4",
  "ownerIdentityId" : "22387f1b-de36-4a10-8fea-3c7d40971072",
  "createdBy" : "22387f1b-de36-4a10-8fea-3c7d40971072",
  "createdAt" : "2021-02-22T12:29:24.839120Z",
  "updatedAt" : "2021-02-22T12:29:24.839120Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "ACME App Wan 2021-02-22T12:29:24.838997Z",
  "zitiId" : "8db8d895-934c-4311-9be8-0c9e6c7520bb",
  "networkId" : "6a1b95bf-afca-4fe5-81b4-48744045ad92",
  "serviceAttributes" : [ ],
  "endpointAttributes" : [ ],
  "postureCheckAttributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6a1b95bf-afca-4fe5-81b4-48744045ad92",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/aea58916-829c-4c45-a019-de415abc23b4"
    }
  }
}

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

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

zitiId

String

false

networkId

String

false

serviceAttributes

Array[String]

false

endpointAttributes

Array[String]

false

postureCheckAttributes

Array[String]

false

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.eyJqdGkiOiJDQm9LMU02Q0gtVzF4cVdTT2FUVmdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBhMGEyNjNhLTI0OTctNDIwYy1iMzEyLTg0OWQyMDJjODFmNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk2NCwiZXhwIjoxNjE0MDAwNTY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU4NWJlYjQ3LTFmOTgtNGQzNC1iZGU2LTU5NjdiNmU2ZmE2NVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.qEAM5mCorBS95JvvSxrVGX4Ycf-FWJVsHUgRjBeq8VzYrJLoSfBgFDZ0weWCz9WFJLPmERxBxvrf4wm91IdZugal2dIdFAlvZZ--PSe5GvugIEB2q8v5Xao0SrW-w0Gr7aTHOef-RvhUbFswX7pWzBVKhbuKSlaptESPNG19dBZPOS6cocJjBgP5MemPR1yTHPVC2g7fyNnxG5jNdnNyyVzDz-VGAWGuCy127Su1JOdYCVmJR6s2RInzjaBKuzm8MFSR8v4LBybR4Q5J0Pw7liQ0N90b-M0F_vD65nugCcM4WAhYbroanWAJZxeUZBItksFeBghpp1QZoovzeO0EGg' \
    -d '{"networkId":"92986f89-cfa8-4869-aa6d-bda10c2c863d","name":"Test App Wan 1613996964","endpointAttributes":["#accessclients","@Test_endpoint2021-02-22T12:29:24.924326Z"],"serviceAttributes":["#service01"],"postureCheckAttributes":["#windows"]}'

Example response

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

{
  "id" : "81f5031f-c32d-463c-8d56-ac673a3e0c18",
  "ownerIdentityId" : "0a0a263a-2497-420c-b312-849d202c81f5",
  "createdBy" : "0a0a263a-2497-420c-b312-849d202c81f5",
  "createdAt" : "2021-02-22T12:29:24.947521Z",
  "updatedAt" : "2021-02-22T12:29:24.949926Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Test App Wan 1613996964",
  "zitiId" : "ce12e4bc-6b30-48dd-9f69-e9806f31ed0b",
  "networkId" : "92986f89-cfa8-4869-aa6d-bda10c2c863d",
  "serviceAttributes" : [ "#service01" ],
  "endpointAttributes" : [ "#accessclients", "@Test_endpoint2021-02-22T12:29:24.924326Z" ],
  "postureCheckAttributes" : [ "#windows" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/92986f89-cfa8-4869-aa6d-bda10c2c863d",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/81f5031f-c32d-463c-8d56-ac673a3e0c18"
    }
  }
}

Update App Wan

PUT /app-wans/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

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

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

name

String

false

io.netfoundry.core.validation.ResourceName.

zitiId

String

false

networkId

String

false

serviceAttributes

Array[String]

false

endpointAttributes

Array[String]

false

postureCheckAttributes

Array[String]

false

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/c1a955f9-4da6-4bff-96ec-fc543a9b4f84' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJaSjFVS1Y4cHNCZ3J5d28tMVZwS0tnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg3OGRkNTA3LWIyNTYtNDExMy05ZmM5LTc3MDhmMGZmNGIxMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk2NCwiZXhwIjoxNjE0MDAwNTY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImVhNjNmY2YyLWQ5YWYtNGM0Zi1iNGE5LTQ2ZjRmODVjODk3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ewotdN4a9rmHnr6NY6525RsPCzj-fT2TvUi4sLtiue3EtGgbIjJ9jNjinwZ2_15-7qNJUY4BQ-UGdF0zP2Qu8ATIovM9DRJSDgoruUWUKguYfLuGXTGjYK8tP6wnoope4k7mxPmh4xCLWM0uTv7Q8ZhBeBfibqtqIRuEV5eDeOLqSuN853WSNTagEFvttQSYxDTI5mhu5twyj2UOEgngdf5pRNlIcHujwaTEe6D6Yo30pMNz_K8kFWLMzOZDOVz4S3MizGgeZVk6FTkJMQXw51fEakc9Gev5qrRJZMksPeN0s3ooGUG5Dylm0S7O5lZ2Ogt2XtuYUisSpqa94WOqyw' \
    -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" : "c1a955f9-4da6-4bff-96ec-fc543a9b4f84",
  "ownerIdentityId" : "9823027e-5e9d-4230-8710-8e37b2ae3b56",
  "createdBy" : "9823027e-5e9d-4230-8710-8e37b2ae3b56",
  "createdAt" : "2021-02-22T12:29:24.571284Z",
  "updatedAt" : "2021-02-22T12:29:24.580456Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Updated App Wan name",
  "zitiId" : "0cfeeaf0-df90-4e55-a8f4-ce622c946e2f",
  "networkId" : "a84e00af-0daf-4ec3-9053-aa1a04a4628c",
  "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
  "endpointAttributes" : [ "#usendpoints" ],
  "postureCheckAttributes" : [ "#windows" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a84e00af-0daf-4ec3-9053-aa1a04a4628c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/c1a955f9-4da6-4bff-96ec-fc543a9b4f84"
    }
  }
}

Delete App Wan

DELETE /app-wans/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/58863d9d-e64c-433a-9a22-7702c13be916' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJycTdDdFJQLVpnUlVvelpnMDV3MU5RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdhNDk5NDBlLTZiYmEtNGZiYy05NmJhLTkxYTYxYzJiN2EyYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njk2NCwiZXhwIjoxNjE0MDAwNTY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhmMzczZDJjLTM0YjUtNDdiZS04OGMyLTgzMDRiNzRjNmU3ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njk2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.hPe8qOPRQ08jXUjOXh77kfZMjfYJvB1AbgazeKhGFM2b5INFYlu3QnndteUVGY6Y4Frr0eOAQ6SHCwgQ0nmNTxL-2A_0rfrns9qypEiB_TgIg3wPiSqyandB8oIweidvLavRVY-aZCKq_a6G_8rJZsJdnJcjCW2pv20D7CilZny98nJ-NDyL13ouQ67wB9sq3cwFXFky9P_mE_Ok-u5IIM_1C8Ys5YMJCADw75H3-47uHg9OZsEq2edJuoVjvGn0yS3SE5aW6ewuMLcdcs-bPEMoV96l-9Hhs8aniQ3ywMYdke-EwRfXvi2488mUL2S-hQUO9TPx3Q2jpkRbplAOrA'

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

attribute

Object

true

deleted

Object

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

id

String

false

zitiId

String

false

Size must be between 1 and 255 inclusive.

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

type

String

false

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

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

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

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

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfR0lDV1JzcG9penBlQnZEaXE3d3RnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkxOGE0OTFiLWNiMzgtNGJkMi04OWNjLWIyZTE3Y2M4MWYzYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg4MiwiZXhwIjoxNjE0MDAwNDgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImE3NzE4YTdiLWNmZjMtNGRjZS05YzFmLTIxYjVmNGQ2Mjk1NlwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg4Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.M3cNWmm2ad0N3j6kxiaxDrEWp8ukV8d8niu0Dye1XLlK5vKc4EkWYGPnhG2M5xvF2AJIwMWA1K6nAcBlsd6UsKJsJF5_Bw7tfcH9qcN9yuDzkG65CiMRWMHNvRWsi8YKmWf6oNP0xGYvWMqf13tUYkiPctrIAsioVflp7UE7rleJB2VpTCz2ujxtGG3CVJZGKbYAhYFfouE2fEU-x4nSsaPRcxZTaaDPRxu5MO91mHRGKVP2FwJyjvBED7eBZffJeFhMbeSqha_izDzwKvuUqQDCip4w7nT8d4cNvagD2YyFPWs5ewFNGeRaib2TIl4bQzOvltdj1-B96x8JOIcW9w'

Example response

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

{
  "_embedded" : {
    "postureCheckList" : [ {
      "id" : "5d81ace5-1585-4f36-b453-6c633ea78961",
      "zitiId" : "ziti.id.d8xeuhdrr30",
      "name" : "Our Service 48436799314122987",
      "networkId" : "595a7f85-f3a0-4e2c-ae67-2b41af9d9941",
      "type" : "OS",
      "ownerIdentityId" : "89319d05-8d20-4b21-b9d7-a5fa07219f24",
      "createdBy" : "89319d05-8d20-4b21-b9d7-a5fa07219f24",
      "createdAt" : "2021-02-22T12:27:59.546913Z",
      "updatedAt" : "2021-02-22T12:28:00.974811Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#Attr-4", "#Attr-2" ],
      "data" : {
        "operatingSystems" : [ {
          "type" : "Linux",
          "versions" : [ "16.2" ]
        } ]
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/595a7f85-f3a0-4e2c-ae67-2b41af9d9941",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/5d81ace5-1585-4f36-b453-6c633ea78961"
        }
      }
    }, {
      "id" : "6bf80387-e40f-4f27-8bad-e5cfdae690aa",
      "zitiId" : "ziti.id.d8xeuixb8ib",
      "name" : "Our Service 48436799314190504",
      "networkId" : "595a7f85-f3a0-4e2c-ae67-2b41af9d9941",
      "type" : "MAC",
      "ownerIdentityId" : "0497361e-e4b0-426f-a5d5-8ea11177a4ef",
      "createdBy" : "0497361e-e4b0-426f-a5d5-8ea11177a4ef",
      "createdAt" : "2021-02-22T12:27:59.636262Z",
      "updatedAt" : "2021-02-22T12:28:01.032189Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#Attr-4", "#Attr-2" ],
      "data" : {
        "macAddresses" : [ "00:0a:95:9d:68:16" ]
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/595a7f85-f3a0-4e2c-ae67-2b41af9d9941",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/6bf80387-e40f-4f27-8bad-e5cfdae690aa"
        }
      }
    }, {
      "id" : "489ddacd-cfc4-4e35-9050-fb69b9275d0c",
      "zitiId" : "ziti.id.d8xeujvdwsu",
      "name" : "Our Service 48436799314192313",
      "networkId" : "595a7f85-f3a0-4e2c-ae67-2b41af9d9941",
      "type" : "MFA",
      "ownerIdentityId" : "c7827419-9f31-4338-9c98-5dc133cf23ef",
      "createdBy" : "c7827419-9f31-4338-9c98-5dc133cf23ef",
      "createdAt" : "2021-02-22T12:27:59.693426Z",
      "updatedAt" : "2021-02-22T12:28:01.088296Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#Attr-4", "#Attr-2" ],
      "data" : { },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/595a7f85-f3a0-4e2c-ae67-2b41af9d9941",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/489ddacd-cfc4-4e35-9050-fb69b9275d0c"
        }
      }
    }, {
      "id" : "f9b68036-6b44-4491-9d95-fc55b81ab036",
      "zitiId" : "ziti.id.d8xeukuhbc7",
      "name" : "Our Service 48436799314193394",
      "networkId" : "595a7f85-f3a0-4e2c-ae67-2b41af9d9941",
      "type" : "DOMAIN",
      "ownerIdentityId" : "308767ee-9a5f-4bbe-a456-9023c7da0c3c",
      "createdBy" : "308767ee-9a5f-4bbe-a456-9023c7da0c3c",
      "createdAt" : "2021-02-22T12:27:59.752501Z",
      "updatedAt" : "2021-02-22T12:28:01.144937Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#Attr-4", "#Attr-2" ],
      "data" : {
        "domains" : [ "abc.com" ]
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/595a7f85-f3a0-4e2c-ae67-2b41af9d9941",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/f9b68036-6b44-4491-9d95-fc55b81ab036"
        }
      }
    }, {
      "id" : "72919d1b-5e37-4ff6-8ed4-be5e6375b196",
      "zitiId" : "ziti.id.d8xeultn1k7",
      "name" : "Our Service 48436799314194288",
      "networkId" : "595a7f85-f3a0-4e2c-ae67-2b41af9d9941",
      "type" : "PROCESS",
      "ownerIdentityId" : "6edd861f-0c06-435c-9865-896223c275b5",
      "createdBy" : "6edd861f-0c06-435c-9865-896223c275b5",
      "createdAt" : "2021-02-22T12:27:59.811659Z",
      "updatedAt" : "2021-02-22T12:28:01.201195Z",
      "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/595a7f85-f3a0-4e2c-ae67-2b41af9d9941",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/72919d1b-5e37-4ff6-8ed4-be5e6375b196"
        }
      }
    }, {
      "id" : "3d5e2d35-b04c-4d3d-a28d-b4222122dc0c",
      "zitiId" : "ziti.id.d8xeun5b00w",
      "name" : "Our Service 48436799315608775",
      "networkId" : "f8445501-1003-4fce-b29e-dd08c0b59d65",
      "type" : "OS",
      "ownerIdentityId" : "f51f21dc-9fb8-430f-ace8-c56d686706f9",
      "createdBy" : "f51f21dc-9fb8-430f-ace8-c56d686706f9",
      "createdAt" : "2021-02-22T12:27:59.891196Z",
      "updatedAt" : "2021-02-22T12:28:01.254092Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#Attr-4", "#Attr-2" ],
      "data" : {
        "operatingSystems" : [ {
          "type" : "Linux",
          "versions" : [ "16.2" ]
        } ]
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f8445501-1003-4fce-b29e-dd08c0b59d65",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/3d5e2d35-b04c-4d3d-a28d-b4222122dc0c"
        }
      }
    }, {
      "id" : "05985a60-079c-4943-9c8b-6b76371c9c28",
      "zitiId" : "ziti.id.d8xeuo21aba",
      "name" : "Our Service 48436799315612451",
      "networkId" : "f8445501-1003-4fce-b29e-dd08c0b59d65",
      "type" : "MAC",
      "ownerIdentityId" : "febcce9e-ea86-4363-93dc-e1ae3f28310a",
      "createdBy" : "febcce9e-ea86-4363-93dc-e1ae3f28310a",
      "createdAt" : "2021-02-22T12:27:59.946164Z",
      "updatedAt" : "2021-02-22T12:28:01.307969Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#Attr-4", "#Attr-2" ],
      "data" : {
        "macAddresses" : [ "00:0a:95:9d:68:16" ]
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f8445501-1003-4fce-b29e-dd08c0b59d65",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/05985a60-079c-4943-9c8b-6b76371c9c28"
        }
      }
    }, {
      "id" : "b44b488d-d01d-488d-98e9-e7c7b269c223",
      "zitiId" : "ziti.id.d8xeuozmbvg",
      "name" : "Our Service 48436799315613481",
      "networkId" : "f8445501-1003-4fce-b29e-dd08c0b59d65",
      "type" : "MFA",
      "ownerIdentityId" : "75c0289c-c7bd-4bae-aef3-8a11312af065",
      "createdBy" : "75c0289c-c7bd-4bae-aef3-8a11312af065",
      "createdAt" : "2021-02-22T12:28:00.002594Z",
      "updatedAt" : "2021-02-22T12:28:01.362104Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#Attr-4", "#Attr-2" ],
      "data" : { },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f8445501-1003-4fce-b29e-dd08c0b59d65",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/b44b488d-d01d-488d-98e9-e7c7b269c223"
        }
      }
    }, {
      "id" : "c42d2294-3ce3-4d83-8ea8-64412bb2c36f",
      "zitiId" : "ziti.id.d8xeupy3nu5",
      "name" : "Our Service 48436799315614261",
      "networkId" : "f8445501-1003-4fce-b29e-dd08c0b59d65",
      "type" : "DOMAIN",
      "ownerIdentityId" : "1399c2c1-4511-41ab-851e-652da21b60c5",
      "createdBy" : "1399c2c1-4511-41ab-851e-652da21b60c5",
      "createdAt" : "2021-02-22T12:28:00.060538Z",
      "updatedAt" : "2021-02-22T12:28:01.416421Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#Attr-4", "#Attr-2" ],
      "data" : {
        "domains" : [ "abc.com" ]
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f8445501-1003-4fce-b29e-dd08c0b59d65",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/c42d2294-3ce3-4d83-8ea8-64412bb2c36f"
        }
      }
    }, {
      "id" : "c79554eb-0a76-43ca-88cc-763b96bb0a5b",
      "zitiId" : "ziti.id.d8xeuqwoucv",
      "name" : "Our Service 48436799315618524",
      "networkId" : "f8445501-1003-4fce-b29e-dd08c0b59d65",
      "type" : "PROCESS",
      "ownerIdentityId" : "deddf86f-85a9-4644-b22c-2162cea479f7",
      "createdBy" : "deddf86f-85a9-4644-b22c-2162cea479f7",
      "createdAt" : "2021-02-22T12:28:00.118622Z",
      "updatedAt" : "2021-02-22T12:28:01.471739Z",
      "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/f8445501-1003-4fce-b29e-dd08c0b59d65",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/c79554eb-0a76-43ca-88cc-763b96bb0a5b"
        }
      }
    }, {
      "id" : "734b2d2a-6db8-45c1-baff-684cf303f993",
      "zitiId" : "zitiId-fake-1b8b8e30-e60e-4b94-bc43-e4ef82a7eab2",
      "name" : "Test Posture Check-28",
      "networkId" : "30cd27ba-f139-428f-a704-dcd83330f890",
      "type" : "DOMAIN",
      "ownerIdentityId" : "75f2a746-8d6e-4152-8994-df57daa480b9",
      "createdBy" : "75f2a746-8d6e-4152-8994-df57daa480b9",
      "createdAt" : "2021-02-22T12:28:00.224909Z",
      "updatedAt" : "2021-02-22T12:28:00.224909Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "Test-Attr" ],
      "data" : {
        "domains" : [ "abc.com" ]
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/30cd27ba-f139-428f-a704-dcd83330f890",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/734b2d2a-6db8-45c1-baff-684cf303f993"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 11,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Posture Check

GET /posture-checks/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

zitiId

String

false

Size must be between 1 and 255 inclusive.

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

type

String

false

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

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

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/c79554eb-0a76-43ca-88cc-763b96bb0a5b' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ4dVdEZ3lvNTA5S0dYd2h2SHdUOXZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVhNmE2NTRiLThmYWUtNDA5Ny1hMTdiLWZkODIzNmM1NDUwZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg4MCwiZXhwIjoxNjE0MDAwNDgwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImViOWIyOWIyLWU4NWQtNGYyMi1hZTFlLTFhNjA0ZmYzYmE5YVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg4MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.aVbD0f53NjuMYM-lWM91XaKI6VGI22QX-suTxSkfXm7qo3nM1j3ojf5Mi3ZVh3yQFjhr-PGKZ3BAx5Mgb9EOUNXzHbfWIFBtPFpE-vi5dggmBgL8-1dhuJ1yvQ0_ziU6FlREZSkIdLrMupSwTe42z00FctX-KISxHvV8ioplUM7VtKuZbLf_JLjQ_fbY3Pat8rw63QZpcw_gCiu_VdwJ0bI_EITFXiFJ2Xnd6ws4214dULbctarI4eFuYyN2JCZMV1be5Qggm6dKOYU8brWyyDB6blHAc5MO8ddq9b3ZZZ_ioUWv3TiCcIydl0bBKsPRbJmofiblFTG2vfDeVVjGeg'

Example response

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

{
  "id" : "c79554eb-0a76-43ca-88cc-763b96bb0a5b",
  "zitiId" : "ziti.id.d8xeuqwoucv",
  "name" : "My Posture Check 48436799315618524",
  "networkId" : "f8445501-1003-4fce-b29e-dd08c0b59d65",
  "type" : "PROCESS",
  "ownerIdentityId" : "deddf86f-85a9-4644-b22c-2162cea479f7",
  "createdBy" : "deddf86f-85a9-4644-b22c-2162cea479f7",
  "createdAt" : "2021-02-22T12:28:00.118622Z",
  "updatedAt" : "2021-02-22T12:28:00.118622Z",
  "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/f8445501-1003-4fce-b29e-dd08c0b59d65",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/c79554eb-0a76-43ca-88cc-763b96bb0a5b"
    }
  }
}

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

id

String

false

zitiId

String

false

Size must be between 1 and 255 inclusive.

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

type

String

false

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

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

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.eyJqdGkiOiJsUGFrT01DZHBzRkRzS1dCY2NvN0pBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRlZGRmODZmLTg1YTktNDY0NC1iMjJjLTIxNjJjZWE0NzlmNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg4MCwiZXhwIjoxNjE0MDAwNDgwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU0Y2RmOTYzLTAxNGYtNDAxMC04ZjRiLTNlMjhiNzkwNTI1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg4MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.YPvXCVK5hQTdZ-0HTJZ6Ss_uVJEdhZ925lpOeWafjh1FsAO-sqFRF-Hq1NGsv_OMRM0soEOeA3YsfvnNbcO1GxNaq-bnK8nSThFUze6CgejLLb6p7hZ0BauF8FsvlsVmS8dRG5YZl0sPw4N1GUjTd1asrlYjiUSDX6sbtQ5OLcAnVK_iCFyXNRAhu2Ygk7QuhCG9y4Edvby8OcObfxqezAYJbLR8j4WTqCiqR63lq3s-YLio7m2UbXi9lfkAWsjL62cCwLxyIfuivqsNfZfwb77yInh13OcJlQ7KBoi-wbgDPwH-b5Y37ooyZf4WTQt5yjBmxvells14YMhgqbCGHw' \
    -d '{"name":"My Posture Check 48436799315618524","networkId":"f8445501-1003-4fce-b29e-dd08c0b59d65","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" : "c79554eb-0a76-43ca-88cc-763b96bb0a5b",
  "zitiId" : "ziti.id.d8xeuqwoucv",
  "name" : "My Posture Check 48436799315618524",
  "networkId" : "f8445501-1003-4fce-b29e-dd08c0b59d65",
  "type" : "PROCESS",
  "ownerIdentityId" : "deddf86f-85a9-4644-b22c-2162cea479f7",
  "createdBy" : "deddf86f-85a9-4644-b22c-2162cea479f7",
  "createdAt" : "2021-02-22T12:28:00.118622Z",
  "updatedAt" : "2021-02-22T12:28:00.118622Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "data" : {
    "process" : {
      "osType" : "Windows",
      "path" : "c:\\programs",
      "hashes" : null,
      "signerFingerprint" : null
    }
  }
}

Update Posture Check

PATCH /posture-checks/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

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

type

String

true

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

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

id

String

false

zitiId

String

false

Size must be between 1 and 255 inclusive.

name

String

false

io.netfoundry.core.validation.ResourceName.

networkId

String

false

type

String

false

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

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

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/c79554eb-0a76-43ca-88cc-763b96bb0a5b' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJPLUp6Vk1qSEk1SlBqcU8wdFFCZktBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdmYzQzZmY5LWYxZmMtNDg4NS1hOTBkLTIyMGQyZjhmNjZmMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg4MSwiZXhwIjoxNjE0MDAwNDgxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdiZmFiNGU2LTVmMmItNGZmZC05NmM3LTg3NTlmOGQ2NTlmMlwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg4MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.c1NPXZXPrt5KpBl_s08YPxuA7FmeFEkL5rx7ep3yAICG_mFFeFmdYBQmPGd5kOj1b2r8NuBjAPBcg91J0KNw1NDSPt3I1uKnIc_IAdKKAm32hTKhy2mcqA8MhGvPjxVFZRGdpJKTYftmJqnAUhERq2q8d1QkDHRgcVzSzwwIZXXxs4UF6G5dX67JoGLdPKF2miF4TQXBtl5moLGsJNEJJ98CIfm_xDJ0JvMDxYLasidAo-Nkq_yr7l3z9lD3IuXxmyealDskEUCa_5l00PLlvBKuL8AC7Rv9dachPP3z8N7vCoJIyfklxyy1dhUzyVC2Krns24tkdaTG_07xm_o0bA' \
    -d '{"name":"Our Service 48436799315618524","attributes":["#Attr-4","#Attr-2"]}'

Example response

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

{
  "id" : "c79554eb-0a76-43ca-88cc-763b96bb0a5b",
  "zitiId" : "ziti.id.d8xeuqwoucv",
  "name" : "Our Service 48436799315618524",
  "networkId" : "f8445501-1003-4fce-b29e-dd08c0b59d65",
  "type" : "PROCESS",
  "ownerIdentityId" : "deddf86f-85a9-4644-b22c-2162cea479f7",
  "createdBy" : "deddf86f-85a9-4644-b22c-2162cea479f7",
  "createdAt" : "2021-02-22T12:28:00.118622Z",
  "updatedAt" : "2021-02-22T12:28:01.471739Z",
  "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/f8445501-1003-4fce-b29e-dd08c0b59d65",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/c79554eb-0a76-43ca-88cc-763b96bb0a5b"
    }
  }
}

Delete Posture Check

DELETE /posture-checks/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks/c79554eb-0a76-43ca-88cc-763b96bb0a5b' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ5Mmt4UXlkWDNIRV9LSVg4YnVPdkFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBmMzk1ZjQ2LTlhZWEtNGZkNy05M2Q3LTgzZTM2MDgzZDE4YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg4MiwiZXhwIjoxNjE0MDAwNDgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImEyOWI2MTc4LTRmODctNDQ4ZC1hYTQxLWE4OWE0MGJhNWQ1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg4Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Tx7heY3Q-s8FBGqk15rXoPqvNHceNMKEQ3VbwXNFDFyhjyWH00-VWqAXW4W7Os-ZWnfW0ai-Cg3DrP4DtdForiKDhmHPxTJ8SUT_9ZVbt2gJiCJUj8UEGafFdMwNqgKRZKji8qxD2A7z7EyENZa9Ru3a1q_n-TzHv1tE7SPGWIl6rjnriMW6DWncg0hGGzwXw19DjW8uPaawfGC_RUBny_CuTt8gZ4SuxxTeukQurNWIvVNyHJaQ-bvO3xeU2ddtonKoMkAW29vLwfesKOF0qGlkchCWwHZRLrRz8KLXxdvEc__g3u07i5P68dZxk9ZymqhnC9vmNO49GI4HOzrzVg'

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

Request fields

No request body.

Response fields

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

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

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?isAuthEnabled=true' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJLN1RhOUhYTVpzOVBfUm04c1JqVUFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI1NmIzMTgxLTBjN2ItNDVjZS04ODIyLWU2YTQ4NzVlZDkxZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg2NSwiZXhwIjoxNjE0MDAwNDY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg0OGU0YmY4LTQ1ZWUtNDM3NC04ZjdlLTdjOGNlYjliNWY3Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg2NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.IkmKQlz2qSeFFhWrWnQpDLfQS2ZvARTA3gQwHwsjUWY0w064HZhAolk0T1KUFkDY3b6HRw1SfufJwIOUvhQMIBM-XBcjd9fv9xk726PAWVbVvgipsBqD6zpCR-hOMBs4srMuCJAKHtnfkDKrF2w3gLmmYqBJbXfad46g6EtIvofwNAoZahzuQjKQYpFDbj7A5St4-wEZM-CQ9k9-3S70_whhYmrccvk-P0Hdkzl2edEDUUH85eftg9AqiuUsANRw5KTMRAt9gAVvAR0sgJe3AwEEkgjNnnQD-KquWOgPtRxcVFwW6NbrgUZrntO02762zdw13jyTAxaOO7k3otW9-g'

Example response

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

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

Get Certificate Authority

GET /certificate-authorities/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

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/8b9e0675-b033-4997-8e88-e58ce009f729' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyLXlDb2Z2UHR1ZGRyVERsREtRZzB3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ1ZGQ0Y2QzLTE5YmMtNGM3ZC05NDBjLTBjYjdlMDg0Y2I4MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg2NSwiZXhwIjoxNjE0MDAwNDY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjZkYmYyYjg0LTllMWUtNGVjNS04NzViLTgwMjgyZWRhNDE2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg2NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Ce7b1yQnZpqnMwxnz0pGWbrxRocM-4c11_8H_WcZZyrK_uj8u3elBHZjDGGw_No6UBzd2RUSR2qsxEqs9D0qow-1H7DGDBG2g7HznET8ifWedGj174M1M2rLsAS8px6SNSwy6YxXaJre0DVZH1yqaftv5tujEzWkzRsdvpu01dX8j23FrXcbnzd-Sq0veiNMzo2LnuUJs8eRWd-9wVjKGWmusxkicMH9m2kNHr1XnjBOVTNZ0Yljs36GjF9opjfZlzlEeP3vcHqqFXeATDViQM3oQG1G2-m7kqNu5fP9msaUW5AfsrK0DpnpbC0Nmd-MLl3AwidbKuJqXzTrNjnpnw'

Example response

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

{
  "id" : "8b9e0675-b033-4997-8e88-e58ce009f729",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-02-22T12:27:45.695529Z",
  "updatedAt" : "2021-02-22T12:27:45.695529Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "c3630f30-dea2-4f0d-a556-465d08802f84",
  "zitiId" : "84cecf9b-b31c-42de-bf7b-ef446f68f35e",
  "name" : "ACME CA 2021-02-22T12:27:45.695288Z",
  "endpointAttributes" : [ ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "fakePem",
  "verified" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c3630f30-dea2-4f0d-a556-465d08802f84",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/8b9e0675-b033-4997-8e88-e58ce009f729"
    }
  }
}

Create Certificate Authority

POST /certificate-authorities

Authorization

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

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

name

String

true

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

autoCaEnrollmentEnabled

Boolean

true

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

authEnabled

Boolean

true

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

ottCaEnrollmentEnabled

Boolean

true

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

certPem

String

false

Size must be between 100 and 2147483647 inclusive.

endpointAttributes

Array[String]

true

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

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

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.eyJqdGkiOiJJWHRSbVB1TkpFMFFhYndVQlVaU3BnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU3NmU0ODc5LTYwMDktNGVjNS1hYmNlLWU0OGQwZDQ0ZTI3MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg2NCwiZXhwIjoxNjE0MDAwNDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI4NTM1MGVjLTQ5MzQtNDdhMi04OGZmLTZlZjAyMmQ5MWFhNlwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.M1cqQEVG2ieieFuZ2h9Bt1pkFyrwa83I6mjIDAdpJhfiobJpGDfwIBI-WsD5__d2pfH0aB2Scr3_yDZG2A2-F1AR82MRSbWHe53Lv8YOswn47eM9Aopw1QGRShtsgd1Cx-KG9IwZMvDEP3g_v7EcF03S2Af5w-QIXVyLE_Gz4jVeteY3MZzvqhvApwVheHXdc-bxIL38AfTRhgIvhy3u1VMZrhK0f3CfzNK_qhGf2fAzM4BufnKctdq4JW6XRRypeRarxF3AoDaI6-lbgKmqX0pVikxbC_h8ECzW7YwJvtOPpK0R-pjzj-Ymzj6mlgowhdEqLhJo6TwJupvcs1ki6w' \
    -d '{"networkId":"47cb8914-8ea6-4704-8370-1a3427670ec4","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" : "92b7af7e-3b5c-4f96-a887-6cfcd5bb09b6",
  "ownerIdentityId" : "e76e4879-6009-4ec5-abce-e48d0d44e273",
  "createdBy" : "e76e4879-6009-4ec5-abce-e48d0d44e273",
  "createdAt" : "2021-02-22T12:27:44.731524Z",
  "updatedAt" : "2021-02-22T12:27:44.735571Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "47cb8914-8ea6-4704-8370-1a3427670ec4",
  "zitiId" : "1c0ce01c-fad4-4ffe-bf7e-d72969fadbb5",
  "name" : "Test ca 02",
  "endpointAttributes" : [ "#secureclients" ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "-----BEGIN CERTIFICATE-----MIIEujCCAqKgAwIBAgIRAL9YVv7hhgdfje0+onHqzogwDQYJKoZIhvcNAQELBQAwczELMAkGA1UEBhMCVVMxEjAQBgNVBAcTCUNoYXJsb3R0ZTETMBEGA1UEChMKTmV0Rm91bmRyeTEQMA4GA1UECxMHQURWLURFVjEpMCcGA1UEAxMgTmV0Rm91bmRyeSwgSW5jLiBJbnRlcm1lZGlhdGUgQ0EwHhcNMjEwMTE1MjEwMDU3WhcNMjIwMTE1MjEwMTU3WjBcMQswCQYDVQQGEwJVUzESMBAGA1UEBxMJQ2hhcmxvdHRlMRMwEQYDVQQKEwpOZXRGb3VuZHJ5MRAwDgYDVQQLEwdBRFYtREVWMRIwEAYDVQQDEwlrWHdMajA0WFQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDJDRmC32XN31LU04Q4uh2uco+78sxCg8BzBbxQ7LrXRqdnfeuskoOx+b8OcA9Af4U9Co8rqrPaUR3y1bME5fIhZTFjesV3Z+V+dRyLlQQ6/tXybBwYeBUUwE/NSECx5jKXbLX3WgLISffxFToB5FVhX2okCkOPOOXiirKwUe9pCfWafnEJAevjH001nEMDh2Ir5Yny6PrU3SgRj9F1+aZ3kuattq89JybUofN1HHTGPOAUUzXIudhhFQC2HYGABGbxvoWBSFmM6i+oWHS9GOX5YnfApcbRDEiWHnGfQEPCOG3sRcA/NfPwV9wChyPMadgXNl+Pc9aFEOj20qmk/LK5AgMBAAGjYDBeMA4GA1UdDwEB/wQEAwIF4DAMBgNVHRMBAf8EAjAAMB0GA1UdDgQWBBRERYGCL0A1YBMCUbxwz4sAk6cfkTAfBgNVHSMEGDAWgBTFYtjJ5IqMPUdx6X0KdeZqZratzzANBgkqhkiG9w0BAQsFAAOCAgEAekd7/VB1nWpLa/2iu7xz8C0MPnkczH4qvWSgoJ7tJ+bXqT4+CL3T4jk7kRFxAj6YXDaTyrhzlwtNxmmH0fcJ0NNXF+86pAAJWbjzgpy20YOy++R4FgJM0Mai6FRDeec94BdFV90ZDxfQ7UJtV3DXtzZAVZGUMo/hsPWi0g2LzJxj2jScugjHBl5rbdc8eQdenAg4Es47dac7sF4XBLocYZeyei4LxaAgVW+R8RmU+VrJv8HcTiRaweo5/47DxYTCg69LvKThf/ow2nS+BW1bHEyD7EI++UuBk/qwoSEtjpMaXlPzN4hMk/Ht7JeifYvWloz2VgJQm8C7O4jplUcVmHkL2OgpGhXiEidA5w1xBInuohQQIK+jSFh7sxG/Ck0EVNIE9BfOc6hhM6emL0xFDoNdSXEGLs4Fm4IaazJJxREJZoB2Cb5c7MKvO6EMF08xG2JNf2P9QiQu6nWZFmyh3wUKY6/LW6YlOhPAmbQ/gu0q+0UuzgnJU61vrIedekDK8q4ePvFZDEsXKg+gA14d5eGh4dRrOqvUZtyE8r6g8vUveQsOpjt7BML6p7kSXW6OGe2K5FrnF2vhJSbHd/zb+VFhm355ssqubCpNpfnrHGoquQVbXJ3HyFEQ0i+BugEUDDE2lIofz/qlq9x+vtb13CMIy1w5WLo3pCVTsufnZmo=-----END CERTIFICATE-----",
  "verified" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/47cb8914-8ea6-4704-8370-1a3427670ec4",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/92b7af7e-3b5c-4f96-a887-6cfcd5bb09b6"
    }
  }
}

Verify Certificate Authority

POST /certificate-authorities/{id}/verify

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

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/41df8f2c-8429-4ad5-a5fa-1c7b83247728/verify' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJQcndyTHA1eVJ6Wk43NkM1SURfMjlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdkMGJiODFiLTRjZWYtNGVkMy1iZTQ5LTQ2ODFjNTg2NjU2NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg2NCwiZXhwIjoxNjE0MDAwNDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY0NjIxYTY5LTAwNDAtNGEwOC05NTI5LWM2YzgxY2MzYmU4ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.s5MgnqFTPyfmwzJigCDaYOGGvBmgXjN7tHJsRwa9gUxgw7Vd0qf9OG8hXK0TmR-e6_7_GKi7so5-AIk2Yjg8oCw227UoNuIaXSSYsPAf7tlUyOC2TaobBWwBxpKNjGx7Klt0JmGBJLhewFwlKHLqctd3nuniBCD9ZKLBE-ptCN48cqWaBEl2xwrYrRcn4MDgXBOCgOHeA-gXERvusbSt7jy81SmXENp1qEw1TXEGh_Cji0zRbcYnuV0HZCkaXb3jmVF4EJDF4JTTMTkW0avoShYlIIo76lekMbrC4W3k0e790NtQZKboRRcrlbEUfyD0HpUKxC1rgMYMDmTGYC48Ig' \
    -d '<testcertverificationbody>'

Example response

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

{
  "id" : "41df8f2c-8429-4ad5-a5fa-1c7b83247728",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-02-22T12:27:44.977448Z",
  "updatedAt" : "2021-02-22T12:27:44.977448Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "38423471-1fda-4b63-af10-f0c10ea7b7fd",
  "zitiId" : "c56108ca-95bb-4551-8f72-9517ee52f25f",
  "name" : "ACME CA 2021-02-22T12:27:44.977270Z",
  "endpointAttributes" : [ ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "fakePem",
  "verified" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/38423471-1fda-4b63-af10-f0c10ea7b7fd",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/41df8f2c-8429-4ad5-a5fa-1c7b83247728"
    }
  }
}

Patch Certificate Authority

PATCH /certificate-authorities/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

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

autoCaEnrollmentEnabled

Boolean

true

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

authEnabled

Boolean

true

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

ottCaEnrollmentEnabled

Boolean

true

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

endpointAttributes

Array[String]

true

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

Response fields

Path Type Optional Description

id

String

false

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

false

updatedAt

String

false

deletedBy

String

true

deletedAt

String

true

networkId

String

false

zitiId

String

false

name

String

false

io.netfoundry.core.validation.ResourceName.

endpointAttributes

Array[String]

false

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

false

verified

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

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/1ba85014-3d03-4c26-9aef-d0b40696306c' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhdmNxcHFua2xYYlg3Mlk4amlWa0NRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY3YWQ2ODM5LTM3MjUtNDE5OS1hOWVhLTY3ZDk2NjRmNTJiNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg2NCwiZXhwIjoxNjE0MDAwNDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImEyOTFmY2IxLTZkZDctNGNjOC1hMzk4LWQ4MzFmODIwYTVjNFwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.C2BFOmrtO60m7Nte5pCgdXbcCmW9HhGZw0O6Izpje_OcHesLgC0bD9eHDauWWXsj2ZRm5QsHMSGjiK5B6Br4vrkdYhN8TnR2Z8vsgo1pmG5nY-4yU1XdomsCJ-e_equLwUGtKh0PxsRUP9InrDrdJeQw_tppK5tSmIZGviM1K7BAlB5Hij6D3y-UlEcS9lDfShPxnIZ85qX9NbBdo9NMLQ2cXuydE1P0Qg9WUK5bC5LDsrDuERIwpw7EhSmxXmta1tWgA6aEgBuYdCyD9R8CpOjBN_p5kDRwDn8cJtrZTVJbyiCCkn9s5T4kiIRxAC6UO6AKhtCcm_HdTqeTCDK8kw' \
    -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" : "1ba85014-3d03-4c26-9aef-d0b40696306c",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "createdAt" : "2021-02-22T12:27:44.895808Z",
  "updatedAt" : "2021-02-22T12:27:44.895808Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "294adbe5-f298-41f7-96cf-5fc3d494df70",
  "zitiId" : "bd51c3c0-e9ab-4d77-be1f-2cc1f3164fce",
  "name" : "ACME CA 2021-02-22T12:27:44.895611Z",
  "endpointAttributes" : [ ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "certPem" : "fakePem",
  "verified" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/294adbe5-f298-41f7-96cf-5fc3d494df70",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/1ba85014-3d03-4c26-9aef-d0b40696306c"
    }
  }
}

Delete Certificate Authority

DELETE /certificate-authorities/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/a7a5f7de-e788-4e89-a05d-20d107aa967b' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1OTFhMmllZVU3aHZ2dlByRVkxUDZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVjNjAwYzE2LTc1YTgtNGI0ZS05OWNmLTIyYWRjMDJmYzA0YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTYxMzk5Njg2NSwiZXhwIjoxNjE0MDAwNDY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjcxMGNhMWYxLWIwMDItNGE3YS04OGRiLWE1NmYxMTdiMjI5ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTYxMzk5Njg2NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.bWeiDZakgiP4WebgjVwz4-sIKN9oSLsNA8TP_g37xJ8dUT1JoMRiIp-n5hSufBOsD6SOCJ9gKIF4SopHX-SSYaZb0XHByWmRG4zYkXEFEj5iXsi4f7whjgxbTVjKxNbzE1_z_hlu4YwBqqpT_whzHFjQuamYiL1qJKdIoBEtQWYXJSQujWpIftp30uqJGvQDAWLvbFjky-WEtuHzU2nYj8oQjoCq9C1kZ1Rf6zi-SVSnwHH-43u8tYTi2H99Fmxw9h6iDkxaUiIqW08mZbk_LO5Qx01qwiM1lmoK1D_7eA58TlZmf_o0AWAwh_EcgkWf3IGVqZVuud44MJfgNJ1PSA'

Example response

HTTP/1.1 200 OK