Introduction

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

Overview

HTTP verbs

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

Verb Usage

Verb	Usage
`GET`	Used to retrieve a resource
`POST`	Used to create a new resource
`PUT`	Used to update an existing resource, full updates only
`PATCH`	Used to update an existing resource, partial updates
`DELETE`	Used to delete an existing resource

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT

Used to update an existing resource, full updates only

PATCH

Used to update an existing resource, partial updates

DELETE

Used to delete an existing resource

HTTP status codes

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

Status code Usage

Status code	Usage
`200 OK`	The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.
`201 Created`	The request has been fulfilled and resulted in a new resource being created.
`202 Accepted`	The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services.
`204 No Content`	The server successfully processed the request, but is not returning any content.
`400 Bad Request`	The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
`401 Unauthorized`	The request lacks valid authentication credentials for the target resource.
`403 Forbidden`	The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource.
`404 Not Found`	The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

200 OK

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

201 Created

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

202 Accepted

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

204 No Content

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

400 Bad Request

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

401 Unauthorized

The request lacks valid authentication credentials for the target resource.

403 Forbidden

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

404 Not Found

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

Pagination

Paginated services will accept the following optional request parameters:

Table 1. Request parameters
Path	Type	Optional	Description
page	Integer	true	Page you want to retrieve, 0 indexed and defaults to 0.
size	Integer	true	Size of the page you want to retrieve, defaults to 1000.
sort	String	true	Sort a list of resources by one or more of their properties e.g. `?sort=firstname,asc&sort=lastname,desc`. The default order is `asc`.

Pagination response has following structure:

Table 2. Response structure
Path	Type	Optional	Description
content	Array[Object]	false	Actual items.
totalElements	Integer	false	Total count.
totalPages	Integer	false	Total pages with current page size.
last	Boolean	false	If this page is the last one.
numberOfElements	Integer	false	Actual size of content array (number of items).
first	Boolean	false	If this page is the first one.
sort	Object	true	Sort information object.
size	Integer	false	Requested size of the page.
number	Integer	false	Page number.
empty	booloean	false	If this page is empty.

Content Types

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

Request a Content Type

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

Request

GET /core/v2/endpoints/{{endpointId}} HTTP/1.1
Accept: application/x-yaml

Response

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

Notation MIME Type Description

Notation	MIME Type	Description
HAL+JSON (default)	application/hal+json	If you request a single resource by ID then the top level of the response will describe that resource and have `_links` to related resources. If you request a list of resources then response will have `_embedded.{{type}}List` where {{type}} is the type of resource e.g. `endpointList` and `_links` to resources that are related to the list, and each element will have `_links` to resources related to that individual resource. If there’s not at least one resource in the list, or when then the key `_embedded` will not be present.
JSON	application/json	Single resource: response is a JSON dictionary describing the resource List of resources: response is a JSON list where each element describes an individual resource. For embedded resources in non-HAL formats, the `_embedded` key is as described above but no `_links` keys will be present. Deprecation: Non-HAL formats additionally have a deprecated format for embedded resources where the embedded resources are returned as keys on the resource instead of contained within an `_embedded` key. Entries returned this way will always be returned as collections of resources regardless of whether or not the key implies a collection, e.g. `host` vs `hosts`.
YAML	application/x-yaml	Single resource: response is a YAML dictionary describing the resource List of resources: response is a YAML list where each element describes an individual resource.
CSV	text/csv	Comma-separated format where the first line is composed of column headers and subsequent lines each represent one resource.

HAL+JSON (default)

application/hal+json

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

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

JSON

application/json

Single resource: response is a JSON dictionary describing the resource

List of resources: response is a JSON list where each element describes an individual resource. For embedded resources in non-HAL formats, the _embedded key is as described above but no _links keys will be present. Deprecation: Non-HAL formats additionally have a deprecated format for embedded resources where the embedded resources are returned as keys on the resource instead of contained within an _embedded key. Entries returned this way will always be returned as collections of resources regardless of whether or not the key implies a collection, e.g. host vs hosts.

YAML

application/x-yaml

Single resource: response is a YAML dictionary describing the resource

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

CSV

text/csv

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

Request a Representation

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

Request

GET /core/v2/endpoints?networkId={{networkId}} HTTP/1.1
Accept:application/hal+json;as=create

Response

{
    "_embedded": {
        "createEndpointList": [
            {
              "name": "ACME Endpoint1",
              "enrollmentMethod": {
                "ott": true,
                "updb": null,
                "ottca": null
              },
              "attributes": [
                "#workFromAnywhere"
              ],
              "_links": {
                "network": {
                  "href": "https://gateway.production.netfoundry.io/core/v2/networks/5611d56c-cb91-4b8f-b658-9e066092ff0a",
                  "title": "ACME Network",
                  "profile": "parent"
                },
                "self": {
                  "href": "https://gateway.production.netfoundry.io/core/v2/endpoints/273a915a-50e4-4994-891e-56a33ce6449e"
                }
              }
            }
        ]
    }
}

Parameter	Value	Description
as	create	Only return the properties necessary to create the same resource.

Parameter

Value

Description

create

Only return the properties necessary to create the same resource.

Embed Child Resources

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

Request

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

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

Response

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

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

Request

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

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

Response

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

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

Notation MIME Type Embedded Format

Notation	MIME Type	Embedded Format
HAL+JSON (default)	application/hal+json	The response has key `_embedded` which will itself have keys for each type of resource. For example, `_embedded.endpoints` and `_embedded."edge-routers"` are typical when requesting an embedded list of endpoints or edge routers for a particular network or list of networks.
JSON	application/json	Each requested, embedded list will appear in a top-level key e.g. `.endpoints` and `."edge-routers"`.
YAML	application/x-yaml	Each requested, embedded list will appear in a top-level key where the resource type has been transposed from kebab-case to camel-case e.g. `edge-routers` becomes top-level key `edgeRouters`.
CSV	text/csv	Heterogeneous embedded resources can not be expressed as CSV because they would require different column headers.

HAL+JSON (default)

application/hal+json

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

JSON

application/json

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

YAML

application/x-yaml

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

CSV

text/csv

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

Select Resource Properties

When requesting an individual or list of resources you may additionally request only certain properties be included in the response by sending an alternate 'accept' header. The properties are specified as a header parameter named includeProperties, the properties requested should be separated by | (pipe).

All requested properties are returned, null values included, as long as the property exists on the requested resource.

The includeProperties parameter supports nested properties using "dot notation" with ant style patterns, examples are:

object.name would include only the name property of the object.
object.object2.name would include only the name property of object2 nested inside object.
object.* includes all direct properties of object.
object.** includes all properties of object and any nested object inside of object.

Request

This example request would return only the property’s id, zitiId, and networkId.

GET /core/v2/networks/${networkId}
Accept: application/json;includeProperties=id|zitiId|networkId

Response

{
  "id", "{{ the id of the resource }}",
  "zitiId", "{{ the ziti id of the resource }}",
  "networkId", "{{ the id of network this resource belongs to }}",
}

Request

This example request would return only the property’s id and status.

GET /core/v2/edge-routers
Accept: application/hal+json;includeProperties=id|status

Response

{
  "_embedded": {
    "edgeRouterList": [
      {{ edge router 1 properties }}
      {
        "id", "{{ the id of the resource }}",
        "status", "{{ current status of the edge routers }}",
        "_links": "{{ dictionary of related resources for this resource }}"
      },
      {{ edge router 2 properties }}
      {
        "id", "{{ the id of the resource }}",
        "status", "{{ current status of the edge routers }}",
        "_links": "{{ dictionary of related resources for this resource }}"
      }
    ]
  },
  "_links": "{{ dictionary of edge routers related resources }}",
  "page": {
    "size": 3500,
    "totalElements": 2,
    "totalPages": 1,
    "number": 0
  }
}

Request

This example request would return the name of the network and all nested properties of the networkController but nothing else. Some properties have been omitted from the example output for brevity.

GET /core/v2/networks/${networkId}?embed=networkController
Accept: application/json;includeProperties=name|networkController.*

Response

{
    "name":" {{ the name of the network }}"
    "networkController": {
      "id": "{{ the id of the network controller }}",
      "networkGroupId": "{{ the group id of which this network belongs to }}",
      "status": "{{ current status of network controller }},"
      "hostId": "{{ the host id of the network controller }}",
      "domainName": {{ the externally resolvable dns name of this network controller" }}
      ...
    }
}

Request

This example request would return the name of the network and the id and status of the networkController but nothing else.

GET /core/v2/networks/${networkId}?embed=networkController
Accept: application/json;includeProperties=id|name|networkController.id|networkController.status

Response

{
    "id": "{{ the id of the network }}",
    "name": "{{ the name of the network }}",
    "networkController": {
      "id": "{{ the id of the network controller }}",
      "status": "{{{ current status of network controller }}"
    }
}

Backup a Network

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

Request

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

Authentication

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

Cognito

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

NETFOUNDRY_API_TOKEN=$( \ (1)
  curl --user ${NETFOUNDRY_CLIENT_ID}:${NETFOUNDRY_PASSWORD} \ (2)
    --request POST ${NETFOUNDRY_OAUTH_URL} \ (3)
    --header 'content-type: application/x-www-form-urlencoded' \
    --data 'grant_type=client_credentials&scope=https%3A%2F%2Fgateway.production.netfoundry.io%2F%2Fignore-scope' | \
      jq -r .access_token (4)
)

1	creates an environment variable `NETFOUNDRY_API_TOKEN` to hold the token after successful request. The contents of this variable will be used in all subsequent requests
2	substitute the client ID and password for your API account
3	substitute the authentication URL for your API account
4	extract the access token with jq (command-line JSON processor)

Auth0

Follow this example if your authentication URL is for Auth0.

NETFOUNDRY_API_TOKEN=$( \(1)
  curl \(2)
    --request POST \
    --silent \
    --show-error \
    --header 'content-type: application/json' \
    --data '{
        "client_id":"---redacted----",       (3)
        "client_secret": "---redacted----",  (4)
        "audience":"https://gateway.production.netfoundry.io/",
        "grant_type":"client_credentials"
    }' \
    https://netfoundry-production.auth0.com/oauth/token |\
    jq -r .access_token \(5)
) && echo $NETFOUNDRY_API_TOKEN (6)

1	creates an environment variable `NETFOUNDRY_API_TOKEN` to hold the token after successful request. The contents of this variable will be used in all subsequent requests
2	this example uses the cURL command to perform the request
3	you will need to insert your actual client ID
4	you will need to insert your actual secret
5	this example uses jq to parse the response from Auth0 and extract the token
6	this line prints the extracted token; it is included for convenience / debugging purposes only

API request using access token

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

# get networks
curl https://gateway.production.netfoundry.io/core/v2/networks \ (1)
    --header "Authorization: Bearer ${NETFOUNDRY_API_TOKEN}"     (2)

1	the URL used to fetch networks (see also [Listing networks])
2	the `Authorization` header transmits the Bearer token

Resources

Network Groups

Create Network Group

POST /v2/network-groups

Authorization

This endpoint requires create action on the network-group resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path	Type	Optional
name	String	true
billingAccountId	String	true
ownerIdentityId	String	true

Path

Type

Optional

Description

name

String

true

billingAccountId

String

true

ownerIdentityId

String

true

Response fields

Path	Type	Optional
content	Object	true
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path	Optional	Description
self	true
network	true

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-groups' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJHd2NhbEc1cEV5REhRemRaRzV2aDZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY3NmJhYzIzLWUwNDQtNDhhNC1iZDczLWVhNTg4MTI4OThhMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzc5NiwiZXhwIjoxNzMxNjQxMzk2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ5ZjAzZGJkLWJkMjUtNDRmMi1hMGJhLWRiOWNjY2FhMzlkYVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzc5Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.IEN3pEESBixBuqJaUXH1adeWoKp_jlvzTCpttQZW8ddCqNhG42-mSHatQJsozDZodplUo9D0-8JMyraG5lBti_cftVcGRiYQwpzYgnhhnXhQM5or8vbnVODLS1nBzecFiptfj2G9xfYr1bqlz7BztbSQgyZuLBMLpPRJCc37rFxmtlfB3TD2it1j6p38QX5jaTK4tP2pWhYIMesKMaRFZf-1eFZ_F0MMgrljrLPMsjRkapAFvTkF5qnRbjZ0M4l8WgJahbF-GhCLTSSvxau8bM-5IBu7t-E4vEKbE28BhzTSA38MwlIC_H9ZRshBHQfgsXgvH0RlDLb_4iq_iHWMqg' \
    -d '{"name":"New NG","billingAccountId":"1bd5c24e-32d8-4784-8479-7e6cfb17d70e","ownerIdentityId":"b490bdc6-bbe3-403a-b65f-b48863b5c129"}'

Example response

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

{
  "id" : "6dca745c-6449-4d50-a3c5-6b01af01e7dc",
  "name" : "New NG",
  "shortName" : "NEWNG",
  "billingAccountId" : "1bd5c24e-32d8-4784-8479-7e6cfb17d70e",
  "ownerIdentityId" : "b490bdc6-bbe3-403a-b65f-b48863b5c129",
  "createdBy" : "676bac23-e044-48a4-bd73-ea58812898a2",
  "createdAt" : "2024-11-15T02:29:56.969345Z",
  "updatedAt" : "2024-11-15T02:29:56.969345Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/6dca745c-6449-4d50-a3c5-6b01af01e7dc",
      "title" : "New NG"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/560bdb02-d67c-4fe8-955b-df5a903c06d1",
      "title" : "Create NetworkGroup",
      "profile" : "meta"
    },
    "dns-zones" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=6dca745c-6449-4d50-a3c5-6b01af01e7dc"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=6dca745c-6449-4d50-a3c5-6b01af01e7dc"
    }
  }
}

Delete Network Group

DELETE /v2/network-groups/{id}

Authorization

This endpoint requires delete action on the network-group resource type.

Path parameters

Parameter	Type	Optional	Description
id	Object	false

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path	Type	Optional
content	Object	true
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path	Optional	Description
self	true
network	true

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-groups/d507fa69-dacb-4f41-abaf-a71495eedeca' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJCNDRoZ2xUVGJDeElmQjg3VnJXMmhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ0MmVhNzE3LTMwMDItNGE3NS1iNGU4LTc1MzNkM2UzZDVmZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzc5NSwiZXhwIjoxNzMxNjQxMzk1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI4NWI5MWNlLWU5NjItNDI3Mi1iYjUwLTIxYjdhOWUyNGJjZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzc5NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Wp_I_bq_x8Y5VLGCa9xWQXyX8MAy4WAZE5zpcUDZSmk043Cgvj5Zd03oGLXvm0oMVc6RORSObQJS4F-JVzl5yNJl-CBpMmyVVweew6lisFA-hKOETgyaA01VM6PtH1Z27HA8yrmGkvaC-KXTCvmOc7EydU34qmtzVLFG7xprc-7o3E3Vla1o6ghGnEy1dY2eT5bZ83Riz9U-1SApj-MUqQ-pRJRS5fdIHvE_tBMwL6mhXj_xq3XyK4tUrn61zYY5X3VJQYN-go7WB5_jwFxTZq2WYJVr8HJ71E62Sl30KLxH88LoyudKvVQJJHtmjPZPdt77Dxq8OIRznA0ifkZ8EA'

Example response

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

{
  "id" : "d507fa69-dacb-4f41-abaf-a71495eedeca",
  "name" : "Test-NG",
  "shortName" : "nw-101",
  "billingAccountId" : "438da28d-c4cb-412d-8f73-2f7432653a39",
  "ownerIdentityId" : "3d7378f7-274f-4217-8946-848b41b85539",
  "createdBy" : "71ded3b6-836d-4827-b52c-5269dd4d9d93",
  "createdAt" : "2024-11-15T02:29:55.329283Z",
  "updatedAt" : "2024-11-15T02:29:55.413525Z",
  "deletedBy" : "442ea717-3002-4a75-b4e8-7533d3e3d5ff",
  "deletedAt" : "2024-11-15T02:29:55.413Z",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/d507fa69-dacb-4f41-abaf-a71495eedeca",
      "title" : "Test-NG"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/f1834dad-78b6-436a-a86d-b464ef8d964a",
      "title" : "Delete NetworkGroup",
      "profile" : "meta"
    },
    "dns-zones" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=d507fa69-dacb-4f41-abaf-a71495eedeca"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=d507fa69-dacb-4f41-abaf-a71495eedeca"
    }
  }
}

Get Network Group

GET /v2/network-groups/{id}

Authorization

This endpoint requires read action on the network-group resource type.

Path parameters

Parameter	Type	Optional	Description
id	Object	false

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path	Type	Optional
content	Object	true
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path	Optional	Description
self	true
network	true

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-groups/418f7eb7-cefd-483b-8860-9ac5cd3d3b56' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJicndTN1ZoVkZPcWR3bFpEWGhGaWpBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUxZGQwYmRiLWNmZmQtNDJkNi1iOGZjLWM3MmQwZjdjMjU2OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzc5NiwiZXhwIjoxNzMxNjQxMzk2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImU4YWM2ZGZmLTQ2ZTUtNDEwNi1hNjkwLWQzYzc1MjAxZmViNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzc5Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.KrGAlzkKjEE3MJEfKV6vqQENyDGLa04WbHgditsUNNnbmiMiUQ0sdL66qxHzkEK8dDxqn0CET28kjXpCHGPawDBUpAxTestaCjwxkgrqfLTzJJsMjSfklJ_VSm_gNzPDy13nNWzaqnvCJ-ZMIFRLxEx0hlpxk21L59xT4gVG2Qql49WIi2DMV4L-8ShJJAZmbYwsVIBOeimKw8tybBYuhNfePX4pydXi6uTxULFhXxcZFl0kkXM2SCbyWXT5EGLdbKKTA95jSO2OwCS7q2PM44L2PVHGZcBJOOI619qN1i8KOOrkGm4nSypcoLZ6zMzSd8kOnle8tvyhl1RR3ooNBg'

Example response

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

{
  "id" : "418f7eb7-cefd-483b-8860-9ac5cd3d3b56",
  "name" : "Test-NG",
  "shortName" : "nw-181",
  "billingAccountId" : "189780dc-c803-45d1-a180-88438d43afb9",
  "ownerIdentityId" : "a343b9e7-abfc-4989-9f22-5ae214b19563",
  "createdBy" : "24bccdb3-02d5-45b5-be11-9aab4deabb56",
  "createdAt" : "2024-11-15T02:29:56.781636Z",
  "updatedAt" : "2024-11-15T02:29:56.781636Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/418f7eb7-cefd-483b-8860-9ac5cd3d3b56",
      "title" : "Test-NG"
    },
    "dns-zones" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=418f7eb7-cefd-483b-8860-9ac5cd3d3b56"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=418f7eb7-cefd-483b-8860-9ac5cd3d3b56"
    }
  }
}

Find Network Groups

GET /v2/network-groups

Authorization

This endpoint requires read action on the network-group resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Request fields

No request body.

Response fields

Path	Type	Optional
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true
content	Array[Object]	true
page	Object	true
page.size	Integer	true
page.totalElements	Integer	true
page.totalPages	Integer	true
page.number	Integer	true

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path	Optional	Description
self	true
network	true

Path

Optional

Description

self

true

network

true

Embedded resources

Path	Type	Optional
id	String	true
name	String	true
shortName	String	true
billingAccountId	String	true
ownerIdentityId	String	true
createdBy	String	true
createdAt	String	true
updatedAt	String	true
deletedBy	String	true
deletedAt	String	true

Path

Type

Optional

Description

String

true

name

String

true

shortName

String

true

billingAccountId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-groups' -i -X GET \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJsRXdOS2lKdGlEZTJVYTBSOHV0VWhnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMyMDBmZDExLWE3NWEtNDA0OS1iYjMxLTEwNjYzMGYxZTdlYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzc5NiwiZXhwIjoxNzMxNjQxMzk2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg0Mjk0NWY5LTI5NzQtNGFmNS04NjkxLWVmM2RmYTlkYTc2NVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzc5Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.MBC-3eTCcGCqIUXoFB0ZbybUSa2w2v7usGSLO_4YF4T9rRhMvJ_ncDfDN0F_lJpHvpkEH5JBNomWA7sbax2x1XPzMi4zdTHbkHKf8_s1cDNpNvqwbNMTtdIY_QOuLuM8D5KPfnpTwYkN1C4LWd7WKITPXmyq1ABts0IjgYIwj4gHE8pY-fofAIjDpR5GEcGovAGmnUOkdikdkB39GSSfbt9E2y9InOd-_kMaPkhT-vvhP0TnsYjUeTpDN3a6cgbvyGWAppo0-IyBWmSQZXEJpk5whbj-0VHeJq4BZGJRP7k_wtVoMWQ79c3W3LjYbL-kIsfFeLX36y9TLPyREQesYw'

Example response

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

{
  "_embedded" : {
    "networkGroupList" : [ {
      "id" : "28fa9a54-15dd-40e9-9531-928b02e6ced0",
      "name" : "Test-NG",
      "shortName" : "nw-81",
      "billingAccountId" : "6440ef23-480c-4a53-b05e-f24f3ca26856",
      "ownerIdentityId" : "9a29f788-2b8f-40f3-bda8-33c59c38a030",
      "createdBy" : "28660b96-5770-466e-8726-b31280c2f44b",
      "createdAt" : "2024-11-15T02:29:54.447336Z",
      "updatedAt" : "2024-11-15T02:29:54.800222Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/28fa9a54-15dd-40e9-9531-928b02e6ced0",
          "title" : "Test-NG"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=28fa9a54-15dd-40e9-9531-928b02e6ced0"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=28fa9a54-15dd-40e9-9531-928b02e6ced0"
        }
      }
    }, {
      "id" : "99a84a9d-52af-4cf1-88a5-e23e66727d9e",
      "name" : "host-test-network-0",
      "shortName" : "nw-21",
      "billingAccountId" : "f200a06d-1014-4ee0-9987-89e91ef26426",
      "ownerIdentityId" : "0f1b4bda-46f6-43cd-b0c5-918d3456c617",
      "createdBy" : "0f1b4bda-46f6-43cd-b0c5-918d3456c617",
      "createdAt" : "2024-11-15T02:29:44.881761Z",
      "updatedAt" : "2024-11-15T02:29:44.881761Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/99a84a9d-52af-4cf1-88a5-e23e66727d9e",
          "title" : "host-test-network-0"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=99a84a9d-52af-4cf1-88a5-e23e66727d9e"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=99a84a9d-52af-4cf1-88a5-e23e66727d9e"
        }
      }
    }, {
      "id" : "bce07cd1-8f36-44a3-b279-26426e7a53ef",
      "name" : "Cloud Engineering Networks",
      "shortName" : "CLDENG",
      "billingAccountId" : null,
      "ownerIdentityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
      "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
      "createdAt" : "2024-11-15T02:29:38.340004Z",
      "updatedAt" : "2024-11-15T02:29:38.340004Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/bce07cd1-8f36-44a3-b279-26426e7a53ef",
          "title" : "Cloud Engineering Networks"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=bce07cd1-8f36-44a3-b279-26426e7a53ef"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=bce07cd1-8f36-44a3-b279-26426e7a53ef"
        }
      }
    }, {
      "id" : "c782db63-44cc-46ab-adc2-27e2e125ff38",
      "name" : "Test-NG",
      "shortName" : "nw-161",
      "billingAccountId" : "bfbc2696-bcd5-4183-8479-5a7574f1b4d7",
      "ownerIdentityId" : "5899d9e6-3df8-48cb-9893-1772b652f2f6",
      "createdBy" : "ee1580c2-7977-45c2-b909-83c2b66a98eb",
      "createdAt" : "2024-11-15T02:29:56.114698Z",
      "updatedAt" : "2024-11-15T02:29:56.114698Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/c782db63-44cc-46ab-adc2-27e2e125ff38",
          "title" : "Test-NG"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=c782db63-44cc-46ab-adc2-27e2e125ff38"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=c782db63-44cc-46ab-adc2-27e2e125ff38"
        }
      }
    }, {
      "id" : "cb241209-8047-4afe-aca8-f851f8791736",
      "name" : "Updated NG Name-11",
      "shortName" : "nw-131",
      "billingAccountId" : "1565f363-5f27-49eb-89e8-8242042409f0",
      "ownerIdentityId" : "8e9e12d8-4875-4407-bdaf-056cdd48d376",
      "createdBy" : "87925a1f-60ff-4346-9b35-1d4cbffa3bab",
      "createdAt" : "2024-11-15T02:29:55.583401Z",
      "updatedAt" : "2024-11-15T02:29:55.664656Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/cb241209-8047-4afe-aca8-f851f8791736",
          "title" : "Updated NG Name-11"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=cb241209-8047-4afe-aca8-f851f8791736"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=cb241209-8047-4afe-aca8-f851f8791736"
        }
      }
    }, {
      "id" : "f0428619-11bd-403d-8b00-a463ff8aad84",
      "name" : "NF Support Networks",
      "shortName" : "NFSUP",
      "billingAccountId" : null,
      "ownerIdentityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
      "createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
      "createdAt" : "2024-11-15T02:29:38.301825Z",
      "updatedAt" : "2024-11-15T02:29:38.301825Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/f0428619-11bd-403d-8b00-a463ff8aad84",
          "title" : "NF Support Networks"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=f0428619-11bd-403d-8b00-a463ff8aad84"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=f0428619-11bd-403d-8b00-a463ff8aad84"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 6,
    "totalPages" : 1,
    "number" : 0
  }
}

Update Network Group

PATCH /v2/network-groups/{id}

Authorization

This endpoint requires update action on the network-group resource type.

Path parameters

Parameter	Type	Optional	Description
id	Object	false

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path	Type	Optional
name	String	true
billingAccountId	String	true
ownerIdentityId	String	true

Path

Type

Optional

Description

name

String

true

billingAccountId

String

true

ownerIdentityId

String

true

Response fields

Path	Type	Optional
content	Object	true
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path	Optional	Description
self	true
network	true

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-groups/cb241209-8047-4afe-aca8-f851f8791736' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJETTRFaVkzNldrWnVDQXh3YmZwYzRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY4ZDBmMmQyLWZhM2ItNDhlMy05NjExLTU1ZTJmNGFmZjBmMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzc5NSwiZXhwIjoxNzMxNjQxMzk1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU1YTY4NGYyLWY5MzgtNDA3MC04ZDljLTNhYzNhOGY2MzZmOFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzc5NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.olWaSq_UCT6TlZPMAH2BLhZZ-JQ1fKbmE6geH_WSXcLc1N4munT3a1Ti2UWFSRW2np6VXa1-6O5o9uKzsEcNMDAWWxpVFXcGLQRNpXb7wvjr6WBP5G0RqqKXBy3JgShUMv3wOlcX1O-SkrAfV1Djx6MS490CTGBIzeLfOrPkPs_hBCORE9mwyv3V_Ext_X4i5e04rPraM4bE_mWBDxYUDDKgbrxUoy_Dxf5U4vKG6EB4ueqR5jDMTFLL3JLd0xxTFuqVvIziXISzLxxeCNHGxKXXB_EWfdd6jg4kUMV5f7leFqe1kB_cLBiDC58zEhbu9Nk8A7RSASKgAJIjX0a4Vg' \
    -d '{"name":"Updated NG Name-11","billingAccountId":"1565f363-5f27-49eb-89e8-8242042409f0","ownerIdentityId":"8e9e12d8-4875-4407-bdaf-056cdd48d376"}'

Example response

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

{
  "id" : "cb241209-8047-4afe-aca8-f851f8791736",
  "name" : "Updated NG Name-11",
  "shortName" : "nw-131",
  "billingAccountId" : "1565f363-5f27-49eb-89e8-8242042409f0",
  "ownerIdentityId" : "8e9e12d8-4875-4407-bdaf-056cdd48d376",
  "createdBy" : "87925a1f-60ff-4346-9b35-1d4cbffa3bab",
  "createdAt" : "2024-11-15T02:29:55.583401Z",
  "updatedAt" : "2024-11-15T02:29:55.664656Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/cb241209-8047-4afe-aca8-f851f8791736",
      "title" : "Updated NG Name-11"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/5fae0e64-6ecd-44e1-981d-29ccd60f7903",
      "title" : "Update NetworkGroup",
      "profile" : "meta"
    },
    "dns-zones" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=cb241209-8047-4afe-aca8-f851f8791736"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=cb241209-8047-4afe-aca8-f851f8791736"
    }
  }
}

Networks

Find Networks

GET /v2/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
network.size	Object	true
findByName	String	true	Deprecated..
findByNetworkGroupId	Object	true	Deprecated..
region	String	true	Deprecated..
locationCode	String	true	Deprecated..
size	String	true	Deprecated..

Parameter

Type

Optional

Description

network.size

Object

true

findByName

String

true

Deprecated..

findByNetworkGroupId

Object

true

Deprecated..

region

String

true

Deprecated..

locationCode

String

true

Deprecated..

size

String

true

Deprecated..

Request fields

No request body.

Response fields

Path	Type	Optional
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true
content	Array[Object]	true
page	Object	true
page.size	Integer	true
page.totalElements	Integer	true
page.totalPages	Integer	true
page.number	Integer	true

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path	Optional	Description
self	true
networkControllers	true
edgeRouters	true
edgeRouterPolicies	true
endpoints	true
services	true
appWans	true
certificateAuthorities	true
hosts	true

Path

Optional

Description

self

true

networkControllers

true

edgeRouters

true

edgeRouterPolicies

true

endpoints

true

services

true

appWans

true

certificateAuthorities

true

hosts

true

Embedded resources

Path	Type	Optional	Description
id	String	true
ownerIdentityId	String	true
createdBy	String	true
createdAt	String	true
updatedAt	String	true
deletedBy	String	true
deletedAt	String	true
name	String	true
networkGroupId	String	true
size	String	true	Deprecated..
productVersion	Object	true
region	String	true	Deprecated..
status	String	true	Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED, OFFLINE].
publicCertEnabled	Boolean	true
haEnabled	Boolean	true
dnsZoneId	String	true
o365BreakoutCategory	String	true	Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE].
networkController	Object	true	Deprecated..
networkController.id	String	true
networkController.ownerIdentityId	String	true
networkController.networkId	String	true
networkController.domainName	String	true
networkController.alternateDomainName	String	true
networkController.port	Integer	true
networkController.name	String	true
networkController.productVersion	Object	true
networkController.hostId	String	true
networkController.status	String	true	Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED, OFFLINE].
networkController.createdAt	String	true
networkController.updatedAt	String	true
networkController.deletedAt	String	true
networkController.createdBy	String	true
networkController.deletedBy	String	true
networkController.softwareDeploymentStateId	String	true
networkController.haPrimaryNode	Boolean	true
networkController.publicDomainName	String	true
networkController.managementZitiIdentity	Object	true
networkController.managementZitiIdentity.id	String	true
networkController.managementZitiIdentity.name	String	true
networkController.managementZitiIdentity.type	Object	true
networkController.managementZitiIdentity.type.id	String	true
networkController.managementZitiIdentity.type.name	String	true
networkController.managementZitiIdentity.typeId	String	true
networkController.managementZitiIdentity.externalId	String	true
networkController.managementZitiIdentity.authPolicyId	String	true
networkController.managementZitiIdentity.authenticators	Object	true
networkController.managementZitiIdentity.authenticators.updb	Object	true
networkController.managementZitiIdentity.authenticators.updb.username	String	true
networkController.managementZitiIdentity.authenticators.cert	Object	true
networkController.managementZitiIdentity.authenticators.cert.fingerprint	String	true
networkController.managementZitiIdentity.enrollment	Object	true
networkController.managementZitiIdentity.enrollment.ott	Object	true
networkController.managementZitiIdentity.enrollment.ott.id	String	true
networkController.managementZitiIdentity.enrollment.ott.token	String	true
networkController.managementZitiIdentity.enrollment.ott.jwt	String	true
networkController.managementZitiIdentity.enrollment.ott.expiresAt	String	true
networkController.managementZitiIdentity.enrollment.ottca	Object	true
networkController.managementZitiIdentity.enrollment.ottca.id	String	true
networkController.managementZitiIdentity.enrollment.ottca.caId	String	true
networkController.managementZitiIdentity.enrollment.ottca.token	String	true
networkController.managementZitiIdentity.enrollment.ottca.jwt	String	true
networkController.managementZitiIdentity.enrollment.ottca.expiresAt	String	true
networkController.managementZitiIdentity.enrollment.updb	Object	true
networkController.managementZitiIdentity.enrollment.updb.id	String	true
networkController.managementZitiIdentity.enrollment.updb.token	String	true
networkController.managementZitiIdentity.enrollment.updb.jwt	String	true
networkController.managementZitiIdentity.enrollment.updb.expiresAt	String	true
networkController.managementZitiIdentity.disabled	Boolean	true
networkController.managementZitiIdentity.disabledAt	String	true
networkController.managementZitiIdentity.disabledUntil	String	true
networkController.managementZitiIdentity.envInfo	Object	true
networkController.managementZitiIdentity.envInfo.arch	String	true
networkController.managementZitiIdentity.envInfo.domain	String	true
networkController.managementZitiIdentity.envInfo.hostname	String	true
networkController.managementZitiIdentity.envInfo.os	String	true
networkController.managementZitiIdentity.envInfo.osRelease	String	true
networkController.managementZitiIdentity.envInfo.osVersion	String	true
networkController.managementZitiIdentity.sdkInfo	Object	true
networkController.managementZitiIdentity.sdkInfo.appId	String	true
networkController.managementZitiIdentity.sdkInfo.appVersion	String	true
networkController.managementZitiIdentity.sdkInfo.branch	String	true
networkController.managementZitiIdentity.sdkInfo.revision	String	true
networkController.managementZitiIdentity.sdkInfo.type	String	true
networkController.managementZitiIdentity.sdkInfo.version	String	true
networkController.managementZitiIdentity.hasApiSession	Boolean	true
networkController.managementZitiIdentity.hasEdgeRouterConnection	Boolean	true
networkController.managementZitiIdentity.roleAttributes	Array[String]	true
networkController.managementZitiIdentity.tags	Map	true
networkController.managementZitiIdentity.appData	Map	true
networkController.managementZitiIdentity.createdAt	String	true
networkController.managementZitiIdentity.updatedAt	String	true
networkController.managementZitiIdentity.mfaEnabled	Boolean	true
networkController.managementZitiIdentity.admin	Boolean	true
networkController.managementZitiIdentity.defaultAdmin	Boolean	true

Path

Type

Optional

Description

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

name

String

true

networkGroupId

String

true

size

String

true

Deprecated..

productVersion

Object

true

region

String

true

Deprecated..

status

String

true

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

publicCertEnabled

Boolean

true

haEnabled

Boolean

true

dnsZoneId

String

true

o365BreakoutCategory

String

true

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

networkController

Object

true

Deprecated..

networkController.id

String

true

networkController.ownerIdentityId

String

true

networkController.networkId

String

true

networkController.domainName

String

true

networkController.alternateDomainName

String

true

networkController.port

Integer

true

networkController.name

String

true

networkController.productVersion

Object

true

networkController.hostId

String

true

networkController.status

String

true

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

networkController.createdAt

String

true

networkController.updatedAt

String

true

networkController.deletedAt

String

true

networkController.createdBy

String

true

networkController.deletedBy

String

true

networkController.softwareDeploymentStateId

String

true

networkController.haPrimaryNode

Boolean

true

networkController.publicDomainName

String

true

networkController.managementZitiIdentity

Object

true

networkController.managementZitiIdentity.id

String

true

networkController.managementZitiIdentity.name

String

true

networkController.managementZitiIdentity.type

Object

true

networkController.managementZitiIdentity.type.id

String

true

networkController.managementZitiIdentity.type.name

String

true

networkController.managementZitiIdentity.typeId

String

true

networkController.managementZitiIdentity.externalId

String

true

networkController.managementZitiIdentity.authPolicyId

String

true

networkController.managementZitiIdentity.authenticators

Object

true

networkController.managementZitiIdentity.authenticators.updb

Object

true

networkController.managementZitiIdentity.authenticators.updb.username

String

true

networkController.managementZitiIdentity.authenticators.cert

Object

true

networkController.managementZitiIdentity.authenticators.cert.fingerprint

String

true

networkController.managementZitiIdentity.enrollment

Object

true

networkController.managementZitiIdentity.enrollment.ott

Object

true

networkController.managementZitiIdentity.enrollment.ott.id

String

true

networkController.managementZitiIdentity.enrollment.ott.token

String

true

networkController.managementZitiIdentity.enrollment.ott.jwt

String

true

networkController.managementZitiIdentity.enrollment.ott.expiresAt

String

true

networkController.managementZitiIdentity.enrollment.ottca

Object

true

networkController.managementZitiIdentity.enrollment.ottca.id

String

true

networkController.managementZitiIdentity.enrollment.ottca.caId

String

true

networkController.managementZitiIdentity.enrollment.ottca.token

String

true

networkController.managementZitiIdentity.enrollment.ottca.jwt

String

true

networkController.managementZitiIdentity.enrollment.ottca.expiresAt

String

true

networkController.managementZitiIdentity.enrollment.updb

Object

true

networkController.managementZitiIdentity.enrollment.updb.id

String

true

networkController.managementZitiIdentity.enrollment.updb.token

String

true

networkController.managementZitiIdentity.enrollment.updb.jwt

String

true

networkController.managementZitiIdentity.enrollment.updb.expiresAt

String

true

networkController.managementZitiIdentity.disabled

Boolean

true

networkController.managementZitiIdentity.disabledAt

String

true

networkController.managementZitiIdentity.disabledUntil

String

true

networkController.managementZitiIdentity.envInfo

Object

true

networkController.managementZitiIdentity.envInfo.arch

String

true

networkController.managementZitiIdentity.envInfo.domain

String

true

networkController.managementZitiIdentity.envInfo.hostname

String

true

networkController.managementZitiIdentity.envInfo.os

String

true

networkController.managementZitiIdentity.envInfo.osRelease

String

true

networkController.managementZitiIdentity.envInfo.osVersion

String

true

networkController.managementZitiIdentity.sdkInfo

Object

true

networkController.managementZitiIdentity.sdkInfo.appId

String

true

networkController.managementZitiIdentity.sdkInfo.appVersion

String

true

networkController.managementZitiIdentity.sdkInfo.branch

String

true

networkController.managementZitiIdentity.sdkInfo.revision

String

true

networkController.managementZitiIdentity.sdkInfo.type

String

true

networkController.managementZitiIdentity.sdkInfo.version

String

true

networkController.managementZitiIdentity.hasApiSession

Boolean

true

networkController.managementZitiIdentity.hasEdgeRouterConnection

Boolean

true

networkController.managementZitiIdentity.roleAttributes

Array[String]

true

networkController.managementZitiIdentity.tags

Map

true

networkController.managementZitiIdentity.appData

Map

true

networkController.managementZitiIdentity.createdAt

String

true

networkController.managementZitiIdentity.updatedAt

String

true

networkController.managementZitiIdentity.mfaEnabled

Boolean

true

networkController.managementZitiIdentity.admin

Boolean

true

networkController.managementZitiIdentity.defaultAdmin

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJsQnUtREhldGNDT0dHbVpqSW9xd3F3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI4YTdkNWM2LTk4MmEtNDI4Mi05Y2FlLWYwY2M5ODg1NjJkNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk1NywiZXhwIjoxNzMxNjQxNTU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk2NTRiZDI3LTU3YmEtNDVmMy05ZjM4LWVkMzcxOGZmZjMzY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk1N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.JJyyObVv_Sv8Bl1MENSjh_Harjr4xBw4p3mbfK4i98hxTm_xB8mslNgp0CxOg84DdXKTx97KWu0ZyCdTBkDbUGdrzYIddF2zFkN1BIO9PMzIVrp44ojef8Lq2xnIQIZEL8zdHExg3N1B4dVeHQGoSBOC7MmfhcmQ7eqxHFxbIc84Hgx68X_XJ-8_jGb5diGmao5eWzDqwP-pOl9_L3H2suY7GxIibDkl__8srRXeUzRgFLftdnL7TxjXMtq0N5Lp-fFnLNOnwa2eWE7HT9xT_WHfsoXuDOsWo9MFjUAQEAVqaotTECvVsk8EYk5LFKagvOHDvzMZZBSpxZXb6m0y7A'

Example response

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

{
  "_embedded" : {
    "networkList" : [ {
      "id" : "00448562-b192-4ec9-b95f-3a459399bbac",
      "ownerIdentityId" : "97cd3af9-6040-4d14-8f7d-ebda0ceb1910",
      "createdBy" : "97cd3af9-6040-4d14-8f7d-ebda0ceb1910",
      "createdAt" : "2024-11-15T02:32:35.898264Z",
      "updatedAt" : "2024-11-15T02:32:35.898918Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-1959",
      "networkGroupId" : "ac062f5a-c959-4083-bee6-d7b06487e25a",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "f4bc8773-0103-4dc0-8dc0-dcae6dbea440",
        "ownerIdentityId" : "97cd3af9-6040-4d14-8f7d-ebda0ceb1910",
        "networkId" : "00448562-b192-4ec9-b95f-3a459399bbac",
        "domainName" : "f4bc8773-0103-4dc0-8dc0-dcae6dbea440.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-1959-nc",
        "productVersion" : "7.4.5",
        "hostId" : "c1106939-fbd7-4705-a45b-460e78292b64",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:35.900140Z",
        "updatedAt" : "2024-11-15T02:32:35.905478Z",
        "deletedAt" : null,
        "createdBy" : "97cd3af9-6040-4d14-8f7d-ebda0ceb1910",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "9616e479-e4f5-4ebe-a79d-5ae0771addfd",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/ac062f5a-c959-4083-bee6-d7b06487e25a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/00448562-b192-4ec9-b95f-3a459399bbac",
          "title" : "network-1959"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=00448562-b192-4ec9-b95f-3a459399bbac"
        }
      }
    }, {
      "id" : "0bec77d6-46b4-4986-a7ae-f49260a08f13",
      "ownerIdentityId" : "6b9428b0-6f33-4789-9c6f-1a2d0a3344ec",
      "createdBy" : "6b9428b0-6f33-4789-9c6f-1a2d0a3344ec",
      "createdAt" : "2024-11-15T02:32:36.199734Z",
      "updatedAt" : "2024-11-15T02:32:36.200852Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-1969",
      "networkGroupId" : "328f914b-7bbd-49dc-9e1e-e21112ca2f12",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "7221ffc1-0a35-456b-b0b8-f3c83d92182f",
        "ownerIdentityId" : "6b9428b0-6f33-4789-9c6f-1a2d0a3344ec",
        "networkId" : "0bec77d6-46b4-4986-a7ae-f49260a08f13",
        "domainName" : "7221ffc1-0a35-456b-b0b8-f3c83d92182f.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-1969-nc",
        "productVersion" : "7.4.5",
        "hostId" : "133caee1-6121-4221-bef8-31c36caac66a",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:36.202534Z",
        "updatedAt" : "2024-11-15T02:32:36.206966Z",
        "deletedAt" : null,
        "createdBy" : "6b9428b0-6f33-4789-9c6f-1a2d0a3344ec",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "8e6709d4-ce1c-4d9c-a96c-3d4262db30e0",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/328f914b-7bbd-49dc-9e1e-e21112ca2f12",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0bec77d6-46b4-4986-a7ae-f49260a08f13",
          "title" : "network-1969"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=0bec77d6-46b4-4986-a7ae-f49260a08f13"
        }
      }
    }, {
      "id" : "0dae869c-d91f-4c02-82f6-ff483672d6a2",
      "ownerIdentityId" : "211a7b11-c178-4db6-9bd4-e928acd13f67",
      "createdBy" : "211a7b11-c178-4db6-9bd4-e928acd13f67",
      "createdAt" : "2024-11-15T02:32:36.881672Z",
      "updatedAt" : "2024-11-15T02:32:36.882169Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-1974",
      "networkGroupId" : "90c28f29-959b-4d18-93dd-bf5e74b4ebd2",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "5af5cb5c-d339-41ac-a3f2-07e50da55a75",
        "ownerIdentityId" : "211a7b11-c178-4db6-9bd4-e928acd13f67",
        "networkId" : "0dae869c-d91f-4c02-82f6-ff483672d6a2",
        "domainName" : "5af5cb5c-d339-41ac-a3f2-07e50da55a75.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-1974-nc",
        "productVersion" : "7.4.5",
        "hostId" : "dcb707b5-a2b7-4e80-ae8f-636e13e0be6c",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:36.883652Z",
        "updatedAt" : "2024-11-15T02:32:36.886141Z",
        "deletedAt" : null,
        "createdBy" : "211a7b11-c178-4db6-9bd4-e928acd13f67",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "d23a693e-a13f-480a-8720-c5982f945fa3",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/90c28f29-959b-4d18-93dd-bf5e74b4ebd2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0dae869c-d91f-4c02-82f6-ff483672d6a2",
          "title" : "network-1974"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=0dae869c-d91f-4c02-82f6-ff483672d6a2"
        }
      }
    }, {
      "id" : "0ff876cd-fd57-4c4a-af55-9b01760020e4",
      "ownerIdentityId" : "333aa81d-95ae-47a1-8dba-f63dbde40a7d",
      "createdBy" : "333aa81d-95ae-47a1-8dba-f63dbde40a7d",
      "createdAt" : "2024-11-15T02:32:36.909915Z",
      "updatedAt" : "2024-11-15T02:32:37.076713Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Create Test Network",
      "networkGroupId" : "90c28f29-959b-4d18-93dd-bf5e74b4ebd2",
      "size" : "small",
      "productVersion" : "7.3.18",
      "region" : "none",
      "status" : "PROVISIONED",
      "publicCertEnabled" : false,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "0d85c9a2-5d0e-47a1-a90a-a9fad498bd9b",
        "ownerIdentityId" : "333aa81d-95ae-47a1-8dba-f63dbde40a7d",
        "networkId" : "0ff876cd-fd57-4c4a-af55-9b01760020e4",
        "domainName" : "9178a60a-5d42-4bb9-9c74-700d2d924d0a.sandbox.netfoundry.io",
        "alternateDomainName" : null,
        "port" : 8443,
        "name" : "Create Test Network-NC",
        "productVersion" : "7.3.18",
        "hostId" : "6e33238b-a8d0-4ec3-8f1f-453491644279",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:36.930486Z",
        "updatedAt" : "2024-11-15T02:32:37.025804Z",
        "deletedAt" : null,
        "createdBy" : "333aa81d-95ae-47a1-8dba-f63dbde40a7d",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "cd3d78e2-5d29-4c0d-bca1-147db5ede615",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/90c28f29-959b-4d18-93dd-bf5e74b4ebd2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0ff876cd-fd57-4c4a-af55-9b01760020e4",
          "title" : "Create Test Network"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=0ff876cd-fd57-4c4a-af55-9b01760020e4"
        }
      }
    }, {
      "id" : "2f8f5874-d080-4e93-bceb-6cc25ebd6f1c",
      "ownerIdentityId" : "938bfbdf-d61c-4d9f-a4e3-330f87d8252b",
      "createdBy" : "938bfbdf-d61c-4d9f-a4e3-330f87d8252b",
      "createdAt" : "2024-11-15T02:32:37.125759Z",
      "updatedAt" : "2024-11-15T02:32:37.126437Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-1979",
      "networkGroupId" : "84afb1c7-0a4d-439b-a533-9d057da9a481",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "d2fc95eb-218f-4e16-af00-9279f970a8f8",
        "ownerIdentityId" : "938bfbdf-d61c-4d9f-a4e3-330f87d8252b",
        "networkId" : "2f8f5874-d080-4e93-bceb-6cc25ebd6f1c",
        "domainName" : "d2fc95eb-218f-4e16-af00-9279f970a8f8.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-1979-nc",
        "productVersion" : "7.4.5",
        "hostId" : "2a3c5bb2-2bb0-41a6-a168-508d62864943",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:37.128143Z",
        "updatedAt" : "2024-11-15T02:32:37.130996Z",
        "deletedAt" : null,
        "createdBy" : "938bfbdf-d61c-4d9f-a4e3-330f87d8252b",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "4e604954-54c7-450c-bbb6-ff31784c2dad",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/84afb1c7-0a4d-439b-a533-9d057da9a481",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2f8f5874-d080-4e93-bceb-6cc25ebd6f1c",
          "title" : "network-1979"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=2f8f5874-d080-4e93-bceb-6cc25ebd6f1c"
        }
      }
    }, {
      "id" : "774e598e-8566-40d9-b6c4-8b052d0a861f",
      "ownerIdentityId" : "bb819b3d-0e51-4e27-80b8-48cff2da9a18",
      "createdBy" : "bb819b3d-0e51-4e27-80b8-48cff2da9a18",
      "createdAt" : "2024-11-15T02:32:34.363109Z",
      "updatedAt" : "2024-11-15T02:32:34.363733Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-1949",
      "networkGroupId" : "14ef58c0-9bff-4347-8628-574144bb6906",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "336b70dc-53ef-41ec-b92d-bf12ef047616",
        "ownerIdentityId" : "bb819b3d-0e51-4e27-80b8-48cff2da9a18",
        "networkId" : "774e598e-8566-40d9-b6c4-8b052d0a861f",
        "domainName" : "336b70dc-53ef-41ec-b92d-bf12ef047616.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-1949-nc",
        "productVersion" : "7.4.5",
        "hostId" : "22607057-7750-4f64-8904-312cfd2821c3",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:34.364974Z",
        "updatedAt" : "2024-11-15T02:32:34.367968Z",
        "deletedAt" : null,
        "createdBy" : "bb819b3d-0e51-4e27-80b8-48cff2da9a18",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "e4a37fc6-44f8-463a-a75c-c53ff99f8a5c",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/14ef58c0-9bff-4347-8628-574144bb6906",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/774e598e-8566-40d9-b6c4-8b052d0a861f",
          "title" : "network-1949"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=774e598e-8566-40d9-b6c4-8b052d0a861f"
        }
      }
    }, {
      "id" : "7d3515f1-3145-4438-96a0-5362b9b1f07b",
      "ownerIdentityId" : "dab6911c-2e90-4272-84c8-613522fe1064",
      "createdBy" : "dab6911c-2e90-4272-84c8-613522fe1064",
      "createdAt" : "2024-11-15T02:32:37.150417Z",
      "updatedAt" : "2024-11-15T02:32:37.263083Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "resume-test",
      "networkGroupId" : "19941878-eaab-4d56-8b0e-dfe148fdd180",
      "size" : "small",
      "productVersion" : "7.3.37",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : false,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "aa1810bb-0b28-42c1-909c-148e41f6388e",
        "ownerIdentityId" : "dab6911c-2e90-4272-84c8-613522fe1064",
        "networkId" : "7d3515f1-3145-4438-96a0-5362b9b1f07b",
        "domainName" : "new-domain.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "resume-test-nc",
        "productVersion" : "7.3.37",
        "hostId" : "c03f90c6-57d9-4bc3-8611-ebf9dfb420a0",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:37.158542Z",
        "updatedAt" : "2024-11-15T02:32:37.261963Z",
        "deletedAt" : null,
        "createdBy" : "dab6911c-2e90-4272-84c8-613522fe1064",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "b428dd90-99d8-4675-8e76-aedf2e88a194",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/19941878-eaab-4d56-8b0e-dfe148fdd180",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/7d3515f1-3145-4438-96a0-5362b9b1f07b",
          "title" : "resume-test"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=7d3515f1-3145-4438-96a0-5362b9b1f07b"
        }
      }
    }, {
      "id" : "81f3ea0e-6c99-4934-a459-470753f6cc8c",
      "ownerIdentityId" : "f3b74909-a959-4ea6-82ca-380ee78a02c2",
      "createdBy" : "f3b74909-a959-4ea6-82ca-380ee78a02c2",
      "createdAt" : "2024-11-15T02:32:36.294088Z",
      "updatedAt" : "2024-11-15T02:32:36.673335Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Upload Test Network",
      "networkGroupId" : "328f914b-7bbd-49dc-9e1e-e21112ca2f12",
      "size" : "small",
      "productVersion" : "7.3.18",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : false,
      "haEnabled" : true,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "663c0c3f-c13b-4613-bbae-8848c0c300ba",
        "ownerIdentityId" : "f3b74909-a959-4ea6-82ca-380ee78a02c2",
        "networkId" : "81f3ea0e-6c99-4934-a459-470753f6cc8c",
        "domainName" : "e29a6f63-77e0-490e-ada5-1401b9c30b56.sandbox.netfoundry.io",
        "alternateDomainName" : null,
        "port" : 8443,
        "name" : "Upload Test Network-NC",
        "productVersion" : "7.3.18",
        "hostId" : "074631a7-b8ce-4dee-9409-684a8725a3f2",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:36.303614Z",
        "updatedAt" : "2024-11-15T02:32:36.425436Z",
        "deletedAt" : null,
        "createdBy" : "f3b74909-a959-4ea6-82ca-380ee78a02c2",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "b24dcea7-a609-4bcd-a99b-897cc5759574",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/328f914b-7bbd-49dc-9e1e-e21112ca2f12",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/81f3ea0e-6c99-4934-a459-470753f6cc8c",
          "title" : "Upload Test Network"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=81f3ea0e-6c99-4934-a459-470753f6cc8c"
        }
      }
    }, {
      "id" : "9bb25b7d-b759-4291-84b5-12aa43100a96",
      "ownerIdentityId" : "d34ecaa3-f0b4-4940-b06f-0010be97aa2a",
      "createdBy" : "d34ecaa3-f0b4-4940-b06f-0010be97aa2a",
      "createdAt" : "2024-11-15T02:32:37.402385Z",
      "updatedAt" : "2024-11-15T02:32:37.403321Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-1995",
      "networkGroupId" : "b2ed6cdf-c6b5-4cf6-bfe3-e8e4ef118515",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "d214f4d7-ef0e-4bdb-b6e1-4a30cf566b99",
        "ownerIdentityId" : "d34ecaa3-f0b4-4940-b06f-0010be97aa2a",
        "networkId" : "9bb25b7d-b759-4291-84b5-12aa43100a96",
        "domainName" : "d214f4d7-ef0e-4bdb-b6e1-4a30cf566b99.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-1995-nc",
        "productVersion" : "7.4.5",
        "hostId" : "0894daf8-5ba6-4bf5-bbf1-5480325d0e4d",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:37.405175Z",
        "updatedAt" : "2024-11-15T02:32:37.409154Z",
        "deletedAt" : null,
        "createdBy" : "d34ecaa3-f0b4-4940-b06f-0010be97aa2a",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "800d1cb6-1ed6-4995-8c9b-fbcba1d5959c",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/b2ed6cdf-c6b5-4cf6-bfe3-e8e4ef118515",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9bb25b7d-b759-4291-84b5-12aa43100a96",
          "title" : "network-1995"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=9bb25b7d-b759-4291-84b5-12aa43100a96"
        }
      }
    }, {
      "id" : "b58b9611-e949-4a39-89f3-f529ac989bca",
      "ownerIdentityId" : "a7d2da98-34fc-4949-abb0-f8c46f213e91",
      "createdBy" : "a7d2da98-34fc-4949-abb0-f8c46f213e91",
      "createdAt" : "2024-11-15T02:32:36.004971Z",
      "updatedAt" : "2024-11-15T02:32:36.005597Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-1964",
      "networkGroupId" : "1c1227fe-ae9f-464b-b7e4-1c24f68afdb2",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "878f8fa5-f192-4973-9a43-f13dd092b172",
        "ownerIdentityId" : "a7d2da98-34fc-4949-abb0-f8c46f213e91",
        "networkId" : "b58b9611-e949-4a39-89f3-f529ac989bca",
        "domainName" : "878f8fa5-f192-4973-9a43-f13dd092b172.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-1964-nc",
        "productVersion" : "7.4.5",
        "hostId" : "b4c0cf2b-016b-4c1a-be57-5e7344391702",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:36.007890Z",
        "updatedAt" : "2024-11-15T02:32:36.010851Z",
        "deletedAt" : null,
        "createdBy" : "a7d2da98-34fc-4949-abb0-f8c46f213e91",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "31a9a562-870f-42d6-9653-40d6d2ec08fb",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/1c1227fe-ae9f-464b-b7e4-1c24f68afdb2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b58b9611-e949-4a39-89f3-f529ac989bca",
          "title" : "network-1964"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
        }
      }
    }, {
      "id" : "be4f94a8-0cf8-44f7-a8bb-dab3c13a8614",
      "ownerIdentityId" : "9ebc30aa-d54a-43cb-898d-0379d7cbfaf2",
      "createdBy" : "9ebc30aa-d54a-43cb-898d-0379d7cbfaf2",
      "createdAt" : "2024-11-15T02:32:35.563065Z",
      "updatedAt" : "2024-11-15T02:32:35.564293Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-1954",
      "networkGroupId" : "5419253d-6e99-4719-a064-17dc5ebb3a3f",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "c52ef4de-e5b5-4011-b493-f63f13ba6a1a",
        "ownerIdentityId" : "9ebc30aa-d54a-43cb-898d-0379d7cbfaf2",
        "networkId" : "be4f94a8-0cf8-44f7-a8bb-dab3c13a8614",
        "domainName" : "c52ef4de-e5b5-4011-b493-f63f13ba6a1a.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-1954-nc",
        "productVersion" : "7.4.5",
        "hostId" : "24e7374e-43e1-4287-8270-aa2d62e3b69f",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:35.568696Z",
        "updatedAt" : "2024-11-15T02:32:35.573915Z",
        "deletedAt" : null,
        "createdBy" : "9ebc30aa-d54a-43cb-898d-0379d7cbfaf2",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "4bae256c-20f0-4b31-b766-d6d8282bf03e",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/5419253d-6e99-4719-a064-17dc5ebb3a3f",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/be4f94a8-0cf8-44f7-a8bb-dab3c13a8614",
          "title" : "network-1954"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=be4f94a8-0cf8-44f7-a8bb-dab3c13a8614"
        }
      }
    }, {
      "id" : "c02bdac8-2890-4a17-b9d4-51b465226c31",
      "ownerIdentityId" : "ea7da364-f245-4e74-b3e8-85d967c796cc",
      "createdBy" : "ea7da364-f245-4e74-b3e8-85d967c796cc",
      "createdAt" : "2024-11-15T02:32:35.670501Z",
      "updatedAt" : "2024-11-15T02:32:35.852578Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Test Network Yaml",
      "networkGroupId" : "5419253d-6e99-4719-a064-17dc5ebb3a3f",
      "size" : "small",
      "productVersion" : "7.3.18",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : false,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "32216161-782e-4b56-83e9-04e98b2d5a7e",
        "ownerIdentityId" : "ea7da364-f245-4e74-b3e8-85d967c796cc",
        "networkId" : "c02bdac8-2890-4a17-b9d4-51b465226c31",
        "domainName" : "051bb5e7-6c2b-4ada-a90e-308578c12d2d.sandbox.netfoundry.io",
        "alternateDomainName" : null,
        "port" : 8443,
        "name" : "Test Network Yaml-NC",
        "productVersion" : "7.3.18",
        "hostId" : "a4004089-dae4-49cf-a793-bd9e2b074d46",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:35.696126Z",
        "updatedAt" : "2024-11-15T02:32:35.808699Z",
        "deletedAt" : null,
        "createdBy" : "ea7da364-f245-4e74-b3e8-85d967c796cc",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "1674c6b8-3960-4b2c-8baa-adc0eb9242de",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/5419253d-6e99-4719-a064-17dc5ebb3a3f",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c02bdac8-2890-4a17-b9d4-51b465226c31",
          "title" : "Test Network Yaml"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=c02bdac8-2890-4a17-b9d4-51b465226c31"
        }
      }
    }, {
      "id" : "faeb133b-b8b7-4adf-b178-88cf12544d0d",
      "ownerIdentityId" : "a4572c3d-ea01-49db-a3d8-32f34a423e34",
      "createdBy" : "a4572c3d-ea01-49db-a3d8-32f34a423e34",
      "createdAt" : "2024-11-15T02:32:33.677597Z",
      "updatedAt" : "2024-11-15T02:32:33.678798Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-1933",
      "networkGroupId" : "0c248101-e088-454d-9618-b7ff2dfd9adb",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "36d65f67-91c7-49b8-93dd-4a3852c50b95",
        "ownerIdentityId" : "a4572c3d-ea01-49db-a3d8-32f34a423e34",
        "networkId" : "faeb133b-b8b7-4adf-b178-88cf12544d0d",
        "domainName" : "36d65f67-91c7-49b8-93dd-4a3852c50b95.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-1933-nc",
        "productVersion" : "7.4.5",
        "hostId" : "e66781fd-d308-4292-915e-4f37dfd0a25d",
        "status" : "PROVISIONED",
        "createdAt" : "2024-11-15T02:32:33.680188Z",
        "updatedAt" : "2024-11-15T02:32:33.689718Z",
        "deletedAt" : null,
        "createdBy" : "a4572c3d-ea01-49db-a3d8-32f34a423e34",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "30ab9c61-6b67-4a27-90ba-c0cbb1f12ce2",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/0c248101-e088-454d-9618-b7ff2dfd9adb",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/faeb133b-b8b7-4adf-b178-88cf12544d0d",
          "title" : "network-1933"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=faeb133b-b8b7-4adf-b178-88cf12544d0d"
        }
      }
    }, {
      "id" : "ffccfaff-b82b-49cb-bb66-6193eb827cee",
      "ownerIdentityId" : "5495ab87-1743-4c9b-b100-05c538406056",
      "createdBy" : "5495ab87-1743-4c9b-b100-05c538406056",
      "createdAt" : "2024-11-15T02:32:34.136862Z",
      "updatedAt" : "2024-11-15T02:32:34.259780Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "suspend-test",
      "networkGroupId" : "018f7f59-4d18-49d3-aae7-5c187ad5048c",
      "size" : "small",
      "productVersion" : "7.3.37",
      "region" : "us-east-1",
      "status" : "SUSPENDED",
      "publicCertEnabled" : false,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "382a59aa-f0e9-4643-9978-69196a50f723",
        "ownerIdentityId" : "5495ab87-1743-4c9b-b100-05c538406056",
        "networkId" : "ffccfaff-b82b-49cb-bb66-6193eb827cee",
        "domainName" : "382a59aa-f0e9-4643-9978-69196a50f723.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "suspend-test-nc",
        "productVersion" : "7.3.37",
        "hostId" : "676c85ec-24b3-4c6b-b899-4154d52d5a7f",
        "status" : "SUSPENDED",
        "createdAt" : "2024-11-15T02:32:34.138557Z",
        "updatedAt" : "2024-11-15T02:32:34.256602Z",
        "deletedAt" : null,
        "createdBy" : "5495ab87-1743-4c9b-b100-05c538406056",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "8bb2c0a4-49e2-4691-b76f-47e1548b183a",
        "haPrimaryNode" : true
      },
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/018f7f59-4d18-49d3-aae7-5c187ad5048c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ffccfaff-b82b-49cb-bb66-6193eb827cee",
          "title" : "suspend-test"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=ffccfaff-b82b-49cb-bb66-6193eb827cee"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 14,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Network

GET /v2/networks/{id}

Authorization

This endpoint requires read action on the network resource type.

Path parameters

Parameter	Type	Optional	Description
id	Object	false

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path	Type	Optional
content	Object	true
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path	Optional	Description
self	true
networkControllers	true
edgeRouters	true
edgeRouterPolicies	true
endpoints	true
services	true
appWans	true
certificateAuthorities	true
hosts	true

Path

Optional

Description

self

true

networkControllers

true

edgeRouters

true

edgeRouterPolicies

true

endpoints

true

services

true

appWans

true

certificateAuthorities

true

hosts

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks/b58b9611-e949-4a39-89f3-f529ac989bca' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJKVExHQmIxYWVmb0k4U04xS0NYQ0xBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk5ZTA4NTIzLWFmYTYtNDRlMC1iMTAwLWJiMDkxYjkyNTdjMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk1NiwiZXhwIjoxNzMxNjQxNTU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjNmNjIwYjE1LTVmNzAtNGE3Zi1iMmY1LWU2YjQ4ZmZhYTNiZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk1Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.r2_dp1AW5cUfsK5u-BxdNifwY0RBdnGiq_4GDgTEZTkNk23W98mb1Wi1HVvL4I7tcQuusbhefmQ_aHebvX_Sl93PLjiWokiPS0RyfrFS0QRAxiLpQ6Jx_ukW1Zae3PR5tF5eXUEbTpbj5yl3FPxxaVdS4TlfnGvwhS1uuj0veaWE9Aagv0WlYHY3nmJroNevw-cT9ROMIxR7Zo5lQ3NfU4EbbLRdnptdXwzYZI4qVUIrS4_rcIH-ywAmx0j5tNyBO1gFftB6-J4IwnkUWxt4CP1L6q0d3xY7aCCu_g57RqfJdNhM6h2T_js23xUwfPG3GowGhEcEm-3BvpMj9UCDDA'

Example response

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

{
  "id" : "b58b9611-e949-4a39-89f3-f529ac989bca",
  "ownerIdentityId" : "a7d2da98-34fc-4949-abb0-f8c46f213e91",
  "createdBy" : "a7d2da98-34fc-4949-abb0-f8c46f213e91",
  "createdAt" : "2024-11-15T02:32:36.004971Z",
  "updatedAt" : "2024-11-15T02:32:36.005597Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "network-1964",
  "networkGroupId" : "1c1227fe-ae9f-464b-b7e4-1c24f68afdb2",
  "size" : "small",
  "productVersion" : "7.4.5",
  "region" : "us-east-1",
  "status" : "PROVISIONED",
  "publicCertEnabled" : true,
  "haEnabled" : false,
  "dnsZoneId" : null,
  "o365BreakoutCategory" : "NONE",
  "networkController" : {
    "id" : "878f8fa5-f192-4973-9a43-f13dd092b172",
    "ownerIdentityId" : "a7d2da98-34fc-4949-abb0-f8c46f213e91",
    "networkId" : "b58b9611-e949-4a39-89f3-f529ac989bca",
    "domainName" : "878f8fa5-f192-4973-9a43-f13dd092b172.nf.io",
    "alternateDomainName" : null,
    "port" : 443,
    "name" : "network-1964-nc",
    "productVersion" : "7.4.5",
    "hostId" : "b4c0cf2b-016b-4c1a-be57-5e7344391702",
    "status" : "PROVISIONED",
    "createdAt" : "2024-11-15T02:32:36.007890Z",
    "updatedAt" : "2024-11-15T02:32:36.010851Z",
    "deletedAt" : null,
    "createdBy" : "a7d2da98-34fc-4949-abb0-f8c46f213e91",
    "deletedBy" : null,
    "softwareDeploymentStateId" : "31a9a562-870f-42d6-9653-40d6d2ec08fb",
    "haPrimaryNode" : true
  },
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/1c1227fe-ae9f-464b-b7e4-1c24f68afdb2",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b58b9611-e949-4a39-89f3-f529ac989bca",
      "title" : "network-1964"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "external-jwt-signers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "auth-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=b58b9611-e949-4a39-89f3-f529ac989bca"
    }
  }
}

Create Network

POST /v2/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
size	String	true
name	String	true
productVersion	Object	true
o365BreakoutCategory	String	true	Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE].
provider	String	true	Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER].
region	String	true
publicCertEnabled	Boolean	true
haEnabled	Boolean	true
dnsZoneId	String	true
alternateDomainName	String	true
customerProviderDetails	Object	true
customerProviderDetails.ipAddress	String	true
customerProviderDetails.managementPort	Integer	true
customerProviderDetails.sshAccessKeyPairName	String	true
networkControllers	Array[Object]	true
networkControllers[].networkId	String	true
networkControllers[].name	String	true
networkControllers[].hostSize	String	true
networkControllers[].provider	String	true	Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER].
networkControllers[].region	String	true
networkControllers[].alternateDomainName	String	true
networkControllers[].customerProviderDetails	Object	true
networkControllers[].customerProviderDetails.ipAddress	String	true
networkControllers[].customerProviderDetails.managementPort	Integer	true
networkControllers[].customerProviderDetails.sshAccessKeyPairName	String	true
networkControllers[].haVotingMember	Boolean	true
edgeRouters	Array[Object]	true
edgeRouters[].name	String	true
edgeRouters[].networkId	String	true
edgeRouters[].zitiId	String	true
edgeRouters[].provider	String	true	Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER].
edgeRouters[].region	String	true
edgeRouters[].hostSize	String	true
edgeRouters[].linkListener	Boolean	true
edgeRouters[].wssListener	Boolean	true
edgeRouters[].tunnelerEnabled	Boolean	true
edgeRouters[].noTraversal	Boolean	true
edgeRouters[].enabled	Boolean	true
edgeRouters[].alternateDomainName	String	true
edgeRouters[].attributes	Array[String]	true
edgeRouters[].endpointAttributes	Array[String]	true
edgeRouterPolicies	Array[Object]	true
edgeRouterPolicies[].name	String	true
edgeRouterPolicies[].networkId	String	true
edgeRouterPolicies[].semantic	String	true	Must be one of [AllOf, AnyOf].
edgeRouterPolicies[].endpointAttributes	Array[String]	true
edgeRouterPolicies[].edgeRouterAttributes	Array[String]	true
serviceEdgeRouterPolicies	Array[Object]	true
serviceEdgeRouterPolicies[].networkId	String	true
serviceEdgeRouterPolicies[].name	String	true
serviceEdgeRouterPolicies[].semantic	String	true	Must be one of [AllOf, AnyOf].
serviceEdgeRouterPolicies[].edgeRouterAttributes	Array[String]	true
serviceEdgeRouterPolicies[].serviceAttributes	Array[String]	true
servicePolicies	Array[Object]	true
servicePolicies[].networkId	String	true
servicePolicies[].name	String	true
servicePolicies[].type	String	true	Must be one of [Dial, Bind].
servicePolicies[].semantic	String	true	Must be one of [AllOf, AnyOf].
servicePolicies[].serviceAttributes	Array[String]	true
servicePolicies[].endpointAttributes	Array[String]	true
servicePolicies[].postureCheckAttributes	Array[String]	true
services	Array[Object]	true
services[].networkId	String	true
services[].name	String	true
services[].encryptionRequired	Boolean	true
services[].terminatorStrategy	String	true
services[].configIds	Array[Object]	true
services[].configNames	Array[String]	true
services[].configs	Array[Object]	true
services[].configs[].networkId	String	true
services[].configs[].name	String	true
services[].configs[].configTypeId	String	true
services[].configs[].configTypeName	String	true
services[].configs[].configType	Object	true
services[].configs[].configType.networkId	String	true
services[].configs[].configType.name	String	true
services[].configs[].configType.schema	Object	true
services[].configs[].data	Object	true
services[].attributes	Array[String]	true
services[].modelType	String	true	Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH].
services[].model	Object	true
certificateAuthorities	Array[Object]	true
certificateAuthorities[].networkId	String	true
certificateAuthorities[].name	String	true
certificateAuthorities[].autoCaEnrollmentEnabled	Boolean	true
certificateAuthorities[].authEnabled	Boolean	true
certificateAuthorities[].ottCaEnrollmentEnabled	Boolean	true
certificateAuthorities[].certPem	String	true
certificateAuthorities[].endpointAttributes	Array[String]	true
certificateAuthorities[].identityNameFormat	String	true
endpoints	Array[Object]	true
endpoints[].networkId	String	true
endpoints[].name	String	true
endpoints[].enrollmentMethod	Object	true
endpoints[].enrollmentMethod.ott	Boolean	true
endpoints[].enrollmentMethod.updb	String	true
endpoints[].enrollmentMethod.ottca	String	true
endpoints[].externalId	String	true
endpoints[].authPolicyId	String	true
endpoints[].attributes	Array[String]	true
endpoints[].syncId	String	true
endpoints[].syncResourceId	String	true
endpoints[].shareRegistration	Object	true
endpoints[].shareRegistration.id	String	true
endpoints[].shareRegistration.toList	Array[String]	true
endpoints[].shareRegistration.ccList	Array[String]	true
endpoints[].shareRegistration.subject	String	true
endpoints[].shareRegistration.type	String	true	Must be one of [Email].
appWans	Array[Object]	true
appWans[].networkId	String	true
appWans[].name	String	true
appWans[].serviceAttributes	Array[String]	true
appWans[].endpointAttributes	Array[String]	true
appWans[].postureCheckAttributes	Array[String]	true
postureChecks	Array[Object]	true
postureChecks[].name	String	true
postureChecks[].networkId	String	true
postureChecks[].type	String	true	Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI].
postureChecks[].attributes	Array[String]	true
postureChecks[].data	Object	true
postureChecks[].data.domains	Array[String]	true
postureChecks[].data.macAddresses	Array[String]	true
postureChecks[].data.timeoutSeconds	Integer	true
postureChecks[].data.promptOnWake	Boolean	true
postureChecks[].data.promptOnUnlock	Boolean	true
postureChecks[].data.ignoreLegacyEndpoints	Boolean	true
postureChecks[].data.operatingSystems	Array[Object]	true
postureChecks[].data.operatingSystems[].type	String	true	Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer].
postureChecks[].data.operatingSystems[].versions	Array[String]	true
postureChecks[].data.process	Object	true
postureChecks[].data.process.osType	String	true	Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].
postureChecks[].data.process.path	String	true
postureChecks[].data.process.hashes	Array[String]	true
postureChecks[].data.process.signerFingerprint	String	true
postureChecks[].data.processes	Array[Object]	true
postureChecks[].data.processes[].osType	String	true	Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS].
postureChecks[].data.processes[].path	String	true
postureChecks[].data.processes[].hashes	Array[String]	true
postureChecks[].data.processes[].signerFingerprints	Array[String]	true
postureChecks[].data.semantic	String	true	Must be one of [AllOf, AnyOf].

Path

Type

Optional

Description

networkGroupId

String

true

size

String

true

name

String

true

productVersion

Object

true

o365BreakoutCategory

String

true

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

provider

String

true

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

region

String

true

publicCertEnabled

Boolean

true

haEnabled

Boolean

true

dnsZoneId

String

true

alternateDomainName

String

true

customerProviderDetails

Object

true

customerProviderDetails.ipAddress

String

true

customerProviderDetails.managementPort

Integer

true

customerProviderDetails.sshAccessKeyPairName

String

true

networkControllers

Array[Object]

true

networkControllers[].networkId

String

true

networkControllers[].name

String

true

networkControllers[].hostSize

String

true

networkControllers[].provider

String

true

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

networkControllers[].region

String

true

networkControllers[].alternateDomainName

String

true

networkControllers[].customerProviderDetails

Object

true

networkControllers[].customerProviderDetails.ipAddress

String

true

networkControllers[].customerProviderDetails.managementPort

Integer

true

networkControllers[].customerProviderDetails.sshAccessKeyPairName

String

true

networkControllers[].haVotingMember

Boolean

true

edgeRouters

Array[Object]

true

edgeRouters[].name

String

true

edgeRouters[].networkId

String

true

edgeRouters[].zitiId

String

true

edgeRouters[].provider

String

true

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

edgeRouters[].region

String

true

edgeRouters[].hostSize

String

true

edgeRouters[].linkListener

Boolean

true

edgeRouters[].wssListener

Boolean

true

edgeRouters[].tunnelerEnabled

Boolean

true

edgeRouters[].noTraversal

Boolean

true

edgeRouters[].enabled

Boolean

true

edgeRouters[].alternateDomainName

String

true

edgeRouters[].attributes

Array[String]

true

edgeRouters[].endpointAttributes

Array[String]

true

edgeRouterPolicies

Array[Object]

true

edgeRouterPolicies[].name

String

true

edgeRouterPolicies[].networkId

String

true

edgeRouterPolicies[].semantic

String

true

Must be one of [AllOf, AnyOf].

edgeRouterPolicies[].endpointAttributes

Array[String]

true

edgeRouterPolicies[].edgeRouterAttributes

Array[String]

true

serviceEdgeRouterPolicies

Array[Object]

true

serviceEdgeRouterPolicies[].networkId

String

true

serviceEdgeRouterPolicies[].name

String

true

serviceEdgeRouterPolicies[].semantic

String

true

Must be one of [AllOf, AnyOf].

serviceEdgeRouterPolicies[].edgeRouterAttributes

Array[String]

true

serviceEdgeRouterPolicies[].serviceAttributes

Array[String]

true

servicePolicies

Array[Object]

true

servicePolicies[].networkId

String

true

servicePolicies[].name

String

true

servicePolicies[].type

String

true

Must be one of [Dial, Bind].

servicePolicies[].semantic

String

true

Must be one of [AllOf, AnyOf].

servicePolicies[].serviceAttributes

Array[String]

true

servicePolicies[].endpointAttributes

Array[String]

true

servicePolicies[].postureCheckAttributes

Array[String]

true

services

Array[Object]

true

services[].networkId

String

true

services[].name

String

true

services[].encryptionRequired

Boolean

true

services[].terminatorStrategy

String

true

services[].configIds

Array[Object]

true

services[].configNames

Array[String]

true

services[].configs

Array[Object]

true

services[].configs[].networkId

String

true

services[].configs[].name

String

true

services[].configs[].configTypeId

String

true

services[].configs[].configTypeName

String

true

services[].configs[].configType

Object

true

services[].configs[].configType.networkId

String

true

services[].configs[].configType.name

String

true

services[].configs[].configType.schema

Object

true

services[].configs[].data

Object

true

services[].attributes

Array[String]

true

services[].modelType

String

true

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

services[].model

Object

true

certificateAuthorities

Array[Object]

true

certificateAuthorities[].networkId

String

true

certificateAuthorities[].name

String

true

certificateAuthorities[].autoCaEnrollmentEnabled

Boolean

true

certificateAuthorities[].authEnabled

Boolean

true

certificateAuthorities[].ottCaEnrollmentEnabled

Boolean

true

certificateAuthorities[].certPem

String

true

certificateAuthorities[].endpointAttributes

Array[String]

true

certificateAuthorities[].identityNameFormat

String

true

endpoints

Array[Object]

true

endpoints[].networkId

String

true

endpoints[].name

String

true

endpoints[].enrollmentMethod

Object

true

endpoints[].enrollmentMethod.ott

Boolean

true

endpoints[].enrollmentMethod.updb

String

true

endpoints[].enrollmentMethod.ottca

String

true

endpoints[].externalId

String

true

endpoints[].authPolicyId

String

true

endpoints[].attributes

Array[String]

true

endpoints[].syncId

String

true

endpoints[].syncResourceId

String

true

endpoints[].shareRegistration

Object

true

endpoints[].shareRegistration.id

String

true

endpoints[].shareRegistration.toList

Array[String]

true

endpoints[].shareRegistration.ccList

Array[String]

true

endpoints[].shareRegistration.subject

String

true

endpoints[].shareRegistration.type

String

true

Must be one of [Email].

appWans

Array[Object]

true

appWans[].networkId

String

true

appWans[].name

String

true

appWans[].serviceAttributes

Array[String]

true

appWans[].endpointAttributes

Array[String]

true

appWans[].postureCheckAttributes

Array[String]

true

postureChecks

Array[Object]

true

postureChecks[].name

String

true

postureChecks[].networkId

String

true

postureChecks[].type

String

true

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

postureChecks[].attributes

Array[String]

true

postureChecks[].data

Object

true

postureChecks[].data.domains

Array[String]

true

postureChecks[].data.macAddresses

Array[String]

true

postureChecks[].data.timeoutSeconds

Integer

true

postureChecks[].data.promptOnWake

Boolean

true

postureChecks[].data.promptOnUnlock

Boolean

true

postureChecks[].data.ignoreLegacyEndpoints

Boolean

true

postureChecks[].data.operatingSystems

Array[Object]

true

postureChecks[].data.operatingSystems[].type

String

true

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

postureChecks[].data.operatingSystems[].versions

Array[String]

true

postureChecks[].data.process

Object

true

postureChecks[].data.process.osType

String

true

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

postureChecks[].data.process.path

String

true

postureChecks[].data.process.hashes

Array[String]

true

postureChecks[].data.process.signerFingerprint

String

true

postureChecks[].data.processes

Array[Object]

true

postureChecks[].data.processes[].osType

String

true

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

postureChecks[].data.processes[].path

String

true

postureChecks[].data.processes[].hashes

Array[String]

true

postureChecks[].data.processes[].signerFingerprints

Array[String]

true

postureChecks[].data.semantic

String

true

Must be one of [AllOf, AnyOf].

Response fields

Path	Type	Optional
content	Object	true
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path	Optional	Description
self	true
networkControllers	true
edgeRouters	true
edgeRouterPolicies	true
endpoints	true
services	true
appWans	true
certificateAuthorities	true
hosts	true

Path

Optional

Description

self

true

networkControllers

true

edgeRouters

true

edgeRouterPolicies

true

endpoints

true

services

true

appWans

true

certificateAuthorities

true

hosts

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJQem8yYTlFRDZtcEdHTE1BOUhaNnh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU0MWZhNTA3LTMzZDctNDJhZS05NjQzLWQ5OTMxMWIxZTY4MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk1OCwiZXhwIjoxNzMxNjQxNTU4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk0M2FjYTA4LTU1YjQtNDY2MS04NzgwLTRkYTdlNzg0NDhlOVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk1OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.j1m5Jq2gDjXy5yUCb9VSGsanttg4xNlZ4d7W0EJxEG4ULhHoryg23ZIL4IKCLrtfPNnJ5fFGiHOytQkJKru6ax0JDtjYdDroY6mvkjglcUS5bCps4fCoON6_Sd3KAYE7S-t4hzccAClzcTR8PrMr6ZpUec6pJlkedMYDvS0ELGXK8xxd5Zd9DHs8eiQK537Vgsr4Et_IhkrhPPLIlE0LALysZGP2eeIvwO_My09Zt_B7ZvgAhdLjSJKwaSzTEPEUzzF1-hWl2txaUfiz3gtd6eqSv2GSQ9N4iqWTzphONaAi6QBDN3JiWnIWbsxjcVlJ7N-nBICALgndo-pXu3W_Og' \
    -d '{"networkGroupId":"0451f011-79bb-4b53-ad38-859d95f77bb2","size":"small","name":"Create Test Network","o365BreakoutCategory":"NONE","provider":"AWS","region":"us-east-1","publicCertEnabled":false,"haEnabled":true}'

Example response

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

{
  "id" : "2062ae5c-f735-4688-8401-5519bd8a9d65",
  "ownerIdentityId" : "541fa507-33d7-42ae-9643-d99311b1e682",
  "createdBy" : "541fa507-33d7-42ae-9643-d99311b1e682",
  "createdAt" : "2024-11-15T02:32:38.885877Z",
  "updatedAt" : "2024-11-15T02:32:38.885877Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Create Test Network",
  "networkGroupId" : "0451f011-79bb-4b53-ad38-859d95f77bb2",
  "size" : "small",
  "productVersion" : "7.3.18",
  "region" : "us-east-1",
  "status" : "PROVISIONING",
  "publicCertEnabled" : false,
  "haEnabled" : false,
  "dnsZoneId" : null,
  "o365BreakoutCategory" : "NONE",
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/0451f011-79bb-4b53-ad38-859d95f77bb2",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2062ae5c-f735-4688-8401-5519bd8a9d65",
      "title" : "Create Test Network"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "external-jwt-signers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "auth-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=2062ae5c-f735-4688-8401-5519bd8a9d65"
    }
  }
}

Delete Network

DELETE /v2/networks/{id}

Authorization

This endpoint requires delete action on the network resource type.

Path parameters

Parameter	Type	Optional	Description
id	Object	false

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path	Type	Optional
content	Object	true
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path	Optional	Description
self	true
networkControllers	true
edgeRouters	true
edgeRouterPolicies	true
endpoints	true
services	true
appWans	true
certificateAuthorities	true
hosts	true

Path

Optional

Description

self

true

networkControllers

true

edgeRouters

true

edgeRouterPolicies

true

endpoints

true

services

true

appWans

true

certificateAuthorities

true

hosts

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks/cb03e10d-4cbc-4a58-a288-0d0013eb88f4' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJuRk5ObTItV3FjU1JVeHVpQno4Zl9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdkMzdjNTU3LWY1MGQtNGFlMi1iNTM5LTFkZTIyYzE4ODFmNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk2MCwiZXhwIjoxNzMxNjQxNTYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjZjOTkxMzc3LTIwMGUtNDVjOS1hNzlmLTg1NGUyMzY4YjdlZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk2MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.WH5MgXGbfO-u8gQk3opxnASzu0lbivUiJVsCQUv_ku1oqI8QfaeQFHVM2jBA936ukGBUQ04hRt14PhkYYoWV2lY84EBQCTUd9ap0DaXPu8IFayD-5RW5RLm9YDrqzllBkiMsBNXbVc4o9CrmqOZTZ59p4ko5-mx0yaK5RIlPfyA3UJCGor40vmvSYiH0G_n8b1dU-7xM7y9xVsLKUIQi-HmBmvRBpor-9vS5tTNQrGj_DGALjkeA_2o-YCzLYXkRyDZfRnTCEmuOarthbKieP6rjColzUcxG_sB1oxCC3rgadfjSjjUkNSEmqh4POZ-cAhNq6mfaFl1E6esqFbGg_g'

Example response

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

{
  "id" : "cb03e10d-4cbc-4a58-a288-0d0013eb88f4",
  "ownerIdentityId" : "b40f64eb-79d4-4550-8d14-382dbb43ec14",
  "createdBy" : "b40f64eb-79d4-4550-8d14-382dbb43ec14",
  "createdAt" : "2024-11-15T02:32:40.408730Z",
  "updatedAt" : "2024-11-15T02:32:40.437582Z",
  "deletedBy" : "7d37c557-f50d-4ae2-b539-1de22c1881f6",
  "deletedAt" : null,
  "name" : "network-2091",
  "networkGroupId" : "e750df85-71ed-4366-9a39-4c44a44dd001",
  "size" : "small",
  "productVersion" : "7.4.5",
  "region" : "us-east-1",
  "status" : "DELETING",
  "publicCertEnabled" : true,
  "haEnabled" : false,
  "dnsZoneId" : null,
  "o365BreakoutCategory" : "NONE",
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/e750df85-71ed-4366-9a39-4c44a44dd001",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/cb03e10d-4cbc-4a58-a288-0d0013eb88f4",
      "title" : "network-2091"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "external-jwt-signers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "auth-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=cb03e10d-4cbc-4a58-a288-0d0013eb88f4"
    }
  }
}

Network Controllers

Get Network Controller

GET /v2/network-controllers/{id}

Authorization

This endpoint requires read action on the network-controller resource type.

Path parameters

Parameter	Type	Optional	Description
id	Object	false

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path	Type	Optional
content	Object	true
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path	Optional	Description
self	true
network	true

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-controllers/20bf6a20-3fb0-40f2-8062-1790491b75b9' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfQ0Q4WDBJdnNWQ2JaVjhCSHF3QkdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkxYzBlMDhhLWZiZGUtNGRmMi1hMmE5LTk4MDMzNDNmYjQwZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk3MCwiZXhwIjoxNzMxNjQxNTcwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhkNzdmMzYxLTdmMGYtNGY2Zi04NjdlLTIxY2YyMDEyODM5NVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk3MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ICnVb7Le0beJhJQGsXSv71qrbwKFMdx4k92o1fHQd2G7VFWkUUC2NnrNrcyOOy41MALeeHsi6QPjDOVCmPpsfcx-2QsiUwY-25Y5XnLOYCbAgsSJRMjkGNfiqD3bWlv5wb2O0cxbdRyeAMw7XZsxFnibJB2oizohCJgwgRREg4donv7vQ0jyFhpb9HgafD9r4CGmwS26C9hWPKP-1Je6klRjsYXgAv7qN5WSA4Ltwv4H2cKFRYGnu_8q5UkBAeFffl8u_8HhjrybUuqvpS8k9RM_xnYPO_ahrEmfQShM_ZF16HPQnogAg4Ecz_8N5EX_c4Tw0aWvlT4vUIuR4Coi7Q'

Example response

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

{
  "id" : "20bf6a20-3fb0-40f2-8062-1790491b75b9",
  "ownerIdentityId" : "81f539ac-ffc0-4df8-917a-16aceb8eca00",
  "networkId" : "d97070b8-c5df-4e48-8fef-77c311efc2f9",
  "domainName" : "new-domain.nf.io",
  "alternateDomainName" : null,
  "port" : 443,
  "name" : "networkcontroller-controller-test-nc",
  "productVersion" : "7.3.37",
  "hostId" : "21060322-5477-4e05-8c8c-564477213821",
  "status" : "PROVISIONED",
  "createdAt" : "2024-11-15T02:32:49.770984Z",
  "updatedAt" : "2024-11-15T02:32:50.136148Z",
  "deletedAt" : null,
  "createdBy" : "81f539ac-ffc0-4df8-917a-16aceb8eca00",
  "deletedBy" : null,
  "softwareDeploymentStateId" : "7aaba59f-fcc3-45df-a355-e826dc5c4d4b",
  "haPrimaryNode" : true,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/20bf6a20-3fb0-40f2-8062-1790491b75b9",
      "title" : "networkcontroller-controller-test-nc"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d97070b8-c5df-4e48-8fef-77c311efc2f9",
      "profile" : "parent"
    },
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/7aaba59f-fcc3-45df-a355-e826dc5c4d4b"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/21060322-5477-4e05-8c8c-564477213821"
    },
    "softwareDeploymentState" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/7aaba59f-fcc3-45df-a355-e826dc5c4d4b",
      "deprecation" : "Use software-deployment-state link instead"
    }
  }
}

Get Network Controller Session

GET /v2/network-controllers/{id}/session

Authorization

This endpoint requires read-platform-protected action on the network-controller resource type.

Path parameters

Parameter	Type	Optional	Description
id	Object	false

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path	Type	Optional
content	Object	true
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path	Optional	Description
self	true
network	true

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-controllers/cc9476c9-16de-432e-967e-c27a3eb16d21/session' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ1SGZfN1g3VDYzdkpfVFFWS1FoSml3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRjODhiMGNiLTI5YjYtNDhlMC1iYjcwLWRmNDY5NDFiMzE1YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk2OCwiZXhwIjoxNzMxNjQxNTY4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFmZjc4YmMzLTZmNzktNDExZi04ZjczLWQzNmE0ZTRmYjA2OFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk2OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.JS37Jfy58H_NHs2WaGxgEIebMfXsjO-MAfpRhsLKlOUeD0JU6jfTlbdhmwGQ8IwfxzezgS6aE7K5l_yGH5JtX0D8Ws-UV2jAuiNMLQUbgptC7o3wMJyPLtm9WisMvvLsjJkY6ZloazDbGA3j6ciLC8wuihvBUv6K3DflY_DbVxlV55BWPgVgfUNuhR3xz-XDS0nQ1W0p2v4WIGsQTSYqgwzk7oOHN4_BAeWb9kbBqwgcxljbRAgE4G5GzKHemWnHSFvYM6EZ8G6m3nQ84OEw1R4Cfj9Oep1LD2ws8K1o1mG5fne9r81BbBFPttIN98VMaWVLXoWxytgbO9lDLATyPw'

Example response

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

{
  "sessionToken" : "--- session ---",
  "expiresAt" : "2024-11-15T02:32:48.237+00:00",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/cc9476c9-16de-432e-967e-c27a3eb16d21/session"
    },
    "parent" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/cc9476c9-16de-432e-967e-c27a3eb16d21"
    }
  }
}

Find Network Controllers

GET /v2/network-controllers

Authorization

This endpoint requires read action on the network-controller resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter	Type	Optional	Description
isDeleted	Boolean	true	Deprecated..

Parameter

Type

Optional

Description

isDeleted

Boolean

true

Deprecated..

Request fields

No request body.

Response fields

Path	Type	Optional
links	Array[Object]	true
links[].rel	String	true
links[].href	String	true
links[].hreflang	String	true
links[].media	String	true
links[].title	String	true
links[].type	String	true
links[].deprecation	String	true
links[].profile	String	true
links[].name	String	true
content	Array[Object]	true
page	Object	true
page.size	Integer	true
page.totalElements	Integer	true
page.totalPages	Integer	true
page.number	Integer	true

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path	Optional	Description
self	true
network	true

Path

Optional

Description

self

true

network

true

Embedded resources

Path	Type	Optional	Description
id	String	true
ownerIdentityId	String	true
networkId	String	true
domainName	String	true
alternateDomainName	String	true
port	Integer	true
name	String	true
productVersion	Object	true
hostId	String	true
status	String	true	Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED, OFFLINE].
createdAt	String	true
updatedAt	String	true
deletedAt	String	true
createdBy	String	true
deletedBy	String	true
softwareDeploymentStateId	String	true
haPrimaryNode	Boolean	true
publicDomainName	String	true
managementZitiIdentity	Object	true
managementZitiIdentity.id	String	true
managementZitiIdentity.name	String	true
managementZitiIdentity.type	Object	true
managementZitiIdentity.type.id	String	true
managementZitiIdentity.type.name	String	true
managementZitiIdentity.typeId	String	true
managementZitiIdentity.externalId	String	true
managementZitiIdentity.authPolicyId	String	true
managementZitiIdentity.authenticators	Object	true
managementZitiIdentity.authenticators.updb	Object	true
managementZitiIdentity.authenticators.updb.username	String	true
managementZitiIdentity.authenticators.cert	Object	true
managementZitiIdentity.authenticators.cert.fingerprint	String	true
managementZitiIdentity.enrollment	Object	true
managementZitiIdentity.enrollment.ott	Object	true
managementZitiIdentity.enrollment.ott.id	String	true
managementZitiIdentity.enrollment.ott.token	String	true
managementZitiIdentity.enrollment.ott.jwt	String	true
managementZitiIdentity.enrollment.ott.expiresAt	String	true
managementZitiIdentity.enrollment.ottca	Object	true
managementZitiIdentity.enrollment.ottca.id	String	true
managementZitiIdentity.enrollment.ottca.caId	String	true
managementZitiIdentity.enrollment.ottca.token	String	true
managementZitiIdentity.enrollment.ottca.jwt	String	true
managementZitiIdentity.enrollment.ottca.expiresAt	String	true
managementZitiIdentity.enrollment.updb	Object	true
managementZitiIdentity.enrollment.updb.id	String	true
managementZitiIdentity.enrollment.updb.token	String	true
managementZitiIdentity.enrollment.updb.jwt	String	true
managementZitiIdentity.enrollment.updb.expiresAt	String	true
managementZitiIdentity.disabled	Boolean	true
managementZitiIdentity.disabledAt	String	true
managementZitiIdentity.disabledUntil	String	true
managementZitiIdentity.envInfo	Object	true
managementZitiIdentity.envInfo.arch	String	true
managementZitiIdentity.envInfo.domain	String	true
managementZitiIdentity.envInfo.hostname	String	true
managementZitiIdentity.envInfo.os	String	true
managementZitiIdentity.envInfo.osRelease	String	true
managementZitiIdentity.envInfo.osVersion	String	true
managementZitiIdentity.sdkInfo	Object	true
managementZitiIdentity.sdkInfo.appId	String	true
managementZitiIdentity.sdkInfo.appVersion	String	true
managementZitiIdentity.sdkInfo.branch	String	true
managementZitiIdentity.sdkInfo.revision	String	true
managementZitiIdentity.sdkInfo.type	String	true
managementZitiIdentity.sdkInfo.version	String	true
managementZitiIdentity.hasApiSession	Boolean	true
managementZitiIdentity.hasEdgeRouterConnection	Boolean	true
managementZitiIdentity.roleAttributes	Array[String]	true
managementZitiIdentity.tags	Map	true
managementZitiIdentity.appData	Map	true
managementZitiIdentity.createdAt	String	true
managementZitiIdentity.updatedAt	String	true
managementZitiIdentity.mfaEnabled	Boolean	true
managementZitiIdentity.admin	Boolean	true
managementZitiIdentity.defaultAdmin	Boolean	true

Path

Type

Optional

Description

String

true

ownerIdentityId

String

true

networkId

String

true

domainName

String

true

alternateDomainName

String

true

port

Integer

true

name

String

true

productVersion

Object

true

hostId

String

true

status

String

true

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

createdAt

String

true

updatedAt

String

true

deletedAt

String

true

createdBy

String

true

deletedBy

String

true

softwareDeploymentStateId

String

true

haPrimaryNode

Boolean

true

publicDomainName

String

true

managementZitiIdentity

Object

true

managementZitiIdentity.id

String

true

managementZitiIdentity.name

String

true

managementZitiIdentity.type

Object

true

managementZitiIdentity.type.id

String

true

managementZitiIdentity.type.name

String

true

managementZitiIdentity.typeId

String

true

managementZitiIdentity.externalId

String

true

managementZitiIdentity.authPolicyId

String

true

managementZitiIdentity.authenticators

Object

true

managementZitiIdentity.authenticators.updb

Object

true

managementZitiIdentity.authenticators.updb.username

String

true

managementZitiIdentity.authenticators.cert

Object

true

managementZitiIdentity.authenticators.cert.fingerprint

String

true

managementZitiIdentity.enrollment

Object

true

managementZitiIdentity.enrollment.ott

Object

true

managementZitiIdentity.enrollment.ott.id

String

true

managementZitiIdentity.enrollment.ott.token

String

true

managementZitiIdentity.enrollment.ott.jwt

String

true

managementZitiIdentity.enrollment.ott.expiresAt

String

true

managementZitiIdentity.enrollment.ottca

Object

true

managementZitiIdentity.enrollment.ottca.id

String

true

managementZitiIdentity.enrollment.ottca.caId

String

true

managementZitiIdentity.enrollment.ottca.token

String

true

managementZitiIdentity.enrollment.ottca.jwt

String

true

managementZitiIdentity.enrollment.ottca.expiresAt

String

true

managementZitiIdentity.enrollment.updb

Object

true

managementZitiIdentity.enrollment.updb.id

String

true

managementZitiIdentity.enrollment.updb.token

String

true

managementZitiIdentity.enrollment.updb.jwt

String

true

managementZitiIdentity.enrollment.updb.expiresAt

String

true

managementZitiIdentity.disabled

Boolean

true

managementZitiIdentity.disabledAt

String

true

managementZitiIdentity.disabledUntil

String

true

managementZitiIdentity.envInfo

Object

true

managementZitiIdentity.envInfo.arch

String

true

managementZitiIdentity.envInfo.domain

String

true

managementZitiIdentity.envInfo.hostname

String

true

managementZitiIdentity.envInfo.os

String

true

managementZitiIdentity.envInfo.osRelease

String

true

managementZitiIdentity.envInfo.osVersion

String

true

managementZitiIdentity.sdkInfo

Object

true

managementZitiIdentity.sdkInfo.appId

String

true

managementZitiIdentity.sdkInfo.appVersion

String

true

managementZitiIdentity.sdkInfo.branch

String

true

managementZitiIdentity.sdkInfo.revision

String

true

managementZitiIdentity.sdkInfo.type

String

true

managementZitiIdentity.sdkInfo.version

String

true

managementZitiIdentity.hasApiSession

Boolean

true

managementZitiIdentity.hasEdgeRouterConnection

Boolean

true

managementZitiIdentity.roleAttributes

Array[String]

true

managementZitiIdentity.tags

Map

true

managementZitiIdentity.appData

Map

true

managementZitiIdentity.createdAt

String

true

managementZitiIdentity.updatedAt

String

true

managementZitiIdentity.mfaEnabled

Boolean

true

managementZitiIdentity.admin

Boolean

true

managementZitiIdentity.defaultAdmin

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-controllers?createdAt=%3E%3D2024-11-15T01:31:43.463973906Z' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJuZ1BxTENLeW9vMTBLVTk0YTZDRGl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc1N2E5MmRjLWZhODgtNDM5My1iMGZiLTI2ODRmNjNmMDEzMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkwMywiZXhwIjoxNzMxNjQxNTAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjc2ZWJjZWMwLTY0MTAtNDI2MC04ZDA5LWZkNTRhZmVhMjIyOFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.RRqAoIK0mvKcy3P0wrSvwTdhlqk4uuY2xDbwQtBcA9RWGNWgvTCpNFIpFs9cO42PHv3UmNpjnK-zRQKHq4F8RPasRyEhRTF9ezhdmAZ2Jkf6sXbKOy8g4uLWLA1TAONXV0AfRQ2WfVrwDVSX8QYBuQuYXaPi5Nh5G-G1obrOH_GWJ2gfGvAS1LSFSdxuTbM2K4dOC6C2jf_L6qW78XaysxeJfcBnRNJv63pF6w4Y6bRwlyLpu_miIk12h8Bar00E303uuZUuRdTuNQ4ZTS4_bAvpZeB4fRKTNNajeGasdiOUdMpvbmkRwqJ-rAugkuX_-PoPg_bpu_Zo-DJFzGDaNA'

Example response

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

{
  "_embedded" : {
    "networkControllerList" : [ {
      "id" : "264dbe4a-c887-4251-ae0f-69056fadd3bc",
      "ownerIdentityId" : "40618f04-4e57-4ec2-b6f6-091d21d1fd60",
      "networkId" : "b54e6ea3-18bb-477d-82dd-1043c39cc8b6",
      "domainName" : "ayU9OaarizytXONcpyu61.fake.com",
      "alternateDomainName" : null,
      "port" : 443,
      "name" : "NetworkController Find Test 2 - NC",
      "productVersion" : "7.3.37",
      "hostId" : "e2bb48d9-107b-42e2-87e7-74d8215ce128",
      "status" : "PROVISIONING",
      "createdAt" : "2024-11-15T02:31:43.435066Z",
      "updatedAt" : "2024-11-15T02:31:43.435066Z",
      "deletedAt" : null,
      "createdBy" : "40618f04-4e57-4ec2-b6f6-091d21d1fd60",
      "deletedBy" : null,
      "softwareDeploymentStateId" : null,
      "haPrimaryNode" : true,
      "_links" : {
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/e2bb48d9-107b-42e2-87e7-74d8215ce128"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b54e6ea3-18bb-477d-82dd-1043c39cc8b6",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/264dbe4a-c887-4251-ae0f-69056fadd3bc",
          "title" : "NetworkController Find Test 2 - NC"
        }
      }
    }, {
      "id" : "2790d771-03b7-4533-92ed-8879dd669a3a",
      "ownerIdentityId" : "40618f04-4e57-4ec2-b6f6-091d21d1fd60",
      "networkId" : "77ac6729-135f-4e7c-bf9f-ad356bb77b1b",
      "domainName" : "-roMOUtjlkXMf_1DotQzJ.fake.com",
      "alternateDomainName" : null,
      "port" : 443,
      "name" : "NetworkController Find Test 1 - NC",
      "productVersion" : "7.3.37",
      "hostId" : "19a7f073-71be-4a00-a78b-4c7b49b3a3ed",
      "status" : "PROVISIONED",
      "createdAt" : "2024-11-15T02:31:43.430096Z",
      "updatedAt" : "2024-11-15T02:31:43.430096Z",
      "deletedAt" : null,
      "createdBy" : "40618f04-4e57-4ec2-b6f6-091d21d1fd60",
      "deletedBy" : null,
      "softwareDeploymentStateId" : null,
      "haPrimaryNode" : true,
      "_links" : {
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/19a7f073-71be-4a00-a78b-4c7b49b3a3ed"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/77ac6729-135f-4e7c-bf9f-ad356bb77b1b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/2790d771-03b7-4533-92ed-8879dd669a3a",
          "title" : "NetworkController Find Test 1 - NC"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?createdAt=%3E%3D2024-11-15T01:31:43.463973906Z"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Create Network Controller

POST /v2/network-controllers

Authorization

This endpoint requires create action on the network-controller resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path	Type	Optional	Description
networkId	String	true
name	String	true
hostSize	String	true
provider	String	true	Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER].
region	String	true
alternateDomainName	String	true
customerProviderDetails	Object	true
customerProviderDetails.ipAddress	String	true
customerProviderDetails.managementPort	Integer	true
customerProviderDetails.sshAccessKeyPairName	String	true
haVotingMember	Boolean	true

Path

Type

Optional

Description

networkId

String

true

name

String

true

hostSize

String

true

provider

String

true

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

region

String

true

alternateDomainName

String

true

customerProviderDetails

Object

true

customerProviderDetails.ipAddress

String

true

customerProviderDetails.managementPort

Integer

true

customerProviderDetails.sshAccessKeyPairName

String

true

haVotingMember

Boolean

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-controllers' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZcW9Yd0M0cG9XRFFCTW5OQlFsdXZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRkMTc5M2MwLTgxNDMtNDI5Ni05OTc2LTg1NTRmZjE4NTE2YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk2OSwiZXhwIjoxNzMxNjQxNTY5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFjNjU1OTQxLTE1ZjUtNDQ4Yi1iYWMzLTIwYjMwMDcwY2ViZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk2OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.AQhGVlSP7NhORytV9JwUQunYgWm2cBxWjWPtmBXzxze0WtdwGtH_AwxU11CMfo32wTzsmB9_hgzC2Cqms-qH57OQNAzg92ct65kFKn0tIBp0c1QN64k8yrSLQnxJVJQ3eIn4eBtYdLhdcyPmJfR7fVfdSVyqjEBCaoV0FoIgYTIfKQn5_ImNtIaGbMWAdx2me9cqrjvSHOxuxXpiBMN6AoqLmLu3141iNJGgKmGkfUd1hwBSc-y5SNR9PimxHvCtOoTlT-WZ894hNfJzjnkKo_O3EXpldDgQvhm0VelRKLI2EPer0ECwHMR6h6zpJjsTCKTlR6TEPvzDSLHSro3FvQ' \
    -d '{"networkId":"d97070b8-c5df-4e48-8fef-77c311efc2f9","name":"controller-2351","hostSize":"small","provider":"AWS","region":"us-east-1","haVotingMember":false}'

Example response

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

{
  "id" : "29aef277-d94e-4f63-9947-36c11eb12634",
  "ownerIdentityId" : "dd1793c0-8143-4296-9976-8554ff18516a",
  "networkId" : "d97070b8-c5df-4e48-8fef-77c311efc2f9",
  "domainName" : null,
  "alternateDomainName" : null,
  "port" : 8443,
  "name" : "controller-2351",
  "productVersion" : "7.4.5",
  "hostId" : null,
  "status" : "PROVISIONING",
  "createdAt" : "2024-11-15T02:32:49.353501Z",
  "updatedAt" : "2024-11-15T02:32:49.353501Z",
  "deletedAt" : null,
  "createdBy" : "dd1793c0-8143-4296-9976-8554ff18516a",
  "deletedBy" : null,
  "softwareDeploymentStateId" : null,
  "haPrimaryNode" : false,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/29aef277-d94e-4f63-9947-36c11eb12634",
      "title" : "controller-2351"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d97070b8-c5df-4e48-8fef-77c311efc2f9",
      "profile" : "parent"
    }
  }
}

Update Network Controller

PATCH /v2/network-controllers/{id}

Authorization

This endpoint requires update action on the network-controller resource type.

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-controllers/cc9476c9-16de-432e-967e-c27a3eb16d21' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvVEhBMlVOajEzb0VqZjZsTFVVdVF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVhZWYyOGQxLTJiZTUtNDM3Ny1hOGRhLTgzZDk5YjU5NjI3YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk2OSwiZXhwIjoxNzMxNjQxNTY5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ2NDY4ODM5LTZiYzMtNGZlOC1hNWU3LWY2MGUwNTFiMGVlM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk2OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.JmwlKrtWmWR0-6_ggW5jUYt06BbnlurTVVOpeNyaEzq3blQRYB7XcH3Ms-0CXHMfXVPiSDb_MGuADv5ImJwx0EaumLqNtjwvYBv5zK1DdmjlJKh21MyTC8dqgWDW4AZbNh0mAHMbHRpuWAAK-eaFpFhORQ2c03egcqapwSV6SmR1vIibXdkjoG4FUMj2mNUy1TGmsgVgwNA7zudeb51Prb1wjFkkMw82yzH1QNUSIaPBMMWwYUv9me4n6Pp0LLPzrCeS-ZjhTUeie0YUK8m1yBeDFkBZOvzYVgW3_epycytOmdW1pgt_BXfgo4KM05aAHPpDEZDGQn8sgoV-pYEmfg' \
    -d '{"name":"updatedControllerName-2374"}'

Example response

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

{
  "id" : "cc9476c9-16de-432e-967e-c27a3eb16d21",
  "ownerIdentityId" : "81f539ac-ffc0-4df8-917a-16aceb8eca00",
  "networkId" : "d97070b8-c5df-4e48-8fef-77c311efc2f9",
  "domainName" : "new-domain.nf.io",
  "alternateDomainName" : null,
  "port" : 443,
  "name" : "updatedControllerName-2374",
  "productVersion" : "7.3.37",
  "hostId" : "bc607af5-6391-461a-b6de-d11e59f49485",
  "status" : "PROVISIONED",
  "createdAt" : "2024-11-15T02:32:47.806619Z",
  "updatedAt" : "2024-11-15T02:32:49.731072Z",
  "deletedAt" : null,
  "createdBy" : "81f539ac-ffc0-4df8-917a-16aceb8eca00",
  "deletedBy" : null,
  "softwareDeploymentStateId" : "0a42bd78-ae95-4bf9-a756-a7675eb0a834",
  "haPrimaryNode" : true,
  "managementZitiIdentity" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/cc9476c9-16de-432e-967e-c27a3eb16d21",
      "title" : "updatedControllerName-2374"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d97070b8-c5df-4e48-8fef-77c311efc2f9",
      "profile" : "parent"
    },
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/0a42bd78-ae95-4bf9-a756-a7675eb0a834"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/bc607af5-6391-461a-b6de-d11e59f49485"
    },
    "softwareDeploymentState" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/0a42bd78-ae95-4bf9-a756-a7675eb0a834",
      "deprecation" : "Use software-deployment-state link instead"
    }
  }
}

Endpoints

Find Endpoints

GET /v2/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

attributes

Object

true

Deprecated..

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

networkId

String

true

zitiId

String

true

name

String

true

typeId

String

true

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

envDomain

String

true

envHostname

String

true

String

true

osRelease

String

true

osVersion

String

true

externalId

String

true

authPolicyId

String

true

disabled

Boolean

true

disabledAt

String

true

disabledUntil

String

true

hasApiSession

Boolean

true

hasEdgeRouterConnection

Boolean

true

lastOnlineAt

String

true

syncId

String

true

syncResourceId

String

true

attributes

Array[String]

true

jwt

String

true

mfaEnabled

Boolean

true

online

Boolean

true

managedBy

String

true

jwtExpiresAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJXclJMTTlQRU1zRGN3TXpPN0xxZFBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg5Y2E3MTk5LWVkZGItNDAyNS1iMTFjLTRjMmIwZDM3MjhmYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg4OSwiZXhwIjoxNzMxNjQxNDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjYyNzI1MjkyLWIzNmUtNDU5ZC1hMDkyLTI3NzllNjkyMzg3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Mbz16M5YHnmHzKrf9PDGSVMWiSln41oCdmFNT-F_oym8gI1WpSnCeWSnRgouzMs9kEEBzEPhFeAzgJ3KY0lEtYww76KPIxRG4l7XlNlmgqAzkX_s3_-yCrTTBgHu3vtEu5APeQvd2tni0ACSQfYlwJj4opAV9gDwwSQjlno6XMApJHi54MYp4PWC1X-5Ml5-U1GZ05fvc_kgamz-0TS_82ZmUnwbX_iBfzvcw2EbrxGm7az-lsPc2DzJt1SDBKN1dMLN1AaDtt094i4RlKSOlPIj65CX2ZyR_fLmS7KZ_AGqbCu0l4-muJ2n_94xGpHFJy1yFSiv_qZ-N5GLrkfgTA'

Example response

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

{
  "_embedded" : {
    "endpointList" : [ {
      "id" : "2262c82d-7ec5-4d3b-8bfd-ab4aa17998d2",
      "ownerIdentityId" : "a872e899-0cb6-4a86-9ad0-f6b4a7c8ebc3",
      "createdBy" : "a872e899-0cb6-4a86-9ad0-f6b4a7c8ebc3",
      "createdAt" : "2024-11-15T02:31:29.432073Z",
      "updatedAt" : "2024-11-15T02:31:29.432073Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "f7d2ae9f-805c-469b-8132-004d97f299e5",
      "zitiId" : "ziti-id-582",
      "name" : "endpoint-583",
      "typeId" : "type",
      "appId" : "appId",
      "appVersion" : "appVersion",
      "branch" : "branch",
      "revision" : "revision",
      "type" : "User",
      "version" : "version",
      "arch" : "arch",
      "envDomain" : "domain",
      "envHostname" : "hostname",
      "os" : "os",
      "osRelease" : "osRelease",
      "osVersion" : "osVersion",
      "externalId" : "osVersion",
      "authPolicyId" : null,
      "disabled" : false,
      "disabledAt" : null,
      "disabledUntil" : null,
      "hasApiSession" : false,
      "hasEdgeRouterConnection" : false,
      "lastOnlineAt" : null,
      "syncId" : null,
      "syncResourceId" : null,
      "attributes" : [ ],
      "jwt" : null,
      "mfaEnabled" : false,
      "online" : false,
      "managedBy" : "Unmanaged",
      "jwtExpiresAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/2262c82d-7ec5-4d3b-8bfd-ab4aa17998d2",
          "title" : "endpoint-583"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f7d2ae9f-805c-469b-8132-004d97f299e5",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Endpoint

GET /v2/endpoints/{id}

Authorization

This endpoint requires read action on the endpoint resource type.

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/4bb24c57-c34a-47d4-b737-e12c0e6593fb' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJabUNzMmxTVEhmOWNvWTBIcUMxVm9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJiYTc1ODE2LTdjODItNDg3Mi05MTVjLWQyOGI3N2Q4NTJhMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg5MSwiZXhwIjoxNzMxNjQxNDkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjkzMWUwYzEzLTU0MWYtNDUxOC04NTkxLWJiYmY0OGI5NjE1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg5MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.QkUM5PwgOmOkSp8lSCrlmML5IMCjVNZpCqlxjoE8qzHdVQw89Pfe20TBKyDtJSNYC-N-GTVIaYB9bK4YjUZj4eo4vXMMeAZjO6yezQ2oZldzRBd4e6Plv-aPGm0tyk0v-jm1T45zOPNjhxBrF6CgK7VNc9Kx43JLnD6LejJkF7olU1W60-aZqus6m7w4IYBeLq9ZbeGe7R305-VHTcQz-itOr9nHTcztY-kTN-tEEoUiGPv_ob6UxUTw8jLrjJ_fKIwVF0CSEAgL7qYVspMSQuQ_70hTqmJZ69Wh7qHDUrV_eQr9J-KOC57bU67kNP5S0jcCGcwOtQBwqtsnu2C56g'

Example response

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

{
  "id" : "4bb24c57-c34a-47d4-b737-e12c0e6593fb",
  "ownerIdentityId" : "f80cc100-17ce-4246-8598-6aa726d89dff",
  "createdBy" : "f80cc100-17ce-4246-8598-6aa726d89dff",
  "createdAt" : "2024-11-15T02:31:31.039458Z",
  "updatedAt" : "2024-11-15T02:31:31.039458Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "6979a72a-bb9c-4edd-9244-cc9460228283",
  "zitiId" : "ziti-id-639",
  "name" : "endpoint-640",
  "typeId" : "type",
  "appId" : "appId",
  "appVersion" : "appVersion",
  "branch" : "branch",
  "revision" : "revision",
  "type" : "User",
  "version" : "version",
  "arch" : "arch",
  "envDomain" : "domain",
  "envHostname" : "hostname",
  "os" : "os",
  "osRelease" : "osRelease",
  "osVersion" : "osVersion",
  "hasApiSession" : false,
  "hasEdgeRouterConnection" : false,
  "lastOnlineAt" : null,
  "syncId" : null,
  "syncResourceId" : null,
  "attributes" : [ ],
  "jwt" : null,
  "mfaEnabled" : false,
  "online" : false,
  "managedBy" : "Unmanaged",
  "jwtExpiresAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/4bb24c57-c34a-47d4-b737-e12c0e6593fb",
      "title" : "endpoint-640"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6979a72a-bb9c-4edd-9244-cc9460228283",
      "profile" : "parent"
    }
  }
}

Find Endpoints

GET /v2/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

attributes

Object

true

Deprecated..

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

networkId

String

true

zitiId

String

true

name

String

true

typeId

String

true

appId

String

true

appVersion

String

true

branch

String

true

revision

String

true

type

String

true

version

String

true

arch

String

true

envDomain

String

true

envHostname

String

true

String

true

osRelease

String

true

osVersion

String

true

externalId

String

true

authPolicyId

String

true

disabled

Boolean

true

disabledAt

String

true

disabledUntil

String

true

hasApiSession

Boolean

true

hasEdgeRouterConnection

Boolean

true

lastOnlineAt

String

true

syncId

String

true

syncResourceId

String

true

attributes

Array[String]

true

jwt

String

true

mfaEnabled

Boolean

true

online

Boolean

true

managedBy

String

true

jwtExpiresAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhWVNJMXdJVHdfdUN5OU85TVE2TEdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ3NDVjZjc3LWE2YzEtNGMwOS04NWYxLTU1NmFkMDYwYmZhOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg3OSwiZXhwIjoxNzMxNjQxNDc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ4NTkxYjEwLTIwMmYtNGI3MS1hYWM4LWZhYmQwNWQ2MzU3NFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg3OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.tHcAQFPoQrs8I38hHG5mBzMTDMs-EJ0xXCVzZ7eP5oRgKK0uxtwnlH26PAzfB9KOSWMRhRA3qPAKkaKSJK2qunLic-sc6MTm96LxdhnRW0karLHkl0DuV-c4IcQ-mHFCHTwB9aetX18nBQdQlpF8ntg4kLclo0nD2zV2jsRC3chb_pYQIZNa2HHHZSNrBs4rLbnXgfwb819EC2_s5u3V2QfSr9sO896_WhoiMR6x1Yh22YqYcAu2q3SC70oxJCylHs_yY0XCExL3nwRrpFLc3deGdM_MCTpNjqUYN3ms-hUnegDjnLzeCuVumoQ0H84HNsOByCGwr7MpxhgatvX9jA'

Example response

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

{
  "_embedded" : {
    "endpointList" : [ {
      "id" : "57252983-86ce-414a-9b0b-0ebdb80575ac",
      "ownerIdentityId" : "35b917eb-4ad0-4f69-8815-b02206f8d235",
      "createdBy" : "35b917eb-4ad0-4f69-8815-b02206f8d235",
      "createdAt" : "2024-11-15T02:31:19.626050Z",
      "updatedAt" : "2024-11-15T02:31:19.626050Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "e7afac65-1ed8-402d-b297-ce1001f72892",
      "zitiId" : "ziti-id-122",
      "name" : "Test Endpoint 2",
      "typeId" : "type",
      "appId" : "appId",
      "appVersion" : "appVersion",
      "branch" : "branch",
      "revision" : "revision",
      "type" : "User",
      "version" : "version",
      "arch" : "arch",
      "envDomain" : "domain",
      "envHostname" : "hostname",
      "os" : "os",
      "osRelease" : "osRelease",
      "osVersion" : "osVersion",
      "hasApiSession" : false,
      "hasEdgeRouterConnection" : false,
      "lastOnlineAt" : null,
      "syncId" : "7a0a5bec-5f96-4b96-9e1d-a10f91fca83b",
      "syncResourceId" : "fPDyBvEJ4xm_sc4unAjiN",
      "attributes" : [ "#attr3", "#attr1" ],
      "jwt" : null,
      "mfaEnabled" : false,
      "online" : false,
      "managedBy" : "Sync",
      "jwtExpiresAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/57252983-86ce-414a-9b0b-0ebdb80575ac",
          "title" : "Test Endpoint 2"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e7afac65-1ed8-402d-b297-ce1001f72892",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "9eb6834a-ac43-4d7a-a69a-c5ec54b41f80",
      "ownerIdentityId" : "7c130581-2c15-445f-ab26-68e9b1553ca1",
      "createdBy" : "7c130581-2c15-445f-ab26-68e9b1553ca1",
      "createdAt" : "2024-11-15T02:31:19.629331Z",
      "updatedAt" : "2024-11-15T02:31:19.629331Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "e7afac65-1ed8-402d-b297-ce1001f72892",
      "zitiId" : "ziti-id-124",
      "name" : "Test Endpoint 3",
      "typeId" : "type",
      "appId" : "appId",
      "appVersion" : "appVersion",
      "branch" : "branch",
      "revision" : "revision",
      "type" : "User",
      "version" : "version",
      "arch" : "arch",
      "envDomain" : "domain",
      "envHostname" : "hostname",
      "os" : "os",
      "osRelease" : "osRelease",
      "osVersion" : "osVersion",
      "hasApiSession" : false,
      "hasEdgeRouterConnection" : false,
      "lastOnlineAt" : null,
      "syncId" : null,
      "syncResourceId" : null,
      "attributes" : [ ],
      "jwt" : null,
      "mfaEnabled" : false,
      "online" : false,
      "managedBy" : "Unmanaged",
      "jwtExpiresAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/9eb6834a-ac43-4d7a-a69a-c5ec54b41f80",
          "title" : "Test Endpoint 3"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e7afac65-1ed8-402d-b297-ce1001f72892",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "dfbee49c-ae8b-462e-b572-ab31005d73f6",
      "ownerIdentityId" : "35b917eb-4ad0-4f69-8815-b02206f8d235",
      "createdBy" : "35b917eb-4ad0-4f69-8815-b02206f8d235",
      "createdAt" : "2024-11-15T02:31:19.617262Z",
      "updatedAt" : "2024-11-15T02:31:19.617262Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "e7afac65-1ed8-402d-b297-ce1001f72892",
      "zitiId" : "ziti-id-120",
      "name" : "Test Endpoint 1",
      "typeId" : "type",
      "appId" : "appId",
      "appVersion" : "appVersion",
      "branch" : "branch",
      "revision" : "revision",
      "type" : "User",
      "version" : "version",
      "arch" : "arch",
      "envDomain" : "domain",
      "envHostname" : "hostname",
      "os" : "os",
      "osRelease" : "osRelease",
      "osVersion" : "osVersion",
      "hasApiSession" : false,
      "hasEdgeRouterConnection" : false,
      "lastOnlineAt" : null,
      "syncId" : "25b04ead-88df-4210-817a-efacb36c0cd8",
      "syncResourceId" : "5kpEe8cyBMbGrsHkFvzdS",
      "attributes" : [ "#attr2", "#attr1" ],
      "jwt" : null,
      "mfaEnabled" : false,
      "online" : false,
      "managedBy" : "Sync",
      "jwtExpiresAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/dfbee49c-ae8b-462e-b572-ab31005d73f6",
          "title" : "Test Endpoint 1"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e7afac65-1ed8-402d-b297-ce1001f72892",
          "profile" : "parent"
        },
        "auth-policy" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies/540f4cd2-49c8-498e-97c5-e858c7d94c43"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Create Endpoint

POST /v2/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

name

String

true

enrollmentMethod

Object

true

enrollmentMethod.ott

Boolean

true

enrollmentMethod.updb

String

true

enrollmentMethod.ottca

String

true

externalId

String

true

authPolicyId

String

true

attributes

Array[String]

true

syncId

String

true

syncResourceId

String

true

shareRegistration

Object

true

shareRegistration.id

String

true

shareRegistration.toList

Array[String]

true

shareRegistration.ccList

Array[String]

true

shareRegistration.subject

String

true

shareRegistration.type

String

true

Must be one of [Email].

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

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.eyJqdGkiOiJjLV9RWGU2NTRpOURMNjBHS2pFZGFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhkNWVhMTJlLWEzMTEtNGQwYS1hOWZmLTI0Y2ViZGJhNGM2ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg4OSwiZXhwIjoxNzMxNjQxNDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY2ZGMwN2ExLTVmNjgtNDY5NC1hM2IyLWE1MzA5MDAwZmM2M1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.KiZsgQKKHImg2TIWGO07lj6orKDy-kfUkRL4FjQuJQU9oWzZW9GdRpgSCL1SkwQdeWZ5dTDXMK_eogwYtjNqSEtPnkOUu1DmE7LaAzDAg07nK8K5mh57WPaaTTrRYGhDXSnu2M7EBRE2KTrvD82bEigg1Cmye4ShH_qZKh5iDKsjfOnQre2OXTHh3qMh-V1Z0jtpGjWD4lLyCztnSfUDmEykphk3Mj3Jb4h6iWoUHUlKV8G4okCMOSv_dTC3znn4zXw-0XIbB9nmFl7b1jInisFHQUTxsi55UwlKhsIiBb9AgjXG2RzjxYn5zLp8D7LkilMSOe4KGs6pTo0CmjlHug' \
    -d '{"networkId":"7c312f86-4bb6-4717-aa5c-5ebcf601980f","name":"Test endpoint 02","enrollmentMethod":{"ott":true,"updb":null,"ottca":null},"attributes":["#clients"],"shareRegistration":{"id":null,"toList":["fake@example.com"],"ccList":null,"subject":"New Endpoint!!","type":null}}'

Example response

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

{
  "id" : "090830e2-07f4-4a09-a7bd-3e3eff941838",
  "ownerIdentityId" : "8d5ea12e-a311-4d0a-a9ff-24cebdba4c6d",
  "createdBy" : "8d5ea12e-a311-4d0a-a9ff-24cebdba4c6d",
  "createdAt" : "2024-11-15T02:31:29.998216Z",
  "updatedAt" : "2024-11-15T02:31:30.030532Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "7c312f86-4bb6-4717-aa5c-5ebcf601980f",
  "zitiId" : "ziti.id.7rkti77e",
  "name" : "Test endpoint 02",
  "typeId" : "Device",
  "appId" : null,
  "appVersion" : null,
  "branch" : null,
  "revision" : null,
  "type" : null,
  "version" : null,
  "arch" : null,
  "envDomain" : null,
  "envHostname" : null,
  "os" : null,
  "osRelease" : null,
  "osVersion" : null,
  "hasApiSession" : null,
  "hasEdgeRouterConnection" : null,
  "lastOnlineAt" : null,
  "syncId" : null,
  "syncResourceId" : null,
  "attributes" : [ "#clients" ],
  "jwt" : "mock ziti enrollment Jwt",
  "mfaEnabled" : false,
  "online" : false,
  "managedBy" : "Unmanaged",
  "jwtExpiresAt" : "2024-11-15T02:36:30.028991Z",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/090830e2-07f4-4a09-a7bd-3e3eff941838",
      "title" : "Test endpoint 02"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/7c312f86-4bb6-4717-aa5c-5ebcf601980f",
      "profile" : "parent"
    }
  }
}

Patch Endpoint

PATCH /v2/endpoints/{id}

Authorization

This endpoint requires update action on the endpoint resource type.

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

externalId

Object

true

authPolicyId

Object

true

attributes

Array[String]

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/1f55c221-ec48-439f-85cb-d0bfde953390' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ4S3lNdm85YjVnUmdhMkFjZ2hNa093IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk4ZmI0ZGY2LTMzYzYtNDNlYi1iMmY1LWMwMzBhZjQ2NmRkMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg5MCwiZXhwIjoxNzMxNjQxNDkwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU2Y2FhZTIzLWU2MDEtNDBlYi04MTRhLTJjOWRiYmE4MjQ0NVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg5MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.exvhe24EfR37mxM7jjZsnY_A637blInzQgJqfSxpbhp0X-e63pw29ASGu5c1XiN9eZ1fT-QkdeUgQ34rxf57jePU_BS7rLu_4QbkW196NcIk00480AcyvoK4QYRZ8OIN6zpb-QwjjMcOpxdKAZkG4QClyTFj7McEvODtZwCTQb-VsgwunbkD2g1QrX1e0pDJ-q3Zk49Y5SWWtF4Ak9qlmPWY-2oSYCepHo1lcmSNc9cxfjZ91fQCHmw89ZzTdaMbck1jT59GVyEn3Yhc3x8PI4iynv7scvZv0w6e0sE20SiPB4dqndl6Qn6NfLwBwiGa5IDRtVCTkGD1pDEWK3Rjhg' \
    -d '{"name":"Test endpoint 02 updated"}'

Example response

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

{
  "id" : "1f55c221-ec48-439f-85cb-d0bfde953390",
  "ownerIdentityId" : "8a004a12-cdfa-4150-8267-c0d244a5e445",
  "createdBy" : "8a004a12-cdfa-4150-8267-c0d244a5e445",
  "createdAt" : "2024-11-15T02:31:30.794037Z",
  "updatedAt" : "2024-11-15T02:31:30.878392Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "3680a0ec-5904-4d2d-befd-7a65cca2b429",
  "zitiId" : "ziti-id-631",
  "name" : "Test endpoint 02 updated",
  "typeId" : "type",
  "appId" : "appId",
  "appVersion" : "appVersion",
  "branch" : "branch",
  "revision" : "revision",
  "type" : "User",
  "version" : "version",
  "arch" : "arch",
  "envDomain" : "domain",
  "envHostname" : "hostname",
  "os" : "os",
  "osRelease" : "osRelease",
  "osVersion" : "osVersion",
  "hasApiSession" : false,
  "hasEdgeRouterConnection" : false,
  "lastOnlineAt" : null,
  "syncId" : null,
  "syncResourceId" : null,
  "attributes" : [ ],
  "jwt" : null,
  "mfaEnabled" : false,
  "online" : false,
  "managedBy" : "Unmanaged",
  "jwtExpiresAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/1f55c221-ec48-439f-85cb-d0bfde953390",
      "title" : "Test endpoint 02 updated"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3680a0ec-5904-4d2d-befd-7a65cca2b429",
      "profile" : "parent"
    }
  }
}

Delete Endpoint

DELETE /v2/endpoints/{id}

Authorization

This endpoint requires delete action on the endpoint resource type.

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/023da2b0-08f4-4229-8842-a128b0eb8ffd' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyTWtpSVJUbkdRMXdkNXJITk1BOWZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJhNzVkZDY4LTJiNjUtNGQ0Ni04ZGYzLTNiNjNiNDU4MzEyMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg5MSwiZXhwIjoxNzMxNjQxNDkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImEzNDI5MjIwLTQzOGEtNGRhZi05NDAyLTA1NGIxNDc0ZGMwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg5MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.GIcq_v4-2NVVXu4Fmff0gulXZj6yLBZ4oeK4OyOSYnUhHSxzSDxhtRWJbcF2EkzRnIm4lar8veYXCVTocitLlFaOhdUQZN3lLRB5ukAgNmEvnpd2FT4UbatnIK58p0772AJWQrQd_QnCeGOtpCi6Ss10QSW0JnzI97ccEUQaQ7_pV7mxXYkxh62DVuYbTnZ4j67jd7F8mjTvGYONxH2BwKtXGFyJ--GtFUY8P-kGiIXVf_lclvYCvoqQrrsuo113AVqLRIGUS8vAnf6Xk7TjoCwHS0LsA5H-NhWB7yfNurQQ8MVTiXSlF5pTjVH4CNt67dCqovjATb9n3zQwzhElow'

Example response

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

{
  "id" : "023da2b0-08f4-4229-8842-a128b0eb8ffd",
  "ownerIdentityId" : "0837f2eb-0b69-4aa8-8d75-5519e52b3de1",
  "createdBy" : "0837f2eb-0b69-4aa8-8d75-5519e52b3de1",
  "createdAt" : "2024-11-15T02:31:31.261402Z",
  "updatedAt" : "2024-11-15T02:31:31.311483Z",
  "deletedBy" : "ba75dd68-2b65-4d46-8df3-3b63b4583121",
  "deletedAt" : "2024-11-15T02:31:31.311Z",
  "networkId" : "8fa5b652-dd33-4734-b7b6-f3aa76f64e87",
  "zitiId" : "ziti-id-657",
  "name" : "test endpoint",
  "typeId" : "type",
  "appId" : "appId",
  "appVersion" : "appVersion",
  "branch" : "branch",
  "revision" : "revision",
  "type" : "User",
  "version" : "version",
  "arch" : "arch",
  "envDomain" : "domain",
  "envHostname" : "hostname",
  "os" : "os",
  "osRelease" : "osRelease",
  "osVersion" : "osVersion",
  "hasApiSession" : false,
  "hasEdgeRouterConnection" : false,
  "lastOnlineAt" : null,
  "syncId" : null,
  "syncResourceId" : null,
  "attributes" : [ ],
  "jwt" : null,
  "mfaEnabled" : false,
  "online" : false,
  "managedBy" : "Unmanaged",
  "jwtExpiresAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/023da2b0-08f4-4229-8842-a128b0eb8ffd",
      "title" : "test endpoint"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8fa5b652-dd33-4734-b7b6-f3aa76f64e87",
      "profile" : "parent"
    }
  }
}

Edge Routers

Find Edge Routers

GET /v2/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

attributes

Object

true

Deprecated..

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

hostId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

zitiId

String

true

domainName

String

true

alternateDomainName

String

true

name

String

true

productVersion

Object

true

networkId

String

true

jwt

String

true

linkListener

Boolean

true

wssListener

Boolean

true

tunnelerEnabled

Boolean

true

noTraversal

Boolean

true

online

Boolean

true

verified

Boolean

true

enabled

Boolean

true

status

String

true

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

softwareDeploymentStateId

String

true

provider

String

true

Deprecated..

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

region

String

true

Deprecated..

hostSize

String

true

Deprecated..

attributes

Array[String]

true

registration

Object

true

registration.id

String

true

registration.networkId

String

true

registration.edgeRouterId

String

true

registration.zitiId

String

true

registration.registrationAttempts

Integer

true

registration.expiresAt

String

true

registration.issuedAt

String

true

registration.usedAt

String

true

registration.createdAt

String

true

registration.createdBy

String

true

registration.updatedAt

String

true

registration.deletedAt

String

true

registration.deletedBy

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJnSzN1MnF5QWRFbUFMVE5pSGhwTUVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc2NTk1YzY5LTliN2UtNGMzYS05YmUwLTE5MjQ4ZTFmZmUxNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkxNiwiZXhwIjoxNzMxNjQxNTE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU2ODkxNWQ5LTdlZTUtNDI3Yi05OTNlLTFmYzAzNzdkZWVlNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkxNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ap2gi6SF4jeV_8fqJFxHfDrZxUF7YeJ6QBKO1oAoTX1m7CErMh7z1B56BpwvJkhvP4KyPflW6pg2U0SFb5VeKMZkdhkFnq4ihEJIHjJOoNtlH2Iwt4U4qbXcZ_aLwgiB9Wd6xoBa6a-PNd3hbUfvyhvm5jAUDOA7s2st3vW_RUdLbSvHPDqUsUfUroU-IINhAdy6Xf0GJJtZr4MpX3mSulCu4x4_55JF5EP3cyi3dxIZ1GPO0SGn4vFcdCwNLJ1aLXBeD-sk_RavAZkucL6Vtz8YWv_zwaRNuPhkKv9l7yafzBETwvgJ5exLTwVanT_pvk3pT1FYHS4QGNCDeMPuAg'

Example response

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

{
  "_embedded" : {
    "edgeRouterList" : [ {
      "id" : "0fbfbe89-2e87-4229-bd7b-239cd12c6806",
      "hostId" : "f544dcb3-fba3-47a7-803d-124b7ec48713",
      "ownerIdentityId" : "c7990fbd-e221-45cc-b141-ae5e082430df",
      "createdBy" : "c7990fbd-e221-45cc-b141-ae5e082430df",
      "createdAt" : "2024-11-15T02:31:56.400679Z",
      "updatedAt" : "2024-11-15T02:31:56.400679Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "ziti-id-1549",
      "domainName" : null,
      "alternateDomainName" : null,
      "name" : "er-test-1548",
      "productVersion" : "7.3.36",
      "networkId" : "49deef2d-2165-410e-99db-5126bffc7d2b",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "noTraversal" : false,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONED",
      "softwareDeploymentStateId" : null,
      "provider" : "AWS",
      "region" : "us-east-1",
      "hostSize" : "small",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/f544dcb3-fba3-47a7-803d-124b7ec48713"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/0fbfbe89-2e87-4229-bd7b-239cd12c6806",
          "title" : "er-test-1548"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/49deef2d-2165-410e-99db-5126bffc7d2b",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "47e3b09d-0559-4f47-bdac-13955f42a2a4",
      "hostId" : "f926c877-bb07-4e6a-adbd-4555820f5eee",
      "ownerIdentityId" : "656babde-40cf-4312-a540-e41f8c28cd78",
      "createdBy" : "656babde-40cf-4312-a540-e41f8c28cd78",
      "createdAt" : "2024-11-15T02:31:56.397897Z",
      "updatedAt" : "2024-11-15T02:31:56.397897Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "ziti-id-1543",
      "domainName" : null,
      "alternateDomainName" : null,
      "name" : "er-test-1542",
      "productVersion" : "7.3.36",
      "networkId" : "49deef2d-2165-410e-99db-5126bffc7d2b",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "noTraversal" : false,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONED",
      "softwareDeploymentStateId" : null,
      "provider" : "AWS",
      "region" : "us-east-1",
      "hostSize" : "small",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/f926c877-bb07-4e6a-adbd-4555820f5eee"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/47e3b09d-0559-4f47-bdac-13955f42a2a4",
          "title" : "er-test-1542"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/49deef2d-2165-410e-99db-5126bffc7d2b",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "c378e614-cde6-4eaf-8fb4-6ce57fa3caef",
      "hostId" : "2f5856ec-61fc-4115-8e7f-0ec273d1796f",
      "ownerIdentityId" : "8237c3b4-e229-4c78-9826-17e12b622b0e",
      "createdBy" : "8237c3b4-e229-4c78-9826-17e12b622b0e",
      "createdAt" : "2024-11-15T02:31:56.399343Z",
      "updatedAt" : "2024-11-15T02:31:56.399343Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "ziti-id-1546",
      "domainName" : null,
      "alternateDomainName" : null,
      "name" : "er-test-1545",
      "productVersion" : "7.3.36",
      "networkId" : "49deef2d-2165-410e-99db-5126bffc7d2b",
      "jwt" : "fake-jwt",
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "noTraversal" : false,
      "online" : false,
      "verified" : false,
      "status" : "PROVISIONED",
      "softwareDeploymentStateId" : null,
      "provider" : "AWS",
      "region" : "us-east-1",
      "hostSize" : "small",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/2f5856ec-61fc-4115-8e7f-0ec273d1796f"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/c378e614-cde6-4eaf-8fb4-6ce57fa3caef",
          "title" : "er-test-1545"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/49deef2d-2165-410e-99db-5126bffc7d2b",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "e4d45793-231c-4815-9cd4-541f2598fa72",
      "hostId" : "b29bf5e7-f12e-4529-8f24-e8e7789bdf6b",
      "ownerIdentityId" : "5acb0758-cd07-42f5-87d8-955c46ad37c7",
      "createdBy" : "5acb0758-cd07-42f5-87d8-955c46ad37c7",
      "createdAt" : "2024-11-15T02:31:56.396301Z",
      "updatedAt" : "2024-11-15T02:31:56.402467Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "ziti-id-1540",
      "domainName" : null,
      "alternateDomainName" : null,
      "name" : "er-test-1539",
      "productVersion" : "7.3.36",
      "networkId" : "49deef2d-2165-410e-99db-5126bffc7d2b",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "noTraversal" : false,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONED",
      "softwareDeploymentStateId" : "62478410-617d-45fa-9c55-3a1c6a524c86",
      "provider" : "AWS",
      "region" : "us-east-1",
      "hostSize" : "small",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "software-deployment-state" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/62478410-617d-45fa-9c55-3a1c6a524c86"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/b29bf5e7-f12e-4529-8f24-e8e7789bdf6b"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/e4d45793-231c-4815-9cd4-541f2598fa72",
          "title" : "er-test-1539"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/49deef2d-2165-410e-99db-5126bffc7d2b",
          "profile" : "parent"
        },
        "softwareDeploymentState" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/62478410-617d-45fa-9c55-3a1c6a524c86",
          "deprecation" : "Use software-deployment-state link instead"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edge Router

GET /v2/edge-routers/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/90ed6a68-c283-41a5-b707-c448f808e5aa' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvZXFKVmZnT1BmeE1xSktySWprOGZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYxMGYwMTExLTM5ODQtNDMyOS1iZDkyLWRlNzc5Yzc4OTM3YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkxNiwiZXhwIjoxNzMxNjQxNTE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY2OWQ0MzFhLWEzM2YtNDY0Ni04Y2Q3LWNiZWRjNzZjZTE0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkxNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.e_sedBkr_ofchDvfUYPABhb2snxFfE98V2fgu5McKKaVlkfk9nyFAeM19DknunjMcn5YsDr27OTwu8JyW5r13V714RnfQpzvXbIaKrYTWwffw56NXtBVJEQAzEZ3JqpXMBq4f7rb9ytSDdzM8cr_d0wq9lpU6YNMf-j7JKkybhCDiHx7QSUTygVzOITBnQdQ_NkQblTpxnj8vq_m83vy6pOCrYJLB1kiKkP1aA9shkeXDl7wZ7ZxZxBWVQ2KubhriA-WTFHXfmVmAqYJp5cCqo8U-skqLDnrTWnY07s5H-ldeSFOOtqN1mozA-3Sv7U_tCA66RK61pT_0xzw7kZV5Q'

Example response

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

{
  "id" : "90ed6a68-c283-41a5-b707-c448f808e5aa",
  "hostId" : "d5a63659-2205-4bd3-ae5d-ac1be8b27623",
  "ownerIdentityId" : "9fe5269d-2a5b-4b5d-9975-f231508da54d",
  "createdBy" : "9fe5269d-2a5b-4b5d-9975-f231508da54d",
  "createdAt" : "2024-11-15T02:31:56.950266Z",
  "updatedAt" : "2024-11-15T02:31:56.963247Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "ziti-id-1597",
  "domainName" : null,
  "alternateDomainName" : null,
  "name" : "er-test-1596",
  "productVersion" : "7.3.36",
  "networkId" : "892d9d97-dbe0-49d7-8d7a-7303b8cdabe8",
  "jwt" : null,
  "linkListener" : true,
  "tunnelerEnabled" : true,
  "noTraversal" : false,
  "online" : false,
  "verified" : true,
  "status" : "PROVISIONED",
  "softwareDeploymentStateId" : "137f275c-5deb-4472-a78d-8fef909166e0",
  "provider" : "AWS",
  "region" : "us-east-1",
  "hostSize" : "small",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/137f275c-5deb-4472-a78d-8fef909166e0"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/d5a63659-2205-4bd3-ae5d-ac1be8b27623"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/90ed6a68-c283-41a5-b707-c448f808e5aa",
      "title" : "er-test-1596"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/892d9d97-dbe0-49d7-8d7a-7303b8cdabe8",
      "profile" : "parent"
    },
    "softwareDeploymentState" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/137f275c-5deb-4472-a78d-8fef909166e0",
      "deprecation" : "Use software-deployment-state link instead"
    }
  }
}

Create Edge Router

POST /v2/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

networkId

String

true

zitiId

String

true

provider

String

true

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

region

String

true

hostSize

String

true

linkListener

Boolean

true

wssListener

Boolean

true

tunnelerEnabled

Boolean

true

noTraversal

Boolean

true

enabled

Boolean

true

alternateDomainName

String

true

attributes

Array[String]

true

endpointAttributes

Array[String]

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

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.eyJqdGkiOiJyc0ZoSVpidG9hQXNPaHpkWTRuSTR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYxNjZjZThkLTY0M2MtNDFiNS1hNjM3LTUzMWI0Y2U0MDQ1YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkxMCwiZXhwIjoxNzMxNjQxNTEwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhjZDU0ZGMxLTI2MGQtNDlhZC1iYmNjLWIyYTcwYmU2ZDk3MVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkxMH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.O9mPaBU784OPfRPOGQ5AKT8P12SwScxOsHwf44VdvV6Eqxnl6SbUJzMmRUbmT0BYGi7Sjziy3xNIw2NjZBLZOOVAR3ewpFYWa8Hi6hM0YCWH2EITxyqCICXYjh16SrDtvhZy2vJ_-BqoDmct0GrHKq0ChgKskxzCwhOe3H7_RTL8hjd0whc1JiXtxnHBUDh7besCmgek5hkihAE5HvjrjoJStayFP7-Z-_gsqOKDgpLYOKmCq1zWDjEOqf6cOnNT59Wg74jc_Ng7jHadky-PQflTPigk4aLy1V4_A4BJ_ujyuhVjbF9wqx8K3tIOGt7_WPkSkrKC_W89mJCoZrfAbg' \
    -d '{"name":"Test edge router 1731637910","networkId":"136751ef-f80d-4d83-afe5-d1deefd7ac4a","provider":"AWS","region":"us-east-1","tunnelerEnabled":null,"noTraversal":null,"attributes":[]}'

Example response

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

{
  "id" : "4f1fb101-60fd-4770-a23a-e7f40b1e0309",
  "hostId" : null,
  "ownerIdentityId" : "6166ce8d-643c-41b5-a637-531b4ce4045a",
  "createdBy" : "6166ce8d-643c-41b5-a637-531b4ce4045a",
  "createdAt" : "2024-11-15T02:31:50.690139Z",
  "updatedAt" : "2024-11-15T02:31:50.693646Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : null,
  "domainName" : null,
  "alternateDomainName" : null,
  "name" : "Test edge router 1731637910",
  "productVersion" : "7.3.36",
  "networkId" : "136751ef-f80d-4d83-afe5-d1deefd7ac4a",
  "jwt" : null,
  "linkListener" : false,
  "tunnelerEnabled" : false,
  "noTraversal" : false,
  "online" : false,
  "verified" : false,
  "status" : "PROVISIONING",
  "softwareDeploymentStateId" : "a90eb7f5-416e-4edd-aa0c-d8dfa6095a31",
  "provider" : null,
  "region" : null,
  "hostSize" : null,
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/a90eb7f5-416e-4edd-aa0c-d8dfa6095a31"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/4f1fb101-60fd-4770-a23a-e7f40b1e0309",
      "title" : "Test edge router 1731637910"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/136751ef-f80d-4d83-afe5-d1deefd7ac4a",
      "profile" : "parent"
    },
    "softwareDeploymentState" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/a90eb7f5-416e-4edd-aa0c-d8dfa6095a31",
      "deprecation" : "Use software-deployment-state link instead"
    }
  }
}

Partial Update Edge Router

PATCH /v2/edge-routers/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

noTraversal

Boolean

true

linkListener

Boolean

true

enabled

Boolean

true

attributes

Array[String]

true

empty

Boolean

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/3888c12a-3866-4c07-9e7d-86676ad54b55' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvLVRNbEtpaFQ3YjV3MXR2MFhTRVpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFhNWMzN2E5LTQyNGUtNDI3NC1iYjQ1LWFmMWQ4N2ZkZTg5NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkxNiwiZXhwIjoxNzMxNjQxNTE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdiMjMyMmI1LWQxOTgtNGVlYi05NTA3LTFlM2YxZDlhMzhmNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkxNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.BoELMIctok6I3nXzHfeujAKZT20J5Z9A2DytUYbwlXPjqHp6ZYQUzDccYHLlQmLeqGj1_eKL2avnNGDdFjB7hJcMSEYARHNIUYMW3LXcYsP0at-CpD5ly1HeuFmrqjats9y1Nu_8TGcxw1QcK0brd90TtBcawsrpjbmC9n7NOEFzRwTuUhzSwfe13-tXbs7IcfSQxvxdPClQwXQFuJHLwDW8ndbwRPDBqLNxNtV7Xb1Z-QTTH4kSgSkz78Ukc-xuupI7khepYDpXCUlQiqSi3M5Ipotg1lyzyA5PAoRMxwzm2Qee8o3VkTQ6qFry4xhKzuBOEib489RKcyrqB9dQ-Q' \
    -d '{"name":"Updated name","noTraversal":null,"enabled":null,"empty":false}'

Example response

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

{
  "id" : "3888c12a-3866-4c07-9e7d-86676ad54b55",
  "hostId" : "bf1242f8-952b-4640-90d1-6827381dfd10",
  "ownerIdentityId" : "59f8afe5-b410-4458-a52d-d1bd0070fd61",
  "createdBy" : "59f8afe5-b410-4458-a52d-d1bd0070fd61",
  "createdAt" : "2024-11-15T02:31:56.750082Z",
  "updatedAt" : "2024-11-15T02:31:56.823205Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "ziti-id-1578",
  "domainName" : null,
  "alternateDomainName" : null,
  "name" : "Updated name",
  "productVersion" : "7.3.36",
  "networkId" : "9f9e851a-3cb5-4bcd-802f-08315a90124d",
  "jwt" : null,
  "linkListener" : true,
  "tunnelerEnabled" : true,
  "noTraversal" : false,
  "online" : false,
  "verified" : true,
  "status" : "PROVISIONED",
  "softwareDeploymentStateId" : "cefdbff1-1ea4-402b-88f6-fdb290332c84",
  "provider" : "AWS",
  "region" : "us-east-1",
  "hostSize" : "small",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/cefdbff1-1ea4-402b-88f6-fdb290332c84"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/bf1242f8-952b-4640-90d1-6827381dfd10"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/3888c12a-3866-4c07-9e7d-86676ad54b55",
      "title" : "Updated name"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9f9e851a-3cb5-4bcd-802f-08315a90124d",
      "profile" : "parent"
    },
    "softwareDeploymentState" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/cefdbff1-1ea4-402b-88f6-fdb290332c84",
      "deprecation" : "Use software-deployment-state link instead"
    }
  }
}

Delete Edge Router

DELETE /v2/edge-routers/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/b4ae5b85-ce68-4659-8a13-08bc3956cf0d' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJzT3A5RGpZaW9mbFNwaUZxSzE3Y19RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJmYTJmNDU4LTQ5MWYtNDZkMS1hNDI0LTE3OTA5MTJmMGE1MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkxNSwiZXhwIjoxNzMxNjQxNTE1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjEyYTkyYjIyLWRmZDMtNGQ2OC04NzMxLTllYTYxODc5Y2NiZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkxNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.QCZkWDdiw_y4inF47BHC728w0BI_3SV0SbaZINACqMelaCDVI_HVJ9kDg3u2zigi9-7uzueinyYqJEycnooh7zhym8WcMwrf2EzxfWkcTy3h_7esaEcqGAdjQ7aB6kePEBj-lXv5wf3mnSkW6ZIA7TjyCfDwVtKMIRjXV3eDMvLWv4Pi_GWiRHtHxXHuB-eoHsK1xASjyN9Z--kqtvJ28uamB2yT6OCR5U7UP7gBTOxWiUWWjcIPVZ8AHiFvW6XFiLTQbnBv68GZpC50XxNRYc-0zj8UUA0Xxv26wUj4HQHQtCpej0pz4-hbmwpR046P5fbX8vWekbDj5-L0zuNC2Q'

Example response

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

{
  "id" : "b4ae5b85-ce68-4659-8a13-08bc3956cf0d",
  "hostId" : "d96633ac-1779-4347-8792-360374f63abe",
  "ownerIdentityId" : "11d3913a-7c04-4804-a0b5-e17b99e8feca",
  "createdBy" : "11d3913a-7c04-4804-a0b5-e17b99e8feca",
  "createdAt" : "2024-11-15T02:31:55.137120Z",
  "updatedAt" : "2024-11-15T02:31:55.183890Z",
  "deletedBy" : "bfa2f458-491f-46d1-a424-1790912f0a50",
  "deletedAt" : null,
  "zitiId" : "ziti-id-1399",
  "domainName" : null,
  "alternateDomainName" : null,
  "name" : "er-test-1398",
  "productVersion" : "7.3.36",
  "networkId" : "45bdac64-5b61-4c42-aabf-ce0a5088e6b1",
  "jwt" : null,
  "linkListener" : true,
  "tunnelerEnabled" : true,
  "noTraversal" : false,
  "online" : false,
  "verified" : true,
  "status" : "DELETING",
  "softwareDeploymentStateId" : null,
  "provider" : "AWS",
  "region" : "us-east-1",
  "hostSize" : "small",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/d96633ac-1779-4347-8792-360374f63abe"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/b4ae5b85-ce68-4659-8a13-08bc3956cf0d",
      "title" : "er-test-1398"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/45bdac64-5b61-4c42-aabf-ce0a5088e6b1",
      "profile" : "parent"
    }
  }
}

Sync Edge Router

PATCH /v2/edge-routers/{id}/sync

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/6358ff35-9159-47e4-866d-0ff27d9558c0/sync' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1UVVWd3UzakpwU25pb2hGXzdCYTBRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk3NzVmNzc1LTc3MDAtNGI0ZS1iYmIwLWY0NmFkYTkyOTM4YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkxNCwiZXhwIjoxNzMxNjQxNTE0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ4YTYwYWMxLTg4NzEtNGFjYS05ZjhlLTBlZTBjN2RkMTIwZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkxNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jSl2i3H7z8r2jZ1SiSeolHrwf5NKfOgHQxJgzb8iHzbo5pPD8xG6LQ___1BOztrG01TESiYTQvmKPvTN9RFyzRu4dUIrMOQ0kmrA-rKVLl8BodHrerfL6tiiVk4ZwT4wKRnxv3mc1LrjkVBK7Wb20rkmISufoqbX6uCxFtriyIjZTNltqMDH4uPhjfcEE2DDj1NGAkzfWOZfulX5ALkQC5bqJTaqNh6U5guEie_bg9ac4LNreeTond-YVpg83KiH9hkdRe5qEXsV8-ADqt3ihgSORIiC_B5KTNieO2-KhJsDBNZREclN48WDzlSYn8G7inJFDUz-27-iRU9sqHxqUA'

Example response

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

{
  "id" : "6358ff35-9159-47e4-866d-0ff27d9558c0",
  "hostId" : "1cffe3da-1194-465a-9304-3b844070a1a2",
  "ownerIdentityId" : "e752031d-942b-41d9-a067-5a8f9fb4cffc",
  "createdBy" : "e752031d-942b-41d9-a067-5a8f9fb4cffc",
  "createdAt" : "2024-11-15T02:31:54.739027Z",
  "updatedAt" : "2024-11-15T02:31:54.767787Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "ziti-id-1320",
  "domainName" : null,
  "alternateDomainName" : null,
  "name" : "er-test-1319",
  "productVersion" : "7.3.36",
  "networkId" : "bd598050-9696-4418-b4c7-e88f7b2d0edd",
  "jwt" : null,
  "linkListener" : true,
  "tunnelerEnabled" : true,
  "noTraversal" : false,
  "online" : true,
  "verified" : false,
  "status" : "PROVISIONED",
  "softwareDeploymentStateId" : "2e304cd0-a2d1-43a8-844f-6bf48ea3b9fc",
  "provider" : "AWS",
  "region" : "us-east-1",
  "hostSize" : "small",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/2e304cd0-a2d1-43a8-844f-6bf48ea3b9fc"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/1cffe3da-1194-465a-9304-3b844070a1a2"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/6358ff35-9159-47e4-866d-0ff27d9558c0",
      "title" : "er-test-1319"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bd598050-9696-4418-b4c7-e88f7b2d0edd",
      "profile" : "parent"
    }
  }
}

Edge Router Policies

Find Edge Router Policies

GET /v2/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.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

zitiId

String

true

name

String

true

isSystem

Boolean

true

semantic

String

true

Must be one of [AllOf, AnyOf].

endpointAttributes

Array[String]

true

edgeRouterAttributes

Array[String]

true

exclusiveType

String

true

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

exclusiveToId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZWFFBcGM0WDZkNXNzelJfMWN3N2J3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNjM2U5YmUyLWYzNWUtNGZjYS04OTRiLWU0MGU3MjI4MDViYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA1NCwiZXhwIjoxNzMxNjQxNjU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFmYjc5MTQyLWVlZjQtNGUyMy05NGZhLTQ4ODE0NjgwMDRhNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA1NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.oCWML_ClLHtCnvpeRTZlOzbaTg5atjkw8nAvhBGbd9PsEHE8Rtu6FmR7O7FLMO8lp6yHnBjNcUM049b9Qn03t04uyzTQ0QJNGo0JUE4_DCCQoFMwUpr3X3C1AB6w3Xx_Sg3OPMDyt4IBGJ0bmQjsnnX1Wh1ASZjYwvKFqu-bgdASy-plh95gc-NoJES5zFt8aj43-gJZuT-cj2N8SYjQwat45IbqSvJ12uWZh_8tgd4lQ-9sUEj-NraDRCLyGbV8irNl5bYQaVuoUl9Zi1eyCcSUMDBwjcPkfMzF1S8RlKkc4utF3YefVJF9snqqMwfOiNzuN0Ball44xGWEwYhBsQ'

Example response

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

{
  "_embedded" : {
    "edgeRouterPolicyList" : [ {
      "id" : "8bfa6e60-29ef-4191-94e2-b9fdc1e1bf54",
      "networkId" : "d7d53017-1e17-45a7-b164-9a212de95e6e",
      "zitiId" : "2ee1434f-6992-4cf1-99a7-a55899845b17",
      "name" : "A2dOxs5RlasrN9Eh2_3gv",
      "isSystem" : false,
      "semantic" : "AnyOf",
      "endpointAttributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "9770b895-dd61-4d77-bafa-585bb497c44e",
      "createdBy" : "9770b895-dd61-4d77-bafa-585bb497c44e",
      "createdAt" : "2024-11-15T02:34:14.066219Z",
      "updatedAt" : "2024-11-15T02:34:14.066219Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/8bfa6e60-29ef-4191-94e2-b9fdc1e1bf54",
          "title" : "A2dOxs5RlasrN9Eh2_3gv"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d7d53017-1e17-45a7-b164-9a212de95e6e",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edge Router Policy

GET /v2/edge-router-policies/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/b6de5ce6-d92c-49b2-a8d0-83ceb3e5e515' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJsMWlIaTdYNGMxNW5mSFlFRDVYT0JBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQwYzRlYWZjLTdkMzMtNDIxNC05ZGYyLWFkNTUwNGU0YzEyMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA1NCwiZXhwIjoxNzMxNjQxNjU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImViYzYxZDEyLWRmNTYtNDQxMC1iMmRiLWJhYmRmMWNiODFlY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA1NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Ho6U1Mn9TgmdbUyAK-3WUp2QmzmRA4unWa_Bt3wCnEPlwz0O4JTpkfKTl2wwaTRVqqJd7kMTHNtDv_JlEb5l7iUpfP-LcdHchaWEwJmER3uPMEFdKCZVgcRmloqcDYcom47EwxWoByv7NhojOikxnLBlwQChQEKmOVam0hTbNEMOC4oYM3q_pHOnQ_5Jaiu3PDYYO_LOPfgjVmpt34wpkVdOAKSjW1UVK6qWsXltqJnNfuhLdT3NSMrAdS_dyNavl2mR45068Wb6qLHXpFZqTeqWkeNmBmTC1MbYcyOwDQcf6EkskVsnNVTX7S1hDoacBfm5UMmG2XjlJFvjYW1ciA'

Example response

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

{
  "id" : "b6de5ce6-d92c-49b2-a8d0-83ceb3e5e515",
  "networkId" : "ce0415cf-18f0-413e-be3a-c36027f24d46",
  "zitiId" : "6f15095c-11c3-40e9-9c83-e655e44fce55",
  "name" : "erp-3273",
  "isSystem" : false,
  "semantic" : "AnyOf",
  "endpointAttributes" : [ ],
  "edgeRouterAttributes" : [ ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "4293812b-1379-4afe-a326-ad2a4d7ddb97",
  "createdBy" : "4293812b-1379-4afe-a326-ad2a4d7ddb97",
  "createdAt" : "2024-11-15T02:34:14.187035Z",
  "updatedAt" : "2024-11-15T02:34:14.187035Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/b6de5ce6-d92c-49b2-a8d0-83ceb3e5e515",
      "title" : "erp-3273"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ce0415cf-18f0-413e-be3a-c36027f24d46",
      "profile" : "parent"
    }
  }
}

Create Edge Router Policy

POST /v2/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

networkId

String

true

semantic

String

true

Must be one of [AllOf, AnyOf].

endpointAttributes

Array[String]

true

edgeRouterAttributes

Array[String]

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

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.eyJqdGkiOiJwXzNGMlA5dVJoUXhNM0M5b1NrUVhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVjMjJlNDJjLTVkOTYtNGVhMC1iYmI2LTdhMzI0NGRiOGE4ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA1NCwiZXhwIjoxNzMxNjQxNjU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjYyMDU2NTlkLTU0MTQtNDUzNy04ZmJlLWFjZDAxNGYxYTMxOVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA1NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.sloiffVeklBctGEGC7tBh3iVrtkWr4zbV88ddRLU5W02sJH43EOMt43I8_4pVRbcV7fPcnfp3RhGyybyUVwtavRMttEmgu3yQ8G9qYe3-M6UyDBLiDox09rfI5nSA1B388xAFknO5aXJq5D7Bzu2cJv6S2-5zVrBuB4-82Lf20mnlHAu7cKnP9dhg2rtkn-nSrtMUN4eVzCVELLXd1Hy9iD8cZCOvxb9fyVmXWL7OnTr2JQ2G2ona9bqiI2qTX9sa2T0-eCAbsqqUK2CJlK-531cYmWApUZOVUxhdiRzSOFBfhYGvUYysDb3iaqKezIZgePBdBGb6U1XGsqL-klPxg' \
    -d '{"name":"Test edge router policy 1731638054","networkId":"1dc59f4c-eb46-4637-9331-c9956a68bb74","semantic":"AnyOf","endpointAttributes":["#topclients"],"edgeRouterAttributes":["#westrouters"]}'

Example response

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

{
  "id" : "3f85c267-dec3-46c7-a162-60be9029e091",
  "networkId" : "1dc59f4c-eb46-4637-9331-c9956a68bb74",
  "zitiId" : "ziti.id.9uz5vde8",
  "name" : "Test edge router policy 1731638054",
  "isSystem" : false,
  "semantic" : "AnyOf",
  "endpointAttributes" : [ "#topclients" ],
  "edgeRouterAttributes" : [ "#westrouters" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "5c22e42c-5d96-4ea0-bbb6-7a3244db8a8e",
  "createdBy" : "5c22e42c-5d96-4ea0-bbb6-7a3244db8a8e",
  "createdAt" : "2024-11-15T02:34:14.149016Z",
  "updatedAt" : "2024-11-15T02:34:14.157227Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/3f85c267-dec3-46c7-a162-60be9029e091",
      "title" : "Test edge router policy 1731638054"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1dc59f4c-eb46-4637-9331-c9956a68bb74",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/2ada7b6f-6bca-4a14-be27-4fdacf429a8d",
      "title" : "Create EdgeRouterPolicy",
      "profile" : "meta"
    }
  }
}

Update Edge Router Policy

PUT /v2/edge-router-policies/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

semantic

String

true

Must be one of [AllOf, AnyOf].

endpointAttributes

Array[String]

true

edgeRouterAttributes

Array[String]

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/cea80ed4-9e86-4400-b4c3-894761c33d91' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiItLXF1eEdWX2d6VUt0QkVHaDlkQXJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJiNmFmY2I2LTc1YjQtNDk4Ni04NGY2LTYwNDE4MjNmYjhhOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA1NCwiZXhwIjoxNzMxNjQxNjU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBiMzk5NzYyLWFjOTItNGMzOC1iZGU5LTA4ODI1MmM1YWI4NVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA1NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.UIOCOUtHxg89teQn4iXpS-82-Cgwk0-Woey2dRwB4AbBi6HV3ivGzQPsbNo1qTzNzK8wwSTRh1ExGH6GIxWuhEhdcoHvYutubaTeHNI28EJRQBrIqkTGHrrObVWxNBo_umEUxBREoAPv5s5l7KbUxSVMO7dXbYrZRTMgcaRn7RTc7oNQEs8YrY5jYO5qYzHYnFqRSzCjM8thRKMFPl5fxM67Wd94Od1RPFoC7THR18IY31GI2h0j2QP1PrfwPeCnD8LwN3Pm2JkQNICdZE5oi47KQDg1Sf404NO3cS5R-0Cl-SXyQDPcRuZzHoPm5lLevvsAteqZhbQnGZuglOT_Qw' \
    -d '{"name":"Updated edge router policy name","semantic":"AnyOf","endpointAttributes":["#topclients"],"edgeRouterAttributes":["#westrouters"]}'

Example response

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

{
  "id" : "cea80ed4-9e86-4400-b4c3-894761c33d91",
  "networkId" : "440a0722-f5a9-48d1-af5b-311c3587cb27",
  "zitiId" : "ziti.id.9v4uofxs",
  "name" : "Updated edge router policy name",
  "isSystem" : false,
  "semantic" : "AnyOf",
  "endpointAttributes" : [ "#topclients" ],
  "edgeRouterAttributes" : [ "#westrouters" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "8105e280-fe06-431e-b4ce-d14675ce27d7",
  "createdBy" : "8105e280-fe06-431e-b4ce-d14675ce27d7",
  "createdAt" : "2024-11-15T02:34:14.494551Z",
  "updatedAt" : "2024-11-15T02:34:14.525337Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/cea80ed4-9e86-4400-b4c3-894761c33d91",
      "title" : "Updated edge router policy name"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/440a0722-f5a9-48d1-af5b-311c3587cb27",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/aef85670-4d7e-418c-bf56-935a7b999b0a",
      "title" : "Update EdgeRouterPolicy",
      "profile" : "meta"
    }
  }
}

Delete Edge Router Policy

DELETE /v2/edge-router-policies/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/b0bb3b5c-c384-4e2c-bc56-67f5eb1c49fd' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJVYVBvaVhIU3N1bEtHZjlIbzlDbUR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ1MWY0NzRkLWY0YjUtNDc3NS05M2Q4LWNiMzk1ZTEyNTM3NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA1NCwiZXhwIjoxNzMxNjQxNjU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImEzYTExZTg1LWFhZDEtNDVjYi05OTI0LWJjYjQ5MDA0YTY0YlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA1NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Vy9D3sQB3WqvXl43_bI1QT4vrORI2XNJ-8v9560CJrLAi65gQiCFEXj1UttpTE6FX-xJ8gjlLXl6TXxsn9xGAaANaz_yKEE2_bk7DlqYpwBdjt51hzFwNUnDUdq2ynimcCFGCnxNFfBs_sivY7aDAT39jCwAQ-YoQfOlaR1JIwXHhyAvYl4NZB2jO2s9kCsX5VnOt06OPtakahlLt1gu4daIL4Fj8f8gjGSit4bSg7p_-22ot0LUsul7mG_g6wMqxMOko2TAa3LswpZjoDQfOvf1DMkvaVie9mOGR90ZEv9OlFHx-oyQi_NL9xqLtZmm9bG072ivghVQ-7kdirqNMA'

Example response

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

{
  "id" : "b0bb3b5c-c384-4e2c-bc56-67f5eb1c49fd",
  "networkId" : "dae7d5af-7382-4dba-9dec-f58362ebe828",
  "zitiId" : "ziti.id.9v2so62f",
  "name" : "Test edge router policy 1731638054",
  "isSystem" : false,
  "semantic" : "AnyOf",
  "endpointAttributes" : [ ],
  "edgeRouterAttributes" : [ ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "9609adc4-405b-4f1c-8a4a-47842c9b480d",
  "createdBy" : "9609adc4-405b-4f1c-8a4a-47842c9b480d",
  "createdAt" : "2024-11-15T02:34:14.368759Z",
  "updatedAt" : "2024-11-15T02:34:14.406337Z",
  "deletedBy" : "451f474d-f4b5-4775-93d8-cb395e125377",
  "deletedAt" : "2024-11-15T02:34:14.406Z",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/b0bb3b5c-c384-4e2c-bc56-67f5eb1c49fd",
      "title" : "Test edge router policy 1731638054"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dae7d5af-7382-4dba-9dec-f58362ebe828",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/9d94eec0-ab6c-45a1-ae11-f7e320019f49",
      "title" : "Delete EdgeRouterPolicy",
      "profile" : "meta"
    }
  }
}

Find Edge Router Policies

GET /v2/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.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

zitiId

String

true

name

String

true

isSystem

Boolean

true

semantic

String

true

Must be one of [AllOf, AnyOf].

endpointAttributes

Array[String]

true

edgeRouterAttributes

Array[String]

true

exclusiveType

String

true

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

exclusiveToId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZS1cxRkdXR21LMGZuQTJyNjV3MDZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcyMTZjOWE3LWZhMTgtNDViYy04MDdjLTA4NmFiZTNmZWU5MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkwOSwiZXhwIjoxNzMxNjQxNTA5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImEwYzE4OWEyLTRiYzItNGU3MC04NGY0LTAyNzAxNmQxY2M3YVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkwOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.lkjxoU2I_-0fU1UkmOPry51-4tQGp_QvgczhWRz2rErao00Mhr6P9X5GyjI1eILiHGYMdXUFyJw27aD1P5pjVT5tF8qlwcIDpd4vK07iu9qPX8DpkcWGZIOdOp4Zydh7-FfzV3joy2gJcCscTl5c2UV1_pzQkOEN-uj6xcCm3nGqgTYMJ6A-_6uOGvln9baVo0HOT6EKgdZoA7v_rfDzaNI45OPbCp4fhNedBIp4KUHPJ9Q0n4wFV099QWuiTKPdsvnTV2NteE8aBlqTfzbWJS4BGv2NTY_t880-uhZwBLgRqSAgmQZjjAkPljYyDuMuHPpqYAUdgFhoLtIqcRAFMA'

Example response

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

{
  "_embedded" : {
    "edgeRouterPolicyList" : [ {
      "id" : "712fe55d-4a4b-497b-aafb-094a4d226291",
      "networkId" : "96e05807-4cba-47ba-b3f7-7a2a6778ed98",
      "zitiId" : "f374c003-569a-40db-92c4-576dc293e4c4",
      "name" : "Find Test Edge Router Policy 1",
      "isSystem" : false,
      "semantic" : "AnyOf",
      "endpointAttributes" : [ "#epAttr2", "#epAttr1" ],
      "edgeRouterAttributes" : [ "#erAttr2", "#erAttr1" ],
      "exclusiveType" : "edge-router",
      "exclusiveToId" : "ce608b89-e1ce-4826-a776-a2020359ba0c",
      "ownerIdentityId" : "38f2ab22-a663-433f-af7f-cd1077b6bccb",
      "createdBy" : "38f2ab22-a663-433f-af7f-cd1077b6bccb",
      "createdAt" : "2024-11-15T02:31:49.674354Z",
      "updatedAt" : "2024-11-15T02:31:49.674354Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/712fe55d-4a4b-497b-aafb-094a4d226291",
          "title" : "Find Test Edge Router Policy 1"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/96e05807-4cba-47ba-b3f7-7a2a6778ed98",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "d71618d5-1873-409a-b377-88c0d2e7986d",
      "networkId" : "96e05807-4cba-47ba-b3f7-7a2a6778ed98",
      "zitiId" : "5d132314-29f7-4899-92ff-34c9bcfbc32f",
      "name" : "Find Test Edge Router Policy 2",
      "isSystem" : true,
      "semantic" : "AllOf",
      "endpointAttributes" : [ "#epAttr1", "#attr3" ],
      "edgeRouterAttributes" : [ "#erAttr1" ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "38f2ab22-a663-433f-af7f-cd1077b6bccb",
      "createdBy" : "38f2ab22-a663-433f-af7f-cd1077b6bccb",
      "createdAt" : "2024-11-15T02:31:49.683051Z",
      "updatedAt" : "2024-11-15T02:31:49.683051Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/d71618d5-1873-409a-b377-88c0d2e7986d",
          "title" : "Find Test Edge Router Policy 2"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/96e05807-4cba-47ba-b3f7-7a2a6778ed98",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Services

Find Services

GET /v2/services

Authorization

This endpoint requires read action on the service resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

zitiId

String

true

name

String

true

encryptionRequired

Boolean

true

terminatorStrategy

String

true

attributes

Array[String]

true

modelType

String

true

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

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

configIdByConfigTypeId

Map

true

model

Object

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJWZGNfb3BmMEszTzNVNVRwMEplR0JRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIwMjEwYzZiLWRmN2YtNDU1NS1iNDcyLWQ2MzQ5YjI1NTkxOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg2OSwiZXhwIjoxNzMxNjQxNDY5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdmYWUyYTU4LTEzMTItNGQxNC1iODVmLWI4ZTQ5OGQwZDcyMFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.RZWHToCkCEK_vVsLoHyBxMPUP_1chrUTeRMucDRMM2ZBNiTkBFdASeEOSzEw0tke2iZOJ79ot_r1Bxv-IhV5-SpSX-dkM-VEphlIgMqMTZj1alM18IEaexZyzqMU7hFE3KSTIf14c4sznOsSljryRhnIzs7jPVUUcpR0H9Z4ZIQwUIWQdVHVYDJ6ig5lyvq6xOIT8oSMVqbOgBev-_H8WwtlIcuiwNM0DPWTLhMdWUenlWdX323iwzOuiGVLzpjzLpmwkhtpoNdA37VE48VvbF0G39r9G_SiF7zhyUv6hzZdWrthLxjCPUipbJ9oVc80k7TGwizUGBuqMQaMiyZXLA'

Example response

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

{
  "_embedded" : {
    "serviceList" : [ {
      "id" : "47e89b7c-13be-471c-b82f-e7a19249adf0",
      "networkId" : "615da4a0-976a-47de-8f58-8c8b78871437",
      "zitiId" : "ziti-id-91",
      "name" : "Find Service 2",
      "encryptionRequired" : false,
      "terminatorStrategy" : "sticky",
      "attributes" : [ "#attr3", "#attr1" ],
      "modelType" : "Generic",
      "ownerIdentityId" : "abb2268d-0629-4246-8024-832848ba973d",
      "createdBy" : "abb2268d-0629-4246-8024-832848ba973d",
      "createdAt" : "2024-11-15T02:31:09.038479Z",
      "updatedAt" : "2024-11-15T02:31:09.038479Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "model" : {
        "configTypes" : [ ],
        "configs" : [ ],
        "terminators" : [ ],
        "serviceEdgeRouterPolicy" : null,
        "servicePolicy" : null
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/47e89b7c-13be-471c-b82f-e7a19249adf0",
          "title" : "Find Service 2"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/615da4a0-976a-47de-8f58-8c8b78871437",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "c70053be-9002-4496-a8e1-4ef704c6f24b",
      "networkId" : "615da4a0-976a-47de-8f58-8c8b78871437",
      "zitiId" : "ziti-id-89",
      "name" : "Find Service 1",
      "encryptionRequired" : true,
      "terminatorStrategy" : "sticky",
      "attributes" : [ "#attr2", "#attr1" ],
      "modelType" : "ZSSH",
      "ownerIdentityId" : "abb2268d-0629-4246-8024-832848ba973d",
      "createdBy" : "abb2268d-0629-4246-8024-832848ba973d",
      "createdAt" : "2024-11-15T02:31:09.031679Z",
      "updatedAt" : "2024-11-15T02:31:09.031679Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "configIdByConfigTypeId" : { },
      "model" : {
        "bindEndpointAttributes" : [ "all" ],
        "edgeRouterAttributes" : [ "all" ]
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/c70053be-9002-4496-a8e1-4ef704c6f24b",
          "title" : "Find Service 1"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/615da4a0-976a-47de-8f58-8c8b78871437",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Service

GET /v2/services/{id}

Authorization

This endpoint requires read action on the service resource type.

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services/f66d598c-95dd-49e0-b63c-d90201e1cebb' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI4Vmk3cVBGemJUdjFGdmVJOHV6MklnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQyYjMxMDM5LTYxYTAtNDlkZC1iMTU5LWY2NjJhNzZiYWQyOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk4MSwiZXhwIjoxNzMxNjQxNTgxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk2MDI3YThhLWE4YmQtNDE0MC05YjI2LTU2ZWU3M2EzYzUxNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk4MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.FhG9ZuLR66AxxXhygG43vHm4BeB0FSexpiGIyi11BGfG61sz7B66WGL6aNCzF4ZF8UbEl5wsnc9CaMsJ-dUkuFiZxaNvJSsqzUbGI-ZJCgDdFufgn28FmuvAV4otamTiaaRz9ZuVI0yfvNGJLXtYt7Jf2HsLA_UljKykbUXT4J-dmgUx8waqshQMzQiQwEGCyCLGH6YT56Z0BufiS-DQi61XJGYDi-T78CzJUS1Tw7NHL3NALp6JU_DwY5lXxuxgZB_u7xqvJSP6I_-4z6ToegcUzpVcbxlmot7u_ad9KrVsIPKytYdbaDgwIUri2g5UjZ6hMAIgoKhgmypHKOYLlQ'

Example response

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

{
  "id" : "f66d598c-95dd-49e0-b63c-d90201e1cebb",
  "networkId" : "9b4d1a19-4e09-47fb-8f1f-8219d471e373",
  "zitiId" : "ziti.id.8xggrzku",
  "name" : "My Service 8vky1qbr",
  "encryptionRequired" : true,
  "terminatorStrategy" : "sticky",
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "modelType" : "AdvancedTunnelerToEndpoint",
  "ownerIdentityId" : "126154a6-c636-4cb9-b31a-9e6f3eaca44b",
  "createdBy" : "126154a6-c636-4cb9-b31a-9e6f3eaca44b",
  "createdAt" : "2024-11-15T02:33:01.141399Z",
  "updatedAt" : "2024-11-15T02:33:01.190611Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "0e36c4ef-9736-4405-85b9-2ab33f135eba" : "6598ba75-eb87-4b09-a9be-8de6febfb2e3",
    "0643f361-22bf-4a68-8a50-21fdbd927a91" : "9d548095-cc85-40a5-82da-257a195c928d"
  },
  "model" : {
    "clientIngress" : {
      "protocols" : [ "tcp", "udp" ],
      "addresses" : [ "aaabbb.com", "10.10.0.0/16" ],
      "ports" : [ {
        "low" : 500,
        "high" : 549
      }, {
        "low" : 8080,
        "high" : 8080
      } ]
    },
    "serverEgress" : {
      "forwardProtocol" : true,
      "allowedProtocols" : [ "udp", "tcp" ],
      "forwardHost" : true,
      "allowedHosts" : [ "aaabbb.com", "10.10.0.0/16" ],
      "forwardPort" : true,
      "allowedPortRanges" : [ {
        "low" : 500,
        "high" : 549
      }, {
        "low" : 8080,
        "high" : 8080
      } ]
    },
    "sourceIpConfigType" : "Transparency",
    "sourceIpConfig" : {
      "allowedSourceAddresses" : [ "192.168.0.0/16", "10.10.0.0/24" ]
    },
    "bindEndpointAttributes" : [ "#east-pop" ],
    "edgeRouterAttributes" : [ "#LA-dataCenter-ERs" ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/f66d598c-95dd-49e0-b63c-d90201e1cebb",
      "title" : "My Service 8vky1qbr"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9b4d1a19-4e09-47fb-8f1f-8219d471e373",
      "profile" : "parent"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?id=6598ba75-eb87-4b09-a9be-8de6febfb2e3,9d548095-cc85-40a5-82da-257a195c928d"
    }
  }
}

Create Service

POST /v2/services

Authorization

This endpoint requires create action on the service resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

networkId

String

true

name

String

true

encryptionRequired

Boolean

true

terminatorStrategy

String

true

configIds

Array[Object]

true

configNames

Array[String]

true

configs

Array[Object]

true

configs[].networkId

String

true

configs[].name

String

true

configs[].configTypeId

String

true

configs[].configTypeName

String

true

configs[].configType

Object

true

configs[].configType.networkId

String

true

configs[].configType.name

String

true

configs[].configType.schema

Object

true

configs[].data

Object

true

attributes

Array[String]

true

modelType

String

true

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

model

Object

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ3SlN4eXp4eThqaTFVUUhhYnJwWUNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjEyNjE1NGE2LWM2MzYtNGNiOS1iMzFhLTllNmYzZWFjYTQ0YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk4MSwiZXhwIjoxNzMxNjQxNTgxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjIxNjNmY2ZkLWJhN2UtNDVhNS05OTZjLTNkZGYwOGY5NjJjMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk4MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.hlZAi6KcCti8lXX2NPxoRvDLbvHc_wKVWt9Mywoo12tsrIT84FXQe1mU0Qg9GnzBBesZLCPw3d0AZK_zsXy0WcUCafvGl-ty06UVuRJJLB4AqN1KUB7_8dvjV-GhDtJnHiQ8oZzsORXET4lg9XZQZCBc9lpjeJObtd6ECO5plxQVfH-5iM5XtL8S-GyBE0Xr1wbLNM9q2Wt9pVsfWiZefkNZKUDUKEK84AfEdehUNCqoBWnPVTg2RIe01fvRo1dGotypm_eCeFlNWlW9ovIx5v0lduA-X2P5Uso5VnBlMUDA7NQzsqGwN_X_EUZ5Ew0EjvS1Ip1szS4kS-zV3HG-Bw' \
    -d '{"networkId":"9b4d1a19-4e09-47fb-8f1f-8219d471e373","name":"My Service 8vky1qbr","encryptionRequired":true,"terminatorStrategy":"sticky","attributes":["#Attr-1","#Attr-2"],"modelType":"AdvancedTunnelerToEndpoint","model":{"clientIngress":{"protocols":["tcp","udp"],"addresses":["10.10.0.0/16","aaabbb.com"],"ports":[{"low":500,"high":549},{"low":8080,"high":8080}]},"serverEgress":{"forwardProtocol":true,"allowedProtocols":["tcp","udp"],"forwardHost":true,"allowedHosts":["10.10.0.0/16","aaabbb.com"],"forwardPort":true,"allowedPortRanges":[{"low":500,"high":549},{"low":8080,"high":8080}]},"sourceIpConfigType":"Transparency","sourceIpConfig":{"allowedSourceAddresses":["192.168.0.0/16","10.10.0.0/24"]},"bindEndpointAttributes":["#east-pop"],"edgeRouterAttributes":["#LA-dataCenter-ERs"]}}'

Example response

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

{
  "id" : "f66d598c-95dd-49e0-b63c-d90201e1cebb",
  "networkId" : "9b4d1a19-4e09-47fb-8f1f-8219d471e373",
  "zitiId" : "ziti.id.8xggrzku",
  "name" : "My Service 8vky1qbr",
  "encryptionRequired" : true,
  "terminatorStrategy" : "sticky",
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "modelType" : "AdvancedTunnelerToEndpoint",
  "ownerIdentityId" : "126154a6-c636-4cb9-b31a-9e6f3eaca44b",
  "createdBy" : "126154a6-c636-4cb9-b31a-9e6f3eaca44b",
  "createdAt" : "2024-11-15T02:33:01.141399Z",
  "updatedAt" : "2024-11-15T02:33:01.190611Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "0e36c4ef-9736-4405-85b9-2ab33f135eba" : "6598ba75-eb87-4b09-a9be-8de6febfb2e3",
    "0643f361-22bf-4a68-8a50-21fdbd927a91" : "9d548095-cc85-40a5-82da-257a195c928d"
  },
  "model" : {
    "clientIngress" : {
      "protocols" : [ "tcp", "udp" ],
      "addresses" : [ "aaabbb.com", "10.10.0.0/16" ],
      "ports" : [ {
        "low" : 500,
        "high" : 549
      }, {
        "low" : 8080,
        "high" : 8080
      } ]
    },
    "serverEgress" : {
      "forwardProtocol" : true,
      "allowedProtocols" : [ "udp", "tcp" ],
      "forwardHost" : true,
      "allowedHosts" : [ "aaabbb.com", "10.10.0.0/16" ],
      "forwardPort" : true,
      "allowedPortRanges" : [ {
        "low" : 500,
        "high" : 549
      }, {
        "low" : 8080,
        "high" : 8080
      } ]
    },
    "sourceIpConfigType" : "Transparency",
    "sourceIpConfig" : {
      "allowedSourceAddresses" : [ "192.168.0.0/16", "10.10.0.0/24" ]
    },
    "bindEndpointAttributes" : [ "#east-pop" ],
    "edgeRouterAttributes" : [ "#LA-dataCenter-ERs" ]
  }
}

Update Service

PATCH /v2/services/{id}

Authorization

This endpoint requires update action on the service resource type.

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

terminatorStrategy

String

true

configIds

Array[Object]

true

configNames

Array[String]

true

updateExclusiveConfigs

Map

true

createExclusiveConfigs

Array[Object]

true

createExclusiveConfigs[].networkId

String

true

createExclusiveConfigs[].name

String

true

createExclusiveConfigs[].configTypeId

String

true

createExclusiveConfigs[].configTypeName

String

true

createExclusiveConfigs[].configType

Object

true

createExclusiveConfigs[].configType.networkId

String

true

createExclusiveConfigs[].configType.name

String

true

createExclusiveConfigs[].configType.schema

Object

true

createExclusiveConfigs[].data

Object

true

attributes

Array[String]

true

modelType

String

true

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

model

Object

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services/f66d598c-95dd-49e0-b63c-d90201e1cebb' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJHdk15X3dTaTdIMnV1RW1BUE91TzNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI2NjcxZDRkLTE3MTgtNDc1OC04NGU5LWMxNThlYTVjMTc0NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk5MCwiZXhwIjoxNzMxNjQxNTkwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjIyZDRlYmMwLWZkMTgtNGI4OS1iZDhkLTUxYTgzNjFhY2VkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk5MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.s1GWaGOzj2xMdBr7oxGstLTqvjXrw-xWCxjtImGt37QRsjqBAx57Nf-M10lkDstoYWXvKie_O5bvEknLEQvlYkXiQ0U8u_S0gue2UObDDyfgfu52CEXufCBRxcl2_miRw84-WhLYzBL8vBJnLj3hb6_CxZAU2Cj1uCjn_dHDd6Zq0qvILi3wJQtiEMrpJGwLPBL7QmKAEEpwk2Wx6MAiCZTTzHsiBUMozfBXbAm8PsZ8qiFaVLpBUjrAqy_99kzAi7WRf7tnUpQ_3OI234YO9ukwCRCjwrCvzzY-MfjEsw85nIUgDyWcjl95tl5ocf_83LyIChBP9LoF86qBlduTKA' \
    -d '{"name":"Our Service 8vky1qbr","attributes":["#Attr-4","#Attr-2"],"modelType":"AdvancedTunnelerToEndpoint","model":{"clientIngress":{"protocols":["tcp","udp"],"addresses":["10.10.0.0/16","aaabbb.com"],"ports":[{"low":500,"high":549},{"low":8080,"high":8080}]},"serverEgress":{"forwardProtocol":true,"allowedProtocols":["tcp","udp"],"forwardHost":true,"allowedHosts":["10.10.0.0/16","aaabbb.com"],"forwardPort":true,"allowedPortRanges":[{"low":500,"high":549},{"low":8080,"high":8080}]},"sourceIpConfigType":"Transparency","sourceIpConfig":{"allowedSourceAddresses":["192.168.0.0/16","10.10.0.0/24"]},"bindEndpointAttributes":["#east-pop"],"edgeRouterAttributes":["#LA-dataCenter-ERs"]}}'

Example response

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

{
  "id" : "f66d598c-95dd-49e0-b63c-d90201e1cebb",
  "networkId" : "9b4d1a19-4e09-47fb-8f1f-8219d471e373",
  "zitiId" : "ziti.id.8xggrzku",
  "name" : "Our Service 8vky1qbr",
  "encryptionRequired" : true,
  "terminatorStrategy" : "sticky",
  "attributes" : [ "#Attr-4", "#Attr-2" ],
  "modelType" : "AdvancedTunnelerToEndpoint",
  "ownerIdentityId" : "126154a6-c636-4cb9-b31a-9e6f3eaca44b",
  "createdBy" : "126154a6-c636-4cb9-b31a-9e6f3eaca44b",
  "createdAt" : "2024-11-15T02:33:01.141399Z",
  "updatedAt" : "2024-11-15T02:33:10.461364Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "0e36c4ef-9736-4405-85b9-2ab33f135eba" : "496ef816-bb00-4332-bf53-405066c73d09",
    "0643f361-22bf-4a68-8a50-21fdbd927a91" : "cf5b7711-5e23-43f2-bafb-98f2f1f397ac"
  },
  "model" : {
    "clientIngress" : {
      "protocols" : [ "tcp", "udp" ],
      "addresses" : [ "aaabbb.com", "10.10.0.0/16" ],
      "ports" : [ {
        "low" : 500,
        "high" : 549
      }, {
        "low" : 8080,
        "high" : 8080
      } ]
    },
    "serverEgress" : {
      "forwardProtocol" : true,
      "allowedProtocols" : [ "udp", "tcp" ],
      "forwardHost" : true,
      "allowedHosts" : [ "aaabbb.com", "10.10.0.0/16" ],
      "forwardPort" : true,
      "allowedPortRanges" : [ {
        "low" : 500,
        "high" : 549
      }, {
        "low" : 8080,
        "high" : 8080
      } ]
    },
    "sourceIpConfigType" : "Transparency",
    "sourceIpConfig" : {
      "allowedSourceAddresses" : [ "192.168.0.0/16", "10.10.0.0/24" ]
    },
    "bindEndpointAttributes" : [ "#east-pop" ],
    "edgeRouterAttributes" : [ "#LA-dataCenter-ERs" ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/f66d598c-95dd-49e0-b63c-d90201e1cebb",
      "title" : "Our Service 8vky1qbr"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9b4d1a19-4e09-47fb-8f1f-8219d471e373",
      "profile" : "parent"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?id=496ef816-bb00-4332-bf53-405066c73d09,cf5b7711-5e23-43f2-bafb-98f2f1f397ac"
    }
  }
}

Delete Service

DELETE /v2/services/{id}

Authorization

This endpoint requires delete action on the service resource type.

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services/f66d598c-95dd-49e0-b63c-d90201e1cebb' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZSVFSbnNUWDlNWW05eEYtdC1WR3VnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFjYjk0YjM2LTQ5ZTktNDRlYS1iYzY4LWRhY2EwZWQ0Mjg3MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk5MSwiZXhwIjoxNzMxNjQxNTkxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJjYjc4MGZiLTRmMGUtNGZlMC1iZWQ3LTRiNThkNTZmMTQyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk5MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.K6r3hJTYjKWuruRHEhvUTaKuxI2UPIG0S--6a81NCHybWDZEdsRXZ_EnHxMP72FTWugzP6UvWP2wsXH4Q2f8HtkwlhIaw2kVAZEj_wGNQsp08OdE667rLgLYx7Q0UPkxIdV7XFNQ3WlpJhNK--h5gy9yRYHiIXDyvNzLNS0bXDzKEDuroBwiOVEXruUnPS9tbbQbneScoX3SaY8myCnAN3BBRXnpyRPbecrBmnULU_WqBNOidYTvFyml27_BkyuvCTIDoqp1EdWqFfVY28YRODk0u_6TbiRoVDhkH8wUsz8lEuXgp6vKH23-0v_RMiz7Sm0MNopzk_iMlqRLMGgydQ'

Example response

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

{
  "id" : "f66d598c-95dd-49e0-b63c-d90201e1cebb",
  "networkId" : "9b4d1a19-4e09-47fb-8f1f-8219d471e373",
  "zitiId" : null,
  "name" : "Our Service 8vky1qbr",
  "encryptionRequired" : true,
  "terminatorStrategy" : "sticky",
  "attributes" : [ ],
  "modelType" : "AdvancedTunnelerToEndpoint",
  "ownerIdentityId" : "126154a6-c636-4cb9-b31a-9e6f3eaca44b",
  "createdBy" : "126154a6-c636-4cb9-b31a-9e6f3eaca44b",
  "createdAt" : "2024-11-15T02:33:01.141399Z",
  "updatedAt" : "2024-11-15T02:33:11.805939Z",
  "deletedBy" : "1cb94b36-49e9-44ea-bc68-daca0ed42872",
  "deletedAt" : "2024-11-15T02:33:11.787Z",
  "configIdByConfigTypeId" : {
    "0e36c4ef-9736-4405-85b9-2ab33f135eba" : "496ef816-bb00-4332-bf53-405066c73d09",
    "0643f361-22bf-4a68-8a50-21fdbd927a91" : "cf5b7711-5e23-43f2-bafb-98f2f1f397ac"
  },
  "model" : {
    "clientIngress" : {
      "protocols" : [ "tcp", "udp" ],
      "addresses" : [ "aaabbb.com", "10.10.0.0/16" ],
      "ports" : [ {
        "low" : 500,
        "high" : 549
      }, {
        "low" : 8080,
        "high" : 8080
      } ]
    },
    "serverEgress" : {
      "forwardProtocol" : true,
      "allowedProtocols" : [ "udp", "tcp" ],
      "forwardHost" : true,
      "allowedHosts" : [ "aaabbb.com", "10.10.0.0/16" ],
      "forwardPort" : true,
      "allowedPortRanges" : [ {
        "low" : 500,
        "high" : 549
      }, {
        "low" : 8080,
        "high" : 8080
      } ]
    },
    "sourceIpConfigType" : "Transparency",
    "sourceIpConfig" : {
      "allowedSourceAddresses" : [ "192.168.0.0/16", "10.10.0.0/24" ]
    },
    "bindEndpointAttributes" : [ ],
    "edgeRouterAttributes" : [ ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/f66d598c-95dd-49e0-b63c-d90201e1cebb",
      "title" : "Our Service 8vky1qbr"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9b4d1a19-4e09-47fb-8f1f-8219d471e373",
      "profile" : "parent"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?id=496ef816-bb00-4332-bf53-405066c73d09,cf5b7711-5e23-43f2-bafb-98f2f1f397ac"
    }
  }
}

App Wans

Find App Wans

GET /v2/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.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

name

String

true

zitiId

String

true

networkId

String

true

serviceAttributes

Array[String]

true

endpointAttributes

Array[String]

true

postureCheckAttributes

Array[String]

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJJUUVZNG9CTUlobVBRWUxBZUExSnV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRhZjU1ODhjLWE2MDYtNDI1NS1iYWRmLWZmM2I2ZTYxOTUzYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkyNiwiZXhwIjoxNzMxNjQxNTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE5Y2Y5ODMyLTc4ZTItNGE5MS1iMmNhLTBiY2Q4YTE1ZjYyZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkyNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.BKbAssSLJHPSq1UqKntO9vpFdSTSsU-s0-Dsd2DipSZ3AdBjvqmsmoGaeU_9MdcP4701pG1uoPAGa-EjhDYPX9ujeBdyfynGWFzJ6RBnHYThSwuWGpXl3YQKbQVPn0V_ec4FhApTQoRnSOfHwkw8iCAhYBSFVR7n4BsKxaCutmN4m4-CRNACN631duCSUbGPne_Im782-0M1oILnUEwMuHpo6xvPjaoeAPIh-IVa0crfPkDVtml0LjVVE648nHSDtK1ODvUCcBpPWZcyCSwNh1V55an_3-487ckR311MIsLUcNMKmsOKrvGS7JFlobfUODo3iuw2ed8lYUeGyuDP_w'

Example response

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

{
  "_embedded" : {
    "appWanList" : [ {
      "id" : "41837de1-6448-4a8a-8996-3a07ccfcc0a1",
      "ownerIdentityId" : "b2e5260b-c6e4-4e40-8b82-179eed036c6f",
      "createdBy" : "b2e5260b-c6e4-4e40-8b82-179eed036c6f",
      "createdAt" : "2024-11-15T02:32:06.252580Z",
      "updatedAt" : "2024-11-15T02:32:06.253124Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "appwan-1635",
      "zitiId" : "f899ab8a-19b7-47f2-8a50-4435dd8974a2",
      "networkId" : "18c0705b-6837-4d39-a9eb-f0aadbca6339",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/41837de1-6448-4a8a-8996-3a07ccfcc0a1",
          "title" : "appwan-1635"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/18c0705b-6837-4d39-a9eb-f0aadbca6339",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "68c3e013-03f6-40ea-aefe-a126dc94740f",
      "ownerIdentityId" : "984f38ea-0dd8-42c9-99c2-03926d0df833",
      "createdBy" : "984f38ea-0dd8-42c9-99c2-03926d0df833",
      "createdAt" : "2024-11-15T02:32:06.564332Z",
      "updatedAt" : "2024-11-15T02:32:06.565038Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "appwan-1675",
      "zitiId" : "2aa4b22c-4d68-4487-b795-bdc063fcc28b",
      "networkId" : "8065210c-7910-433d-8d1e-79467daa8caf",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/68c3e013-03f6-40ea-aefe-a126dc94740f",
          "title" : "appwan-1675"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8065210c-7910-433d-8d1e-79467daa8caf",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "87a73cae-725f-42fd-8bf0-389eafd1e7c2",
      "ownerIdentityId" : "f85a0d0a-6491-4798-86bf-95f1f79c16a4",
      "createdBy" : "f85a0d0a-6491-4798-86bf-95f1f79c16a4",
      "createdAt" : "2024-11-15T02:32:06.493908Z",
      "updatedAt" : "2024-11-15T02:32:06.514147Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "appwan-1665",
      "zitiId" : "7e446a13-368e-4e47-8cac-5afdfef47b56",
      "networkId" : "e76180e9-552f-4c33-ab90-9e12f3735b30",
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/87a73cae-725f-42fd-8bf0-389eafd1e7c2",
          "title" : "appwan-1665"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e76180e9-552f-4c33-ab90-9e12f3735b30",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "a69495dc-3565-4f59-a3bf-5082dea9c072",
      "ownerIdentityId" : "b6565585-654c-4ffb-8324-1cd8d9c3674b",
      "createdBy" : "b6565585-654c-4ffb-8324-1cd8d9c3674b",
      "createdAt" : "2024-11-15T02:32:06.303788Z",
      "updatedAt" : "2024-11-15T02:32:06.304274Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "appwan-1645",
      "zitiId" : "bc87f5a4-fc53-4071-88f5-59354c018b5c",
      "networkId" : "0eb35261-279e-407b-8e6d-b85a80038578",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/a69495dc-3565-4f59-a3bf-5082dea9c072",
          "title" : "appwan-1645"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0eb35261-279e-407b-8e6d-b85a80038578",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "c444b949-f56a-4e06-a3d9-127906d4b73f",
      "ownerIdentityId" : "9a5be0b9-35ac-4c71-86f6-9bb95239de4e",
      "createdBy" : "9a5be0b9-35ac-4c71-86f6-9bb95239de4e",
      "createdAt" : "2024-11-15T02:32:05.953765Z",
      "updatedAt" : "2024-11-15T02:32:05.955926Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "appwan-1615",
      "zitiId" : "961a2dc4-921e-40bc-8816-177cc883672e",
      "networkId" : "8cd76b2d-9512-408d-a64e-c8e54f87a4de",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/c444b949-f56a-4e06-a3d9-127906d4b73f",
          "title" : "appwan-1615"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8cd76b2d-9512-408d-a64e-c8e54f87a4de",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "cd9422a6-3e60-4026-84dd-b95e0a969226",
      "ownerIdentityId" : "8207b07d-673b-472c-8732-813fb0bdb7bd",
      "createdBy" : "8207b07d-673b-472c-8732-813fb0bdb7bd",
      "createdAt" : "2024-11-15T02:32:06.344628Z",
      "updatedAt" : "2024-11-15T02:32:06.443327Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Updated App Wan name",
      "zitiId" : "e68136d2-2e96-44a7-9f4d-aa9725fa9b1b",
      "networkId" : "bbce62cf-a47b-41dd-bb20-6c60993721be",
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/cd9422a6-3e60-4026-84dd-b95e0a969226",
          "title" : "Updated App Wan name"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bbce62cf-a47b-41dd-bb20-6c60993721be",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_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 /v2/app-wans/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/0b6c438d-f8da-47a2-93ab-ec467c88e0af' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJSbzhVTUpncU0xQVo4U25sdWdoNWZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg2ZmZhNzBjLWM0OTQtNDk1Yi1hYjQ1LWJkMDcyNWM4NmYxZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkyNiwiZXhwIjoxNzMxNjQxNTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVkN2E2MDEzLWYzZmQtNDVhNi1hMzY4LTU1ODI5NGQ0YmZlYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkyNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Yi-l_zV43thpUQrFnRTtU_vAHDtQQMrx9upza0J2a9QS68kxge3kHOns2e7RTKoj4T73yieCOLwNZbK6eZu9tSfgQIpK_-K3IcIOPQTuUfmKH5c-HfND1ZTZejxHiW0fHEKfGDi6LTWDhf6yBOnB5b9d1apA5mgvBW7GiurpJKLp3lKFRVapheoute40isCCnfeSHzOw08t7hxnW70fWsr8oxG3G51OvOZVyaI-zob2E6Y_vcB65b09zAQyhxE4C1xXWhwGYhF-nIdjM6Jv53Kpl6SrENV8XOd7s8KaG_FTJsM2z2U-eSu72a6HCx7dJKYZ25okLbTZ3TYVQLQ7KJg'

Example response

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

{
  "id" : "0b6c438d-f8da-47a2-93ab-ec467c88e0af",
  "ownerIdentityId" : "848c9d01-e4e5-4d2c-8857-114fd68c5e10",
  "createdBy" : "848c9d01-e4e5-4d2c-8857-114fd68c5e10",
  "createdAt" : "2024-11-15T02:32:06.629216Z",
  "updatedAt" : "2024-11-15T02:32:06.629826Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "appwan-1685",
  "zitiId" : "55445d56-59b7-42e0-be80-5a09db6dfc6a",
  "networkId" : "cca77594-1a31-45d1-8972-8391268dcbf4",
  "serviceAttributes" : [ ],
  "endpointAttributes" : [ ],
  "postureCheckAttributes" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/0b6c438d-f8da-47a2-93ab-ec467c88e0af",
      "title" : "appwan-1685"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/cca77594-1a31-45d1-8972-8391268dcbf4",
      "profile" : "parent"
    }
  }
}

Find App Wans

GET /v2/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.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

name

String

true

zitiId

String

true

networkId

String

true

serviceAttributes

Array[String]

true

endpointAttributes

Array[String]

true

postureCheckAttributes

Array[String]

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJJV04zek9tdk8yXzY2VDdSeXdIcG9RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM2ODJiOTQwLTBmYTctNDhkZi05ODY2LTU0M2VkY2IyMDY1MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkwOCwiZXhwIjoxNzMxNjQxNTA4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImUwMTJiMzcxLTgzM2QtNDNkNS05MGI2LWI3MGVmZTA1YTJkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkwOH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.GWC4SzuoPRv647qHx4n8Vha0KKzJ_oLJcq8XwAYgMrwYRKOF966JnGrUu30bMvdpRT-GwvIpc0Wf9LA1IZwj-3Xhazl1Xgcnp6ho-JrOA_w4ICfxBU5odMqippEojAXg3eBs2Ykk537N0O68db415nK0oTfKlIqYUOQTp5eVS7m5BpGFPvr6pRjGlnsmO9sJc98zui9Z55mWnKOy6aANT-y4DM7C97SnIuL0BHh0c7IP7rZK5m9rEDsF4uuxqY5RiklBoELGKDmPbQdtms7atTszxAxqvnIB-0xdCpzR9pzodks1ary9WjB52GnN9OZU-Tuv88rUmRDsOui2u6fJIw'

Example response

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

{
  "_embedded" : {
    "appWanList" : [ {
      "id" : "93c3bec1-a52c-4460-88dd-63f81794e63e",
      "ownerIdentityId" : "b9f3f1fe-373a-4248-815c-82261b2040f9",
      "createdBy" : "b9f3f1fe-373a-4248-815c-82261b2040f9",
      "createdAt" : "2024-11-15T02:31:48.346383Z",
      "updatedAt" : "2024-11-15T02:31:48.351863Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Find Test AppWan 1",
      "zitiId" : "4c8234ab-3b86-4eff-b32f-0c31cc79d69b",
      "networkId" : "0aeb6b05-5f00-478c-8b83-7a1b0ed486a6",
      "serviceAttributes" : [ "#seAttr1", "#seAttr2" ],
      "endpointAttributes" : [ "#epAttr2", "#epAttr1" ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/93c3bec1-a52c-4460-88dd-63f81794e63e",
          "title" : "Find Test AppWan 1"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0aeb6b05-5f00-478c-8b83-7a1b0ed486a6",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "b7d73d1e-bc32-436a-a29b-c49f190c41f6",
      "ownerIdentityId" : "b9f3f1fe-373a-4248-815c-82261b2040f9",
      "createdBy" : "b9f3f1fe-373a-4248-815c-82261b2040f9",
      "createdAt" : "2024-11-15T02:31:48.353319Z",
      "updatedAt" : "2024-11-15T02:31:48.356012Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Find Test AppWan 2",
      "zitiId" : "60c993f8-8409-4200-af8d-711799ca8237",
      "networkId" : "0aeb6b05-5f00-478c-8b83-7a1b0ed486a6",
      "serviceAttributes" : [ "#seAttr1", "#seAttr3" ],
      "endpointAttributes" : [ "#epAttr1" ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/b7d73d1e-bc32-436a-a29b-c49f190c41f6",
          "title" : "Find Test AppWan 2"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/0aeb6b05-5f00-478c-8b83-7a1b0ed486a6",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Create App Wan

POST /v2/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

name

String

true

serviceAttributes

Array[String]

true

endpointAttributes

Array[String]

true

postureCheckAttributes

Array[String]

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

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.eyJqdGkiOiI2emc2bERuMEZyM1hKc0JuNHl4VF93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM0YWVmMmYwLWU4N2MtNDk1OC05NzAzLTY4YmVhZDJhZjMzNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkyNiwiZXhwIjoxNzMxNjQxNTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjZlMDNmMDNiLWZjNzQtNDUwZS04ZjAzLWQwMjNhZmM0NWYwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkyNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.RtYGLjiS3OMD4etJpTGjQdKsrxuwyCsscFTr44j1AxVi2JRmeiYG6Ex_lB-gZol8ulyyaBrtSQpzs4y0srpzRlcyg_EFE9oS09qFQq1hwEN53KwCwQL0Vit0-uVMS79ARH7jrV0EWiw1XA01xkT91ZOHMXRQ_8T0uMBnFDEIdaiDoElM_sn9lZV6lBoDGtCJstF41_mG8cbA5zmGbMYalPTwgB8UCZMvlrQS_y-7VoLGpHhAZP4bNtIBF8U33WGBiTwo8pWaLW1Hfgema6dNOcbIqYCCXBipZpf6Bj7vcilB0DfFy3MXPgNeLYnBGT7KeuvZ88S-_Jvi9I8vtITKvg' \
    -d '{"networkId":"1764bd07-16ed-4bb2-8f20-fcaf1f6d5c1e","name":"Test App Wan 1731637926","serviceAttributes":["#service01"],"endpointAttributes":["#accessclients","@endpoint-1717"],"postureCheckAttributes":["#windows"]}'

Example response

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

{
  "id" : "e08bbad2-9405-4df0-aa5b-e2265178808b",
  "ownerIdentityId" : "c4aef2f0-e87c-4958-9703-68bead2af336",
  "createdBy" : "c4aef2f0-e87c-4958-9703-68bead2af336",
  "createdAt" : "2024-11-15T02:32:06.985767Z",
  "updatedAt" : "2024-11-15T02:32:06.990141Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Test App Wan 1731637926",
  "zitiId" : "b04d9e01-fc99-4430-a6b0-bf296ff55828",
  "networkId" : "1764bd07-16ed-4bb2-8f20-fcaf1f6d5c1e",
  "serviceAttributes" : [ "#service01" ],
  "endpointAttributes" : [ "#accessclients", "@endpoint-1717" ],
  "postureCheckAttributes" : [ "#windows" ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/e08bbad2-9405-4df0-aa5b-e2265178808b",
      "title" : "Test App Wan 1731637926"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1764bd07-16ed-4bb2-8f20-fcaf1f6d5c1e",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/ae5d105c-8dd5-4f50-8525-90056288df0a",
      "title" : "Create AppWan",
      "profile" : "meta"
    }
  }
}

Update App Wan

PUT /v2/app-wans/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

serviceAttributes

Array[String]

true

endpointAttributes

Array[String]

true

postureCheckAttributes

Array[String]

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/cd9422a6-3e60-4026-84dd-b95e0a969226' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ2RWZSUFNLdW9pRXBuaWIwSDBQU21nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYyMDhjY2JjLTE2NzQtNGM3OC04MjQyLWI3Yjk0MzA3YmRhMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkyNiwiZXhwIjoxNzMxNjQxNTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRiYjAyZDVkLTA2NGEtNDRmYS04ZmI2LTVkOWM5MWM3ZWI3NVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkyNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ijc1plHjMAuZP5xDWDJu2e327f-LGvjxG5TD7hEAlJmPumRC_IdrGFlmw822APMUb29RLQVJPs3XKc-LMoK-RmnFP6aJuImOq8tkik2eLVW1A4Q_OVllDqRJmVCJUDB5OK-CH1XQ0F5XXAyP_zCc2Q5lWGRKZDWWbV6G8nNQ9oNySJWnt7wrQwu0nKH_Kq8BmRFFBQ2sBLIj0zO4P2Odnnu99Tdq2jCQiKpmB2qBR2sY7rLrT14aTSRwlEL6nOqwaBEDZXh1vZfs-ufk30UBQ5nius9ZPU0Sx6bb8M-84SyyGP46iJIqjnEzYapvv4pPg9XoolAXZjmrbe9WhStz_Q' \
    -d '{"name":"Updated App Wan name","serviceAttributes":["#service03","#service02","#service01"],"endpointAttributes":["#usendpoints"],"postureCheckAttributes":["#windows"]}'

Example response

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

{
  "id" : "cd9422a6-3e60-4026-84dd-b95e0a969226",
  "ownerIdentityId" : "8207b07d-673b-472c-8732-813fb0bdb7bd",
  "createdBy" : "8207b07d-673b-472c-8732-813fb0bdb7bd",
  "createdAt" : "2024-11-15T02:32:06.344628Z",
  "updatedAt" : "2024-11-15T02:32:06.443327Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Updated App Wan name",
  "zitiId" : "e68136d2-2e96-44a7-9f4d-aa9725fa9b1b",
  "networkId" : "bbce62cf-a47b-41dd-bb20-6c60993721be",
  "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
  "endpointAttributes" : [ "#usendpoints" ],
  "postureCheckAttributes" : [ "#windows" ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/cd9422a6-3e60-4026-84dd-b95e0a969226",
      "title" : "Updated App Wan name"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bbce62cf-a47b-41dd-bb20-6c60993721be",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/a0a47bf7-6b09-40e4-8faf-7310872f8b2c",
      "title" : "Update AppWan",
      "profile" : "meta"
    }
  }
}

Delete App Wan

DELETE /v2/app-wans/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/01c6108a-c7e5-4461-a174-570d2178bbb8' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJoX1JSaGRCMGxPcF85UGVRaVp6eWZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjlkM2NhMmE0LTZhYjEtNDYyOC1iZDgxLTNmNWY4MWMxZDM3ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkyNiwiZXhwIjoxNzMxNjQxNTI2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImNiYTM5YWE5LTU1NGMtNDBmNy1iZmRkLWMwYzJjZTVmZDZhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkyNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.BNZ3yU0nfi6ckF2I7dYHwrtDo9kIn1nyZj6YJ_UeeVvJvAeO-fc3uh9lgPd_b_IkJDCiM90t5IzKdSixqzPyf4oFny6zXfBWapJaqZdYMTzMHCyq5vHlX7RoU4UWB0eR3FO-S9XCNJHvK-EHV3Q3TrIW3o86n8HASv9AQx6rGIt-Q5pQWtjrNvmFoAQp1AqUZYNFsuKHdjGA9hIUKKAZAMBfBUIxB-AZP5bCceE-Ekm_XV3QW_pVECPKVGD1lXLq6fWKEWLiNdTGkA45OyzIBG17aYXR-MGIbDEM0DOVCZ5Nkv_vNzMLZRipe2LsagWBExMxpqopvUwB9dDR_se20w'

Example response

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

{
  "id" : "01c6108a-c7e5-4461-a174-570d2178bbb8",
  "ownerIdentityId" : "ce605136-aa4f-4ad2-a0b2-780bfe536137",
  "createdBy" : "ce605136-aa4f-4ad2-a0b2-780bfe536137",
  "createdAt" : "2024-11-15T02:32:06.154067Z",
  "updatedAt" : "2024-11-15T02:32:06.171736Z",
  "deletedBy" : "9d3ca2a4-6ab1-4628-bd81-3f5f81c1d37f",
  "deletedAt" : "2024-11-15T02:32:06.169Z",
  "name" : "appwan-1625",
  "zitiId" : null,
  "networkId" : "841d3bcd-160a-40d5-9d0d-bfe007ad1fa1",
  "serviceAttributes" : [ ],
  "endpointAttributes" : [ ],
  "postureCheckAttributes" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/01c6108a-c7e5-4461-a174-570d2178bbb8",
      "title" : "appwan-1625"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/841d3bcd-160a-40d5-9d0d-bfe007ad1fa1",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/00f8b37d-412f-45a6-b3b6-be28c954f0b1",
      "title" : "Delete AppWan",
      "profile" : "meta"
    }
  }
}

Posture Checks

Find Posture Checks

GET /v2/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

deleted

Boolean

true

Deprecated..

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

zitiId

String

true

name

String

true

networkId

String

true

type

String

true

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

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

attributes

Array[String]

true

data

Object

true

data.domains

Array[String]

true

data.macAddresses

Array[String]

true

data.timeoutSeconds

Integer

true

data.promptOnWake

Boolean

true

data.promptOnUnlock

Boolean

true

data.ignoreLegacyEndpoints

Boolean

true

data.operatingSystems

Array[Object]

true

data.operatingSystems[].type

String

true

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

data.operatingSystems[].versions

Array[String]

true

data.process

Object

true

data.process.osType

String

true

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

data.process.path

String

true

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

data.processes

Array[Object]

true

data.processes[].osType

String

true

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

data.processes[].path

String

true

data.processes[].hashes

Array[String]

true

data.processes[].signerFingerprints

Array[String]

true

data.semantic

String

true

Must be one of [AllOf, AnyOf].

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyTW8ySXY1Z0JHRnNyd1NvRl9mV3B3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA0YzMxOTJhLTZlNDItNDhhMy1iNGNkLTA0OTE1MWM4ZWY1YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg3MSwiZXhwIjoxNzMxNjQxNDcxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImE5YjcyZDI3LWQ1YTEtNDFkZS05ZWVkLTFhYzFjN2UxYWFmN1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg3MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.F1gZI8-gsWHAMKLKN0FEf3sjDlEzj2FNL8Y8-kv9l5cPuWgxBzt3sBnMYKJcX-dNh0m-viHQ1p2bamHqOKwUxGu1ONvEecKO6lowk3ZvS1D4KBu1XsE3MsR2PbNi8UbXM2cnSucPK8e7zQm6uUPBZ5hlaq84_oLprncW9wUzEvrMnEXBhp8bE3ZAAtvXtGAPx7zt0h6i4H2VYz0Ae8e9dyTPCTZI92knIoUZZB4qcUwuzPA6FaAWYyV2YI-y2TFPnkP6i6vzgzO_-IxqI2HNOLccDUm7Zihc8IkaO4WZz7RRsuyMES8KqOy1owdQGdOiwC6TTRlLG7x5Z-KaLIVWeQ'

Example response

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

{
  "_embedded" : {
    "postureCheckList" : [ {
      "id" : "632f1412-0bde-415f-bb63-61d36c82f59f",
      "zitiId" : "zitiId-fake-f7cb66d3-df2f-4b67-bddd-02b44d5b9c22",
      "name" : "Find Test Posture Check 1",
      "networkId" : "581f6f11-102c-4859-a2b2-acc339b4e6aa",
      "type" : "DOMAIN",
      "ownerIdentityId" : "f8d959a9-2db7-43df-ba1c-566a435a32a3",
      "createdBy" : "f8d959a9-2db7-43df-ba1c-566a435a32a3",
      "createdAt" : "2024-11-15T02:31:11.303967Z",
      "updatedAt" : "2024-11-15T02:31:11.303967Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#attr2", "#attr1" ],
      "data" : {
        "domains" : [ "abc.com" ]
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/632f1412-0bde-415f-bb63-61d36c82f59f",
          "title" : "Find Test Posture Check 1"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/581f6f11-102c-4859-a2b2-acc339b4e6aa",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "79a9da31-8e3e-44cc-ba27-82aae47007b7",
      "zitiId" : "zitiId-fake-930bd1a2-be25-4b0d-b5c9-445b8fa058b0",
      "name" : "Find Test Posture Check 2",
      "networkId" : "581f6f11-102c-4859-a2b2-acc339b4e6aa",
      "type" : "DOMAIN",
      "ownerIdentityId" : "f8d959a9-2db7-43df-ba1c-566a435a32a3",
      "createdBy" : "f8d959a9-2db7-43df-ba1c-566a435a32a3",
      "createdAt" : "2024-11-15T02:31:11.319628Z",
      "updatedAt" : "2024-11-15T02:31:11.319628Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#attr3", "#attr1" ],
      "data" : {
        "domains" : [ "abc.com" ]
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/79a9da31-8e3e-44cc-ba27-82aae47007b7",
          "title" : "Find Test Posture Check 2"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/581f6f11-102c-4859-a2b2-acc339b4e6aa",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Posture Check

GET /v2/posture-checks/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks/5555bb29-4833-4cce-b198-bf2aae10e0e7' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2SlUzejctMEdpbHFRUUdmUVIweTJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRhZmI3NTBlLTE0NGUtNDM3MS1iNzEzLTEyMjExNzllYTk0NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA0NiwiZXhwIjoxNzMxNjQxNjQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg1ZTQ5OTBmLWU2ZTctNGIwOC1iMzAyLWQ2NzQ5MjQzZTQ2NlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.hO5tkKLLWCOWEOuM6_upXDecmkP2G90AwwdSceZZ-on56wUGVaoHcoU2PrYprxASrg46z1uMduOFsb07C5uQBp3w1L9-mckGEKhwNy5-cClNH08jJD3Fvyex4uptUuiksgr-PcZLH2fXvOwrooY0RgywEgmNZwVLYvGFaofeO_rP08bsNztisv6iisQ-oy841oLnuKpr0CMoNzS2KK67K2z8POkCYfu9zzETNYPVGKkKMhZaOQ0yS2O6lGAfontbpoEnH7Iqz0ncT2E_pfW4ueg8ayaQONnZEVgi9F2GKfkXKNIuF_uglerqBuxG1vgVJsh-Qq-9OemSgglqOmLn6A'

Example response

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

{
  "id" : "5555bb29-4833-4cce-b198-bf2aae10e0e7",
  "zitiId" : "ziti.id.9r6rttsw",
  "name" : "My Posture Check 763703578358",
  "networkId" : "2c42b25e-04d2-4827-9ca6-6ae9e404661d",
  "type" : "MFA",
  "ownerIdentityId" : "1d3a6465-9bb0-49bf-965d-cb33dbbfeec8",
  "createdBy" : "1d3a6465-9bb0-49bf-965d-cb33dbbfeec8",
  "createdAt" : "2024-11-15T02:34:05.907999Z",
  "updatedAt" : "2024-11-15T02:34:05.907999Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "data" : {
    "timeoutSeconds" : 1234,
    "promptOnWake" : true,
    "promptOnUnlock" : false,
    "ignoreLegacyEndpoints" : false
  },
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2c42b25e-04d2-4827-9ca6-6ae9e404661d",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/5555bb29-4833-4cce-b198-bf2aae10e0e7",
      "title" : "My Posture Check 763703578358"
    }
  }
}

Create Posture Check

POST /v2/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

networkId

String

true

type

String

true

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

attributes

Array[String]

true

data

Object

true

data.domains

Array[String]

true

data.macAddresses

Array[String]

true

data.timeoutSeconds

Integer

true

data.promptOnWake

Boolean

true

data.promptOnUnlock

Boolean

true

data.ignoreLegacyEndpoints

Boolean

true

data.operatingSystems

Array[Object]

true

data.operatingSystems[].type

String

true

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

data.operatingSystems[].versions

Array[String]

true

data.process

Object

true

data.process.osType

String

true

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

data.process.path

String

true

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

data.processes

Array[Object]

true

data.processes[].osType

String

true

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

data.processes[].path

String

true

data.processes[].hashes

Array[String]

true

data.processes[].signerFingerprints

Array[String]

true

data.semantic

String

true

Must be one of [AllOf, AnyOf].

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJmU1RuU052d1FGaTZEcThWTi1ldWdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFkM2E2NDY1LTliYjAtNDliZi05NjVkLWNiMzNkYmJmZWVjOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA0NSwiZXhwIjoxNzMxNjQxNjQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA4ZDEzMmZlLTE5MDAtNGY2MC05MTQ2LTg2NDJhZTU2Y2Y0MlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Or-F6DpIf57v95MnMNv6_kPGuuOV_A9MRZ1lEcqFHEqZgHc2C4Qcvt-QfmES0kqYKM-NnR6LkX_wznXPat5Nj9l9F-WdgHgAM5_siWdzDnHdszgCOues7JgKWIzSByWfkLXsKe9crs82FT20FKHBhWdft_AwO92kC8W9vmRQFcaecip-kE2OHGGWfZHkDjRlBT6FNp97TgtThfEjWE2HKYas1dN9u9j09SyelfpuB-ooWp-KkSw2m56jgaK42aCk349-JWPFZDYsiCsme8nMbQMxOq-m6d_gmeuNM5qMqzm3fUC4TR2ITQ3anrMr-KHErjbSmr120Yp3EzhIY45AEg' \
    -d '{"name":"My Posture Check 763703578358","networkId":"2c42b25e-04d2-4827-9ca6-6ae9e404661d","type":"MFA","attributes":["#Attr-1","#Attr-2"],"data":{"timeoutSeconds":1234,"promptOnWake":true,"promptOnUnlock":false,"ignoreLegacyEndpoints":false}}'

Example response

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

{
  "id" : "5555bb29-4833-4cce-b198-bf2aae10e0e7",
  "zitiId" : "ziti.id.9r6rttsw",
  "name" : "My Posture Check 763703578358",
  "networkId" : "2c42b25e-04d2-4827-9ca6-6ae9e404661d",
  "type" : "MFA",
  "ownerIdentityId" : "1d3a6465-9bb0-49bf-965d-cb33dbbfeec8",
  "createdBy" : "1d3a6465-9bb0-49bf-965d-cb33dbbfeec8",
  "createdAt" : "2024-11-15T02:34:05.907999Z",
  "updatedAt" : "2024-11-15T02:34:05.907999Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "data" : {
    "timeoutSeconds" : 1234,
    "promptOnWake" : true,
    "promptOnUnlock" : false,
    "ignoreLegacyEndpoints" : false
  }
}

Update Posture Check

PATCH /v2/posture-checks/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

type

String

true

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

attributes

Array[String]

true

ownerIdentityId

String

true

data

Object

true

data.domains

Array[String]

true

data.macAddresses

Array[String]

true

data.timeoutSeconds

Integer

true

data.promptOnWake

Boolean

true

data.promptOnUnlock

Boolean

true

data.ignoreLegacyEndpoints

Boolean

true

data.operatingSystems

Array[Object]

true

data.operatingSystems[].type

String

true

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

data.operatingSystems[].versions

Array[String]

true

data.process

Object

true

data.process.osType

String

true

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

data.process.path

String

true

data.process.hashes

Array[String]

true

data.process.signerFingerprint

String

true

data.processes

Array[Object]

true

data.processes[].osType

String

true

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

data.processes[].path

String

true

data.processes[].hashes

Array[String]

true

data.processes[].signerFingerprints

Array[String]

true

data.semantic

String

true

Must be one of [AllOf, AnyOf].

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks/5555bb29-4833-4cce-b198-bf2aae10e0e7' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJQcExqU0VCWVZuOHhKeFo3VmR0cDVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE0ZGY5ZDZmLTQwZTEtNDc1NC04NWVhLThjYmIyNjZhNWIxOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA0NiwiZXhwIjoxNzMxNjQxNjQ2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY4N2MxYTYzLWI0MWYtNDYyNS1iNDA3LTY2MjdiODRmMjNmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Rb2kA-XwSOV-l4TOFJwI1-5o8JDhkh6YE_84l2mZx_UGxOCbccAex-zNBlDSzRbOutKff18RZ8Rcuq66B1ELq2mMva9jN8I3A2Gi3fmReikcyuRLU87pu1FBOJVnX71KYeKNShM2IhXCwXun_1bRuy_e3Ou5yvm_28WNEYIYq-oSV7uAxBbuDAbndrwqML8_KaFeezug5kyWt1LNDMzl4vnLXXQNmvlFY-86eXxTGR1NRPtOixHq6fJr3ihyWrjbR9J8-eyrETs_5cbOqg9aZ6uLWm_Mksv7ELoBegKnOk74OYYyWaK1Plbex-wuC7VMliQojjiAB4nAtS0Z1Q-M3A' \
    -d '{"name":"Our Service 763703578358","attributes":["#Attr-4","#Attr-2"]}'

Example response

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

{
  "id" : "5555bb29-4833-4cce-b198-bf2aae10e0e7",
  "zitiId" : "ziti.id.9r6rttsw",
  "name" : "Our Service 763703578358",
  "networkId" : "2c42b25e-04d2-4827-9ca6-6ae9e404661d",
  "type" : "MFA",
  "ownerIdentityId" : "1d3a6465-9bb0-49bf-965d-cb33dbbfeec8",
  "createdBy" : "1d3a6465-9bb0-49bf-965d-cb33dbbfeec8",
  "createdAt" : "2024-11-15T02:34:05.907999Z",
  "updatedAt" : "2024-11-15T02:34:06.828264Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-4", "#Attr-2" ],
  "data" : {
    "timeoutSeconds" : 1234,
    "promptOnWake" : true,
    "promptOnUnlock" : false,
    "ignoreLegacyEndpoints" : false
  },
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2c42b25e-04d2-4827-9ca6-6ae9e404661d",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/5555bb29-4833-4cce-b198-bf2aae10e0e7",
      "title" : "Our Service 763703578358"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/d50c217c-a27f-45ee-8a74-9a8ef91136ca",
      "title" : "Update PostureCheck",
      "profile" : "meta"
    }
  }
}

Delete Posture Check

DELETE /v2/posture-checks/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks/5555bb29-4833-4cce-b198-bf2aae10e0e7' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJUbUlLSWxmbVJxV0xHTzREMWl3ZnVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJhMDhhZDQ1LWI2ZmMtNGU5My1hYzg5LWYxOTI1ZTJlYzA2NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA0NywiZXhwIjoxNzMxNjQxNjQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM2YzM4NWZlLTMzNWUtNGIxZC1iMTBjLWVkZTE4MzA5MDQ2MlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.flpvqNIH_C-XYkt4Hd0kZN8zWTCAfUWJ36gBv1GtAN5LHn6-P-MV6RORDvVkezXqy2dnb9oJyIcGbA_QCTlEeofn3q-1lVF-QcDrc2RjTvxeSTv0ZrokfNBC3HTOjRr4Jk50_ItWMBJBMBn6XKjFwBV90nPEnlL2FZTQDwOFKj6Gk1r6fr3_49VCQ0PH9_aLSIVAO_bL90JoJkofUvsXXnXeNF3fIceILvf9J-64gKxqzL6OZmy6Wv5zl7A_x0S0Z3uk5rZS9Sr79RlNZSlRjN1OsxDwwNGCZnyx8qCd6xJU0HNEIorJ647vuQrfaoGs4TP9H4FEygwYqBZmcNOrtw'

Example response

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

{
  "id" : "5555bb29-4833-4cce-b198-bf2aae10e0e7",
  "zitiId" : "ziti.id.9r6rttsw",
  "name" : "Our Service 763703578358",
  "networkId" : "2c42b25e-04d2-4827-9ca6-6ae9e404661d",
  "type" : "MFA",
  "ownerIdentityId" : "1d3a6465-9bb0-49bf-965d-cb33dbbfeec8",
  "createdBy" : "1d3a6465-9bb0-49bf-965d-cb33dbbfeec8",
  "createdAt" : "2024-11-15T02:34:05.907999Z",
  "updatedAt" : "2024-11-15T02:34:07.211940Z",
  "deletedBy" : "ba08ad45-b6fc-4e93-ac89-f1925e2ec066",
  "deletedAt" : "2024-11-15T02:34:07.211Z",
  "attributes" : null,
  "data" : {
    "timeoutSeconds" : 1234,
    "promptOnWake" : true,
    "promptOnUnlock" : false,
    "ignoreLegacyEndpoints" : false
  },
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2c42b25e-04d2-4827-9ca6-6ae9e404661d",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/5555bb29-4833-4cce-b198-bf2aae10e0e7",
      "title" : "Our Service 763703578358"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/b8a03923-895e-42c3-ae91-cb793c528922",
      "title" : "Delete PostureCheck",
      "profile" : "meta"
    }
  }
}

Certificate Authorities

Find Certificate Authorities

GET /v2/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

isAutoCaEnrollment

Boolean

true

Deprecated..

isOttCaEnrollmentEnabled

Boolean

true

Deprecated..

isAuthEnabled

Boolean

true

Deprecated..

isVerified

Boolean

true

Deprecated..

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

networkId

String

true

zitiId

String

true

name

String

true

endpointAttributes

Array[String]

true

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

true

identityNameFormat

String

true

verified

Boolean

true

authEnabled

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ1RnBaa053U3dhRzJMXzhrLUpyTm1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVkNTgzYmY1LWMyZWQtNGZkMS04OTAxLTVlY2UxMzRhZTY4YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzgxOSwiZXhwIjoxNzMxNjQxNDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZiYmQxODc0LTVlMGQtNDM4OC1iNDk3LWVkNjAzZDA5NGM5ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzgxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Oe0b-71PNDeL7Zli0ig7oGFx5vYvFTW8Pnjx8Yu5U5jGDIu3e5sEp9KrKmri2cRu1-J1-CuBttBJJW4KFdCFPAb6Z0HKwfJ_n_-rB6_uZdptQ5Th_llvcaepbLstiPbMvmslWuNi-SkKmggicwZkP7z8oSSgG5lVL4kD--XhS0IL8vZfzLDFRkHDljg1ywfA2Cuy2gaafW3w7hqNM9j_3A-_U26y6h1MbHZMDuyQAZ6RcC0MAYP08G4tZH0NEuG-X9QHLai4bD91Gji74FWO2BMXo67AvTrOWHZYS5CaQe0cBj_ApCMnaUioBkMK0_kxerNgXF4TWX28udK2Je-8Bw'

Example response

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

{
  "_embedded" : {
    "certificateAuthorityList" : [ {
      "id" : "10291552-de50-48cd-8049-e33b9b14bc4e",
      "ownerIdentityId" : "37fd6094-9353-4282-a012-12c047b5f1e1",
      "createdBy" : "37fd6094-9353-4282-a012-12c047b5f1e1",
      "createdAt" : "2024-11-15T02:30:16.387979Z",
      "updatedAt" : "2024-11-15T02:30:16.443686Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "b855e4ec-a4c5-449f-b4fc-8231931e89c1",
      "zitiId" : "ziti.id.6trtupbt",
      "name" : "Test ca 02",
      "endpointAttributes" : [ "#secureclients" ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "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-----",
      "identityNameFormat" : null,
      "verified" : false,
      "authEnabled" : false,
      "autoCaEnrollmentEnabled" : true,
      "ottCaEnrollmentEnabled" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/10291552-de50-48cd-8049-e33b9b14bc4e",
          "title" : "Test ca 02"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b855e4ec-a4c5-449f-b4fc-8231931e89c1"
        }
      }
    }, {
      "id" : "26dd16ed-2614-44f8-8f1f-7fd31d762d1f",
      "ownerIdentityId" : "ff7dd423-d8b5-45d8-81ad-6cf8031af2dd",
      "createdBy" : "ff7dd423-d8b5-45d8-81ad-6cf8031af2dd",
      "createdAt" : "2024-11-15T02:30:14.862102Z",
      "updatedAt" : "2024-11-15T02:30:14.901269Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "6eca37d7-2f58-45fb-8f56-5e284a755ae8",
      "zitiId" : "ziti.id.6t1bf8b1",
      "name" : "ca-47",
      "endpointAttributes" : [ ],
      "verificationToken" : "token",
      "fingerprint" : "fingerprint",
      "jwt" : "jwt",
      "certPem" : "fake-pem",
      "identityNameFormat" : "name-format",
      "verified" : false,
      "authEnabled" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/26dd16ed-2614-44f8-8f1f-7fd31d762d1f",
          "title" : "ca-47"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/6eca37d7-2f58-45fb-8f56-5e284a755ae8"
        }
      }
    }, {
      "id" : "527abbc9-59bd-4a16-8dc4-27099e46be00",
      "ownerIdentityId" : "3ac11c55-2bb7-4ef8-9a7e-f5ebe91c9d85",
      "createdBy" : "3ac11c55-2bb7-4ef8-9a7e-f5ebe91c9d85",
      "createdAt" : "2024-11-15T02:30:17.590150Z",
      "updatedAt" : "2024-11-15T02:30:17.899145Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "bc92431c-d86d-40af-8a79-1a6fbd600316",
      "zitiId" : "ziti.id.6uascdth",
      "name" : "Test ca 02 updated",
      "endpointAttributes" : [ ],
      "verificationToken" : "token",
      "fingerprint" : "fingerprint",
      "jwt" : "jwt",
      "certPem" : "fake-pem",
      "identityNameFormat" : "name-format",
      "verified" : false,
      "authEnabled" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/527abbc9-59bd-4a16-8dc4-27099e46be00",
          "title" : "Test ca 02 updated"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/bc92431c-d86d-40af-8a79-1a6fbd600316"
        }
      }
    }, {
      "id" : "5a22b5da-da9a-4b14-8f40-cf738e1c049d",
      "ownerIdentityId" : "1727b132-9828-4fc6-a26d-ccd28bb32e4e",
      "createdBy" : "1727b132-9828-4fc6-a26d-ccd28bb32e4e",
      "createdAt" : "2024-11-15T02:30:17.222231Z",
      "updatedAt" : "2024-11-15T02:30:17.224145Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "27050d53-84f0-49ef-ad25-280affe964fa",
      "zitiId" : "ziti.id.6u4p9rxq",
      "name" : "ca-68",
      "endpointAttributes" : [ ],
      "verificationToken" : "token",
      "fingerprint" : "fingerprint",
      "jwt" : "jwt",
      "certPem" : "fake-pem",
      "identityNameFormat" : "name-format",
      "verified" : false,
      "authEnabled" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/5a22b5da-da9a-4b14-8f40-cf738e1c049d",
          "title" : "ca-68"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/27050d53-84f0-49ef-ad25-280affe964fa"
        }
      }
    }, {
      "id" : "8ddac750-b745-4ef7-b1d8-08ff3ec2921b",
      "ownerIdentityId" : "b333319b-b124-4c2a-ac7c-9eca24090b41",
      "createdBy" : "b333319b-b124-4c2a-ac7c-9eca24090b41",
      "createdAt" : "2024-11-15T02:30:18.156634Z",
      "updatedAt" : "2024-11-15T02:30:18.158688Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "3743df25-cb18-4a62-8948-9147c76a7b56",
      "zitiId" : "ziti.id.6uk4cvn9",
      "name" : "ca-82",
      "endpointAttributes" : [ ],
      "verificationToken" : "token",
      "fingerprint" : "fingerprint",
      "jwt" : "jwt",
      "certPem" : "fake-pem",
      "identityNameFormat" : "name-format",
      "verified" : false,
      "authEnabled" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/8ddac750-b745-4ef7-b1d8-08ff3ec2921b",
          "title" : "ca-82"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/3743df25-cb18-4a62-8948-9147c76a7b56"
        }
      }
    }, {
      "id" : "9eeb0d8b-f6b7-4c9f-a1eb-2d632c150bd2",
      "ownerIdentityId" : "f48d2817-2c0a-42cc-ac79-7cd59b2183e4",
      "createdBy" : "f48d2817-2c0a-42cc-ac79-7cd59b2183e4",
      "createdAt" : "2024-11-15T02:30:15.418831Z",
      "updatedAt" : "2024-11-15T02:30:15.439061Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "d3caf6e6-0336-4665-81bb-89294b2df1ed",
      "zitiId" : "ziti.id.6tav2os2",
      "name" : "ca-54",
      "endpointAttributes" : [ ],
      "verificationToken" : "token",
      "fingerprint" : "fingerprint",
      "jwt" : "jwt",
      "certPem" : "fake-pem",
      "identityNameFormat" : "name-format",
      "verified" : false,
      "authEnabled" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/9eeb0d8b-f6b7-4c9f-a1eb-2d632c150bd2",
          "title" : "ca-54"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/d3caf6e6-0336-4665-81bb-89294b2df1ed"
        }
      }
    }, {
      "id" : "9eec20f3-6204-4d56-898c-342117addf76",
      "ownerIdentityId" : "5f1bc565-828b-4c79-b93f-7e768b6e88c3",
      "createdBy" : "5f1bc565-828b-4c79-b93f-7e768b6e88c3",
      "createdAt" : "2024-11-15T02:30:16.098124Z",
      "updatedAt" : "2024-11-15T02:30:16.109191Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "b855e4ec-a4c5-449f-b4fc-8231931e89c1",
      "zitiId" : "ziti.id.6tm3wc5z",
      "name" : "ca-61",
      "endpointAttributes" : [ ],
      "verificationToken" : "token",
      "fingerprint" : "fingerprint",
      "jwt" : "jwt",
      "certPem" : "fake-pem",
      "identityNameFormat" : "name-format",
      "verified" : false,
      "authEnabled" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/9eec20f3-6204-4d56-898c-342117addf76",
          "title" : "ca-61"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b855e4ec-a4c5-449f-b4fc-8231931e89c1"
        }
      }
    }, {
      "id" : "dbff95c5-10df-4e0c-8488-837ba8aafb00",
      "ownerIdentityId" : "85e52465-f1fd-4aee-9e52-2c5b700bc64b",
      "createdBy" : "85e52465-f1fd-4aee-9e52-2c5b700bc64b",
      "createdAt" : "2024-11-15T02:30:19.064233Z",
      "updatedAt" : "2024-11-15T02:30:19.072205Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "117f55a7-160f-40c6-a671-165add5fa546",
      "zitiId" : "ziti.id.6uz5vao0",
      "name" : "ca-96",
      "endpointAttributes" : [ ],
      "verificationToken" : "token",
      "fingerprint" : "fingerprint",
      "jwt" : "jwt",
      "certPem" : "fake-pem",
      "identityNameFormat" : "name-format",
      "verified" : false,
      "authEnabled" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/dbff95c5-10df-4e0c-8488-837ba8aafb00",
          "title" : "ca-96"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/117f55a7-160f-40c6-a671-165add5fa546"
        }
      }
    }, {
      "id" : "f5696db4-63dc-4aeb-bac6-7144eae81a62",
      "ownerIdentityId" : "53152cc8-9de6-4f49-97be-4d159d945463",
      "createdBy" : "53152cc8-9de6-4f49-97be-4d159d945463",
      "createdAt" : "2024-11-15T02:30:17.297268Z",
      "updatedAt" : "2024-11-15T02:30:17.340349Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "27050d53-84f0-49ef-ad25-280affe964fa",
      "zitiId" : "ziti.id.6u6o33ne",
      "name" : "Test ca 02",
      "endpointAttributes" : [ "#secureclients" ],
      "verificationToken" : null,
      "fingerprint" : null,
      "jwt" : null,
      "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-----",
      "identityNameFormat" : "[commonName] - [identityId]",
      "verified" : false,
      "authEnabled" : false,
      "autoCaEnrollmentEnabled" : true,
      "ottCaEnrollmentEnabled" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/f5696db4-63dc-4aeb-bac6-7144eae81a62",
          "title" : "Test ca 02"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/27050d53-84f0-49ef-ad25-280affe964fa"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 9,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Certificate Authority

GET /v2/certificate-authorities/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/c6123fcb-1c10-4eff-b5fb-767d3cc59817' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJEZmJTOTBRR2pFQ0QwQ0lLQ3lTeVlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUwNGY4YjY3LTlmM2YtNDRhYi1hMDYyLWRiNDRjZWEzMWE2NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzgxOSwiZXhwIjoxNzMxNjQxNDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJkY2NkMzIxLWM0YmItNGVkNi1hZjgwLTEwZDVhOGUzZjgzNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzgxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.bNk4dAne4RY5uWKS7dAMHhVslTcOX5Y4oA89NCLgNTy_9I2ZmtTQtNLiH1zCX_XUvz_HyytnggQRVtWOnf5A8vJVHS8Osw5EQ-sF70gSC9rDaCiVxmYtIa9464nN91gm_XH5xtswaQlZ6iBPoHHKiGxHv_y1AKqeF111n-sZYmYoshq4cLqFb4nFiLoADYDg3DF7H-e2f2SPGZp5Dlztcoea6RnCbDfqy9jIpme3bBkLvMhOGkNQ1VBRz-fhdMkzOoDIgyp1fUyd9nIrjm0ZOhLxAbA6VuMQicvJ6ioV0ZB-07pe2LJEgl7DVHPlL_m9IPF70IoKXqQUIRZyuT3rSw'

Example response

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

{
  "id" : "c6123fcb-1c10-4eff-b5fb-767d3cc59817",
  "ownerIdentityId" : "a250d34d-b507-426b-9fea-176df43914e3",
  "createdBy" : "a250d34d-b507-426b-9fea-176df43914e3",
  "createdAt" : "2024-11-15T02:30:19.677151Z",
  "updatedAt" : "2024-11-15T02:30:19.678921Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "abb43141-f4e8-4c63-a5cb-ee56efe85ac3",
  "zitiId" : "ziti.id.6v9auboy",
  "name" : "ca-110",
  "endpointAttributes" : [ ],
  "verificationToken" : "token",
  "fingerprint" : "fingerprint",
  "jwt" : "jwt",
  "certPem" : "fake-pem",
  "identityNameFormat" : "name-format",
  "verified" : false,
  "authEnabled" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/c6123fcb-1c10-4eff-b5fb-767d3cc59817",
      "title" : "ca-110"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/abb43141-f4e8-4c63-a5cb-ee56efe85ac3"
    }
  }
}

Create Certificate Authority

POST /v2/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

name

String

true

autoCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

certPem

String

true

endpointAttributes

Array[String]

true

identityNameFormat

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

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.eyJqdGkiOiJWZWwwV2V2NXJJTnhUMWFoSGtlbXRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM3ZmQ2MDk0LTkzNTMtNDI4Mi1hMDEyLTEyYzA0N2I1ZjFlMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzgxNiwiZXhwIjoxNzMxNjQxNDE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjI0NDM2M2M1LWY4NzUtNGVjZi1iNWNhLTYxYTM2ZjNjOWMyY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzgxNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.INeRKC1oKujb2BtFolaP0TetUQFNbYXrpSMfyiY0pHnjApBslts6bmaIeVuL36h9lmAyJoKEk_BZl_Pdh2P34wAQcgK65Hc5IeinnDTHUV4koF0Xk_erMUiZ-wXs7EcSDLssv47KPYnYBNw4PaF8zMpH893yi1aMb89wvLZ8Kfl2kcHt6XS9lzn8VZojhVO8C2RWUnO6sh7NB0F7CHg6Brd2AIdh2USrtHhBqLYpKOOievbogUKZ26uA_9VQJI_3FtUbZKDakgCXaqgkcJ6kK2KBk4toTwRXbYrT2XveIQt8FcoTMyHJOjnndEx-iLfXBy7QW7thmpKcN5qFON3DOA' \
    -d '{"networkId":"b855e4ec-a4c5-449f-b4fc-8231931e89c1","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: 2996

{
  "id" : "10291552-de50-48cd-8049-e33b9b14bc4e",
  "ownerIdentityId" : "37fd6094-9353-4282-a012-12c047b5f1e1",
  "createdBy" : "37fd6094-9353-4282-a012-12c047b5f1e1",
  "createdAt" : "2024-11-15T02:30:16.387979Z",
  "updatedAt" : "2024-11-15T02:30:16.443686Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "b855e4ec-a4c5-449f-b4fc-8231931e89c1",
  "zitiId" : "ziti.id.6trtupbt",
  "name" : "Test ca 02",
  "endpointAttributes" : [ "#secureclients" ],
  "verificationToken" : null,
  "fingerprint" : null,
  "jwt" : null,
  "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-----",
  "identityNameFormat" : null,
  "verified" : false,
  "authEnabled" : false,
  "autoCaEnrollmentEnabled" : true,
  "ottCaEnrollmentEnabled" : false,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/10291552-de50-48cd-8049-e33b9b14bc4e",
      "title" : "Test ca 02"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b855e4ec-a4c5-449f-b4fc-8231931e89c1"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/6c5aa9db-dbac-40e7-a13a-3af773f07ccf",
      "title" : "Create CertificateAuthority",
      "profile" : "meta"
    }
  }
}

Verify Certificate Authority

POST /v2/certificate-authorities/{id}/verify

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/8ddac750-b745-4ef7-b1d8-08ff3ec2921b/verify' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhZGJvcDFxWi1XX1NjZ2RwZjJzQ0hnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE1NTRlNzRkLWZmODQtNDgwZi05ZmRlLWFhMGI1MDMxZWJjOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzgxOCwiZXhwIjoxNzMxNjQxNDE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM3ODE4ZjJlLWU0ZmMtNDA3NS1hOGQ0LWNmZDQyZTk3N2NkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzgxOH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.UU05JkVUu_Zgd5LKWb5CKzWLTW-9-3cOfP0C43EnT2KDl1cdhqoMl-PJf7F_OCu15nAPtJDuu8KBJ-o7M4WqvLgTQHsB4KV82HxzqzrMdUWD0pbPpqH0aXodNZ2c9lgCseSVxbwKaXzYzTySqtU5wE148EngVepg8N57oELlwtGjg67qF4qJtrVJ7JrlksshR-KqJGlYA_SYKPrtGZsSYbRlHVCDzDSF5r9fLRbVjq_PPSYaTzcBHw0ThV_Lh2JYEEA9uAtZSHuy2mYKNGIbJ8CIgqiLqYsdBFOVPVerDPvxFXfLWf-ryY8Z10AmwDvCCRVYBUTt61p85QT9FGiI2Q' \
    -d '<testcertverificationbody>'

Example response

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

{
  "id" : "8ddac750-b745-4ef7-b1d8-08ff3ec2921b",
  "ownerIdentityId" : "b333319b-b124-4c2a-ac7c-9eca24090b41",
  "createdBy" : "b333319b-b124-4c2a-ac7c-9eca24090b41",
  "createdAt" : "2024-11-15T02:30:18.156634Z",
  "updatedAt" : "2024-11-15T02:30:18.158688Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "3743df25-cb18-4a62-8948-9147c76a7b56",
  "zitiId" : "ziti.id.6uk4cvn9",
  "name" : "ca-82",
  "endpointAttributes" : [ ],
  "verificationToken" : "token",
  "fingerprint" : "fingerprint",
  "jwt" : "jwt",
  "certPem" : "fake-pem",
  "identityNameFormat" : "name-format",
  "verified" : false,
  "authEnabled" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/8ddac750-b745-4ef7-b1d8-08ff3ec2921b",
      "title" : "ca-82"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/3743df25-cb18-4a62-8948-9147c76a7b56"
    }
  }
}

Patch Certificate Authority

PATCH /v2/certificate-authorities/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

autoCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

endpointAttributes

Array[String]

true

identityNameFormat

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/527abbc9-59bd-4a16-8dc4-27099e46be00' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI4eFVuOXJsbEl2ekw5Vm9qekFvRDNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM1MTM4YzFmLTFmNTItNGVmOC1hNjliLTgzMWZlYTYxYzk1YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzgxNywiZXhwIjoxNzMxNjQxNDE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgzNjBkZDEwLTk0OGYtNDY1Yi1iMGViLWVlNTI3Y2FhMDg4YVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzgxN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.FVwa2NRel3AadrqRLeFwAeSOZbBKC2rdnbjSSspMvm5twCnyyw5R9hl-BdShoRNUDh3vI4Ysf-1jdJWP0B-BAh3-xNETum6acTW9IMiFNxsMGoB-zUm47Qg7Z54bz1hUR91RozRSu_5V3VZT5CHb53bYXrj8EnsJVqYirSqqJKvId9m8751vqPESprBbADnyjOKIyymctRNNwpMh_5UU4mEjAqW10M92TEHYOdHfir5rnAdJGHNtzv1tCZ2cnfcXhWocgvctZzJ0wb2vABDalEI2q5-0YKHoFsorAvsbtoqT6B-1tl-I76X5ztlDVbU59ROHsocbQfLF6OTj8lK1wQ' \
    -d '{"name":"Test ca 02 updated"}'

Example response

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

{
  "id" : "527abbc9-59bd-4a16-8dc4-27099e46be00",
  "ownerIdentityId" : "3ac11c55-2bb7-4ef8-9a7e-f5ebe91c9d85",
  "createdBy" : "3ac11c55-2bb7-4ef8-9a7e-f5ebe91c9d85",
  "createdAt" : "2024-11-15T02:30:17.590150Z",
  "updatedAt" : "2024-11-15T02:30:17.899145Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "bc92431c-d86d-40af-8a79-1a6fbd600316",
  "zitiId" : "ziti.id.6uascdth",
  "name" : "Test ca 02 updated",
  "endpointAttributes" : [ ],
  "verificationToken" : "token",
  "fingerprint" : "fingerprint",
  "jwt" : "jwt",
  "certPem" : "fake-pem",
  "identityNameFormat" : "name-format",
  "verified" : false,
  "authEnabled" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/527abbc9-59bd-4a16-8dc4-27099e46be00",
      "title" : "Test ca 02 updated"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/bc92431c-d86d-40af-8a79-1a6fbd600316"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/56ace37f-afde-4094-b0ff-1e1d98d74bb6",
      "title" : "Update CertificateAuthority",
      "profile" : "meta"
    }
  }
}

Delete Certificate Authority

DELETE /v2/certificate-authorities/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/374ff2bd-37a3-4352-a42e-17383f5a92f8' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZR1RHZVVSSllsS0t2c0MwQWRhV3lBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMyNGU3NWViLWI2NzUtNDU2ZS1iODQ5LTFjM2Q3NzE1MTFjZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzgxOCwiZXhwIjoxNzMxNjQxNDE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBhYTIwNjMxLTQ5YmItNGI5Ny04OWQyLWI2NDIzMmMyMzk5NVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzgxOH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.OMiFIiRtng2d_BQHGQCFkR9BFUPobvOAXBqrrJA0x2c1z6AAb_mZO_gbAEf8YfbkuFx8dtNBOugYiicXV1qq1jP0ONgYXhsv38EXQ8NBsZU-I7xTuxTYiGCZKmQdCE-ih2xfTasHLfj1aXhqpDhx82ahr9E6PbYC0JXW2S8F2HFLxChbdg9QeAh_-6I5IeDwZy6IMbEv-RSDnf1sm7MChZc1StV-ngJPpPHHVYBtAXw_NxF4I0jt4QFvBDxiKMtCUvZC-jMSbqMPirS6K7NwDxR8NAigPzQsEFfMltW1oSU5MJC59qLgYzN8wyZjjNTjVsK1e_IkZEfAgFSvb5n51Q'

Example response

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

{
  "id" : "374ff2bd-37a3-4352-a42e-17383f5a92f8",
  "ownerIdentityId" : "cf40a678-b145-4e40-98bd-8d86157e70a6",
  "createdBy" : "cf40a678-b145-4e40-98bd-8d86157e70a6",
  "createdAt" : "2024-11-15T02:30:18.643246Z",
  "updatedAt" : "2024-11-15T02:30:18.897022Z",
  "deletedBy" : "c24e75eb-b675-456e-b849-1c3d771511cf",
  "deletedAt" : "2024-11-15T02:30:18.896Z",
  "networkId" : "6bb417f9-46b8-4926-995f-545affc23286",
  "zitiId" : "ziti.id.6us7d6um",
  "name" : "ca-89",
  "endpointAttributes" : [ ],
  "verificationToken" : "token",
  "fingerprint" : "fingerprint",
  "jwt" : "jwt",
  "certPem" : "fake-pem",
  "identityNameFormat" : "name-format",
  "verified" : false,
  "authEnabled" : false,
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/374ff2bd-37a3-4352-a42e-17383f5a92f8",
      "title" : "ca-89"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/6bb417f9-46b8-4926-995f-545affc23286"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/a6db0dbd-9445-48d0-bb83-2899007eb855",
      "title" : "Delete CertificateAuthority",
      "profile" : "meta"
    }
  }
}

Find Certificate Authorities

GET /v2/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

isAutoCaEnrollment

Boolean

true

Deprecated..

isOttCaEnrollmentEnabled

Boolean

true

Deprecated..

isAuthEnabled

Boolean

true

Deprecated..

isVerified

Boolean

true

Deprecated..

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

networkId

String

true

zitiId

String

true

name

String

true

endpointAttributes

Array[String]

true

verificationToken

String

true

fingerprint

String

true

jwt

String

true

certPem

String

true

identityNameFormat

String

true

verified

Boolean

true

authEnabled

Boolean

true

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJPM0laai1KV0RCOHNmS1pzTllmTnFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdmZmY2OTU2LTYwZTctNDk4ZS1iNTY4LWFkNTExM2RjNGI2YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk0MCwiZXhwIjoxNzMxNjQxNTQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ4OTdjNDRmLTQwNTAtNGQyYS05Y2NmLWQ5Y2U2YzVhNjY1Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.K-f14eByT2xDmjn5ePPceGMPJreHgWwS-ePzDLPdFnSS750SznAxGh8NmML_NLCb2SHrJTP3zAapyuhfSIgVdoz8rzsJOGuOHpqmA7tGiymWYtJuW8FocjV3EcZXUEIO_ZJhngRpXyAVXuMSnGSCb0tcqo4bD_-6HMKtzrNHh8KNntQxsuAlm5yZXKqpOfH58DCbehZwSQFKvkOOiVFTyM-g6aUSOITMBaY3BP2VqJKjqr-NX8UqRyCzcjT_dkL3bVqdVO5qTu3A2bb2h0DUjhTIi0Df-RoRVq3Vl90RLFpEzXcnuXjRc7Zz1oWKQNeWS1eqW4mkIOLhsgl9dkJjSA'

Example response

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

{
  "_embedded" : {
    "certificateAuthorityList" : [ {
      "id" : "489f8d08-62c2-4e4e-aeab-c8cf43cf18f6",
      "ownerIdentityId" : "a8620780-7b1b-48f8-9614-65050ee156fb",
      "createdBy" : "a8620780-7b1b-48f8-9614-65050ee156fb",
      "createdAt" : "2024-11-15T02:32:20.698058Z",
      "updatedAt" : "2024-11-15T02:32:20.698837Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "5a4be143-e8d1-4777-b726-84e30fda5a17",
      "zitiId" : "ziti-id-05d5aacd-eaaf-43c9-8f97-96fbea12946e",
      "name" : "Find Test CA 2",
      "endpointAttributes" : [ ],
      "verificationToken" : "token",
      "fingerprint" : "fingerprint",
      "jwt" : "jwt",
      "certPem" : "fake-pem",
      "identityNameFormat" : "name-format",
      "verified" : true,
      "authEnabled" : true,
      "autoCaEnrollmentEnabled" : true,
      "ottCaEnrollmentEnabled" : true,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/5a4be143-e8d1-4777-b726-84e30fda5a17"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/489f8d08-62c2-4e4e-aeab-c8cf43cf18f6",
          "title" : "Find Test CA 2"
        }
      }
    }, {
      "id" : "c9b32f7c-a58b-438f-ba6f-93fe8f1b0f34",
      "ownerIdentityId" : "a8620780-7b1b-48f8-9614-65050ee156fb",
      "createdBy" : "a8620780-7b1b-48f8-9614-65050ee156fb",
      "createdAt" : "2024-11-15T02:32:20.692715Z",
      "updatedAt" : "2024-11-15T02:32:20.696881Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "5a4be143-e8d1-4777-b726-84e30fda5a17",
      "zitiId" : "ziti-id-a3fd6114-d4b7-4bdb-89da-74b45c53274b",
      "name" : "Find Test CA 1",
      "endpointAttributes" : [ ],
      "verificationToken" : "token",
      "fingerprint" : "fingerprint",
      "jwt" : "jwt",
      "certPem" : "fake-pem",
      "identityNameFormat" : "name-format",
      "verified" : false,
      "authEnabled" : false,
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/5a4be143-e8d1-4777-b726-84e30fda5a17"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/c9b32f7c-a58b-438f-ba6f-93fe8f1b0f34",
          "title" : "Find Test CA 1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Service Edge Router Policies

Find Service Edge Router Policies

GET /v2/service-edge-router-policies

Authorization

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

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

zitiId

String

true

name

String

true

semantic

String

true

Must be one of [AllOf, AnyOf].

serviceAttributes

Array[String]

true

edgeRouterAttributes

Array[String]

true

exclusiveType

String

true

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

exclusiveToId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJYNTM2MzJDdml2RmVCSG1CZFZfcG1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc4YjMxZjYzLTI1NTYtNDcyOC04ZDMzLWU1NzljYzBkYjBlZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk3MywiZXhwIjoxNzMxNjQxNTczLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjM0NjI5NzMzLTE2ZDMtNDlhOS1hZjRiLTljMmZkNjE0ZTBjNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk3M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.eUuyCpJtigVwzR7neLcssp9BX9cacDjeac_DKQvC2sEOfqey9KOpwb-aQkDwpsQoz6xCKbrtqWSDJRVThDTVN8MeLIQyBX9kNHRfTHxdVVqjFVCoReqKvUBTOXTTvBnHWdwusNulPIVzu3i--Sxi2CeVEncxAkXBle4LXQAj0lsIUaq9epBNK006j3dkfmhlCX-EZRjqxEQ4Dx9lpp4PP63VJuvnUK2_s10MxMU4i4LbtqzIt6m8SVJfbLip0lfQrCLjtZTVIGOoVE6AI3b9Qtonn3QcvIzp7VUrvxn2kZ6Kh46vJ-NF_TjkPIUCFRBW64sDPezpcVtDdK7b5yEEEA'

Example response

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

{
  "_embedded" : {
    "serviceEdgeRouterPolicyList" : [ {
      "id" : "75d3e8d1-55e0-4724-b892-d52463d4291e",
      "networkId" : "e0ccc16c-51cd-4723-a307-a095c7a5ba4c",
      "zitiId" : "ziti.id.8tjh5gcm",
      "name" : "My Service Edge Router Policy 691075852878",
      "semantic" : "AnyOf",
      "serviceAttributes" : [ "#router-3" ],
      "edgeRouterAttributes" : [ "#service-1", "#service-5" ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "efc29b05-5e88-4093-a76e-89afd34de332",
      "createdBy" : "efc29b05-5e88-4093-a76e-89afd34de332",
      "createdAt" : "2024-11-15T02:32:52.657840Z",
      "updatedAt" : "2024-11-15T02:32:52.665587Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e0ccc16c-51cd-4723-a307-a095c7a5ba4c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/75d3e8d1-55e0-4724-b892-d52463d4291e",
          "title" : "My Service Edge Router Policy 691075852878"
        }
      }
    }, {
      "id" : "b94b9fb0-508b-4b3f-9348-9760a4a2286b",
      "networkId" : "89ccd48b-7c8d-4750-b2d6-dafbe0bbaa1b",
      "zitiId" : "ziti.id.8ti49hkh",
      "name" : "My Service Edge Router Policy 691073125456",
      "semantic" : "AnyOf",
      "serviceAttributes" : [ "#router-3" ],
      "edgeRouterAttributes" : [ "#service-1", "#service-5" ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "a930f438-c59b-4bc1-bf2c-e832402c7687",
      "createdBy" : "a930f438-c59b-4bc1-bf2c-e832402c7687",
      "createdAt" : "2024-11-15T02:32:52.567685Z",
      "updatedAt" : "2024-11-15T02:32:52.585845Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/89ccd48b-7c8d-4750-b2d6-dafbe0bbaa1b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/b94b9fb0-508b-4b3f-9348-9760a4a2286b",
          "title" : "My Service Edge Router Policy 691073125456"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Service Edge Router Policy

GET /v2/service-edge-router-policies/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/75d3e8d1-55e0-4724-b892-d52463d4291e' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI3VXB0XzhFQWtZRFVsZnBCR0d0REdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA5ZDA3ZGU5LThhZTQtNDI4MS1hYzFkLTRkOTRmMGI1MTdlYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk3MiwiZXhwIjoxNzMxNjQxNTcyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZiMGZlMjgxLWQ0MWMtNDJiNy05YjhhLTI2YzI1N2I2OTBiNFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk3Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.O68B0Ig41rbKsfDln-oeFlcLhb2LatHEOxwsFSk9xKm3khN2w-JN4jVytgESe5NvTh5U8-zxfX_46lRY94D1tfk_8ZrmsP3V0D0Zk54Q6kBJGy6aOInpHIyC5nx1eHt8EvbFMEbcJ5ZNeP_TQ6BLLqf9D5wfstdxc4sTnWYG0EsWu5MTIu9UkYRLQyPgENStO6-QWE9cmOLGFL_3BA7vN9dR68EMFK5s68F3O08pohJqtl0KgF4-KVyeKeQy2v-L2F-9KdlMeNRFWLeoUWkLidI9-E7IPlcJx0WVyyM1vBaOSGyNFrBF9ZX-9OVrs_3aHOsM6lXSe5xp4I3YHIdeHA'

Example response

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

{
  "id" : "75d3e8d1-55e0-4724-b892-d52463d4291e",
  "networkId" : "e0ccc16c-51cd-4723-a307-a095c7a5ba4c",
  "zitiId" : "ziti.id.8tjh5gcm",
  "name" : "My Service Edge Router Policy 691075852878",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ "#service-2", "#service-1" ],
  "edgeRouterAttributes" : [ "#router-1", "#router-2" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "efc29b05-5e88-4093-a76e-89afd34de332",
  "createdBy" : "efc29b05-5e88-4093-a76e-89afd34de332",
  "createdAt" : "2024-11-15T02:32:52.657840Z",
  "updatedAt" : "2024-11-15T02:32:52.665587Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e0ccc16c-51cd-4723-a307-a095c7a5ba4c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/75d3e8d1-55e0-4724-b892-d52463d4291e",
      "title" : "My Service Edge Router Policy 691075852878"
    }
  }
}

Create Service Edge Router Policy

POST /v2/service-edge-router-policies

Authorization

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

networkId

String

true

name

String

true

semantic

String

true

Must be one of [AllOf, AnyOf].

edgeRouterAttributes

Array[String]

true

serviceAttributes

Array[String]

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI4R0J3WUQ4YnZYQmtveW91dFhKYWRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVmYzI5YjA1LTVlODgtNDA5My1hNzZlLTg5YWZkMzRkZTMzMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk3MiwiZXhwIjoxNzMxNjQxNTcyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg0N2FhYmNjLTFjZmYtNGZmMi04MzlkLTBmZjRkODM3ZTMzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk3Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.UEaspj9z7essuFF9TghjwX338v97CiYeahiugoj_d18fdVhX3PKVbVm9fi1RqvtGsluODxxrVdyaUoccI_-G0IfwdCwAaxse4tbowVdVzOyG6Pubg8UG1mEobEHz0DtohwLBpS_wlW_eGEjjoOlw-3rD2CpmqkKVSUWU_fc9IlOnL4pr0CBMIxx4XWKJAx0vKX13lVEr8lidegjLQdK0s5lh5rBYvf-2m2z4hQ3HKLqEkUeT-Zf4b0PMfeCCVFlCrbiCnkRsgg2lEwUCTOSyEvFeXU7uqP15hoMtESTZh_zk60mjQoETjmG3vFC9FfKziSXC3lbXTGjQDplJB9pyzg' \
    -d '{"networkId":"e0ccc16c-51cd-4723-a307-a095c7a5ba4c","name":"My Service Edge Router Policy 691075852878","semantic":"AnyOf","edgeRouterAttributes":["#router-1","#router-2"],"serviceAttributes":["#service-1","#service-2"]}'

Example response

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

{
  "id" : "75d3e8d1-55e0-4724-b892-d52463d4291e",
  "networkId" : "e0ccc16c-51cd-4723-a307-a095c7a5ba4c",
  "zitiId" : "ziti.id.8tjh5gcm",
  "name" : "My Service Edge Router Policy 691075852878",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ "#service-2", "#service-1" ],
  "edgeRouterAttributes" : [ "#router-1", "#router-2" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "efc29b05-5e88-4093-a76e-89afd34de332",
  "createdBy" : "efc29b05-5e88-4093-a76e-89afd34de332",
  "createdAt" : "2024-11-15T02:32:52.657840Z",
  "updatedAt" : "2024-11-15T02:32:52.665587Z",
  "deletedBy" : null,
  "deletedAt" : null
}

Update Service Edge Router Policy

PATCH /v2/service-edge-router-policies/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

semantic

String

true

Must be one of [AllOf, AnyOf].

serviceAttributes

Array[String]

true

edgeRouterAttributes

Array[String]

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/75d3e8d1-55e0-4724-b892-d52463d4291e' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJmcWR5N19LZUxQV2dnaXNrSnJwSXNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIyMGFkYWE5LThmZmMtNGFiOC1iYTE1LTE0YmZlYzI0ZjlmNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk3MiwiZXhwIjoxNzMxNjQxNTcyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImUyNjI4YWFlLTU4ZTctNDI1NC1hMzY1LWFkYzdkZWEyNTA5ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk3Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.QTnJ3IhbRNeyXfg0m4rq7E7GZ3Ucw248NDIfmEHO_ObtOfHzFK3eDVR5BGlueKUo1DVxx9idVBnurJ-N27MzpY9hR22cLl0HACVecr1Rp2RFIFNDHloZOU7mMk76-8fDOQUGY3NzZciKzNCX68AndDrcBf8Vsxq-Y_MJJTzEfO4_F3Aopc4e74SrTFYadZTw8bmFYXqYhNbV0bhcgIRchTBXDop_IIDLYe6kXKJ1MoNBvdjYQS9ob2ViooMtAM_pMQB56pq5gyzYI6bTQ_HQ1Dvd08rlHUr-60fT1oqzxuoPl2cxJhKN7vMlkDvsoHLtQIsPJeq7dvOL8ZHcbrjNmA' \
    -d '{"name":"My Service Edge Router Policy 691075852878","semantic":"AllOf","serviceAttributes":["#router-3"],"edgeRouterAttributes":["#service-1","#service-5"]}'

Example response

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

{
  "id" : "75d3e8d1-55e0-4724-b892-d52463d4291e",
  "networkId" : "e0ccc16c-51cd-4723-a307-a095c7a5ba4c",
  "zitiId" : "ziti.id.8tjh5gcm",
  "name" : "My Service Edge Router Policy 691075852878",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ "#router-3" ],
  "edgeRouterAttributes" : [ "#service-1", "#service-5" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "efc29b05-5e88-4093-a76e-89afd34de332",
  "createdBy" : "efc29b05-5e88-4093-a76e-89afd34de332",
  "createdAt" : "2024-11-15T02:32:52.657840Z",
  "updatedAt" : "2024-11-15T02:32:52.665587Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e0ccc16c-51cd-4723-a307-a095c7a5ba4c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/75d3e8d1-55e0-4724-b892-d52463d4291e",
      "title" : "My Service Edge Router Policy 691075852878"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/3428bd5a-df1e-4a12-84f1-2fee80dd6d87",
      "title" : "Update ServiceEdgeRouterPolicy",
      "profile" : "meta"
    }
  }
}

Delete Service Edge Router Policy

DELETE /v2/service-edge-router-policies/{id}

Authorization

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

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/75d3e8d1-55e0-4724-b892-d52463d4291e' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDalNBdkc3bjZuaUFudTROUDQyWFBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRjN2VmODQyLWJlMDgtNDkwNC1iZWQzLTAxMTFjZmEwYTE1YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk3MywiZXhwIjoxNzMxNjQxNTczLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjlkMDE1MTE4LWNmYTktNDY0ZC04YTFlLTQ0OTE3OTdlZDRiN1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk3M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.RpkAt2Sen3ZWmEHeVo4K6P4nQRbCQVVp1IfnpCW1I_kMSOQ41NOekIda1Ey6eUpGS1pZ0VXh3dcmOwPPhdYxlt0cRnHQ9AyUlcBmDzRYnivQuLfUAJkWAwQ8C7ngDOR-Cnpn-_vZSaHmoOKbU4QYVENxXAVJINVUx-ZE-spE-wT3W8YLXFnFkoOzMnSnqEIZMANqfdP5rR_L5Lbafp9umZqdR5ZW3EjErlSbrvbJox1aVLc87drvY2yVIinrB2XfIJAF7YJCJ3o68eUPexBt5DMD9R1_tl8bjmOfEh5ARJVwID8jgE4yHwDqRFFzHAzR2DeDRJk89b-JPtUuDhGZoQ'

Example response

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

{
  "id" : "75d3e8d1-55e0-4724-b892-d52463d4291e",
  "networkId" : "e0ccc16c-51cd-4723-a307-a095c7a5ba4c",
  "zitiId" : null,
  "name" : "My Service Edge Router Policy 691075852878",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ ],
  "edgeRouterAttributes" : [ ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "efc29b05-5e88-4093-a76e-89afd34de332",
  "createdBy" : "efc29b05-5e88-4093-a76e-89afd34de332",
  "createdAt" : "2024-11-15T02:32:52.657840Z",
  "updatedAt" : "2024-11-15T02:32:53.112959Z",
  "deletedBy" : "dc7ef842-be08-4904-bed3-0111cfa0a15a",
  "deletedAt" : "2024-11-15T02:32:53.106Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e0ccc16c-51cd-4723-a307-a095c7a5ba4c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/75d3e8d1-55e0-4724-b892-d52463d4291e",
      "title" : "My Service Edge Router Policy 691075852878"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/c37cdc71-dc9a-4f62-b571-fcadbb422a94",
      "title" : "Delete ServiceEdgeRouterPolicy",
      "profile" : "meta"
    }
  }
}

Service Policies

Find Service Policies

GET /v2/service-policies

Authorization

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

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

zitiId

String

true

name

String

true

type

String

true

Must be one of [Dial, Bind].

semantic

String

true

Must be one of [AllOf, AnyOf].

serviceAttributes

Array[String]

true

endpointAttributes

Array[String]

true

postureCheckAttributes

Array[String]

true

exclusiveType

String

true

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

exclusiveToId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-policies' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJmQzJZaU5MeWJPdExmZ1RLbm1VbWRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ1NDRhYzU4LTNlY2MtNDYxMi05ZmY3LTk3Y2E2MDBmMjQyNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg5NywiZXhwIjoxNzMxNjQxNDk3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhlODU4MzYxLTZlNDEtNDJlMC04MzViLTM5MjQwZjcyMDkwMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg5N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.iukIwksEZ6uEfegZZYzUwsZq9bDilNXwOn6YR4BrnzE85UPhpK7qcOhFBeU19dkKkiGLy-YmnXKruGNOHMFUrt9-HJjBN331SERsNC2k7tmDTFIMIAWiJg0CN0AZuKIqyrKAiNJcbJppLkzfWWUic8DNmg52NuRppxQN5i6RcOYkJahHIftv2oIDWyRZweCaNev-ZuwlFBBRqY2LILsYmrAIx4o1lb5AibXL2jpw_ItMlzXVz3-kscKXuNnIxuioCjB1ot5uVFBW_Q95ryNco9_sbnEY6fmp1qzCNzyxMHjXqvOg68XhWHpSc7ERLRfr4NxEJ-QaDO59rjSiLr6fcQ'

Example response

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

{
  "_embedded" : {
    "servicePolicyList" : [ {
      "id" : "5574a2f3-d7cb-4a99-b320-64bece352a56",
      "networkId" : "d1b65740-42b2-40e3-b423-5c5a7d03a2bd",
      "zitiId" : "6DnPzh1X7se2Us9ZdUzE6",
      "name" : "Find Test Service Policy 1",
      "type" : "Dial",
      "semantic" : "AnyOf",
      "serviceAttributes" : [ "#seAttr1", "#seAttr2" ],
      "endpointAttributes" : [ "#epAttr2", "#epAttr1" ],
      "postureCheckAttributes" : [ ],
      "exclusiveType" : "service",
      "exclusiveToId" : "b1b42b00-546b-4c8f-935a-74f1ca47281e",
      "ownerIdentityId" : "7aa6d42d-322d-4193-8a23-86ce6e536c66",
      "createdBy" : "7aa6d42d-322d-4193-8a23-86ce6e536c66",
      "createdAt" : "2024-11-15T02:31:36.979797Z",
      "updatedAt" : "2024-11-15T02:31:37.017015Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/5574a2f3-d7cb-4a99-b320-64bece352a56",
          "title" : "Find Test Service Policy 1"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d1b65740-42b2-40e3-b423-5c5a7d03a2bd",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "ae174548-07fa-42f9-b386-a3da7cdfe40f",
      "networkId" : "d1b65740-42b2-40e3-b423-5c5a7d03a2bd",
      "zitiId" : "r6WbnhxQLdQqY8mkdBtOc",
      "name" : "Find Test Service Policy 2",
      "type" : "Bind",
      "semantic" : "AllOf",
      "serviceAttributes" : [ "#seAttr1", "#seAttr3" ],
      "endpointAttributes" : [ "#epAttr1" ],
      "postureCheckAttributes" : [ ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "7aa6d42d-322d-4193-8a23-86ce6e536c66",
      "createdBy" : "7aa6d42d-322d-4193-8a23-86ce6e536c66",
      "createdAt" : "2024-11-15T02:31:37.018551Z",
      "updatedAt" : "2024-11-15T02:31:37.024327Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/ae174548-07fa-42f9-b386-a3da7cdfe40f",
          "title" : "Find Test Service Policy 2"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d1b65740-42b2-40e3-b423-5c5a7d03a2bd",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-policies/559012f7-60bb-4717-8f36-c8ecf95cc807' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJJc1lSYUJWczVPX0xtbXdyNmVjc3lBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBmODllYWUzLTQ0NDUtNGQ5YS04ZmU5LWQ5NGM2MmI4MmQ4ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg2OCwiZXhwIjoxNzMxNjQxNDY4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFlNzk0OTBjLTc3NmQtNDY2ZC04Njk4LTkyYzM4MjgzY2UzZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.mZRvKZ3dg4XqCyv7FaEEt6bxfoEOLA_QLbFRr9QFP9tCiomE2S_xcuB71VIupjYcQRcMUZ8LKmM-Zp3deyXVGiUECV3ixZbiz9CAz0U2y6Vsx90n4oib743ub_OQv9bHhLk91APPoL0xAu2o4BP9syUwYBIfABf4CRMyENOOqEvG-hc9e4kSzlldlt76QKT0p8YATTgytmgacn2BpgqLzcabOdd5eo06tuB5FYIr2U7OsJiIXCx5MYuFNbihLvCwotXdWRV15DjuncHtUUyOWXPDsy5d2JG9LDPSJN_jd7XbaAKM29wqGE0agxWObkzxc-kHMt-0SZhmSbxTh-fLBQ'

Example response

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

{
  "id" : "559012f7-60bb-4717-8f36-c8ecf95cc807",
  "networkId" : "1fc55548-034f-4445-887d-c972e1aee22c",
  "zitiId" : "ziti.id.7hgfy7rp",
  "name" : "My Service Policy 585867757320",
  "type" : "Dial",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ "#service-2", "#service-1" ],
  "endpointAttributes" : [ "#endpoint-1", "#endpoint-2" ],
  "postureCheckAttributes" : [ "#posture-2", "#posture-1" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "952a6175-f20f-483b-99cf-9cce07084a63",
  "createdBy" : "952a6175-f20f-483b-99cf-9cce07084a63",
  "createdAt" : "2024-11-15T02:31:07.919907Z",
  "updatedAt" : "2024-11-15T02:31:07.996775Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1fc55548-034f-4445-887d-c972e1aee22c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/559012f7-60bb-4717-8f36-c8ecf95cc807",
      "title" : "My Service Policy 585867757320"
    }
  }
}

Optional

Description

networkId

String

true

name

String

true

type

String

true

Must be one of [Dial, Bind].

semantic

String

true

Must be one of [AllOf, AnyOf].

serviceAttributes

Array[String]

true

endpointAttributes

Array[String]

true

postureCheckAttributes

Array[String]

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-policies' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJrWW1mSXktenQwU2tjckx1UDN6Q3B3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk1MmE2MTc1LWYyMGYtNDgzYi05OWNmLTljY2UwNzA4NGE2MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg2NywiZXhwIjoxNzMxNjQxNDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQzYWNhMmZkLWVkMjgtNDU5Ni04NjJhLTJhZjU1NTEwN2E1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.pTLeDgnQMp3liGFRUaceKE-yyXF937qGWH4E3H-u9z1dbzfjAv_cuAQ7z1JknhzMiD30O7QvYXCTdlOZMcS9L_0PbSfarZFklAXzdFN7W7Rv14vD-O6eeL_GBQnrbFZ6Xy9j5hWJ7Zv_xC9yxchQu8pMPRxIzVwPihGDIRDRUCcM86ApQxC2LpZ7o05R9rxFVbNKhkbE0FAObB5BOoCtFc7Tjcf5lyAjvYen4msQhxmV4k4URzX46e_Ls6JP4m82Tub99hoQr82IWm0igCUy0V8zMO1ORDmAx_ZvYdVcyXhkieoYtjBvEl0q-_R506Zux5nZ50KVGFH-DPKSt_t22Q' \
    -d '{"networkId":"1fc55548-034f-4445-887d-c972e1aee22c","name":"My Service Policy 585867757320","type":"Dial","semantic":"AnyOf","serviceAttributes":["#service-1","#service-2"],"endpointAttributes":["#endpoint-1","#endpoint-2"],"postureCheckAttributes":["#posture-1","#posture-2"]}'

Example response

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

{
  "id" : "559012f7-60bb-4717-8f36-c8ecf95cc807",
  "networkId" : "1fc55548-034f-4445-887d-c972e1aee22c",
  "zitiId" : "ziti.id.7hgfy7rp",
  "name" : "My Service Policy 585867757320",
  "type" : "Dial",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ "#service-2", "#service-1" ],
  "endpointAttributes" : [ "#endpoint-1", "#endpoint-2" ],
  "postureCheckAttributes" : [ "#posture-2", "#posture-1" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "952a6175-f20f-483b-99cf-9cce07084a63",
  "createdBy" : "952a6175-f20f-483b-99cf-9cce07084a63",
  "createdAt" : "2024-11-15T02:31:07.919907Z",
  "updatedAt" : "2024-11-15T02:31:07.996775Z",
  "deletedBy" : null,
  "deletedAt" : null
}

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

type

String

true

Must be one of [Dial, Bind].

semantic

String

true

Must be one of [AllOf, AnyOf].

serviceAttributes

Array[String]

true

endpointAttributes

Array[String]

true

postureCheckAttributes

Array[String]

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-policies/559012f7-60bb-4717-8f36-c8ecf95cc807' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJsNHZ4UEdXMDAzamNsb2VzVnFjYzVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRiMjY1ODAxLTU0NDQtNDE1OS1hMDJjLTBkYjVhZGY5MTg3YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg2OCwiZXhwIjoxNzMxNjQxNDY4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImUwNTVhNjAwLWJlYTEtNDQ1ZS05MjA1LTc4YjQ5NjVhNmE2NlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.M2m-1SDmMv-o_mylhjNo8SKISiANT0jRfOkjvBxg_sBUc6vrcbylrREzAD2MDwtoRtgE2yMBF2ZvG1dE4lm1jkNSislCYfmcHNW_-RApGboV44z4_FcwVraaC3e0Q39g2cWPgrlL0KWY7f-Ns6OsRmngek-zNs7bV5lvu4wq5-emXQ6-AwT_XCBh4qUCpwOanwDPsb4NOxOJmWOfNJxuQV5bZltYwMI6k32oX7RKHD-tpjXwWxc7ZxqLvydscSnb9tucNAh7CqSCUTqnnnNwmYkRquKKEsP4Uo5hXse8lFi_YdbPjBYpRQlJ0YjK08WGXpd3-epCF8y4N6f0jqcgEw' \
    -d '{"name":"My Service Policy 585867757320","type":"Bind","semantic":"AllOf","serviceAttributes":["#service-1","#service-5"],"endpointAttributes":["#endpoint-3"],"postureCheckAttributes":["#posture-3","#posture-2","#posture-1"]}'

Example response

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

{
  "id" : "559012f7-60bb-4717-8f36-c8ecf95cc807",
  "networkId" : "1fc55548-034f-4445-887d-c972e1aee22c",
  "zitiId" : "ziti.id.7hgfy7rp",
  "name" : "My Service Policy 585867757320",
  "type" : "Bind",
  "semantic" : "AllOf",
  "serviceAttributes" : [ "#service-1", "#service-5" ],
  "endpointAttributes" : [ "#endpoint-3" ],
  "postureCheckAttributes" : [ "#posture-2", "#posture-3", "#posture-1" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "952a6175-f20f-483b-99cf-9cce07084a63",
  "createdBy" : "952a6175-f20f-483b-99cf-9cce07084a63",
  "createdAt" : "2024-11-15T02:31:07.919907Z",
  "updatedAt" : "2024-11-15T02:31:08.965772Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1fc55548-034f-4445-887d-c972e1aee22c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/559012f7-60bb-4717-8f36-c8ecf95cc807",
      "title" : "My Service Policy 585867757320"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/4c4bd871-e22a-4afd-a9ba-fb38e47fe4a4",
      "title" : "Update ServicePolicy",
      "profile" : "meta"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/service-policies/559012f7-60bb-4717-8f36-c8ecf95cc807' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJwY3luWVN5Nm11VzlwbnMxZHJ6dzNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRjMzA1NmE4LWJlM2QtNDM1Ni05OWRiLTk0NTQyMGU3MTg4ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg2OSwiZXhwIjoxNzMxNjQxNDY5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImU3MThkYmQ3LWI1ZmYtNGEyNC1hYzU0LTQ2Y2U3Njg5MWUwNFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.QR475oEGGxhNGWy4olMu7dox7aI1tEgl6A0aTSHlOKw805gg0T0xEVSfPyCgT8C4V16KTWj0jJ18KLqn2Kd8kqQgbbvqfxg427656scWZogirU2KUznIhk1P75-xW321sS1Ss7-FhxX-AwXxwcoiKpi7QrF37ZUecyGKrjusZelvcfvC8QhuLElPxLM5YZxMBOhiyNpj-qW_rVP0KCL5EdN88VYVFd0_Wk4E8Kl-qPidtrxutjnAHQkEOjKJ9FL40vvas2kFBd1XQN-PMXObgvIkC5X6IIQydPrRbvdqBZ0HRhWaA3btpXWzPS_aJVANZIlVv_mCuV_Nmb3p6YCUvw'

Example response

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

{
  "id" : "559012f7-60bb-4717-8f36-c8ecf95cc807",
  "networkId" : "1fc55548-034f-4445-887d-c972e1aee22c",
  "zitiId" : null,
  "name" : "My Service Policy 585867757320",
  "type" : "Bind",
  "semantic" : "AllOf",
  "serviceAttributes" : [ ],
  "endpointAttributes" : [ ],
  "postureCheckAttributes" : [ ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "952a6175-f20f-483b-99cf-9cce07084a63",
  "createdBy" : "952a6175-f20f-483b-99cf-9cce07084a63",
  "createdAt" : "2024-11-15T02:31:07.919907Z",
  "updatedAt" : "2024-11-15T02:31:09.514177Z",
  "deletedBy" : "4c3056a8-be3d-4356-99db-945420e7188e",
  "deletedAt" : "2024-11-15T02:31:09.492Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1fc55548-034f-4445-887d-c972e1aee22c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/559012f7-60bb-4717-8f36-c8ecf95cc807",
      "title" : "My Service Policy 585867757320"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/246fa6b2-8334-4344-83ed-532b553edd72",
      "title" : "Delete ServicePolicy",
      "profile" : "meta"
    }
  }
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

zitiId

String

true

serviceId

String

true

routerId

String

true

binding

String

true

Must be one of [edge, edge_transport, transport, transport_udp, tunnel, udp, proxy, proxy_udp].

address

String

true

endpointId

String

true

cost

Integer

true

precedence

String

true

Must be one of [default, required, failed].

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/terminators' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJUYzN0bDNKSEkwbFRSTEdtaUpKODdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjczNDhjMzhkLTAzNzYtNDBjZi04OWVlLWQxMzE3MTk1NmYxZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg2NCwiZXhwIjoxNzMxNjQxNDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjAwZWU2YjI4LTdhNDQtNDY1ZS1hYzk4LTczNzBmZGY5YzM2ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.pyd8pRjm8hOx32ZPsemNNdqH16MjVy0SLiGIc_ActOoaxZ1XzGX5r3E4GODCdfDkujOEGGfN9cX8XZC7FfLfcXW1h0POGA1ftuCmEBw6-5li39vu9RQCt7Np0tg5v0TPhM22NQAZEk2Uzx9RUUkj3PTkiAvN8oDG3MG7Nw9yu35wBEoTSaVGOL3xH_o8gG3q1BpvlJynwkQp0lt6s17wq9_ZwsdAJIFPU3K4LgQkKWpDtCkVl0502VEN7j4BKxdY1qvV2r-Db8YnzKsdfNFA7qx_NzoaOeoRvKpps3Ie4cgnnQZ1Vtc43MzUsHIBvi_V0x0wFTEWE42YX-gBisZo-g'

Example response

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

{
  "_embedded" : {
    "terminatorList" : [ {
      "id" : "5bc85384-1389-4c4c-b233-c9b5256ab5ed",
      "networkId" : "5a2cc1dd-7d35-4afd-a6e0-db8acc5ac417",
      "zitiId" : "hxWNmjaqU-diumFVg0YJj",
      "serviceId" : "6f9e1f0f-2315-4c8a-811c-362be8c4287e",
      "routerId" : "3d79320a-d832-44e0-b90a-5d352d813fcb",
      "binding" : "edge_transport",
      "address" : "1.2.3.4",
      "endpointId" : "4d3f191b-e8b5-43d3-ac37-5f16e5d9417d",
      "cost" : 20,
      "precedence" : "default",
      "ownerIdentityId" : "e2b8d5d5-e3ca-4837-9759-8833b18eabe5",
      "createdBy" : "e2b8d5d5-e3ca-4837-9759-8833b18eabe5",
      "createdAt" : "2024-11-15T02:31:04.109298Z",
      "updatedAt" : "2024-11-15T02:31:04.113489Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5a2cc1dd-7d35-4afd-a6e0-db8acc5ac417",
          "profile" : "parent"
        },
        "service" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/6f9e1f0f-2315-4c8a-811c-362be8c4287e"
        },
        "endpoint" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/4d3f191b-e8b5-43d3-ac37-5f16e5d9417d"
        },
        "edge-router" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/3d79320a-d832-44e0-b90a-5d352d813fcb"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators/5bc85384-1389-4c4c-b233-c9b5256ab5ed"
        }
      }
    }, {
      "id" : "c4786218-8226-419d-8c47-5aff2e78fbe4",
      "networkId" : "5a2cc1dd-7d35-4afd-a6e0-db8acc5ac417",
      "zitiId" : "TJHj9Yi9tTNTvPGeaiOmG",
      "serviceId" : "6f9e1f0f-2315-4c8a-811c-362be8c4287e",
      "routerId" : "3d79320a-d832-44e0-b90a-5d352d813fcb",
      "binding" : "transport",
      "address" : "1.2.3.4",
      "endpointId" : "4d3f191b-e8b5-43d3-ac37-5f16e5d9417d",
      "cost" : 10,
      "precedence" : "required",
      "ownerIdentityId" : "e2b8d5d5-e3ca-4837-9759-8833b18eabe5",
      "createdBy" : "e2b8d5d5-e3ca-4837-9759-8833b18eabe5",
      "createdAt" : "2024-11-15T02:31:04.084181Z",
      "updatedAt" : "2024-11-15T02:31:04.107816Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5a2cc1dd-7d35-4afd-a6e0-db8acc5ac417",
          "profile" : "parent"
        },
        "service" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/6f9e1f0f-2315-4c8a-811c-362be8c4287e"
        },
        "endpoint" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/4d3f191b-e8b5-43d3-ac37-5f16e5d9417d"
        },
        "edge-router" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/3d79320a-d832-44e0-b90a-5d352d813fcb"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators/c4786218-8226-419d-8c47-5aff2e78fbe4"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/terminators/f0e7dd4a-3d8d-4289-9e67-10fa8ef77ef1' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJKaGFoYjRqT05QbEp6a1JnXzdEZ05nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc5ZjkyNDAyLTc3NDUtNDgwMi05NGZjLWRmYTZmYTRhMTIzZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA0NywiZXhwIjoxNzMxNjQxNjQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhmYzc4MjE3LTQ2MDItNDdlZS1iNGVlLWZmNWY3MzljNWRkOVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ng_56OjlAblt_PCWcFsW4b4KE1ppHtB1jqgAsZArmEzGdjRO1H5eF63Xi4VMZuRQaqNVe4aK2Xpq8Mb7cEIXee99rZU55M9k8hn1ZiR5_eDOSvk1ZYY28JyACRbJIj9FI0-fd7vDk_hNFMmX1Op2oUgjagEQCHUCiMLZ_OytYT7yf70EeHUxETIh4orkOGc9Z-eOymM6uFXRftBfFN9UIcY647cUpP5AKB2hVQ8lJ8m1yEkn4R-5-PFjARhnKPCCvr8np2LjSOg2V5Nhv7iEg0hvttTIOPjUptHj75BSeuHAjMe33cDrWd1KNQIocwMfT29xa_F0_brSlJuAmRU4_A'

Example response

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

{
  "id" : "f0e7dd4a-3d8d-4289-9e67-10fa8ef77ef1",
  "networkId" : "224add3b-fe75-476a-ab35-df9388798d66",
  "zitiId" : "ziti.id.9rvy4xm5",
  "serviceId" : "8eab19c7-251c-4307-834e-723d63b01a99",
  "routerId" : "48df3a8a-e5ac-415b-b82c-19c212d895ad",
  "binding" : "transport",
  "address" : "tcp:1.2.3.4:12345",
  "endpointId" : null,
  "cost" : 10,
  "precedence" : "default",
  "ownerIdentityId" : "08807aab-608b-4beb-b4b1-082ff256f3ab",
  "createdBy" : "08807aab-608b-4beb-b4b1-082ff256f3ab",
  "createdAt" : "2024-11-15T02:34:07.426733Z",
  "updatedAt" : "2024-11-15T02:34:07.430151Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/224add3b-fe75-476a-ab35-df9388798d66",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators/f0e7dd4a-3d8d-4289-9e67-10fa8ef77ef1"
    },
    "service" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/8eab19c7-251c-4307-834e-723d63b01a99"
    },
    "edge-router" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/48df3a8a-e5ac-415b-b82c-19c212d895ad"
    }
  }
}

Create Terminator

POST /v2/terminators

Authorization

This endpoint requires the following actions:

create action on the terminator resource type
read action on the service resource type
read action on the edge-router resource type

Optional

Description

networkId

String

true

serviceId

String

true

routerId

String

true

routerName

String

true

binding

String

true

Must be one of [edge, edge_transport, transport, transport_udp, tunnel, udp, proxy, proxy_udp].

address

String

true

endpointId

String

true

cost

Integer

true

precedence

String

true

Must be one of [default, required, failed].

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/terminators' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI3U1YySHotTDBJa2tfSmsyN1VvWkd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA4ODA3YWFiLTYwOGItNGJlYi1iNGIxLTA4MmZmMjU2ZjNhYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA0NywiZXhwIjoxNzMxNjQxNjQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZlMDg3ZDJiLWE4ZGItNGJlZi1hN2FiLWE1N2FiYTFkZDQyYVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0N30se1wiaWRcIjpcImMxNDBkZjg5LTgwZmMtNGRiMS05NTM1LTI5MmY2ZmE5MjBmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0N30se1wiaWRcIjpcImQ0MTI0MjNiLWQyNjItNGM1NC1iYmFkLTdmYjE0ODVlOGVmNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.HXqn2g4tlATnZQmXyVYvh6v3eByWpO0xbS_QEZ2Iz_fFhqgchyiHL06beATSS4O41o-KOTddwJyEfFPDuDuO1x99MUJt3XkT6GBDUBqMy6we7jzWkZ2wCYCJJwtVPvCYtQAJSM7qRudABiAooR_ir9q7kkJXO9rIZx-KQmfwjDNWY2RvOrmkZYMn7I5jrRs4Yy0fA-1nzJxXuRFrVJz75_cu24sdcx_zuQ6JM2JPdkZW2BPmpHogOpWy3YXwwOVKZlX5XKhBS-CM6n9nBsu-1T1fjq6M2uX0v_P2qJa4SD0EKtgJNqa8-3eFwCJ6ecplw7Qg_4uufXcVG_3cMnBxsg' \
    -d '{"networkId":"224add3b-fe75-476a-ab35-df9388798d66","serviceId":"8eab19c7-251c-4307-834e-723d63b01a99","routerId":"48df3a8a-e5ac-415b-b82c-19c212d895ad","routerName":null,"binding":"transport","address":"tcp:1.2.3.4:12345","endpointId":null,"cost":10,"precedence":"default"}'

Example response

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

{
  "id" : "f0e7dd4a-3d8d-4289-9e67-10fa8ef77ef1",
  "networkId" : "224add3b-fe75-476a-ab35-df9388798d66",
  "zitiId" : "ziti.id.9rvy4xm5",
  "serviceId" : "8eab19c7-251c-4307-834e-723d63b01a99",
  "routerId" : "48df3a8a-e5ac-415b-b82c-19c212d895ad",
  "binding" : "transport",
  "address" : "tcp:1.2.3.4:12345",
  "endpointId" : null,
  "cost" : 10,
  "precedence" : "default",
  "ownerIdentityId" : "08807aab-608b-4beb-b4b1-082ff256f3ab",
  "createdBy" : "08807aab-608b-4beb-b4b1-082ff256f3ab",
  "createdAt" : "2024-11-15T02:34:07.426733Z",
  "updatedAt" : "2024-11-15T02:34:07.430151Z",
  "deletedBy" : null,
  "deletedAt" : null
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/terminators/f0e7dd4a-3d8d-4289-9e67-10fa8ef77ef1' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJLMWNWQlFXTVItWExPTlN0ZjNvRjJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUxZGNjOTkxLWVmMjMtNGEyMi1iN2RjLTViYTM2MzcyNWM2MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA0NywiZXhwIjoxNzMxNjQxNjQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg5MjBmYTZjLTZjNzctNDY2MC1hMmEwLTc2ZjdmNGVjMzEyOVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.IOwWzqaSlrdQRMhQzSeL-f9MvUXxJxmnLGtFDIRdqz_ZEv9iofNvrhdfZNiN5pQLEeg1i2os6yxf5LJUd93VVKvIL7XAYkZgzjBjsQgy3rxyHqXgSY702RB-NMKU2ABRSAFsE8xcaQ1zAKiLcc_d-6XGGgqIQcbprOFysNZburYZH7loBQMdkD18ap5PF1igx-OUVDPuLn0MTV0seKnzPLdh5VWcWkX0BFBetKdYgHhCWeX_UZv_ydA-seVMQCPnqAK2mSwKOc60WD45EOtrgOAJ9xWrQKknQVs_h20H9VmOk28gajKMku1JpULV7pV6oSnQU3uKR-krS_XrCSCZeQ'

Example response

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

{
  "id" : "f0e7dd4a-3d8d-4289-9e67-10fa8ef77ef1",
  "networkId" : "224add3b-fe75-476a-ab35-df9388798d66",
  "zitiId" : null,
  "serviceId" : "8eab19c7-251c-4307-834e-723d63b01a99",
  "routerId" : "48df3a8a-e5ac-415b-b82c-19c212d895ad",
  "binding" : "transport",
  "address" : "tcp:1.2.3.4:12345",
  "endpointId" : null,
  "cost" : 10,
  "precedence" : "default",
  "ownerIdentityId" : "08807aab-608b-4beb-b4b1-082ff256f3ab",
  "createdBy" : "08807aab-608b-4beb-b4b1-082ff256f3ab",
  "createdAt" : "2024-11-15T02:34:07.426733Z",
  "updatedAt" : "2024-11-15T02:34:07.633362Z",
  "deletedBy" : "e1dcc991-ef23-4a22-b7dc-5ba363725c60",
  "deletedAt" : "2024-11-15T02:34:07.629Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/224add3b-fe75-476a-ab35-df9388798d66",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators/f0e7dd4a-3d8d-4289-9e67-10fa8ef77ef1"
    },
    "service" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/8eab19c7-251c-4307-834e-723d63b01a99"
    },
    "edge-router" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/48df3a8a-e5ac-415b-b82c-19c212d895ad"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/035e7d1b-a670-4290-b7d3-9b2872e8666f",
      "title" : "Delete Terminator",
      "profile" : "meta"
    }
  }
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

name

String

true

configTypeId

String

true

zitiId

String

true

data

Object

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

exclusiveToId

String

true

addressAndPortIndex

Map

true

exclusiveTo

String

true

Deprecated..

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/configs' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyX2RGc3lNT0dzVHFvcGUwdTFheHJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAzYWEzYjExLTQ0MmItNGUzMi05ODg5LWZkYzVmZjYzZGZkOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAzOSwiZXhwIjoxNzMxNjQxNjM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZkZjJjY2NlLTQzYTItNDhlOC1iZmE2LTY4MjhkMDgwY2Q0OFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAzOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ECD-jRY2-57HCBCrHgRJDtkvkjkb2LgEg0y70hK2uKFRw6F2ZpBl_Uxf3IJR1If5z43vfa_O4VU0Ih_bbIxB3dRexENjj2-o6PdoM7glE9Ug5DauZyIR0Cd9XpEgdc8dBULDbyJqgSrx4VHV95sqo_pLpZvtGZnmOIFU-Ukc6VOLBmjjIedDzN2BGISjp2DQSdFnj0RzjyIzAYF-MPGNg1xTh8EAxTKK-bNjXwpQ7PpvuK_KdeI9gNKkyeL-zR1dNDQx_N6ppxRirIBqVMBKuVauzwLiHgs2OHDbih1L3MI12jo1Fgg7Kyqj6do1-yk4eg-Qj6PSs7TYt_R-lFgg_A'

Example response

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

{
  "_embedded" : {
    "configList" : [ {
      "id" : "6d3ad793-e904-4199-b88c-0af478dcc5a8",
      "networkId" : "d23480e9-b0e7-4ba9-9418-40ca47432ddd",
      "name" : "My Config 756971252707",
      "configTypeId" : "65919822-fdcb-421b-b6ed-1b018b2c2d71",
      "zitiId" : "ziti.id.9nvme56u",
      "data" : {
        "hostname" : "abc.com",
        "port" : 11222
      },
      "ownerIdentityId" : "413e0955-4e44-4f02-9d8d-91354af0590c",
      "createdBy" : "413e0955-4e44-4f02-9d8d-91354af0590c",
      "createdAt" : "2024-11-15T02:33:58.697512Z",
      "updatedAt" : "2024-11-15T02:33:58.703460Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "exclusiveToId" : null,
      "addressAndPortIndex" : null,
      "exclusiveTo" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d23480e9-b0e7-4ba9-9418-40ca47432ddd",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs/6d3ad793-e904-4199-b88c-0af478dcc5a8",
          "title" : "My Config 756971252707"
        },
        "configType" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/65919822-fdcb-421b-b6ed-1b018b2c2d71",
          "deprecation" : "Use config-type link instead"
        },
        "config-type" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/65919822-fdcb-421b-b6ed-1b018b2c2d71"
        }
      }
    }, {
      "id" : "88e2b1c2-31de-47b6-9c10-2620147ec282",
      "networkId" : "d23480e9-b0e7-4ba9-9418-40ca47432ddd",
      "name" : "My Config 756971679397",
      "configTypeId" : "35e1c947-b4b8-43fb-8a60-70cd6702c9b3",
      "zitiId" : "ziti.id.9nu8bnbr",
      "data" : {
        "number" : 2303,
        "street_name" : "Ziti",
        "street_type" : "Boulevard"
      },
      "ownerIdentityId" : "0f707cc9-2100-4cb6-86bd-4595bec366a8",
      "createdBy" : "0f707cc9-2100-4cb6-86bd-4595bec366a8",
      "createdAt" : "2024-11-15T02:33:58.594237Z",
      "updatedAt" : "2024-11-15T02:33:58.620315Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "exclusiveToId" : null,
      "addressAndPortIndex" : null,
      "exclusiveTo" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d23480e9-b0e7-4ba9-9418-40ca47432ddd",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs/88e2b1c2-31de-47b6-9c10-2620147ec282",
          "title" : "My Config 756971679397"
        },
        "configType" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/35e1c947-b4b8-43fb-8a60-70cd6702c9b3",
          "deprecation" : "Use config-type link instead"
        },
        "config-type" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/35e1c947-b4b8-43fb-8a60-70cd6702c9b3"
        }
      }
    }, {
      "id" : "af64951a-73aa-44fc-bc58-eac99f1f3b60",
      "networkId" : "f6dfbbf4-a506-4ca3-8d7e-453c94d4d4f2",
      "name" : "My Config 756977339786",
      "configTypeId" : "fb0101f4-9717-4f47-b69f-4b67730c25f5",
      "zitiId" : "ziti.id.9ny0bqq1",
      "data" : {
        "number" : 2303,
        "street_name" : "Ziti",
        "street_type" : "Boulevard"
      },
      "ownerIdentityId" : "992bb229-9c84-407b-ae95-4037145f2da5",
      "createdBy" : "992bb229-9c84-407b-ae95-4037145f2da5",
      "createdAt" : "2024-11-15T02:33:58.835999Z",
      "updatedAt" : "2024-11-15T02:33:58.847664Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "exclusiveToId" : null,
      "addressAndPortIndex" : null,
      "exclusiveTo" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f6dfbbf4-a506-4ca3-8d7e-453c94d4d4f2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs/af64951a-73aa-44fc-bc58-eac99f1f3b60",
          "title" : "My Config 756977339786"
        },
        "configType" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/fb0101f4-9717-4f47-b69f-4b67730c25f5",
          "deprecation" : "Use config-type link instead"
        },
        "config-type" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/fb0101f4-9717-4f47-b69f-4b67730c25f5"
        }
      }
    }, {
      "id" : "fc44d3f0-06e9-46a2-9bbd-89ab961de24b",
      "networkId" : "f6dfbbf4-a506-4ca3-8d7e-453c94d4d4f2",
      "name" : "My Config 756977053664",
      "configTypeId" : "2ebe1478-f7cb-4851-a36c-f0afdf8d4278",
      "zitiId" : "ziti.id.9nz8nnyw",
      "data" : {
        "hostname" : "abc.com",
        "port" : 11222
      },
      "ownerIdentityId" : "3bd290e0-5f4b-4ca7-a8ce-fdbb7954ef56",
      "createdBy" : "3bd290e0-5f4b-4ca7-a8ce-fdbb7954ef56",
      "createdAt" : "2024-11-15T02:33:58.912356Z",
      "updatedAt" : "2024-11-15T02:33:58.922220Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "exclusiveToId" : null,
      "addressAndPortIndex" : null,
      "exclusiveTo" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f6dfbbf4-a506-4ca3-8d7e-453c94d4d4f2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs/fc44d3f0-06e9-46a2-9bbd-89ab961de24b",
          "title" : "My Config 756977053664"
        },
        "configType" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/2ebe1478-f7cb-4851-a36c-f0afdf8d4278",
          "deprecation" : "Use config-type link instead"
        },
        "config-type" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/2ebe1478-f7cb-4851-a36c-f0afdf8d4278"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/configs/fc44d3f0-06e9-46a2-9bbd-89ab961de24b' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJrZmpvOWE3QllZbmNpTk1lQkJwejZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY5YmViYzU3LThmMzItNDJkYS05YzUwLWE4N2UwOTUzMTIzNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAzOSwiZXhwIjoxNzMxNjQxNjM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjM3NDNkMjI0LTNiMDYtNDViNy05NDM3LTVkMGUzZGNiOTRhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAzOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.GOttFdEQFaBJdutB7WHwHcHOkZeF3rrLHpuHnMNE9vRoFXgbo_erC9PE03nJTEBJmSYDRSsEW9QI7npmnFv5j8Clf8c-LXAq5ntwG1heXesw7b_tsLUXixXRZVKcaHEcMomTdK-6URSAsI_2KS97r-xQwWamk1odNdpF17ClNUxad0VkLk7HfBimuXNzXgjpRLcy8NH1ByrX8b3_JVbTLRGdeNsereoR4oD6UqxxUsD8I68BN3YL76cZp04RkrxTDgo0KAXNweFWel3SGvcXNI7w7i7ExFcTD2lygzFB-MaXAH9KtvKasZeUepp3ZzxgOlSpp6Jg2MxI4kcwRozILg'

Example response

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

{
  "id" : "fc44d3f0-06e9-46a2-9bbd-89ab961de24b",
  "networkId" : "f6dfbbf4-a506-4ca3-8d7e-453c94d4d4f2",
  "name" : "My Config 756977053664",
  "configTypeId" : "2ebe1478-f7cb-4851-a36c-f0afdf8d4278",
  "zitiId" : "ziti.id.9nz8nnyw",
  "data" : {
    "hostname" : "abc.com",
    "port" : 11222
  },
  "ownerIdentityId" : "3bd290e0-5f4b-4ca7-a8ce-fdbb7954ef56",
  "createdBy" : "3bd290e0-5f4b-4ca7-a8ce-fdbb7954ef56",
  "createdAt" : "2024-11-15T02:33:58.912356Z",
  "updatedAt" : "2024-11-15T02:33:58.922220Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "exclusiveToId" : null,
  "addressAndPortIndex" : null,
  "exclusiveTo" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f6dfbbf4-a506-4ca3-8d7e-453c94d4d4f2",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs/fc44d3f0-06e9-46a2-9bbd-89ab961de24b",
      "title" : "My Config 756977053664"
    },
    "configType" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/2ebe1478-f7cb-4851-a36c-f0afdf8d4278",
      "deprecation" : "Use config-type link instead"
    },
    "config-type" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/2ebe1478-f7cb-4851-a36c-f0afdf8d4278"
    }
  }
}

Create Config

POST /v2/configs

Authorization

This endpoint requires the following actions:

create action on the config resource type
create action on the config-type resource type

Optional

Description

networkId

String

true

name

String

true

configTypeId

String

true

configTypeName

String

true

configType

Object

true

configType.networkId

String

true

configType.name

String

true

configType.schema

Object

true

data

Object

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/configs' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJzZXVyb0UxMXVjSEc4Z3I5UmVQTVl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNiZDI5MGUwLTVmNGItNGNhNy1hOGNlLWZkYmI3OTU0ZWY1NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAzOCwiZXhwIjoxNzMxNjQxNjM4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ5Y2RkODE4LTY3ODYtNDk5OC1iMTFjLWJjMDUwODNhNzY4Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAzOH0se1wiaWRcIjpcIjg3YWNiMWQ3LTE1MzgtNDIyMi1hYzNkLTQ2OGE5ZDQzMDU3MlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAzOH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.LQUyJO0SSzNPxEXmqBa4rMaYFOe88ovjLoZsrjfw9PGCMfszwRTdON2M2xg-CftyX_IR2MeUhQrkqval5oCM3emt-wDoW77EW5klRmRqEdMF3PHb9LdqhMG91phSc9aCVBu4lxlav0nzrf8XVYQbIfumYqXDp6Y21ddEpdpJAj8xSWcc9DVi-lNXTgDXOcFnsm5hBFDYHj68luSnXn4Dv9QC61Wgerjbf6k7NfsAiYYm1x9RUonhRvXqwQp7qZsDOXOtaC-mm_N_RpiJry_41FIN0NumG_T8EuT94tDCjvH3-vLaK2Ui8sETrt89_0_69J0VLvYCRjG7qmRosZVCNw' \
    -d '{"networkId":"f6dfbbf4-a506-4ca3-8d7e-453c94d4d4f2","name":"My Config 756977053664","configTypeId":null,"configTypeName":"ziti-tunneler-client.v1","configType":null,"data":{"hostname":"abc.com","port":11222}}'

Example response

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

{
  "id" : "fc44d3f0-06e9-46a2-9bbd-89ab961de24b",
  "networkId" : "f6dfbbf4-a506-4ca3-8d7e-453c94d4d4f2",
  "name" : "My Config 756977053664",
  "configTypeId" : "2ebe1478-f7cb-4851-a36c-f0afdf8d4278",
  "zitiId" : "ziti.id.9nz8nnyw",
  "data" : {
    "hostname" : "abc.com",
    "port" : 11222
  },
  "ownerIdentityId" : "3bd290e0-5f4b-4ca7-a8ce-fdbb7954ef56",
  "createdBy" : "3bd290e0-5f4b-4ca7-a8ce-fdbb7954ef56",
  "createdAt" : "2024-11-15T02:33:58.912356Z",
  "updatedAt" : "2024-11-15T02:33:58.922220Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "exclusiveToId" : null,
  "addressAndPortIndex" : null,
  "exclusiveTo" : null
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/configs/fc44d3f0-06e9-46a2-9bbd-89ab961de24b' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiItd2NSQ2NVSEZZWURFczRCTk5kR0tBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZmOWMzYTE4LWQzNjEtNDY3NC1iYmIwLWM3M2E4MmViMWNhMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAzOSwiZXhwIjoxNzMxNjQxNjM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjc3NmRkYTcxLTFiNWQtNGE5ZS1hNzY4LWIzM2U4OGY5MzFlMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAzOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.IyHdJi5zwFFqkAUH35cWpn9JMShJJpHiNRVZuRn0eIHhZYFEyhUuKvx4kvYwYherzVvMxejqguhKLUOHAlvESWYh9nrlOEWqOh0DfL-45vucUV9EYY_K-uvBZUM-_xPZ6FbYyZPBBhoNHcwMjIaVuA8junIyednOPpuqawFcM9gzgnRqHjSGbZ9WcaAWxdWyxiHHxkc1-bApQnGF_5cl6da3ujy4irfaDbi2zKKHcHEr4QyyevArh5NqAlNL3OjKqTCduR7HPFyTaFsVNCxI-itkNhS4MoViScpvelSXje_snEjNeRo5_4ELDE5FI2btDOgMS5aAWsC60zGlYwxgVg'

Example response

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

{
  "id" : "fc44d3f0-06e9-46a2-9bbd-89ab961de24b",
  "networkId" : "f6dfbbf4-a506-4ca3-8d7e-453c94d4d4f2",
  "name" : "My Config 756977053664",
  "configTypeId" : "2ebe1478-f7cb-4851-a36c-f0afdf8d4278",
  "zitiId" : null,
  "data" : {
    "hostname" : "abc.com",
    "port" : 11222
  },
  "ownerIdentityId" : "3bd290e0-5f4b-4ca7-a8ce-fdbb7954ef56",
  "createdBy" : "3bd290e0-5f4b-4ca7-a8ce-fdbb7954ef56",
  "createdAt" : "2024-11-15T02:33:58.912356Z",
  "updatedAt" : "2024-11-15T02:33:59.437733Z",
  "deletedBy" : "6f9c3a18-d361-4674-bbb0-c73a82eb1ca2",
  "deletedAt" : "2024-11-15T02:33:59.434Z",
  "exclusiveToId" : null,
  "addressAndPortIndex" : null,
  "exclusiveTo" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f6dfbbf4-a506-4ca3-8d7e-453c94d4d4f2",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs/fc44d3f0-06e9-46a2-9bbd-89ab961de24b",
      "title" : "My Config 756977053664"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/5f49eaa0-1798-4d71-a8f7-d7984c1f33b8",
      "title" : "Delete Config",
      "profile" : "meta"
    },
    "configType" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/2ebe1478-f7cb-4851-a36c-f0afdf8d4278",
      "deprecation" : "Use config-type link instead"
    },
    "config-type" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/2ebe1478-f7cb-4851-a36c-f0afdf8d4278"
    }
  }
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

name

String

true

zitiId

String

true

schema

Object

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

exclusiveToId

String

true

reserved

Boolean

true

exclusiveTo

String

true

Deprecated..

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/config-types' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJtT3ctUTRPS1RXcm9ENnZ0NjlvRDVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFmOTE5YTZkLTNkNWItNGJlNC05NWMzLWI3Nzk1YzE3MWM3MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk3NCwiZXhwIjoxNzMxNjQxNTc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk3ZjllODllLTEyNTAtNGIwOC05NmJjLTZkOWEyZGNhNDM4MFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Ktl8DFO3ZU-GJXz4C6mN959Shdw8HNpfIPsgXeEOlXWIVVsRtXra0Y8-EDmBvphWH2oPAeSOjebgUsny2dVPPr8VENW8197vk5WfmD40-XOYxesJBduqtt4J_R1WFkKGvvTGF4PAPr__IcJi9vpRxZMsY4XkaSwmxWxvoqPTDGq9eLDnmM99le_HXsLK1sJk3AzjExjk7Yd-tndzvDTat7kUDnxLzIVFamJatlQsEz98D5YSRinKvTODoPiABm4QIz598yMcU6He9EI9GLplfUaBWHuK6Xuh9G3gsPf6GLhfLhBpFwVa9FPr4GcwQ--uMKIBWAyrWxF4YX8grXMO6w'

Example response

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

{
  "_embedded" : {
    "configTypeList" : [ {
      "id" : "10725aaf-e6dd-4c4d-ad5b-e9f192053dcd",
      "networkId" : "efc4087d-a7f3-45c3-affc-e6884e1512e2",
      "name" : "My ConfigType 691916410133",
      "zitiId" : "ziti.id.8u9eykpz",
      "schema" : {
        "type" : "object",
        "properties" : {
          "number" : {
            "type" : "number"
          },
          "street_name" : {
            "type" : "string"
          },
          "street_type" : {
            "type" : "string",
            "enum" : [ "Street", "Avenue", "Boulevard" ]
          }
        }
      },
      "ownerIdentityId" : "23c7e847-8d49-455a-a89f-e608e85b2c7f",
      "createdBy" : "23c7e847-8d49-455a-a89f-e608e85b2c7f",
      "createdAt" : "2024-11-15T02:32:54.217268Z",
      "updatedAt" : "2024-11-15T02:32:54.234124Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "reserved" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/efc4087d-a7f3-45c3-affc-e6884e1512e2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/10725aaf-e6dd-4c4d-ad5b-e9f192053dcd",
          "title" : "My ConfigType 691916410133"
        }
      }
    }, {
      "id" : "78dcf2b1-1cae-418b-8e76-f81356b695f4",
      "networkId" : "efcb0f2c-cebd-4394-8f59-6eccc0ac0b5a",
      "name" : "My ConfigType 691911147235",
      "zitiId" : "ziti.id.8u6u556g",
      "schema" : {
        "type" : "object",
        "properties" : {
          "number" : {
            "type" : "number"
          },
          "street_name" : {
            "type" : "string"
          },
          "street_type" : {
            "type" : "string",
            "enum" : [ "Street", "Avenue", "Boulevard" ]
          }
        }
      },
      "ownerIdentityId" : "d193f1a1-1790-4b61-a343-1aaa80908b50",
      "createdBy" : "d193f1a1-1790-4b61-a343-1aaa80908b50",
      "createdAt" : "2024-11-15T02:32:54.066559Z",
      "updatedAt" : "2024-11-15T02:32:54.078405Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "reserved" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/efcb0f2c-cebd-4394-8f59-6eccc0ac0b5a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/78dcf2b1-1cae-418b-8e76-f81356b695f4",
          "title" : "My ConfigType 691911147235"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/config-types/10725aaf-e6dd-4c4d-ad5b-e9f192053dcd' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJJN2U2dzh5cVA1Y1NCQW9yWXFBTC1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJlYTkyZjU4LWUwNjUtNGRjYi05OTU4LTU4MTgyN2E4OTc2YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk3NCwiZXhwIjoxNzMxNjQxNTc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU2NmNjZmVmLWVkNWUtNGVlZC1hNjQ4LWFhZTM1YzM0MTNiYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.g_q0EykjiyapTqjSsSN_sex8vSbnH466xKscwLku6PwNpYYQqYkJqvKbVBOXX_c0m6_GfbZLW_y5p1HRJMk7acEUrffYiK4lzWhxZ_zOTht_DQ3XEGERz_NLlwEJQpo4Zg0BakwRWwxXaqMRPemNbuwGz9PsPtZQR-9hJ93NTWIaRCnq0HbWpgpUziDXHWSSBuCOBW4kj-HcTjsVXOUxU2l0mMA8g6DNvTrE2zMdWUeEf_ZnwrDEHhcsrafWlk8pPiHFyUGQJRjgdxAVeE1OZo37LUEq5V2JHVPAzf4GSxxWt_4sag87GEfnvpk03APWAY1O_iHpW9CCg4woNiqcdQ'

Example response

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

{
  "id" : "10725aaf-e6dd-4c4d-ad5b-e9f192053dcd",
  "networkId" : "efc4087d-a7f3-45c3-affc-e6884e1512e2",
  "name" : "My ConfigType 691916410133",
  "zitiId" : "ziti.id.8u9eykpz",
  "schema" : {
    "type" : "object",
    "properties" : {
      "number" : {
        "type" : "number"
      },
      "street_name" : {
        "type" : "string"
      },
      "street_type" : {
        "type" : "string",
        "enum" : [ "Street", "Avenue", "Boulevard" ]
      }
    }
  },
  "ownerIdentityId" : "23c7e847-8d49-455a-a89f-e608e85b2c7f",
  "createdBy" : "23c7e847-8d49-455a-a89f-e608e85b2c7f",
  "createdAt" : "2024-11-15T02:32:54.217268Z",
  "updatedAt" : "2024-11-15T02:32:54.234124Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "reserved" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/efc4087d-a7f3-45c3-affc-e6884e1512e2",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/10725aaf-e6dd-4c4d-ad5b-e9f192053dcd",
      "title" : "My ConfigType 691916410133"
    }
  }
}

Optional

Description

networkId

String

true

name

String

true

schema

Object

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/config-types' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJPeUQxRUJ0M0dhQnlpeVJqR0s5RWtnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIzYzdlODQ3LThkNDktNDU1YS1hODlmLWU2MDhlODViMmM3ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk3NCwiZXhwIjoxNzMxNjQxNTc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ2OThjMjJkLTA5MmQtNDg3MC1iZjc3LWJlNWU3OTRhMTdjNFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.HNHL6f2gmomh4ebXMJQpmCUv_nojVI6kwW6BvSKOLGteLVwrOMdP0JUnlICNozOrifg7NoXkhejkhfyZkS5Sm_yUgOlzypTihDbDaq98JP5294lvlC2Py9fHvGi6NM03WGniucQYpHdWSTb3apXybdBNUwyfOQ7dpKc0WfUx7eL2dq53bgO2CVmNLPQIVcRU__5fHxPdfBXFM5iJcbZTyx4QVO0P8A-awPUF0Yk2RgUfYli7JlkRBaFoZ05f_lL5kS_jl3HfU8hSdl56nJiaQuwtntK5DunGnyu9244LBrjp7Mj5VB4zkqzVr7YBQKal57uo4GyWIJNv0SI01BKfXw' \
    -d '{"networkId":"efc4087d-a7f3-45c3-affc-e6884e1512e2","name":"My ConfigType 691916410133","schema":{"type":"object","properties":{"number":{"type":"number"},"street_name":{"type":"string"},"street_type":{"type":"string","enum":["Street","Avenue","Boulevard"]}}}}'

Example response

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

{
  "id" : "10725aaf-e6dd-4c4d-ad5b-e9f192053dcd",
  "networkId" : "efc4087d-a7f3-45c3-affc-e6884e1512e2",
  "name" : "My ConfigType 691916410133",
  "zitiId" : "ziti.id.8u9eykpz",
  "schema" : {
    "type" : "object",
    "properties" : {
      "number" : {
        "type" : "number"
      },
      "street_name" : {
        "type" : "string"
      },
      "street_type" : {
        "type" : "string",
        "enum" : [ "Street", "Avenue", "Boulevard" ]
      }
    }
  },
  "ownerIdentityId" : "23c7e847-8d49-455a-a89f-e608e85b2c7f",
  "createdBy" : "23c7e847-8d49-455a-a89f-e608e85b2c7f",
  "createdAt" : "2024-11-15T02:32:54.217268Z",
  "updatedAt" : "2024-11-15T02:32:54.234124Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "reserved" : false
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/config-types/10725aaf-e6dd-4c4d-ad5b-e9f192053dcd' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDM0ZlWUhWLXlSOS1EdXlKak43XzBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY4NTIwNjc5LWVmNDktNDI3Mi1hN2E4LWJmOTJmYzk0OGMzYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk3NCwiZXhwIjoxNzMxNjQxNTc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjZkNDg2ZTI3LTk4ZDMtNDNhNi04YjZmLThlNDIxNjEyZDEyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.UUofpNPG4-nV-ZXKQbv3hn2wKnisOxhE365PKGBxyPpjYgETK5by6Tb2Vkqb4WbNjuppx3bVj-xzlXlwtPj1b7z5Ecfsy9GYM4Gs818sxBjS5VZZXWoqFjjgiprhWuF4qRLeCyVU_QdSO4mGwqS9e6RiTakMA4Hlr7XwZWQF35Xbqy2gHtWwpbuG3UzsufPP-OwEGpqDW9aTnxYxavqRt_PoOIF8KNxLu5m2FzRg1ctr9BwUdwDckQSbJpinnpWqPzUVtLAu34mvl3gDqmEleAvdu-9CTrQS0Cx8kxTVV7xjxIFtK67ruhcws0g5-gw_q5FmXhgt6dTtukJCpCuG4g'

Example response

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

{
  "id" : "10725aaf-e6dd-4c4d-ad5b-e9f192053dcd",
  "networkId" : "efc4087d-a7f3-45c3-affc-e6884e1512e2",
  "name" : "My ConfigType 691916410133",
  "zitiId" : null,
  "schema" : {
    "type" : "object",
    "properties" : {
      "number" : {
        "type" : "number"
      },
      "street_name" : {
        "type" : "string"
      },
      "street_type" : {
        "type" : "string",
        "enum" : [ "Street", "Avenue", "Boulevard" ]
      }
    }
  },
  "ownerIdentityId" : "23c7e847-8d49-455a-a89f-e608e85b2c7f",
  "createdBy" : "23c7e847-8d49-455a-a89f-e608e85b2c7f",
  "createdAt" : "2024-11-15T02:32:54.217268Z",
  "updatedAt" : "2024-11-15T02:32:54.656292Z",
  "deletedBy" : "68520679-ef49-4272-a7a8-bf92fc948c3b",
  "deletedAt" : "2024-11-15T02:32:54.650Z",
  "reserved" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/efc4087d-a7f3-45c3-affc-e6884e1512e2",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/10725aaf-e6dd-4c4d-ad5b-e9f192053dcd",
      "title" : "My ConfigType 691916410133"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/2c3a0b08-cdc5-4f15-bb3e-c00d6bdca5f7",
      "title" : "Delete ConfigType",
      "profile" : "meta"
    }
  }
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/auth-policies?id=ec73da4f-76b8-4db6-b6ed-b67f500eaf17' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJSUnhocUp0S0JERTBxNTY0Ql9pRXlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk2ZTMxYWU5LWI4YjQtNGI4Yy1hZDI4LTMzOTNiODRlZGFhZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAxMCwiZXhwIjoxNzMxNjQxNjEwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjRmZmQ0MDBkLWQ4OGItNGRlNy1iMDYwLWUwNjUwOGMwMzdiYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAxMH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.R6CIx3XsOjUFaxhUDmVUW3nRvPooo8z7fsechXA7kyxfR8KWbGLkyI0g8rSJXfMHJhvKa1ayVnmM6gXk_2xS8xFtwhK2vlIDe3dbmvticj8_bBarmOejE_L8n3cZYqp3nI_y2xk49anml84mfDOlsTaIr2c8sxV1KhqwEQby38-e_6lXapbkYSCqGCywZoHVUxaJvXwoFhUe76OOXSI6jj-6jY9z7K5yAdZEqABk6hB1NRVXqrfYaqvBjIR8SBFx6EFLU7wWixq528pgEGtCHypZ5miWrh7GmVharo3RSj3XaqDs6covrj5pW3xowEOozCaCTMLMUqZk4W0VegBTlQ'

Example response

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

[ {
  "id" : "ec73da4f-76b8-4db6-b6ed-b67f500eaf17",
  "networkId" : "bab5f7e8-e941-4959-ac58-89e071af348c",
  "zitiId" : "ziti.id.97ocqx2t",
  "name" : "Updated Test AuthPolicy",
  "primary" : {
    "cert" : {
      "allowed" : false,
      "allowExpiredCerts" : true
    },
    "extJwt" : {
      "allowed" : false,
      "allowedSigners" : [ "a8dd55b1-af7e-45fc-a01d-738a23822dcb", "0fb67952-bd01-4c05-b555-88ccda9dd16d" ]
    },
    "updb" : {
      "allowed" : true,
      "lockoutDurationMinutes" : 6,
      "maxAttempts" : 4,
      "minPasswordLength" : 9,
      "requireMixedCase" : false,
      "requireNumberChar" : false,
      "requireSpecialChar" : false
    }
  },
  "secondary" : {
    "requireExtJwtSigner" : "6275bf89-b8ba-4753-8ce8-ad81019b23b8",
    "requireTotp" : true
  },
  "createdBy" : "b07e3426-ee84-4e34-ad96-299a258f3bb9",
  "createdAt" : "2024-11-15T02:33:23.429317Z",
  "updatedAt" : "2024-11-15T02:33:30.194723Z",
  "appliedAt" : "2024-11-15T02:33:30.194723Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
} ]

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/auth-policies/ec73da4f-76b8-4db6-b6ed-b67f500eaf17?meta=ziti,diffZiti' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ2QWdsZFN4eGlVZ19WdGR2aHpwbmhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNmZjUxNDkzLTQ2ZTktNDhlYy1iYjI5LTRmZDAxY2NhY2ZkMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAwOSwiZXhwIjoxNzMxNjQxNjA5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBkZWE2NTA2LTY4YmEtNGNkNS05OWIxLTJhNzQxOWMxM2U2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAwOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.E58txV5Imcuw_k-_GHJmsPG2KZPeLGyzY1g1L2JEz161BwLz4qwEZTSx5sJ_1ZeIv5x6_2zZEPX-M-KweIfARxhrvPyfHC7U7JYJak64r9N9kfwt_BZKUUF4jsBj2EiShFAhdAAE-wmTVuaHqf62OKqduhBFKmXGDpr_4Pxv5ZCzq0qg_fM4jr1ViraP84iKtdITvP7P_pMSsvZgrmq59e7WlrkWUm-IxiqDohYbVXxsB8cglTDYiKtPtUdf5S44MQWMBUgmGAD2uOjP-T8pSaqICQIAu0NtBc_eBE8QcDd8IHAH42GNKiulQmGf7j8sctI_FUngv0d7s6GP8x0WNg'

Example response

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

{
  "id" : "ec73da4f-76b8-4db6-b6ed-b67f500eaf17",
  "networkId" : "bab5f7e8-e941-4959-ac58-89e071af348c",
  "zitiId" : "ziti.id.97ocqx2t",
  "name" : "Test AuthPolicy",
  "primary" : {
    "cert" : {
      "allowed" : true,
      "allowExpiredCerts" : false
    },
    "extJwt" : {
      "allowed" : true,
      "allowedSigners" : [ "26849469-a558-4781-a5b0-549d506a989a" ]
    },
    "updb" : {
      "allowed" : false,
      "lockoutDurationMinutes" : 5,
      "maxAttempts" : 3,
      "minPasswordLength" : 8,
      "requireMixedCase" : true,
      "requireNumberChar" : true,
      "requireSpecialChar" : true
    }
  },
  "secondary" : {
    "requireExtJwtSigner" : null,
    "requireTotp" : false
  },
  "createdBy" : "b07e3426-ee84-4e34-ad96-299a258f3bb9",
  "createdAt" : "2024-11-15T02:33:23.429317Z",
  "updatedAt" : "2024-11-15T02:33:23.439694Z",
  "appliedAt" : "2024-11-15T02:33:23.439694Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "_meta" : {
    "diffZiti" : {
      "differencesDetected" : false,
      "description" : "No differences detected",
      "comparedAt" : "2024-11-15T02:33:29.710407107Z"
    },
    "ziti" : {
      "id" : "ziti.id.97ocqx2t",
      "name" : "Test AuthPolicy",
      "primary" : {
        "cert" : {
          "allowExpiredCerts" : false,
          "allowed" : true
        },
        "extJwt" : {
          "allowed" : true,
          "allowedSigners" : [ "ziti-id-2929" ]
        },
        "updb" : {
          "allowed" : false,
          "lockoutDurationMinutes" : 5,
          "maxAttempts" : 3,
          "minPasswordLength" : 8,
          "requireMixedCase" : true,
          "requireNumberChar" : true,
          "requireSpecialChar" : true
        }
      },
      "secondary" : {
        "requireExtJwtSigner" : null,
        "requireTotp" : false
      },
      "tags" : {
        "network-id" : "bab5f7e8-e941-4959-ac58-89e071af348c",
        "resource-id" : "ec73da4f-76b8-4db6-b6ed-b67f500eaf17"
      },
      "createdAt" : "2024-11-15T02:33:23.439207066Z",
      "updatedAt" : "2024-11-15T02:33:23.439213666Z"
    }
  },
  "meta" : {
    "diffZiti" : {
      "differencesDetected" : false,
      "description" : "No differences detected",
      "comparedAt" : "2024-11-15T02:33:29.710407107Z"
    },
    "ziti" : {
      "id" : "ziti.id.97ocqx2t",
      "name" : "Test AuthPolicy",
      "primary" : {
        "cert" : {
          "allowExpiredCerts" : false,
          "allowed" : true
        },
        "extJwt" : {
          "allowed" : true,
          "allowedSigners" : [ "ziti-id-2929" ]
        },
        "updb" : {
          "allowed" : false,
          "lockoutDurationMinutes" : 5,
          "maxAttempts" : 3,
          "minPasswordLength" : 8,
          "requireMixedCase" : true,
          "requireNumberChar" : true,
          "requireSpecialChar" : true
        }
      },
      "secondary" : {
        "requireExtJwtSigner" : null,
        "requireTotp" : false
      },
      "tags" : {
        "network-id" : "bab5f7e8-e941-4959-ac58-89e071af348c",
        "resource-id" : "ec73da4f-76b8-4db6-b6ed-b67f500eaf17"
      },
      "createdAt" : "2024-11-15T02:33:23.439207066Z",
      "updatedAt" : "2024-11-15T02:33:23.439213666Z"
    }
  }
}

Create Auth Policy

POST /v2/auth-policies

Authorization

This endpoint requires the following actions:

create action on the auth-policy resource type
read action on the external-jwt-signer resource type

Optional

Description

networkId

String

true

name

String

true

primary

Object

true

primary.cert

Object

true

primary.cert.allowed

Boolean

true

primary.cert.allowExpiredCerts

Boolean

true

primary.extJwt

Object

true

primary.extJwt.allowed

Boolean

true

primary.extJwt.allowedSigners

Array[Object]

true

primary.updb

Object

true

primary.updb.allowed

Boolean

true

primary.updb.lockoutDurationMinutes

Integer

true

primary.updb.maxAttempts

Integer

true

primary.updb.minPasswordLength

Integer

true

primary.updb.requireMixedCase

Boolean

true

primary.updb.requireNumberChar

Boolean

true

primary.updb.requireSpecialChar

Boolean

true

secondary

Object

true

secondary.requireExtJwtSigner

String

true

secondary.requireTotp

Boolean

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/auth-policies' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZVnZacHJzUWFlMmhGRVRaVkcxVlZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIwN2UzNDI2LWVlODQtNGUzNC1hZDk2LTI5OWEyNThmM2JiOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAwMywiZXhwIjoxNzMxNjQxNjAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk5MTBjZDI5LTU2NzgtNDdiMS04MTIyLWU1YmE1YWZmMmUwZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAwM30se1wiaWRcIjpcImM0ZmRlNGUxLTk2NDQtNGIxZi05ZmY2LTZmMzY2M2FjNGJlMFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.qsA5z9ZP7bZa2-d-hpZK_UGSDpfnW7QYCOXRKhQanmnnOjy9njdinhXgx87V_uod2JvGU8300mzKu6scQ4uZg4Lcw32axMtjWLnCTU1nF5-pjmpEKE_TZM3vYzuTTpwn-JOlYvgCX4DK6iU5x9RPMhU6ZEGrSHhAggmaliIyalRVTM8GJORC4HdbkAcGhoVCcFKr6sG2KmNgsrcIsO29_bcFRF9PePYnlRM_5Iq0pGBn0Nf1h0tWvdgWm2yF3t-n8-L3pk2A6ADZXv3HMR9QO3hBEPhSq9UYR-sYvfZj7rYNLNYuj5rvVesjW2i5rypQol_qbiz5jf8iGueWuk1WBA' \
    -d '{"networkId":"bab5f7e8-e941-4959-ac58-89e071af348c","name":"Test AuthPolicy","primary":{"cert":{"allowed":true,"allowExpiredCerts":false},"extJwt":{"allowed":true,"allowedSigners":["26849469-a558-4781-a5b0-549d506a989a"]},"updb":{"allowed":false,"lockoutDurationMinutes":5,"maxAttempts":3,"minPasswordLength":8,"requireMixedCase":true,"requireNumberChar":true,"requireSpecialChar":true}},"secondary":{"requireExtJwtSigner":null,"requireTotp":false}}'

Example response

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

{
  "id" : "ec73da4f-76b8-4db6-b6ed-b67f500eaf17",
  "networkId" : "bab5f7e8-e941-4959-ac58-89e071af348c",
  "zitiId" : "ziti.id.97ocqx2t",
  "name" : "Test AuthPolicy",
  "primary" : {
    "cert" : {
      "allowed" : true,
      "allowExpiredCerts" : false
    },
    "extJwt" : {
      "allowed" : true,
      "allowedSigners" : [ "26849469-a558-4781-a5b0-549d506a989a" ]
    },
    "updb" : {
      "allowed" : false,
      "lockoutDurationMinutes" : 5,
      "maxAttempts" : 3,
      "minPasswordLength" : 8,
      "requireMixedCase" : true,
      "requireNumberChar" : true,
      "requireSpecialChar" : true
    }
  },
  "secondary" : {
    "requireExtJwtSigner" : null,
    "requireTotp" : false
  },
  "createdBy" : "b07e3426-ee84-4e34-ad96-299a258f3bb9",
  "createdAt" : "2024-11-15T02:33:23.429317Z",
  "updatedAt" : "2024-11-15T02:33:23.439694Z",
  "appliedAt" : "2024-11-15T02:33:23.439694Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Update Auth Policy

PATCH /v2/auth-policies/{id}

Authorization

This endpoint requires the following actions:

update action on the auth-policy resource type
read action on the external-jwt-signer resource type

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

primary

Object

true

primary.cert

Object

true

primary.cert.allowed

Boolean

true

primary.cert.allowExpiredCerts

Boolean

true

primary.extJwt

Object

true

primary.extJwt.allowed

Boolean

true

primary.extJwt.allowedSigners

Array[Object]

true

primary.updb

Object

true

primary.updb.allowed

Boolean

true

primary.updb.lockoutDurationMinutes

Integer

true

primary.updb.maxAttempts

Integer

true

primary.updb.minPasswordLength

Integer

true

primary.updb.requireMixedCase

Boolean

true

primary.updb.requireNumberChar

Boolean

true

primary.updb.requireSpecialChar

Boolean

true

secondary

Object

true

secondary.requireExtJwtSigner

Object

true

secondary.requireTotp

Boolean

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/auth-policies/ec73da4f-76b8-4db6-b6ed-b67f500eaf17' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJaWGM5b2RmMFNjWS1fbUVJdXRmWG93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEwN2Y2ZjQ3LWU2MTYtNGJiNC05YThjLWJiYWFjM2JiNDQ5NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAxMCwiZXhwIjoxNzMxNjQxNjEwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjYyMTRkYTk3LTAzNGYtNDFkNy04OWEyLWM3MjBlNWUxYWI1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAxMH0se1wiaWRcIjpcIjM0MjJjMTE3LTUyNmItNDJhZC05YTdkLWNiZGU3Yjg1NGQzYVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAxMH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ZTMQbS81RO84Vs2sG8tHS7lBrf8oO06rDXCcESHgqd-y73fXae7HWTUcJDJQaJ7QTh_RpStV6OmNjMpX_CA1pWj3rv-If-nDHm8eUOBM8a8uFB055mLGDxHFyxMJPXsVvj4zTqobFZ6ZOv96jgF-iZpfVcYd_6mO6APgOd7NcNso9w0Mzo64Lw44mfhZ4HSUWpI59TtT6mC0W5aA5DNXnj14B0rxAIi084p3xg5hqFqqwnplUxroqXul2Qz2JWBtgAr31FJX6RcmMxkcCAgxswE6CoTo58aFhZ2HwaIRsbRiMaovYfZ0bgLS8oPaY_EIO5Z4GP4MtWgj2S3XqN4fkg' \
    -d '{"name":"Updated Test AuthPolicy","primary":{"cert":{"allowed":false,"allowExpiredCerts":true},"extJwt":{"allowed":false,"allowedSigners":["a8dd55b1-af7e-45fc-a01d-738a23822dcb","0fb67952-bd01-4c05-b555-88ccda9dd16d"]},"updb":{"allowed":true,"lockoutDurationMinutes":6,"maxAttempts":4,"minPasswordLength":9,"requireMixedCase":false,"requireNumberChar":false,"requireSpecialChar":false}},"secondary":{"requireExtJwtSigner":"6275bf89-b8ba-4753-8ce8-ad81019b23b8","requireTotp":true}}'

Example response

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

{
  "id" : "ec73da4f-76b8-4db6-b6ed-b67f500eaf17",
  "networkId" : "bab5f7e8-e941-4959-ac58-89e071af348c",
  "zitiId" : "ziti.id.97ocqx2t",
  "name" : "Updated Test AuthPolicy",
  "primary" : {
    "cert" : {
      "allowed" : false,
      "allowExpiredCerts" : true
    },
    "extJwt" : {
      "allowed" : false,
      "allowedSigners" : [ "a8dd55b1-af7e-45fc-a01d-738a23822dcb", "0fb67952-bd01-4c05-b555-88ccda9dd16d" ]
    },
    "updb" : {
      "allowed" : true,
      "lockoutDurationMinutes" : 6,
      "maxAttempts" : 4,
      "minPasswordLength" : 9,
      "requireMixedCase" : false,
      "requireNumberChar" : false,
      "requireSpecialChar" : false
    }
  },
  "secondary" : {
    "requireExtJwtSigner" : "6275bf89-b8ba-4753-8ce8-ad81019b23b8",
    "requireTotp" : true
  },
  "createdBy" : "b07e3426-ee84-4e34-ad96-299a258f3bb9",
  "createdAt" : "2024-11-15T02:33:23.429317Z",
  "updatedAt" : "2024-11-15T02:33:30.194723Z",
  "appliedAt" : "2024-11-15T02:33:30.194723Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/auth-policies/ec73da4f-76b8-4db6-b6ed-b67f500eaf17' -i -X DELETE \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJsUjk5T3ZlT1VuUGhucnB0Tjh6eFpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVjODllMjhmLTI2ZTQtNDg2OC05MTIyLTMwZWM5MTJmMGU1ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAxMCwiZXhwIjoxNzMxNjQxNjEwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjM4ZTJlYjBiLTZkMzUtNDc3Yy04OWVjLWEzMjU1ODc4Yzk2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAxMH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.PThVkfrJL_l6a3DRoX3B7BPfwZd1jt9lGzWTQK8_ThYPAXYFK8g6wpuv7Lyq49o7xVL7QVEGMtdYr5n8fgQudaZuQymbJsLwrSJtgcfyfe3tjBKBUAb3lQiSRGBFjyboCamXH0SlfgyjnN9MO2DNrKO4vEyhIYmy-tY2Q6nu7GMyld0s9mzztwUvBsD2yiudyKz6I5UVHUvrVSZy8rp3qNFH2jlvde_jbLXXdezLnpP7pnBAiGl3NQv01W850r1lFnH7gMygsijNaiSNjDmF2bZuos8XhdxKsB9TH0znoOxvKfcbpaG3NaNgyKBBzDeSx6OIi8hldJ4-RWdG_721KQ'

Example response

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

{
  "id" : "ec73da4f-76b8-4db6-b6ed-b67f500eaf17",
  "networkId" : "bab5f7e8-e941-4959-ac58-89e071af348c",
  "zitiId" : null,
  "name" : "Updated Test AuthPolicy",
  "primary" : {
    "cert" : {
      "allowed" : false,
      "allowExpiredCerts" : true
    },
    "extJwt" : {
      "allowed" : false,
      "allowedSigners" : [ "a8dd55b1-af7e-45fc-a01d-738a23822dcb", "0fb67952-bd01-4c05-b555-88ccda9dd16d" ]
    },
    "updb" : {
      "allowed" : true,
      "lockoutDurationMinutes" : 6,
      "maxAttempts" : 4,
      "minPasswordLength" : 9,
      "requireMixedCase" : false,
      "requireNumberChar" : false,
      "requireSpecialChar" : false
    }
  },
  "secondary" : {
    "requireExtJwtSigner" : "6275bf89-b8ba-4753-8ce8-ad81019b23b8",
    "requireTotp" : true
  },
  "createdBy" : "b07e3426-ee84-4e34-ad96-299a258f3bb9",
  "createdAt" : "2024-11-15T02:33:23.429317Z",
  "updatedAt" : "2024-11-15T02:33:30.913885Z",
  "appliedAt" : "2024-11-15T02:33:30.913885Z",
  "deletedAt" : "2024-11-15T02:33:30.907825Z",
  "deletedBy" : "5c89e28f-26e4-4868-9122-30ec912f0e5f",
  "deleted" : true
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?id=c3a70894-d8be-41ec-a30c-eb799aa3b769' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJFNnY5eF9nY1gzV1ltSEtOUzkyRHlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU4YzcyMDc3LWMwNmMtNDlhMi1iN2MzLTMzZjcxN2UwZTZkZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzNSwiZXhwIjoxNzMxNjQxNTM1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ4MmI1MWU4LWM1NTQtNGYzZC05NWIxLTcxMzBiZjU5OTQ3NlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Flnx7_FlOuwZL-rUxq-LMaCmUObYHagyoW-7WX6LwKroqmTxQ4mGhe-672ubmLolSFVYnzXwWGaibIFCYZ57Mqa7qMaMuz_87g2k0p7bvYJnwHwchkFxb5nDgbYEQXeWKt22y3e9-Ml9eqTOBS0KHYDKdLzlXGKzi0QkJOl8JPdRq6RxtgAxVLzLQPcNUi8pErlHSqUk3Zk4bWfGClRSgWFA9tWEo6zs43mKjrdC6103W54MDgrNZrObE5O4VeUR0Y_u_Afw5j0QEzEV5eSm05W9_JU-YiF-ZKTHD_2ueV2GeJ5k6qV7T5IqUoAmBOmHfuiIz9X7m-m-ZJZL6UCgsA'

Example response

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

[ {
  "id" : "c3a70894-d8be-41ec-a30c-eb799aa3b769",
  "networkId" : "f028986f-29e1-4d73-a945-9de9cdece842",
  "zitiId" : "ziti.id.88ucnm34",
  "name" : "Updated Test ExternalJwtSigner",
  "enabled" : false,
  "externalAuthUrl" : "http://externalAuthUrl.com",
  "issuer" : "issuer",
  "audience" : "audience",
  "jwksEndpoint" : "https://updated.jwksEndpoint.com",
  "claimsProperty" : "mySpecialClaim",
  "useExternalId" : true,
  "certPem" : null,
  "kid" : null,
  "createdBy" : "64a376c3-4853-4941-a98b-35c2df83ccaa",
  "createdAt" : "2024-11-15T02:32:07.577424Z",
  "updatedAt" : "2024-11-15T02:32:15.190700Z",
  "appliedAt" : "2024-11-15T02:32:15.190700Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
} ]

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/external-jwt-signers/c3a70894-d8be-41ec-a30c-eb799aa3b769?meta=ziti,diffZiti' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIySjFrQ2c5cGhsakpqQnZoeS1SME9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFlOWZjNzQ5LTE5ODUtNDBhYS05MTQ1LTdlOTRmYTI1ZjAwMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzNCwiZXhwIjoxNzMxNjQxNTM0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRkYTc0OTJiLWQ5ODAtNGZlMC05YTVmLTIyZGQxOTI0M2RjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.nT5pKfNoncx8LAwYV2ZdTxSydNnYBYur2A2rCkyTOWRSZWpN1mn1LvYTT42NVrrko7KNSq6124WjVuMiCjY7al7tQ2HMEadBUP3g0WLgUGwwAnJer1fGgc30iKClva6kIk84Ql3oVbQpGPeitsfjfsJBXWfe8_B9Mbu1NnN2he-83H-VGRRtlYoG3CaWu9yf_qzX6cYsYRI04bHVhtlh3POcNWLuxhw6nJRgRnvSRm1uQ-MI3Mjn_p4KukugHp1ttE8PuCGNTXhfO54sRZEyv4uup9d-MXqGN_HSCJ6zfhoZWW3O2pZO_Z3tn8CkYCYphgzk1sc2vxFNm0aNIXGwqg'

Example response

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

{
  "id" : "c3a70894-d8be-41ec-a30c-eb799aa3b769",
  "networkId" : "f028986f-29e1-4d73-a945-9de9cdece842",
  "zitiId" : "ziti.id.88ucnm34",
  "name" : "Test ExternalJwtSigner",
  "enabled" : true,
  "externalAuthUrl" : "http://externalAuthUrl.com",
  "issuer" : "issuer",
  "audience" : "audience",
  "jwksEndpoint" : "https://jwksEndpoint.com",
  "claimsProperty" : "mySpecialClaim",
  "useExternalId" : false,
  "certPem" : null,
  "kid" : null,
  "createdBy" : "64a376c3-4853-4941-a98b-35c2df83ccaa",
  "createdAt" : "2024-11-15T02:32:07.577424Z",
  "updatedAt" : "2024-11-15T02:32:07.635733Z",
  "appliedAt" : "2024-11-15T02:32:07.635733Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "_meta" : {
    "diffZiti" : {
      "differencesDetected" : true,
      "description" : "Ziti missing resource with zitiId='ziti.id.88ucnm34'",
      "comparedAt" : "2024-11-15T02:32:14.406196490Z"
    }
  },
  "meta" : {
    "diffZiti" : {
      "differencesDetected" : true,
      "description" : "Ziti missing resource with zitiId='ziti.id.88ucnm34'",
      "comparedAt" : "2024-11-15T02:32:14.406196490Z"
    }
  }
}

Optional

Description

networkId

String

true

name

String

true

enabled

Boolean

true

externalAuthUrl

String

true

issuer

String

true

audience

String

true

jwksEndpoint

String

true

claimsProperty

String

true

useExternalId

Boolean

true

certPem

String

true

kid

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/external-jwt-signers' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIydkxNdDNJNFl2QU5maXZpcmpIeEJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY0YTM3NmMzLTQ4NTMtNDk0MS1hOThiLTM1YzJkZjgzY2NhYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkyNywiZXhwIjoxNzMxNjQxNTI3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjRiNTQ0MTJjLTMxODYtNDc2Mi1hY2FjLTVkZjg4MGQzZjJkMFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkyN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.fGlkN7dNXVES2GQOv3KHXnMtpI0adlrYn_3kJd_qfEbHB1UgGeH6J1cE_0EDkDS-s6Y82O18pFMei40pdSrivt_j6rvDBkf2VKOQe8xHNncYwzQPfJAbdpDy0lSRdtIcVJ5zLDv_kFwhacc-fvNuCKx2mmwmSfnC2Xjpmd_guDtXajjh4Zm1PUawJo4KFt_oe7aq5wutOn2nLRMO7jldm-Yb8l2eijnScTlVZvdDGxftugiKP0rLD4Lipbo3O6SCj-EyMSACIVsUrhTjsfuiUZcsTYn-5ZuXFv5Zf7ELd5kx1ntnsCa1oynHDPqP2Zn0ZgqzlHno04ZEa7VISXWPSw' \
    -d '{"networkId":"f028986f-29e1-4d73-a945-9de9cdece842","name":"Test ExternalJwtSigner","enabled":true,"externalAuthUrl":"http://externalAuthUrl.com","issuer":"issuer","audience":"audience","jwksEndpoint":"https://jwksEndpoint.com","claimsProperty":"mySpecialClaim","useExternalId":false,"certPem":null,"kid":null}'

Example response

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

{
  "id" : "c3a70894-d8be-41ec-a30c-eb799aa3b769",
  "networkId" : "f028986f-29e1-4d73-a945-9de9cdece842",
  "zitiId" : "ziti.id.88ucnm34",
  "name" : "Test ExternalJwtSigner",
  "enabled" : true,
  "externalAuthUrl" : "http://externalAuthUrl.com",
  "issuer" : "issuer",
  "audience" : "audience",
  "jwksEndpoint" : "https://jwksEndpoint.com",
  "claimsProperty" : "mySpecialClaim",
  "useExternalId" : false,
  "certPem" : null,
  "kid" : null,
  "createdBy" : "64a376c3-4853-4941-a98b-35c2df83ccaa",
  "createdAt" : "2024-11-15T02:32:07.577424Z",
  "updatedAt" : "2024-11-15T02:32:07.635733Z",
  "appliedAt" : "2024-11-15T02:32:07.635733Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

enabled

Boolean

true

externalAuthUrl

Object

true

issuer

String

true

audience

String

true

jwksEndpoint

String

true

claimsProperty

Object

true

useExternalId

Boolean

true

certPem

String

true

kid

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/external-jwt-signers/c3a70894-d8be-41ec-a30c-eb799aa3b769' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIwSWk4TW9aLWlDVXdZT3FXbm92MzlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRmYTE1MTcwLTQ2NTctNDBiZC04N2RlLTFmMzhlNDQzNWUwNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzNSwiZXhwIjoxNzMxNjQxNTM1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImUzMTM3NmQ1LTg3YTAtNDQ4MC04ZjQyLTBmMTYyZWYwNzBkNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ob9699zgDBYCuUu33ZQiq82ZEnHxmGlQ9JpP4p6DtCrAkFofAoKuwFY0-l6sK7WNGnP2AO0Ugb3JJ_XRv3Mo0nJlqM1ncsazHKzRVghyJyS4KLZ-rkgVtUXgnGIAEQecKdLeVmgyd6enAVGkUEkIRKxp5zP-_v5PCxrVhJcm6heF_PELng5A-Vh2k9Kro04xFwECDxAedA3j6HlTbb8e7zO-3FyoDlzNVMCF0HIu-w4A4pp1ykCo9kbE72itU1Yj9z_CwOwVmm8JbKh73srYC2iyq_KvlrPQeVaSVZtUmX6fk_T-gc0MPGlwWwL_u4whYbZiMI5puAn5bFK7AMXmsA' \
    -d '{"name":"Updated Test ExternalJwtSigner","enabled":false,"issuer":"issuer","audience":"audience","jwksEndpoint":"https://updated.jwksEndpoint.com","useExternalId":true,"certPem":null,"kid":null}'

Example response

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

{
  "id" : "c3a70894-d8be-41ec-a30c-eb799aa3b769",
  "networkId" : "f028986f-29e1-4d73-a945-9de9cdece842",
  "zitiId" : "ziti.id.88ucnm34",
  "name" : "Updated Test ExternalJwtSigner",
  "enabled" : false,
  "externalAuthUrl" : "http://externalAuthUrl.com",
  "issuer" : "issuer",
  "audience" : "audience",
  "jwksEndpoint" : "https://updated.jwksEndpoint.com",
  "claimsProperty" : "mySpecialClaim",
  "useExternalId" : true,
  "certPem" : null,
  "kid" : null,
  "createdBy" : "64a376c3-4853-4941-a98b-35c2df83ccaa",
  "createdAt" : "2024-11-15T02:32:07.577424Z",
  "updatedAt" : "2024-11-15T02:32:15.190700Z",
  "appliedAt" : "2024-11-15T02:32:15.190700Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/external-jwt-signers/c3a70894-d8be-41ec-a30c-eb799aa3b769' -i -X DELETE \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJSVldES3VBV0FGekZWaEE4SFFYc3FnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE3ODEzOTVmLWY2ZGItNDRjOS1hZjc0LTQwZDY0ZTViMDRhMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzNiwiZXhwIjoxNzMxNjQxNTM2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg3OTQ4NzIzLWM5NjktNGZiMy1hODYwLTdlMDQwMmNkZmYyY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.o2zjaY8ygM2E2U98xf1Iu-JILaYSV7Qk4SCb1hpY-_ZRZv3el2WXgw33aLZdIFjaTmB0bMP0XlV50_eFNAy52iPCtyvFTKhWUwalIj_i1th8nywmIMtCWwDBnPrXV0bXebmBtT0z7CSWe-Z_-UROZQj0Qs6foUz5YHwmd6juWt6XkYwLVelLC7__sD8I9rMkkPmEzG4lCGSrInfKiQTLRpbnWy7BKYTGIrPtGMUj99ysCZb6zuiZL3i48QIOj_It6usLgq12tnOhPVcZDcS4G3bQGkbwBAZoFiZqZ699pbasfu804pJzNCORmTYklvX-zRigl0vALaFYjCM6r8-kkg'

Example response

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

{
  "id" : "c3a70894-d8be-41ec-a30c-eb799aa3b769",
  "networkId" : "f028986f-29e1-4d73-a945-9de9cdece842",
  "zitiId" : null,
  "name" : "Updated Test ExternalJwtSigner",
  "enabled" : false,
  "externalAuthUrl" : "http://externalAuthUrl.com",
  "issuer" : "issuer",
  "audience" : "audience",
  "jwksEndpoint" : "https://updated.jwksEndpoint.com",
  "claimsProperty" : "mySpecialClaim",
  "useExternalId" : true,
  "certPem" : null,
  "kid" : null,
  "createdBy" : "64a376c3-4853-4941-a98b-35c2df83ccaa",
  "createdAt" : "2024-11-15T02:32:07.577424Z",
  "updatedAt" : "2024-11-15T02:32:16.184861Z",
  "appliedAt" : "2024-11-15T02:32:16.184861Z",
  "deletedAt" : "2024-11-15T02:32:16.163778Z",
  "deletedBy" : "a781395f-f6db-44c9-af74-40d64e5b04a1",
  "deleted" : true
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

type

String

true

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

name

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/cloud-providers' -i -X GET \
    -H 'Accept: application/hal+json'

Example response

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

{
  "_embedded" : {
    "cloudProviderList" : [ {
      "type" : "AWS",
      "name" : "AWS Name",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/AWS"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?providers=AWS"
        }
      }
    }, {
      "type" : "ALICLOUD",
      "name" : "AliCloud Name",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/ALICLOUD"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?providers=ALICLOUD"
        }
      }
    }, {
      "type" : "AZURE",
      "name" : "Azure Name",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/AZURE"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?providers=AZURE"
        }
      }
    }, {
      "type" : "GCP",
      "name" : "GCP Name",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/GCP"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?providers=GCP"
        }
      }
    }, {
      "type" : "OCI",
      "name" : "OCI Name",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/OCI"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?providers=OCI"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
    }
  }
}

Optional

Description

cloudProvider

String

false

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

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/cloud-providers/OCP' -i -X GET \
    -H 'Accept: application/hal+json'

Example response

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

{
  "type" : "OCI",
  "name" : "OCI Name",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/OCI"
    },
    "providers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
    },
    "regions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/regions?providers=OCI"
    }
  }
}

Optional

Description

provider

Object

true

latitude

Decimal

true

longitude

Decimal

true

providers

Object

true

Deprecated..

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

locationCode

String

true

name

String

true

provider

String

true

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

address

String

true

city

String

true

stateCode

String

true

stateName

String

true

countryName

String

true

countryCode

String

true

latitude

Decimal

true

longitude

Decimal

true

distance

Decimal

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/regions' -i -X GET \
    -H 'Accept: application/hal+json'

Example response

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

{
  "_embedded" : {
    "regionList" : [ {
      "locationCode" : "azure-us-east-1",
      "name" : "us-east-1",
      "provider" : "AZURE",
      "latitude" : 51.0,
      "longitude" : 51.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/AZURE/azure-us-east-1"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=AZURE"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/AZURE"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    }, {
      "locationCode" : "azure-us-east-2",
      "name" : "us-east-2",
      "provider" : "AZURE",
      "latitude" : 48.0,
      "longitude" : 48.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/AZURE/azure-us-east-2"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=AZURE"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/AZURE"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    }, {
      "locationCode" : "aws-us-east-1",
      "name" : "us-east-1",
      "provider" : "AWS",
      "latitude" : 50.0,
      "longitude" : 50.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/AWS/aws-us-east-1"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=AWS"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/AWS"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    }, {
      "locationCode" : "aws-us-east-2",
      "name" : "us-east-2",
      "provider" : "AWS",
      "latitude" : 45.0,
      "longitude" : 45.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/AWS/aws-us-east-2"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=AWS"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/AWS"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    }, {
      "locationCode" : "gcp-us-east-1",
      "name" : "us-east-1",
      "provider" : "GCP",
      "latitude" : 50.0,
      "longitude" : 55.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/GCP/gcp-us-east-1"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=GCP"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/GCP"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    }, {
      "locationCode" : "gcp-us-east-2",
      "name" : "us-east-2",
      "provider" : "GCP",
      "latitude" : 55.0,
      "longitude" : 50.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/GCP/gcp-us-east-2"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=GCP"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/GCP"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    }, {
      "locationCode" : "oci-us-east-1",
      "name" : "us-east-1",
      "provider" : "OCI",
      "latitude" : 25.0,
      "longitude" : 25.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/OCI/oci-us-east-1"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=OCI"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/OCI"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    }, {
      "locationCode" : "oci-us-east-2",
      "name" : "us-east-2",
      "provider" : "OCI",
      "latitude" : 22.0,
      "longitude" : 22.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/OCI/oci-us-east-2"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=OCI"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/OCI"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    }, {
      "locationCode" : "ali-us-east-1",
      "name" : "us-east-1",
      "provider" : "ALICLOUD",
      "latitude" : 52.0,
      "longitude" : 52.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/ALICLOUD/ali-us-east-1"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=ALICLOUD"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/ALICLOUD"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    }, {
      "locationCode" : "ali-us-east-2",
      "name" : "us-east-2",
      "provider" : "ALICLOUD",
      "latitude" : 53.0,
      "longitude" : 53.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/ALICLOUD/ali-us-east-2"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=ALICLOUD"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/ALICLOUD"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/regions"
    },
    "providers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
    }
  }
}

Optional

Description

provider

Object

true

latitude

Decimal

true

longitude

Decimal

true

providers

Object

true

Deprecated..

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

locationCode

String

true

name

String

true

provider

String

true

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

address

String

true

city

String

true

stateCode

String

true

stateName

String

true

countryName

String

true

countryCode

String

true

latitude

Decimal

true

longitude

Decimal

true

distance

Decimal

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/regions?providers=OCP' -i -X GET \
    -H 'Accept: application/hal+json'

Example response

HTTP/1.1 200 OK
X-NF-deprecated-property: providers; removal 3/1/2022; see use provider
Content-Type: application/hal+json
Content-Length: 1621

{
  "_embedded" : {
    "regionList" : [ {
      "locationCode" : "oci-us-east-1",
      "name" : "us-east-1",
      "provider" : "OCI",
      "latitude" : 25.0,
      "longitude" : 25.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/OCI/oci-us-east-1"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=OCI"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/OCI"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    }, {
      "locationCode" : "oci-us-east-2",
      "name" : "us-east-2",
      "provider" : "OCI",
      "latitude" : 22.0,
      "longitude" : 22.0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions/OCI/oci-us-east-2"
        },
        "regions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=OCI"
        },
        "provider" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/OCI"
        },
        "providers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/regions"
    },
    "providers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
    }
  }
}

Optional

Description

provider

String

false

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

locationCode

String

false

Optional

Description

locationCode

String

true

name

String

true

provider

String

true

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

address

String

true

city

String

true

stateCode

String

true

stateName

String

true

countryName

String

true

countryCode

String

true

latitude

Decimal

true

longitude

Decimal

true

distance

Decimal

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/regions/OCP/oci-us-east-1' -i -X GET \
    -H 'Accept: application/hal+json'

Example response

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

{
  "locationCode" : "oci-us-east-1",
  "name" : "us-east-1",
  "provider" : "OCI",
  "latitude" : 25.0,
  "longitude" : 25.0,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/regions/OCI/oci-us-east-1"
    },
    "regions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/regions?provider=OCI"
    },
    "provider" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/OCI"
    },
    "providers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
    }
  }
}

Type

Optional

Description

host.size

Object

true

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

ownerIdentityId

String

true

provider

String

true

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

region

String

true

ipAddress

String

true

sshPort

Integer

true

sshPrivateKeyStoredSecretId

String

true

providerInstanceId

String

true

size

String

true

userData

String

true

username

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/hosts' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJRNEdHRnlQblFhZ3luaE53dW9hNlN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJmMTU3NjA2LTJjYjMtNDczZC1iZGNhLWM3MjE3ZTBkNTMxZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkwNCwiZXhwIjoxNzMxNjQxNTA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjViZjU2ODBkLTMyZTUtNDMzMy1hZTQ0LThmY2QwYzVlMmJiYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.GcPUCBI0M9sbxrTRkNsUKU1smNnOKtYrBNn-58cxDDTQOLgoHJFV0uEHhE2m_s_SzovVavheD5J0jaNJ-BlLJhlmvGgu_51y3rtKrlGt7pXzGzd-5gOG4p1kUlLPRWuH37sfICHt2WdKQWETCu5iAT43WOTH8ocpflctxzN_Bmd22ZTPug13NV0eFVOCtuGxj9pirPAOZVJeKwo1yEJg1UYoA3dcGmw1Pu72RRXmRmlgd2D30hfXx02nnKh4M_46HKOooYSw_78cxfR8GA698XTFi8_N9zRGLfDhcXV__iYoz82lGViSlEIh-_u8GcZy9fDp52A9aqjilOzOP31UzA'

Example response

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

{
  "_embedded" : {
    "hostList" : [ {
      "id" : "a06f62fd-9747-4fd1-9938-4741db393568",
      "networkId" : "df5a0fd0-2a5d-4e15-b2ef-2bb65a8afd8d",
      "ownerIdentityId" : "8545b37c-f23f-402d-a1b1-60cf059624dc",
      "provider" : "OCI",
      "region" : "us-east-1",
      "ipAddress" : "0.0.0.27",
      "sshPort" : 22,
      "sshPrivateKeyStoredSecretId" : null,
      "providerInstanceId" : "d5e7efc8-3b6e-4f03-8b01-c1a7e0dea859",
      "size" : "medium",
      "userData" : null,
      "createdBy" : null,
      "createdAt" : "2024-11-15T02:31:44.956084Z",
      "updatedAt" : "2024-11-15T02:31:44.956084Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/a06f62fd-9747-4fd1-9938-4741db393568"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df5a0fd0-2a5d-4e15-b2ef-2bb65a8afd8d",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "d55f88f4-04c8-42ca-b5d5-dd981610ae8a",
      "networkId" : "df5a0fd0-2a5d-4e15-b2ef-2bb65a8afd8d",
      "ownerIdentityId" : "8545b37c-f23f-402d-a1b1-60cf059624dc",
      "provider" : "AWS",
      "region" : "us-east-1",
      "ipAddress" : "0.0.0.26",
      "sshPort" : 22,
      "sshPrivateKeyStoredSecretId" : null,
      "providerInstanceId" : "cd53ee62-328f-4b65-ba04-cbf04a0c9c0a",
      "size" : "small",
      "userData" : null,
      "createdBy" : null,
      "createdAt" : "2024-11-15T02:31:44.948858Z",
      "updatedAt" : "2024-11-15T02:31:44.948858Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/d55f88f4-04c8-42ca-b5d5-dd981610ae8a"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/df5a0fd0-2a5d-4e15-b2ef-2bb65a8afd8d",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/hosts/d10fe04d-9c33-4abd-a1b2-25f4d130c221' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJNTzdROWM5V0xIcnJnbG5CS0ZTZFdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRlZTNkODcxLTFkZGEtNGUxZS04MDdjLTk0YzEzZGU5MjZlZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzc4NSwiZXhwIjoxNzMxNjQxMzg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdhMWYxMGFhLWQyZGEtNDlhNi04YjAyLTFlMDQ1MmIzY2Q3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzc4NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.E8AEjFiPtbtQ_sbGl3-ruSDMReQC4AeX9CB_PY9rxhFpN2eQdfa05CvCPCMxK7r8O5qFVml8P1BtV-C-QhbiffVRQJgnMsLVLfKat2Xv0FO2Jh7lp5FpzV9D6OH-w4PnS69G_huswjRJnfMgdLb3re0O7ibZcsNxcjnXRTAuzO-WN0ybIiSSCqOsb2QZO0g6BcbaTADBF_bpsK8Q-0jSuGr9f8vrm4q9wZ0u5wvZRjeCsZ8dI524cpRNZG9J7swwOcFrdWW7SFLeIqgHxkHnRFoPhB4gUI5ioukZhSNgqQi62XKadsmtY7KXIuJYdwDXdL4lzdVHxDTjRU2cLSiMew'

Example response

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

{
  "id" : "d10fe04d-9c33-4abd-a1b2-25f4d130c221",
  "networkId" : "86d85bd3-e29c-4b63-bc3c-b30ad0e056ef",
  "ownerIdentityId" : "cda6c725-e54c-4282-89bb-c008471b7ea1",
  "provider" : "AWS",
  "region" : "us-east-1",
  "ipAddress" : "0.0.0.0",
  "sshPort" : 22,
  "sshPrivateKeyStoredSecretId" : null,
  "providerInstanceId" : "f6cbfb75-2a48-44d1-a5a6-9f76316c6fde",
  "size" : "small",
  "userData" : null,
  "createdBy" : null,
  "createdAt" : "2024-11-15T02:29:44.976981Z",
  "updatedAt" : "2024-11-15T02:29:44.976981Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/d10fe04d-9c33-4abd-a1b2-25f4d130c221"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/86d85bd3-e29c-4b63-bc3c-b30ad0e056ef",
      "profile" : "parent"
    },
    "provider" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers/AWS"
    },
    "region" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/regions/AWS/us-east-1"
    }
  }
}

Optional

Description

provider

Object

true

providers

Object

true

Deprecated..

type

String

true

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

name

String

true

hostType

String

true

Must be one of [NC, ER].

providers

Array[String]

true

description

Array[String]

true

default

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/host-sizes' -i -X GET \
    -H 'Accept: application/hal+json'

Example response

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

{
  "_embedded" : {
    "hostSizeList" : [ {
      "name" : "small",
      "hostType" : "ER",
      "providers" : [ "AZURE", "AWS", "GCP", "OCI", "ALICLOUD" ],
      "description" : [ ],
      "default" : true
    }, {
      "name" : "medium",
      "hostType" : "ER",
      "providers" : [ "AZURE", "AWS", "GCP", "OCI", "ALICLOUD" ],
      "description" : [ ],
      "default" : false
    }, {
      "name" : "small",
      "hostType" : "NC",
      "providers" : [ "AWS" ],
      "description" : [ ],
      "default" : true
    }, {
      "name" : "medium",
      "hostType" : "NC",
      "providers" : [ "AWS" ],
      "description" : [ ],
      "default" : false
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/host-sizes"
    },
    "providers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/cloud-providers"
    }
  }
}

Optional

Description

provider

Object

true

providers

Object

true

Deprecated..

type

String

true

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

name

String

true

hostType

String

true

Must be one of [NC, ER].

providers

Array[String]

true

description

Array[String]

true

default

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/host-sizes?provider=ALICLOUD' -i -X GET \
    -H 'Accept: application/hal+json'

Example response

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

{
  "_embedded" : {
    "hostSizeList" : [ {
      "name" : "small",
      "hostType" : "ER",
      "providers" : [ "ALICLOUD" ],
      "description" : [ ],
      "default" : true
    }, {
      "name" : "medium",
      "hostType" : "ER",
      "providers" : [ "ALICLOUD" ],
      "description" : [ ],
      "default" : false
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/host-sizes?provider=ALICLOUD"
    },
    "providers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/cloud-providers"
    }
  }
}

Optional

Description

provider

Object

true

providers

Object

true

Deprecated..

type

String

true

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

name

String

true

hostType

String

true

Must be one of [NC, ER].

providers

Array[String]

true

description

Array[String]

true

default

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/host-sizes?provider=ALICLOUD&type=ER' -i -X GET \
    -H 'Accept: application/hal+json'

Example response

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

{
  "_embedded" : {
    "hostSizeList" : [ {
      "name" : "small",
      "hostType" : "ER",
      "providers" : [ "ALICLOUD" ],
      "description" : [ ],
      "default" : true
    }, {
      "name" : "medium",
      "hostType" : "ER",
      "providers" : [ "ALICLOUD" ],
      "description" : [ ],
      "default" : false
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/host-sizes?provider=ALICLOUD&type=ER"
    },
    "providers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/cloud-providers"
    }
  }
}

Optional

Description

provider

Object

true

providers

Object

true

Deprecated..

type

String

true

Request fields

No request body.

Response fields

Path

Type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

name

String

true

hostType

String

true

Must be one of [NC, ER].

providers

Array[String]

true

description

Array[String]

true

default

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/host-sizes?type=NC' -i -X GET \
    -H 'Accept: application/hal+json'

Example response

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

{
  "_embedded" : {
    "hostSizeList" : [ {
      "name" : "small",
      "hostType" : "NC",
      "providers" : [ "AWS" ],
      "description" : [ ],
      "default" : true
    }, {
      "name" : "medium",
      "hostType" : "NC",
      "providers" : [ "AWS" ],
      "description" : [ ],
      "default" : false
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/host-sizes?type=NC"
    },
    "providers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/cloud-providers"
    }
  }
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

processId

String

true

name

String

true

description

String

true

resourceType

String

true

resourceId

String

true

startedAt

String

true

finishedAt

String

true

traceId

String

true

status

String

true

Must be one of [RUNNING, FAILED, SUCCESS, CANCELED].

initiatingIdentityId

String

true

createdAt

String

true

updatedAt

String

true

actions

Array[Object]

true

actions[].title

String

true

actions[].method

String

true

actions[].url

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/executions?networkId=96c6a637-e1a6-4626-abf1-8e357ccbdb0c' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJzR0FxYUpjX3ptZGZ6bzZSSjUtcjRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgyOTIyMjNkLTUyOWItNGJkMC1iMjZiLTQ4OTY0YzhjN2QyNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA0NCwiZXhwIjoxNzMxNjQxNjQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImEwMzQ1ZDgyLTE1YzgtNDI0YS1hNDgxLWI2Y2QxYTA4ZTE2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Nj825HIIV-ydaXd3P2_O34ss_An52hjyfC3R2EXKU-DhDy0M0HPaC1e7f0klpZ3v9PnHlailzP7ibpj9O5tZTW93Vyu9c9-Vdwmt6x_2VBUI4SQMkDSf7omiO7SWWk_rZFmoVGpVyGDlX04-TLHqcWDFDdSCGpvGgjevLFqIvu1tJf0nkV5C4yZuFiF_F4dY6PpjqNE4rXRCvc8cRXMnqfr4cgLe_PYJu37UosSPSSSphy5NMQPoM-aeyDX8zqf0UEKvw3LU42iSRf7NNmszDF9GEFimUqQjYZqheYeHeheU9tj0E3jd9aCRyBZbcnaaQAPoxsyj8LAfC4DpUpBPxg'

Example response

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

{
  "_embedded" : {
    "executionList" : [ {
      "id" : "6b238023-6ac6-44c1-9757-c957f7d42b87",
      "networkId" : "96c6a637-e1a6-4626-abf1-8e357ccbdb0c",
      "processId" : "b395409f-3acc-4470-a2ea-6c7b9bd348f1",
      "name" : "CreateEndpointProcess",
      "description" : "Fake Process",
      "resourceType" : "component",
      "resourceId" : "5ffb39c5-0143-4548-9aad-2ed5a4400cab",
      "startedAt" : "2024-11-15T02:34:04.915516Z",
      "finishedAt" : null,
      "traceId" : "trace2",
      "status" : "RUNNING",
      "initiatingIdentityId" : "f3527615-76fe-42a0-ba2d-6b74e46e5770",
      "createdAt" : "2024-11-15T02:34:04.915678Z",
      "updatedAt" : "2024-11-15T02:34:04.915678Z",
      "actions" : [ {
        "title" : "Cancel",
        "method" : "PUT",
        "url" : "http://localhost:8080/core/v2/executions/6b238023-6ac6-44c1-9757-c957f7d42b87/cancel"
      } ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions/6b238023-6ac6-44c1-9757-c957f7d42b87",
          "title" : "CreateEndpointProcess"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/96c6a637-e1a6-4626-abf1-8e357ccbdb0c",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "8dd54cdd-e912-4638-a030-8be1357f1c70",
      "networkId" : "96c6a637-e1a6-4626-abf1-8e357ccbdb0c",
      "processId" : "0b341e68-d650-4e2b-9d69-b4cd1ec194ff",
      "name" : "CreateEndpointProcess",
      "description" : "Fake Process",
      "resourceType" : "component",
      "resourceId" : "bea71dbf-9ec3-4e7b-972a-c7ad6e83b227",
      "startedAt" : "2024-11-15T02:34:04.914376Z",
      "finishedAt" : "2024-11-15T02:34:04.914376Z",
      "traceId" : "trace1",
      "status" : "SUCCESS",
      "initiatingIdentityId" : "e6a21b56-a81e-4ceb-9867-8531db5e1845",
      "createdAt" : "2024-11-15T02:34:04.914532Z",
      "updatedAt" : "2024-11-15T02:34:04.914532Z",
      "actions" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions/8dd54cdd-e912-4638-a030-8be1357f1c70",
          "title" : "CreateEndpointProcess"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/96c6a637-e1a6-4626-abf1-8e357ccbdb0c",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "d6dceaed-3807-4fc0-88f1-aa7a20e8ba74",
      "networkId" : "96c6a637-e1a6-4626-abf1-8e357ccbdb0c",
      "processId" : "5c00a647-55e2-4602-943c-d3a1291c888a",
      "name" : "CreateNetworkProcess",
      "description" : "Fake Process",
      "resourceType" : "network",
      "resourceId" : null,
      "startedAt" : "2024-11-15T02:34:04.915866Z",
      "finishedAt" : "2024-11-15T02:34:04.915867Z",
      "traceId" : "trace3",
      "status" : "FAILED",
      "initiatingIdentityId" : "7a216d32-33e3-4539-a911-8514741c04ff",
      "createdAt" : "2024-11-15T02:34:04.915995Z",
      "updatedAt" : "2024-11-15T02:34:04.915995Z",
      "actions" : [ {
        "title" : "Replay",
        "method" : "PUT",
        "url" : "http://localhost:8080/core/v2/networks/96c6a637-e1a6-4626-abf1-8e357ccbdb0c/replay"
      } ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions/d6dceaed-3807-4fc0-88f1-aa7a20e8ba74",
          "title" : "CreateNetworkProcess"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/96c6a637-e1a6-4626-abf1-8e357ccbdb0c",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=96c6a637-e1a6-4626-abf1-8e357ccbdb0c"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/executions/08efc8e3-ef85-40f9-a6ab-cf5bd2548221' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiaGEyY1FmdkVEU0JyaHAxOHRSVXV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc1YjA5MDA5LTg1ZjUtNDcyOS1hYzBlLWI4MTlkM2JhNWY1ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA0NSwiZXhwIjoxNzMxNjQxNjQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFmOTBhNzk4LTlmOTctNDg3ZC05ZDA2LWFhZGM2OTIyNTA3YVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA0NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.f8eyf0XIdgPrd2WPvqzXccnpCjaw_PfhqAaG8Kpm8T3vx5O85P7nOR46GM9S-Jn9BbsHRLTFLxlH0vHOwkcPybjtL0IkaU9-MtkeYBQHfO0qQpNFj8w4la0jcnBshRq7Rs-d3VYrAQg-zgoFmYWKb92GIg3w12GsaXXf8aOYHGd3_cCLZ9GrMyMcjrwE-XelcZ1b7fmAphw7adthL9RhtbcF2Pz5ew14DCNRCf5PMxvl5hMhUXujLH5JE2RID2bmDxRcTpy1v3oekVBBRGBu8pjiUfBIceAyQCIOwUxC7oD3nUP_KHn8-ONvLxP4IMyXdQ8xhPph0hyKhT_z7AGrWg'

Example response

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

{
  "id" : "08efc8e3-ef85-40f9-a6ab-cf5bd2548221",
  "networkId" : "4971f596-918b-4267-9d5b-42ef903d2423",
  "processId" : "1423c12a-a5fb-47bb-8dec-d25bdce3d6ba",
  "name" : "CreateNetworkProcess",
  "description" : "Fake Process",
  "resourceType" : "network",
  "resourceId" : null,
  "startedAt" : "2024-11-15T02:34:04.999361Z",
  "finishedAt" : "2024-11-15T02:34:04.999361Z",
  "traceId" : "trace3",
  "status" : "FAILED",
  "initiatingIdentityId" : "a963e365-04e9-485c-8680-5369d20b0580",
  "createdAt" : "2024-11-15T02:34:04.999492Z",
  "updatedAt" : "2024-11-15T02:34:04.999492Z",
  "actions" : [ {
    "title" : "Replay",
    "method" : "PUT",
    "url" : "http://localhost:8080/core/v2/networks/4971f596-918b-4267-9d5b-42ef903d2423/replay"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/08efc8e3-ef85-40f9-a6ab-cf5bd2548221",
      "title" : "CreateNetworkProcess"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4971f596-918b-4267-9d5b-42ef903d2423",
      "profile" : "parent"
    }
  }
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

networkControllers

true

edgeRouters

true

edgeRouterPolicies

true

endpoints

true

services

true

appWans

true

certificateAuthorities

true

hosts

true

Embedded resources

Path

Type

Optional

Description

String

true

networkVersion

Object

true

zitiVersion

Object

true

minimumNetworkVersionForUpgrade

Object

true

minimumEdgeRouterVersionForUpgrade

Object

true

active

Boolean

true

default

Boolean

true

jsonNode

Object

true

createdAt

String

true

updatedAt

String

true

platformFeatures

Array[Object]

true

platformFeatures[].displayName

String

true

platformFeatures[].introducedAt

Object

true

platformFeatures[].deprecatedAt

Object

true

platformFeatures[].removedAt

Object

true

zitiFeatures

Array[Object]

true

zitiFeatures[].displayName

String

true

zitiFeatures[].introducedAt

Object

true

zitiFeatures[].deprecatedAt

Object

true

zitiFeatures[].removedAt

Object

true

recommended

Boolean

true

Deprecated..

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-versions' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJLYkFhZzlkalhUdzdYZHkwcGdHYi1RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjEzNWE4NzNhLTcyZDgtNGQ3Ny05NzJlLWU1Mzc5YjJhMDc4MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg0NSwiZXhwIjoxNzMxNjQxNDQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZmMTkwODI3LTU0ZjctNDgwNi1hM2RiLTc0YzBiMzM2MGQ3YVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg0NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.B4RbtvhyfCblUCiVnjTdixHS8XhV9I3W_AnpEbepXAhsRLKhKCb-bxbosn4Qh_GCTuR090GNHtX3LfLBOEoQSTl5RBa3BJUs03wlR2ADy_gWq_Co6xmEMWtu3ZH54cMlLGEMKPeUdtHCC44urXwS4UoVVke6Bih3YWKHtZ55YIQ9A4dNKq51avkfq7OtpUky8qMqJelIX810QnYHJTnMoH7k9x0IHim35n-Se6Slu13S-fFTJNrKyBFYDKI423fOnz_5LiqASJBrTqsPtf9Xv_13Uy101onUZPYKZ5lgmUAmYBQf445McZvU1JctG2IMxnmhnmTiv1-RizUxbzBwqw'

Example response

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

{
  "_embedded" : {
    "network-versions" : [ {
      "id" : "0183f5d7-e476-4703-b9bf-203f4607d4a2",
      "networkVersion" : "8.0.69",
      "zitiVersion" : "0.25.13",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.25.13",
          "value" : "0.25.13",
          "major" : 0,
          "minor" : 25,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "8.0.69",
          "value" : "8.0.69",
          "major" : 8,
          "minor" : 0,
          "patch" : 69,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.037968Z",
      "updatedAt" : "2024-11-15T02:30:44.037968Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/0183f5d7-e476-4703-b9bf-203f4607d4a2"
        }
      }
    }, {
      "id" : "01d1a789-888d-49b0-b6d1-dc24ab002d77",
      "networkVersion" : "7.3.24",
      "zitiVersion" : "0.19.10",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.10",
          "value" : "0.19.10",
          "major" : 0,
          "minor" : 19,
          "patch" : 10,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.24",
          "value" : "7.3.24",
          "major" : 7,
          "minor" : 3,
          "patch" : 24,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.050610Z",
      "updatedAt" : "2024-11-15T02:30:44.050610Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/01d1a789-888d-49b0-b6d1-dc24ab002d77"
        }
      }
    }, {
      "id" : "08356b99-7990-484a-985d-1432b4830148",
      "networkVersion" : "7.3.11",
      "zitiVersion" : "0.18.8",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.18.8",
          "value" : "0.18.8",
          "major" : 0,
          "minor" : 18,
          "patch" : 8,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.11",
          "value" : "7.3.11",
          "major" : 7,
          "minor" : 3,
          "patch" : 11,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.078304Z",
      "updatedAt" : "2024-11-15T02:30:44.078304Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/08356b99-7990-484a-985d-1432b4830148"
        }
      }
    }, {
      "id" : "0857bd85-e829-4e5d-893b-ebb7132fa211",
      "networkVersion" : "7.3.8",
      "zitiVersion" : "0.18.4",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.18.4",
          "value" : "0.18.4",
          "major" : 0,
          "minor" : 18,
          "patch" : 4,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.8",
          "value" : "7.3.8",
          "major" : 7,
          "minor" : 3,
          "patch" : 8,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.058718Z",
      "updatedAt" : "2024-11-15T02:30:44.058718Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/0857bd85-e829-4e5d-893b-ebb7132fa211"
        }
      }
    }, {
      "id" : "0ce41c79-92be-4b1f-85a3-06f96ea5ba00",
      "networkVersion" : "7.3.23",
      "zitiVersion" : "0.19.9",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.9",
          "value" : "0.19.9",
          "major" : 0,
          "minor" : 19,
          "patch" : 9,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.23",
          "value" : "7.3.23",
          "major" : 7,
          "minor" : 3,
          "patch" : 23,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.051912Z",
      "updatedAt" : "2024-11-15T02:30:44.051912Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/0ce41c79-92be-4b1f-85a3-06f96ea5ba00"
        }
      }
    }, {
      "id" : "11c4ad2e-693e-4f6d-9b87-bbdd78af4864",
      "networkVersion" : "7.3.90",
      "zitiVersion" : "0.27.10",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.27.10",
          "value" : "0.27.10",
          "major" : 0,
          "minor" : 27,
          "patch" : 10,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.90",
          "value" : "7.3.90",
          "major" : 7,
          "minor" : 3,
          "patch" : 90,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.098508Z",
      "updatedAt" : "2024-11-15T02:30:44.098508Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/11c4ad2e-693e-4f6d-9b87-bbdd78af4864"
        }
      }
    }, {
      "id" : "11d09b95-944e-488e-99e6-c4fc390b98d9",
      "networkVersion" : "8.0.90",
      "zitiVersion" : "0.30.1",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : true,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.30.1",
          "value" : "0.30.1",
          "major" : 0,
          "minor" : 30,
          "patch" : 1,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "8.0.90",
          "value" : "8.0.90",
          "major" : 8,
          "minor" : 0,
          "patch" : 90,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : true,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.041085Z",
      "updatedAt" : "2024-11-15T02:30:44.041085Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : true,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/11d09b95-944e-488e-99e6-c4fc390b98d9"
        }
      }
    }, {
      "id" : "20e5f43c-8acd-4a65-954e-e111c64438c1",
      "networkVersion" : "7.3.32",
      "zitiVersion" : "0.20.9",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.20.9",
          "value" : "0.20.9",
          "major" : 0,
          "minor" : 20,
          "patch" : 9,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.32",
          "value" : "7.3.32",
          "major" : 7,
          "minor" : 3,
          "patch" : 32,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.119944Z",
      "updatedAt" : "2024-11-15T02:30:44.119944Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/20e5f43c-8acd-4a65-954e-e111c64438c1"
        }
      }
    }, {
      "id" : "2501ec27-8c57-4f9f-a56d-0704aff7549d",
      "networkVersion" : "7.3.25",
      "zitiVersion" : "0.19.11",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.11",
          "value" : "0.19.11",
          "major" : 0,
          "minor" : 19,
          "patch" : 11,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.25",
          "value" : "7.3.25",
          "major" : 7,
          "minor" : 3,
          "patch" : 25,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.049232Z",
      "updatedAt" : "2024-11-15T02:30:44.049232Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/2501ec27-8c57-4f9f-a56d-0704aff7549d"
        }
      }
    }, {
      "id" : "309cd842-36ae-47c1-a789-e72f2880711c",
      "networkVersion" : "7.3.21",
      "zitiVersion" : "0.19.7",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.7",
          "value" : "0.19.7",
          "major" : 0,
          "minor" : 19,
          "patch" : 7,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.21",
          "value" : "7.3.21",
          "major" : 7,
          "minor" : 3,
          "patch" : 21,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.054638Z",
      "updatedAt" : "2024-11-15T02:30:44.054638Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/309cd842-36ae-47c1-a789-e72f2880711c"
        }
      }
    }, {
      "id" : "3942035d-fba3-4286-9411-bf9ad93fed82",
      "networkVersion" : "7.3.15",
      "zitiVersion" : "0.19.1",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.1",
          "value" : "0.19.1",
          "major" : 0,
          "minor" : 19,
          "patch" : 1,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.15",
          "value" : "7.3.15",
          "major" : 7,
          "minor" : 3,
          "patch" : 15,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.072155Z",
      "updatedAt" : "2024-11-15T02:30:44.072155Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/3942035d-fba3-4286-9411-bf9ad93fed82"
        }
      }
    }, {
      "id" : "3978842d-59cf-45e5-b639-8d213749acd9",
      "networkVersion" : "7.3.36",
      "zitiVersion" : "0.24.13",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : false,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.24.13",
          "value" : "0.24.13",
          "major" : 0,
          "minor" : 24,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.36",
          "value" : "7.3.36",
          "major" : 7,
          "minor" : 3,
          "patch" : 36,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : false
      },
      "createdAt" : "2024-11-15T02:30:44.109574Z",
      "updatedAt" : "2024-11-15T02:30:44.109574Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/3978842d-59cf-45e5-b639-8d213749acd9"
        }
      }
    }, {
      "id" : "3bd2e59a-cbe0-4ff7-a9fa-e7c4a9ac9af0",
      "networkVersion" : "8.0.43",
      "zitiVersion" : "0.25.3",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.25.3",
          "value" : "0.25.3",
          "major" : 0,
          "minor" : 25,
          "patch" : 3,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "8.0.43",
          "value" : "8.0.43",
          "major" : 8,
          "minor" : 0,
          "patch" : 43,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.084269Z",
      "updatedAt" : "2024-11-15T02:30:44.084269Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/3bd2e59a-cbe0-4ff7-a9fa-e7c4a9ac9af0"
        }
      }
    }, {
      "id" : "3ecb3673-e1be-425d-968b-035abe262031",
      "networkVersion" : "7.3.29",
      "zitiVersion" : "0.20.2",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.20.2",
          "value" : "0.20.2",
          "major" : 0,
          "minor" : 20,
          "patch" : 2,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.29",
          "value" : "7.3.29",
          "major" : 7,
          "minor" : 3,
          "patch" : 29,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.043179Z",
      "updatedAt" : "2024-11-15T02:30:44.043179Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/3ecb3673-e1be-425d-968b-035abe262031"
        }
      }
    }, {
      "id" : "4cd59925-13fa-45bb-b81a-ec779f93ca92",
      "networkVersion" : "7.3.6",
      "zitiVersion" : "0.18.2",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.18.2",
          "value" : "0.18.2",
          "major" : 0,
          "minor" : 18,
          "patch" : 2,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.6",
          "value" : "7.3.6",
          "major" : 7,
          "minor" : 3,
          "patch" : 6,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.061049Z",
      "updatedAt" : "2024-11-15T02:30:44.061049Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/4cd59925-13fa-45bb-b81a-ec779f93ca92"
        }
      }
    }, {
      "id" : "6a2f470e-949c-4fa5-92d1-6a26572dfb85",
      "networkVersion" : "7.3.33",
      "zitiVersion" : "0.20.10",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.20.10",
          "value" : "0.20.10",
          "major" : 0,
          "minor" : 20,
          "patch" : 10,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.33",
          "value" : "7.3.33",
          "major" : 7,
          "minor" : 3,
          "patch" : 33,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.118452Z",
      "updatedAt" : "2024-11-15T02:30:44.118452Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/6a2f470e-949c-4fa5-92d1-6a26572dfb85"
        }
      }
    }, {
      "id" : "6a6beffa-16d2-4f2e-a5c3-c5a5a86e1d8d",
      "networkVersion" : "7.3.5",
      "zitiVersion" : "0.18.0",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.18.0",
          "value" : "0.18.0",
          "major" : 0,
          "minor" : 18,
          "patch" : 0,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.5",
          "value" : "7.3.5",
          "major" : 7,
          "minor" : 3,
          "patch" : 5,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.062598Z",
      "updatedAt" : "2024-11-15T02:30:44.062598Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/6a6beffa-16d2-4f2e-a5c3-c5a5a86e1d8d"
        }
      }
    }, {
      "id" : "6d473d05-f514-422f-afa4-af550b2722fd",
      "networkVersion" : "7.3.14",
      "zitiVersion" : "0.19.0",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.0",
          "value" : "0.19.0",
          "major" : 0,
          "minor" : 19,
          "patch" : 0,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.14",
          "value" : "7.3.14",
          "major" : 7,
          "minor" : 3,
          "patch" : 14,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.073507Z",
      "updatedAt" : "2024-11-15T02:30:44.073507Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/6d473d05-f514-422f-afa4-af550b2722fd"
        }
      }
    }, {
      "id" : "6e9012cd-5738-44ec-9ac6-3feaea00e845",
      "networkVersion" : "7.3.92",
      "zitiVersion" : "0.28.4",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.28.4",
          "value" : "0.28.4",
          "major" : 0,
          "minor" : 28,
          "patch" : 4,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.92",
          "value" : "7.3.92",
          "major" : 7,
          "minor" : 3,
          "patch" : 92,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.096313Z",
      "updatedAt" : "2024-11-15T02:30:44.096313Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/6e9012cd-5738-44ec-9ac6-3feaea00e845"
        }
      }
    }, {
      "id" : "6e94a9ac-6ac6-4175-9c2a-166494dcbc93",
      "networkVersion" : "7.3.37",
      "zitiVersion" : "0.24.14",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.24.14",
          "value" : "0.24.14",
          "major" : 0,
          "minor" : 24,
          "patch" : 14,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.37",
          "value" : "7.3.37",
          "major" : 7,
          "minor" : 3,
          "patch" : 37,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.107872Z",
      "updatedAt" : "2024-11-15T02:30:44.107872Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/6e94a9ac-6ac6-4175-9c2a-166494dcbc93"
        }
      }
    }, {
      "id" : "7b1e73c5-2a62-4b03-973e-4e0c8b561a7b",
      "networkVersion" : "8.1.12",
      "zitiVersion" : "1.1.12",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "1.1.12",
          "value" : "1.1.12",
          "major" : 1,
          "minor" : 1,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "version" : {
          "originalValue" : "8.1.12",
          "value" : "8.1.12",
          "major" : 8,
          "minor" : 1,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.124018Z",
      "updatedAt" : "2024-11-15T02:30:44.124018Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/7b1e73c5-2a62-4b03-973e-4e0c8b561a7b"
        }
      }
    }, {
      "id" : "7f1ced5f-8bba-4965-9a83-b9fcdd649d61",
      "networkVersion" : "7.3.28",
      "zitiVersion" : "0.20.1",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.20.1",
          "value" : "0.20.1",
          "major" : 0,
          "minor" : 20,
          "patch" : 1,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.28",
          "value" : "7.3.28",
          "major" : 7,
          "minor" : 3,
          "patch" : 28,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.044759Z",
      "updatedAt" : "2024-11-15T02:30:44.044759Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/7f1ced5f-8bba-4965-9a83-b9fcdd649d61"
        }
      }
    }, {
      "id" : "8028db1c-6bfc-474b-b375-6cea6d5c5f59",
      "networkVersion" : "7.3.62",
      "zitiVersion" : "0.25.14",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.25.14",
          "value" : "0.25.14",
          "major" : 0,
          "minor" : 25,
          "patch" : 14,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.62",
          "value" : "7.3.62",
          "major" : 7,
          "minor" : 3,
          "patch" : 62,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.100030Z",
      "updatedAt" : "2024-11-15T02:30:44.100030Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/8028db1c-6bfc-474b-b375-6cea6d5c5f59"
        }
      }
    }, {
      "id" : "8a23abf5-334b-4953-9eff-67e890e1852e",
      "networkVersion" : "7.3.35",
      "zitiVersion" : "0.20.12",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.20.12",
          "value" : "0.20.12",
          "major" : 0,
          "minor" : 20,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.35",
          "value" : "7.3.35",
          "major" : 7,
          "minor" : 3,
          "patch" : 35,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.115150Z",
      "updatedAt" : "2024-11-15T02:30:44.115150Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/8a23abf5-334b-4953-9eff-67e890e1852e"
        }
      }
    }, {
      "id" : "8f4ab8f2-55a2-4e47-8786-9c58d21f8e0c",
      "networkVersion" : "7.3.34",
      "zitiVersion" : "0.20.11",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.20.11",
          "value" : "0.20.11",
          "major" : 0,
          "minor" : 20,
          "patch" : 11,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.34",
          "value" : "7.3.34",
          "major" : 7,
          "minor" : 3,
          "patch" : 34,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.117080Z",
      "updatedAt" : "2024-11-15T02:30:44.117080Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/8f4ab8f2-55a2-4e47-8786-9c58d21f8e0c"
        }
      }
    }, {
      "id" : "952390db-5d23-41f9-bae4-2f7645b2b89d",
      "networkVersion" : "7.3.7",
      "zitiVersion" : "0.08.3",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.08.3",
          "value" : "0.08.3",
          "major" : 0,
          "minor" : 8,
          "patch" : 3,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.7",
          "value" : "7.3.7",
          "major" : 7,
          "minor" : 3,
          "patch" : 7,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.060017Z",
      "updatedAt" : "2024-11-15T02:30:44.060017Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/952390db-5d23-41f9-bae4-2f7645b2b89d"
        }
      }
    }, {
      "id" : "97748e69-13e7-4706-88ff-4ec010455302",
      "networkVersion" : "7.3.13",
      "zitiVersion" : "0.18.10",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.18.10",
          "value" : "0.18.10",
          "major" : 0,
          "minor" : 18,
          "patch" : 10,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.13",
          "value" : "7.3.13",
          "major" : 7,
          "minor" : 3,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.074977Z",
      "updatedAt" : "2024-11-15T02:30:44.074977Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/97748e69-13e7-4706-88ff-4ec010455302"
        }
      }
    }, {
      "id" : "9ae8731a-32c1-4bcc-836a-3d4f9a4c5fb0",
      "networkVersion" : "7.3.26",
      "zitiVersion" : "0.19.12",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.12",
          "value" : "0.19.12",
          "major" : 0,
          "minor" : 19,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.26",
          "value" : "7.3.26",
          "major" : 7,
          "minor" : 3,
          "patch" : 26,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.047785Z",
      "updatedAt" : "2024-11-15T02:30:44.047785Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/9ae8731a-32c1-4bcc-836a-3d4f9a4c5fb0"
        }
      }
    }, {
      "id" : "a0f04e7c-d593-4aed-a9a2-404f5942c17c",
      "networkVersion" : "7.3.10",
      "zitiVersion" : "0.18.7",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.18.7",
          "value" : "0.18.7",
          "major" : 0,
          "minor" : 18,
          "patch" : 7,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.10",
          "value" : "7.3.10",
          "major" : 7,
          "minor" : 3,
          "patch" : 10,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.079830Z",
      "updatedAt" : "2024-11-15T02:30:44.079830Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/a0f04e7c-d593-4aed-a9a2-404f5942c17c"
        }
      }
    }, {
      "id" : "a72aa5fb-2b0a-48cf-931c-bbff5be60691",
      "networkVersion" : "7.3.20",
      "zitiVersion" : "0.19.6",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.6",
          "value" : "0.19.6",
          "major" : 0,
          "minor" : 19,
          "patch" : 6,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.20",
          "value" : "7.3.20",
          "major" : 7,
          "minor" : 3,
          "patch" : 20,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.056191Z",
      "updatedAt" : "2024-11-15T02:30:44.056191Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/a72aa5fb-2b0a-48cf-931c-bbff5be60691"
        }
      }
    }, {
      "id" : "a9f80a0e-caba-4153-a81a-74ad0bb84f34",
      "networkVersion" : "7.3.30",
      "zitiVersion" : "0.20.3",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.20.3",
          "value" : "0.20.3",
          "major" : 0,
          "minor" : 20,
          "patch" : 3,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.30",
          "value" : "7.3.30",
          "major" : 7,
          "minor" : 3,
          "patch" : 30,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.122601Z",
      "updatedAt" : "2024-11-15T02:30:44.122601Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/a9f80a0e-caba-4153-a81a-74ad0bb84f34"
        }
      }
    }, {
      "id" : "aa354c89-3a85-488d-9937-625c0339d73e",
      "networkVersion" : "7.3.89",
      "zitiVersion" : "0.27.9",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.27.9",
          "value" : "0.27.9",
          "major" : 0,
          "minor" : 27,
          "patch" : 9,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.89",
          "value" : "7.3.89",
          "major" : 7,
          "minor" : 3,
          "patch" : 89,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.125398Z",
      "updatedAt" : "2024-11-15T02:30:44.125398Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/aa354c89-3a85-488d-9937-625c0339d73e"
        }
      }
    }, {
      "id" : "b0cee9b9-2dc1-4954-baf2-8b529494528b",
      "networkVersion" : "7.3.69",
      "zitiVersion" : "0.25.13",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.25.13",
          "value" : "0.25.13",
          "major" : 0,
          "minor" : 25,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.69",
          "value" : "7.3.69",
          "major" : 7,
          "minor" : 3,
          "patch" : 69,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.082855Z",
      "updatedAt" : "2024-11-15T02:30:44.082855Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/b0cee9b9-2dc1-4954-baf2-8b529494528b"
        }
      }
    }, {
      "id" : "b3375eaf-f40c-411d-b21c-cc1f43d2bd3b",
      "networkVersion" : "7.3.4",
      "zitiVersion" : "0.17.5",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.17.5",
          "value" : "0.17.5",
          "major" : 0,
          "minor" : 17,
          "patch" : 5,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.4",
          "value" : "7.3.4",
          "major" : 7,
          "minor" : 3,
          "patch" : 4,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.063827Z",
      "updatedAt" : "2024-11-15T02:30:44.063827Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/b3375eaf-f40c-411d-b21c-cc1f43d2bd3b"
        }
      }
    }, {
      "id" : "be4201bc-eca9-4afb-8280-d5e146535f89",
      "networkVersion" : "7.3.19",
      "zitiVersion" : "0.19.5",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.5",
          "value" : "0.19.5",
          "major" : 0,
          "minor" : 19,
          "patch" : 5,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.19",
          "value" : "7.3.19",
          "major" : 7,
          "minor" : 3,
          "patch" : 19,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.066542Z",
      "updatedAt" : "2024-11-15T02:30:44.066542Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/be4201bc-eca9-4afb-8280-d5e146535f89"
        }
      }
    }, {
      "id" : "c1d7d7ce-3d29-4ff6-a27d-eff67d1b076f",
      "networkVersion" : "7.3.27",
      "zitiVersion" : "0.19.13",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.13",
          "value" : "0.19.13",
          "major" : 0,
          "minor" : 19,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.27",
          "value" : "7.3.27",
          "major" : 7,
          "minor" : 3,
          "patch" : 27,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.046279Z",
      "updatedAt" : "2024-11-15T02:30:44.046279Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/c1d7d7ce-3d29-4ff6-a27d-eff67d1b076f"
        }
      }
    }, {
      "id" : "c1dbc218-d36b-4afa-975f-d1bfbaabc570",
      "networkVersion" : "7.3.12",
      "zitiVersion" : "0.18.9",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.18.9",
          "value" : "0.18.9",
          "major" : 0,
          "minor" : 18,
          "patch" : 9,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.12",
          "value" : "7.3.12",
          "major" : 7,
          "minor" : 3,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.076894Z",
      "updatedAt" : "2024-11-15T02:30:44.076894Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/c1dbc218-d36b-4afa-975f-d1bfbaabc570"
        }
      }
    }, {
      "id" : "c5c925dc-a3e0-49e2-b47d-fae91e0257ad",
      "networkVersion" : "7.3.22",
      "zitiVersion" : "0.19.8",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.8",
          "value" : "0.19.8",
          "major" : 0,
          "minor" : 19,
          "patch" : 8,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.22",
          "value" : "7.3.22",
          "major" : 7,
          "minor" : 3,
          "patch" : 22,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.053312Z",
      "updatedAt" : "2024-11-15T02:30:44.053312Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/c5c925dc-a3e0-49e2-b47d-fae91e0257ad"
        }
      }
    }, {
      "id" : "cc800ee9-912e-4c79-8cf3-cea8f6509c13",
      "networkVersion" : "7.3.9",
      "zitiVersion" : "0.18.5",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.18.5",
          "value" : "0.18.5",
          "major" : 0,
          "minor" : 18,
          "patch" : 5,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.9",
          "value" : "7.3.9",
          "major" : 7,
          "minor" : 3,
          "patch" : 9,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.057524Z",
      "updatedAt" : "2024-11-15T02:30:44.057524Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/cc800ee9-912e-4c79-8cf3-cea8f6509c13"
        }
      }
    }, {
      "id" : "cf2bcea7-f4f2-4eb2-a640-7e1d808e0331",
      "networkVersion" : "7.3.17",
      "zitiVersion" : "0.19.3",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.3",
          "value" : "0.19.3",
          "major" : 0,
          "minor" : 19,
          "patch" : 3,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.17",
          "value" : "7.3.17",
          "major" : 7,
          "minor" : 3,
          "patch" : 17,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.069144Z",
      "updatedAt" : "2024-11-15T02:30:44.069144Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/cf2bcea7-f4f2-4eb2-a640-7e1d808e0331"
        }
      }
    }, {
      "id" : "dc22022f-487c-49d5-809a-3f37ef53bc26",
      "networkVersion" : "7.4.5",
      "zitiVersion" : "1.1.4",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "1.1.4",
          "value" : "1.1.4",
          "major" : 1,
          "minor" : 1,
          "patch" : 4,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "version" : {
          "originalValue" : "7.4.5",
          "value" : "7.4.5",
          "major" : 7,
          "minor" : 4,
          "patch" : 5,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.081239Z",
      "updatedAt" : "2024-11-15T02:30:44.081239Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/dc22022f-487c-49d5-809a-3f37ef53bc26"
        }
      }
    }, {
      "id" : "e466b3ac-72e9-4f77-b775-9fac991fc934",
      "networkVersion" : "7.3.31",
      "zitiVersion" : "0.20.8",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.20.8",
          "value" : "0.20.8",
          "major" : 0,
          "minor" : 20,
          "patch" : 8,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.31",
          "value" : "7.3.31",
          "major" : 7,
          "minor" : 3,
          "patch" : 31,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.121345Z",
      "updatedAt" : "2024-11-15T02:30:44.121345Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/e466b3ac-72e9-4f77-b775-9fac991fc934"
        }
      }
    }, {
      "id" : "e5d5e19d-830b-4539-96b1-27ac7566c9a8",
      "networkVersion" : "7.3.18",
      "zitiVersion" : "0.19.4",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : true,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.4",
          "value" : "0.19.4",
          "major" : 0,
          "minor" : 19,
          "patch" : 4,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.18",
          "value" : "7.3.18",
          "major" : 7,
          "minor" : 3,
          "patch" : 18,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : true,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.067786Z",
      "updatedAt" : "2024-11-15T02:30:44.067786Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : true,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/e5d5e19d-830b-4539-96b1-27ac7566c9a8"
        }
      }
    }, {
      "id" : "f2aa7035-19a2-4642-affc-5ae5ac327a71",
      "networkVersion" : "7.4.13",
      "zitiVersion" : "1.1.12",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "1.1.12",
          "value" : "1.1.12",
          "major" : 1,
          "minor" : 1,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "version" : {
          "originalValue" : "7.4.13",
          "value" : "7.4.13",
          "major" : 7,
          "minor" : 4,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.065400Z",
      "updatedAt" : "2024-11-15T02:30:44.065400Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/f2aa7035-19a2-4642-affc-5ae5ac327a71"
        }
      }
    }, {
      "id" : "fbcb045e-8c14-4f90-87dc-a1da491797fc",
      "networkVersion" : "7.3.16",
      "zitiVersion" : "0.19.2",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "zitiVersion" : {
          "originalValue" : "0.19.2",
          "value" : "0.19.2",
          "major" : 0,
          "minor" : 19,
          "patch" : 2,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        },
        "version" : {
          "originalValue" : "7.3.16",
          "value" : "7.3.16",
          "major" : 7,
          "minor" : 3,
          "patch" : 16,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "defaultVersion" : false,
        "active" : true
      },
      "createdAt" : "2024-11-15T02:30:44.070629Z",
      "updatedAt" : "2024-11-15T02:30:44.070629Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/fbcb045e-8c14-4f90-87dc-a1da491797fc"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 45,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

networkControllers

true

edgeRouters

true

edgeRouterPolicies

true

endpoints

true

services

true

appWans

true

certificateAuthorities

true

hosts

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-versions/6a6beffa-16d2-4f2e-a5c3-c5a5a86e1d8d' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJTMzNxbEF6bjBiRHVXeUNnV0YwTUR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQxODdhNGI5LWUwYjItNGVmYS1hOWE0LTJiZTQ0YTdiNmRmZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg0NCwiZXhwIjoxNzMxNjQxNDQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQxMDk2MDdkLTk5ZTYtNDYyOC05NjUzLTAwNDlkMDE3ZGRiNFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg0NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jCD2j0qwGI9UByZXV3QpkAaJRWT9LeTIf6yboAC-IgoWZrFu3Zlojcun5uasbJw4wqNsW-umq-FSa66ZtTnEn4AmP9f8tMUm_401FWAD-v8dRHZ3lhGsU1iqGkYGTQ8HPez-seLUqvTCNGMOUsEqZo3-7rREI5Ryux1AEAplwQoVHsUTYhB2a3okKI0AhKy5H90QRvi5mia3FboTqawn1F-Dt17WK6XdF3Ywkbuf-rkxUs-e7lNXpIli3Yd4u-Dlp6TviuEYxPCNx3l-VBLQ55gmAP2VPKEEhV3yQcasROTBvAdqrjLapDj3bkc84d7ynJISV_gomM5zZ5GwxLbAWQ'

Example response

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

{
  "id" : "6a6beffa-16d2-4f2e-a5c3-c5a5a86e1d8d",
  "networkVersion" : "7.3.5",
  "zitiVersion" : "0.18.0",
  "minimumNetworkVersionForUpgrade" : null,
  "minimumEdgeRouterVersionForUpgrade" : null,
  "active" : true,
  "default" : false,
  "jsonNode" : {
    "zitiVersion" : {
      "originalValue" : "0.18.0",
      "value" : "0.18.0",
      "major" : 0,
      "minor" : 18,
      "patch" : 0,
      "suffixTokens" : [ ],
      "build" : null,
      "type" : "STRICT",
      "stable" : false
    },
    "version" : {
      "originalValue" : "7.3.5",
      "value" : "7.3.5",
      "major" : 7,
      "minor" : 3,
      "patch" : 5,
      "suffixTokens" : [ ],
      "build" : null,
      "type" : "STRICT",
      "stable" : true
    },
    "defaultVersion" : false,
    "active" : true
  },
  "createdAt" : "2024-11-15T02:30:44.062598Z",
  "updatedAt" : "2024-11-15T02:30:44.062598Z",
  "platformFeatures" : [ ],
  "zitiFeatures" : [ {
    "displayName" : "service-policy",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "policy-advice",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "transit-router",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "terminator",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "posture-check",
    "introducedAt" : "0.16.5",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "posture-check.process",
    "introducedAt" : "0.16.5",
    "deprecatedAt" : "0.20.0",
    "removedAt" : null
  }, {
    "displayName" : "identity-type",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "identity",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "config-type",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "config",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "service-edge-router-policy",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "cas",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "service",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "edge-router",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "session",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "edge-router-policy",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  }, {
    "displayName" : "authenticator",
    "introducedAt" : "0.0.0",
    "deprecatedAt" : null,
    "removedAt" : null
  } ],
  "recommended" : false,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/6a6beffa-16d2-4f2e-a5c3-c5a5a86e1d8d"
    },
    "versions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions",
      "profile" : "parent"
    }
  }
}

Optional

Description

networkCount

Integer

true

defaultEndpointCount

Integer

true

defaultControllerCount

Integer

true

networkGroupId

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-group-limits' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJHSFZES0poT3NOWk5lSW53ZGNFR0xBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI0NzZmYTM0LWViZTAtNGJkNy05ZmNlLTk1OWQ3N2NjNTM0ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg3NiwiZXhwIjoxNzMxNjQxNDc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgyMDRjZWNjLTA5MWItNDQ4NS04NDEyLTg2NTQyZTYxMjM0NlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.WEcOtb8bPK_042IWRraGbWqtGPptn3U8wsX_eVUtg69n904qav_26NVmjA0JStN9BjhFI3jUxp-jo2kmvORf1mkN-U-QQCYLKalKL-iOGopjBny56iWT8X5b0eN-HM0O85thBMIM-nVHNN2jRtmFH1c-1rvoWr8b6S0TT7H8PNAhSSEbWIn082w2_rNE3wOWso1D3v333szSnF41w6NX5Nrc7azqzHCyxOZyXuaj6QwTMRLgYTu6StwiMbzM7ph9-GbYLD3cnMGTigwaOJK4fS4H81Tk6DMy6T4Rgt4cqyJgXRplUbN9nGbkovYxFalKTNCbu4HyRcHHMm1twX8PDw' \
    -d '{"networkCount":1,"defaultEndpointCount":1,"defaultControllerCount":null,"networkGroupId":"9f082a24-91fc-4796-8c21-59947e58d88a"}'

Example response

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

{
  "id" : "d305d292-f7b1-41a1-bbbb-82603121e68e",
  "networkCount" : 1,
  "defaultEndpointCount" : 1,
  "defaultControllerCount" : -1,
  "networkGroupId" : "9f082a24-91fc-4796-8c21-59947e58d88a",
  "createdBy" : "2476fa34-ebe0-4bd7-9fce-959d77cc534f",
  "createdAt" : "2024-11-15T02:31:16.708948Z",
  "updatedAt" : "2024-11-15T02:31:16.708948Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/9f082a24-91fc-4796-8c21-59947e58d88a",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/d305d292-f7b1-41a1-bbbb-82603121e68e"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-group-limits/a6ef2518-834c-4ca8-a35f-1c0a52e64e39' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJOWEVINFhUbE5kSU1ucVJoSEFZaVRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE4ZjhmNmU3LTA2ZWQtNGY3ZC1hZTFkLTFmMmFjMGE0NDI3YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg3NiwiZXhwIjoxNzMxNjQxNDc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjUxMGQ1Njc5LTgxZWUtNDMxZS1iOGFhLTA5ZDY2ZjI4OTkzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.atgGKxKmuucEIni1yC6KSfDDRjROIDOhR0vbbxsF3oePJtHpXxfyHW0pw7H5RgFBxPr4LiH0eJnxUMV9WIz7iWqxgj0Q07ROMMHe_iqrXknWw-YtwCOiuIc31v_6Z2w1HmNH34aiejYXhAIR7OEFj66TYGe5tZNy50RlIc_Ef1ckJUjN3wYtUra2_2GxwEX21zkRffU77g6MS0aNiX4LAwBc2hVIGTyvoEDGqBBYYkmW8W4ZfWdCckkgeqcHxVuTayJeQE_I9AZEhw3X6Y93__wTvAhWH-wq7IP_fryfmDrT-w-b8BVhz81wwxNZEgivog6pL5l01cE2z51ALWRiCQ'

Example response

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

{
  "id" : "a6ef2518-834c-4ca8-a35f-1c0a52e64e39",
  "networkCount" : 1,
  "defaultEndpointCount" : 1,
  "defaultControllerCount" : -1,
  "networkGroupId" : "049a6e94-7c8c-48e2-9e24-ed3e0a996386",
  "createdBy" : "125f3db7-5bb2-4f3b-9135-598978bffa5b",
  "createdAt" : "2024-11-15T02:31:16.388635Z",
  "updatedAt" : "2024-11-15T02:31:16.399727Z",
  "deletedBy" : "a8f8f6e7-06ed-4f7d-ae1d-1f2ac0a4427a",
  "deletedAt" : "2024-11-15T02:31:16.399Z",
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/049a6e94-7c8c-48e2-9e24-ed3e0a996386",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/a6ef2518-834c-4ca8-a35f-1c0a52e64e39"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-group-limits/74851dc4-86ba-4114-9836-1ee177164a76' -i -X GET \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJkdmFDLTEtY3VwcXd3ODdZV0ZaT2hnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc1NjBjODZiLWIwNWMtNDAxZi1iYWQ5LTMxZTNjYWQ3YTg1NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg3NiwiZXhwIjoxNzMxNjQxNDc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjI0MjZiYmFkLTAxMDUtNGI2Yi05NzZlLTc4MjUzZDNmZDY2N1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.CKfIF_F02xtaH5pip9AvEeHgBwV1YviyvO-oj18-5fn82dEJ41LVPSNm4xhpJDh8ooNC9bje3SxbuiXUaB-LAl9wTL9k1XmHvRXSTBiOtFSbwN74sT_Mts7bGDoBw7PSt0TChZwIV9otieY8t1n-z4-ovm3o3eUNRnotD6CpDY1lVqXWsH8YtO8Z8fSbVzLoFI2CqNgG9D_gs7HL0I_Bx4ireK4szx0bYKwcbx_ymE4MBSktAZYcLDtjaieviY65XObWQV2RZN1mGwC69T74R8I_aLW4QeLCY9AsubT1k17pcLyLt6BXAVoA3aPHsBey0MaM1tQNVDlnVpXZlzZJsw'

Example response

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

{
  "id" : "74851dc4-86ba-4114-9836-1ee177164a76",
  "networkCount" : 1,
  "defaultEndpointCount" : 1,
  "defaultControllerCount" : -1,
  "networkGroupId" : "f09e65c9-3a38-4dc5-89e9-12d77389060e",
  "createdBy" : "96dc0a09-753f-4edf-bb9f-6dd1b212a682",
  "createdAt" : "2024-11-15T02:31:16.184983Z",
  "updatedAt" : "2024-11-15T02:31:16.184983Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/f09e65c9-3a38-4dc5-89e9-12d77389060e",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/74851dc4-86ba-4114-9836-1ee177164a76"
    }
  }
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkCount

Integer

true

defaultEndpointCount

Integer

true

defaultControllerCount

Integer

true

networkGroupId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-group-limits?networkCount=1' -i -X GET \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJuaDNISDFSeEhwSmEyWUJUM1AtM1VRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNjMjZiZWU1LWNiYzMtNGIzOS04Yzc3LWQzMzdjOWJlMDMwOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg3NiwiZXhwIjoxNzMxNjQxNDc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJmN2Q5YTQ4LWNhYWMtNDkwOS1iNjY0LTNhNjkwY2MyMjJhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.HhHiAEZpkfaWiQyWeq4vGZBg-lhjUyW0-PBYMAB9nag2-Y1J_HZR1lenUn0YWkRye7GVVmSjlbKQorv1ysj4ELmRD-7kYcdwixPcNuQG6mtfPFZXAeHdPV__Qd3l3eEnq_5Ymp2VDwE4_wdcnfeKPdJGQkDzL-zbzlSuzL5TFr9jdIMd_Qb3nmZWYQ2ZksH9nhrGQzm-6ZL7rMSmJ6O75aY-1CvmdXOAzL6RuXBGpMHVM6xMMwSTDKrUsaIB4lKy3SyRl_a83TMTgDgIcCH6VwQinC_z4TdI4N423bUOImndu6jLZ5C_73JN6ltAYHM5ynVD-5ph7VJpQJGq26mtog'

Example response

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

{
  "_embedded" : {
    "networkGroupLimitList" : [ {
      "id" : "4ff38e73-0f23-4e24-8666-82ce206bb04f",
      "networkCount" : 1,
      "defaultEndpointCount" : 1,
      "defaultControllerCount" : -1,
      "networkGroupId" : "80cf5401-404e-4484-9dd3-2d5e4b64d774",
      "createdBy" : "51cd9f3b-7c2b-4a02-8b8c-21503fafcfab",
      "createdAt" : "2024-11-15T02:31:16.442209Z",
      "updatedAt" : "2024-11-15T02:31:16.442209Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/80cf5401-404e-4484-9dd3-2d5e4b64d774",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/4ff38e73-0f23-4e24-8666-82ce206bb04f"
        }
      }
    }, {
      "id" : "74851dc4-86ba-4114-9836-1ee177164a76",
      "networkCount" : 1,
      "defaultEndpointCount" : 1,
      "defaultControllerCount" : -1,
      "networkGroupId" : "f09e65c9-3a38-4dc5-89e9-12d77389060e",
      "createdBy" : "96dc0a09-753f-4edf-bb9f-6dd1b212a682",
      "createdAt" : "2024-11-15T02:31:16.184983Z",
      "updatedAt" : "2024-11-15T02:31:16.184983Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/f09e65c9-3a38-4dc5-89e9-12d77389060e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/74851dc4-86ba-4114-9836-1ee177164a76"
        }
      }
    }, {
      "id" : "8e2b8153-0ce6-4a27-b561-6346b3954cf7",
      "networkCount" : 1,
      "defaultEndpointCount" : 1,
      "defaultControllerCount" : -1,
      "networkGroupId" : "8a118521-4fed-4742-adff-9fe0e2dc3438",
      "createdBy" : "11d8c94f-97d4-463e-9151-88bcb7193f5d",
      "createdAt" : "2024-11-15T02:31:16.812258Z",
      "updatedAt" : "2024-11-15T02:31:16.812258Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/8a118521-4fed-4742-adff-9fe0e2dc3438",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/8e2b8153-0ce6-4a27-b561-6346b3954cf7"
        }
      }
    }, {
      "id" : "a6ef2518-834c-4ca8-a35f-1c0a52e64e39",
      "networkCount" : 1,
      "defaultEndpointCount" : 1,
      "defaultControllerCount" : -1,
      "networkGroupId" : "049a6e94-7c8c-48e2-9e24-ed3e0a996386",
      "createdBy" : "125f3db7-5bb2-4f3b-9135-598978bffa5b",
      "createdAt" : "2024-11-15T02:31:16.388635Z",
      "updatedAt" : "2024-11-15T02:31:16.399727Z",
      "deletedBy" : "a8f8f6e7-06ed-4f7d-ae1d-1f2ac0a4427a",
      "deletedAt" : "2024-11-15T02:31:16.399Z",
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/049a6e94-7c8c-48e2-9e24-ed3e0a996386",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/a6ef2518-834c-4ca8-a35f-1c0a52e64e39"
        }
      }
    }, {
      "id" : "d305d292-f7b1-41a1-bbbb-82603121e68e",
      "networkCount" : 1,
      "defaultEndpointCount" : 1,
      "defaultControllerCount" : -1,
      "networkGroupId" : "9f082a24-91fc-4796-8c21-59947e58d88a",
      "createdBy" : "2476fa34-ebe0-4bd7-9fce-959d77cc534f",
      "createdAt" : "2024-11-15T02:31:16.708948Z",
      "updatedAt" : "2024-11-15T02:31:16.708948Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/9f082a24-91fc-4796-8c21-59947e58d88a",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/d305d292-f7b1-41a1-bbbb-82603121e68e"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits?networkCount=1"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

networkCount

Integer

true

defaultEndpointCount

Integer

true

defaultControllerCount

Integer

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-group-limits/73b6bae2-705e-4f3f-ac6a-4e1ab34acfe5' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJsUDF6MV82ZjR2eTlPLXF2eG5rUnFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE2ZWE0ZGVjLWRmZmYtNDk3ZC1iM2U2LTMzMDNlMmUyZDFlMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg3NiwiZXhwIjoxNzMxNjQxNDc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY5NzBmNzFhLWRiYzUtNDE2Zi1iZjcxLTY5YTAxMmIzZTE4MVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ZS18aufb54GGyfgARqlbHBN8tCXo-kHgwIqS4bimffG7cCkHzqcksYyRD5b1gB2VjvYXbcQu8phq1Wpc64iZvfyotG700ThQD596CsKOCgMyV2NR52_Quo_UOthIudfuGS_IL0quLg_4IMR1seWFF77N07_vdahndZqTxIEsXhrn_PrTp1OqzqAsJRZc6nHKrUFldmmprm-6IHBsQVLU4sh8cTDUm60VcoFLZOHvXHkvyvyjYUlPNvcNyPG6hb6vBvOgf_Se0EWOJ_lSiTAj7khbGNa1VgpZDU13b3vdKb_9xpmARdbhqnaS8MouT4izKLXHc7UDri-iclkcPEvzUA' \
    -d '{"networkCount":2,"defaultEndpointCount":null,"defaultControllerCount":null}'

Example response

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

{
  "id" : "73b6bae2-705e-4f3f-ac6a-4e1ab34acfe5",
  "networkCount" : 2,
  "defaultEndpointCount" : 1,
  "defaultControllerCount" : -1,
  "networkGroupId" : "4e4e1a51-d217-4a7f-95fc-8851a953ac25",
  "createdBy" : "cb327e03-ca83-42e9-8467-041e7b9e5d62",
  "createdAt" : "2024-11-15T02:31:16.963771Z",
  "updatedAt" : "2024-11-15T02:31:17.019668Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/4e4e1a51-d217-4a7f-95fc-8851a953ac25",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/73b6bae2-705e-4f3f-ac6a-4e1ab34acfe5"
    }
  }
}

Optional

Description

endpointCount

Integer

true

controllerCount

Integer

true

networkId

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-limits' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZeFhiX3BCLWU4OEFBd213enVHU0VRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk4NThkZThhLWYyNTYtNGNiNi1iOTcxLTkxYmI0Y2QwODNmZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk0NCwiZXhwIjoxNzMxNjQxNTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFhYjVkMmVhLTVhZjgtNDM5Yy04OWRlLTgwMWU1OTFhMGZhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk0NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.EndJEvbcZrXiNPgTNqB6FFOw7WE3CjHPQ80U2_zz8OTHThA23Q-crZGyy6QG2-SPhLvqS96_q3Zel7pZlMdKKAasLL8oDZbtWECPRqdpH9o0eFX6tDZG0_t3B9cfrdy7RKRh-E92U1ZBQHyJzj-hPgBHhk1PNKTVjKvBN7ciPtK_J33clTRJNl8m5Mhop52FRZdHL0P0L2GtaQ4YWfzCgQczEGK9Q0koX5qcsgRD8WgBMFbyyVTCSUZZPVax9v6b7lBeTA7GwS4bGUdY_Qi1kAhrmDnf4HmXn33DdOzATlNuw52-9yvf9Oa40ybkXm-3YJhKhy3dUfVR_ERViqtb7Q' \
    -d '{"endpointCount":1,"controllerCount":null,"networkId":"55873e2f-6f13-4a79-9549-666e473a56f1"}'

Example response

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

{
  "id" : "95571137-b91e-43e7-9b1a-83d8d4d1f673",
  "endpointCount" : 1,
  "controllerCount" : 1,
  "networkId" : "55873e2f-6f13-4a79-9549-666e473a56f1",
  "createdBy" : "9858de8a-f256-4cb6-b971-91bb4cd083fd",
  "createdAt" : "2024-11-15T02:32:24.763026Z",
  "updatedAt" : "2024-11-15T02:32:24.763026Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits/95571137-b91e-43e7-9b1a-83d8d4d1f673"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/55873e2f-6f13-4a79-9549-666e473a56f1",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/1f51157e-a9a5-4ab5-ac8e-c916c045a7e5",
      "title" : "Create NetworkLimit",
      "profile" : "meta"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-limits/feeaa575-3a3b-418e-9aa8-ee36b6bcdddd' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJoMnhzUy15Nm5ZX1EwOGc4TkFucHZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkyZjc0YzUwLWQxYmItNGNmZi1iMjIyLWExZjM1ZmJmYWNjMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk0NCwiZXhwIjoxNzMxNjQxNTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjY2MDUzNGQ3LWZhMzEtNGQwNC05OWEyLWZiZmY4MTI3MmM0OFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk0NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jEQ1YaRUsELWt4YJZzrZOWEawosr4e2paxMERidrwGivtZKp0zW9l3ulZv538z-zLbUQFyuuoPTmaMg8FOps9RRbU5y9dBQEKDmMQZzwGoYeKmx30bowageM3-0mHHecdkv54H6PWZeuZw-qe4F6YSoj-KTHc3EzQES_ZjGAaRBh7jQoPuHKR4HMQaXFMts9JmIPW-czeYY4JpXJ6O4srHkwfxsqBTbJJ_GolOq81H9OM7pw_-FsYrFuOXTCFpK8CGdUdk43nfAEOAvyJ8JjjSUWnf4V2QVB-5IiPdt1CQqVBbFeVXIXRFA7CVUd9ztKaX3vuqqVHuH3mExZLgcjFA'

Example response

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

{
  "id" : "feeaa575-3a3b-418e-9aa8-ee36b6bcdddd",
  "endpointCount" : 1,
  "controllerCount" : 1,
  "networkId" : "9199b9c4-a9ee-453a-9686-44cbde5a40dd",
  "createdBy" : "a40e125f-18ba-4380-af4c-cce5d7450aa8",
  "createdAt" : "2024-11-15T02:32:24.337235Z",
  "updatedAt" : "2024-11-15T02:32:24.353066Z",
  "deletedBy" : "92f74c50-d1bb-4cff-b222-a1f35fbfacc1",
  "deletedAt" : "2024-11-15T02:32:24.352Z",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits/feeaa575-3a3b-418e-9aa8-ee36b6bcdddd"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9199b9c4-a9ee-453a-9686-44cbde5a40dd",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/4cfde2f6-8cf5-4a0c-9248-7aeaab54648f",
      "title" : "Delete NetworkLimit",
      "profile" : "meta"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-limits/9761d484-4780-44ec-b971-8af761dda745' -i -X GET \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ1dE5YQURmTHdHUzVYRnRGTXdWckl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg1NWIwNDUwLTMwYTMtNDMwOS1iYTdlLTViZGRlZTQ3OGY0MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk0NCwiZXhwIjoxNzMxNjQxNTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjc1YTJhYWRlLTE2OGQtNGI4MS05NjllLWMxYjc4ZWU3NTQyNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk0NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.PbSljjVWMtW3BZsIakQa6Xicl3w-deGsXSeQAnFBgHLGmhI1Zs8CWA5chK8-XY2vUXf0vwiK7wJytZCa7HBG0iDx1OWFf2BLCxj25NcMM8R0QMfELvzOy8xI_M44siVZDtAVb-yt6wRn7D83n3xty_CPZS8PDJW5NjLZfJENmcbdr3sAtpyi50xdgWR9vVRzXZIUjefFLvOc4DccETLuAGLXpiikArl2O3eMw2a-yN6-cjH9EyDm0wnkAj_7QWK5vzaK1rNLTH_bFjgrzOEqcd5POFJwgt9gami8Y25Pe3J15U2_PuVhoL8-5-N0ycUdNTyiEccOfPgErH26tDkNIA'

Example response

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

{
  "id" : "9761d484-4780-44ec-b971-8af761dda745",
  "endpointCount" : 1,
  "controllerCount" : 1,
  "networkId" : "de02fff5-611c-4b05-b81c-6ad71bef80c8",
  "createdBy" : "8731c734-7e48-448f-8aaa-fee5a10da5cc",
  "createdAt" : "2024-11-15T02:32:24.637966Z",
  "updatedAt" : "2024-11-15T02:32:24.637966Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits/9761d484-4780-44ec-b971-8af761dda745"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/de02fff5-611c-4b05-b81c-6ad71bef80c8",
      "profile" : "parent"
    }
  }
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

endpointCount

Integer

true

controllerCount

Integer

true

networkId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-limits?networkId=83f2b1a0-7108-41e4-8084-17bfe3141e53' -i -X GET \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJCQlNRMUswV19HNkN0RW5LdWZqMllRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI5YjZlN2MyLTY0NmYtNDhlOC1iMDk2LTBjMWYzNTc2NmMzYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk0NCwiZXhwIjoxNzMxNjQxNTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk2ZDdkMTA1LTIzZjctNDk5Yi1hMjJiLWMxMmQ1MGJkNTk4YlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk0NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.VjbT_qsFfLB0E0R9eEqgydC2EjCKD4b44aSs-fjAiOxej91o1m88ODrh-MSqNsmroAa8Nyus6i59_wMXqro1tiKuQZ7UKdyBltfMXXP3YPf1K-d99R4RymLwMGxKv64B4IyLEe3Edit7n3f-gvyjGjieCGDm2SYA4IR3boCyvU6MpjoBaU5mXGC6-lwBjgzLQj4HesUZrpcloUUj7Dt2vw4M2yyAeeyEqt2pKU0gX3buPXbjD8Oky2MQqyMs4ZUNrCBHOUcDIp8LiUFTmBlZ4Mq3Oi67tzmbRP0CWubRED6NW5OGRsz3rY6pxbMbAHWInMx5RXInf4brWSC2Qle4Nw'

Example response

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

{
  "_embedded" : {
    "networkLimitList" : [ {
      "id" : "1766d196-c536-40f8-b9f9-974ea7dce0ce",
      "endpointCount" : 1,
      "controllerCount" : 1,
      "networkId" : "83f2b1a0-7108-41e4-8084-17bfe3141e53",
      "createdBy" : "a94ae572-0202-43a3-b9e8-f55ab6f706eb",
      "createdAt" : "2024-11-15T02:32:24.691191Z",
      "updatedAt" : "2024-11-15T02:32:24.691191Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits/1766d196-c536-40f8-b9f9-974ea7dce0ce"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/83f2b1a0-7108-41e4-8084-17bfe3141e53",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits?networkId=83f2b1a0-7108-41e4-8084-17bfe3141e53"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

endpointCount

Integer

true

controllerCount

Integer

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-limits/ceccbe59-8b0d-49cf-b0e2-fcfe85b155e6' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiUUVaRklUYXNCa2ktRkhxdndORk9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJlN2U5MDUxLTU5N2MtNDExMy04MGIzLWFhMjdiMjE2Mzg0ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk0NCwiZXhwIjoxNzMxNjQxNTQ0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFiNjE2NTgzLTYwNjktNDlhNS05MjBiLWY5Y2NmZDE2ODg0MlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk0NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.JLtbZxbE5KgECmT-8C_0o-m-JJoEKrDTTBLF19S7solmz__JsoFk41ecSPdN4x-SFqSvt0Yr7iG0di9YvTfC-BVc5AJydsgHaTFcjSPZq8cJqbuVBfqG7xifSFOSKUOXvaszh1jG3oyiXZ59_8B_tgwEzWHbpERaJe8sgEYqnZHMtKWKHBXBXkxD3NWCts2cQCJu-8QOC_2tpjPuBb5eFkTIP7SfSwXjdMp4az9pVbhkcjkOCfCzN6Qd6untyAjerfBTCmFS1s37TcI-gL_9fmKO3eQEu-Z2aC_0ZQUKoFPXiAGQbC2nWBn3da1SYsD4APTgx9oSEkrqabvBVhKWrw' \
    -d '{"endpointCount":2,"controllerCount":null}'

Example response

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

{
  "id" : "ceccbe59-8b0d-49cf-b0e2-fcfe85b155e6",
  "endpointCount" : 2,
  "controllerCount" : 1,
  "networkId" : "3bbb1df0-4638-4751-8529-9f3047e06a63",
  "createdBy" : "8a3a3e57-a45c-4978-8be8-22f371a5fe99",
  "createdAt" : "2024-11-15T02:32:24.467468Z",
  "updatedAt" : "2024-11-15T02:32:24.505188Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits/ceccbe59-8b0d-49cf-b0e2-fcfe85b155e6"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3bbb1df0-4638-4751-8529-9f3047e06a63",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/5695008f-2759-40d9-916d-afd3b8f56d61",
      "title" : "Update NetworkLimit",
      "profile" : "meta"
    }
  }
}

Optional

Description

networkGroupId

String

true

name

String

true

route53ZoneId

String

true

domain

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/dns-zones' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJjeTFKYS1hSV9LRVVtYW5EaEtVbEJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQxYTE5NDk3LWM1ZTQtNGE2Mi05YzNiLTNhODhhMzMxZTZkZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzMSwiZXhwIjoxNzMxNjQxNTMxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjY1Y2Y3N2NhLTYwNzQtNDJkNi05Njc2LTkxYTRhN2M1MDQzN1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.judMe-ziXGUtnozWJKsmYgvyTektY4i9NQTkvSc2AqU7q1P0iAsP2hSS7w8jHDGVb_OTnuVFSF_CCVXZ5IoCWV_1OsMM8Vjdp2klMiIFBuqmuoqfcdV-H9qn0xeBVTCQr57k20K8VlesCSsMwiIRsnqklfnGGfXKVqDDce8whVz7nJOQJhkvSxjXJ10v8GvjkxCbuIS9mwQgDaRJ2f63QiAOaJHg3aKyXE3GjA9Cxu1o7Rnr42hmf-mSDt9ez0_ppcLYtuSK1E2ZO6PUvCp9EpLtwjRxHokbN3r698FLNEgA6fD4tlFlDFcr2naKj88BYLeGZHreWv08f8vCLIUxJQ' \
    -d '{"networkGroupId":"aa7105d1-eda7-443f-b0b5-bc5af2a75a52","name":"testName-506","route53ZoneId":"zoneId","domain":null}'

Example response

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

{
  "id" : "8d3e0d88-563c-4a94-90ea-d8d7d4be4109",
  "networkGroupId" : "aa7105d1-eda7-443f-b0b5-bc5af2a75a52",
  "name" : "testName-506",
  "route53ZoneId" : "zoneId",
  "domain" : "domainResult",
  "validated" : false,
  "createdBy" : "41a19497-c5e4-4a62-9c3b-3a88a331e6de",
  "createdAt" : "2024-11-15T02:32:11.216178Z",
  "updatedAt" : "2024-11-15T02:32:11.216178Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/aa7105d1-eda7-443f-b0b5-bc5af2a75a52",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/8d3e0d88-563c-4a94-90ea-d8d7d4be4109",
      "title" : "testName-506"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/dns-zones/4307c62f-d0a4-4410-aaa0-2a63a48563e4' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJjVUlLQ3RvRjY4OGVTdFNCM2hYNjNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE3MWVkYjMwLTViMjMtNDhkNS1iNTgwLWRjZWQzOWViZjc2ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzMSwiZXhwIjoxNzMxNjQxNTMxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ4M2Q4YzhlLTc3ZTAtNDhhZi1hZjRjLWFjNzI3MTM3MzBhNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.lcqYnII5Eb_oM_dhX0dbr0xiNvcDXNV7ixtaXTXTtOBCuy3NYdSOznx_5_HSVlr0bdOolw8dDMlZ20hVuKzkBQTg95OgQmpP-pI_k3-e9MThW6eGjiDJZrtu6WCzI1WYZuQlsdUZb-yrsUpP26HoN1uHRHOMhZhAVYGGWPwG_pa_QOI8V-yBnDywJGz2Py8z_oBIIRIymA8VdLt8SPLTOq1b41hlVWZpYqFKJ3jTeZqscN5OQQ7_e5g65XiC_3zWhZb42MImW6Mo6uPAmqsmuLTMgaEY9wY_64w9WGitrMyjKL3rTSO6iq7Tlnqgl2f_RaZeFzH--SAsSVMBavWp0A'

Example response

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

{
  "id" : "4307c62f-d0a4-4410-aaa0-2a63a48563e4",
  "networkGroupId" : "bc37ff70-9780-4e6b-b2cc-46ee8a78b8bb",
  "name" : "toDelete",
  "route53ZoneId" : "zoneId-527",
  "domain" : "domain.io.",
  "validated" : false,
  "createdBy" : "5122a2ef-0233-481c-b8e2-e61e8eccf465",
  "createdAt" : "2024-11-15T02:32:11.484261Z",
  "updatedAt" : "2024-11-15T02:32:11.514853Z",
  "deletedAt" : "2024-11-15T02:32:11.514Z",
  "deletedBy" : "a71edb30-5b23-48d5-b580-dced39ebf76d",
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/bc37ff70-9780-4e6b-b2cc-46ee8a78b8bb",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/4307c62f-d0a4-4410-aaa0-2a63a48563e4",
      "title" : "toDelete"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/dns-zones/2479b536-af1a-4f60-953b-f6c902a95e3c' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJGVXZrREtLSVZ5WFRKZTN0NWc2UmF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhhNmQ1ZjQxLTRmYWEtNDM0Yi05MWVmLTAyYzk3NjcwZDc0MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzMCwiZXhwIjoxNzMxNjQxNTMwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhiYTc2ZWYwLTNhZTQtNDE5OS1iZmQ1LThmNTRhNjk3NDg3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzMH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.n0bH3fZTu_1zs7Z1nUZPX25Pg_AVbQv3jf2_rtUNQ_nB2UD_9jGdmzVHt53UguUb8B74Pa1u3RpFt9Mq-aESigFoLNWPwOZVQoN6U3rVREWsneGr3fxWP_KJpCe_9Ca3Kvwx8PwvVJ5KTXo-zO77Zba_BYqj-UJDJg0NkxYBMpyEk3qsUr3W9NPTuagAqNxGRDqS7sTYYmlEP1MpvvGn_5vIincigBdjM4-zN0m1CO2QIJIzXqK9OM56RneBez9r7LND24i8McFlQvZiXaagdKctQ_p1KFL6XXfEpgwpIRV3qX6PoNLuhHBZ8jKA5szyhDDEY1UWayal4NogqbUnUg'

Example response

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

{
  "id" : "2479b536-af1a-4f60-953b-f6c902a95e3c",
  "networkGroupId" : "aed5c101-d91b-470e-9640-71b2e816e3d5",
  "name" : "test-v3-domain.com",
  "route53ZoneId" : "zoneId-491",
  "domain" : "domain.io.",
  "validated" : false,
  "createdBy" : "2c5d7bbf-5ec6-43fe-b322-c9a0f988d1d7",
  "createdAt" : "2024-11-15T02:32:10.994087Z",
  "updatedAt" : "2024-11-15T02:32:10.994087Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/aed5c101-d91b-470e-9640-71b2e816e3d5",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/2479b536-af1a-4f60-953b-f6c902a95e3c",
      "title" : "test-v3-domain.com"
    }
  }
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkGroupId

String

true

name

String

true

route53ZoneId

String

true

domain

String

true

validated

Boolean

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedAt

String

true

deletedBy

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/dns-zones' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJIdXloN0cwTkF3VDZ6M09CNWlMZzBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU4NDZiMzRhLTY5NDktNDM1OS1iZDg2LWZiYzkzNzFhOTYyMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzMSwiZXhwIjoxNzMxNjQxNTMxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA0ZWQ3YmE3LWJlMGMtNGJiNi05NWNhLTA5NDMxNmI2ZjQzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.NNw0Zga2yFSvndesyJ0Ew43h134DGLbZaaK_3uO99xLNQzjukPme_auL-FVsS9-P2f1kPPnjtcPozQ2T0z98MKQPHR9Oy2uGQz2hYxEncTnjrOmTsAnQ4XGHurWb6zvattkhE42mq4dPJ-Mvj11hfGw5A0-VB78_lEJ-aWr7jDgexKnhBZ5sClWcAsyYmqhSrrYJrL1HeoaCvLz3rBq9Ln_h-mNFEklrrJoAWcGq0OfdzdTd_ONs3U75KRrGXuex6MI320_3Z-k6ceAe1uhav1hX9W-L6TUGRGMFJLsKf_CmDeJmn2uNuyl8N1ysqBSqqDf5xVZ13v3Y-qxHjKlt6A'

Example response

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

{
  "_embedded" : {
    "dnsZoneList" : [ {
      "id" : "14ad6c6f-a726-47d5-9264-5aa5e89f6d2f",
      "networkGroupId" : "1a9bf4ae-b1a3-484f-aa0b-a2a0c52fd090",
      "name" : "toUpdate-513",
      "route53ZoneId" : "zoneId-514",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "328d242d-ca8c-46dd-8906-20dfa93cc22a",
      "createdAt" : "2024-11-15T02:32:11.269694Z",
      "updatedAt" : "2024-11-15T02:32:11.269694Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/1a9bf4ae-b1a3-484f-aa0b-a2a0c52fd090",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/14ad6c6f-a726-47d5-9264-5aa5e89f6d2f",
          "title" : "toUpdate-513"
        }
      }
    }, {
      "id" : "19bdac2a-9518-4323-9648-4c59ba108272",
      "networkGroupId" : "409ee0fd-24ad-4f1a-9294-61878b2ac020",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-485",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "a77ad214-ee3f-4245-8983-5b8478061e1a",
      "createdAt" : "2024-11-15T02:32:10.822451Z",
      "updatedAt" : "2024-11-15T02:32:10.822451Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/409ee0fd-24ad-4f1a-9294-61878b2ac020",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/19bdac2a-9518-4323-9648-4c59ba108272",
          "title" : "test-v3-domain.com"
        }
      }
    }, {
      "id" : "2479b536-af1a-4f60-953b-f6c902a95e3c",
      "networkGroupId" : "aed5c101-d91b-470e-9640-71b2e816e3d5",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-491",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "2c5d7bbf-5ec6-43fe-b322-c9a0f988d1d7",
      "createdAt" : "2024-11-15T02:32:10.994087Z",
      "updatedAt" : "2024-11-15T02:32:10.994087Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/aed5c101-d91b-470e-9640-71b2e816e3d5",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/2479b536-af1a-4f60-953b-f6c902a95e3c",
          "title" : "test-v3-domain.com"
        }
      }
    }, {
      "id" : "335ccba6-c102-4952-bc25-cef164dc37d8",
      "networkGroupId" : "29217b48-8098-485f-9981-7f0145d26a3c",
      "name" : "updated-501",
      "route53ZoneId" : "zoneId-500",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "f0374cc8-2b4a-4314-9c2e-02f0ca8660c3",
      "createdAt" : "2024-11-15T02:32:11.105666Z",
      "updatedAt" : "2024-11-15T02:32:11.119094Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/29217b48-8098-485f-9981-7f0145d26a3c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/335ccba6-c102-4952-bc25-cef164dc37d8",
          "title" : "updated-501"
        }
      }
    }, {
      "id" : "40a72e0e-1b07-402f-b14c-ab00e6c30a8e",
      "networkGroupId" : "1a9bf4ae-b1a3-484f-aa0b-a2a0c52fd090",
      "name" : "firstName-511",
      "route53ZoneId" : "zoneId-512",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "f8ff83a6-4871-45e1-a1cb-1e8e27da5e42",
      "createdAt" : "2024-11-15T02:32:11.267613Z",
      "updatedAt" : "2024-11-15T02:32:11.267613Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/1a9bf4ae-b1a3-484f-aa0b-a2a0c52fd090",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/40a72e0e-1b07-402f-b14c-ab00e6c30a8e",
          "title" : "firstName-511"
        }
      }
    }, {
      "id" : "48bcf876-303e-4ba4-979f-b9c6d2f12c9c",
      "networkGroupId" : "aa7105d1-eda7-443f-b0b5-bc5af2a75a52",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-505",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "e1073112-1fd9-4f90-81df-e34252f503f6",
      "createdAt" : "2024-11-15T02:32:11.169663Z",
      "updatedAt" : "2024-11-15T02:32:11.169663Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/aa7105d1-eda7-443f-b0b5-bc5af2a75a52",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/48bcf876-303e-4ba4-979f-b9c6d2f12c9c",
          "title" : "test-v3-domain.com"
        }
      }
    }, {
      "id" : "52ba4a4b-38cf-4cc7-aa92-ad370f4df197",
      "networkGroupId" : "72ecfaf7-6ecf-43db-a4a1-05b38a6fdb26",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-518",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "fbba6c88-ad0c-47a2-8f13-504f6db755dd",
      "createdAt" : "2024-11-15T02:32:11.302192Z",
      "updatedAt" : "2024-11-15T02:32:11.302192Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/72ecfaf7-6ecf-43db-a4a1-05b38a6fdb26",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/52ba4a4b-38cf-4cc7-aa92-ad370f4df197",
          "title" : "test-v3-domain.com"
        }
      }
    }, {
      "id" : "5538e695-3fae-4b0f-883c-d0743f86d115",
      "networkGroupId" : "1a9bf4ae-b1a3-484f-aa0b-a2a0c52fd090",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-510",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "48dc37c2-3664-40a3-9217-d29c2675b5cc",
      "createdAt" : "2024-11-15T02:32:11.266328Z",
      "updatedAt" : "2024-11-15T02:32:11.266328Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/1a9bf4ae-b1a3-484f-aa0b-a2a0c52fd090",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/5538e695-3fae-4b0f-883c-d0743f86d115",
          "title" : "test-v3-domain.com"
        }
      }
    }, {
      "id" : "74865066-ec6a-42a0-8da0-03d42fd8c6a4",
      "networkGroupId" : "409ee0fd-24ad-4f1a-9294-61878b2ac020",
      "name" : "updated-487",
      "route53ZoneId" : "zoneId-486",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "ce6c0cff-bb77-4149-83a8-94845ed5bfcc",
      "createdAt" : "2024-11-15T02:32:10.825013Z",
      "updatedAt" : "2024-11-15T02:32:10.874144Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/409ee0fd-24ad-4f1a-9294-61878b2ac020",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/74865066-ec6a-42a0-8da0-03d42fd8c6a4",
          "title" : "updated-487"
        }
      }
    }, {
      "id" : "823c30cf-fc56-400f-a896-1830a413fd50",
      "networkGroupId" : "29217b48-8098-485f-9981-7f0145d26a3c",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-499",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "5700addb-0523-4a42-a516-66956de1318a",
      "createdAt" : "2024-11-15T02:32:11.104553Z",
      "updatedAt" : "2024-11-15T02:32:11.104553Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/29217b48-8098-485f-9981-7f0145d26a3c",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/823c30cf-fc56-400f-a896-1830a413fd50",
          "title" : "test-v3-domain.com"
        }
      }
    }, {
      "id" : "8d3e0d88-563c-4a94-90ea-d8d7d4be4109",
      "networkGroupId" : "aa7105d1-eda7-443f-b0b5-bc5af2a75a52",
      "name" : "testName-506",
      "route53ZoneId" : "zoneId",
      "domain" : "domainResult",
      "validated" : false,
      "createdBy" : "41a19497-c5e4-4a62-9c3b-3a88a331e6de",
      "createdAt" : "2024-11-15T02:32:11.216178Z",
      "updatedAt" : "2024-11-15T02:32:11.216178Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/aa7105d1-eda7-443f-b0b5-bc5af2a75a52",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/8d3e0d88-563c-4a94-90ea-d8d7d4be4109",
          "title" : "testName-506"
        }
      }
    }, {
      "id" : "a4d72bed-cf46-45cb-ab2c-6d368538c3d6",
      "networkGroupId" : "7f5eb788-59df-4e2e-ba96-61931300a03f",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-495",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "3b212884-11b7-4587-8897-9a57a5736095",
      "createdAt" : "2024-11-15T02:32:11.067108Z",
      "updatedAt" : "2024-11-15T02:32:11.067108Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/7f5eb788-59df-4e2e-ba96-61931300a03f",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/a4d72bed-cf46-45cb-ab2c-6d368538c3d6",
          "title" : "test-v3-domain.com"
        }
      }
    }, {
      "id" : "bd661c98-3fa1-42ee-8126-5a8d2bc6d4cc",
      "networkGroupId" : "d5ab97d0-0e10-49ec-a1e1-a9c1ca1decf7",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-522",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "9ed0c1ab-3959-4e0d-8ee1-42b69f66e02e",
      "createdAt" : "2024-11-15T02:32:11.399410Z",
      "updatedAt" : "2024-11-15T02:32:11.399410Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/d5ab97d0-0e10-49ec-a1e1-a9c1ca1decf7",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/bd661c98-3fa1-42ee-8126-5a8d2bc6d4cc",
          "title" : "test-v3-domain.com"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 13,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/dns-zones/335ccba6-c102-4952-bc25-cef164dc37d8' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJUSk1WZFd1ZllOVDZNUkZBenpOU1FnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImExYzlhNDFlLTE0OWYtNGJiNi04OTk3LThiZTBjZDdlY2MxNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzMSwiZXhwIjoxNzMxNjQxNTMxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjIyNGZhMWJiLTkzOWEtNDkzNC04NmI3LWI1NjRhNDk5ZDg5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.IVTXq1agzl8MyWptuNCZ8NCGh2zgGSIzrfUOMDmfvfFiMOJ-sCo6lrhLfupyRS6zqGuYSWIG6Mw0cSKq9-CQFFpnkJh87R8w0VPFDYT0bl5XXZRWHGtoIhSLokynU3uASSE_PVzUPlj-ozDUS21GVpwUReuihKVSQfDptYnzdNC_cUy4i_VffQd-yb_kXVg9caNAKrRuKQv1oJh7K1sP_jbxf3CSZmwCEB9KXMgbojOeGeWf45lA3rdFrKMqQpERhEhOn7hanJOcC1NPgHilzbGkpEX5S03XCGEAl8zfkVi8w9YJuVIzJAcHgrwhvm1vZJBkfm2xbOUT0tkTFbHXAA' \
    -d '{"name":"updated-501"}'

Example response

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

{
  "id" : "335ccba6-c102-4952-bc25-cef164dc37d8",
  "networkGroupId" : "29217b48-8098-485f-9981-7f0145d26a3c",
  "name" : "updated-501",
  "route53ZoneId" : "zoneId-500",
  "domain" : "domain.io.",
  "validated" : false,
  "createdBy" : "f0374cc8-2b4a-4314-9c2e-02f0ca8660c3",
  "createdAt" : "2024-11-15T02:32:11.105666Z",
  "updatedAt" : "2024-11-15T02:32:11.119094Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/29217b48-8098-485f-9981-7f0145d26a3c",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/335ccba6-c102-4952-bc25-cef164dc37d8",
      "title" : "updated-501"
    }
  }
}

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/dns-zones/74865066-ec6a-42a0-8da0-03d42fd8c6a4' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ5empaMGhQVERSUTgyYm1ubFZ1Nnd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdkYzE0MDJhLTBjM2YtNGIyNy05ZjExLTExYmMwOGE1Zjg2NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzMCwiZXhwIjoxNzMxNjQxNTMwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjUzODZmODE4LWIwNWYtNDJjNS1iOGI1LTJmN2M3YTk4MDVmYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzMH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.cgarRiG2XI0jsJx8pBvvug5I1_Du_r09Zn4gwF8oSQU884lPGMv6lIkELrYdKc0l3bdgk2wDTmZm84ij04h3GbEsWmp_kz7exFrahar9IqmLaNcmizIGPxllenA-VWfECgfLWu4wCOyYje1TWG8iMGAmea3bEMLmpxf4dHmbZr_5pDdF1f9qt2K35lXUUT9UNSRZ8fkDeL8KPsRuvfluViFlZ_JnD8_z-8AvcyCnSfUNUOngnrgV2af-DxJXT2LqiedZgetapTUC6g1XH90gZjnW2Pu1vHb5ex0r3aFBO3B-iAdUmt87ZSBUfQXXxkCR7rKXTffJ14am8lSRwUgNjg' \
    -d '{"name":"updated-487"}'

Example response

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

{
  "id" : "74865066-ec6a-42a0-8da0-03d42fd8c6a4",
  "networkGroupId" : "409ee0fd-24ad-4f1a-9294-61878b2ac020",
  "name" : "updated-487",
  "route53ZoneId" : "zoneId-486",
  "domain" : "domain.io.",
  "validated" : false,
  "createdBy" : "ce6c0cff-bb77-4149-83a8-94845ed5bfcc",
  "createdAt" : "2024-11-15T02:32:10.825013Z",
  "updatedAt" : "2024-11-15T02:32:10.874144Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/409ee0fd-24ad-4f1a-9294-61878b2ac020",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/74865066-ec6a-42a0-8da0-03d42fd8c6a4",
      "title" : "updated-487"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v3/dns-zones/9f1d5e07-3f74-438a-80d9-8017556acd67/validate' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJETkNFZUx2bm5aS1lZQmt5Uks1R093IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg3YThjYzgxLTUxMTAtNGNmMS05NjI0LWVjZWI5Y2QwY2VjMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkzMSwiZXhwIjoxNzMxNjQxNTMxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjYxMThlMWZjLTVkMjEtNDQ2Yy1iNzllLTc1YzVmYzNlOWU0MVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkzMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Jo8ltjiLDukpZBGcyfhEs93TTyCaBtgT12K6fsj-Bo8KPl-TIMp-8rRslUBOYD79ddxl5Y_Yn5AXrma682ghz0uYwQvBkKM3tk9eqbOxKUpoQmQ8-Sg25W1NbqnQ_hsIX3q40Awr9UWmNi9W37MC92kAI3vpPBZl3MpxyQtbnMhANixNDTa9rXu0bicf0dz-8SDa53-BV8yyCF7LHbvDNPcuSeuqDjujT8HgzKkMl3gP8e79bpqyLBHYc1bBrH1FWC5TzjEt6i9930RLCkCJKKq15WwGpTAyePKBkNvGmPMoVtRE9-f9c4ZOuMHytZA1LPKngdzhR2suEWjH6J8w-A'

Example response

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

{
  "valid" : false,
  "failureMessage" : "No public txt record found"
}

Optional

Description

networkId

String

true

domainNameLabel

String

true

edgeRouterProvider

String

true

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

edgeRouterRegion

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzers' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJWbEZyOTQxUmlYNkxBZnAxX2xzTjBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRiNTFkNWNiLWUxYjgtNGZhOC05MTc0LTg2NTkzMTRmMDZjYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA1MywiZXhwIjoxNzMxNjQxNjUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ3MzlhOGZhLTFkY2EtNDdjNC1hYzkyLWUxNTJmNDdmYmEyYVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA1M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.K5yL4BgX6ehmmsOvNOJT1zANKczbiU-3d_wmmpTu2eaGAZ7m-Q1QDNuLVGL1GCJoc_Lfjz949Gecde7oaWtsb779rYBjjsHvEY4jMvG9j5UoCfLXp8FuOtMb866dMUKnWHjkoqB9JVuTr2RmSDkqKATsyEM3OCFLYFzu2vwAJBOviBo30KKKwHPMiNNLzIP8e3nxCRq3SOOGlOJYE6UjlBIy4USFmKB7_G9qrDY5RL5ZpV-flyZknN7vXPNX-7kR3OcobjIjRtbE4NL4H4Ilyi7fs4hSZewy5N_ch87i_5Dw_Q1hOolm8FVWdIAfIVgmtZv_C98jWVamaSRyXSDkHg' \
    -d '{"networkId":"31201bc9-0103-4017-9b6d-a37cc97b6c8c","domainNameLabel":"tugrpryc","edgeRouterProvider":"AWS","edgeRouterRegion":"us-east-1"}'

Example response

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

{
  "id" : "04f24a0f-7ed8-40c7-8816-9b454e563607",
  "networkId" : "31201bc9-0103-4017-9b6d-a37cc97b6c8c",
  "domainNameLabel" : "tugrpryc",
  "createdBy" : "db51d5cb-e1b8-4fa8-9174-8659314f06ca",
  "createdAt" : "2024-11-15T02:34:13.272414Z",
  "updatedAt" : "2024-11-15T02:34:13.272414Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "wssListener" : false,
  "publicCertEnabled" : false,
  "bootstrapper" : false,
  "executionId" : null,
  "status" : "ERROR",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzers/04f24a0f-7ed8-40c7-8816-9b454e563607"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/31201bc9-0103-4017-9b6d-a37cc97b6c8c",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=31201bc9-0103-4017-9b6d-a37cc97b6c8c&wssListener=true"
    },
    "browzer-bootstrappers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers?networkId=31201bc9-0103-4017-9b6d-a37cc97b6c8c"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=31201bc9-0103-4017-9b6d-a37cc97b6c8c"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzers/ab57029a-d86e-4c94-ad0e-281d65a04e27' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJma3pyREMxS1lDaE1KV0VaVERNWFFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcyM2I0NGI4LWQ3ZWUtNGJhMC04ZGYwLTU0NWU2ZTdlYjQzNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA1MywiZXhwIjoxNzMxNjQxNjUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA2ZmRkZDE1LTAxYTktNGUzOC1iYzMxLWRhOTM5NTcyYTQ2N1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA1M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.iO5aWSB3z24-2bwj9bQclxsqo8BpITK0QyduXpmDCBAsQ34sF_3l2p5UWkBaVBGkRz4ZcpFpVuuL7gM4DY3Ap1nequlS0N_6bszIECwLK0U2gVCXhelNyDDzBqtUyzbVxgNAH3TgU8T57AOQgJfg0cUPnpq9--63o7mpZzTT9U2H11TpN5D13TzWDu_xd9XipzvfwPB72yQNpBuHn_-5Woy0oR5mtcC6K9BJ5HB17SmEM94F448Madb1cFsFSLkK5h9qLMuk2pctkingA0dZ3dODRvTyj51fC-rYE0V4I_StQP_i85SfV4nNDrjlrLSehgiB0YdBqorfCwdzVKru9Q'

Example response

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

{
  "id" : "ab57029a-d86e-4c94-ad0e-281d65a04e27",
  "networkId" : "a1654b70-945a-4ca5-9106-8bdde1c31e45",
  "domainNameLabel" : "-aZ-90-Z",
  "createdBy" : "22f90e7e-3cb1-4c10-88af-2b8ca011edf0",
  "createdAt" : "2024-11-15T02:34:13.571680Z",
  "updatedAt" : "2024-11-15T02:34:13.571680Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "wssListener" : false,
  "publicCertEnabled" : true,
  "bootstrapper" : false,
  "executionId" : null,
  "status" : "ERROR",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzers/ab57029a-d86e-4c94-ad0e-281d65a04e27"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a1654b70-945a-4ca5-9106-8bdde1c31e45",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=a1654b70-945a-4ca5-9106-8bdde1c31e45&wssListener=true"
    },
    "browzer-bootstrappers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers?networkId=a1654b70-945a-4ca5-9106-8bdde1c31e45"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=a1654b70-945a-4ca5-9106-8bdde1c31e45"
    }
  }
}

Find Browzer

GET /v2/browzers

Authorization

This endpoint requires the following actions:

read action on the browzer resource type
read action on the browzer resource type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

domainNameLabel

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedAt

String

true

deletedBy

String

true

wssListener

Boolean

true

publicCertEnabled

Boolean

true

bootstrapper

Boolean

true

executionId

String

true

status

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzers' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJUblhCZTduTWstNUx0OG9pSG9TbHpnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJhMWJkNmYyLTAzZDYtNGE1MS1hZmU5LWFhMDcyYWM0MDU1MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkyNSwiZXhwIjoxNzMxNjQxNTI1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjRkMmVjZDUzLWI2NGQtNDhmZi04NDUzLTBjNzY4MTVlNDNmMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkyNX0se1wiaWRcIjpcImRmYzc1NmI4LTljNzctNGEwNi05NzUzLTc2MTE0MWIyNzZhYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkyNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.DCEdn2dC_1XyzNCxIv7y4eHeFRaOq8sfJa1HYbK360b1atBL3HeoC1_dzp9PEXClrd7stYOE3YSOb3muhyl_GSR7ssSS4M705QBxDMyr6a97G-q4i7wOAqmXkzVrYitz23Vl0oyTPvGota0tKXMFB76_rY5gflVs00ZrvivqERbC-zBiAOj1g4_Ngw2TLwy__nw_WYXuE4wKFHzl-qk0nzsm9OhI-iSz5v37P8LjDsYvkGxoqBj1JC2uijIhZgzqfaEkF3r1OMoDebuZ9Mxms0eoS1yu8PLzZKdUnYv9UoSExt0Bu1INlBaxtrbOsOqPPKpWMNwqD-_0CAwhNHkKIQ'

Example response

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

{
  "_embedded" : {
    "browzerList" : [ {
      "id" : "2c867be5-a24f-4e64-99d2-8f57e7c98b90",
      "networkId" : "cce8c658-10b8-4f3a-93a2-87eb737dfa72",
      "domainNameLabel" : "-zZ-9--a",
      "createdBy" : "52808cb5-e428-4343-a34b-210aed4baf24",
      "createdAt" : "2024-11-15T02:32:05.590073Z",
      "updatedAt" : "2024-11-15T02:32:05.590073Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "wssListener" : false,
      "publicCertEnabled" : false,
      "bootstrapper" : false,
      "executionId" : null,
      "status" : "ERROR",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/cce8c658-10b8-4f3a-93a2-87eb737dfa72",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzers/2c867be5-a24f-4e64-99d2-8f57e7c98b90"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=cce8c658-10b8-4f3a-93a2-87eb737dfa72&wssListener=true"
        },
        "browzer-bootstrappers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers?networkId=cce8c658-10b8-4f3a-93a2-87eb737dfa72"
        },
        "browzer-apps" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=cce8c658-10b8-4f3a-93a2-87eb737dfa72"
        }
      }
    }, {
      "id" : "bda5d808-e67e-4335-8170-60f56ba8a8ee",
      "networkId" : "764f382f-b3cd-4e3c-aab7-9b8f913f2e8e",
      "domainNameLabel" : "aaZzz-aa",
      "createdBy" : "eac1991b-61b5-4ae6-a9ac-489b45ddf8e3",
      "createdAt" : "2024-11-15T02:32:05.588258Z",
      "updatedAt" : "2024-11-15T02:32:05.588258Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "wssListener" : false,
      "publicCertEnabled" : false,
      "bootstrapper" : false,
      "executionId" : null,
      "status" : "ERROR",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/764f382f-b3cd-4e3c-aab7-9b8f913f2e8e",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzers/bda5d808-e67e-4335-8170-60f56ba8a8ee"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=764f382f-b3cd-4e3c-aab7-9b8f913f2e8e&wssListener=true"
        },
        "browzer-bootstrappers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers?networkId=764f382f-b3cd-4e3c-aab7-9b8f913f2e8e"
        },
        "browzer-apps" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=764f382f-b3cd-4e3c-aab7-9b8f913f2e8e"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

edgeRouterProvider

String

true

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

edgeRouterRegion

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzers/a37ea635-aaed-42be-8e7d-7d2b69f88d2d' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI3WlllaFhwNnBST0tUeXh3Z2RjSm5RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMzMDgwYWQ3LWJkMTgtNDRmZC1hYzViLTIyZmM5YjM0NGQyOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA1MywiZXhwIjoxNzMxNjQxNjUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjExOTdlNzgwLTk1ZDItNGMwYy1hMDE0LWJjOTQ4MjJiMTg5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA1M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.dG3wpiwphXVCr_NDUhTFHdvFiQrBuq8YDSViKwI0ar_zHfd7ymU37W1npalgUeaE4y-nmqu4RuPf0MnqSggVs5TGOVl-LsFMi39iCVd8NWYFagSPj3BxENpl_xPSGqJccYlCn_oPn81LuQ1bAh50-VPPn7-3NyfT21DxDmp4lVIxYgK_PeFo0qFqhJCIvflQmr_EBErC0KuWnLxFlhlw-s3MuJeIhIM7EWEf_s9Fj9r6sEtYsPtdVEL4z_WnWsTFOLSLg7YGRP0-BwxAMCGfK9x7vMAQia5s_N48i_TQ1qdKF7GdjKiv26Fr87NYt5ubUvTzcCuyhYr18oCwiqW1-Q' \
    -d '{"edgeRouterProvider":"AWS","edgeRouterRegion":"us-east-1"}'

Example response

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

{
  "id" : "a37ea635-aaed-42be-8e7d-7d2b69f88d2d",
  "networkId" : "db227793-8e35-46e4-9355-a873cdf668d9",
  "domainNameLabel" : "9-aa00--",
  "createdBy" : "b7a6a65c-0389-4713-9b2d-3b63eb8ffc1f",
  "createdAt" : "2024-11-15T02:34:13.609555Z",
  "updatedAt" : "2024-11-15T02:34:13.609555Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "wssListener" : false,
  "publicCertEnabled" : true,
  "bootstrapper" : true,
  "executionId" : null,
  "status" : "ERROR",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzers/a37ea635-aaed-42be-8e7d-7d2b69f88d2d"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/db227793-8e35-46e4-9355-a873cdf668d9",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=db227793-8e35-46e4-9355-a873cdf668d9&wssListener=true"
    },
    "browzer-bootstrappers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers?networkId=db227793-8e35-46e4-9355-a873cdf668d9"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=db227793-8e35-46e4-9355-a873cdf668d9"
    }
  }
}

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

edgeRouterProvider

String

true

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

edgeRouterRegion

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzers/c575ba89-5854-4fbf-881f-c641648b6014' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJlLUpISXdrUVBDWE5kdHo1UHJ0OFZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFiOTA2ZGVmLWMzYjktNDdmZC05YTdiLTQyOTM1ZTRjYTFlMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODA1MywiZXhwIjoxNzMxNjQxNjUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU4ZGI2YmVjLTRhMzItNDU0MS04NmE4LTBjNTFlNDM5ZjA2OVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODA1M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.nkUX6vE44ryNSbhdB5Las_Tb5hkw4I-q1masCANo2oNtbOxLDXnGbdERsVog2Ye3iKR6z5I9qHq2L93UnVgp0gts2OV5uXeFm9-ZaurTSqyJ1EHMkeLSRyyo-7nUTu_WUJUnVCbudov9MdofcwVMqdP-gXDJjVr3BNCBl7wV52xr725_8cp-kiaSloRQXTrO3jEcR8JbAiHhxXOQ7zVgpHcgLztH093G-vweEsYMRU-9lwkqz4ezg1335qMPVELD83TXzdNSEruJ7mU1a3T7rnsDkijwkoc4EwW4T67xYOzck5FBQF-UFmTyM9hV6T7bCkAvprc8MqCDOP_A5aNyxw' \
    -d '{"edgeRouterProvider":"AWS","edgeRouterRegion":"us-east-1"}'

Example response

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

{
  "id" : "c575ba89-5854-4fbf-881f-c641648b6014",
  "networkId" : "e0ca75aa-ae21-4604-9a35-b3ed95c7ca17",
  "domainNameLabel" : "A-AZ--9-",
  "createdBy" : "44c556b4-6bbc-46a2-9fca-ad00229d606d",
  "createdAt" : "2024-11-15T02:34:13.497569Z",
  "updatedAt" : "2024-11-15T02:34:13.497569Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "wssListener" : false,
  "publicCertEnabled" : true,
  "bootstrapper" : false,
  "executionId" : null,
  "status" : "ERROR",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzers/c575ba89-5854-4fbf-881f-c641648b6014"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e0ca75aa-ae21-4604-9a35-b3ed95c7ca17",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=e0ca75aa-ae21-4604-9a35-b3ed95c7ca17&wssListener=true"
    },
    "browzer-bootstrappers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers?networkId=e0ca75aa-ae21-4604-9a35-b3ed95c7ca17"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=e0ca75aa-ae21-4604-9a35-b3ed95c7ca17"
    }
  }
}

Validate Update

PATCH /v2/browzers/{id}

Authorization

This endpoint requires the following actions:

create action on the browzer resource type
create action on the browzer resource type
create action on the browzer resource type
create action on the browzer resource type

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

edgeRouterProvider

String

true

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

edgeRouterRegion

String

true

Response fields

Path

Type

Optional

Description

[].path

String

true

[].label

String

true

[].message

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzers/aef57ad2-7a1e-4e1a-8fcb-38ac46ecd287' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'nf-validate: ' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiItNllYSnJHZVBZOERqM3Z0bFZXRTl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRlMTdhMmRjLTg0YTQtNDNiNi05YTI1LWI4NmYwMmIwMmQ2YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg1NCwiZXhwIjoxNzMxNjQxNDU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImMwMzA5MzY5LWQ4ZjItNGU4Ny1hNzJhLWJjOWY2NzM3ZjEwN1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg1NH0se1wiaWRcIjpcImIyNjE2ZjkzLWZiMzktNDE3OS04NTVmLWViYTNmZjM1ZWIwMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg1NH0se1wiaWRcIjpcIjA2MjZkNTI4LTIyYjQtNDcxMy1hMTc3LTI5YjNmMWNkNGMzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg1NH0se1wiaWRcIjpcIjIwZmVjOThkLTNkNjYtNDg4NC1hMDMwLWMwOTUzZDA5OWY0MlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg1NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.VldE648h_o7udxNs6Pid6pqOAaXByo4E862_EaCjEYQkMTgUrA0WZYH_e_2xKINcUShQxFGjLf3jd1zl2yBO6tRthE8sVgTCTF4vCFed8PGUC34y8sTyceqUtYUMEqLurpVt7v56QLgGaIkwkmkB6DBzc7vk2Qnef210oKLmRzabeenkMxLtcRV-4a6EiP3UOQNNHPc66g-buSqv_W-7xK-gUaKbk2-wqIQjJDMGujTqME4O5H6YS8g3N2AVKoorSIVDkivRpb3Bn56PfnDP697ctpcVerdFb6ycgfGOYx0vYU5RbYJ1XIj890N56AUCyol_XwVlrCAm4QjnNheB0w' \
    -d '{
    "edgeRouterProvider": "AWS",
    "edgeRouterRegion": null
}'

Example response

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

[ {
  "path" : "$.edgeRouterRegion",
  "label" : "edgeRouterRegion",
  "message" : "Region must not be empty."
} ]

Optional

Description

networkId

String

true

provider

String

true

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

region

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJSOFdZb0dGQ210VkMzaVUyMV9oZG9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI1MWE1MDVmLTQxM2UtNGI5MC04YjA3LTE0ZDJkYmMyNmMxNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAwMywiZXhwIjoxNzMxNjQxNjAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVjZjg5ZWNjLTkxNzItNDA3My1iZGU1LTg1MmVmYzQ3MzAyOFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.hm-MJk-dm22KfR2NBwpbtX2jC3hOHmzQGWLo16TxcZoyPjGYuS0c83OinY0Mird7-MCt9Ji5kAVbmVsffJAW1wfsoTmVEc_Mvn5YHKgNDRiBpmVV8cHiNIxU4X5Kun4Bx0ysKxW2v4EPgj6Kk6ztbG1vBVUY8zP7GVBuXJ3gFo6HeVGjX2ghZ6jNVjoOUKZp4v66QNLuK2Zq7UBZ0_Eq32oxVsirpeO0P216d3Apeqy8MsikbiVzfkBGccIUghNOm-xF3Yyg7Cy25Zdy5EHvgi96AXH0MQKZ_2gBHNIrVo5MksZVm1l-dShVZIpG9XkhD8Sln0nZmqEUSd3xwG0HOA' \
    -d '{"networkId":"fed8b078-e6d3-40ec-aaac-9f33e644fb96","provider":"AWS","region":"us-east-2"}'

Example response

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

{
  "id" : "cbaf2267-47e4-49e9-96a8-3fa8aa575893",
  "networkId" : "fed8b078-e6d3-40ec-aaac-9f33e644fb96",
  "createdBy" : "74c9fc40-d915-496b-911a-9a2437ac9444",
  "createdAt" : "2024-11-15T02:33:23.284368290Z",
  "updatedAt" : "2024-11-15T02:33:23.284368815Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "containerId" : "4965dd47-9190-460e-a926-73004726f47a",
  "status" : "PROVISIONING",
  "_links" : {
    "container" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/containers/4965dd47-9190-460e-a926-73004726f47a"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/cbaf2267-47e4-49e9-96a8-3fa8aa575893"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/fed8b078-e6d3-40ec-aaac-9f33e644fb96",
      "profile" : "parent"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=fed8b078-e6d3-40ec-aaac-9f33e644fb96"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/8760657d-8b29-4abc-b35e-5c5df3917904' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJJZ0Y2ZFkwa21JbkZuazFobnVHTi1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBhZTEyNjgzLTBiMWMtNGM3ZS04NDYwLWEwNjdlODU4ZmY5YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAwMywiZXhwIjoxNzMxNjQxNjAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJiMTg5OWM1LWI3YWYtNDBiMS05YTYzLTI0ZDFmMWQ2OWVkMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.pjUpIRb6aWvd24WZVijid6yY2pFf4L828x20HNcBdlJ6hlTlCKS3h7jvJssck2S7p522Wm5QbUoKb3Z8MEmwTJhqRegqkLYGYqdcbbED_zf4zCRqn_Ym2nOVHMh2F_9O15FjMOM-G--GOw-2czfvWgpC6jvqgL5WwIFUYeRjZ56HK1oMF1Z8BrDYfuR41y2haV2iMgRsZK5Fsd51Nq3C3fBoq1o8BfrAkeN5F3GUbFNtYoGglk-o40nF7DLkXr_EZvtAHj5U10wRpEFzPsgiULX8ytp-Q3kzykxK5eiRl5aF8BXWzfo7WJHEUceeclIqUVs8qFdMQFjaPsWjk2zE0g'

Example response

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

{
  "id" : "8760657d-8b29-4abc-b35e-5c5df3917904",
  "networkId" : "fed8b078-e6d3-40ec-aaac-9f33e644fb96",
  "createdBy" : "7d3c4344-c470-433a-824b-bb41cff038db",
  "createdAt" : "2024-11-15T02:33:22.989204Z",
  "updatedAt" : "2024-11-15T02:33:22.989588Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "containerId" : "e79abff8-b749-45fe-ba54-c2ea7e6b0f3a",
  "status" : "PROVISIONED",
  "_links" : {
    "container" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/containers/e79abff8-b749-45fe-ba54-c2ea7e6b0f3a"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/8760657d-8b29-4abc-b35e-5c5df3917904"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/fed8b078-e6d3-40ec-aaac-9f33e644fb96",
      "profile" : "parent"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=fed8b078-e6d3-40ec-aaac-9f33e644fb96"
    }
  }
}

Find Browzer Bootstrapper

GET /v2/browzer-bootstrappers

Authorization

This endpoint requires the following actions:

read action on the browzer-bootstrapper resource type
read action on the browzer-bootstrapper resource type

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

containerId

String

true

status

String

true

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

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfZW9TbloxdFVYdVdOakVLRnpBc2hBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk3MWZjM2QxLWZlMjEtNGY1YS05ZDY2LWM1MmU3ZGUyZTUyZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkxMywiZXhwIjoxNzMxNjQxNTEzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA3OGEwN2JkLTAyZmItNDcyYy1iNGE1LTUwNjBjZjUzZGQ4ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkxM30se1wiaWRcIjpcImU0YmFlYTk0LTJmZDQtNGJjNS1hODY0LTcwOTAyMzE5OGJmNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkxM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.IOuivJjp6u-hkVH2twNeXn4dpoCBbNOjQO6yz2618PLtVmiZm-Zbd2ipjxiMwqmtHS71y_OIgAW1Uz4ht2lWOVZjmzu1euF0aZ3SAmE28WrVnKXBf4z33owxI_KLwY0p6TUifHj0IRhVcKDHAx_cPKAsHasEES1ZIibgXYJRplHCeMwheA1VCV-ODZYPpuFHAtAyPiwFseJ6dtc4SiSF6dZnY3uCDG5bDynbm4dzh70mM4ewow1mL8cKL0urOyt8VMOKdxABMwdx_-p73kv34IZVO4W50ryITS8OxNEputmhl2GxpkGClEa1RVasTEpRkVIh6vvxN2yFctQFJxD8NA'

Example response

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

{
  "_embedded" : {
    "browzerBootstrapperList" : [ {
      "id" : "9c02121e-11a7-435d-8db6-8ef3213acf07",
      "networkId" : "5ac16c8f-d992-4fbe-aee1-5ed9edaf4f6c",
      "createdBy" : "aa2f5e66-60b7-4689-b57b-e8e9773773f8",
      "createdAt" : "2024-11-15T02:31:53.018349Z",
      "updatedAt" : "2024-11-15T02:31:53.018872Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "containerId" : "511079fd-ab50-4486-a860-293d024c36e7",
      "status" : "PROVISIONED",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5ac16c8f-d992-4fbe-aee1-5ed9edaf4f6c",
          "profile" : "parent"
        },
        "container" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/containers/511079fd-ab50-4486-a860-293d024c36e7"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/9c02121e-11a7-435d-8db6-8ef3213acf07"
        },
        "browzer-apps" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=5ac16c8f-d992-4fbe-aee1-5ed9edaf4f6c"
        }
      }
    }, {
      "id" : "e9f4433c-0ae1-485e-8687-85bc14bb59b5",
      "networkId" : "1eb04f62-0b02-4a02-8fc5-63c1c4467b7b",
      "createdBy" : "9312dcce-21b3-4479-8715-1dabcae01514",
      "createdAt" : "2024-11-15T02:31:53.013745Z",
      "updatedAt" : "2024-11-15T02:31:53.016383Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "containerId" : "6eaa40e4-81b5-4afa-b9df-fd6d13a875f4",
      "status" : "PROVISIONED",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1eb04f62-0b02-4a02-8fc5-63c1c4467b7b",
          "profile" : "parent"
        },
        "container" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/containers/6eaa40e4-81b5-4afa-b9df-fd6d13a875f4"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/e9f4433c-0ae1-485e-8687-85bc14bb59b5"
        },
        "browzer-apps" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=1eb04f62-0b02-4a02-8fc5-63c1c4467b7b"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Validate Create

POST /v2/browzer-bootstrappers

Authorization

This endpoint requires the following actions:

create action on the browzer-bootstrapper resource type
create action on the browzer-bootstrapper resource type
create action on the browzer-bootstrapper resource type
create action on the browzer-bootstrapper resource type

Optional

Description

networkId

String

true

provider

String

true

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

region

String

true

Response fields

Path

Type

Optional

Description

[].path

String

true

[].label

String

true

[].message

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'nf-validate: ' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJOR1RNTG4tUGxBRlp6bWpiT1FuNVJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNkMGVkMWRlLTYzZWItNDVkNi04ZDRjLTY4MDRmYjFmYTJhYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg0OCwiZXhwIjoxNzMxNjQxNDQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjIzMWMzYTlmLWUzMDMtNDA4MC1iNWFkLWY3OTBkN2RmYmQ0MlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg0OH0se1wiaWRcIjpcImI1ODc0OWMyLTk3YWEtNDFhMS04NGI2LWRlMTJlNDNhNGU2OFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg0OH0se1wiaWRcIjpcImYwNzU2MzhmLWY5ZDctNGNhMS1hNjQ4LWE0YmMxYWQwMDE0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg0OH0se1wiaWRcIjpcIjcxNGIwNDAxLTZiZTgtNDllNS1iZjYzLTk3YTZiM2Q0ZjZmMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg0OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.VceGlzWD8_8mFJ82V77V2p-9TK1BnvPpuJGzhilXELwupXHTxAnYnO2l0Ar1mbIz7n8nr-KnG_a1BPvEV19iyBEHV2H8HWzPn7lhGt-ATvoCzScR15j-raZEI2jiWNXNM3hnZHbtb60PVDUqIqQWtRRRh35IJEnp9yz3KrfGteaFgENNylSQh1wMCTnMLycRFlLHBqQULrpFl4t9Mx45clYUcCX-eMrKb7ZvPLFVkHuWuuFAHLeRWMQMcXkjn2VKwhADn71EMn5XkYIynBe0ORGNB3HkSY6lBzt2E_x_gGWu-Td5haHZSJu-zxHnAff_USd3dZspSTP0m4ynoSH1Bg' \
    -d '{
    "provider": "AWS",
    "networkId": "aa7d66b9-4c58-43ed-9d6c-62eb1a7ba272",
    "region": "us-east-1"
}'

Example response

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

[ {
  "path" : "$.region",
  "label" : "region",
  "message" : "The network already has a BrowZer Bootstrapper in the same region, only 1 allowed."
} ]

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/8760657d-8b29-4abc-b35e-5c5df3917904' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJSTDd0d0xKUUNsYlNlOS1WUnVVZE13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYyMzlmN2EwLTcxZjctNDU5ZS05NWI0LTNlMmZmNDZmYTRlMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzODAwMywiZXhwIjoxNzMxNjQxNjAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM4OTRkNjY1LWNiZTEtNDUzNy05M2VkLTJmNjA5MjExMTYzMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzODAwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.nM_oBaJ3-_Bs68ZEbQjvv_cBJyU0Uq8dNKXVMwZwsY8wVNwhqI8tx0fjknTPvaFrFHg9wRJlfS1FrGLGN5RAQW_Gq__dKnhU0IVWKQ4cfaDB9KI3Dh8PuhEI_G7JHu0VqMZzjNBzVy-GfxcryTiPvHP1fvBrChotywtn6rw6ONLiRR2ldWyoGqYMhkHozVmtY7-uNhhjdJkHc7S1J6LDgY5GHmIbm3ACozkEuy82-RMvIikyj7mK3KY4LGvL-xWDNUzuJmFnByWAr3oLBAkTdsQL-x9uTaAkOOX7FiBsf_idoqD6X7UMj_0HEmUixWoVYu5CzCXuStdfUk0N4DelcA'

Example response

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

{
  "id" : "c02cc61e-0078-4d0f-bf4b-df2038815c33",
  "networkId" : "fed8b078-e6d3-40ec-aaac-9f33e644fb96",
  "createdBy" : "70e088f2-fb5f-4b79-8998-33f1e1094eb9",
  "createdAt" : "2024-11-15T02:33:23.215133371Z",
  "updatedAt" : "2024-11-15T02:33:23.215133552Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "containerId" : "37eaf295-f400-4b39-84b5-39848a1ec112",
  "status" : "PROVISIONING",
  "_links" : {
    "container" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/containers/37eaf295-f400-4b39-84b5-39848a1ec112"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/c02cc61e-0078-4d0f-bf4b-df2038815c33"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/fed8b078-e6d3-40ec-aaac-9f33e644fb96",
      "profile" : "parent"
    }
  }
}

create action on the browzer-app resource type
read action on the service resource type

Optional

Description

networkId

String

true

name

String

true

path

String

true

serviceId

String

true

Deprecated..

zitiServiceId

String

true

tunnelHttps

Boolean

true

access

Object

true

access.domainNameLabel

String

true

access.dnsZoneId

String

true

auth

Object

true

auth.type

String

true
true

auth.baseUrl

String

true

auth.clientId

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-apps' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJLNmFsR0tGTnJoREhWRy1kRXNKemNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNjZDVhYjY3LTAwYzMtNDJjYS1hNjc5LTNjYjlmNzdmNDlhNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk5NywiZXhwIjoxNzMxNjQxNTk3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjIxODI5ZmYyLThhZGMtNDk2MS04MDU1LWMwNzYxNTFlZGFlNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk5N30se1wiaWRcIjpcImVmNzE4NGE1LWQ0NzctNDVlMy1hMzU4LTQ5NmUxODIwYzM3NlwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk5N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.bZgzA9Tj-R-ndcuJYK6VAYBzt8xyWJRiyXkfTPQPVIw6JkYJx7phCEs6KnoeObv_oWfDyP6bIB5z7iGqW2YwsJ-ODiQSv27HzJ7I0iDC-8DnGoAoDMztIH8k9IStplRhZVYuDKQpy2TUf-hShBQCd-vLTr5ZJPm8ZWn-nF69iMOsSdPGPAg2cBAYXzYmRl7RAD4nFz9wcABF6qt3ZKDv1IlQVLSnZZrji8Ul97UfSCmaUkhtj_U3sOMuR22kOJgURE_8cuOedmn0r7jaWPSZBO8bdWP9Hg3esmW7tIaWDyyq5t3TrcEhxA81pBjLWeTsV2c2W1wAWZLp3JsuL_4gYw' \
    -d '{"networkId":"d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936","name":"Xr8sBUfY9gxQlVKS5LQiP","path":null,"serviceId":"e6216020-d7bf-4ee3-a2c9-f3b2d7a14df5","zitiServiceId":null,"tunnelHttps":false,"access":{"domainNameLabel":"test-02","dnsZoneId":null},"auth":{"baseUrl":"https://fake.com","clientId":"fake","type":"OIDC-Default"}}'

Example response

HTTP/1.1 202 Accepted
X-NF-deprecated-property: serviceId; removal 4/1/2023; see https://gateway.production.netfoundry.io/core/v2/docs/index.html
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1286

{
  "id" : "d79db8a4-c065-4651-aef5-2b7ac16e4499",
  "networkId" : "d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936",
  "name" : "Xr8sBUfY9gxQlVKS5LQiP",
  "path" : "/",
  "serviceId" : "e6216020-d7bf-4ee3-a2c9-f3b2d7a14df5",
  "zitiServiceId" : "ziti-id-2878",
  "tunnelHttps" : false,
  "access" : {
    "domainNameLabel" : "test-02",
    "dnsZoneId" : null,
    "fqdn" : null
  },
  "auth" : {
    "baseUrl" : "https://fake.com",
    "clientId" : "fake",
    "type" : "OIDC-Default"
  },
  "createdBy" : "ccd5ab67-00c3-42ca-a679-3cb9f77f49a4",
  "createdAt" : "2024-11-15T02:33:17.863697Z",
  "updatedAt" : "2024-11-15T02:33:17.863697Z",
  "versionDate" : "2024-11-15T02:33:17.863217Z",
  "appliedAt" : null,
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "status" : "NEW",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936",
      "profile" : "parent"
    },
    "service" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/e6216020-d7bf-4ee3-a2c9-f3b2d7a14df5"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/d79db8a4-c065-4651-aef5-2b7ac16e4499",
      "title" : "Xr8sBUfY9gxQlVKS5LQiP"
    }
  }
}

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-apps/230c4ac8-2659-43f8-a8f5-21675756a69c' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2bE5XRWN2QnVobXRuU25hMk1GdDlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ4MWNiOGU4LTMwMGYtNDUyZC1iMGQ1LTkzMmYzNjcyOTllNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk5NywiZXhwIjoxNzMxNjQxNTk3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImViYWYzZmUxLTdiY2YtNDA0NS1hNWQ3LWJlNTY3NTQ5NzUyYVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk5N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.L67mnziO_ruv8Z70gvnCTycXkm39JF99pAxYQoWfax9vfrjfKHbjnUrPLz1zQVH_23DvPeI5qhqn6fIpqiRLuka1V-0LdqxwGVTcmrBVSPE6GVvvmNBBlxFCYhcM1NpMDffNYFzUfTe1E64p1MFXc4nuHS6ZXWtcqyTSoNH6kZdDU9i46nWew-qUXIbGPKRR1O-mgEf1nfYFEirRVK0IG6RUl1ldm7EW3g-LUERjez7A7n6QQN1zpKWrbJHppFXBwDvoJ1yWag96kb4cXik2rSqMRDd0x1Mi3i7eeeDnIFmyfVkfHNhnadvobwl-EgJO6HaUqUvg_HkabVaE0356Fg'

Example response

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

{
  "id" : "230c4ac8-2659-43f8-a8f5-21675756a69c",
  "networkId" : "d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936",
  "name" : "browzer-app-2785",
  "path" : "/",
  "serviceId" : "5156857b-f769-495a-8a73-ea1c04a44d2e",
  "zitiServiceId" : "ziti-id-2780",
  "tunnelHttps" : true,
  "access" : {
    "domainNameLabel" : null,
    "dnsZoneId" : null,
    "fqdn" : null
  },
  "auth" : {
    "baseUrl" : "https://foo.bar",
    "clientId" : "12345",
    "type" : "OIDC-Default"
  },
  "createdBy" : "e6dc6d23-f1b7-4e99-9094-46bab2515f85",
  "createdAt" : "2024-11-15T02:33:17.506970Z",
  "updatedAt" : "2024-11-15T02:33:17.506970Z",
  "versionDate" : "2024-11-15T02:33:17.506270Z",
  "appliedAt" : null,
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "status" : "NEW",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936",
      "profile" : "parent"
    },
    "service" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/5156857b-f769-495a-8a73-ea1c04a44d2e"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/230c4ac8-2659-43f8-a8f5-21675756a69c",
      "title" : "browzer-app-2785"
    }
  }
}

Optional

Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

Path

Type

Optional

Description

String

true

networkId

String

true

name

String

true

path

String

true

serviceId

String

true

Deprecated..

zitiServiceId

String

true

tunnelHttps

Boolean

true

access

Object

true

access.domainNameLabel

String

true

access.dnsZoneId

String

true

access.fqdn

String

true

auth

Object

true

auth.type

String

true
true

auth.baseUrl

String

true

auth.clientId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

versionDate

String

true

appliedAt

String

true

deletedAt

String

true

deletedBy

String

true

deleted

Boolean

true

status

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-apps' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2RGxnbTJteklZWlM5VjlzNWIybXhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNhZDZkNGUzLWQxZDUtNDUyOS1iM2I3LWFiMjhkYjBmMTAyNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzkxMSwiZXhwIjoxNzMxNjQxNTExLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImNiYTVkODZlLWZmYmItNDc1MC1iMGNlLWU2ODhhMTViYjY1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzkxMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.il7iBqqMN6qOCL3K-3z2yHauR-6aJFeGGk5k4a0rPUHXdPNhHxPfeAy1wTmfylFbp1w0NfH23Xr_0DzIbzK-GtqW8e81hJBOeLIl4gis0yH0FweeKU1IhEQtMnKeIYQitoIaAKIpsEFXB1hYZoNmoCanoBKWWdIYqscumnKrr6LNe07TfLPFaDcqeAF3S6OBbKfLTmiikP_umwo1YOIwCJhzylx4-_T4xvQa7yjvTP3jho0fnetL9MDL5fkCnnO6mEOoUf6EtSscT6oCB0ED8W_3KFCXSYKCRqms2_oYqza-sLtGBbKKAT1YXq-BvAzgyZeHsGejz4q-YlGA0mLGHw'

Example response

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

{
  "_embedded" : {
    "browzerAppList" : [ {
      "id" : "5b62ea62-ab44-4f6a-b72a-e971f40a8f20",
      "networkId" : "954f4363-8498-4391-b910-023ec7f40d59",
      "name" : "deleting",
      "path" : "/deleting",
      "serviceId" : null,
      "zitiServiceId" : "zitiId-210",
      "tunnelHttps" : true,
      "access" : {
        "domainNameLabel" : "app3",
        "dnsZoneId" : null,
        "fqdn" : null
      },
      "auth" : {
        "baseUrl" : "fake.nf.io",
        "clientId" : "12345",
        "type" : "OIDC-Default"
      },
      "createdBy" : "119c864f-30d9-4140-8270-47194d644955",
      "createdAt" : "2024-11-15T02:31:51.488543Z",
      "updatedAt" : "2024-11-15T02:31:51.493106Z",
      "versionDate" : "2024-11-15T02:31:51.493106Z",
      "appliedAt" : null,
      "deletedAt" : "2024-11-15T02:31:51.493106Z",
      "deletedBy" : "f40f1fe8-88d4-4cb4-bfac-4e4a56cedeef",
      "deleted" : true,
      "status" : "DELETING",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/954f4363-8498-4391-b910-023ec7f40d59",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/5b62ea62-ab44-4f6a-b72a-e971f40a8f20",
          "title" : "deleting"
        }
      }
    }, {
      "id" : "604f9881-626d-4f66-843b-5d9c7c48ef2f",
      "networkId" : "954f4363-8498-4391-b910-023ec7f40d59",
      "name" : "app one",
      "path" : "/some-path",
      "serviceId" : null,
      "zitiServiceId" : "zitiId-208",
      "tunnelHttps" : true,
      "access" : {
        "domainNameLabel" : "app1",
        "dnsZoneId" : "667c8624-386a-4bf3-bb6c-4db59970bb27",
        "fqdn" : "app1.fake.nf.io"
      },
      "auth" : {
        "baseUrl" : "fake.nf.io",
        "clientId" : "12345",
        "type" : "OIDC-Default"
      },
      "createdBy" : "449ceecd-d0da-425e-8ef7-d568b0e6d543",
      "createdAt" : "2024-11-15T02:31:51.452206Z",
      "updatedAt" : "2024-11-15T02:31:51.491819Z",
      "versionDate" : "2024-11-15T02:31:51.483267Z",
      "appliedAt" : "2024-11-15T02:31:51.483267Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "deleted" : false,
      "status" : "DEPLOYED",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/954f4363-8498-4391-b910-023ec7f40d59",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/604f9881-626d-4f66-843b-5d9c7c48ef2f",
          "title" : "app one"
        }
      }
    }, {
      "id" : "f536e2da-8dd5-4b99-b773-2ca014e0dcb6",
      "networkId" : "954f4363-8498-4391-b910-023ec7f40d59",
      "name" : "app two",
      "path" : "/",
      "serviceId" : null,
      "zitiServiceId" : "zitiId-209",
      "tunnelHttps" : true,
      "access" : {
        "domainNameLabel" : "app2",
        "dnsZoneId" : null,
        "fqdn" : null
      },
      "auth" : {
        "baseUrl" : "fake.nf.io",
        "clientId" : "12345",
        "type" : "OIDC-Default"
      },
      "createdBy" : "8f5a0fb2-af1e-4065-97c5-5380db96b61b",
      "createdAt" : "2024-11-15T02:31:51.486348Z",
      "updatedAt" : "2024-11-15T02:31:51.486348Z",
      "versionDate" : "2024-11-15T02:31:51.485239Z",
      "appliedAt" : null,
      "deletedAt" : null,
      "deletedBy" : null,
      "deleted" : false,
      "status" : "NEW",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/954f4363-8498-4391-b910-023ec7f40d59",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/f536e2da-8dd5-4b99-b773-2ca014e0dcb6",
          "title" : "app two"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

path

String

true

serviceId

String

true

Deprecated..

zitiServiceId

String

true

tunnelHttps

Boolean

true

auth

Object

true

auth.type

String

true
true

auth.baseUrl

String

true

auth.clientId

String

true

access

Object

true

access.domainNameLabel

String

true

access.dnsZoneId

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-apps/992a23e5-a81d-4ad7-89cc-fac83a62da7f' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJzVW5lUzZmRDBfMENUMzM2Z3JZOElBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNhZGZkMDI5LTJkZWItNDAyZC04OTRhLTE5YmZkNTFjNTdkYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk5NywiZXhwIjoxNzMxNjQxNTk3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjNiOGMzYzUxLTM1N2ItNDc0Ny04NmY5LTdhN2I5Yzk5YjFiZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk5N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.n3xRKDgMix36u0TWx56iDyynSvH41_j16apHh1U4TH7OXvPJ29dFrIXparzZLwqr_9Vqlj2UuE3KL3kRG7ejBppzFr1Z0n0Dq5XZrqxRkumU8bEcDKVG5dIWIJsios612gGfrxFf8-JJ93CU2Tgdqe9_RiTaDogrTNMVwrmeSVx6wxpQ_4CnNo3Sx9WWaaorBUZ5gcE8myGFvouAC_v6AV_DOJ5cOyWWMqPOaa0c4jRTD_6qumIK0oV0BlrwlAfMCzzwPh5kpsHU4yqVCv_M0HutCKlVBb-BSxfsVYbbvl4FqS-9xnuXURB5m9wd_fQ_7RPpGq856g4uOuSmKpj36w' \
    -d '{"name":"E3BwNcdtBlTXRD0qoyySo","path":null,"serviceId":null,"zitiServiceId":null,"tunnelHttps":null,"auth":null,"access":null}'

Example response

HTTP/1.1 202 Accepted
X-NF-deprecated-property: serviceId; removal 3/1/2023; see https://gateway.production.netfoundry.io/core/v2/docs/index.html
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1280

{
  "id" : "992a23e5-a81d-4ad7-89cc-fac83a62da7f",
  "networkId" : "d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936",
  "name" : "E3BwNcdtBlTXRD0qoyySo",
  "path" : "/",
  "serviceId" : "782fc6eb-a9c0-4b38-9440-c8a82d340cc6",
  "zitiServiceId" : "ziti-id-2764",
  "tunnelHttps" : true,
  "access" : {
    "domainNameLabel" : null,
    "dnsZoneId" : null,
    "fqdn" : null
  },
  "auth" : {
    "baseUrl" : "https://foo.bar",
    "clientId" : "12345",
    "type" : "OIDC-Default"
  },
  "createdBy" : "8d22a09a-4aff-414e-9438-1d3b8b34204e",
  "createdAt" : "2024-11-15T02:33:17.434032Z",
  "updatedAt" : "2024-11-15T02:33:17.460116Z",
  "versionDate" : "2024-11-15T02:33:17.459951Z",
  "appliedAt" : null,
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "status" : "NEW",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936",
      "profile" : "parent"
    },
    "service" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/782fc6eb-a9c0-4b38-9440-c8a82d340cc6"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/992a23e5-a81d-4ad7-89cc-fac83a62da7f",
      "title" : "E3BwNcdtBlTXRD0qoyySo"
    }
  }
}

Update Browzer App

PUT /v2/browzer-apps/{id}

Authorization

This endpoint requires the following actions:

update action on the browzer-app resource type
read action on the service resource type

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

path

String

true

serviceId

String

true

Deprecated..

zitiServiceId

String

true

tunnelHttps

Boolean

true

auth

Object

true

auth.type

String

true
true

auth.baseUrl

String

true

auth.clientId

String

true

access

Object

true

access.domainNameLabel

String

true

access.dnsZoneId

String

true

Response fields

Path

Type

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-apps/39f1f625-df64-48d7-9d6b-669719bcb32b' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJUR0FJVTNUNS1wdGhUTllSbWpJRDV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZlZGQ2ZThhLTRiNzUtNGMwNS1iMDZkLWVkNWMyNGIwZDBlNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk5NywiZXhwIjoxNzMxNjQxNTk3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImNjYTc2NmZjLWY0MGUtNDUxOC1hZWVkLTkxODVhMDAwNjkwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk5N30se1wiaWRcIjpcImY0NjdlMGNiLWM1ODctNGI4MC04YmYwLWE5NTNlNjg1YWYzZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk5N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.C7vFRL6LJylGu-ZdbuUFPKcUpofZDZaKqv1R29zIjrvieX_QQdwAJVqKv7BuHWAuuxD_3xJEmrjyueIVltgx4Oqeb_9gmBDJ7-irgBNq1tiucheakajIueWnXBiO9V1r8MK5NZe_w8sfqq_GIquyi1QBRwEBA9kp5mlWwhyjTbPgfuliGEbOe5e_-KvNQGuNBcdePi_Gy3QvYa_iDJEmO2QYrGQjwFch6IvD6BUJ7EwRt9fcWXbL7eCih6rt3cnnIki8S837UOoemOBzzIsgxfahorDa0af1kOnMPlbsyfjxFQ9YfznDeV-pGZSuVlTUCOemDctHqjAkR7r8HqNI4A' \
    -d '{"name":"tTfdmkYn-5K5LJBmD9O5j","path":null,"serviceId":"f9837ecc-ca59-436a-8adb-19a1d155ddc5","zitiServiceId":null,"tunnelHttps":null,"auth":{"baseUrl":"https://fake.com","clientId":"fake","type":"OIDC-Default"},"access":{"domainNameLabel":"test-03","dnsZoneId":null}}'

Example response

HTTP/1.1 202 Accepted
X-NF-deprecated-property: serviceId; removal 3/1/2023; see https://gateway.production.netfoundry.io/core/v2/docs/index.html
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1310

{
  "id" : "39f1f625-df64-48d7-9d6b-669719bcb32b",
  "networkId" : "d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936",
  "name" : "tTfdmkYn-5K5LJBmD9O5j",
  "path" : "/",
  "serviceId" : "f9837ecc-ca59-436a-8adb-19a1d155ddc5",
  "zitiServiceId" : "ziti-id-2748",
  "tunnelHttps" : true,
  "access" : {
    "domainNameLabel" : null,
    "dnsZoneId" : null,
    "fqdn" : null
  },
  "auth" : {
    "baseUrl" : "https://fake.com",
    "clientId" : "fake",
    "type" : "OIDC-Default"
  },
  "createdBy" : "d1251c2b-46c0-4993-b416-c3f4ca11d99f",
  "createdAt" : "2024-11-15T02:33:17.266067Z",
  "updatedAt" : "2024-11-15T02:33:17.380189Z",
  "versionDate" : "2024-11-15T02:33:17.379649Z",
  "appliedAt" : "2024-11-15T02:33:17.267186Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "status" : "UPDATING",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936",
      "profile" : "parent"
    },
    "service" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/f9837ecc-ca59-436a-8adb-19a1d155ddc5"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/39f1f625-df64-48d7-9d6b-669719bcb32b",
      "title" : "tTfdmkYn-5K5LJBmD9O5j"
    }
  }
}

Validate Update

PATCH /v2/browzer-apps/{id}

Authorization

This endpoint requires the following actions:

create action on the browzer-app resource type
create action on the browzer-app resource type
read action on the service resource type
read action on the service resource type
read action on the dns-zone resource type
read action on the dns-zone resource type

Path parameters

Parameter

Type

Optional

Description

Object

false

Query parameters

No parameters.

Request fields

Path

Type

Optional

Description

name

String

true

path

String

true

serviceId

String

true

Deprecated..

zitiServiceId

String

true

tunnelHttps

Boolean

true

auth

Object

true

auth.type

String

true
true

auth.baseUrl

String

true

auth.clientId

String

true

access

Object

true

access.domainNameLabel

String

true

access.dnsZoneId

String

true

Response fields

Path

Type

Optional

Description

[].path

String

true

[].label

String

true

[].message

String

true

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-apps/c72bc84c-0c09-4f1b-9b9d-a7954a54d2e0' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'nf-validate: ' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJFWVJCRG9rdEY1QzN1YkIwX1hyVXF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIzY2YzMmMzLWIzZDgtNDI4Ni1iNDA4LTVmZDg3MmYyMzJhMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzg2MCwiZXhwIjoxNzMxNjQxNDYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE3MTgwMmJjLWRmYWMtNDE0YS1hYTdiLTAwYmYxN2UwNmJjMFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2MH0se1wiaWRcIjpcIjk3OWZmZWYyLTczMWYtNDc2Yy05NTdmLTY2YWUyZDZmYTQyOVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2MH0se1wiaWRcIjpcImVjYmNiYjI0LWMxMmQtNGY0Ny1hOTQ1LWZjMDNiYWFkY2NmZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2MH0se1wiaWRcIjpcImI1ZjNlMTU4LTEzMzktNGQ2My05NTNjLTRkZWEzYTBmNTA0OVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2MH0se1wiaWRcIjpcIjRiYmM4NTYxLWE0MDgtNDIwMC04ZTRjLWQ2MTYwNGE0ODNlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2MH0se1wiaWRcIjpcImQ3NGFhZWMyLTk2ZjYtNGZiZS04NzQxLTZjM2E4YTc2ZDE1NVwiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzg2MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.M4YDyUsdk1FohpDrVW4BZUUpm18vTBgWRd26KGZzx1IcQmjgRcumkqY_HgrK7y9K3cGIc4QysB9b7jQmkKm7WJ7V7zAm4SS_-hyL4_ZjA3VesFvTspWvzN6m_Hu-L-acckNb3vOf9nAMDdfXlUCL1rf69p8yzlX-0T2r9bvVG9BpE4tFL9I1Iwqn4-4R27EmjOEFD-RC0gLlrxNbmtzyDEnD8NmBnwm_kuvlSxvGKFV9Kq3VS1MSW6KYE_UW9vJqpdoPuGD7KdxsjTFVeeM0YxBYjuPHlxUw69ZiSTTeJdSjq7Nz7QSu7W0vmwRX1_itwfAaxOmiJ1hC71Eh3n6h2w' \
    -d '{
    "path": "/whatever",
    "zitiServiceId": null,
    "baseUrl": null,
    "clientId": null,
    "name": null,
    "tunnelHttps": null,
    "domainNameLabel": null,
    "serviceId": null,
    "dnsZoneId": null
}'

Example response

HTTP/1.1 200 OK
X-NF-deprecated-property: serviceId; removal 3/1/2023; see https://gateway.production.netfoundry.io/core/v2/docs/index.html
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3

[ ]

Optional

Description

Object

false

Optional

Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path

Optional

Description

self

true

network

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-apps/ccb808ce-4edd-48a2-9e38-26e381056f86' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfRDhVUzhtSXlDVXR3dUVtbzJUVzVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk2MTUwZGU3LTJmMGUtNDg2Yi1iNmM2LTVhNjYxMmZiM2RiNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczMTYzNzk5NywiZXhwIjoxNzMxNjQxNTk3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVjYTY5N2UwLWZjYjUtNDE5ZC05NjlkLTAzNmYyNDUwYTRlN1wiLFwibGFzdE1vZGlmaWVkXCI6MTczMTYzNzk5N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.BVJB47nlEXe0J20JbiAuvk77fBw0ARqJRCDbOIHu_-3XuGEuMD1Wpllvh_f0Ermx0_jKbZN1Spx761MLpGisAFnGdqaj2nLn5qRV1PaWBWwu83RINJpZpMbC_wiW-S9g6F2wlR1XzeJ63zR5ov4CyjfilQ-XAT_jabH_QzlVUxUZlUqo1hVCNxD7eA-OrAewCNOHJwY3TJhWXFDkp05Ro7MVnBhcN_4A32WL-w9sq_OJjg9M0Tdadsj77rHvmMPK9sNXy3Jhpg4kEr3m0mwjkS-oXYNlNoZh9QGBqD7lc8YTjBY7YrHQ2zwjc7BrUdkZSgpWs2jS2EkaCd0MmUtFyQ'

Example response

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

{
  "id" : "ccb808ce-4edd-48a2-9e38-26e381056f86",
  "networkId" : "d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936",
  "name" : "browzer-app-2720",
  "path" : "/",
  "serviceId" : "d4341396-0fd4-412a-bd12-95099afe30d0",
  "zitiServiceId" : "ziti-id-2715",
  "tunnelHttps" : true,
  "access" : {
    "domainNameLabel" : null,
    "dnsZoneId" : null,
    "fqdn" : null
  },
  "auth" : {
    "baseUrl" : "https://foo.bar",
    "clientId" : "12345",
    "type" : "OIDC-Default"
  },
  "createdBy" : "c1becaad-a217-4d2a-9b8e-5f34c7472327",
  "createdAt" : "2024-11-15T02:33:17.091751Z",
  "updatedAt" : "2024-11-15T02:33:17.125387Z",
  "versionDate" : "2024-11-15T02:33:17.125387Z",
  "appliedAt" : null,
  "deletedAt" : "2024-11-15T02:33:17.125387Z",
  "deletedBy" : "96150de7-2f0e-486b-b6c6-5a6612fb3db6",
  "deleted" : true,
  "status" : "DELETING",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d9cb3d0b-4cf7-4b4b-aa12-f6efdd991936",
      "profile" : "parent"
    },
    "service" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/d4341396-0fd4-412a-bd12-95099afe30d0"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/ccb808ce-4edd-48a2-9e38-26e381056f86",
      "title" : "browzer-app-2720"
    }
  }
}

NetFoundry Network Management V2 Service Guide