Introduction

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

Overview

HTTP verbs

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

Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT

Used to update an existing resource, full updates only

PATCH

Used to update an existing resource, partial updates

DELETE

Used to delete an existing resource

HTTP status codes

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

Status code Usage

200 OK

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

201 Created

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

202 Accepted

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

204 No Content

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

400 Bad Request

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

401 Unauthorized

The request lacks valid authentication credentials for the target resource.

403 Forbidden

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

404 Not Found

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

Pagination

Paginated services will accept the following optional request parameters:

Table 1. Request parameters
Path Type Optional Description

page

Integer

true

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

size

Integer

true

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

sort

String

true

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

Pagination response has following structure:

Table 2. Response structure
Path Type Optional Description

content

Array[Object]

false

Actual items.

totalElements

Integer

false

Total count.

totalPages

Integer

false

Total pages with current page size.

last

Boolean

false

If this page is the last one.

numberOfElements

Integer

false

Actual size of content array (number of items).

first

Boolean

false

If this page is the first one.

sort

Object

true

Sort information object.

size

Integer

false

Requested size of the page.

number

Integer

false

Page number.

empty

booloean

false

If this page is empty.

Content Types

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

Request a Content Type

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

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

HAL+JSON (default)

application/hal+json

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

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

JSON

application/json

Single resource: response is a JSON dictionary describing the resource

List of resources: response is a JSON list where each element describes an 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.

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

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 Description

name

String

true

billingAccountId

String

true

ownerIdentityId

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-groups' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI0d2NiNGZ3dUMxZERXWFpfX3YySHZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA5ZjgxODk3LWVmZWYtNDQwZC1hMjk5LTY3ZTZmZDU2MGUxYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc2MCwiZXhwIjoxNzM2NjMxMzYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQyYzRhNTRjLWE5YTItNDRiZS04OGM2LWIxZjgyNGVhMTE1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.SDqWRNeg1osFXt_6YAJflciI6x4NKQ9TTyCM-CxmwoKM5n4c_fpNif80BI_c0i6Xnde4ThNCJ3WNCJdyuFQNDLHw7-PjzKkg_kHnqBskry5bE23_4wIflxh9DinGUaFwvuAZPePMso6GxHHsGHbtou_fxi4gEc_00UPDBSzoghB-o8NF0jKyyp-3UgHAz4jkPM6ubE_x5QH4DhzFB5LYOzrB4yabmOs_oEfDZ7lmO_y3eflv6VfMW5ZwJRY6GY0XitQKXHNTv7TH2-nOSwv31bCc5eqZ32rn0c-D49LWjnx4eJ9AX77m1k-cav-76kzLEj4pkP5rjPcqADRHw_vsgw' \
    -d '{"name":"New NG","billingAccountId":"afee07b7-0e0f-4544-b955-eeb558089906","ownerIdentityId":"f1f522d5-45f9-4b9f-88c0-8717757664e3"}'

Example response

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

{
  "id" : "ec60fcf4-e161-465c-a9bc-dc7c9e68d0f0",
  "name" : "New NG",
  "shortName" : "NEWNG",
  "billingAccountId" : "afee07b7-0e0f-4544-b955-eeb558089906",
  "ownerIdentityId" : "f1f522d5-45f9-4b9f-88c0-8717757664e3",
  "createdBy" : "09f81897-efef-440d-a299-67e6fd560e1b",
  "createdAt" : "2025-01-11T20:36:00.671038Z",
  "updatedAt" : "2025-01-11T20:36:00.671038Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/ec60fcf4-e161-465c-a9bc-dc7c9e68d0f0",
      "title" : "New NG"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/59c32094-6dfd-4a19-95cd-bf5ac1ae3ffb",
      "title" : "Create NetworkGroup",
      "profile" : "meta"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=ec60fcf4-e161-465c-a9bc-dc7c9e68d0f0"
    },
    "dns-zones" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=ec60fcf4-e161-465c-a9bc-dc7c9e68d0f0"
    }
  }
}

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

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/network-groups/e62ae46e-3119-4d09-9f78-066de09e3647' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJwZzVQaWtoeTBackEtdDZOTVYtT0ZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg2ZWI3OWQ3LWE2MjUtNDI4Ni1hZDQ2LWJiOGY3OWI0NWYzZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc1OSwiZXhwIjoxNzM2NjMxMzU5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZmZWMzOWFjLTgwMjktNDViNS04NmRhLWQwMTc4MjVjZTkxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc1OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.P2YoPLUGT0ySFo_MkLuMBHg5NBt5TTMO0pO48PYcCBuwDuaTrWaFMNCZo1UIUR5WCNVJCGbrxL_TH7BXoMZPKD5tuF889lNYTynGWjxfsoqigODBO6aLt37QJS5WxJ7AOuKh2iXjRogJQ4jT-rTcDiqgX4jBLEvVwOHqhB25nCIyAxuMrLIzM_mbUSHDXRGB-3mWy4MutnzMtm8rJiQ36lMf7etHobyH-meygbW3NUkSde6rdqt_vv7ZFBP4fgRSmS8m-pzhf_HHnXhV5g6YZndwrxGq61JE6j3hQbcspIpXFciBngaAwWvt4wMwSh9M09RJH_lFxZFh5FwrVqF6wQ'

Example response

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

{
  "id" : "e62ae46e-3119-4d09-9f78-066de09e3647",
  "name" : "Test-NG",
  "shortName" : "nw-271",
  "billingAccountId" : "cd5c6801-e132-4998-8d1e-5f43d6dd0529",
  "ownerIdentityId" : "7d49f94a-a29f-4414-baa6-682c02fc272d",
  "createdBy" : "f78e4358-52fa-4c14-9e62-01fd9907803c",
  "createdAt" : "2025-01-11T20:35:59.985275Z",
  "updatedAt" : "2025-01-11T20:36:00.000331Z",
  "deletedBy" : "86eb79d7-a625-4286-ad46-bb8f79b45f3e",
  "deletedAt" : "2025-01-11T20:35:59.999Z",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/e62ae46e-3119-4d09-9f78-066de09e3647",
      "title" : "Test-NG"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/f30bd89b-a2b0-4184-b3fd-c74194823b54",
      "title" : "Delete NetworkGroup",
      "profile" : "meta"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=e62ae46e-3119-4d09-9f78-066de09e3647"
    },
    "dns-zones" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=e62ae46e-3119-4d09-9f78-066de09e3647"
    }
  }
}

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

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/network-groups/a39abda4-0940-4933-a55d-411740192b9a' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJNOVI2SnJxeXJ6N1FLbWpZbzdxUHVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ5YTVmMzMwLTAzOGYtNDM4Ni04YjA1LTMzMmM3YmRhMDE5YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc2MCwiZXhwIjoxNzM2NjMxMzYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY1MzAxNTVlLWRiY2UtNDczNi1hZDA5LWNjZWRmZjY1YjUwMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.YJFPRudTYyPbxD5ZzusO3uoclEaol4lyM96HSj0_u3tVTv6eEK7LmgLI1UVbYZc7x0HX5WbUao9UmMZRS53psuemeR27OvxFibDwIAAEA5IMbD7QqEtVMhuqbtDTfC_SUnGnVXB1GojVCkRTiLX6AGUVM1QO0WstGY46Oox-ZiW4w5vqLlJVj-Mku9W3TNveJE_WKOZHKDnJGb4wPRQ7_ofDId1dBKl2K-Dize7jWVV9O1N-0rd9eQamM1vnzrFlSr6qzcf4RBm7HmveF-n50FtjzhDBMRpMiVJDDT1mTGATVRkVg99EGjCeUo8DNbKMiQdjsr_0iy4-_fS7bDGLgA'

Example response

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

{
  "id" : "a39abda4-0940-4933-a55d-411740192b9a",
  "name" : "Test-NG",
  "shortName" : "nw-351",
  "billingAccountId" : "2b9ba674-d19e-4ec1-88fd-b02c0cbb4c41",
  "ownerIdentityId" : "43c8e0db-5f7b-4d50-b3a5-82d395478d3a",
  "createdBy" : "8fe9e9bf-5cbe-42da-91e1-89b0a3750689",
  "createdAt" : "2025-01-11T20:36:00.570966Z",
  "updatedAt" : "2025-01-11T20:36:00.570966Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/a39abda4-0940-4933-a55d-411740192b9a",
      "title" : "Test-NG"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=a39abda4-0940-4933-a55d-411740192b9a"
    },
    "dns-zones" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=a39abda4-0940-4933-a55d-411740192b9a"
    }
  }
}

Find Network Groups

GET /v2/network-groups

Returns all {@link NetworkGroup} instances which match the search criteria as specified via query parameters or an application/x-www-form-urlencoded encoded query, where query parameter names match the properties of the {@link FindNetworkGroup} command. <p/> Instances that the API client does not have authorization to read will be removed from the results. As a side effect of this behavior, this API endpoint will never result in a 403 unauthorized result. In such cases, the results will simply be empty. This applies whether any find query parameters exist or not; ie, this API endpoint will never return a 404.

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

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

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.eyJqdGkiOiJGcFcxeXFWaWpDTGhqVkp6YUtGb3FnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRjYzdjY2ZkLWQ0ZmQtNDhiOS1hNGFmLWUzYmFhMzczZmY1MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc2MCwiZXhwIjoxNzM2NjMxMzYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjllZjA0OGQwLTI1Y2MtNGQzOS05NDdiLTU2OTE5YzkwN2MxMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.pSj880uDNrS0N_TRwc7imbMYba3YiX3-Ay3lv4g_6zLKOz9twhsaZc0s3QTPyYDryitdflyMtQEgs21LfF_-dN_k1h_WDkMDHl_ljy4pWpYYHEjO2Z5xrJleNEYUz3ksiRe6bV-QQ9pCvNfzkbzP7LQmd7S_YVt0k0BrQo3jTKUQJb5oiogMSqXQACSL4oxgVutpQRnyUTv9-7o5gwhwm06u3Imx2rEyppszrhhLL0zVluIJQG8i9eiHPJF7TBh8iigQFIx4VPOmBhUO6gqj5YBDxtyo6eK4iuN5KKYFC889-eIE_0I4ORnENh18MxwXBo5cgFW9zbpeFFoHyFml1Q'

Example response

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

{
  "_embedded" : {
    "networkGroupList" : [ {
      "id" : "61ec0c19-59b2-46d8-9756-c9ad56887796",
      "name" : "Test-NG",
      "shortName" : "nw-251",
      "billingAccountId" : "6ba352a2-d656-4c28-b740-f5b36d9d7c30",
      "ownerIdentityId" : "4086d599-f17c-491d-a28e-95197bbf037a",
      "createdBy" : "6e631611-a232-40fb-8199-76d77ee11d32",
      "createdAt" : "2025-01-11T20:35:59.623985Z",
      "updatedAt" : "2025-01-11T20:35:59.777166Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/61ec0c19-59b2-46d8-9756-c9ad56887796",
          "title" : "Test-NG"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=61ec0c19-59b2-46d8-9756-c9ad56887796"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=61ec0c19-59b2-46d8-9756-c9ad56887796"
        }
      }
    }, {
      "id" : "8ba47cf4-f4e3-4e04-bdc6-7a267acec20e",
      "name" : "Updated NG Name-28",
      "shortName" : "nw-301",
      "billingAccountId" : "eda801bf-f318-4538-b0b4-e372193078fa",
      "ownerIdentityId" : "66e3252e-13a0-4d97-8c13-2bfcf5da1d7e",
      "createdBy" : "c98eb1b0-41c9-4736-8364-4ab84d1e76be",
      "createdAt" : "2025-01-11T20:36:00.160051Z",
      "updatedAt" : "2025-01-11T20:36:00.201366Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/8ba47cf4-f4e3-4e04-bdc6-7a267acec20e",
          "title" : "Updated NG Name-28"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=8ba47cf4-f4e3-4e04-bdc6-7a267acec20e"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=8ba47cf4-f4e3-4e04-bdc6-7a267acec20e"
        }
      }
    }, {
      "id" : "a473d160-58aa-4251-b27b-3068978f6686",
      "name" : "Test-NG",
      "shortName" : "nw-331",
      "billingAccountId" : "0080350a-b62a-416b-97ad-01144663ad0c",
      "ownerIdentityId" : "9b89cdcf-c6d6-4d69-8dbe-1853b1ffd273",
      "createdBy" : "e9feeac8-79a8-4cb4-806f-ecb44ecbe194",
      "createdAt" : "2025-01-11T20:36:00.438789Z",
      "updatedAt" : "2025-01-11T20:36:00.438789Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/a473d160-58aa-4251-b27b-3068978f6686",
          "title" : "Test-NG"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=a473d160-58aa-4251-b27b-3068978f6686"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=a473d160-58aa-4251-b27b-3068978f6686"
        }
      }
    }, {
      "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" : "2025-01-11T20:35:58.298643Z",
      "updatedAt" : "2025-01-11T20:35:58.298643Z",
      "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"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=bce07cd1-8f36-44a3-b279-26426e7a53ef"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=bce07cd1-8f36-44a3-b279-26426e7a53ef"
        }
      }
    }, {
      "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" : "2025-01-11T20:35:58.279713Z",
      "updatedAt" : "2025-01-11T20:35:58.279713Z",
      "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"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=f0428619-11bd-403d-8b00-a463ff8aad84"
        },
        "dns-zones" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=f0428619-11bd-403d-8b00-a463ff8aad84"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 5,
    "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

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

billingAccountId

String

true

ownerIdentityId

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-groups/8ba47cf4-f4e3-4e04-bdc6-7a267acec20e' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvM3dydEg5WWhpQXZpTkZWbkctNEFRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc3ZGZhOWIxLWFjZWMtNDlhOS1hNGYwLTBhYTBhNzM2M2EwNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc2MCwiZXhwIjoxNzM2NjMxMzYwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE2ZTEyZDdhLTk3MjAtNDNhYy1iNDA3LTA3N2U0ZThmYmM2ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.HXbUQ5fbxtq_dbbvvkPUEhGnjRa1aZ7cgWEM_k2vfkyASO7D71YzEkcPhqpEZFFoivtHwfLVG2Y8KZ0GQa41ncPL4Q_JF40MTcwPkp_sT42acK2r4x3epB4wNM2JhRVRyofck_syOXMlRRScda3nBUU0zacPQPMbMEr6WmWxjRIhYQc8KHIIb0UI92BPQupBy3bSCvVSulKXYzoje_an3ZWLblmtKgw7Urg5IlH1AGOXcPNXTqZ4CtESKuWx_ygWC6Ue7AGMcGuwtlGWTEhJMAR426cHrQh7dtQbrnhHkgWrxLHi96sxN08rExrPXOjt6Wv54vlkBdXzkgArdIiEqg' \
    -d '{"name":"Updated NG Name-28","billingAccountId":"eda801bf-f318-4538-b0b4-e372193078fa","ownerIdentityId":"66e3252e-13a0-4d97-8c13-2bfcf5da1d7e"}'

Example response

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

{
  "id" : "8ba47cf4-f4e3-4e04-bdc6-7a267acec20e",
  "name" : "Updated NG Name-28",
  "shortName" : "nw-301",
  "billingAccountId" : "eda801bf-f318-4538-b0b4-e372193078fa",
  "ownerIdentityId" : "66e3252e-13a0-4d97-8c13-2bfcf5da1d7e",
  "createdBy" : "c98eb1b0-41c9-4736-8364-4ab84d1e76be",
  "createdAt" : "2025-01-11T20:36:00.160051Z",
  "updatedAt" : "2025-01-11T20:36:00.201366Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/8ba47cf4-f4e3-4e04-bdc6-7a267acec20e",
      "title" : "Updated NG Name-28"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/9285b570-6b4d-4219-9c89-a597c6db978d",
      "title" : "Update NetworkGroup",
      "profile" : "meta"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks?networkGroupId=8ba47cf4-f4e3-4e04-bdc6-7a267acec20e"
    },
    "dns-zones" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/dns-zones?networkGroupId=8ba47cf4-f4e3-4e04-bdc6-7a267acec20e"
    }
  }
}

Networks

Find Networks

GET /v2/networks

Returns all {@link Network} instances which match the search criteria as specified via query parameters or an application/x-www-form-urlencoded encoded query, where query parameter names match the properties of the {@link FindNetwork} command.

Instances that the API client does not have authorization to read will be removed from the results. As a side effect of this behavior, this API endpoint will never result in a 403 unauthorized result. In such cases, the results will simply be empty. This applies whether any find query parameters exist or not; ie, this API endpoint will never return a 404.

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

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

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. In favor of the size property on the host for the network controller, will be deleted 1/1/2023.

@deprecated in favor of the size property on the host for the network controller, will be deleted 1/1/2023
See Hosts.

productVersion

Object

true

region

String

true

Deprecated. In favor of the region property on the network controller, will be deleted 1/1/2023.

@deprecated in favor of the region property on the network controller, will be deleted 1/1/2023
See Network Controllers.

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. Please use either the embed support or make a separate request to load the network controller of a network, will be deleted 1/1/2023.

@deprecated please use either the embed support or make a separate request to load the network controller of a network, will be deleted 1/1/2023
See Network Controllers.

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

Contains the {@link ZitiIdentity} of the ziti tunnel that is running co-located to this controller process on this controller’s host, or null if there is no such tunnel, this resource was obtained not on an HTTP request thread, or the HTTP request does not have a 'beta' query parameter on it. This property may be stripped from the response if the client making the request does not have update permission on this network controller.

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

Boolean

true

networkController.managementZitiIdentity.admin

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.eyJqdGkiOiIxWmFrRUdUeFcyaW5ZcTRBUXl1OHBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUzNTk1Mjk2LTJkOWQtNGVlNS1hM2IxLTI5ZGRmNDM5NWM5ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg4OSwiZXhwIjoxNzM2NjMxNDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFhYzRhY2ZiLTcwMDAtNGU2Yi04NTg5LTJiMWMzMWVlZGMwMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.EEzpnM7hjepJnLlf0OGrDAoNO49OjCk4aq-n5lhFrK-XDNyyoekYIZCedunz07wIRnGn3sP3DO4rb1cdvjO1N3JF5k9TZUPsYa-u6iqqnnGG_Bi66AGzTLxlna-l0J8X2xB09mY3KA8cRjHIdzbVtVU1JKPIjUnprXy0Ok8_vWJIDLXlmWfjeI-zQXcBkIngxCAcPKsHOB1wjbEEU2MrRQMrC0GWZLZgbhzCJNWJGQ_wOBal5THTLWUxqRv5uMBYNxpu5h8EbXmi-l6AbQHmQ8BLu7TUCgFG58SbPPMqKCk8cdbpkMaQXYDNWNf1ugzc-R41aLZpN71PLeqzhaUvYw'

Example response

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

{
  "_embedded" : {
    "networkList" : [ {
      "id" : "09deab44-6d49-4b00-a118-b3ebda6a12d0",
      "ownerIdentityId" : "0a373532-b750-4621-81c9-fb1a935694bb",
      "createdBy" : "0a373532-b750-4621-81c9-fb1a935694bb",
      "createdAt" : "2025-01-11T20:38:09.291425Z",
      "updatedAt" : "2025-01-11T20:38:09.341025Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Create Test Network",
      "networkGroupId" : "3adce4be-ee00-4bb3-b11e-ec39149ba08a",
      "size" : "small",
      "productVersion" : "7.3.18",
      "region" : "none",
      "status" : "PROVISIONED",
      "publicCertEnabled" : false,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "147492fe-69e2-40ff-b4fa-435e8197f325",
        "ownerIdentityId" : "0a373532-b750-4621-81c9-fb1a935694bb",
        "networkId" : "09deab44-6d49-4b00-a118-b3ebda6a12d0",
        "domainName" : "b82c5e41-e3ce-4509-83b4-1c8de44f460e.sandbox.netfoundry.io",
        "alternateDomainName" : null,
        "port" : 8443,
        "name" : "Create Test Network-NC",
        "productVersion" : "7.3.18",
        "hostId" : "81b4613d-9996-4db1-bddf-71279fe85d1f",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:09.297145Z",
        "updatedAt" : "2025-01-11T20:38:09.331014Z",
        "deletedAt" : null,
        "createdBy" : "0a373532-b750-4621-81c9-fb1a935694bb",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "442b0510-b0aa-43cb-90d3-f4d1a359db7d",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/09deab44-6d49-4b00-a118-b3ebda6a12d0",
          "title" : "Create Test Network"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/3adce4be-ee00-4bb3-b11e-ec39149ba08a",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=09deab44-6d49-4b00-a118-b3ebda6a12d0"
        }
      }
    }, {
      "id" : "15c682f7-df6f-4f34-a69d-121976ef17fa",
      "ownerIdentityId" : "2b8e9fe9-26ec-4238-a318-dc6fbe3ba38d",
      "createdBy" : "2b8e9fe9-26ec-4238-a318-dc6fbe3ba38d",
      "createdAt" : "2025-01-11T20:38:09.277825Z",
      "updatedAt" : "2025-01-11T20:38:09.278193Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-2618",
      "networkGroupId" : "3adce4be-ee00-4bb3-b11e-ec39149ba08a",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "dbb9194e-4695-43d7-8af6-5814c3262005",
        "ownerIdentityId" : "2b8e9fe9-26ec-4238-a318-dc6fbe3ba38d",
        "networkId" : "15c682f7-df6f-4f34-a69d-121976ef17fa",
        "domainName" : "dbb9194e-4695-43d7-8af6-5814c3262005.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-2618-nc",
        "productVersion" : "7.4.5",
        "hostId" : "49b5f3bd-f7b5-4dbc-9b69-f6e75a9c610a",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:09.278948Z",
        "updatedAt" : "2025-01-11T20:38:09.280677Z",
        "deletedAt" : null,
        "createdBy" : "2b8e9fe9-26ec-4238-a318-dc6fbe3ba38d",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "1a020bb9-aea5-465d-84d6-60d2f78a333e",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/15c682f7-df6f-4f34-a69d-121976ef17fa",
          "title" : "network-2618"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/3adce4be-ee00-4bb3-b11e-ec39149ba08a",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=15c682f7-df6f-4f34-a69d-121976ef17fa"
        }
      }
    }, {
      "id" : "18f5497c-03ba-4288-8ca4-b62342449331",
      "ownerIdentityId" : "e6cb5931-8935-4f79-9b39-5103845c32f3",
      "createdBy" : "e6cb5931-8935-4f79-9b39-5103845c32f3",
      "createdAt" : "2025-01-11T20:38:08.888418Z",
      "updatedAt" : "2025-01-11T20:38:08.952996Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Test Network Yaml",
      "networkGroupId" : "c6f838ae-ba6d-474b-9d8a-20ac2726fb49",
      "size" : "small",
      "productVersion" : "7.3.18",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : false,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "76374816-6d5a-40e8-9ede-45f77ed72621",
        "ownerIdentityId" : "e6cb5931-8935-4f79-9b39-5103845c32f3",
        "networkId" : "18f5497c-03ba-4288-8ca4-b62342449331",
        "domainName" : "22657bd6-a30b-4354-a7ed-8538e0fc7fdd.sandbox.netfoundry.io",
        "alternateDomainName" : null,
        "port" : 8443,
        "name" : "Test Network Yaml-NC",
        "productVersion" : "7.3.18",
        "hostId" : "e4521d3c-0ad2-4341-8a7b-3aa663055d06",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:08.898149Z",
        "updatedAt" : "2025-01-11T20:38:08.940007Z",
        "deletedAt" : null,
        "createdBy" : "e6cb5931-8935-4f79-9b39-5103845c32f3",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "5c82ea03-5331-4456-b4fb-d5918b9f18eb",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/18f5497c-03ba-4288-8ca4-b62342449331",
          "title" : "Test Network Yaml"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/c6f838ae-ba6d-474b-9d8a-20ac2726fb49",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=18f5497c-03ba-4288-8ca4-b62342449331"
        }
      }
    }, {
      "id" : "57d6f7a5-8937-41b3-b79a-31ea3c6f140b",
      "ownerIdentityId" : "a307a146-e0e2-492a-888f-b243fff91b9a",
      "createdBy" : "a307a146-e0e2-492a-888f-b243fff91b9a",
      "createdAt" : "2025-01-11T20:38:09.359246Z",
      "updatedAt" : "2025-01-11T20:38:09.359793Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-2623",
      "networkGroupId" : "8fffb8b7-4898-4ca0-b4b5-f14f688f3f0d",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "d9aa5ed2-33c7-449a-b24b-1994a01d6662",
        "ownerIdentityId" : "a307a146-e0e2-492a-888f-b243fff91b9a",
        "networkId" : "57d6f7a5-8937-41b3-b79a-31ea3c6f140b",
        "domainName" : "d9aa5ed2-33c7-449a-b24b-1994a01d6662.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-2623-nc",
        "productVersion" : "7.4.5",
        "hostId" : "3b306029-fa9c-4a89-9f51-0b427caf212c",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:09.360578Z",
        "updatedAt" : "2025-01-11T20:38:09.362581Z",
        "deletedAt" : null,
        "createdBy" : "a307a146-e0e2-492a-888f-b243fff91b9a",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "936e7ab1-2075-429f-987c-b2181d539c30",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/57d6f7a5-8937-41b3-b79a-31ea3c6f140b",
          "title" : "network-2623"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/8fffb8b7-4898-4ca0-b4b5-f14f688f3f0d",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=57d6f7a5-8937-41b3-b79a-31ea3c6f140b"
        }
      }
    }, {
      "id" : "5b60a28b-694e-4d01-831f-b2363dac168d",
      "ownerIdentityId" : "df1bb91e-d326-4cd7-93ff-9c5b68451ee8",
      "createdBy" : "df1bb91e-d326-4cd7-93ff-9c5b68451ee8",
      "createdAt" : "2025-01-11T20:38:08.978812Z",
      "updatedAt" : "2025-01-11T20:38:08.979217Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-2603",
      "networkGroupId" : "9a02c0d7-a490-4b9c-b5da-44e74f0efc07",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "6b2513b3-312b-46b3-b9e2-6acdf1a8cb4b",
        "ownerIdentityId" : "df1bb91e-d326-4cd7-93ff-9c5b68451ee8",
        "networkId" : "5b60a28b-694e-4d01-831f-b2363dac168d",
        "domainName" : "6b2513b3-312b-46b3-b9e2-6acdf1a8cb4b.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-2603-nc",
        "productVersion" : "7.4.5",
        "hostId" : "1fd157e1-8bec-487d-a112-711ac1f2e2b9",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:08.979960Z",
        "updatedAt" : "2025-01-11T20:38:08.982013Z",
        "deletedAt" : null,
        "createdBy" : "df1bb91e-d326-4cd7-93ff-9c5b68451ee8",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "00ac263e-e920-40fd-b795-780df1fe2ca3",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5b60a28b-694e-4d01-831f-b2363dac168d",
          "title" : "network-2603"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/9a02c0d7-a490-4b9c-b5da-44e74f0efc07",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=5b60a28b-694e-4d01-831f-b2363dac168d"
        }
      }
    }, {
      "id" : "5fe203bb-e9eb-4661-b9e5-854e37199c05",
      "ownerIdentityId" : "f091d496-bf2a-4a47-ac55-c627e1e9146c",
      "createdBy" : "f091d496-bf2a-4a47-ac55-c627e1e9146c",
      "createdAt" : "2025-01-11T20:38:09.023579Z",
      "updatedAt" : "2025-01-11T20:38:09.023955Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-2608",
      "networkGroupId" : "70e7f9f5-49bb-4533-a89f-1127c0d882e0",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "e78284b5-d26d-4a87-8428-f812ecb4fb6d",
        "ownerIdentityId" : "f091d496-bf2a-4a47-ac55-c627e1e9146c",
        "networkId" : "5fe203bb-e9eb-4661-b9e5-854e37199c05",
        "domainName" : "e78284b5-d26d-4a87-8428-f812ecb4fb6d.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-2608-nc",
        "productVersion" : "7.4.5",
        "hostId" : "2c5c4d2b-20aa-4d4a-9de4-983e796926b8",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:09.024710Z",
        "updatedAt" : "2025-01-11T20:38:09.026838Z",
        "deletedAt" : null,
        "createdBy" : "f091d496-bf2a-4a47-ac55-c627e1e9146c",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "a7501656-b902-4cf9-ac2c-037b56eb06c2",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5fe203bb-e9eb-4661-b9e5-854e37199c05",
          "title" : "network-2608"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/70e7f9f5-49bb-4533-a89f-1127c0d882e0",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
        }
      }
    }, {
      "id" : "669b8d41-5e62-4573-8a4d-32ea7a479f16",
      "ownerIdentityId" : "fdc9bd5a-ee79-4573-b90b-606d5bf8c536",
      "createdBy" : "fdc9bd5a-ee79-4573-b90b-606d5bf8c536",
      "createdAt" : "2025-01-11T20:38:09.059510Z",
      "updatedAt" : "2025-01-11T20:38:09.059892Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-2613",
      "networkGroupId" : "83825484-c692-4c56-9a93-742e16788a25",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "131610df-d409-4aab-a1d5-64cb2d9e7696",
        "ownerIdentityId" : "fdc9bd5a-ee79-4573-b90b-606d5bf8c536",
        "networkId" : "669b8d41-5e62-4573-8a4d-32ea7a479f16",
        "domainName" : "131610df-d409-4aab-a1d5-64cb2d9e7696.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-2613-nc",
        "productVersion" : "7.4.5",
        "hostId" : "688b497c-bf5b-46f5-9220-4a7f7e52c377",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:09.060658Z",
        "updatedAt" : "2025-01-11T20:38:09.062434Z",
        "deletedAt" : null,
        "createdBy" : "fdc9bd5a-ee79-4573-b90b-606d5bf8c536",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "50a25eba-a123-4fd3-935f-b1746978d1d7",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/669b8d41-5e62-4573-8a4d-32ea7a479f16",
          "title" : "network-2613"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/83825484-c692-4c56-9a93-742e16788a25",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=669b8d41-5e62-4573-8a4d-32ea7a479f16"
        }
      }
    }, {
      "id" : "6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3",
      "ownerIdentityId" : "0bfc4b0e-6f8d-4a41-8480-034add7e34cf",
      "createdBy" : "0bfc4b0e-6f8d-4a41-8480-034add7e34cf",
      "createdAt" : "2025-01-11T20:38:09.364896Z",
      "updatedAt" : "2025-01-11T20:38:09.415470Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "resume-test",
      "networkGroupId" : "527529db-69e4-4d4c-9a22-1c2c1416c428",
      "size" : "small",
      "productVersion" : "7.3.37",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : false,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "38a0bd13-6a1d-4a19-84f2-7f36260bb4c9",
        "ownerIdentityId" : "0bfc4b0e-6f8d-4a41-8480-034add7e34cf",
        "networkId" : "6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3",
        "domainName" : "new-domain.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "resume-test-nc",
        "productVersion" : "7.3.37",
        "hostId" : "fdee2d20-59ef-467d-88a7-772b03c054e5",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:09.365967Z",
        "updatedAt" : "2025-01-11T20:38:09.414670Z",
        "deletedAt" : null,
        "createdBy" : "0bfc4b0e-6f8d-4a41-8480-034add7e34cf",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "c8c555be-fa99-42d3-bede-aeb8975f1877",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3",
          "title" : "resume-test"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/527529db-69e4-4d4c-9a22-1c2c1416c428",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=6a8c9ae3-93fd-43b7-8e40-e9183c1e71c3"
        }
      }
    }, {
      "id" : "70b4e281-6d22-40b3-a974-911a74129377",
      "ownerIdentityId" : "ae3d7f10-d8ee-427a-9689-29418676b387",
      "createdBy" : "ae3d7f10-d8ee-427a-9689-29418676b387",
      "createdAt" : "2025-01-11T20:38:08.589553Z",
      "updatedAt" : "2025-01-11T20:38:08.590552Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-2577",
      "networkGroupId" : "8b114e42-1f0f-4603-8020-d217d5bd777c",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "977f0433-5dcd-4b53-9879-3b88a828b70f",
        "ownerIdentityId" : "ae3d7f10-d8ee-427a-9689-29418676b387",
        "networkId" : "70b4e281-6d22-40b3-a974-911a74129377",
        "domainName" : "977f0433-5dcd-4b53-9879-3b88a828b70f.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-2577-nc",
        "productVersion" : "7.4.5",
        "hostId" : "27bf5487-e07a-4fa9-b6d3-ca5abb14a73d",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:08.591842Z",
        "updatedAt" : "2025-01-11T20:38:08.596083Z",
        "deletedAt" : null,
        "createdBy" : "ae3d7f10-d8ee-427a-9689-29418676b387",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "f80478a8-48d9-413a-87c7-508de86a4af1",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/70b4e281-6d22-40b3-a974-911a74129377",
          "title" : "network-2577"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/8b114e42-1f0f-4603-8020-d217d5bd777c",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=70b4e281-6d22-40b3-a974-911a74129377"
        }
      }
    }, {
      "id" : "748cc6c7-be91-44ea-8918-6be287d6f150",
      "ownerIdentityId" : "b4f5ed19-e4b5-4c9b-b5f2-bb6ae3763798",
      "createdBy" : "b4f5ed19-e4b5-4c9b-b5f2-bb6ae3763798",
      "createdAt" : "2025-01-11T20:38:08.855393Z",
      "updatedAt" : "2025-01-11T20:38:08.855733Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-2598",
      "networkGroupId" : "c6f838ae-ba6d-474b-9d8a-20ac2726fb49",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "7ef91363-55eb-4ed8-8072-b8937e722228",
        "ownerIdentityId" : "b4f5ed19-e4b5-4c9b-b5f2-bb6ae3763798",
        "networkId" : "748cc6c7-be91-44ea-8918-6be287d6f150",
        "domainName" : "7ef91363-55eb-4ed8-8072-b8937e722228.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-2598-nc",
        "productVersion" : "7.4.5",
        "hostId" : "0bf6ac95-594f-4b3a-b62a-785e559a0263",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:08.856401Z",
        "updatedAt" : "2025-01-11T20:38:08.858125Z",
        "deletedAt" : null,
        "createdBy" : "b4f5ed19-e4b5-4c9b-b5f2-bb6ae3763798",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "e3a3e64c-355c-4e9d-9449-6f78aa283822",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/748cc6c7-be91-44ea-8918-6be287d6f150",
          "title" : "network-2598"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/c6f838ae-ba6d-474b-9d8a-20ac2726fb49",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=748cc6c7-be91-44ea-8918-6be287d6f150"
        }
      }
    }, {
      "id" : "954bdbdc-97c1-4c8a-9e55-c8ac382f36ae",
      "ownerIdentityId" : "a234336e-4388-4f07-9026-eff7b5a4d0f4",
      "createdBy" : "a234336e-4388-4f07-9026-eff7b5a4d0f4",
      "createdAt" : "2025-01-11T20:38:08.602491Z",
      "updatedAt" : "2025-01-11T20:38:08.674364Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "suspend-test",
      "networkGroupId" : "700632ab-4f8f-43da-98da-8f9d73bb0585",
      "size" : "small",
      "productVersion" : "7.3.37",
      "region" : "us-east-1",
      "status" : "SUSPENDED",
      "publicCertEnabled" : false,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "65f71c7e-d2dc-40d4-916f-e183e6b0beab",
        "ownerIdentityId" : "a234336e-4388-4f07-9026-eff7b5a4d0f4",
        "networkId" : "954bdbdc-97c1-4c8a-9e55-c8ac382f36ae",
        "domainName" : "65f71c7e-d2dc-40d4-916f-e183e6b0beab.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "suspend-test-nc",
        "productVersion" : "7.3.37",
        "hostId" : "355c1dc1-5cbe-4f18-9bb9-1a5d783cb0fa",
        "status" : "SUSPENDED",
        "createdAt" : "2025-01-11T20:38:08.603535Z",
        "updatedAt" : "2025-01-11T20:38:08.673204Z",
        "deletedAt" : null,
        "createdBy" : "a234336e-4388-4f07-9026-eff7b5a4d0f4",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "d36b0539-408e-494d-8b3a-136141e02fd9",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/954bdbdc-97c1-4c8a-9e55-c8ac382f36ae",
          "title" : "suspend-test"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/700632ab-4f8f-43da-98da-8f9d73bb0585",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=954bdbdc-97c1-4c8a-9e55-c8ac382f36ae"
        }
      }
    }, {
      "id" : "a7e7b2be-1ddc-4480-9adc-2775f4a2568b",
      "ownerIdentityId" : "5f30b64b-3890-4415-8c20-ee423daf0a90",
      "createdBy" : "5f30b64b-3890-4415-8c20-ee423daf0a90",
      "createdAt" : "2025-01-11T20:38:08.724074Z",
      "updatedAt" : "2025-01-11T20:38:08.724429Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-2593",
      "networkGroupId" : "3df11f8a-8caf-4862-87c4-97f463e0fbcc",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "0792dbbd-6f9f-4a68-adef-5d3be315a93f",
        "ownerIdentityId" : "5f30b64b-3890-4415-8c20-ee423daf0a90",
        "networkId" : "a7e7b2be-1ddc-4480-9adc-2775f4a2568b",
        "domainName" : "0792dbbd-6f9f-4a68-adef-5d3be315a93f.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-2593-nc",
        "productVersion" : "7.4.5",
        "hostId" : "bb78be44-7e13-48f8-9bcd-c941c8800882",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:08.725398Z",
        "updatedAt" : "2025-01-11T20:38:08.727385Z",
        "deletedAt" : null,
        "createdBy" : "5f30b64b-3890-4415-8c20-ee423daf0a90",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "16b3e6a8-5869-414a-a531-bd2bdb64a56a",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a7e7b2be-1ddc-4480-9adc-2775f4a2568b",
          "title" : "network-2593"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/3df11f8a-8caf-4862-87c4-97f463e0fbcc",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=a7e7b2be-1ddc-4480-9adc-2775f4a2568b"
        }
      }
    }, {
      "id" : "f8bb498e-ec42-4719-bda5-f3a2698483d2",
      "ownerIdentityId" : "f60fcc2b-c166-48a2-9c63-169a4dc42403",
      "createdBy" : "f60fcc2b-c166-48a2-9c63-169a4dc42403",
      "createdAt" : "2025-01-11T20:38:09.484666Z",
      "updatedAt" : "2025-01-11T20:38:09.485042Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "network-2639",
      "networkGroupId" : "1d61fdcd-d4af-401d-b9c7-5fe268dc9c6c",
      "size" : "small",
      "productVersion" : "7.4.5",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : true,
      "haEnabled" : false,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "d1c1cbe4-ae8f-4b38-a63a-248027af7b8d",
        "ownerIdentityId" : "f60fcc2b-c166-48a2-9c63-169a4dc42403",
        "networkId" : "f8bb498e-ec42-4719-bda5-f3a2698483d2",
        "domainName" : "d1c1cbe4-ae8f-4b38-a63a-248027af7b8d.nf.io",
        "alternateDomainName" : null,
        "port" : 443,
        "name" : "network-2639-nc",
        "productVersion" : "7.4.5",
        "hostId" : "40df8f6a-01a9-4b9a-89b2-d116245ce8dd",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:09.485907Z",
        "updatedAt" : "2025-01-11T20:38:09.487874Z",
        "deletedAt" : null,
        "createdBy" : "f60fcc2b-c166-48a2-9c63-169a4dc42403",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "dd0ce869-8a6f-4223-b377-9d9feb5a6152",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f8bb498e-ec42-4719-bda5-f3a2698483d2",
          "title" : "network-2639"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/1d61fdcd-d4af-401d-b9c7-5fe268dc9c6c",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=f8bb498e-ec42-4719-bda5-f3a2698483d2"
        }
      }
    }, {
      "id" : "fdb12d0c-e808-494f-b85a-88d2a7498811",
      "ownerIdentityId" : "9e28b78b-2413-47da-b847-849dc83b702c",
      "createdBy" : "9e28b78b-2413-47da-b847-849dc83b702c",
      "createdAt" : "2025-01-11T20:38:09.087026Z",
      "updatedAt" : "2025-01-11T20:38:09.213850Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Upload Test Network",
      "networkGroupId" : "83825484-c692-4c56-9a93-742e16788a25",
      "size" : "small",
      "productVersion" : "7.3.18",
      "region" : "us-east-1",
      "status" : "PROVISIONED",
      "publicCertEnabled" : false,
      "haEnabled" : true,
      "dnsZoneId" : null,
      "o365BreakoutCategory" : "NONE",
      "networkController" : {
        "id" : "df8f0c0f-ad87-46a7-8e36-9986b5b73bd0",
        "ownerIdentityId" : "9e28b78b-2413-47da-b847-849dc83b702c",
        "networkId" : "fdb12d0c-e808-494f-b85a-88d2a7498811",
        "domainName" : "b59ee924-d318-494f-8bbb-3f312ad1b16d.sandbox.netfoundry.io",
        "alternateDomainName" : null,
        "port" : 8443,
        "name" : "Upload Test Network-NC",
        "productVersion" : "7.3.18",
        "hostId" : "216f2217-bd42-4252-b02f-2f7ef033c283",
        "status" : "PROVISIONED",
        "createdAt" : "2025-01-11T20:38:09.092926Z",
        "updatedAt" : "2025-01-11T20:38:09.160760Z",
        "deletedAt" : null,
        "createdBy" : "9e28b78b-2413-47da-b847-849dc83b702c",
        "deletedBy" : null,
        "softwareDeploymentStateId" : "708a374e-7b4f-48df-9019-76d5719feac3",
        "haPrimaryNode" : true
      },
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/fdb12d0c-e808-494f-b85a-88d2a7498811",
          "title" : "Upload Test Network"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/83825484-c692-4c56-9a93-742e16788a25",
          "profile" : "parent"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
          "profile" : "parent"
        },
        "service-edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "external-jwt-signers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "auth-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "service-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "process-executions" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "config-types" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "hosts" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "terminators" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "configs" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "posture-checks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "network-controllers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        },
        "clusters" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/clusters?networkId=fdb12d0c-e808-494f-b85a-88d2a7498811"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 14,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Network (deprecated)

GET /v2/networks/{id}

Deprecated. In favor of the size property on the network controller, will be deleted 1/1/2023.

@deprecated in favor of the size property on the network controller, will be deleted 1/1/2023.

See Network Controllers.

Authorization

This endpoint requires read action on the network resource type.

Path parameters

Parameter Type Optional Description

id

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

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/5fe203bb-e9eb-4661-b9e5-854e37199c05' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJYWVRaeVQxSnlyQWYwa3Z0OWhReXRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk0ZDNhODAxLThhMTgtNDdkNS04YjJiLTU0YTE4NGU2MjI0YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg4OSwiZXhwIjoxNzM2NjMxNDg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjZmYjQzNmNhLWI0ZjAtNDliZC1hYWEzLTQyNTgxYjcwMjg1ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.m3JC_RddE5WWo8WXli0sb_Y0WITwzpOAo5FKcPM1s8QFe8mSBFpyfJIA8rUAfRjAwKHuy4k3ROyh5Lu8P24QlvwZ3THrZNy7T4u0ANRKrLMjytNXg_lWzxM7hAooO6DeCgwk0f7LUKgMAtQ_FLSE1S-MxNeleXdoQO5b4fqWY-k6NMf_8CsWJxf77iaABrIuFhGzCFql-9L4UVDz6fHUu5nY9mx3jm6DNPt5f0-CBxJTMOfBI1ftDuokWODOhWqK_twyGDkAAVcal48J1f2ZVmio-tiIMoZ-KrkbDjCAKpOwIonccY7exbCxPxB4pcZaxQYHkrXFclG9vpoNQ2QE4A'

Example response

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

{
  "id" : "5fe203bb-e9eb-4661-b9e5-854e37199c05",
  "ownerIdentityId" : "f091d496-bf2a-4a47-ac55-c627e1e9146c",
  "createdBy" : "f091d496-bf2a-4a47-ac55-c627e1e9146c",
  "createdAt" : "2025-01-11T20:38:09.023579Z",
  "updatedAt" : "2025-01-11T20:38:09.023955Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "network-2608",
  "networkGroupId" : "70e7f9f5-49bb-4533-a89f-1127c0d882e0",
  "size" : "small",
  "productVersion" : "7.4.5",
  "region" : "us-east-1",
  "status" : "PROVISIONED",
  "publicCertEnabled" : true,
  "haEnabled" : false,
  "dnsZoneId" : null,
  "o365BreakoutCategory" : "NONE",
  "networkController" : {
    "id" : "e78284b5-d26d-4a87-8428-f812ecb4fb6d",
    "ownerIdentityId" : "f091d496-bf2a-4a47-ac55-c627e1e9146c",
    "networkId" : "5fe203bb-e9eb-4661-b9e5-854e37199c05",
    "domainName" : "e78284b5-d26d-4a87-8428-f812ecb4fb6d.nf.io",
    "alternateDomainName" : null,
    "port" : 443,
    "name" : "network-2608-nc",
    "productVersion" : "7.4.5",
    "hostId" : "2c5c4d2b-20aa-4d4a-9de4-983e796926b8",
    "status" : "PROVISIONED",
    "createdAt" : "2025-01-11T20:38:09.024710Z",
    "updatedAt" : "2025-01-11T20:38:09.026838Z",
    "deletedAt" : null,
    "createdBy" : "f091d496-bf2a-4a47-ac55-c627e1e9146c",
    "deletedBy" : null,
    "softwareDeploymentStateId" : "a7501656-b902-4cf9-ac2c-037b56eb06c2",
    "haPrimaryNode" : true
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5fe203bb-e9eb-4661-b9e5-854e37199c05",
      "title" : "network-2608"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/70e7f9f5-49bb-4533-a89f-1127c0d882e0",
      "profile" : "parent"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "external-jwt-signers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "auth-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=5fe203bb-e9eb-4661-b9e5-854e37199c05"
    }
  }
}

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

{@link Config}s referenced by id in this property will be applied to the created {@link Service}. Note, only existing, non-exclusive {@link Config}s may be referenced via this property. {@link Config}s applied via this property and the {@link #configNames} and {@link #configs} properties must not conflict. That is, each must be of a different {@link ConfigType}. Applying {@link Config}s to a service via this {@link #configIds}, {@link #configNames} or {@link #configs} are mutually exclusive to a model based {@link Service}. Setting any of these three properties while also specifying a {@link #model} will result in an error.

services[].configNames

Array[String]

true

{@link Config}s referenced by name in this property will be applied to the created {@link Service}. Note, only existing, non-exclusive {@link Config}s may be referenced via this property. {@link Config}s applied via this property and the {@link #configIds} and {@link #configs} properties must not conflict. That is, each must be of a different {@link ConfigType}. Applying {@link Config}s to a service via this {@link #configNames}, {@link #configIds} or {@link #configs} are mutually exclusive to a model based {@link Service}. Setting any of these three properties while also specifying a {@link #model} will result in an error.

services[].configs

Array[Object]

true

{@link Config}s created via this property will be applied to the created {@link Service}. Each entry is this property must be a valid {@link CreateConfig} directive, and the created {@link Config} will be marked as exclusive to the created {@link Service}. This will create exclusive {@link Config}s. If the intent is to create a shared {@link Config}, then it must be created separately, then referenced via either {@link #configIds} or {@link #configNames}. {@link Config}s applied via this property and the {@link #configIds} and {@link #configs} properties must not conflict. That is, each must be of a different {@link ConfigType}. Applying {@link Config}s to a service via this {@link #configs}, {@link #configIds} or {@link #configNames} are mutually exclusive to a model based {@link Service}. Setting any of these three properties while also specifying a {@link #model} will result in an error.

services[].configs[].networkId

String

true

Specifies the id of the {@link Network} within which the resulting {@link Config} should be created.

services[].configs[].name

String

true

Specifies the name to assign to the {@link Config}.

services[].configs[].configTypeId

String

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have by the id of that {@link ConfigType}. The referenced {@link ConfigType} must exist, be in a valid state for use, and not be 'exclusive' or otherwise reserved by some other resource. This method of specifying the {@link ConfigType} is mutually exclusive with name and embedded create based declarations.

services[].configs[].configTypeName

String

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have by the name of that {@link ConfigType}. The referenced {@link ConfigType} must exist, be in a valid state for use, and not be 'exclusive' or otherwise reserved by some other resource. This method of specifying the {@link ConfigType} is mutually exclusive with id and embedded create based declarations.

services[].configs[].configType

Object

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have. The form of this {@link ConfigType} declaration is an embedded "command" to create a {@link ConfigType}. The resulting {@link ConfigType} instance will only be usable by this {@link Config} and it will be deleted when this {@link Config} is deleted. This method of specifying the {@link ConfigType} is mutually exclusive with id and name based declarations.

services[].configs[].configType.networkId

String

true

Specifies the id of the {@link Network} within which the resulting {@link ConfigType} should be created.

services[].configs[].configType.name

String

true

Specifies the name to assign to the {@link ConfigType}.

services[].configs[].configType.schema

Object

true

Specifies the JSON Schema to assign to the {@link ConfigType}.

services[].configs[].data

Object

true

Specifies the data to assign to the {@link Config}.

services[].attributes

Array[String]

true

The contained attributes will be applied to the created Service.

services[].modelType

String

true

If intending to create a model driven {@link Service}, then this property must be set to the type of model desired and must match the schema of the {@link #model} property. This property and {@link #model} are covariant. Either set both or neither.

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

services[].model

Object

true

If intending to create a model driven {@link Service}, then this property must be set with the desired model data which must match the type indicated by {@link #modelType}. This property and {@link #modelType} are covariant. Either set both or neither.

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

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

endpoints[].name

String

true

A display name allowing whitespace for the endpoint.

endpoints[].enrollmentMethod

Object

true

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

endpoints[].enrollmentMethod.ott

Boolean

true

endpoints[].enrollmentMethod.updb

String

true

endpoints[].enrollmentMethod.ottca

String

true

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

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

postureChecks[].data.promptOnWake

Boolean

true

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

postureChecks[].data.promptOnUnlock

Boolean

true

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

postureChecks[].data.ignoreLegacyEndpoints

Boolean

true

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

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 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/networks' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJVUUNvNk9WRjZrcldRbm5YejJfR0xnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRjYmZkZDlmLWJlNGQtNDU2ZS1iZjhmLTFjYzFkNjc5YjgwYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg5MCwiZXhwIjoxNzM2NjMxNDkwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjI0ZDgyMDZjLTczODQtNDBiMi04YmY5LWVjZmFiOWFiZWY0MFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg5MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.MbHBq-PKFG590b8hUC2dgmxXQY5qOhzd7_aemUkwIy8MbW19bfzKqmGEg5bkPmK7fKbNlUcR53ou1R0UHxtCpOe8WFyGyAIpoJ_OmkQru0EltmGUn5S5Bbyew5ZjqQsO1wRTGV9MGVrRqr_QvQClXgPVDz-Jd31MvhilivPZMvp0y7S8lyH-rAssBRsU37I6Do7Hp8QFeCWFNIb6MRQToPoiGZ-3yEt-j_ogwRe7wRhjjK6UGDZRiT64aGPWTTEGPgQnSASufXfZOglr9M8SqhbbfzRB0aFUx02LeGWKWRbJArvfQYue4Dv4Y3F4k-5emlUJhVQo3s92CShP51z7hg' \
    -d '{"networkGroupId":"08026c46-a14e-4e95-81b0-9e1b534ec6cf","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" : "3d31c9f4-98ff-40de-b3b3-551f258e2752",
  "ownerIdentityId" : "dcbfdd9f-be4d-456e-bf8f-1cc1d679b80a",
  "createdBy" : "dcbfdd9f-be4d-456e-bf8f-1cc1d679b80a",
  "createdAt" : "2025-01-11T20:38:10.095653Z",
  "updatedAt" : "2025-01-11T20:38:10.095653Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Create Test Network",
  "networkGroupId" : "08026c46-a14e-4e95-81b0-9e1b534ec6cf",
  "size" : "small",
  "productVersion" : "7.3.18",
  "region" : "us-east-1",
  "status" : "PROVISIONING",
  "publicCertEnabled" : false,
  "haEnabled" : false,
  "dnsZoneId" : null,
  "o365BreakoutCategory" : "NONE",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3d31c9f4-98ff-40de-b3b3-551f258e2752",
      "title" : "Create Test Network"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/08026c46-a14e-4e95-81b0-9e1b534ec6cf",
      "profile" : "parent"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "external-jwt-signers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "auth-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=3d31c9f4-98ff-40de-b3b3-551f258e2752"
    }
  }
}

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

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

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/85b6bcca-5482-42ba-bb64-06808e9dec44' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ3LVd6bTVNX3NFMkp4bm1nYnFSeWR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNiZWFjOThlLTJiYzctNDI3NS1iNjgwLTk4MTc1MDQ0MDYwNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg5MCwiZXhwIjoxNzM2NjMxNDkwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM2ODhmOGJlLWVhYjYtNDAwYS05NjU5LTI2NDZmYmQ2M2U3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg5MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.nkGkWVOor3dovUFZsHOnhAz4KahScs26Pq4TdjxhvX8zTvuiCV07C2WRQmav7kwSJYVvdMrvvg2xQ7pcxlyjKOIq6QDpTcKmb2erD74HpVDD_mLlZdczZvhJGUqFvgvAaUADs1wF2MNRSp4BDkCpg5sG16Qa7t0Dpyj_BTevzoCDe9z1zeau0_PN-Kf-qEbQ9_BG708Hmc493WXczblUtGOXQGrRk9TdYj0XofUrAKn6_rG69yAvXQAUOB0K66zv36GgVgd4oNcV2pWgJNiOr7RdF1NB05yU2KDgvZa_zglaQIbiPFcNCOehR697OP1K7iScGsaWdLw7MgfklyY9Ig'

Example response

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

{
  "id" : "85b6bcca-5482-42ba-bb64-06808e9dec44",
  "ownerIdentityId" : "90fd923f-ee0d-42ec-a80b-5859439c218b",
  "createdBy" : "90fd923f-ee0d-42ec-a80b-5859439c218b",
  "createdAt" : "2025-01-11T20:38:10.690006Z",
  "updatedAt" : "2025-01-11T20:38:10.704486Z",
  "deletedBy" : "3beac98e-2bc7-4275-b680-981750440605",
  "deletedAt" : null,
  "name" : "network-2735",
  "networkGroupId" : "ae141db3-6912-45b4-90c3-12283bcf9efe",
  "size" : "small",
  "productVersion" : "7.4.5",
  "region" : "us-east-1",
  "status" : "DELETING",
  "publicCertEnabled" : true,
  "haEnabled" : false,
  "dnsZoneId" : null,
  "o365BreakoutCategory" : "NONE",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/85b6bcca-5482-42ba-bb64-06808e9dec44",
      "title" : "network-2735"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/ae141db3-6912-45b4-90c3-12283bcf9efe",
      "profile" : "parent"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks",
      "profile" : "parent"
    },
    "service-edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "external-jwt-signers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "auth-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "service-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "process-executions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "config-types" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "hosts" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "terminators" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "posture-checks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    },
    "network-controllers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=85b6bcca-5482-42ba-bb64-06808e9dec44"
    }
  }
}

Network Controllers

Get Network Controller (deprecated)

GET /v2/network-controllers/{id}

Deprecated. Use deletedAt instead, will be deleted 1/1/2023.

@deprecated use deletedAt instead, will be deleted 1/1/2023.

See Network Controllers.

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/network-controllers/0064531f-fab3-4a09-b731-c284d1d05610' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvZVdjREZRai1HSy1MTm0xbWZBUTVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRkODJmNWE2LWY4MzgtNDcyNS05Nzg5LTU4N2M4MTU1YjEyYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NCwiZXhwIjoxNzM2NjMxNDc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImIyNzFlNGU5LTA2ZWMtNDIwYS1hZWUwLTQ5MmNjMzgwNjE4M1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.cMM01ew_CAx-Ujz47G9ZT1PfnBRU0-U8OZ1cCCdtYMoIq4v4q6HrN7pkiKouxbPdmTjfZU0k89tRqtP8ORN10zmlrlkHHbOqTw_UA8BRx2JCGicOxJ8GBGZHv7eB9iF3ttUIh7oTVG9_Lg70M2CvdAe0TKoL7vbGToqclkEPGpnzgojmj9vNjuqo4MMLLCODwXefR6O7WM4DZJLXnpU8mPb4nPzZhMchEdIGZQGivUgbS2scQjUMDAp3zft1XXTdGtaI6o5hcnvsKf5RoS7nQmoY9ZF44jC-78HXfXM02bu0FjLpAy_OKxm0wEX1N4a8EiBiiywWf16epuTeZB_Wew'

Example response

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

{
  "id" : "0064531f-fab3-4a09-b731-c284d1d05610",
  "ownerIdentityId" : "799c6d48-99a4-458d-a59e-0f792a9dca43",
  "networkId" : "a4e636ef-2ade-4cb2-a53c-fea373fabe3e",
  "domainName" : "new-domain.nf.io",
  "alternateDomainName" : null,
  "port" : 443,
  "name" : "networkcontroller-controller-test-nc",
  "productVersion" : "7.3.37",
  "hostId" : "cdca4282-9e89-487f-8d53-1e5a1d6376a1",
  "status" : "PROVISIONED",
  "createdAt" : "2025-01-11T20:37:54.154456Z",
  "updatedAt" : "2025-01-11T20:37:54.432188Z",
  "deletedAt" : null,
  "createdBy" : "799c6d48-99a4-458d-a59e-0f792a9dca43",
  "deletedBy" : null,
  "softwareDeploymentStateId" : "50e42ab8-dcbd-4499-a5ba-25d22db2b84c",
  "haPrimaryNode" : true,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a4e636ef-2ade-4cb2-a53c-fea373fabe3e",
      "profile" : "parent"
    },
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/50e42ab8-dcbd-4499-a5ba-25d22db2b84c"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/0064531f-fab3-4a09-b731-c284d1d05610",
      "title" : "networkcontroller-controller-test-nc"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/cdca4282-9e89-487f-8d53-1e5a1d6376a1"
    },
    "softwareDeploymentState" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/50e42ab8-dcbd-4499-a5ba-25d22db2b84c",
      "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

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/network-controllers/69a120d0-a2df-4831-bec5-a96180431f23/session' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJNYzNKS2VKN2s0NGh5MUNHMmlXMzN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIwNTRhZDRkLTFlZjUtNGRkNy1iMTYzLWMyOWYwNTY3MzkyMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3MiwiZXhwIjoxNzM2NjMxNDcyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZiM2ZkYTgyLWVmZDgtNGYyZC1hNGVjLWQ1YTMwMThmODUzMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.PWFu0Ql87VIm7wt074YBkdddPuAFAgH7_vq-myWHywicASBj4JyJ4iC-PUIb8uYfaKcoqlxsnu4sgBULwfhAwknnpzwIzhb1TDeEl1QPyHpBVcOlY3HauOr0LRrajUBilHdP0uS2mqtL30u3APnjtTS5yfVi6xqFbGa_XxCdZFOEInIA3Xf9R7_302rOWOUn0CycFPXs9uAz6F-ptGPDi0TlqE5jNFBeCvjxLptf4IdBHJrT_J3wVsEUgl_RXoqv9nA_EzbxYPJqJiOkG4RXqOMcU0xfqavpT21QAZLxrSqgdkKmRgb5-6u8-tFmayeiVHKlHoeo8FBZzd1C9Pf7Yg'

Example response

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

{
  "sessionToken" : "--- session ---",
  "expiresAt" : "2025-01-11T20:37:52.650+00:00",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/69a120d0-a2df-4831-bec5-a96180431f23/session"
    },
    "parent" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/69a120d0-a2df-4831-bec5-a96180431f23"
    }
  }
}

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

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

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

Contains the {@link ZitiIdentity} of the ziti tunnel that is running co-located to this controller process on this controller’s host, or null if there is no such tunnel, this resource was obtained not on an HTTP request thread, or the HTTP request does not have a 'beta' query parameter on it. This property may be stripped from the response if the client making the request does not have update permission on this network controller.

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%3D2025-01-11T19:36:35.397151505Z' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJlX01UZU9GSmRMeXlxalBEeXZkbWlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUyM2Y5Zjc4LTk5NmItNGFkZS05OGJlLWU0MGUwOTZmMWExMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5NSwiZXhwIjoxNzM2NjMxMzk1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImU0MmY1M2JmLTc5YTYtNDQ0ZS04ZGNhLWY1MTc1NjA2YTM1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.sFnYLA487WuG-PXIWDf5ACrxEIoPr_9cjlANn_fWnHSF2kyJoGJjIwQxF-tc5MowymNngTUT1kdsKu2NgV--hi4MuaDncPHZss3o2tZTb7pDhkOoOthQuRRz2C-3vijFmFq9xOYhDrr53c_evN6pa7GsCkgmPPVthjxJsnGKBTiwXTWW4aDq-6oZR7eLabEkiRd8QYlQYOqNnDiKZkJjOWvWG7WGIG_-RM6PPRItloRgyLfM04BuhthcIf9P36uZvl_oMx-4pEBejRUlRSgn5kpAsETSvLpBl1GjcUyZmxgTPlMcJdiOJ_tBbFPkXpE7kk3_W1uNrf5S-bT5XrSLZQ'

Example response

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

{
  "_embedded" : {
    "networkControllerList" : [ {
      "id" : "3b4f37c0-ff33-48d4-bc9a-e21dc71f93a3",
      "ownerIdentityId" : "0686b09b-634c-47a4-93fa-bfc52539f2d0",
      "networkId" : "b0ea7f02-ed9f-4d4e-8e93-a9c856960d17",
      "domainName" : "hisizIEw3kEB75jRlKCOR.fake.com",
      "alternateDomainName" : null,
      "port" : 443,
      "name" : "NetworkController Find Test 1 - NC",
      "productVersion" : "7.3.37",
      "hostId" : "7f088866-e1ca-41ff-9574-5edbd5daf2fa",
      "status" : "PROVISIONED",
      "createdAt" : "2025-01-11T20:36:35.348501Z",
      "updatedAt" : "2025-01-11T20:36:35.348501Z",
      "deletedAt" : null,
      "createdBy" : "0686b09b-634c-47a4-93fa-bfc52539f2d0",
      "deletedBy" : null,
      "softwareDeploymentStateId" : null,
      "haPrimaryNode" : true,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b0ea7f02-ed9f-4d4e-8e93-a9c856960d17",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/3b4f37c0-ff33-48d4-bc9a-e21dc71f93a3",
          "title" : "NetworkController Find Test 1 - NC"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/7f088866-e1ca-41ff-9574-5edbd5daf2fa"
        }
      }
    }, {
      "id" : "f71523b2-516e-4d66-9bf4-6afb356a6d5e",
      "ownerIdentityId" : "0686b09b-634c-47a4-93fa-bfc52539f2d0",
      "networkId" : "92db09a3-33d5-4d8c-bec8-fc92e5ad09d5",
      "domainName" : "OPiGLbBBy6DO-S9KbNXvo.fake.com",
      "alternateDomainName" : null,
      "port" : 443,
      "name" : "NetworkController Find Test 2 - NC",
      "productVersion" : "7.3.37",
      "hostId" : "c35590fb-ad6c-47bf-8235-aeff1aebf6c8",
      "status" : "PROVISIONING",
      "createdAt" : "2025-01-11T20:36:35.366738Z",
      "updatedAt" : "2025-01-11T20:36:35.366738Z",
      "deletedAt" : null,
      "createdBy" : "0686b09b-634c-47a4-93fa-bfc52539f2d0",
      "deletedBy" : null,
      "softwareDeploymentStateId" : null,
      "haPrimaryNode" : true,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/92db09a3-33d5-4d8c-bec8-fc92e5ad09d5",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/f71523b2-516e-4d66-9bf4-6afb356a6d5e",
          "title" : "NetworkController Find Test 2 - NC"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/c35590fb-ad6c-47bf-8235-aeff1aebf6c8"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?createdAt=%3E%3D2025-01-11T19:36:35.397151505Z"
    }
  },
  "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

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.eyJqdGkiOiJqMFBtZ25UNUY5ZkVSRDBULVdsRHFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA2MmVkOTYzLThiMTItNDZhOC05NWMxLWU3MTc4MTJkNjljMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3MywiZXhwIjoxNzM2NjMxNDczLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImU4NDg5YTcwLTM2OTktNGZlYi05ZDFmLTIyMDNjYWU0Nzk3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.XZ5HblR6SX1B0qF2wQbmlZjILyyZVIpF2TkE-JHjWz90ccQBtRHuvnISsnrn3_5ksZq04gc7P8F1P2VwxStnGcP1h8dLgH_HUENUn3kzGOYP0uqTH6Vru9lsSNIIcv8mMDRFhkDLn8K9lRcyR-clMvFhL8rGKozjFTHPwKfMphJrH7HBaM-uEkO1JUD1S8-jK9KeoYhvllUKPXVjRnlULZ7tiLtbxfOFzdaPC9TR8vhdAw2z0Hv-QYXGyKErR9Uad4Ke-ifFlB2hHrMdVsQlydNtvgoksrSh5a_Rwbc8Gndnj8GQzmd_bMvf2hPbCnZrxrxRIn5CT7B3z4bE30LFkg' \
    -d '{"networkId":"a4e636ef-2ade-4cb2-a53c-fea373fabe3e","name":"controller-2149","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" : "e0d61df7-a0d2-4c5b-a2f6-7b18eb410f44",
  "ownerIdentityId" : "062ed963-8b12-46a8-95c1-e717812d69c1",
  "networkId" : "a4e636ef-2ade-4cb2-a53c-fea373fabe3e",
  "domainName" : null,
  "alternateDomainName" : null,
  "port" : 8443,
  "name" : "controller-2149",
  "productVersion" : "7.4.5",
  "hostId" : null,
  "status" : "PROVISIONING",
  "createdAt" : "2025-01-11T20:37:53.898001Z",
  "updatedAt" : "2025-01-11T20:37:53.898001Z",
  "deletedAt" : null,
  "createdBy" : "062ed963-8b12-46a8-95c1-e717812d69c1",
  "deletedBy" : null,
  "softwareDeploymentStateId" : null,
  "haPrimaryNode" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a4e636ef-2ade-4cb2-a53c-fea373fabe3e",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/e0d61df7-a0d2-4c5b-a2f6-7b18eb410f44",
      "title" : "controller-2149"
    }
  }
}

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

id

Object

false

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

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/69a120d0-a2df-4831-bec5-a96180431f23' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfNVVSZWd2YlNrNWxtUVYxOERSRG13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgwMjY4NGYwLWUwMzctNDU3Ny05MWU5LWNkNTAzYTg1YThlZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NCwiZXhwIjoxNzM2NjMxNDc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjkxYmIzODBmLWZlOTQtNGRhNy1iM2JiLTk4NGVjZjhkNDAyNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.EAqK1P8h13fVaLNR95hmxIWZUVfuEKdSNbnyX1Eo0zm98acZn234lbVJqcnNDBESxworFGXMc3LBiYfLXOLHqmvBYVOTBy_3rNtWhw7Bbq9qlctsNeWAYvcA_vH4H_EmiswZGl_SIZsXMTfMm4eb36mXqvjyIr26yjhC2qQBy0S8O5lofCLFX4wO-cBiFCRrSev-nkQloXpvVCKNXDF1VVu7XDl2s4DrVESfmy3d45gttRXPLM1VPMuMl_39pcXaC-YRiOdbTZKkcv0PWsz7hWLkDZG9RsY9ZNna-HGYbVDfHBx9eYjm8DurOA4GovMOM7Dp5S_wpvECLpd-dpAvEA' \
    -d '{"name":"updatedControllerName-2172"}'

Example response

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

{
  "id" : "69a120d0-a2df-4831-bec5-a96180431f23",
  "ownerIdentityId" : "799c6d48-99a4-458d-a59e-0f792a9dca43",
  "networkId" : "a4e636ef-2ade-4cb2-a53c-fea373fabe3e",
  "domainName" : "new-domain.nf.io",
  "alternateDomainName" : null,
  "port" : 443,
  "name" : "updatedControllerName-2172",
  "productVersion" : "7.3.37",
  "hostId" : "86d7921d-0860-4310-bd8b-9bd57edb658b",
  "status" : "PROVISIONED",
  "createdAt" : "2025-01-11T20:37:52.302661Z",
  "updatedAt" : "2025-01-11T20:37:54.125137Z",
  "deletedAt" : null,
  "createdBy" : "799c6d48-99a4-458d-a59e-0f792a9dca43",
  "deletedBy" : null,
  "softwareDeploymentStateId" : "8e9a4c22-cba9-4b49-b8a7-f04a34b18743",
  "haPrimaryNode" : true,
  "managementZitiIdentity" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a4e636ef-2ade-4cb2-a53c-fea373fabe3e",
      "profile" : "parent"
    },
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/8e9a4c22-cba9-4b49-b8a7-f04a34b18743"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/69a120d0-a2df-4831-bec5-a96180431f23",
      "title" : "updatedControllerName-2172"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/86d7921d-0860-4310-bd8b-9bd57edb658b"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/d296bfbb-9751-4d7c-868a-ab817d2df9ce",
      "title" : "Update NetworkController",
      "profile" : "meta"
    },
    "softwareDeploymentState" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/8e9a4c22-cba9-4b49-b8a7-f04a34b18743",
      "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

id

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

os

String

true

osRelease

String

true

osVersion

String

true

externalId

String

true

A value that a system external to Ziti can set or update to contain a unique key to identify that identity. The value can be used by External JWT Signers to match JWT subject (or other claim) to the target identity. Introduced in Ziti version 0.25.4.

authPolicyId

String

true

The optional id of an {@link AuthPolicy} which is assigned to this Endpoint, if one is assigned. If no specific {@link AuthPolicy} is assigned then Ziti uses a built in (backward compatible) default. This property can be set at creation and updated at will. Introduced in Ziti version 0.25.4.

disabled

Boolean

true

A disabled endpoint can not use the network. Introduced in Ziti version 0.25.4; immutable and false prior to supported version.

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

managedBy

String

true

jwtExpiresAt

String

true

jwt

String

true

online

Boolean

true

mfaEnabled

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDRHJEMjUwZ2NPQWhac3I0M0RxVjZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ0NTZkMWExLTU4ZjItNDQ3Mi1hYzJkLTg2NWRlYmQ5MDliOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwNCwiZXhwIjoxNzM2NjMxNTA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImMzYjk2OWJhLTFjZDUtNGE0YS1iNmU1LTE1MTYxYWIwYWZhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.KOvGyVdhlRWjyDueqWjPIb2kdKeJIwVjYJTGqyb7yccUPk3mMVjoEX6ctgIThCJ2pu-QOcWEJYFMBVY8th_fdNx3eIPI-b4C-qBOsSsRokHC6flx1idUl6ljWtCpyfflIPuUsWLUb8xyjTjWb4F1GPiQr1zxWSpHAd6QQGsXaxRH3k-ZNwi5vcn6duElfBVHEKqeiLJ_EOtis8ZB3Z3lFmR_zs_4fGd26uUBo4bjufWjlrce3DwaIFOdR6SVW1OAgOUW5IIoTE6bNF5mLSrcFyeBn5Jqe_4Oo-gDM5fMufvcsfvrikrHrRkKd4_UZeDyM4Tp3uqtFYrPmpF2xIA1nQ'

Example response

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

{
  "_embedded" : {
    "endpointList" : [ {
      "id" : "b69aaa32-a59f-45e8-8c44-72a49e6342de",
      "ownerIdentityId" : "cbb83a91-b005-4fe4-b0ae-c3c91f8e0eaa",
      "createdBy" : "cbb83a91-b005-4fe4-b0ae-c3c91f8e0eaa",
      "createdAt" : "2025-01-11T20:38:24.630874Z",
      "updatedAt" : "2025-01-11T20:38:24.630874Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "5c4e7895-4928-432a-8702-9886955b4d90",
      "zitiId" : "ziti-id-2830",
      "name" : "endpoint-2831",
      "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" : [ ],
      "managedBy" : "Unmanaged",
      "jwtExpiresAt" : null,
      "jwt" : null,
      "online" : false,
      "mfaEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5c4e7895-4928-432a-8702-9886955b4d90",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/b69aaa32-a59f-45e8-8c44-72a49e6342de",
          "title" : "endpoint-2831"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Endpoint (deprecated)

GET /v2/endpoints/{id}

Deprecated. Use attribute instead, will be deleted 1/1/2023.

@deprecated use attribute instead, will be deleted 1/1/2023.

See Endpoints.

Authorization

This endpoint requires read action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

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/4142ef7b-f86c-43b8-a413-32bf26c0aa9c' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiItZU82Y0Ria3lKMWJfaXJVdndGNnlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQzYWM2ODI4LWY4ZTgtNGRhZC1hYzA0LWJhZTMxNDRmYzU2MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwNSwiZXhwIjoxNzM2NjMxNTA1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImE1NDgxMmViLTAyNWItNGU0Mi1hNWFjLTkyZjYzMGY2MjFkNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.gbAD-nhZGzEhq51j8Pdq92SXkE4rmhl35H2_k0coHy1Ujx7TQW0lBI_dypeAyuYKNZYuMgzKIWEW9dxAgTrxLwdhrCHdLUPSVvaBWITx-U9up4wxuZaFyXXEYzF1NJPAtL4XR-SqSnSWJfaY1y3_0a2V0ALe3xMVItngqwaK3kcNhcOLwiycostY8wLb8aRBlqzSUm52tiRrb7fL0ojLQfQABONSAKUEYOqKah7uRDPvG_FhPnpSxSbV4oFm19mD3SIDUCqRNPSz16IY35UUVoMlvWlelhMnJGmo2Qu4oD5ipEH1p51LPExWK84VgFnQnt197Corwl1O_iHFbmniSA'

Example response

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

{
  "id" : "4142ef7b-f86c-43b8-a413-32bf26c0aa9c",
  "ownerIdentityId" : "09181c88-9d42-4223-8a6f-8ce5cb749725",
  "createdBy" : "09181c88-9d42-4223-8a6f-8ce5cb749725",
  "createdAt" : "2025-01-11T20:38:25.136977Z",
  "updatedAt" : "2025-01-11T20:38:25.136977Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "b5621c42-c653-463a-bcb2-b61cb8a71e22",
  "zitiId" : "ziti-id-2887",
  "name" : "endpoint-2888",
  "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" : [ ],
  "managedBy" : "Unmanaged",
  "jwtExpiresAt" : null,
  "jwt" : null,
  "online" : false,
  "mfaEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b5621c42-c653-463a-bcb2-b61cb8a71e22",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/4142ef7b-f86c-43b8-a413-32bf26c0aa9c",
      "title" : "endpoint-2888"
    }
  }
}

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

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints?mfaEnabled=true' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvTHA0a0E3aUtRWnpka0VYTlFjd3RBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZhZmY3NTkwLTJiMzItNDEyYi04OTcxLTM3NGQ2NDE4YzY0MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc2NCwiZXhwIjoxNzM2NjMxMzY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ1YWUxNjUwLTBiOGUtNGEyZS04ZDg4LWY5YzUwYWEyMzA1N1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.S2BobJpgYL56xRXjCw8x_y2XKy26dKOm7pAMW0SfVF6bdIhJHsyhj91mcyJJxB4OWzQ-vxwwVp_EjKWgHLp8AbLqLKrJ0w3CnNmNo1_PmW0F9d1JIv7br95BW5d9vv7BqNcrEgnk7YAuOxh1B1dqhwpU78M7V62qdw-eyZ7EYKs3-RJnH3aYcXGa3XZpt5ZrbHOIgUJSlnYYbtBw2Z2vfUBTNAXCZTIXto-pQMZVIShXreeP0czk29rivThogxBb_PvYq3oFc1adG56Ob64Dz27-6ISOU8caynV9-ienq1Vrdcs_AwT8og41w9lFfDPurHLxmFR82_GW0C6kElvdUQ'

Example response

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

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

Create Endpoint

POST /v2/endpoints

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

Authorization

This endpoint requires create action on the endpoint resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

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

name

String

true

A display name allowing whitespace for the endpoint.

enrollmentMethod

Object

true

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

enrollmentMethod.ott

Boolean

true

enrollmentMethod.updb

String

true

enrollmentMethod.ottca

String

true

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.eyJqdGkiOiJncVhXNXg5b01kNU5uSWE1c1o1c19BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjlkNWY0MTRhLTM0ODgtNDE1MC1hNDliLTg4M2MyOTA4NmJhNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwNCwiZXhwIjoxNzM2NjMxNTA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdkMjgyMjk3LTRjNmMtNDBhZC1hYmZiLWNlNjcwOTU1MjExZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.D3M2vc4rbhMXYWgu8l1uunVkmgBT2132nFOhDuz8jYeEq2d7ucSej9wcKSSA-_u7CJisDVXZQ0cL9yNC8Vh0s6DTg9duMzC2Zd3TvhvtnYHQyuHxuupMrJ746PX0IpLOvo3tyMrWmo1v89IeB7Q58QQ7reUDbIVMPARVv8mza_Vuf6Af7gao3tHW3cMQ4wgI8o-Xcx0PUwBrFqL1kfJb6OLnfKmmEwBoQ7KITtH4Rgiwmb-BW1u1Ra8FqcFgcOnC73mez_0qxm-k-HV7qs5Mf9w435P02cDwkWFYH1AQjeEP4uT3lNu4DcrXEdFsg8whIs_W-q3CJDueW8DyJ3N7yQ' \
    -d '{"networkId":"8f14c838-a0df-40b4-bea2-39ba811af97a","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" : "1881f71e-5604-43af-a552-8f449cc173b5",
  "ownerIdentityId" : "9d5f414a-3488-4150-a49b-883c29086ba5",
  "createdBy" : "9d5f414a-3488-4150-a49b-883c29086ba5",
  "createdAt" : "2025-01-11T20:38:24.808589Z",
  "updatedAt" : "2025-01-11T20:38:24.816086Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "8f14c838-a0df-40b4-bea2-39ba811af97a",
  "zitiId" : "ziti.id.e158wnji",
  "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" ],
  "managedBy" : "Unmanaged",
  "jwtExpiresAt" : "2025-01-11T20:43:24.815394Z",
  "jwt" : "mock ziti enrollment Jwt",
  "online" : false,
  "mfaEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8f14c838-a0df-40b4-bea2-39ba811af97a",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/1881f71e-5604-43af-a552-8f449cc173b5",
      "title" : "Test endpoint 02"
    }
  }
}

Patch Endpoint

PATCH /v2/endpoints/{id}

Authorization

This endpoint requires update action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

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/0fc54f5e-ae43-4a7c-944c-043c356a9134' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJSMjNCOTR6OEpkTHRMMmZacm9YRlp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE4ZTYwZjYwLTMzYTYtNDk4ZS05YzQ1LWU3NWI3ODkxZjU3MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwNSwiZXhwIjoxNzM2NjMxNTA1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI0NWUxOTU1LTNkZDItNDhkNC1iOTBkLWQzZjRiYmFmZDNkMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.k8ut2n8hCn1Cad-5qfzCjXFv8s6Vhnxm1KVFOBwvHVZRHw3gt_XpRF28wGxz5KoG4TkfreV64N3T9DtXy1jQQg0ZVNU33Oi1rqGOlctfEyld60-m1hcAI0fSn-kVX3lYOj30zYoXGK6tF7ToZStIyxWOFwbAfZo8ik_xaTftFAZ9ByLltcfnAawdomHvn3dHRAkCxKgjovl5357qOfSjUlwmOSMBwVW6zrWdy8iHb6r51RpqBNh67JIm01acoaE5zmlR_5R6WLaEefhM8dbfu_awzwW937CbcoO7RELgmn2A3A6sAoEU72whKY4r1Y4KEP_xCa_2IjS13r6HkIWA6A' \
    -d '{"name":"Test endpoint 02 updated"}'

Example response

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

{
  "id" : "0fc54f5e-ae43-4a7c-944c-043c356a9134",
  "ownerIdentityId" : "4eb69682-6b5c-4a6a-94b6-946af3ec1e2e",
  "createdBy" : "4eb69682-6b5c-4a6a-94b6-946af3ec1e2e",
  "createdAt" : "2025-01-11T20:38:25.068615Z",
  "updatedAt" : "2025-01-11T20:38:25.095699Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "6af1617e-5ec6-4e10-83b0-38239a577cd6",
  "zitiId" : "ziti-id-2879",
  "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" : [ ],
  "managedBy" : "Unmanaged",
  "jwtExpiresAt" : null,
  "jwt" : null,
  "online" : false,
  "mfaEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6af1617e-5ec6-4e10-83b0-38239a577cd6",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/0fc54f5e-ae43-4a7c-944c-043c356a9134",
      "title" : "Test endpoint 02 updated"
    }
  }
}

Delete Endpoint

DELETE /v2/endpoints/{id}

Authorization

This endpoint requires delete action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

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/af9704a3-1478-4c44-bc1e-7688107a8380' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJNRVRGTnJoREtuNGJDcG5fUERIRWpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcyNzcyYzhkLWQxYzgtNDE0My04N2ViLTk4YmY4ZDU1YWYwYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwNSwiZXhwIjoxNzM2NjMxNTA1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdmZjVmMzFiLTE3YjYtNDY2MS1hOGNiLTk1ZmU2MTA1YzZhZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.qBVe-SGglhF-IaA2M8rUYdqWvHwL9a3fsML_v03bViTe1HJh1XtNdvGEc7zKTF5Gjs3VjrC3rRa11NgorqsUJQG3ztHCpMRxCl7ID0y4D-1oj1cCOjMxFvHCJ-6l9qDujukiVjIazm7kWORn4l-4qwwxM2JewNSkzlNa81i9tsf9zfXTTVMa10cK0rarJo2oub9zKtTAeBtGc8uut6yjvaf8oouLA-FgpqeiIZs6l1iK5xWRaOirZvQKrtAzcPqzaX0Qb9ZfBm4vvdcPdjmiJBJWfo7Cb8IWgQYG-ruQdGov_ours8UQdPZXCuC5kD7WYkboGCDjfZzW27-QUDIiig'

Example response

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

{
  "id" : "af9704a3-1478-4c44-bc1e-7688107a8380",
  "ownerIdentityId" : "f442bca8-b84c-4e9b-a446-7da3ad18cf9f",
  "createdBy" : "f442bca8-b84c-4e9b-a446-7da3ad18cf9f",
  "createdAt" : "2025-01-11T20:38:25.220481Z",
  "updatedAt" : "2025-01-11T20:38:25.236076Z",
  "deletedBy" : "72772c8d-d1c8-4143-87eb-98bf8d55af0c",
  "deletedAt" : "2025-01-11T20:38:25.236Z",
  "networkId" : "6f5a9914-fb82-48ae-8028-4c738c23d2f3",
  "zitiId" : "ziti-id-2905",
  "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" : [ ],
  "managedBy" : "Unmanaged",
  "jwtExpiresAt" : null,
  "jwt" : null,
  "online" : false,
  "mfaEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6f5a9914-fb82-48ae-8028-4c738c23d2f3",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/af9704a3-1478-4c44-bc1e-7688107a8380",
      "title" : "test endpoint"
    }
  }
}

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

id

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. In favor of the provider property on the host, will be deleted 1/1/2023.

@deprecated in favor of the provider property on the host, will be deleted 1/1/2023.

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

region

String

true

Deprecated. In favor of the region property on the host, will be deleted 1/1/2023.

@deprecated in favor of the region property on the host, will be deleted 1/1/2023.

hostSize

String

true

Deprecated. In favor of the size property on the host, will be deleted 1/1/2023.

@deprecated in favor of the size property on the host, will be deleted 1/1/2023.

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.eyJqdGkiOiJhcndNZEItTXlUMWtwSFh2YlZzQTZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI0MjUwYThiLWViNjctNGJlYy1hYWJiLTdiNTE3ZmUwZmI0ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NCwiZXhwIjoxNzM2NjMxNDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImYzYTJkZGE4LTRlNjctNDNmOC04OTcwLTY5MGVjNjg3YzExYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.k4DExSnB_bwicZkYzfZ9_OtqA9p8bblBLihMtwjzDh6Cx10Id_OQfuPj_8hxyL6XdXv0tDf2UUVllIqkFSLJWCqjMb14dEnRbK5nbB1fQyZJezwUbrTAhEB3AgQik0enzVt0Ha_HrrBNAra9m1fnNr3gpJo4fxsGTQkjc06svDTwn8BaYCRJbfWNgLTn-tImJJr1-ukeo1wJjXvqxiZzcimw5xaq4db8Jb_-vFMQLUexNJECAAt_KMjLc-Cs87bfk2-CyWh6iPbi72nWqI8SFuTEphn23sFzdtxZlqJLvsV10FDnco390GS9PAZk78_WpnzNGYe2IPH9I0QJ1bep9Q'

Example response

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

{
  "_embedded" : {
    "edgeRouterList" : [ {
      "id" : "03267da9-ab9f-4941-889b-abadb287efef",
      "hostId" : "9b8b5cf2-d730-41bc-b4df-85f4f359cfef",
      "ownerIdentityId" : "1f3ab164-9905-40dc-b8c0-81bb16e60a18",
      "createdBy" : "1f3ab164-9905-40dc-b8c0-81bb16e60a18",
      "createdAt" : "2025-01-11T20:37:44.218522Z",
      "updatedAt" : "2025-01-11T20:37:44.223626Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "ziti-id-1787",
      "domainName" : null,
      "alternateDomainName" : null,
      "name" : "er-test-1786",
      "productVersion" : "7.3.36",
      "networkId" : "44d859e3-e640-4306-afae-7085890d4bb0",
      "jwt" : null,
      "linkListener" : true,
      "tunnelerEnabled" : true,
      "noTraversal" : false,
      "online" : false,
      "verified" : true,
      "status" : "PROVISIONED",
      "softwareDeploymentStateId" : "c6688c5d-b063-4d4c-bf46-b5eecc2be34a",
      "provider" : "AWS",
      "region" : "us-east-1",
      "hostSize" : "small",
      "attributes" : [ ],
      "registration" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/44d859e3-e640-4306-afae-7085890d4bb0",
          "profile" : "parent"
        },
        "software-deployment-state" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/c6688c5d-b063-4d4c-bf46-b5eecc2be34a"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/9b8b5cf2-d730-41bc-b4df-85f4f359cfef"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/03267da9-ab9f-4941-889b-abadb287efef",
          "title" : "er-test-1786"
        },
        "softwareDeploymentState" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/c6688c5d-b063-4d4c-bf46-b5eecc2be34a",
          "deprecation" : "Use software-deployment-state link instead"
        }
      }
    }, {
      "id" : "268677b7-a37f-48c9-8bf2-87b0be4ec288",
      "hostId" : "e6fc5468-68e3-4336-8448-4d83ff57d790",
      "ownerIdentityId" : "89a73c9d-650f-403b-a271-ad60dbb197cb",
      "createdBy" : "89a73c9d-650f-403b-a271-ad60dbb197cb",
      "createdAt" : "2025-01-11T20:37:44.221011Z",
      "updatedAt" : "2025-01-11T20:37:44.221011Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "ziti-id-1793",
      "domainName" : null,
      "alternateDomainName" : null,
      "name" : "er-test-1792",
      "productVersion" : "7.3.36",
      "networkId" : "44d859e3-e640-4306-afae-7085890d4bb0",
      "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" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/44d859e3-e640-4306-afae-7085890d4bb0",
          "profile" : "parent"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/e6fc5468-68e3-4336-8448-4d83ff57d790"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/268677b7-a37f-48c9-8bf2-87b0be4ec288",
          "title" : "er-test-1792"
        }
      }
    }, {
      "id" : "28dcf4b8-20e3-41e3-8477-e4e1674da2b5",
      "hostId" : "6da10436-8713-470a-bd56-27d9bd5519f3",
      "ownerIdentityId" : "bd36266f-2476-4e16-9417-0b63df083b22",
      "createdBy" : "bd36266f-2476-4e16-9417-0b63df083b22",
      "createdAt" : "2025-01-11T20:37:44.222096Z",
      "updatedAt" : "2025-01-11T20:37:44.222096Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "ziti-id-1796",
      "domainName" : null,
      "alternateDomainName" : null,
      "name" : "er-test-1795",
      "productVersion" : "7.3.36",
      "networkId" : "44d859e3-e640-4306-afae-7085890d4bb0",
      "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" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/44d859e3-e640-4306-afae-7085890d4bb0",
          "profile" : "parent"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/6da10436-8713-470a-bd56-27d9bd5519f3"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/28dcf4b8-20e3-41e3-8477-e4e1674da2b5",
          "title" : "er-test-1795"
        }
      }
    }, {
      "id" : "cfc11b89-bd11-430d-8dda-c143e8f93f07",
      "hostId" : "72f475c4-ba61-40c6-bc35-53cca067b9fc",
      "ownerIdentityId" : "a27ebc25-6291-4ba4-a841-1a1d630366a7",
      "createdBy" : "a27ebc25-6291-4ba4-a841-1a1d630366a7",
      "createdAt" : "2025-01-11T20:37:44.219768Z",
      "updatedAt" : "2025-01-11T20:37:44.219768Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "zitiId" : "ziti-id-1790",
      "domainName" : null,
      "alternateDomainName" : null,
      "name" : "er-test-1789",
      "productVersion" : "7.3.36",
      "networkId" : "44d859e3-e640-4306-afae-7085890d4bb0",
      "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" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/44d859e3-e640-4306-afae-7085890d4bb0",
          "profile" : "parent"
        },
        "host" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/72f475c4-ba61-40c6-bc35-53cca067b9fc"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/cfc11b89-bd11-430d-8dda-c143e8f93f07",
          "title" : "er-test-1789"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edge Router (deprecated)

GET /v2/edge-routers/{id}

Deprecated. Use attribute instead, will be deleted 1/1/2023.

@deprecated use attribute instead, will be deleted 1/1/2023.

See Edge Routers .

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/4fb7ec17-bfa6-4aee-a94f-f819f85dbbc2' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJtaldHZ2FkVk90NlYzaXltNEpUMEJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFhMjM2MGNlLTA0ZDYtNDZiNC04NGM3LTQwZGNjMTAyN2MzMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NCwiZXhwIjoxNzM2NjMxNDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjM4NDBiM2U3LWE0ZmEtNDM0YS1hOWFhLWRiYzI5YmRmM2I2OFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.FNwvfbfXvmObz3z2rcSg1YyzkUZ0SJNXKcouyNZGJ6Ln4pa8i3kvFz0xQT96spNxXTP_5kx3mgzpj1EY54Ah9QOPKYLQtiIXKJ0_-nh2u_QbWa21XrMeKfTwVZT8Qup7Tlt_3oPfdY0p9VjzJfcM3nezLumHp071s5_LDHnQzyyyKeETU8X2XA2ph7-yCzrPMXWbGUgrOD1xoNbBSHVd3yR_U2Uz1UkAFVu9eNLRrfD7tFeJSPN6V-4go7PaQfeBdJT8ABPS2ia4kChxzlfnu41QmELzxsZ3JkKy5eJNDtIA9dkDvh0IWPxqw9yoTCapKt02pEL3mVO4FPRPoPPb_Q'

Example response

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

{
  "id" : "4fb7ec17-bfa6-4aee-a94f-f819f85dbbc2",
  "hostId" : "995c681f-9880-47d1-aef4-5d4277d82d70",
  "ownerIdentityId" : "de6e789e-9c99-49c2-915e-57f614c4ed45",
  "createdBy" : "de6e789e-9c99-49c2-915e-57f614c4ed45",
  "createdAt" : "2025-01-11T20:37:44.421139Z",
  "updatedAt" : "2025-01-11T20:37:44.425780Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "ziti-id-1844",
  "domainName" : null,
  "alternateDomainName" : null,
  "name" : "er-test-1843",
  "productVersion" : "7.3.36",
  "networkId" : "77472a24-6565-49ef-9e5d-dda6fa423a52",
  "jwt" : null,
  "linkListener" : true,
  "tunnelerEnabled" : true,
  "noTraversal" : false,
  "online" : false,
  "verified" : true,
  "status" : "PROVISIONED",
  "softwareDeploymentStateId" : "4ac29f9b-a15d-475c-9c57-48a7379f1833",
  "provider" : "AWS",
  "region" : "us-east-1",
  "hostSize" : "small",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/77472a24-6565-49ef-9e5d-dda6fa423a52",
      "profile" : "parent"
    },
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/4ac29f9b-a15d-475c-9c57-48a7379f1833"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/995c681f-9880-47d1-aef4-5d4277d82d70"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/4fb7ec17-bfa6-4aee-a94f-f819f85dbbc2",
      "title" : "er-test-1843"
    },
    "softwareDeploymentState" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/4ac29f9b-a15d-475c-9c57-48a7379f1833",
      "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.eyJqdGkiOiJYbHZ6Z0JhcVVSUU9Ua3RHS285WmdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE2MDVkNzU4LTM1OTMtNGUwMi04ZjY1LTNjYTNhZTAyY2M1MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg0MCwiZXhwIjoxNzM2NjMxNDQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM0NTRmMGFiLTE3MzQtNDQ1NC05YjE3LWJiMzk5ODQ0NDQxZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ZMJ1a-a0itWYcGRaXOsAgaQ8o1XHgXv0pEI4MP0t7jf9kdoM1HfSBJMV4Xi_Wf9aNP5ZtoowdGayANx9g6BgrDmRqceAxq5-0h2XJcSWfppBPjhND8WQQopoFT2GDpwjKFwgvH1ydqJibqXfmUPxqLoV1fAxiuFUxhzZzI2YFYnHRyRn0eEnMsS7PU1eYK8t25_0O87z9csntaDSOnEf6bmUa8gVOfgDp-xtqF6vQ30yFUQajnKP66EaRG-Hd_yZBc0rFroX24LdIVDXGrF7UVMYVYKFu5IK7IdxZU1otVgdHdDyHMy_y4qcNTRrMqDHu6M6l_6-po1BhjGRLkj9QA' \
    -d '{"name":"Test edge router 1736627840","networkId":"23dca03c-e5f4-4593-b087-ca9f2fec1d0c","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" : "eeafde06-01a2-4560-bbd8-1b084c00181c",
  "hostId" : null,
  "ownerIdentityId" : "1605d758-3593-4e02-8f65-3ca3ae02cc51",
  "createdBy" : "1605d758-3593-4e02-8f65-3ca3ae02cc51",
  "createdAt" : "2025-01-11T20:37:20.151418Z",
  "updatedAt" : "2025-01-11T20:37:20.153615Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : null,
  "domainName" : null,
  "alternateDomainName" : null,
  "name" : "Test edge router 1736627840",
  "productVersion" : "7.3.36",
  "networkId" : "23dca03c-e5f4-4593-b087-ca9f2fec1d0c",
  "jwt" : null,
  "linkListener" : false,
  "tunnelerEnabled" : false,
  "noTraversal" : false,
  "online" : false,
  "verified" : false,
  "status" : "PROVISIONING",
  "softwareDeploymentStateId" : "77299f3a-456e-4f4c-90b6-0275f0cde672",
  "provider" : null,
  "region" : null,
  "hostSize" : null,
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/23dca03c-e5f4-4593-b087-ca9f2fec1d0c",
      "profile" : "parent"
    },
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/77299f3a-456e-4f4c-90b6-0275f0cde672"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/eeafde06-01a2-4560-bbd8-1b084c00181c",
      "title" : "Test edge router 1736627840"
    },
    "softwareDeploymentState" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/77299f3a-456e-4f4c-90b6-0275f0cde672",
      "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

id

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/e6bc9a06-9937-4c2c-a2d3-76c15d51e673' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJLSjdWSV9VejlxMGxEaXd1dk5WNGxRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcxMzM4YmJiLTllNDgtNGIxMC1hY2ZmLTI4OTY0Zjg5NTExMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NCwiZXhwIjoxNzM2NjMxNDY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM5YTIyZGIzLTBiMGItNGU4Ny04ZmVhLWM4YWQ5NjNiZTdiMFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.P6YelWCO6pDh-ChF4pPumsLXVuVZgqv9y8wWaBJNufWVaJERGO8xb2_y2_D8tCbXAuYjnkk5U56if6EaD-ev8C0aRM7lkoxA__-q9UPGJNwBFGlzbWLdTJK1EIREVQH_RjNmlezDLrwTd1tqvxFuiA8IarwETncqgXWnPrvUpzV7myMjD771ILI6XseiETx9nkESEhw9LoUBBR8TjOewZGqxKCQfOpTN-DG59LfGmm8hE-IUghvOjCLfFe8pmP9lR6okWu8B1FgGuwvq9Ze8_vC0fL3BZMLk-LRVkmPe5tgvLeB6zj1doab-vcmhTIT905EblkOSEcC0A-v95hMjAg' \
    -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" : "e6bc9a06-9937-4c2c-a2d3-76c15d51e673",
  "hostId" : "4d9b366f-4638-4b8f-921d-01577dc53933",
  "ownerIdentityId" : "b4c59687-5798-4ad7-9f30-aa10378e9a77",
  "createdBy" : "b4c59687-5798-4ad7-9f30-aa10378e9a77",
  "createdAt" : "2025-01-11T20:37:44.349173Z",
  "updatedAt" : "2025-01-11T20:37:44.373648Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "ziti-id-1825",
  "domainName" : null,
  "alternateDomainName" : null,
  "name" : "Updated name",
  "productVersion" : "7.3.36",
  "networkId" : "3d0c49f3-5895-4528-bcbc-2c6b68ac9a02",
  "jwt" : null,
  "linkListener" : true,
  "tunnelerEnabled" : true,
  "noTraversal" : false,
  "online" : false,
  "verified" : true,
  "status" : "PROVISIONED",
  "softwareDeploymentStateId" : "d31b698d-ae1b-478a-b961-c7e88617557a",
  "provider" : "AWS",
  "region" : "us-east-1",
  "hostSize" : "small",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3d0c49f3-5895-4528-bcbc-2c6b68ac9a02",
      "profile" : "parent"
    },
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/d31b698d-ae1b-478a-b961-c7e88617557a"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/4d9b366f-4638-4b8f-921d-01577dc53933"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/e6bc9a06-9937-4c2c-a2d3-76c15d51e673",
      "title" : "Updated name"
    },
    "softwareDeploymentState" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/d31b698d-ae1b-478a-b961-c7e88617557a",
      "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

id

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/166e6978-c6b6-46af-87c1-7973b4ab37bb' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ5bnhYVjQxazFWNUFGd08yYUd0czVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYyNTU1OGE2LWNiZWUtNGIwZC05MTkwLTMzNzIyOTkyZTBkYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg0MywiZXhwIjoxNzM2NjMxNDQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBjNmIyMWEwLTBkNWYtNDM1OC05NjdlLTc2YmNiYzdmZDdiMFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg0M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.sMItB-ScOTWzHp8SqDuJ4T1_8sSgNEFahKiIOQEW5aQ45lCaDe148m61MrJr06PODlx742iwBCn1cPVd88edLA9LD5y48wRtggdAXtZmmbP4SSMAcsk264P_82GOVpCwsXdeAtGK0nWmLnWfd2US8tyn3C_QlOCD6u39diIGA04PRfZQqyUy7hpNEXk34ICsm2Tx-suI5cSzTVA99horpJ_aOFZRAGI4xDKkvmzHesc-Cx8x3R6AUZulJhw_C7WzO9GQCTh_nf_uXyhGuwbmhR-exoS_SNj9K8Au5oeXOmIO5BC3XFhYVkyArx5rhdRR36fZHIxsLJY2J1yRm9DIcA'

Example response

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

{
  "id" : "166e6978-c6b6-46af-87c1-7973b4ab37bb",
  "hostId" : "567cef6c-7092-4724-b390-43d2796b40ae",
  "ownerIdentityId" : "23770123-04ae-49da-94ba-4163ef1ca710",
  "createdBy" : "23770123-04ae-49da-94ba-4163ef1ca710",
  "createdAt" : "2025-01-11T20:37:23.691342Z",
  "updatedAt" : "2025-01-11T20:37:23.709792Z",
  "deletedBy" : "625558a6-cbee-4b0d-9190-33722992e0dc",
  "deletedAt" : null,
  "zitiId" : "ziti-id-1646",
  "domainName" : null,
  "alternateDomainName" : null,
  "name" : "er-test-1645",
  "productVersion" : "7.3.36",
  "networkId" : "5e280943-95b7-42fd-8a81-be8ab5b41eea",
  "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" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5e280943-95b7-42fd-8a81-be8ab5b41eea",
      "profile" : "parent"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/567cef6c-7092-4724-b390-43d2796b40ae"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/166e6978-c6b6-46af-87c1-7973b4ab37bb",
      "title" : "er-test-1645"
    }
  }
}

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

id

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/bb3ef914-f961-4bdf-9ed0-99fe2bd3f7a4/sync' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxY3BJQ1V1Mm1Tcm9RM0ZJR3k3eW1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU1NmMxOTA3LWRjNWEtNDNiMi1iODliLWYyYjE3MzVhMGVmNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg0MywiZXhwIjoxNzM2NjMxNDQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQxYjc4ZDgzLTkyNmMtNGVhYS1hYmFkLWI1ZTQwOGE1MmQ2OFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg0M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.EJy30j20Mk9241-h1tw0nqzu0oOHrLoHX-LGxDHZAYpVUJyE81L9cldT89HcB1xF0oySSGZ7_x0ui-MK56CQImiHAnQqL3TFHVha0hofrDbs6FQBr6zq5TgR9c33gxUIJYeHwudWDKD-rzZGcw9qcshzDi6569vS7lxj4IhDwqRVXfy9CuYPp2_74pKWN3IUDKiQd2mxNaHfzEhAVRh7ql0shERqwoSpxnz1BqZwQEUR1ctvYg2izQgCkb9ja_uQug7xaAZgiAO8rvTiX_UuaD55p0H9jwQ_tMrPdvmHR57kv_R_asOeATfNLky7Qwigw_iy_SCIyrVN3H-lZOddWg'

Example response

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

{
  "id" : "bb3ef914-f961-4bdf-9ed0-99fe2bd3f7a4",
  "hostId" : "03ea14da-4f8b-4de7-9e45-3f1953b421b9",
  "ownerIdentityId" : "c516aca7-55e5-4efa-a352-d610689283fd",
  "createdBy" : "c516aca7-55e5-4efa-a352-d610689283fd",
  "createdAt" : "2025-01-11T20:37:23.508783Z",
  "updatedAt" : "2025-01-11T20:37:23.523376Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "zitiId" : "ziti-id-1567",
  "domainName" : null,
  "alternateDomainName" : null,
  "name" : "er-test-1566",
  "productVersion" : "7.3.36",
  "networkId" : "b5cdcb63-be22-4c5f-9532-a0259be1ed4f",
  "jwt" : null,
  "linkListener" : true,
  "tunnelerEnabled" : true,
  "noTraversal" : false,
  "online" : true,
  "verified" : false,
  "status" : "PROVISIONED",
  "softwareDeploymentStateId" : "261e2a80-9322-4d60-90d7-5dce9f48e1c5",
  "provider" : "AWS",
  "region" : "us-east-1",
  "hostSize" : "small",
  "attributes" : [ ],
  "registration" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b5cdcb63-be22-4c5f-9532-a0259be1ed4f",
      "profile" : "parent"
    },
    "software-deployment-state" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/261e2a80-9322-4d60-90d7-5dce9f48e1c5"
    },
    "host" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/03ea14da-4f8b-4de7-9e45-3f1953b421b9"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/bb3ef914-f961-4bdf-9ed0-99fe2bd3f7a4",
      "title" : "er-test-1566"
    }
  }
}

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

id

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

Indicates whether or not this {@link EdgeRouterPolicy} is "exclusive" to a specific {@link EdgeRouter} or {@link Endpoint} instance, or is not exclusive (null). <p/> An exclusive {@link EdgeRouterPolicy} is defined and managed by the resource that it is exclusive to. An exclusive {@link EdgeRouterPolicy} will have exactly one attribute of the type indicated by this property, and that attribute will be an '@' name based direct reference to the resource that defined and manages this policy. <p/> An exclusive {@link EdgeRouterPolicy} can not be created by an external API request. They are only created by internal processes as a side effect of other actions. Exclusive policies can not be updated via an external API request. All changes to exclusive policies are driven by the system, usually as a side effect of actions on the managing resource. Last but not least, exclusive policies are auto-deleted when the managing resource is deleted.

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.eyJqdGkiOiJWdzlTOGxYakE1MFJZa0RoZlJLc3J3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY5YmYxMDYwLTY1YTMtNDk2Ni05NGU4LWY1ZDgwYjFjNTYzYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgxOSwiZXhwIjoxNzM2NjMxNDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRjYTVhNDliLTViMzUtNGE2My1iN2U1LTViY2NiMzdhMjVjZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.d4ajyMqJ_31_Fhf2q44UQpNiOuGA1KXi473SelnyS7NHhBQ_H2BaN7mmYMkvyk7Ft2Nq3p_j7kFlF8f_sx8t3EmHd2dq8XpxyRji2yAt0Rv3KW_ElG3eJRWTNEAGeHdiBC2jEOVmcmLDW9ry5pE2torgjE7Ko6DOm1TqdfRbwSvluhr3CDlxszlDmLMGzxd3w4ChtdbqOy7byfbuVgUxwl0vazqC2sX5W6ZiPE5un6vF-A8rOTlEPJwP2yIzkQTePrBoik8eeaQ5zgm0IlQsi4dVrgz9d3AIxUOBxTvC7Rk3zVcvASm4jnrEjEV6du4QnFNvN9RJ65ohNk9bCwpAdg'

Example response

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

{
  "_embedded" : {
    "edgeRouterPolicyList" : [ {
      "id" : "3cdc0c03-be22-4ae1-90bc-4d25d1c81222",
      "networkId" : "87ed429b-4ef8-4b9b-a2b1-411d090a27c1",
      "zitiId" : "3aad87f7-5b9c-45b1-a1a0-fd566dfde0f7",
      "name" : "v0SPC1V9sA-xw0qv_rzti",
      "isSystem" : false,
      "semantic" : "AnyOf",
      "endpointAttributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "61331c0c-999b-4cad-9e24-92ea8957a109",
      "createdBy" : "61331c0c-999b-4cad-9e24-92ea8957a109",
      "createdAt" : "2025-01-11T20:36:59.051795Z",
      "updatedAt" : "2025-01-11T20:36:59.051795Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/3cdc0c03-be22-4ae1-90bc-4d25d1c81222",
          "title" : "v0SPC1V9sA-xw0qv_rzti"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/87ed429b-4ef8-4b9b-a2b1-411d090a27c1",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "45d4ac83-cda7-42fc-95fc-961cca7aeee9",
      "networkId" : "bafb3f0c-10ba-401c-a033-ad251ebf6eed",
      "zitiId" : "18f84f1f-7d78-434c-ae38-237b01fec165",
      "name" : "erp-579",
      "isSystem" : false,
      "semantic" : "AnyOf",
      "endpointAttributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "e4e35982-b828-4f14-9f3f-25df4737512f",
      "createdBy" : "e4e35982-b828-4f14-9f3f-25df4737512f",
      "createdAt" : "2025-01-11T20:36:58.619052Z",
      "updatedAt" : "2025-01-11T20:36:58.619052Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/45d4ac83-cda7-42fc-95fc-961cca7aeee9",
          "title" : "erp-579"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bafb3f0c-10ba-401c-a033-ad251ebf6eed",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edge Router Policy

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

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

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/b8a513c9-2b30-4021-b842-07d649bb2bce' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1OFpBQTlSNUNYcUtpWWhYOXRXLWp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYzZDBkNTE3LWVjNjItNDczNC05NGVkLTBhN2I0NDk1NDY1MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgxOSwiZXhwIjoxNzM2NjMxNDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjc0YTRjODczLWFhMjctNDNlMy04YzdkLTcxNTcxZDhiNDNlNFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.I_gVp_5ekJl00NkYfU0mYkB5QqcSOGYovecog2IKgnfHc2A223eAVsldVwc0SqzAPLpufhFkhQrapurq3LNebdyJF_1kUEDz5KG4l33NyyDWmK5kjQXad2TwR7J8XcJhxOAb31W4yuytG8_dVv8TD1yrIde4IyAqVrm2OkO9vqkeXanC8YjZCMUehrCZCxO_NMq6HvWnPvX5Ulss6lXX7xNoVqmbqoBtucpNBmwaKXvv7y0LUw8xrUwxuX_M4Rj4pc1pxIDaoaxgRFGWAmoStv6bmUbW8n6BopObT3EL5mG8x4nxaIRr5ZP0tdeQwvHA6NXBM1J5EYutJoeCs3T7dQ'

Example response

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

{
  "id" : "b8a513c9-2b30-4021-b842-07d649bb2bce",
  "networkId" : "906c3083-407f-4ab3-bf7b-48c07a6a8e46",
  "zitiId" : "c8fe6a24-56a8-4cea-917a-5908acdebec2",
  "name" : "erp-623",
  "isSystem" : false,
  "semantic" : "AnyOf",
  "endpointAttributes" : [ ],
  "edgeRouterAttributes" : [ ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "dfbe7cac-7541-483b-ae8c-cf1490ad7e3b",
  "createdBy" : "dfbe7cac-7541-483b-ae8c-cf1490ad7e3b",
  "createdAt" : "2025-01-11T20:36:59.230343Z",
  "updatedAt" : "2025-01-11T20:36:59.230343Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/b8a513c9-2b30-4021-b842-07d649bb2bce",
      "title" : "erp-623"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/906c3083-407f-4ab3-bf7b-48c07a6a8e46",
      "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.eyJqdGkiOiJDZ0dUOFlLZzEwekhpYXZqNDR3Z2ZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQzNWIzOWIxLTcwNDgtNGM3ZC04ZGUwLTc0NTBiZGM4NzA1NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgxOSwiZXhwIjoxNzM2NjMxNDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk1MGRkM2M0LTU1ZTgtNGE4OS1iZDk1LWVmNDA1OGI1MDAzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.OnOqQTv7Nedalu968D6b8A9oKj-CVXZL_K11B-RBasCzRyTMpZddvNJYQY7mA1axsBF0p5-BNM7LMRjtEL1JFllYZAb0buRB1Yk6ZzSqBbS5VpbzJWBXe4TiKzlKv5L_cHx8_ZNOdT0xIm31-rjFGjrbPs9oWloW2kWSwEDdUFju1cjrDn5KLkMhMYcbDfB4mW9GNaPmOAC2mcxVRRFEPIzVUoDvKQTUQ1DdrqSQvPJb4d90XfxHHyLq1Z8CoT91RLByVmRWOyRVxZcXUe-kCYwiWcbxvGMpZAm6r2NfkTP-jD8sjbqR582woSn1eIND_rKI2wqEh1E25OnsfhpiVw' \
    -d '{"name":"Test edge router policy 1736627819","networkId":"02f78d2e-80cd-4fdd-a42d-6f674bfdc361","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" : "24ebc29d-1d37-4854-a6fa-77e683d77b15",
  "networkId" : "02f78d2e-80cd-4fdd-a42d-6f674bfdc361",
  "zitiId" : "ziti.id.cxt49kev",
  "name" : "Test edge router policy 1736627819",
  "isSystem" : false,
  "semantic" : "AnyOf",
  "endpointAttributes" : [ "#topclients" ],
  "edgeRouterAttributes" : [ "#westrouters" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "435b39b1-7048-4c7d-8de0-7450bdc87054",
  "createdBy" : "435b39b1-7048-4c7d-8de0-7450bdc87054",
  "createdAt" : "2025-01-11T20:36:59.179196Z",
  "updatedAt" : "2025-01-11T20:36:59.191025Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/24ebc29d-1d37-4854-a6fa-77e683d77b15",
      "title" : "Test edge router policy 1736627819"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/02f78d2e-80cd-4fdd-a42d-6f674bfdc361",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/ce71639c-25b8-4d43-a72f-5b6219d223ba",
      "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

id

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/b483885a-4652-4e47-92c3-853573f14c39' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJETzVLQl9uV0J4S2dpLUQxSzY5RUlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFjMTQxYWQ1LTg0NTYtNDVmOC1iNWU0LWY0NzZkMzlkZGM3YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgxOSwiZXhwIjoxNzM2NjMxNDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjNhNTg0M2E0LTNiOTEtNDgyMC1iMTVlLWM3NDZhOGUwMWU5NFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.YddBLNyyix4LKfMnJ0Ze7B3t_Z3L-ZXBmbuhb-bmEFFAry_PMeE0JfJftPGmw0icbbBN-jtEdsFo_vMMLsOHd4bHU77kjYVir9P2tazn4bVd4Yqv1h4ClAtcHcPGa6Sa0mdEvmiXFbrZKIQwl1HeBS8Prv6fCaxHrjhsORYPlENF1J5spebWpN925qd8_Q_K2GVBPgPs-2rPC0QGpeT7rjrtyIpAeD1OhSgX_ELfSEBgN_Wq1A-aDF_gFAskITa8ihUODHPbuulVOpE4nkuFmDBCaU_zQKDYhF7D1QUq2QXosY7Raq-lrKanGCSdhiLHq9uB8uulg8ubLTAS4vnRoQ' \
    -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" : "b483885a-4652-4e47-92c3-853573f14c39",
  "networkId" : "76f985bf-4943-4cb2-b8de-07267e13455a",
  "zitiId" : "ziti.id.cy07mj6x",
  "name" : "Updated edge router policy name",
  "isSystem" : false,
  "semantic" : "AnyOf",
  "endpointAttributes" : [ "#topclients" ],
  "edgeRouterAttributes" : [ "#westrouters" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "74b5bc98-42b9-4835-92d1-d94ef091087e",
  "createdBy" : "74b5bc98-42b9-4835-92d1-d94ef091087e",
  "createdAt" : "2025-01-11T20:36:59.609126Z",
  "updatedAt" : "2025-01-11T20:36:59.658552Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/b483885a-4652-4e47-92c3-853573f14c39",
      "title" : "Updated edge router policy name"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/76f985bf-4943-4cb2-b8de-07267e13455a",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/ec7fdac7-9c23-4563-a8ec-5ac8987a7c7d",
      "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

id

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/921c5688-abfd-49bb-b859-7cd7873a46b8' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJsU3ZiZnVhWkdFbUFISjQxckU1VTRRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg5ODAwZTNjLWJlNzUtNDYyMi05NmZkLTNmYWI1YTY2ODUyNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgxOSwiZXhwIjoxNzM2NjMxNDE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjkxMWYzZGM2LWEzZjMtNDcwZC05MjFlLTMyYWY4ZGFjNTEwY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.qoD8JuT04dY7Ljnhr7CBtqNyU787OJaWPEhdBNbM-lvRc2KMiMbVzMhFGo_RRMGiiJNC13fB07dDtmwbZi2evJi06tYv9t3GLACKOWsHHqZZTeiZBdTzShPFBJqU83rBnJ46t2iX3nR79UMj5AzUh61GTFG2bcrqwYTQ1aVDof3SKnv7OUaUWLF5yaKh99FF1jjiJFiJrmfxJ3mUAeZ6WcPUZAimwJy8iizlz9WYso9OqhWEloH5XBf-wr1qqBQtijbZJgP6cUZCdhc6vBu_Qy6I3tngSVllazv1VbtBXtWBmlmPh9ezVuwYsuBC-9n8VCvjc_zmVedg06iRMZLMjg'

Example response

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

{
  "id" : "921c5688-abfd-49bb-b859-7cd7873a46b8",
  "networkId" : "73769c64-7e3a-497d-93b7-b79f8938ffea",
  "zitiId" : "ziti.id.cxxo79wc",
  "name" : "Test edge router policy 1736627819",
  "isSystem" : false,
  "semantic" : "AnyOf",
  "endpointAttributes" : [ ],
  "edgeRouterAttributes" : [ ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "45bbe11b-4edc-4c4a-9107-fc6657dec13f",
  "createdBy" : "45bbe11b-4edc-4c4a-9107-fc6657dec13f",
  "createdAt" : "2025-01-11T20:36:59.456003Z",
  "updatedAt" : "2025-01-11T20:36:59.502838Z",
  "deletedBy" : "89800e3c-be75-4622-96fd-3fab5a668526",
  "deletedAt" : "2025-01-11T20:36:59.502Z",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/921c5688-abfd-49bb-b859-7cd7873a46b8",
      "title" : "Test edge router policy 1736627819"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/73769c64-7e3a-497d-93b7-b79f8938ffea",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/95c6e68c-23a4-49d9-a5e3-ad23297f30c3",
      "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

id

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

Indicates whether or not this {@link EdgeRouterPolicy} is "exclusive" to a specific {@link EdgeRouter} or {@link Endpoint} instance, or is not exclusive (null). <p/> An exclusive {@link EdgeRouterPolicy} is defined and managed by the resource that it is exclusive to. An exclusive {@link EdgeRouterPolicy} will have exactly one attribute of the type indicated by this property, and that attribute will be an '@' name based direct reference to the resource that defined and manages this policy. <p/> An exclusive {@link EdgeRouterPolicy} can not be created by an external API request. They are only created by internal processes as a side effect of other actions. Exclusive policies can not be updated via an external API request. All changes to exclusive policies are driven by the system, usually as a side effect of actions on the managing resource. Last but not least, exclusive policies are auto-deleted when the managing resource is deleted.

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.eyJqdGkiOiJOalM0ZXlJMHZKZDd0Q1lXanhXODFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdiY2MyZTNkLTUwMTItNDgzMS05NTI3LTY5Yzc2ZGVmNTdmYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5MCwiZXhwIjoxNzM2NjMxMzkwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ2Zjg3YmEwLTRiNjgtNDhmMC05NzBiLTIwYTRlYmYwN2Q1NFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.lb2Xr5YVJDL7FcjLPXzU5jXd2YtHU9II6Ou6ZG3V2mQysF1KzLLxvFByS6hYvEIXD-fHjOiV46ngHeSU7tolsD03izj-qHy0dmrKVXjAR5peN0B7Y5IM1hnneWQeCJrLhjAgA7yTLMum0ssXSHieaJ6M_M3KtpaMhL0MTU_15jNenX6Udj1cNzKVlERMwtHOdWETrCidhG32q8ZlzT3Worgk67ekjagSRoQawCymikRH6TuBMwzc-YoBp9rMh0-MYmTmOytFefS3klDP8uF_7nl4HM96L7TVusXFjIVn9OKDFWTXTKfbrEhwt1KnI2nEJsWHEkTOTUr2W0k1s_aCgA'

Example response

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

{
  "_embedded" : {
    "edgeRouterPolicyList" : [ {
      "id" : "3ddd0cda-552b-4357-8e6a-721071797a85",
      "networkId" : "eb712164-ad8d-4ef4-a418-18e3a7da2771",
      "zitiId" : "6cd856c9-0559-43d3-a52b-b28c4b14ad5f",
      "name" : "Find Test Edge Router Policy 1",
      "isSystem" : false,
      "semantic" : "AnyOf",
      "endpointAttributes" : [ "#epAttr2", "#epAttr1" ],
      "edgeRouterAttributes" : [ "#erAttr2", "#erAttr1" ],
      "exclusiveType" : "edge-router",
      "exclusiveToId" : "594792bf-7d7c-4d36-82dc-deb33ea2c26d",
      "ownerIdentityId" : "c7b473b0-9c05-491a-9ae3-d5289a9dac14",
      "createdBy" : "c7b473b0-9c05-491a-9ae3-d5289a9dac14",
      "createdAt" : "2025-01-11T20:36:30.347393Z",
      "updatedAt" : "2025-01-11T20:36:30.347393Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/eb712164-ad8d-4ef4-a418-18e3a7da2771",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/3ddd0cda-552b-4357-8e6a-721071797a85",
          "title" : "Find Test Edge Router Policy 1"
        }
      }
    }, {
      "id" : "6c39d5ae-cd06-4a03-a906-ef0bcfc7c99f",
      "networkId" : "eb712164-ad8d-4ef4-a418-18e3a7da2771",
      "zitiId" : "d7f37e2b-dbdb-4c32-a485-99a7d6515b7b",
      "name" : "Find Test Edge Router Policy 2",
      "isSystem" : true,
      "semantic" : "AllOf",
      "endpointAttributes" : [ "#epAttr1", "#attr3" ],
      "edgeRouterAttributes" : [ "#erAttr1" ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "c7b473b0-9c05-491a-9ae3-d5289a9dac14",
      "createdBy" : "c7b473b0-9c05-491a-9ae3-d5289a9dac14",
      "createdAt" : "2025-01-11T20:36:30.350876Z",
      "updatedAt" : "2025-01-11T20:36:30.350876Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/eb712164-ad8d-4ef4-a418-18e3a7da2771",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/6c39d5ae-cd06-4a03-a906-ef0bcfc7c99f",
          "title" : "Find Test Edge Router Policy 2"
        }
      }
    } ]
  },
  "_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

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/services?config.addressAndPortIndex%5Bingress%5D=foo.bar.com%7C%5B80--80%5D' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJneWVOQVVNZk9pdlVScVRQb21NWGdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQyZTRmNzM0LTM1MGYtNDQyMy04NTkyLTVmOWZmMzk3YjQ1NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc2MiwiZXhwIjoxNzM2NjMxMzYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjUyYzAxNDhmLTlmN2ItNGRlNi1hNDRkLTE2MTVmOTQwYzcyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.AJd5Gkxq2KUw6tbIPGfzKrJZ3WDjNrsxRAtlScIkIV8ZS5bC-BDLbMzwPgGkgmlCMpx_NJS0X7N_bDyor8MDSflon6F5-e9xV2bUA6dZB7cDw7ves-OX0iR0KXaAakINhZdA6g9cO_Q6A74dYuDy0jAoLBLYffUWT6Pv5gzXEF9EsQfDQsQ7E5qfplz_0uFXyArNNB4fUZL4XFGxv7jz0Ejz0Gw6X9pNMBhHZalcl7w42r2FhyK0OsysHH2Y-EiUiDdetW44Ocg_upiY4tXkjGdwb38ERRdFxmipC_6K5eQ9FBxgOFfHPE33OJDhDoCg2Pu-nkqjJ9zeoB-iMBhLmA'

Example response

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

{
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?config.addressAndPortIndex%5Bingress%5D=foo.bar.com%7C%5B80--80%5D"
    }
  },
  "page" : {
    "size" : 0,
    "totalElements" : 0,
    "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

id

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/aa49ca53-3b68-4871-9971-1e510ad3d880' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZMFh1YmpCdnRSbmwwMWpPTmtFeEZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU0YzY5NzlkLTdmN2YtNGZlOC1iNmEwLTU1YTM5Y2ZjMTM3ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5OSwiZXhwIjoxNzM2NjMxMzk5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjAwZWEzZDc5LTY5ZjQtNDRhYS1iMzkwLWM0OTc5ODQ3NTM1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.bsvelqEA7fKYcqHVTj-6mN2P-nufIyD9B8riMgLQvgK6EY_WBqUJQ_V_4RlpRvWkLARrczh1fdhprV6AcFXbppHxYppiKdi69FMKH5HmoejdNppMvehNi9ceRT9F5GrwNi6_1HhOhOUjgeG23QJRiCHK3KhgtPQEnGppraMKrOFlZKB9zGnrEUUru6p6svB0Oykz9nTOkH9eyGtBScUYSyrbvzGsQVOvVX5jcOSiBSipzZYqHcJ_tSfIgR7anYs5k8pFCyyhyYeW_8yfbvvNDEzFAyK7zddAwtaJ1GB2SM4ng1HXp28bsnoRlXiNOKVp-iemN8uHdn2cHRGrMCtNQA'

Example response

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

{
  "id" : "aa49ca53-3b68-4871-9971-1e510ad3d880",
  "networkId" : "dc2299ac-9c84-421f-a862-b7b01a275697",
  "zitiId" : "ziti.id.cokbsaau",
  "name" : "My Service cmapg8dh",
  "encryptionRequired" : true,
  "terminatorStrategy" : "sticky",
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "modelType" : "AdvancedTunnelerToEndpoint",
  "ownerIdentityId" : "71cd9536-74cb-40d1-b34b-d2b6efe1daa2",
  "createdBy" : "71cd9536-74cb-40d1-b34b-d2b6efe1daa2",
  "createdAt" : "2025-01-11T20:36:39.016210Z",
  "updatedAt" : "2025-01-11T20:36:39.065130Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "26569d8e-f10f-4c16-99ff-628146068569" : "4115e0d9-0a79-4d59-a999-ac21cc56bfce",
    "191cfd2c-9a19-4920-9479-86dedba51a0e" : "10be20bf-0a37-4866-8458-cf8065717ec5"
  },
  "model" : {
    "clientIngress" : {
      "protocols" : [ "udp", "tcp" ],
      "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" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dc2299ac-9c84-421f-a862-b7b01a275697",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/aa49ca53-3b68-4871-9971-1e510ad3d880",
      "title" : "My Service cmapg8dh"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?id=4115e0d9-0a79-4d59-a999-ac21cc56bfce,10be20bf-0a37-4866-8458-cf8065717ec5"
    }
  }
}

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

{@link Config}s referenced by id in this property will be applied to the created {@link Service}. Note, only existing, non-exclusive {@link Config}s may be referenced via this property. {@link Config}s applied via this property and the {@link #configNames} and {@link #configs} properties must not conflict. That is, each must be of a different {@link ConfigType}. Applying {@link Config}s to a service via this {@link #configIds}, {@link #configNames} or {@link #configs} are mutually exclusive to a model based {@link Service}. Setting any of these three properties while also specifying a {@link #model} will result in an error.

configNames

Array[String]

true

{@link Config}s referenced by name in this property will be applied to the created {@link Service}. Note, only existing, non-exclusive {@link Config}s may be referenced via this property. {@link Config}s applied via this property and the {@link #configIds} and {@link #configs} properties must not conflict. That is, each must be of a different {@link ConfigType}. Applying {@link Config}s to a service via this {@link #configNames}, {@link #configIds} or {@link #configs} are mutually exclusive to a model based {@link Service}. Setting any of these three properties while also specifying a {@link #model} will result in an error.

configs

Array[Object]

true

{@link Config}s created via this property will be applied to the created {@link Service}. Each entry is this property must be a valid {@link CreateConfig} directive, and the created {@link Config} will be marked as exclusive to the created {@link Service}. This will create exclusive {@link Config}s. If the intent is to create a shared {@link Config}, then it must be created separately, then referenced via either {@link #configIds} or {@link #configNames}. {@link Config}s applied via this property and the {@link #configIds} and {@link #configs} properties must not conflict. That is, each must be of a different {@link ConfigType}. Applying {@link Config}s to a service via this {@link #configs}, {@link #configIds} or {@link #configNames} are mutually exclusive to a model based {@link Service}. Setting any of these three properties while also specifying a {@link #model} will result in an error.

configs[].networkId

String

true

Specifies the id of the {@link Network} within which the resulting {@link Config} should be created.

configs[].name

String

true

Specifies the name to assign to the {@link Config}.

configs[].configTypeId

String

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have by the id of that {@link ConfigType}. The referenced {@link ConfigType} must exist, be in a valid state for use, and not be 'exclusive' or otherwise reserved by some other resource. This method of specifying the {@link ConfigType} is mutually exclusive with name and embedded create based declarations.

configs[].configTypeName

String

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have by the name of that {@link ConfigType}. The referenced {@link ConfigType} must exist, be in a valid state for use, and not be 'exclusive' or otherwise reserved by some other resource. This method of specifying the {@link ConfigType} is mutually exclusive with id and embedded create based declarations.

configs[].configType

Object

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have. The form of this {@link ConfigType} declaration is an embedded "command" to create a {@link ConfigType}. The resulting {@link ConfigType} instance will only be usable by this {@link Config} and it will be deleted when this {@link Config} is deleted. This method of specifying the {@link ConfigType} is mutually exclusive with id and name based declarations.

configs[].configType.networkId

String

true

Specifies the id of the {@link Network} within which the resulting {@link ConfigType} should be created.

configs[].configType.name

String

true

Specifies the name to assign to the {@link ConfigType}.

configs[].configType.schema

Object

true

Specifies the JSON Schema to assign to the {@link ConfigType}.

configs[].data

Object

true

Specifies the data to assign to the {@link Config}.

attributes

Array[String]

true

The contained attributes will be applied to the created Service.

modelType

String

true

If intending to create a model driven {@link Service}, then this property must be set to the type of model desired and must match the schema of the {@link #model} property. This property and {@link #model} are covariant. Either set both or neither.

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

model

Object

true

If intending to create a model driven {@link Service}, then this property must be set with the desired model data which must match the type indicated by {@link #modelType}. This property and {@link #modelType} are covariant. Either set both or neither.

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.eyJqdGkiOiJQN1Z0V0NlRmUzV1NlcXFTaDhvXzZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcxY2Q5NTM2LTc0Y2ItNDBkMS1iMzRiLWQyYjZlZmUxZGFhMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5OCwiZXhwIjoxNzM2NjMxMzk4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjZhYzA5MmY4LWIxMDUtNDZhZS1hMmIwLTNlNjg3NTMxYmFmZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.biRx-WFvFYwWOBI4ay6aZE23JoT9ZUEL9VFyLJi_WGUkBqNAMf6WCEj6epB_ZNDfTvbUv4qp_vU23tTRwZEpd2ePFLBNQv1su6cmpLrJIX5bVvtDZJqDH_VVv31cnklzgwTLFZx_SYmXw30ZcqvR3wXw2h5-Lv95ULh_NUPk8Cwww5FDalWOWErZw7wGuz9Q8ZuY0x3-z5InHbfOZw1DP_ca6lBAf1cbDFRliRtKnAECKe7kVz7UtDvRsb1Fg_Ok18ijJVEDViTutMRKWEHPYVbvILsM-Zx3uhsYopA_dRkXBQ3MAsVuBqE9T6usJkpgpIty6Qi66WmoPf3lhbtnZg' \
    -d '{"networkId":"dc2299ac-9c84-421f-a862-b7b01a275697","name":"My Service cmapg8dh","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" : "aa49ca53-3b68-4871-9971-1e510ad3d880",
  "networkId" : "dc2299ac-9c84-421f-a862-b7b01a275697",
  "zitiId" : "ziti.id.cokbsaau",
  "name" : "My Service cmapg8dh",
  "encryptionRequired" : true,
  "terminatorStrategy" : "sticky",
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "modelType" : "AdvancedTunnelerToEndpoint",
  "ownerIdentityId" : "71cd9536-74cb-40d1-b34b-d2b6efe1daa2",
  "createdBy" : "71cd9536-74cb-40d1-b34b-d2b6efe1daa2",
  "createdAt" : "2025-01-11T20:36:39.016210Z",
  "updatedAt" : "2025-01-11T20:36:39.065130Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "26569d8e-f10f-4c16-99ff-628146068569" : "4115e0d9-0a79-4d59-a999-ac21cc56bfce",
    "191cfd2c-9a19-4920-9479-86dedba51a0e" : "10be20bf-0a37-4866-8458-cf8065717ec5"
  },
  "model" : {
    "clientIngress" : {
      "protocols" : [ "udp", "tcp" ],
      "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

id

Object

false

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

When set, this property specifies the desired name of the Service. Omit the property when PATCHing and no name change is desired.

terminatorStrategy

String

true

configIds

Array[Object]

true

This property references existing {@link Config}s by id which, along with {@link #configNames}, are logically combined to form the set of {@link Config}s that the {@link Service} will be updated to have assigned to it after processing this request. That logical set must be contain references to ALL desired {@link Config}s. Any currently assigned {@link Config}s not in that set will be unlinked from the {@link Service}. Any {@link Config}s present in the set and not currently linked to the {@link Service} will be added to the set of assigned {@link Config}s. Any exclusive {@link Config} which are unlinked will be deleted. Non-exclusive {@link Config}s will remain, even if there are no {@link Service}s using them. Any exclusive {@link Config}s referenced by {@link #configIds} or {@link #configNames} must be exclusive to the {@link Config} being updated. Use {@link #createExclusiveConfigs} to add and link a new exclusive {@link Config}. A {@link Service} can only have one {@link Config} assigned to it for any given {@link ConfigType}. It is possible to remove one {@link Config} and and another, both of the same {@link ConfigType}, in the same update request, as long as the end result is a {@link Service} which conforms to this "at most one per type" rule. If the {@link Service} is model driven, as indicated by the presence of a non-null {@link #model} property, then all {@link Config} management is governed by the model. Attempts to assign, create, or update {@link Config}s via this and similar {@link Config} related properties outside the scope of the {@link #model} will be rejected. Clients not wishing to change the assigned {@link Config}s must omit this property from PATCH requests. Sending an empty collection will be interpreted as a directive to remove all linked {@link Config}s.

configNames

Array[String]

true

This property references existing {@link Config}s by id which, along with {@link #configIds}, are logically combined to form the set of {@link Config}s that the {@link Service} will be updated to have assigned to it after processing this request. That logical set must be contain references to ALL desired {@link Config}s. Any currently assigned {@link Config}s not in that set will be unlinked from the {@link Service}. Any {@link Config}s present in the set and not currently linked to the {@link Service} will be added to the set of assigned {@link Config}s. Any exclusive {@link Config} which are unlinked will be deleted. Non-exclusive {@link Config}s will remain, even if there are no {@link Service}s using them. Any exclusive {@link Config}s referenced by {@link #configIds} or {@link #configNames} must be exclusive to the {@link Config} being updated. Use {@link #createExclusiveConfigs} to add and link a new exclusive {@link Config}. A {@link Service} can only have one {@link Config} assigned to it for any given {@link ConfigType}. It is possible to remove one {@link Config} and and another, both of the same {@link ConfigType}, in the same update request, as long as the end result is a {@link Service} which conforms to this "at most one per type" rule. If the {@link Service} is model driven, as indicated by the presence of a non-null {@link #model} property, then all {@link Config} management is governed by the model. Attempts to assign, create, or update {@link Config}s via this and similar {@link Config} related properties outside the scope of the {@link #model} will be rejected. Clients not wishing to change the assigned {@link Config}s must omit this property from PATCH requests. Sending an empty collection will be interpreted as a directive to remove all linked {@link Config}s.

updateExclusiveConfigs

Map

true

This property declares update directives for existing exclusive {@link Config}s which are linked and exclusive to the {@link Service} being updated. Such exclusive {@link Config}s can not be directly updated. This property is a map where the key may be either the id or name of the existing exclusive {@link Config}, and the value is the update directive for that {@link Config}. This property can not be used to update non-exclusive {@link Config}s nor any {@link Config} not assigned to this {@link Service}. Use direct {@link Config} updates for non-exclusive {@link Config}s. Exclusive {@link Config} updates are processed after changes to assigned {@link Config}s via {@link #configIds} and {@link #configNames}, and before {@link #createExclusiveConfigs} have been processed. Updating an exclusive Config via this property implicitly retains the assignment of the Config to the Service. Only include entries in this map property for {@link Config}s which require an update. If the {@link Service} is model driven, as indicated by the presence of a non-null {@link #model} property, then all {@link Config} management is governed by the model. Attempts to assign, create, or update {@link Config}s via this and similar {@link Config} related properties outside the scope of the {@link #model} will be rejected.

createExclusiveConfigs

Array[Object]

true

This property declares the creation of new exclusive {@link Config}s which will be created and assigned to the {@link Service} as a result of processing this request. These {@link CreateConfig} directives are processed after changes to assigned {@link Config}s via {@link #configIds} and {@link #configNames}, and after {@link #updateExclusiveConfigs} have been processed. By processing updates prior to creates, it is possible to rename an existing exclusive {@link Config} via an update so that a {@link CreateConfig} within this property can create a new {@link Config} using the old existing {@link Config} name. A {@link Service} can only have one {@link Config} assigned to it for any given {@link ConfigType}. It is possible to remove one {@link Config} and create another, both of the same {@link ConfigType}, as long as the end result is a {@link Service} which conforms to this "at most one per type" rule. If the {@link Service} is model driven, as indicated by the presence of a non-null {@link #model} property, then all {@link Config} management is governed by the model. Attempts to assign, create, or update {@link Config}s via this and similar {@link Config} related properties outside the scope of the {@link #model} will be rejected.

createExclusiveConfigs[].networkId

String

true

Specifies the id of the {@link Network} within which the resulting {@link Config} should be created.

createExclusiveConfigs[].name

String

true

Specifies the name to assign to the {@link Config}.

createExclusiveConfigs[].configTypeId

String

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have by the id of that {@link ConfigType}. The referenced {@link ConfigType} must exist, be in a valid state for use, and not be 'exclusive' or otherwise reserved by some other resource. This method of specifying the {@link ConfigType} is mutually exclusive with name and embedded create based declarations.

createExclusiveConfigs[].configTypeName

String

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have by the name of that {@link ConfigType}. The referenced {@link ConfigType} must exist, be in a valid state for use, and not be 'exclusive' or otherwise reserved by some other resource. This method of specifying the {@link ConfigType} is mutually exclusive with id and embedded create based declarations.

createExclusiveConfigs[].configType

Object

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have. The form of this {@link ConfigType} declaration is an embedded "command" to create a {@link ConfigType}. The resulting {@link ConfigType} instance will only be usable by this {@link Config} and it will be deleted when this {@link Config} is deleted. This method of specifying the {@link ConfigType} is mutually exclusive with id and name based declarations.

createExclusiveConfigs[].configType.networkId

String

true

Specifies the id of the {@link Network} within which the resulting {@link ConfigType} should be created.

createExclusiveConfigs[].configType.name

String

true

Specifies the name to assign to the {@link ConfigType}.

createExclusiveConfigs[].configType.schema

Object

true

Specifies the JSON Schema to assign to the {@link ConfigType}.

createExclusiveConfigs[].data

Object

true

Specifies the data to assign to the {@link Config}.

attributes

Array[String]

true

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

modelType

String

true

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

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

model

Object

true

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

Response fields

Path Type Optional Description

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/aa49ca53-3b68-4871-9971-1e510ad3d880' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJtNG8xWm0tUkpqYThmcERWbks1LVdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk3ZGZmYjliLTJhNzEtNDFjZS1iMzliLTBmOTliODI3Yjk0OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgwMiwiZXhwIjoxNzM2NjMxNDAyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRhNmE3YTdhLTk1ZTUtNDU3Zi1hZmI1LTViODE1YWMzNjNmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgwMn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.iYZJSLLRYd-MPWHrNrLomfvjKaxL9TKUnSJyvFibvWmwepScRIt_0RHGBvGADnzOpgv51uoQr_y27F_AEa34oXd-V1z930neGT70QQdfZXboGI_EZU6EBODYvJjJVFpUtcD9ZJUzRdUnfTQXwZ5BohVCoYpvH8Wqc4VCl1imQQGrW5yxjpHG4aAFcNFNe-nIIWcemAkymTgfzAKQZfl38NcdP7SJ77Zl-ingeYyplKlOvFVBZPpwBtdwGiJBS7rOCVTl-_eN4qrCelXa9M98mAyouXn5iCTO5-9et1Ne7GSyrchc8PCQuwa-FvQKzc-ohxKRsFOi_tUfn7UXblm33A' \
    -d '{"name":"Our Service cmapg8dh","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" : "aa49ca53-3b68-4871-9971-1e510ad3d880",
  "networkId" : "dc2299ac-9c84-421f-a862-b7b01a275697",
  "zitiId" : "ziti.id.cokbsaau",
  "name" : "Our Service cmapg8dh",
  "encryptionRequired" : true,
  "terminatorStrategy" : "sticky",
  "attributes" : [ "#Attr-4", "#Attr-2" ],
  "modelType" : "AdvancedTunnelerToEndpoint",
  "ownerIdentityId" : "71cd9536-74cb-40d1-b34b-d2b6efe1daa2",
  "createdBy" : "71cd9536-74cb-40d1-b34b-d2b6efe1daa2",
  "createdAt" : "2025-01-11T20:36:39.016210Z",
  "updatedAt" : "2025-01-11T20:36:42.842932Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "configIdByConfigTypeId" : {
    "26569d8e-f10f-4c16-99ff-628146068569" : "d51d5f3d-fc60-47ab-8573-e9e62278ac1a",
    "191cfd2c-9a19-4920-9479-86dedba51a0e" : "b7c18755-7212-4263-878e-9ebdb9e97471"
  },
  "model" : {
    "clientIngress" : {
      "protocols" : [ "udp", "tcp" ],
      "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" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dc2299ac-9c84-421f-a862-b7b01a275697",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/aa49ca53-3b68-4871-9971-1e510ad3d880",
      "title" : "Our Service cmapg8dh"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?id=d51d5f3d-fc60-47ab-8573-e9e62278ac1a,b7c18755-7212-4263-878e-9ebdb9e97471"
    }
  }
}

Delete Service

DELETE /v2/services/{id}

Authorization

This endpoint requires delete action on the service resource type.

Path parameters

Parameter Type Optional Description

id

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/aa49ca53-3b68-4871-9971-1e510ad3d880' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJJZ2pjUWxrcElKRkhCOU1sdmhwOG93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQxYmUwNzEwLWRjZWYtNGVkOC1hYmU3LWJhOTgyMzc5NTFjOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgwNCwiZXhwIjoxNzM2NjMxNDA0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA2ODZjZTJkLTM3YTUtNGQzNC1iNDZkLTQ4ZDY2NTI4MmExN1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgwNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.nLQRatc_GoZBWdtpih8dp4rVgHOSKYvuTlWhDR8CF4TBnq4Y0eTQ8g1YWUboBdRkgBiJXJc5Xu2qmvJ7jMie1__KNNFttFgr6Ps61FW9h57ijNexYD0p9uwyrvx0FrEx-E76DLuM1Qb_wEhUFZxKCHYfBK7NHBhVYxQYXTKHriaV-aZV4Mv-tFMsNIk0xkO_16fhzkme2GfowOd-Tu8HHeSJgJr-7r0fDnGr9AyORApr96Zk78YlnJv7g8a82bBc6cxRWBSNKt5cR3sz-LAk883ognD5zWBSQxjYFdZk-hbaqkAAYB3o2iHBmJlA7IN0L1Lrr8uX9_ix-dFRX9TTVg'

Example response

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

{
  "id" : "aa49ca53-3b68-4871-9971-1e510ad3d880",
  "networkId" : "dc2299ac-9c84-421f-a862-b7b01a275697",
  "zitiId" : null,
  "name" : "Our Service cmapg8dh",
  "encryptionRequired" : true,
  "terminatorStrategy" : "sticky",
  "attributes" : [ ],
  "modelType" : "AdvancedTunnelerToEndpoint",
  "ownerIdentityId" : "71cd9536-74cb-40d1-b34b-d2b6efe1daa2",
  "createdBy" : "71cd9536-74cb-40d1-b34b-d2b6efe1daa2",
  "createdAt" : "2025-01-11T20:36:39.016210Z",
  "updatedAt" : "2025-01-11T20:36:44.505290Z",
  "deletedBy" : "d1be0710-dcef-4ed8-abe7-ba98237951c9",
  "deletedAt" : "2025-01-11T20:36:44.471Z",
  "configIdByConfigTypeId" : {
    "26569d8e-f10f-4c16-99ff-628146068569" : "d51d5f3d-fc60-47ab-8573-e9e62278ac1a",
    "191cfd2c-9a19-4920-9479-86dedba51a0e" : "b7c18755-7212-4263-878e-9ebdb9e97471"
  },
  "model" : {
    "clientIngress" : {
      "protocols" : [ "udp", "tcp" ],
      "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" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dc2299ac-9c84-421f-a862-b7b01a275697",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/aa49ca53-3b68-4871-9971-1e510ad3d880",
      "title" : "Our Service cmapg8dh"
    },
    "configs" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs?id=d51d5f3d-fc60-47ab-8573-e9e62278ac1a,b7c18755-7212-4263-878e-9ebdb9e97471"
    }
  }
}

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

id

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.eyJqdGkiOiJvREM0Z0lucmctX3hCR2dQN1NPZF9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJjNGNmY2JmLTgxMWEtNDA4OC05MTE0LWZjZThmZjZhYTRjNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5MiwiZXhwIjoxNzM2NjMxMzkyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQxMDdiY2FmLTU1MmItNGYxNi04NDE4LTUxZGY4OGQ2MTlhNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.OJNDZXQ19SlmgGyYcroHRI0K-gzFASL_2jwoCpySOXWvPetFKqIxCJ2kDh-xQ_ft-vUeGnKuTt9tJDqNrh30TAp5kyZ2XNKVZIqf8FE5RxOBhq780i0vdQwpgsPooc3dXh_9IrrCdxb9wByRnI7ouBqTzjeQQv_M0UYQNJ72i9z3QHguGcRc5vF41PaD0qp_QJv94ETbipH50PLOYX-esfXa21pUA1D-a8WFDBlnNWxJWWrvE5dOqs21LHVQfHY4XaC6UoExHyTgttqG19bKOM3oQFzqV_bVnE7GbqvkVad6kpF4Oe7CCI2RuCDCQV9mxNJ0AKnYp_O_OdX_wWQ17w'

Example response

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

{
  "_embedded" : {
    "appWanList" : [ {
      "id" : "1fc4a37d-6b50-4ce1-b924-77388f82a451",
      "ownerIdentityId" : "3471e650-9fba-43d5-808f-bb4538fd3def",
      "createdBy" : "3471e650-9fba-43d5-808f-bb4538fd3def",
      "createdAt" : "2025-01-11T20:36:32.687469Z",
      "updatedAt" : "2025-01-11T20:36:32.751565Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Updated App Wan name",
      "zitiId" : "982f8795-3800-4fba-ac9c-ece5961b3e8a",
      "networkId" : "07ab0d05-1fd1-4a00-a950-6a82e64e28b4",
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/1fc4a37d-6b50-4ce1-b924-77388f82a451",
          "title" : "Updated App Wan name"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/07ab0d05-1fd1-4a00-a950-6a82e64e28b4",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "469c5b8f-65cc-4044-8619-433b533e979b",
      "ownerIdentityId" : "22ab5173-0e9e-44bd-bd4f-12999387f154",
      "createdBy" : "22ab5173-0e9e-44bd-bd4f-12999387f154",
      "createdAt" : "2025-01-11T20:36:32.841218Z",
      "updatedAt" : "2025-01-11T20:36:32.841780Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "appwan-337",
      "zitiId" : "76a22879-4cec-4e81-a115-3469fed6c629",
      "networkId" : "ff39344a-9964-4e47-bafa-07d8b2c3abf5",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/469c5b8f-65cc-4044-8619-433b533e979b",
          "title" : "appwan-337"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ff39344a-9964-4e47-bafa-07d8b2c3abf5",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "4cb37388-dba3-4af2-8644-3e84df7aa3a7",
      "ownerIdentityId" : "c20436f3-e3ca-44ee-85b8-d8ddc0ed2725",
      "createdBy" : "c20436f3-e3ca-44ee-85b8-d8ddc0ed2725",
      "createdAt" : "2025-01-11T20:36:32.636928Z",
      "updatedAt" : "2025-01-11T20:36:32.637490Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "appwan-307",
      "zitiId" : "e59ec14f-bdb4-43f4-b0d2-6bafff916339",
      "networkId" : "5d98968d-56c8-4250-b09c-fa7662052a97",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/4cb37388-dba3-4af2-8644-3e84df7aa3a7",
          "title" : "appwan-307"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5d98968d-56c8-4250-b09c-fa7662052a97",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "5f71ea51-beba-45cb-a2c6-c74213f501bb",
      "ownerIdentityId" : "4e9d900a-eac5-4e5a-8ac0-196e9271fc2d",
      "createdBy" : "4e9d900a-eac5-4e5a-8ac0-196e9271fc2d",
      "createdAt" : "2025-01-11T20:36:32.583572Z",
      "updatedAt" : "2025-01-11T20:36:32.584317Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "appwan-297",
      "zitiId" : "7655e57d-cf39-49d8-84a8-083f55f86cf9",
      "networkId" : "fb670b28-697d-45f1-b76d-153cbceaa08d",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/5f71ea51-beba-45cb-a2c6-c74213f501bb",
          "title" : "appwan-297"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/fb670b28-697d-45f1-b76d-153cbceaa08d",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "8cbd0096-fae4-4bbe-80a3-7749a2932341",
      "ownerIdentityId" : "8b7ef6b0-66a2-4087-b2b4-f73202641d8f",
      "createdBy" : "8b7ef6b0-66a2-4087-b2b4-f73202641d8f",
      "createdAt" : "2025-01-11T20:36:32.064935Z",
      "updatedAt" : "2025-01-11T20:36:32.068930Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "appwan-277",
      "zitiId" : "818d9367-b45a-4e77-bfca-2c5554e99625",
      "networkId" : "c9e2d93b-f663-4380-b331-de7ccf824774",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/8cbd0096-fae4-4bbe-80a3-7749a2932341",
          "title" : "appwan-277"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c9e2d93b-f663-4380-b331-de7ccf824774",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "c014f197-493c-4da4-be31-71cfaaa6d8e3",
      "ownerIdentityId" : "556549a0-e9fb-44a9-85fe-ea609aafe8d8",
      "createdBy" : "556549a0-e9fb-44a9-85fe-ea609aafe8d8",
      "createdAt" : "2025-01-11T20:36:32.789703Z",
      "updatedAt" : "2025-01-11T20:36:32.804882Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "appwan-327",
      "zitiId" : "5d61a29e-8c53-427d-b3b8-9bcfb0291127",
      "networkId" : "84b9dbe2-aec1-4548-addc-e593be6bd5d0",
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "endpointAttributes" : [ "#usendpoints" ],
      "postureCheckAttributes" : [ "#windows" ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/c014f197-493c-4da4-be31-71cfaaa6d8e3",
          "title" : "appwan-327"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/84b9dbe2-aec1-4548-addc-e593be6bd5d0",
          "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

id

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/1c023cda-0c42-4a1e-81f9-00eab20551dd' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJPYkRUckpuZW00YmtYVnJTcHl2enp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc1ZDk0NDM4LWM1NGQtNDg1YS1iNTFkLWU4MDVjNTI4OWQ5MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5MiwiZXhwIjoxNzM2NjMxMzkyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImMxMjRlMDk5LTlmZWYtNDIyOC1iZDkyLThlMjY2M2IxOTlhNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.mYW8Jb8OYHLG07XLlCYXn8CPIolLVnJ3KltbOkLP_vTiVupoeDgYZkbKuz9sf_qTDhn36Qd08P-oFOWvmFo8FP73-3U7-HdAZAr_M6o3ZBsaiGAgHXiLgtvBfHamNrLtX00-CIncmMjuHPvEMHTvSgkmWZ2WddsBdpckmxiku4w_1WFIxwIEzrrUMU65YInth1F6DwBkC5plKVmiVKel6c92zd3QIxoMOtRrbJskM3ctN2XyfhHteCA98L0irWN6lueqjlN9O1YpwU8JgmU0Oc3lC-5oLt6zYlVxHe3bbotdWFixwQmcQ_GtM1CLAPMeJFbqw63elsrqCzCnXth_YQ'

Example response

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

{
  "id" : "1c023cda-0c42-4a1e-81f9-00eab20551dd",
  "ownerIdentityId" : "9cf0b225-6563-46d6-bdc4-c97fa22f8c0f",
  "createdBy" : "9cf0b225-6563-46d6-bdc4-c97fa22f8c0f",
  "createdAt" : "2025-01-11T20:36:32.893030Z",
  "updatedAt" : "2025-01-11T20:36:32.893665Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "appwan-347",
  "zitiId" : "7d0e0b90-d8f8-4559-9312-26fd7cfd47be",
  "networkId" : "af5f47cd-b54f-4ff2-8338-23e6f676d459",
  "serviceAttributes" : [ ],
  "endpointAttributes" : [ ],
  "postureCheckAttributes" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/1c023cda-0c42-4a1e-81f9-00eab20551dd",
      "title" : "appwan-347"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/af5f47cd-b54f-4ff2-8338-23e6f676d459",
      "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

id

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.eyJqdGkiOiIxb3JnMlc4LW9iYUZIU3pCcXQzRk53IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE5MWY1YzI2LTY4OWEtNGIxNC1iNWI3LTY4MWI2NDI2YzZhZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc0NSwiZXhwIjoxNzM2NjMxMzQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFiYmVhYWQyLTYxMmYtNDFkYS05MmMzLTgwZTU3NzMyMTY2MVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc0NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.NNCtPZxo5M7W6dCRlfQQEQrk3O2ZDXtsgJnHElrtvEX1bqkSLsgeCq5ZYTw13XcLWxA8wHLsURVZvhQGjK5sPF7PtfR35RJXjqpAlP6N6_xw2gUookFSMf06MBQgGX-TJ4GnaM1A0bCV2ooP-EIK_owSCuYWLFU-7uqd9OV_xO63y8l6BUno69m7Zwy3ZIzoI4MC2qMpiFERGrDZWkktL2Uma6J6WkHlMdFl4iu8UoktIrTuxrnJszOkWVZS3bVOZKQlGFYpw4gU34m2sfTukl68ZVgvc9W4B1Ozv5igCo2O2OdCTU0XzEl3-EGkuEsDTorHAwLL-vzAPywrux5FQw'

Example response

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

{
  "_embedded" : {
    "appWanList" : [ {
      "id" : "d196a03e-ee2f-4ce9-a197-cd20ba0834bc",
      "ownerIdentityId" : "2e46e3d3-4ddc-41f5-87d5-70a7cdeac05d",
      "createdBy" : "2e46e3d3-4ddc-41f5-87d5-70a7cdeac05d",
      "createdAt" : "2025-01-11T20:35:45.741449Z",
      "updatedAt" : "2025-01-11T20:35:45.761041Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Find Test AppWan 1",
      "zitiId" : "6e021679-2c44-450a-ad1c-fbc227490d3f",
      "networkId" : "cf1e8dda-a4b6-4c57-a94e-c3fa12e10f3b",
      "serviceAttributes" : [ "#seAttr1", "#seAttr2" ],
      "endpointAttributes" : [ "#epAttr2", "#epAttr1" ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/d196a03e-ee2f-4ce9-a197-cd20ba0834bc",
          "title" : "Find Test AppWan 1"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/cf1e8dda-a4b6-4c57-a94e-c3fa12e10f3b",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "fe7b47f0-ec75-4f46-8fc3-58bf430f2536",
      "ownerIdentityId" : "2e46e3d3-4ddc-41f5-87d5-70a7cdeac05d",
      "createdBy" : "2e46e3d3-4ddc-41f5-87d5-70a7cdeac05d",
      "createdAt" : "2025-01-11T20:35:45.767060Z",
      "updatedAt" : "2025-01-11T20:35:45.777158Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "name" : "Find Test AppWan 2",
      "zitiId" : "a55c89ee-0466-4daf-a513-1ddda16f008a",
      "networkId" : "cf1e8dda-a4b6-4c57-a94e-c3fa12e10f3b",
      "serviceAttributes" : [ "#seAttr1", "#seAttr3" ],
      "endpointAttributes" : [ "#epAttr1" ],
      "postureCheckAttributes" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/fe7b47f0-ec75-4f46-8fc3-58bf430f2536",
          "title" : "Find Test AppWan 2"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/cf1e8dda-a4b6-4c57-a94e-c3fa12e10f3b",
          "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.eyJqdGkiOiJaUGgzdGJGeW1NcFZBR2xoeXktYVZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM3MDBkNjhjLThkYmEtNDllMy1hNzY3LWZiNGU5NGI0NjBhNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5MywiZXhwIjoxNzM2NjMxMzkzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjllMTc3MDc5LTAyY2MtNGFiMC05YTlmLWUwNTk4MDg2YzMxZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.OPTotbYMWK6dPyM0HlLvHvwL2Jlq9ljbaleljsJxYkjyo3RrQNhBje-qISvVtgNgydszuvNMrKfwXotpMa77bgZ7KQGd3V4yCITb3kC676Hq6mDQP-d8Ao277VZrNf3WWB2kixoToEbrigj9VTWm-zi-Ap7xVfi-STp1Z-uCBTat_kMw0fFR7-DOOrlVY1sGxnwXCWcXN7i1hfm1LjpZ3MCzntdidpKH0bbjuyUzJeNQL2AppBqj9GaARZLVPoW4eXdhDCQyXie32Q-mHxOcsD4R9VT1UUrRMhjHO5litzakax7Hog8VsHNdomKZlOUuMPtUFRZc2qu5xxFXpOjDjQ' \
    -d '{"networkId":"fc12d524-4140-44d7-ab20-114aec1c0b12","name":"Test App Wan 1736627793","serviceAttributes":["#service01"],"endpointAttributes":["@endpoint-379","#accessclients"],"postureCheckAttributes":["#windows"]}'

Example response

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

{
  "id" : "060445cf-9aa1-4759-b69a-c547a9b57f67",
  "ownerIdentityId" : "3700d68c-8dba-49e3-a767-fb4e94b460a6",
  "createdBy" : "3700d68c-8dba-49e3-a767-fb4e94b460a6",
  "createdAt" : "2025-01-11T20:36:33.062553Z",
  "updatedAt" : "2025-01-11T20:36:33.068544Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Test App Wan 1736627793",
  "zitiId" : "1d51e631-ea7d-4892-a7ec-2e486d9a4532",
  "networkId" : "fc12d524-4140-44d7-ab20-114aec1c0b12",
  "serviceAttributes" : [ "#service01" ],
  "endpointAttributes" : [ "@endpoint-379", "#accessclients" ],
  "postureCheckAttributes" : [ "#windows" ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/060445cf-9aa1-4759-b69a-c547a9b57f67",
      "title" : "Test App Wan 1736627793"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/fc12d524-4140-44d7-ab20-114aec1c0b12",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/8e8cf6d4-50d8-4b05-b9d5-fbf52f72af0a",
      "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

id

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/1fc4a37d-6b50-4ce1-b924-77388f82a451' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJkTW4zZGdoNFE3amhQNE82ck9iUUtnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQzODBmMmU2LThiMDctNDVkNS05YTg0LTI5MGVlYjc0MDVhZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5MiwiZXhwIjoxNzM2NjMxMzkyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJhYzdmODM2LTgyZTMtNDI0Ni05ZDJmLTNmZGQ0ZWU5ZjIyMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.gfjRI-GpJ3l5DabDnFfeg9BMbOvLIcHMlZomOIPwiQVntO7EjdtMHNLb7PaMYmV2TKVdDoJnrhaaPz-zPixhyojq_wX0QLOCwxbSqCb_zGPFFtjStQpZO4Gu2KbhiyAnRRBtEnp7C8o7aiP3erxt6PmnI-3UZsi0bQQc2gRDuhapm2XoOL2F-AKMtlN711wrf-tONIcyqVAv_9AYf9JPolmkQjE_EzoCc6KTpyqy5WPb18UEJ6ErJWCxh_NrLV3rxefios-eO4oKbFf1vcvK9h5FXxlQwuIq-8O1Jd9ykcOSPNj-2hJzFMcnGBe_XshrE-9I7QE_0ar-2Q6N5KxFKQ' \
    -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" : "1fc4a37d-6b50-4ce1-b924-77388f82a451",
  "ownerIdentityId" : "3471e650-9fba-43d5-808f-bb4538fd3def",
  "createdBy" : "3471e650-9fba-43d5-808f-bb4538fd3def",
  "createdAt" : "2025-01-11T20:36:32.687469Z",
  "updatedAt" : "2025-01-11T20:36:32.751565Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "name" : "Updated App Wan name",
  "zitiId" : "982f8795-3800-4fba-ac9c-ece5961b3e8a",
  "networkId" : "07ab0d05-1fd1-4a00-a950-6a82e64e28b4",
  "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
  "endpointAttributes" : [ "#usendpoints" ],
  "postureCheckAttributes" : [ "#windows" ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/1fc4a37d-6b50-4ce1-b924-77388f82a451",
      "title" : "Updated App Wan name"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/07ab0d05-1fd1-4a00-a950-6a82e64e28b4",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/7942db8f-53de-4d1e-9506-acf35ef90a97",
      "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

id

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/8d16be7c-a445-451e-a709-f5952e2580d3' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI0eGh5TXRwRHdUUVhTM0lSTjZsV0V3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYxY2E0ZDk2LTZhMTUtNDU0Ny05YTViLWI2ZDdjNGQ5ODYwNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5MiwiZXhwIjoxNzM2NjMxMzkyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY4NjUxMmRhLTgxNzQtNDU1Yy05MmQ5LTE0MzU3OGYzZmVkZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.km_2OnMoTKtwXwUpgmKJJYOjP_yUs5zpHrSpKKDwCl0Pb1vAqlsxZ-DgrXhPt5YmhrcCJvGyqJueW_EQc5DzpdIShjCPMPvA-brhL1W0yGPhDSfVtLtvLpLB8Cpn8wrbYYjTOHkS-oVH_XfFghlsYa0RmoYDktfW8-NObB_dmqfQvr8WGvHgPQFALeE9xVlpHsbC-L6kJ-SG2ilcD1p_8mRPTG38BkwrYTGCrehHU7raDlGM6t-EgMsu0KjrJV3UJq09nNWirElPWR4tSmClHt_Rd-pdtGmdPdHUzI-5zvRUXqoVlmMD70Jsbx-mFEwkqmzvTLt7b-AyS8VDN1ig-Q'

Example response

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

{
  "id" : "8d16be7c-a445-451e-a709-f5952e2580d3",
  "ownerIdentityId" : "836d9be1-70f8-47c0-befb-b53f354a7698",
  "createdBy" : "836d9be1-70f8-47c0-befb-b53f354a7698",
  "createdAt" : "2025-01-11T20:36:32.504384Z",
  "updatedAt" : "2025-01-11T20:36:32.531872Z",
  "deletedBy" : "61ca4d96-6a15-4547-9a5b-b6d7c4d98607",
  "deletedAt" : "2025-01-11T20:36:32.520Z",
  "name" : "appwan-287",
  "zitiId" : null,
  "networkId" : "6af9f412-5d4d-439e-8a9d-1ed5f46a2e89",
  "serviceAttributes" : [ ],
  "endpointAttributes" : [ ],
  "postureCheckAttributes" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/8d16be7c-a445-451e-a709-f5952e2580d3",
      "title" : "appwan-287"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6af9f412-5d4d-439e-8a9d-1ed5f46a2e89",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/cb346f45-a3c3-4a57-9577-f0915ee06b17",
      "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

id

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

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

data.promptOnWake

Boolean

true

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

data.promptOnUnlock

Boolean

true

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

data.ignoreLegacyEndpoints

Boolean

true

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

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.eyJqdGkiOiJ3WHprZDZNXzlyWXhlZE8wdUxudm13IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhiN2RiNzk4LWIyNTMtNGY4My04YWJjLWM5MTY4ZTUxOGM4OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc0MywiZXhwIjoxNzM2NjMxMzQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjliNDc3MmM0LTg5YWQtNDU4Ny05ODdiLTQ4MTlkYzVmNWE2NlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc0M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.OIttqCNxmZBiyVvY6kW8D6YGRR6rU-BeThkpKLqPlhqSjEdCCxq11oIxrEpYpfOLlaNSBUDCcbThSYsiKFM2jg9uiuE-GwzlrNffKdiqQTkd0r4CaSWONvEfuHSucsvOVFUdEZqSjVMHPSl_MSPvHMZC6DCXMIRYZM_A1rUB2-YiiCAZlclacs4jBz1vpIFjajH4qxNjm9FAQKALE8jizgG6v_zRq33oc3h99-rlLCruM6gvoOJIpYGBteSH28jo7eWKO0cPFkamIIv_2wo-ohx1jvT5mW-_FRAvbx0B9gkgmCHadmEzScnG1iD3wZYLzo-enQ_6JrBv4SvdMu-jzg'

Example response

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

{
  "_embedded" : {
    "postureCheckList" : [ {
      "id" : "47f8998e-4de3-460a-8bd3-791123023cc2",
      "zitiId" : "zitiId-fake-573140c1-90d1-4df3-a178-932a7b5467fe",
      "name" : "Find Test Posture Check 1",
      "networkId" : "9c8a00d7-fea6-46ae-b4f9-7a4486fa5217",
      "type" : "DOMAIN",
      "ownerIdentityId" : "2c23ef60-9533-4ab6-adbd-73f12e3ab454",
      "createdBy" : "2c23ef60-9533-4ab6-adbd-73f12e3ab454",
      "createdAt" : "2025-01-11T20:35:43.356979Z",
      "updatedAt" : "2025-01-11T20:35:43.356979Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#attr2", "#attr1" ],
      "data" : {
        "domains" : [ "abc.com" ]
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9c8a00d7-fea6-46ae-b4f9-7a4486fa5217",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/47f8998e-4de3-460a-8bd3-791123023cc2",
          "title" : "Find Test Posture Check 1"
        }
      }
    }, {
      "id" : "bb44d688-fe66-46c1-b90f-b46bb0e57565",
      "zitiId" : "zitiId-fake-87c97318-16bd-4f20-b760-d494aedc7293",
      "name" : "Find Test Posture Check 2",
      "networkId" : "9c8a00d7-fea6-46ae-b4f9-7a4486fa5217",
      "type" : "DOMAIN",
      "ownerIdentityId" : "2c23ef60-9533-4ab6-adbd-73f12e3ab454",
      "createdBy" : "2c23ef60-9533-4ab6-adbd-73f12e3ab454",
      "createdAt" : "2025-01-11T20:35:43.368935Z",
      "updatedAt" : "2025-01-11T20:35:43.368935Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "attributes" : [ "#attr3", "#attr1" ],
      "data" : {
        "domains" : [ "abc.com" ]
      },
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9c8a00d7-fea6-46ae-b4f9-7a4486fa5217",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/bb44d688-fe66-46c1-b90f-b46bb0e57565",
          "title" : "Find Test Posture Check 2"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Posture Check (deprecated)

GET /v2/posture-checks/{id}

Deprecated. Use deletedAt filter instead, will be deleted 1/1/2023.

@deprecated use deletedAt filter instead, will be deleted 1/1/2023.

See Posture Checks.

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/241302a3-ccac-4e37-85b4-06d10353522d' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2MTN2WVRPcVdGcjFwWWRTZ2Jjd3NRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQwNTdhODEzLTQ3NGQtNDc4Zi1iMWQ0LTE4NzY3YzM4NTlkMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NSwiZXhwIjoxNzM2NjMxNDY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM1NGEzOGMzLTA1NDgtNDYyYi1hOTJlLWEwZGVlYWE1YTMwMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Njuwtc_Ppy3nrJo--psUQMiF18QaILdKPb5bb6YpMHsJMQ3Q3tFzlqTWiiJfa8BBH10ZAE8nUsWrlM50ksq7ZeAUjfZTbKEj8kXnUHRaRt5qLH15TucJMzQQqJQUi9yOnIhqarvuvIp6BSsV4n7ni5ZYnrs8X_1eDVwNNPutfgUmjLobtRLz_5g8OjYyC5DpXtyOozCboNZZnTzkASYQL5sMpckdp_cAUprvHWzkYZCUSwvJfnoZy7Cws3DVHLoeY6NG315u1teAsXDmJTuxNDORTDDuGmJnYIG9VQJgEKh8Ex9QwBbp2WbdUhX9mueywgMbb8INMQIxR-1gOm0L7w'

Example response

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

{
  "id" : "241302a3-ccac-4e37-85b4-06d10353522d",
  "zitiId" : "ziti.id.diyu2kjw",
  "name" : "My Posture Check 1059263161045",
  "networkId" : "210058d2-665a-4819-896c-c96f5f9c5491",
  "type" : "MFA",
  "ownerIdentityId" : "12f4e00b-0201-439b-9f2e-722bba4400fc",
  "createdBy" : "12f4e00b-0201-439b-9f2e-722bba4400fc",
  "createdAt" : "2025-01-11T20:37:45.245836Z",
  "updatedAt" : "2025-01-11T20:37:45.245836Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-1", "#Attr-2" ],
  "data" : {
    "timeoutSeconds" : 1234,
    "promptOnWake" : true,
    "promptOnUnlock" : false,
    "ignoreLegacyEndpoints" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/241302a3-ccac-4e37-85b4-06d10353522d",
      "title" : "My Posture Check 1059263161045"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/210058d2-665a-4819-896c-c96f5f9c5491",
      "profile" : "parent"
    }
  }
}

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

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

data.promptOnWake

Boolean

true

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

data.promptOnUnlock

Boolean

true

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

data.ignoreLegacyEndpoints

Boolean

true

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

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.eyJqdGkiOiI2eEpCM2JhUXRrYVlMWlhLUmJJZGlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjEyZjRlMDBiLTAyMDEtNDM5Yi05ZjJlLTcyMmJiYTQ0MDBmYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NSwiZXhwIjoxNzM2NjMxNDY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjZkN2ZmODBmLWE1NzItNDkwYS05MDFmLTBjMzQ4YzMxNGIyOFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.mSBNem6BphXQuV1mRgOjget1dCU6rDbbgiR03O0OumSbrbBwJJpbJGWRZOx-KrqPgUJ-YRzrqdUa98mH33rKi4On7qB614hQJqfm2tn26zsIlcDYMkhCMmevwAJ6zLiDcWZIjx87GDetp5cmlGjt4nuycQtdZ6ni89nI1V5lHzapXJV8XaebvxLtSFmmdtKaz2oGzv700IYhYzsPjWD7UUDpSVQGcwYOxThFVqEqskDrW4G9Rl2_SwkpjvpfH0k2DdFghodBVlClnO78kL5O2uXyT84_hUYbyrax7Tmb7LOHiP9N_U-xI7_iemfHiLiALQspUsRkx01rIH5hEa-P7w' \
    -d '{"name":"My Posture Check 1059263161045","networkId":"210058d2-665a-4819-896c-c96f5f9c5491","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: 642

{
  "id" : "241302a3-ccac-4e37-85b4-06d10353522d",
  "zitiId" : "ziti.id.diyu2kjw",
  "name" : "My Posture Check 1059263161045",
  "networkId" : "210058d2-665a-4819-896c-c96f5f9c5491",
  "type" : "MFA",
  "ownerIdentityId" : "12f4e00b-0201-439b-9f2e-722bba4400fc",
  "createdBy" : "12f4e00b-0201-439b-9f2e-722bba4400fc",
  "createdAt" : "2025-01-11T20:37:45.245836Z",
  "updatedAt" : "2025-01-11T20:37:45.245836Z",
  "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

id

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

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

data.promptOnWake

Boolean

true

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

data.promptOnUnlock

Boolean

true

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

data.ignoreLegacyEndpoints

Boolean

true

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

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/241302a3-ccac-4e37-85b4-06d10353522d' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJPRlpsWjlhRkRHRWRiaTVZN3Nib3R3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZhZTk0OGZmLWYyYjMtNGM2ZC04YTEwLTY2MTA1YmRmMTk0ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NiwiZXhwIjoxNzM2NjMxNDY2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI3MmJkOTE4LTVmNzItNDdiZi04MDA3LWU2MDI4OWQ4MjRjYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Efq9X7gEVDO9cRx66T4Vs2oii-swVkf2uBmclqYOr_o32G3mrnZBofH-CkYP-C6Yi6C_UNXiQr8t97cXKMALGno74cmP99Pg8MoI3jz9wy0JizyijsHOznkUscW6O_wlApXXNXfmtufdWvq0m6QEkYlb3lp4IKasvwjM2p9qUBRD5wSLJY56EDtBQ7ivo5eIPo8AP6VH2EYLTjKl-YzuaV3_NeBpKrZebyi2_0p9B087wwqBcioMr4zsWcsWx3_MK4AxezPPb19glxbwQzdeUhRrMqK485VyW0wTr2B0QhNWw4aldlkbjmOAAQJbRZlfjoI3dn5yLg_3uh2x9k1kaA' \
    -d '{"name":"Our Service 1059263161045","attributes":["#Attr-4","#Attr-2"]}'

Example response

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

{
  "id" : "241302a3-ccac-4e37-85b4-06d10353522d",
  "zitiId" : "ziti.id.diyu2kjw",
  "name" : "Our Service 1059263161045",
  "networkId" : "210058d2-665a-4819-896c-c96f5f9c5491",
  "type" : "MFA",
  "ownerIdentityId" : "12f4e00b-0201-439b-9f2e-722bba4400fc",
  "createdBy" : "12f4e00b-0201-439b-9f2e-722bba4400fc",
  "createdAt" : "2025-01-11T20:37:45.245836Z",
  "updatedAt" : "2025-01-11T20:37:46.330995Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "attributes" : [ "#Attr-4", "#Attr-2" ],
  "data" : {
    "timeoutSeconds" : 1234,
    "promptOnWake" : true,
    "promptOnUnlock" : false,
    "ignoreLegacyEndpoints" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/241302a3-ccac-4e37-85b4-06d10353522d",
      "title" : "Our Service 1059263161045"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/210058d2-665a-4819-896c-c96f5f9c5491",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/e6c46575-9b8c-4959-b838-ab430a5ba47c",
      "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

id

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/241302a3-ccac-4e37-85b4-06d10353522d' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJEbVdaYTZqenE2T0poaFY5Y2c2THBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJiNjBiYWFjLWE3YTgtNGJmOS05NzhiLTNlM2Q4ZWFiMDY3NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NiwiZXhwIjoxNzM2NjMxNDY2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM5YzgxNjMyLWQyNTQtNGRjMC05NjljLTUxN2VmMDg3ODgzNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.rxiHu4KQLrUV3KrGkbhUSF59UDBAXFUrzu02dDPqSSp9bum2VcK4HFd8kHPAogCO1um_WJ1qVhpL2n7HJ6vHk6chPyAy_YnuxJjuPwTR2regKGaLr1Z5e8wSMa4KgmfaCkK6aGe50vLIDTT9IsocROn_4BrqsYvC7ElPOa-AncCj5A0jJqzie808X-kQx6hQcOqeuaOdsv1gFEllZKo9gcZ6CozXidKAB-jZhQPvCZpRhIjz_sgU4Hctm21xEgkyhHWfv8cLD7tGczI7L36LpL3j7WneEYjCIqP9nqb9QcufNxDjcPxZ3coepYgc77yrPCu7YFshJV2AsOZxEUd6gQ'

Example response

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

{
  "id" : "241302a3-ccac-4e37-85b4-06d10353522d",
  "zitiId" : "ziti.id.diyu2kjw",
  "name" : "Our Service 1059263161045",
  "networkId" : "210058d2-665a-4819-896c-c96f5f9c5491",
  "type" : "MFA",
  "ownerIdentityId" : "12f4e00b-0201-439b-9f2e-722bba4400fc",
  "createdBy" : "12f4e00b-0201-439b-9f2e-722bba4400fc",
  "createdAt" : "2025-01-11T20:37:45.245836Z",
  "updatedAt" : "2025-01-11T20:37:46.769789Z",
  "deletedBy" : "2b60baac-a7a8-4bf9-978b-3e3d8eab0675",
  "deletedAt" : "2025-01-11T20:37:46.769Z",
  "attributes" : null,
  "data" : {
    "timeoutSeconds" : 1234,
    "promptOnWake" : true,
    "promptOnUnlock" : false,
    "ignoreLegacyEndpoints" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/241302a3-ccac-4e37-85b4-06d10353522d",
      "title" : "Our Service 1059263161045"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/210058d2-665a-4819-896c-c96f5f9c5491",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/1f4b60b3-317d-4596-a8a4-67337b7881b9",
      "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

id

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.eyJqdGkiOiI2LWJ3eDdrdVM5LVM4QTRpUDVDcktRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE0ZmVhYzIwLTgzMDgtNDcyNy1iOTI1LWRlOTJhZTg5M2Y0NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NywiZXhwIjoxNzM2NjMxNDc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg2ZTU1Y2MyLWI2OTgtNDZhZS04NjIwLTA2NjY0NTU1MDBmZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.bMsP2JG61xd7Wo6L9ujpGtNsERNSs-hk2Cm-W5UtFQoCzjkCPQ0iiLaHW6m3wjmL2OCimIcOoQVHeq55wBj3ffdMcEMwzUmn6rPQ4xnuQS7ceqxYrDw_InD21R9aqTZuxJjj-sAvUfdnjpnzXoZwmF2NKtsb06jm-L8IIGqUZG4o5TJVEAV-e1cQj7-P7IgPZuqwNUIuAidE4clSBjBwHQCMA5hwlGFOojNVtvaoz7z0VaYNFLI3SBkh1qWuZXKbUMnPjVvSy7Xi6YGmjRz1Fk7u28_OiAZk9cHXkPL7lJYxoyAlHqyMRBYaoeQZbr8Gz7PnrGFoJiKMfuqAhfxRNw'

Example response

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

{
  "_embedded" : {
    "certificateAuthorityList" : [ {
      "id" : "385fb192-d0c7-469e-a787-88be25cc09f8",
      "ownerIdentityId" : "5e85fccf-e904-4e2f-9c55-2056134a210e",
      "createdBy" : "5e85fccf-e904-4e2f-9c55-2056134a210e",
      "createdAt" : "2025-01-11T20:37:56.938685Z",
      "updatedAt" : "2025-01-11T20:37:56.943902Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "29a27e60-199b-46d9-a989-4c2fbb6949c8",
      "zitiId" : "ziti.id.docasud2",
      "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" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/29a27e60-199b-46d9-a989-4c2fbb6949c8"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/385fb192-d0c7-469e-a787-88be25cc09f8",
          "title" : "Test ca 02"
        }
      }
    }, {
      "id" : "41334666-e460-4581-a478-df853012ccf1",
      "ownerIdentityId" : "4ddbc3d7-b8d3-4c29-a7b9-88c826d7433d",
      "createdBy" : "4ddbc3d7-b8d3-4c29-a7b9-88c826d7433d",
      "createdAt" : "2025-01-11T20:37:56.995354Z",
      "updatedAt" : "2025-01-11T20:37:56.999286Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "1e788f5f-d145-41f9-9031-d7e7b464f644",
      "zitiId" : "ziti.id.dod7uunb",
      "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" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/1e788f5f-d145-41f9-9031-d7e7b464f644"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/41334666-e460-4581-a478-df853012ccf1",
          "title" : "Test ca 02"
        }
      }
    }, {
      "id" : "6136dbd9-3553-43f3-8467-69b45a2d9265",
      "ownerIdentityId" : "6edb2123-e6bd-4808-8b44-f1c2b951f4e6",
      "createdBy" : "6edb2123-e6bd-4808-8b44-f1c2b951f4e6",
      "createdAt" : "2025-01-11T20:37:56.845942Z",
      "updatedAt" : "2025-01-11T20:37:56.849251Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "cf166f87-9b63-4346-883f-3bde8945c005",
      "zitiId" : "ziti.id.doam3v69",
      "name" : "ca-2324",
      "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/cf166f87-9b63-4346-883f-3bde8945c005"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/6136dbd9-3553-43f3-8467-69b45a2d9265",
          "title" : "ca-2324"
        }
      }
    }, {
      "id" : "7c6e3dfe-ab68-4fe2-aa0a-bd526993c882",
      "ownerIdentityId" : "619494e3-1f55-48fc-8541-e63eda3b14c2",
      "createdBy" : "619494e3-1f55-48fc-8541-e63eda3b14c2",
      "createdAt" : "2025-01-11T20:37:57.032998Z",
      "updatedAt" : "2025-01-11T20:37:57.062201Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "828a921d-0531-4e3a-bd16-077ee3435c11",
      "zitiId" : "ziti.id.dodrph56",
      "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" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/828a921d-0531-4e3a-bd16-077ee3435c11"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/7c6e3dfe-ab68-4fe2-aa0a-bd526993c882",
          "title" : "Test ca 02 updated"
        }
      }
    }, {
      "id" : "a5ab3b7e-14e8-4ea3-a863-836bbdab4f1e",
      "ownerIdentityId" : "59c3f7ce-6efd-4c38-aa0e-0b1dea126f91",
      "createdBy" : "59c3f7ce-6efd-4c38-aa0e-0b1dea126f91",
      "createdAt" : "2025-01-11T20:37:56.878214Z",
      "updatedAt" : "2025-01-11T20:37:56.878793Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "e09909e2-b79e-4403-81dd-3e97a37937dd",
      "zitiId" : "ziti.id.dob7mymm",
      "name" : "ca-2331",
      "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/e09909e2-b79e-4403-81dd-3e97a37937dd"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/a5ab3b7e-14e8-4ea3-a863-836bbdab4f1e",
          "title" : "ca-2331"
        }
      }
    }, {
      "id" : "a74ccdf0-3bfc-4e86-a0cc-bc886b9f1a38",
      "ownerIdentityId" : "98c687a7-a4e7-4188-8850-14aaed22e0da",
      "createdBy" : "98c687a7-a4e7-4188-8850-14aaed22e0da",
      "createdAt" : "2025-01-11T20:37:56.989059Z",
      "updatedAt" : "2025-01-11T20:37:56.989616Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "1e788f5f-d145-41f9-9031-d7e7b464f644",
      "zitiId" : "ziti.id.dod1n7vk",
      "name" : "ca-2345",
      "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/1e788f5f-d145-41f9-9031-d7e7b464f644"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/a74ccdf0-3bfc-4e86-a0cc-bc886b9f1a38",
          "title" : "ca-2345"
        }
      }
    }, {
      "id" : "b3c11ebd-8a96-4c1f-b12c-cc90e0e1f9a2",
      "ownerIdentityId" : "3aa1f5d5-08ea-4072-b603-5aa331c0f8a4",
      "createdBy" : "3aa1f5d5-08ea-4072-b603-5aa331c0f8a4",
      "createdAt" : "2025-01-11T20:37:57.093349Z",
      "updatedAt" : "2025-01-11T20:37:57.093978Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "2101a459-6e1b-4f57-a48f-9cd7a71a367a",
      "zitiId" : "ziti.id.doerqjwc",
      "name" : "ca-2359",
      "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/2101a459-6e1b-4f57-a48f-9cd7a71a367a"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b3c11ebd-8a96-4c1f-b12c-cc90e0e1f9a2",
          "title" : "ca-2359"
        }
      }
    }, {
      "id" : "b72c92e0-8c31-4d5b-aaa7-10bf1d914e93",
      "ownerIdentityId" : "d6711860-bf1b-4480-953c-94a34c8395c8",
      "createdBy" : "d6711860-bf1b-4480-953c-94a34c8395c8",
      "createdAt" : "2025-01-11T20:37:57.184678Z",
      "updatedAt" : "2025-01-11T20:37:57.185287Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "4d0495b6-0213-4759-bbaa-4f93a04b0ede",
      "zitiId" : "ziti.id.doga2n1s",
      "name" : "ca-2373",
      "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/4d0495b6-0213-4759-bbaa-4f93a04b0ede"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b72c92e0-8c31-4d5b-aaa7-10bf1d914e93",
          "title" : "ca-2373"
        }
      }
    }, {
      "id" : "d6189043-aa83-4433-bbf2-796c209eb73b",
      "ownerIdentityId" : "cadfb13d-8e7c-414d-a4e9-cf43a6b58603",
      "createdBy" : "cadfb13d-8e7c-414d-a4e9-cf43a6b58603",
      "createdAt" : "2025-01-11T20:37:56.920005Z",
      "updatedAt" : "2025-01-11T20:37:56.920567Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "29a27e60-199b-46d9-a989-4c2fbb6949c8",
      "zitiId" : "ziti.id.dobwj8w8",
      "name" : "ca-2338",
      "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/29a27e60-199b-46d9-a989-4c2fbb6949c8"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/d6189043-aa83-4433-bbf2-796c209eb73b",
          "title" : "ca-2338"
        }
      }
    } ]
  },
  "_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}

@see Certificate Authorities.

See Certificate Authorities.

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/6e908b05-3bdb-4312-a6ba-599bb5eaf79e' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiald6V0FaWVdTTU5POFZ2ZHRvcEJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJlMWNiM2QxLTNiYzgtNDlkOS04MzFkLWQ2OGUwOTU3NGU3ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NywiZXhwIjoxNzM2NjMxNDc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjIxNThhODBiLTAxNDYtNGU3NS1hNDM0LTFhMjM1ZDljYTM2Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.RKjTGo3JE36Spbt8s3GPwCqHmo5x87V_Nstg_e4_ZI-UEbLDmbd57Uw74g8hf_HkIO3rJW0LmUacyy5xTLHodHSdXpwZa2uKhA5WF9ka4xWlIBMuTG6J02o1yyNBIM1Y7Hf3XzHHtb7srIevlBJfa_B_snuUiCxck_Q5cH-yCD_UORhfHS4ez2hKFC2TOPeYqMl5rJsb6_mCeyRjfHWXyTDmAYGrKxgHFDIxFNTdE0i-LWX8owqzEpItbmX6WHPo1nQUawaCa7GzFbuiZszO8TS9RtydA0tWTo0wlBwaFs29sNnKe7oIDqagA-MYDfTwFMeD_-CD2Xz6ofQko5Kg2Q'

Example response

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

{
  "id" : "6e908b05-3bdb-4312-a6ba-599bb5eaf79e",
  "ownerIdentityId" : "824e905e-8941-4eb9-a7bc-5b5d6effff0d",
  "createdBy" : "824e905e-8941-4eb9-a7bc-5b5d6effff0d",
  "createdAt" : "2025-01-11T20:37:57.281621Z",
  "updatedAt" : "2025-01-11T20:37:57.282214Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "dd25f28a-69b1-4561-8aad-8fd89eafcf2b",
  "zitiId" : "ziti.id.dohvsndz",
  "name" : "ca-2387",
  "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/dd25f28a-69b1-4561-8aad-8fd89eafcf2b"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/6e908b05-3bdb-4312-a6ba-599bb5eaf79e",
      "title" : "ca-2387"
    }
  }
}

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.eyJqdGkiOiIwNVJ6a2xBM2VmWEFnaFppcFRYTUNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVlODVmY2NmLWU5MDQtNGUyZi05YzU1LTIwNTYxMzRhMjEwZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NiwiZXhwIjoxNzM2NjMxNDc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjI4ZmJjZTBlLTAwNjMtNGRiNC05Mjg1LTE1NmQyYjE5YjYxM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.OqS7xZX8MNLgBEAv1k1G6wOe_XFg5JQE851K2-t8AIwJdv8n7PuQkRlVx4m7qcZwW-qEtg5XUV9P0QFusu1OvSrUuQnyS8zF4TU8GjVzKdQPv2S9X7Q2qoH1t0Y-DitDHUhmhyGLUtPR2KrYLCkNrCssTD03c4qKj7C79EGDpVIpK3p6Q4cEB6GS-iB10cR9M8KCsmBeav9WVTo15Anj7xGUxSYSIEobHvN2upBOXwaO7Mk2ARf9LR9f_fkIlK_QJ0m9fpNFXfwbi6lynk2a-XkxRx9ArIjEtv7jKNmW3woiclekE57hOi08WYBBhS7_Wr55qyfEVVDhpkHUg9Lpiw' \
    -d '{"networkId":"29a27e60-199b-46d9-a989-4c2fbb6949c8","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" : "385fb192-d0c7-469e-a787-88be25cc09f8",
  "ownerIdentityId" : "5e85fccf-e904-4e2f-9c55-2056134a210e",
  "createdBy" : "5e85fccf-e904-4e2f-9c55-2056134a210e",
  "createdAt" : "2025-01-11T20:37:56.938685Z",
  "updatedAt" : "2025-01-11T20:37:56.943902Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "29a27e60-199b-46d9-a989-4c2fbb6949c8",
  "zitiId" : "ziti.id.docasud2",
  "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" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/29a27e60-199b-46d9-a989-4c2fbb6949c8"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/385fb192-d0c7-469e-a787-88be25cc09f8",
      "title" : "Test ca 02"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/c30216a3-3b92-4b24-96b7-93f32289952b",
      "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

id

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/b3c11ebd-8a96-4c1f-b12c-cc90e0e1f9a2/verify' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJkMFA1TXZ3YXVHTE90NkdrdVVIcXNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJmZjY0ZTlmLTM4Y2EtNGZmMi1iNjliLTY2ODJjNzRlOTgwMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NywiZXhwIjoxNzM2NjMxNDc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZhZTkyOTRjLTlkYzUtNGNmOC05M2VkLWM1MmFlM2M1YzA4OFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.kRVrmvry5IOzVsWhS9VmH58rioUD_ZkKqWg6wmB3-z8LPkfpfBZ-qy0d5bdQHnPPpR8VGjb5zx6B_tjUpPutxqf9HMYPmx_li-JcAbkdVgh1RE09i1D7PV8gByqA7PU9xfUnqCvkZio0_QWCK88REAywY36XDO3FTawRap2j5xtWfM1I_A0yF1kp4rpGDoej-npp0_1rreNZHkVM90rkRKexI6_1WGHaKdOFXLUBG56UDpAp7EvBwqXrPQTJtWHloo87gIO_QvIkv4mzPdHQSe58oSxfzQW497znHNkJa6r1YR_ucTRJKIW_M4rRs1a4PqYFvDA5XfYkonnY5i_I9g' \
    -d '<testcertverificationbody>'

Example response

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

{
  "id" : "b3c11ebd-8a96-4c1f-b12c-cc90e0e1f9a2",
  "ownerIdentityId" : "3aa1f5d5-08ea-4072-b603-5aa331c0f8a4",
  "createdBy" : "3aa1f5d5-08ea-4072-b603-5aa331c0f8a4",
  "createdAt" : "2025-01-11T20:37:57.093349Z",
  "updatedAt" : "2025-01-11T20:37:57.093978Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "2101a459-6e1b-4f57-a48f-9cd7a71a367a",
  "zitiId" : "ziti.id.doerqjwc",
  "name" : "ca-2359",
  "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/2101a459-6e1b-4f57-a48f-9cd7a71a367a"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b3c11ebd-8a96-4c1f-b12c-cc90e0e1f9a2",
      "title" : "ca-2359"
    }
  }
}

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

id

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/7c6e3dfe-ab68-4fe2-aa0a-bd526993c882' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI4S2ZXLUloMUpyOW1lNDR4WmVnUk53IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMxOGMzMDBmLTVkMWYtNDZhMC1hZTE5LTM4ODM3NmQwYWUxNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NywiZXhwIjoxNzM2NjMxNDc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImU1ZjhjNzNlLTM2NTAtNGEzNi04NTRmLTI5OGI4OGE0OGZlNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.MLpC5nmvCy1J2hAibTGfblW1eGl4t555Z3HKC95vgIabKacTp1BoRiNI0rO4zln3Dw82pBgLiCbHo5_7V6s_urIeM43R2yUdEGOmL2JS86q5PTnj7C7c_UZPnp4eKUm1oP9USwxNPsombu9kjLGnq78aCXmvsowlJ5pa3IEeH-JOXb-x6-veFQSVvInq-1lz9yjXmQG4e_uPO1spOSIMq_mlFEJJY4OG028upbUSvPcPYAb1Z8p-RtarwSnmAyPY94o40REJQl5VWif57EIxPs7XwrBrF01R8DYgLhSn2_7zucamD6s72A8wk0m4kVoF0IH3WXK1XRQL67VCk1hcrA' \
    -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" : "7c6e3dfe-ab68-4fe2-aa0a-bd526993c882",
  "ownerIdentityId" : "619494e3-1f55-48fc-8541-e63eda3b14c2",
  "createdBy" : "619494e3-1f55-48fc-8541-e63eda3b14c2",
  "createdAt" : "2025-01-11T20:37:57.032998Z",
  "updatedAt" : "2025-01-11T20:37:57.062201Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "networkId" : "828a921d-0531-4e3a-bd16-077ee3435c11",
  "zitiId" : "ziti.id.dodrph56",
  "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" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/828a921d-0531-4e3a-bd16-077ee3435c11"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/7c6e3dfe-ab68-4fe2-aa0a-bd526993c882",
      "title" : "Test ca 02 updated"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/aa5ee267-ca37-457c-9947-9579ddb344cc",
      "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

id

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/986ee13a-4129-41af-83db-a67cb15fd43c' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJubndjdmR2UkhFRWNaLVVDelM0ZmZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZhNTJlNGM5LThlMDEtNGZkMC04ODk3LTQ1NzE5MzRmYWEzYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NywiZXhwIjoxNzM2NjMxNDc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjM5MjU0NzUxLWQwZmUtNDJjNi04OWY5LTA2MGVmZTg4YjQxOVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.JMAYaSSGTBpeLHrfnJx_i4JcTW-hMkTgN09KThqEwnQd4pH7R66JNsOnafkp5J0q528AkaQdT_VbUbEw7XqKPM5W0k8jSbA0reU8YaatoN3ltv2kM8ZERLfI3E2WR-Aegm6H-hpsLAf41BwcsDEoFo4W6Cq56dIFpPNl--pNA0V8eaTXjqHMzvmeW3lnTVFxjgEOi7xcfz6dSFVPsYVu5uomQEay_U9MVDhItYQbWfR9PSA8LDe_NvOtPxUovSRR-M7jbL7j2ASysq0osOriAelIbwwPboDRLHo1xWUG3XVR6EOaGb0YQa__ZBSxDp4G-yR4Fc3JtdfEGCQnAstkyA'

Example response

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

{
  "id" : "986ee13a-4129-41af-83db-a67cb15fd43c",
  "ownerIdentityId" : "c3421ceb-53f0-494b-940b-13663d3b4afd",
  "createdBy" : "c3421ceb-53f0-494b-940b-13663d3b4afd",
  "createdAt" : "2025-01-11T20:37:57.140254Z",
  "updatedAt" : "2025-01-11T20:37:57.152581Z",
  "deletedBy" : "fa52e4c9-8e01-4fd0-8897-4571934faa3c",
  "deletedAt" : "2025-01-11T20:37:57.152Z",
  "networkId" : "8e878ced-0c65-4e9c-a5b9-99bec83fe86d",
  "zitiId" : "ziti.id.dofjlct9",
  "name" : "ca-2366",
  "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/8e878ced-0c65-4e9c-a5b9-99bec83fe86d"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/986ee13a-4129-41af-83db-a67cb15fd43c",
      "title" : "ca-2366"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/fb7e7b3c-6941-4466-b549-12a787c5556a",
      "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

id

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.eyJqdGkiOiJYSUJrWGo5RHNmY3FfVURaZ3FUdzhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZjMmE2NTk0LTQ4ZDAtNGU2Yi1hMTVmLWM5MzhkYjM2YzU1YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5MiwiZXhwIjoxNzM2NjMxMzkyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImJiZGIyMTBiLTM4NDItNDAwNC1hNjlkLTMyODM3NjRjZjZlYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.BiJ6d4m3ktDiH-vsOUJzYVAv5nyqrpJ932k40g7VMqO6oNSf8GWlEhlf5poEWwGZJGXjR9iSeBbqHfTdSPd17fTXgVft2BOo3tTTIXcD-EAQ0hJAlkYjs1-doLmxuJsFgUMS1Ut5l7_7zyfYHiUonZ3giDdT_rd2U51RV-z7RN56zMKrxo7xMXxA6kvpA7Wqam1HbL_J6FS6DkFFQT9AsYly82yZA8Muf6l16qMpevaB2L60t_0ObNF9ZhT6nV9ooCwDIPnYfr36qxe8pUe67NWWl2XZE8WMFpANhbbGJRED6YLA736zZBjkAy_ivYvZ3hKzZ11a-yGHZqQIptfzvw'

Example response

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

{
  "_embedded" : {
    "certificateAuthorityList" : [ {
      "id" : "34d3a78c-402f-4761-96c8-adcfbb380825",
      "ownerIdentityId" : "a3095bd4-0d54-446e-9d30-7f487659be83",
      "createdBy" : "a3095bd4-0d54-446e-9d30-7f487659be83",
      "createdAt" : "2025-01-11T20:36:32.088512Z",
      "updatedAt" : "2025-01-11T20:36:32.089187Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "c9fe8471-9c37-49ad-b490-16095e8156b5",
      "zitiId" : "ziti-id-09177539-d993-490d-b05d-9526f1f1a145",
      "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/c9fe8471-9c37-49ad-b490-16095e8156b5"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/34d3a78c-402f-4761-96c8-adcfbb380825",
          "title" : "Find Test CA 2"
        }
      }
    }, {
      "id" : "a6ff845d-9bba-40f8-9876-642390e979f8",
      "ownerIdentityId" : "a3095bd4-0d54-446e-9d30-7f487659be83",
      "createdBy" : "a3095bd4-0d54-446e-9d30-7f487659be83",
      "createdAt" : "2025-01-11T20:36:32.084047Z",
      "updatedAt" : "2025-01-11T20:36:32.087628Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "networkId" : "c9fe8471-9c37-49ad-b490-16095e8156b5",
      "zitiId" : "ziti-id-1e857b07-6a10-463c-ab55-8202d0df8871",
      "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/c9fe8471-9c37-49ad-b490-16095e8156b5"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/a6ff845d-9bba-40f8-9876-642390e979f8",
          "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

id

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

Indicates whether or not this {@link ServiceEdgeRouterPolicy} is "exclusive" to a specific {@link Service} or {@link EdgeRouter} instance, or is not exclusive (null). <p/> An exclusive {@link ServiceEdgeRouterPolicy} is defined and managed by the resource that it is exclusive to. An exclusive {@link ServiceEdgeRouterPolicy} will have exactly one attribute of the type indicated by this property, and that attribute will be an '@' name based direct reference to the resource that defined and manages this policy. <p/> An exclusive {@link ServiceEdgeRouterPolicy} can not be created by an external API request. They are only created by internal processes as a side effect of other actions. Exclusive policies can not be updated via an external API request. All changes to exclusive policies are driven by the system, usually as a side effect of actions on the managing resource. Last but not least, exclusive policies are auto-deleted when the managing resource is deleted.

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.eyJqdGkiOiJqNWgzeUtXUWwzbmg0NVZCRks2aVNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU3YzRiNzUzLTE5YjktNDU1NC1hOWNmLWJjODA3ZWQ5NThiOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg4MywiZXhwIjoxNzM2NjMxNDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBmYjFjOWI0LTA1ZjktNGY0MS1iYWQ4LTU3NjBjZTA0ODhkM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.WWSDHwcamAs5NJe5o9fKrnLvdj7fu6bHLY9akbaiqInvrnJV6opR03jTEw1tSD6mT7jQxHfxU-qpXHHfU1yEwDWadxJOVask2F2JDV3hAQFz-tyXKNL9s2ZgBkW_6DO87JsetcSTvEZcyd_CoQbuzeWdiAEE2G-XaKwIn2Bwj5yN_-_VHyT0XGH4CTwrYKVs_TFpBfizDvhJq1f2Kix5ghRa-XjrU-Uan5kj4rZA2pHvXjS83C0-BaVOXinzz4zRkzvLhlsvKG8zZu2uk5qmR2ve-55SaysfplMGoVEyx_vyOJxQBjBXRFCNdtAWD04nT9vn33fjogMQeNctdnQJmA'

Example response

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

{
  "_embedded" : {
    "serviceEdgeRouterPolicyList" : [ {
      "id" : "377165b1-2392-4ac4-9c3c-35b0a75eab9f",
      "networkId" : "719fe761-581e-4a54-93d1-3d5f2d9b30a1",
      "zitiId" : null,
      "name" : "throw keyword to trigger exception in mock",
      "semantic" : "AnyOf",
      "serviceAttributes" : [ "@My Service cr4qfxff" ],
      "edgeRouterAttributes" : [ "#all" ],
      "exclusiveType" : "service",
      "exclusiveToId" : "ff6825ac-d3b4-4fba-8552-8d1eb798bd34",
      "ownerIdentityId" : "9924c882-51ba-43d1-b430-a0cff14b5d46",
      "createdBy" : "9924c882-51ba-43d1-b430-a0cff14b5d46",
      "createdAt" : "2025-01-11T20:36:44.686037Z",
      "updatedAt" : "2025-01-11T20:36:44.686037Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/719fe761-581e-4a54-93d1-3d5f2d9b30a1",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/377165b1-2392-4ac4-9c3c-35b0a75eab9f",
          "title" : "throw keyword to trigger exception in mock"
        },
        "exclusive-to" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/ff6825ac-d3b4-4fba-8552-8d1eb798bd34",
          "title" : "My Service cr4qfxff"
        }
      }
    }, {
      "id" : "4c17fc4d-873b-4852-9795-8a852d767860",
      "networkId" : "3c9ed3df-1a3e-4108-bc18-3e717ae5c584",
      "zitiId" : "ziti.id.dr9gb3p1",
      "name" : "My Service Edge Router Policy 1078055551647",
      "semantic" : "AnyOf",
      "serviceAttributes" : [ "#router-3" ],
      "edgeRouterAttributes" : [ "#service-1", "#service-5" ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "50206769-a3c5-426f-9602-9edb5885c476",
      "createdBy" : "50206769-a3c5-426f-9602-9edb5885c476",
      "createdAt" : "2025-01-11T20:38:03.295862Z",
      "updatedAt" : "2025-01-11T20:38:03.302004Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3c9ed3df-1a3e-4108-bc18-3e717ae5c584",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/4c17fc4d-873b-4852-9795-8a852d767860",
          "title" : "My Service Edge Router Policy 1078055551647"
        }
      }
    }, {
      "id" : "55f0a299-65ba-4d09-9bc3-c3162174859d",
      "networkId" : "a8b380af-f23e-4eef-85f6-a4896d3726ce",
      "zitiId" : null,
      "name" : "erp-586",
      "semantic" : "AnyOf",
      "serviceAttributes" : [ ],
      "edgeRouterAttributes" : [ ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "e46f1a61-1c28-482e-8252-7e1dbb581e06",
      "createdBy" : "e46f1a61-1c28-482e-8252-7e1dbb581e06",
      "createdAt" : "2025-01-11T20:36:58.780803Z",
      "updatedAt" : "2025-01-11T20:36:58.780803Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a8b380af-f23e-4eef-85f6-a4896d3726ce",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/55f0a299-65ba-4d09-9bc3-c3162174859d",
          "title" : "erp-586"
        }
      }
    }, {
      "id" : "db564cd1-6f0b-4d84-879d-a10c6c4ce6cc",
      "networkId" : "c72b4a51-55bf-4982-8385-082843380800",
      "zitiId" : "ziti.id.drah0vhk",
      "name" : "My Service Edge Router Policy 1078058123197",
      "semantic" : "AnyOf",
      "serviceAttributes" : [ "#router-3" ],
      "edgeRouterAttributes" : [ "#service-1", "#service-5" ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "ecec77cd-6b03-4225-9d7c-d8c3d90e4b6d",
      "createdBy" : "ecec77cd-6b03-4225-9d7c-d8c3d90e4b6d",
      "createdAt" : "2025-01-11T20:38:03.357623Z",
      "updatedAt" : "2025-01-11T20:38:03.363706Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c72b4a51-55bf-4982-8385-082843380800",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/db564cd1-6f0b-4d84-879d-a10c6c4ce6cc",
          "title" : "My Service Edge Router Policy 1078058123197"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 4,
    "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

id

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/db564cd1-6f0b-4d84-879d-a10c6c4ce6cc' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ0SVJkS215cmNWSXIwc3EwY0Z3X0tnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVmZTI2OTQ1LWI3ZGYtNDVmYS1hZmVkLWJiZDQ0OWU2ZmRjYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg4MywiZXhwIjoxNzM2NjMxNDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImMxNmEwODYzLThhYWUtNDJiMi04YTRiLTc0ZGE0MmVlNmJjY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.V3A85yHML-OH_ypeIhfEf3QvPibq7q_jrakGrsHcPMNpbFBAZAzoJrsNsWqtwlZfnoFehIvE5mKYAosm0EOmUvSRHVbPwxvjqs5ZlpCD22T4oW5cDxZuq1dRWNV00ap7keeMjus3JRZ-EL4lJ4it9Q_PvWY_Go7w7dNxtXgmXVG1oBYXXi-LC_8hnc5siyrtbRaZcdZVQRZ0i4sikSjqIXs2dua7xLTXBba_ggU0ISjgFXjsBsFfyxRFVDOtBI5ECaiK8wodiLrZAB4XlZzs9r5x-rc9U3UXceuyQe5XOYRxAzGx1v1YANLgGsh7K2BffOOHcBiYKop89gAJjPt8xg'

Example response

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

{
  "id" : "db564cd1-6f0b-4d84-879d-a10c6c4ce6cc",
  "networkId" : "c72b4a51-55bf-4982-8385-082843380800",
  "zitiId" : "ziti.id.drah0vhk",
  "name" : "My Service Edge Router Policy 1078058123197",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ "#service-2", "#service-1" ],
  "edgeRouterAttributes" : [ "#router-1", "#router-2" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "ecec77cd-6b03-4225-9d7c-d8c3d90e4b6d",
  "createdBy" : "ecec77cd-6b03-4225-9d7c-d8c3d90e4b6d",
  "createdAt" : "2025-01-11T20:38:03.357623Z",
  "updatedAt" : "2025-01-11T20:38:03.363706Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c72b4a51-55bf-4982-8385-082843380800",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/db564cd1-6f0b-4d84-879d-a10c6c4ce6cc",
      "title" : "My Service Edge Router Policy 1078058123197"
    }
  }
}

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.eyJqdGkiOiI2NXpnWmw2SG1qMzJKSUxMTzR2bVdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVjZWM3N2NkLTZiMDMtNDIyNS05ZDdjLWQ4YzNkOTBlNGI2ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg4MywiZXhwIjoxNzM2NjMxNDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjlkNjE5NDhjLTJkMWUtNDlmYS1iMTQzLWM1OTdjMjE5ODA1ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.GVDXdPXT7w3mMXZrJvX96l6xp9Tp_ollglHixLVoxL4tB10KSpGVSa5Uv5MlLchovbhVU55yiuXifMc7d5of1mbd1DRfH2sCXPAJhhvvTIJg_n6vp7UTsI89TrxHydRKYMvj4e0oqCHFU4SgE-KKtWw1ANdkcz6HiHQx94gbcymktz0w1lfuwv55PZHleFiOv-M0MGQGbOexU0cBkbkgSnTW16hxTQw5FiLhwVfPavZsgauGZYTGGBv2EV5FDVrmtNVXuFq6T8AH9I4h7HuIpnhzcoqqL3Y_T0QtTux5leknHBNe3ka9pQUBojwnTfRNRdlJr62oPVX63lsy_XatPQ' \
    -d '{"networkId":"c72b4a51-55bf-4982-8385-082843380800","name":"My Service Edge Router Policy 1078058123197","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: 643

{
  "id" : "db564cd1-6f0b-4d84-879d-a10c6c4ce6cc",
  "networkId" : "c72b4a51-55bf-4982-8385-082843380800",
  "zitiId" : "ziti.id.drah0vhk",
  "name" : "My Service Edge Router Policy 1078058123197",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ "#service-2", "#service-1" ],
  "edgeRouterAttributes" : [ "#router-1", "#router-2" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "ecec77cd-6b03-4225-9d7c-d8c3d90e4b6d",
  "createdBy" : "ecec77cd-6b03-4225-9d7c-d8c3d90e4b6d",
  "createdAt" : "2025-01-11T20:38:03.357623Z",
  "updatedAt" : "2025-01-11T20:38:03.363706Z",
  "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

id

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/db564cd1-6f0b-4d84-879d-a10c6c4ce6cc' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJmbkZqN2tTYlh4WEQ0UkJHWGVMTDB3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFiZDg5OWYxLTQ2NGYtNDdlYi05ZWY3LTExNzI4MWE2MjNjYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg4MywiZXhwIjoxNzM2NjMxNDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjEyMGQyOGUyLWY3MGQtNDVmNS04NGVhLTYwMjE0Y2E0M2U3OVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.cthPrmJ4E1SswjqEunfb-bKQXF81vazI5aogvrC1N2OhJlW_7jWJegO-CQcTOVxH7Bn1xdsac6X_I5oweJWRm3vgsWgVxiawtRmKmbnvqpSZzykMRx7ljUtgmtkhmKam9taXFVo4tb6NZTGVcVD2MMUF5zGa4lWPdQkYkhRdN2IqoPVIWsDBGCH2x01LPElR0jKPJb8vteU33B5I5Yp8el4ALKJx12Eh2zJ7IlBq1tGywu45yDIAe3j7lB_vF2YdmDRlXw6e8FZNsBZHpMVzNtyTdYjc1DraEH5NJ-K-DTRQ-_HqcUDGc7YZPgQ_KB5I2NS2lhmndNRi1A-STn5YKg' \
    -d '{"name":"My Service Edge Router Policy 1078058123197","semantic":"AllOf","serviceAttributes":["#router-3"],"edgeRouterAttributes":["#service-1","#service-5"]}'

Example response

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

{
  "id" : "db564cd1-6f0b-4d84-879d-a10c6c4ce6cc",
  "networkId" : "c72b4a51-55bf-4982-8385-082843380800",
  "zitiId" : "ziti.id.drah0vhk",
  "name" : "My Service Edge Router Policy 1078058123197",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ "#router-3" ],
  "edgeRouterAttributes" : [ "#service-1", "#service-5" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "ecec77cd-6b03-4225-9d7c-d8c3d90e4b6d",
  "createdBy" : "ecec77cd-6b03-4225-9d7c-d8c3d90e4b6d",
  "createdAt" : "2025-01-11T20:38:03.357623Z",
  "updatedAt" : "2025-01-11T20:38:03.363706Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c72b4a51-55bf-4982-8385-082843380800",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/db564cd1-6f0b-4d84-879d-a10c6c4ce6cc",
      "title" : "My Service Edge Router Policy 1078058123197"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/9223871d-ca12-4810-b795-7b341ad4af3e",
      "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

id

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/db564cd1-6f0b-4d84-879d-a10c6c4ce6cc' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJFQlY0ZEpvbHJpYlhNR2dVeEFNemJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE1YTlmYmM1LWJjOTItNDZjOC05YTdjLWFhNzk1YWUyMTYxYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg4MywiZXhwIjoxNzM2NjMxNDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg2NTUzNDU2LTc1ZDEtNDViMy1iODkzLTM3ZDJiYTdkMzQ3MFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.kZYvqey0NaIsVeiPku0dXHc5BJVSvZJ3F0qc5tZ-fAXJuDzrCMlZPM2UIKhUI0SbV10IWlM6WEoORrtdRkNf7_KJ-EXEmvSYmCi7pO3H8L1-zt3hT7vQrJyJL_9pc3e2tXV9L3mR-_fQUcQ7rhdrHSE50x4d9_9BcewQlKoF-o8tdo2SPck4-Pb3yUDFz9SaJ7YNgTSXrSliOE9It3YRHEW1_M0geaWXyQjN7cjLoBWAXTgX_AE0tGWdeUkEFCKGCVjC0HgL1Rvnq_ImslXnU9rSj9YiKxv8I9CK6Vmedb7t1CYzCcz0AGMe0LhOT9ZvmTo9-2PrEnF3UZgyNlvSdQ'

Example response

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

{
  "id" : "db564cd1-6f0b-4d84-879d-a10c6c4ce6cc",
  "networkId" : "c72b4a51-55bf-4982-8385-082843380800",
  "zitiId" : null,
  "name" : "My Service Edge Router Policy 1078058123197",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ ],
  "edgeRouterAttributes" : [ ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "ecec77cd-6b03-4225-9d7c-d8c3d90e4b6d",
  "createdBy" : "ecec77cd-6b03-4225-9d7c-d8c3d90e4b6d",
  "createdAt" : "2025-01-11T20:38:03.357623Z",
  "updatedAt" : "2025-01-11T20:38:03.638729Z",
  "deletedBy" : "a5a9fbc5-bc92-46c8-9a7c-aa795ae2161b",
  "deletedAt" : "2025-01-11T20:38:03.633Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/c72b4a51-55bf-4982-8385-082843380800",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies/db564cd1-6f0b-4d84-879d-a10c6c4ce6cc",
      "title" : "My Service Edge Router Policy 1078058123197"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/f68414ec-e6c7-4642-8e00-01e4a754add9",
      "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

id

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

Indicates whether or not this {@link ServicePolicy} is "exclusive" to a specific {@link Service} or {@link Endpoint} instance, or is not exclusive (null). <p/> An exclusive {@link ServicePolicy} is defined and managed by the resource that it is exclusive to. An exclusive {@link ServicePolicy} will have exactly one attribute of the type indicated by this property, and that attribute will be an '@' name based direct reference to the resource that defined and manages this policy. <p/> An exclusive {@link ServicePolicy} can not be created by an external API request. They are only created by internal processes as a side effect of other actions. Exclusive policies can not be updated via an external API request. All changes to exclusive policies are driven by the system, usually as a side effect of actions on the managing resource. Last but not least, exclusive policies are auto-deleted when the managing resource is deleted.

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.eyJqdGkiOiJheXZieE5DTkc0azRiWk9xZG56Y1FBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM2ZDc5ZWFkLTYzZWYtNDA3Yy05ODNkLTg3MTg0YWZhMzhhZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NywiZXhwIjoxNzM2NjMxNDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFmNmQ0Y2NkLWY5N2QtNDc0Ni1iMDFiLWViZTFkNTQwZDRkMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.gixvlwUCPYpVlavqyf_skBnnKlBd_n79NTiLvokwHQWqP6SI5hJehUyRiInMuxAroJ1kTgK4JX_mjZp-hxZJ7QqHsjnk4ao8OGhgO0xi6eN5Pt-AOGHyur2hobvJ2bmPWUhbkMirbc_qk0nbLgmQTJt20e9Pd4eMvFiT1FdoU0lP6wcwpCSHz41qKqeUeFH9nl2traLHGbtKETRvcvMFMNagpbEgby1e2GaPQIaZyZ-YkmcrFT43-bgjdg6qsgsTEevoTA8KKEFFBwDO9CfLtY1hW26x6lcfWDIF2DxZCGoApQyX0VnulT875XOjfbd9pCCVSWgiLqJ-S6Joe9v4ag'

Example response

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

{
  "_embedded" : {
    "servicePolicyList" : [ {
      "id" : "0f539d7f-f47f-439b-98c0-515c18369570",
      "networkId" : "deea74b6-ae0e-4838-8ca8-5e41933f51ac",
      "zitiId" : "ziti.id.djri99xk",
      "name" : "My Service Policy 1061673034724",
      "type" : "Bind",
      "semantic" : "AllOf",
      "serviceAttributes" : [ "#service-1", "#service-5" ],
      "endpointAttributes" : [ "#endpoint-3" ],
      "postureCheckAttributes" : [ "#posture-2", "#posture-3", "#posture-1" ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "06027471-efc8-4383-b3ae-bf33037993fb",
      "createdBy" : "06027471-efc8-4383-b3ae-bf33037993fb",
      "createdAt" : "2025-01-11T20:37:46.973035Z",
      "updatedAt" : "2025-01-11T20:37:47.119617Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/deea74b6-ae0e-4838-8ca8-5e41933f51ac",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/0f539d7f-f47f-439b-98c0-515c18369570",
          "title" : "My Service Policy 1061673034724"
        }
      }
    }, {
      "id" : "90dd320d-0223-40e0-a201-d0c5f6efcbdc",
      "networkId" : "96965caa-f279-405e-a716-de834fe2be2b",
      "zitiId" : "ziti.id.djqi5kjn",
      "name" : "My Service Policy 1061669916326",
      "type" : "Bind",
      "semantic" : "AllOf",
      "serviceAttributes" : [ "#service-1", "#service-5" ],
      "endpointAttributes" : [ "#endpoint-3" ],
      "postureCheckAttributes" : [ "#posture-2", "#posture-3", "#posture-1" ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "cbe78520-2612-46bc-b298-c3fd793c8413",
      "createdBy" : "cbe78520-2612-46bc-b298-c3fd793c8413",
      "createdAt" : "2025-01-11T20:37:46.912126Z",
      "updatedAt" : "2025-01-11T20:37:47.078608Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/96965caa-f279-405e-a716-de834fe2be2b",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/90dd320d-0223-40e0-a201-d0c5f6efcbdc",
          "title" : "My Service Policy 1061669916326"
        }
      }
    }, {
      "id" : "c8d80fcb-b837-4fa3-bacd-d97580256a5e",
      "networkId" : "ad977076-e8e6-4dee-89ad-e4a14c342781",
      "zitiId" : null,
      "name" : "erp-599",
      "type" : "Bind",
      "semantic" : "AnyOf",
      "serviceAttributes" : [ ],
      "endpointAttributes" : [ ],
      "postureCheckAttributes" : [ ],
      "exclusiveType" : null,
      "exclusiveToId" : null,
      "ownerIdentityId" : "4962e5f6-cdee-457d-9402-370f5f60e31a",
      "createdBy" : "4962e5f6-cdee-457d-9402-370f5f60e31a",
      "createdAt" : "2025-01-11T20:36:58.958763Z",
      "updatedAt" : "2025-01-11T20:36:58.958763Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ad977076-e8e6-4dee-89ad-e4a14c342781",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/c8d80fcb-b837-4fa3-bacd-d97580256a5e",
          "title" : "erp-599"
        }
      }
    }, {
      "id" : "e721fa71-8873-446e-adf6-18177a6ca02e",
      "networkId" : "719fe761-581e-4a54-93d1-3d5f2d9b30a1",
      "zitiId" : null,
      "name" : "My Bind policy",
      "type" : "Bind",
      "semantic" : "AnyOf",
      "serviceAttributes" : [ "@My Service cr4qfxff" ],
      "endpointAttributes" : [ "#east-coast-routers" ],
      "postureCheckAttributes" : [ ],
      "exclusiveType" : "service",
      "exclusiveToId" : "ff6825ac-d3b4-4fba-8552-8d1eb798bd34",
      "ownerIdentityId" : "9924c882-51ba-43d1-b430-a0cff14b5d46",
      "createdBy" : "9924c882-51ba-43d1-b430-a0cff14b5d46",
      "createdAt" : "2025-01-11T20:36:44.680418Z",
      "updatedAt" : "2025-01-11T20:36:44.680418Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/719fe761-581e-4a54-93d1-3d5f2d9b30a1",
          "profile" : "parent"
        },
        "exclusive-to" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/ff6825ac-d3b4-4fba-8552-8d1eb798bd34",
          "title" : "My Service cr4qfxff"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/e721fa71-8873-446e-adf6-18177a6ca02e",
          "title" : "My Bind policy"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Service Policy

GET /v2/service-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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-policies/0f539d7f-f47f-439b-98c0-515c18369570' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZbWtwNVJoUWE5cG5JRWw4Y2t3dU9RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM3NzlhYzQ0LTdjOGUtNDU5ZC1iYjM1LWUwODFiNzQzZDFlOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NywiZXhwIjoxNzM2NjMxNDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjExNjhjZmQxLWEzNTctNDUzMi1hYmVhLWJlMzc2NjhlNzNjN1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.spSYNKqW8REb-NiV74HWUz0a3PsLdbozu7pN-bF8lwtLGnbKkm9W-GwQCJ9i9DJnR8Z56TEFCLLVcVB4A81BkmlzLdkswgvncYpNceaee4DGLfksdiaQkgGLS_5ltFJoN6byFI91AC4pPPnVWQqYYS2MVo2saCkygYZJxiBbZa5U7oZqTkNiVEVsLmyuqR1rH1nPSkVSgsl7jm51O2RpSS5Fu_QVbjNM5_Kp67_s7uK-P6BRAH-w6QthA7J1UHy0eI-N1d5NAsfG-ujYvqn5CTqrSZNqUURWNRyGrJ43Bv3xGpwXBXeEq4QMX44SfxorZN_JeSp1eHvCi37dEAGKww'

Example response

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

{
  "id" : "0f539d7f-f47f-439b-98c0-515c18369570",
  "networkId" : "deea74b6-ae0e-4838-8ca8-5e41933f51ac",
  "zitiId" : "ziti.id.djri99xk",
  "name" : "My Service Policy 1061673034724",
  "type" : "Dial",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ "#service-2", "#service-1" ],
  "endpointAttributes" : [ "#endpoint-1", "#endpoint-2" ],
  "postureCheckAttributes" : [ "#posture-2", "#posture-1" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "06027471-efc8-4383-b3ae-bf33037993fb",
  "createdBy" : "06027471-efc8-4383-b3ae-bf33037993fb",
  "createdAt" : "2025-01-11T20:37:46.973035Z",
  "updatedAt" : "2025-01-11T20:37:46.979374Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/deea74b6-ae0e-4838-8ca8-5e41933f51ac",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/0f539d7f-f47f-439b-98c0-515c18369570",
      "title" : "My Service Policy 1061673034724"
    }
  }
}

Create Service Policy

POST /v2/service-policies

Authorization

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

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

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ 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.eyJqdGkiOiJ5MnpvSk4yUzZBRGhoWV9zaHpnZC1nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA2MDI3NDcxLWVmYzgtNDM4My1iM2FlLWJmMzMwMzc5OTNmYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NiwiZXhwIjoxNzM2NjMxNDY2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImIwY2Y3N2UwLWNiNDAtNDBjZC1iNmNkLTBhMTNhYTFhMWNjZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ghtgaoz4-vTVnAg8ioXg_cWZrWnQRRKCpBRaGRVJMDsiDUv2NlxbGWIsMEzofWbnCVv_4y9NH8M-Ic2NQNgdwoeh8J1k9bhR4dkr-zhSjT9KEuJj4duOfSNxtVz9chE9CfcPntcy0u84XaPkdKC0RCTixjJPvakabNrq7v_I5rtyjToeccmF5Cjo1cdMEW8P1x82R93xTrpWx4f5vMJYDMBgn_Wcw14ehY7xXGk77Vc3WERU5U3ogjDyCcObgFXEtMS2AHa1qBii3K_YsfvhVU54AM9G6rjFTmsa4h0wLCsh6PKInsibJ1Cl397LjD8lT9vt8TVMcQgmV4h_bL-IQQ' \
    -d '{"networkId":"deea74b6-ae0e-4838-8ca8-5e41933f51ac","name":"My Service Policy 1061673034724","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: 713

{
  "id" : "0f539d7f-f47f-439b-98c0-515c18369570",
  "networkId" : "deea74b6-ae0e-4838-8ca8-5e41933f51ac",
  "zitiId" : "ziti.id.djri99xk",
  "name" : "My Service Policy 1061673034724",
  "type" : "Dial",
  "semantic" : "AnyOf",
  "serviceAttributes" : [ "#service-2", "#service-1" ],
  "endpointAttributes" : [ "#endpoint-1", "#endpoint-2" ],
  "postureCheckAttributes" : [ "#posture-2", "#posture-1" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "06027471-efc8-4383-b3ae-bf33037993fb",
  "createdBy" : "06027471-efc8-4383-b3ae-bf33037993fb",
  "createdAt" : "2025-01-11T20:37:46.973035Z",
  "updatedAt" : "2025-01-11T20:37:46.979374Z",
  "deletedBy" : null,
  "deletedAt" : null
}

Update Service Policy

PATCH /v2/service-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/0f539d7f-f47f-439b-98c0-515c18369570' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJGVmxnZkltazhJdDV3R21fQnhIRjVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhiYmNjMDIzLTcwNGEtNDgwOC1iODRlLWIzZTUzNWE2YjBlNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NywiZXhwIjoxNzM2NjMxNDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImMyYTI4MjcwLWFiNjktNGY1Yi1iY2E3LTA2NDI5MzNiMTAxM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Wh-7r9c3rdtYGjWCB-W7_ddwjt3GmyxLkWm-X1K99P3MNopIt_YKJEIkoPBYYYaOCPvTyBsm8iRvgYfnBHjuVDbOIFa1i_q6v9-_Nq6oUmPsbuqiGUb42SmJUBa1DlpHz-jdwTFQKF1G-eXYcpGt-7j530YcVPlduO0iPvUgkINh4kHEfDGnD8v8sATrrbRh8ZxI7DbFDbhZsezRFPPC3xpIQpBuqf7oEDJJpJ-w_QHXLwJBeSFQNUxjfOqhcnsdOqmPt7ebSJZ1eda19_Bgwc447PZKlOvHcOMaP7gnHyiWxTOuynin0E7dKrR1io9uvSyqSWOcQPR8KLEUhRdxvA' \
    -d '{"name":"My Service Policy 1061673034724","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: 1296

{
  "id" : "0f539d7f-f47f-439b-98c0-515c18369570",
  "networkId" : "deea74b6-ae0e-4838-8ca8-5e41933f51ac",
  "zitiId" : "ziti.id.djri99xk",
  "name" : "My Service Policy 1061673034724",
  "type" : "Bind",
  "semantic" : "AllOf",
  "serviceAttributes" : [ "#service-1", "#service-5" ],
  "endpointAttributes" : [ "#endpoint-3" ],
  "postureCheckAttributes" : [ "#posture-2", "#posture-3", "#posture-1" ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "06027471-efc8-4383-b3ae-bf33037993fb",
  "createdBy" : "06027471-efc8-4383-b3ae-bf33037993fb",
  "createdAt" : "2025-01-11T20:37:46.973035Z",
  "updatedAt" : "2025-01-11T20:37:47.119617Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/deea74b6-ae0e-4838-8ca8-5e41933f51ac",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/0f539d7f-f47f-439b-98c0-515c18369570",
      "title" : "My Service Policy 1061673034724"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/f251f6a2-ac31-4533-9dbd-c4101bec2844",
      "title" : "Update ServicePolicy",
      "profile" : "meta"
    }
  }
}

Delete Service Policy

DELETE /v2/service-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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-policies/0f539d7f-f47f-439b-98c0-515c18369570' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxWFR1VDhLY2NtR3A0aDJBNzViaGFRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVlYWZmMDBjLTQ2N2UtNDlmNC05YjQ3LWQxYzRmYThiYjZjOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NywiZXhwIjoxNzM2NjMxNDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImVlOWM1MmI3LTI2MTUtNDQwNy1hNDAyLWMzYzRlZDc2ZTVlOFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.M7_eqzeDv3Noe3uGsNTIlfcOkFxFHFsaIzGKTUt9q8EsDVYJ_8BV6-eoR55wzKmOEAcbNUj_RC7pnJGuEBuTrd9Qo34m_W4XcJGqZKWOilwFeg7lPhRR-KtniZDvimN2jlSr4vXeLU-X7th7VnVgLTX5tRQGkKOwZTdvEGjTuPKfE6HEdr5xbrkPeobUeCL0Gn3YPf2COx4xuCpmmKFo53lV2UhCd6qdF5Sk-riAUAuLPxY_qsMXte26wtlblAF8rcwoUpX8TMfW_zfyJCpMxL-KMKlpA0kvYNOX8b-E1k1VerFZMmccnFYUh6nPqAbntXDjuINRxHUcTC2XRBWhLQ'

Example response

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

{
  "id" : "0f539d7f-f47f-439b-98c0-515c18369570",
  "networkId" : "deea74b6-ae0e-4838-8ca8-5e41933f51ac",
  "zitiId" : null,
  "name" : "My Service Policy 1061673034724",
  "type" : "Bind",
  "semantic" : "AllOf",
  "serviceAttributes" : [ ],
  "endpointAttributes" : [ ],
  "postureCheckAttributes" : [ ],
  "exclusiveType" : null,
  "exclusiveToId" : null,
  "ownerIdentityId" : "06027471-efc8-4383-b3ae-bf33037993fb",
  "createdBy" : "06027471-efc8-4383-b3ae-bf33037993fb",
  "createdAt" : "2025-01-11T20:37:46.973035Z",
  "updatedAt" : "2025-01-11T20:37:47.278727Z",
  "deletedBy" : "eeaff00c-467e-49f4-9b47-d1c4fa8bb6c8",
  "deletedAt" : "2025-01-11T20:37:47.272Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/deea74b6-ae0e-4838-8ca8-5e41933f51ac",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/service-policies/0f539d7f-f47f-439b-98c0-515c18369570",
      "title" : "My Service Policy 1061673034724"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/03bb77fd-1e20-4ffe-be9c-483c675de534",
      "title" : "Delete ServicePolicy",
      "profile" : "meta"
    }
  }
}

Terminators

Find Terminators

GET /v2/terminators

Authorization

This endpoint requires read action on the terminator 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

id

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.eyJqdGkiOiJLVWxucGk1UGxpTWMzMXMtMmp2MVFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQyNzQ5NGRhLTIxZDYtNGY0Yi1iYjQ0LTM1ZWZjOWM0ODFjMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc4OCwiZXhwIjoxNzM2NjMxMzg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY3MDNmMmNiLTEyZDAtNGRmNi05NDc5LTIzODA2MjIxMGY3OFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc4OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.In4fnS3P9HbZC2U1l6AujwQRY4kd9NayyroZFAVFMrq7RZjnL45x3VX3XLpIioqvCqLsh_Kje_WeYgR33Aj6JsaHSEcOSMhYL9AI7CU_FjxxbROinuh_eBL07gFNSs0cmz4VaJ_Czs6uXUlUPsZoVTXlteCjdflU3bov_AaT4so_5qXkJCRMPtdYaPT0DJeZ2CGqCX_9QOZ8KrzoOLRG4g14tjc6So2AWADWND5Up89h_zAB5m6qqyJjJ5a0G3k4J-f4y4H00i-EIDp_dJcDKvhO6ganzedXSrSAzdOO93iOSOASx0t0GwhfrV58LOZPH_Wu3YTyV_lQhHqsR_WFeg'

Example response

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

{
  "_embedded" : {
    "terminatorList" : [ {
      "id" : "58420aab-496e-4314-8fe9-7413f03350e2",
      "networkId" : "d7af82fc-46ae-4ffe-8836-f33ccfa374c2",
      "zitiId" : "pfNaD0UO9Az4e2ETJag-y",
      "serviceId" : "40b7878b-7f1e-4660-89e3-440f90b17cca",
      "routerId" : "45cf6805-437f-4669-8b89-75bb51853746",
      "binding" : "edge_transport",
      "address" : "1.2.3.4",
      "endpointId" : "1efb12d9-db34-4292-8f80-a9aa93820f96",
      "cost" : 20,
      "precedence" : "default",
      "ownerIdentityId" : "f4e6e1f6-65a2-47c1-944b-d5f4499fbdb1",
      "createdBy" : "f4e6e1f6-65a2-47c1-944b-d5f4499fbdb1",
      "createdAt" : "2025-01-11T20:36:28.846840Z",
      "updatedAt" : "2025-01-11T20:36:28.848375Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "endpoint" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/1efb12d9-db34-4292-8f80-a9aa93820f96"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d7af82fc-46ae-4ffe-8836-f33ccfa374c2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators/58420aab-496e-4314-8fe9-7413f03350e2"
        },
        "service" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/40b7878b-7f1e-4660-89e3-440f90b17cca"
        },
        "edge-router" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/45cf6805-437f-4669-8b89-75bb51853746"
        }
      }
    }, {
      "id" : "ecad55a6-012a-44f3-9722-fbccc63ca7a1",
      "networkId" : "d7af82fc-46ae-4ffe-8836-f33ccfa374c2",
      "zitiId" : "4_jYJkUJ4VqkyC7lD6LFh",
      "serviceId" : "40b7878b-7f1e-4660-89e3-440f90b17cca",
      "routerId" : "45cf6805-437f-4669-8b89-75bb51853746",
      "binding" : "transport",
      "address" : "1.2.3.4",
      "endpointId" : "1efb12d9-db34-4292-8f80-a9aa93820f96",
      "cost" : 10,
      "precedence" : "required",
      "ownerIdentityId" : "f4e6e1f6-65a2-47c1-944b-d5f4499fbdb1",
      "createdBy" : "f4e6e1f6-65a2-47c1-944b-d5f4499fbdb1",
      "createdAt" : "2025-01-11T20:36:28.836704Z",
      "updatedAt" : "2025-01-11T20:36:28.845924Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "endpoint" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/1efb12d9-db34-4292-8f80-a9aa93820f96"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d7af82fc-46ae-4ffe-8836-f33ccfa374c2",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/terminators/ecad55a6-012a-44f3-9722-fbccc63ca7a1"
        },
        "service" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services/40b7878b-7f1e-4660-89e3-440f90b17cca"
        },
        "edge-router" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/45cf6805-437f-4669-8b89-75bb51853746"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Terminator

GET /v2/terminators/{id}

Authorization

This endpoint requires read action on the terminator resource type.

Path parameters

Parameter Type Optional Description

id

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/terminators/9287768c-83a7-4c8b-b587-ad49e87f6338' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ2SzZTcm9Wbl9xNXNnb0RpdWNxZ3hnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMxMzA5MjZjLTU1ZGQtNDVlYS1iMDJjLWVlYmEwN2Y4NDM1MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg4MywiZXhwIjoxNzM2NjMxNDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjMwZjgwMmMxLTQ4YmYtNDA5Ni04MGRlLWM2M2Q5NGE5OWY2NFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.iVdeT-TlGeFxPq1ZOV-qAxK3awGe0cysPHB4c3AnzXGGRy9nR5OpnFUdzafYPx1Mb8ZcT9pjFVQhW-huCjuZpi4mV-P878xSGnR0bPkfKFI44afLyuGZm_hzzvnwEm_BDruuorL9p7svKM_85fuW5cXH12BirQfrvWp7jeAFXtnSKwC3o2E5HHoTgoGBMooGqPHiQmOLWp6uPljZQZ7ggn0TIP0K71L45OMW031ytXoFlX8gJgt4F6nNwLGrvjqaSBda-RHHVzVc-G_9sz5T3z2bisJDdp_obfqhnKz9pdkJYbVyHiW1H159avKFjhXsxE188TNXqNKNCK_jR6Q2Nw'

Example response

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

{
  "id" : "9287768c-83a7-4c8b-b587-ad49e87f6338",
  "networkId" : "34fd0dc0-91a7-4f22-bfa2-10dadbf7b204",
  "zitiId" : "ziti.id.dr52pj7z",
  "serviceId" : "49274caa-1337-42b9-b9d5-5bf2bcd33be7",
  "routerId" : "7c81b6a9-7114-487d-befc-1273e0dc27a3",
  "binding" : "transport",
  "address" : "tcp:1.2.3.4:12345",
  "endpointId" : null,
  "cost" : 10,
  "precedence" : "default",
  "ownerIdentityId" : "9db407d5-10b6-4788-94f4-eba2047c9003",
  "createdBy" : "9db407d5-10b6-4788-94f4-eba2047c9003",
  "createdAt" : "2025-01-11T20:38:03.029937Z",
  "updatedAt" : "2025-01-11T20:38:03.037336Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/34fd0dc0-91a7-4f22-bfa2-10dadbf7b204",
      "profile" : "parent"
    },
    "service" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/49274caa-1337-42b9-b9d5-5bf2bcd33be7"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators/9287768c-83a7-4c8b-b587-ad49e87f6338"
    },
    "edge-router" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/7c81b6a9-7114-487d-befc-1273e0dc27a3"
    }
  }
}

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path 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

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ 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.eyJqdGkiOiJHMWl5OGFxY29UelFiVjYwSVA2X21BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjlkYjQwN2Q1LTEwYjYtNDc4OC05NGY0LWViYTIwNDdjOTAwMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg4MywiZXhwIjoxNzM2NjMxNDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE0MzUwMjdlLTc1OTUtNDlkYy04NzQzLWI4NGFkMjM1YzMyZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4M30se1wiaWRcIjpcImExYzg1ZjUyLTQxYWQtNGNjNS05ZTI4LWUzYzlmZmQ3YTIyOVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4M30se1wiaWRcIjpcImUxNzVkZTlmLTA4MzMtNGM5ZC1hZDE5LTllMzU1NmQ3ZWUyZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.QICrzohGSvDQYUlhl5QJRqtX0FAOjdXaoOxpIStmSJBBeBXtxRPBllL_0i5LKz32fx76-gmsL-E5tUuU-xC0-GJ9mChRoUERuUiGp1FEIVgFsxFlPUsqVwBjlL44I05IjTt-rdTQVEtOKFhYJCPLufSwUfriJAfd5yOB_VjU-3m_udxDVe55HsE4cV8JTivh7kmfjC_ScmFR0mIfc2RdtlhOgPCaBo8R5p8y13p8LaH8KRDVwNWF9DO_xpZ3UD0tsjdIDzDGax5Fjws2FLfw_K6KDhBmZE0Q9QJD9ZjRks97wF7lTUYOFDACbx_j3F4YODDruC1ONgWz4JMBw5jqcA' \
    -d '{"networkId":"34fd0dc0-91a7-4f22-bfa2-10dadbf7b204","serviceId":"49274caa-1337-42b9-b9d5-5bf2bcd33be7","routerId":"7c81b6a9-7114-487d-befc-1273e0dc27a3","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" : "9287768c-83a7-4c8b-b587-ad49e87f6338",
  "networkId" : "34fd0dc0-91a7-4f22-bfa2-10dadbf7b204",
  "zitiId" : "ziti.id.dr52pj7z",
  "serviceId" : "49274caa-1337-42b9-b9d5-5bf2bcd33be7",
  "routerId" : "7c81b6a9-7114-487d-befc-1273e0dc27a3",
  "binding" : "transport",
  "address" : "tcp:1.2.3.4:12345",
  "endpointId" : null,
  "cost" : 10,
  "precedence" : "default",
  "ownerIdentityId" : "9db407d5-10b6-4788-94f4-eba2047c9003",
  "createdBy" : "9db407d5-10b6-4788-94f4-eba2047c9003",
  "createdAt" : "2025-01-11T20:38:03.029937Z",
  "updatedAt" : "2025-01-11T20:38:03.037336Z",
  "deletedBy" : null,
  "deletedAt" : null
}

Delete Terminator

DELETE /v2/terminators/{id}

Authorization

This endpoint requires delete action on the terminator resource type.

Path parameters

Parameter Type Optional Description

id

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/terminators/9287768c-83a7-4c8b-b587-ad49e87f6338' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJwaWFzT2p1dkFyNzV4ajdhcFBQbWlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZkMGJkYzUzLTI5MGUtNGMxZC1hYzIwLWNiMDI0OTA3NmFlMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg4MywiZXhwIjoxNzM2NjMxNDgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQwMGZkYWE1LTQwMDQtNDc5NC1hMTdlLWI0NWFiY2ExNzE1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.bS2_kDZKgXlqSqB1virHQhUUcQR1o9uFhLBo8_IuI7r0k2fLN7l6K_D9hHoG9axaYJEsXvVCi-LzcXU92iqL0bG3YG_DRmI-MJizWzo-MOqCAg_MONMn4sPt4OrS-spdawKUCxOICC2jA6qSL5gNUfQHxUqYoGflSMH0WGDhWw7NdA8jODHn-C_lS7Unz75QBXQRkKeA0oEpm7McJWxXIERDadoJVitg6cHLsj65Iq7T4vD0VhjSjWZC7_grD3i04yBpW-GVEt-8-2wZIv0kw9l2N5UAw2LoMGSeXXNctOUdmnFkaM5Bbb_vcQxzR4TZWLJPId7P3WNjOLPRWACJxQ'

Example response

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

{
  "id" : "9287768c-83a7-4c8b-b587-ad49e87f6338",
  "networkId" : "34fd0dc0-91a7-4f22-bfa2-10dadbf7b204",
  "zitiId" : null,
  "serviceId" : "49274caa-1337-42b9-b9d5-5bf2bcd33be7",
  "routerId" : "7c81b6a9-7114-487d-befc-1273e0dc27a3",
  "binding" : "transport",
  "address" : "tcp:1.2.3.4:12345",
  "endpointId" : null,
  "cost" : 10,
  "precedence" : "default",
  "ownerIdentityId" : "9db407d5-10b6-4788-94f4-eba2047c9003",
  "createdBy" : "9db407d5-10b6-4788-94f4-eba2047c9003",
  "createdAt" : "2025-01-11T20:38:03.029937Z",
  "updatedAt" : "2025-01-11T20:38:03.166010Z",
  "deletedBy" : "6d0bdc53-290e-4c1d-ac20-cb0249076ae2",
  "deletedAt" : "2025-01-11T20:38:03.161Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/34fd0dc0-91a7-4f22-bfa2-10dadbf7b204",
      "profile" : "parent"
    },
    "service" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services/49274caa-1337-42b9-b9d5-5bf2bcd33be7"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/terminators/9287768c-83a7-4c8b-b587-ad49e87f6338"
    },
    "edge-router" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/7c81b6a9-7114-487d-befc-1273e0dc27a3"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/cb2ea66b-4693-4e19-9709-6689b7e9cf22",
      "title" : "Delete Terminator",
      "profile" : "meta"
    }
  }
}

Config

Find Configs

GET /v2/configs

Authorization

This endpoint requires read action on the config 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

id

String

true

networkId

String

true

name

String

true

configTypeId

String

true

zitiId

String

true

data

Object

true

A {@link Config}'s data is a JSON object conforming to the Json schema defined by the {@link ConfigType} linked by the {@link #configTypeId} property.

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

exclusiveToId

String

true

Specifies the id of the {@link Service} to which this type is exclusive to, if this type is exclusive. This property is only populated when this {@link Config} is exclusive. This property is covariant to the {@link #exclusive} property.

addressAndPortIndex

Map

true

exclusiveTo

String

true

Deprecated. In favor of the exclusiveToId property, will be removed after 3/1/2023.

@deprecated in favor of the exclusiveToId property, will be removed after 3/1/2023.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/configs' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhNUlCNC1Xc0VFalo1Y29CZmZKYTRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI3YzI4N2I2LTc2ODAtNDU1My1iOWE5LTY0ZWI5ZGY0OGJlNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NywiZXhwIjoxNzM2NjMxNDc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ4ODAyODU2LWZlMWMtNGNlZC1hNmEyLWQxYWUzYmU4MmM5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.GoorGNxazDqZMKRe-qnmhf40gQmVpTW-AZdlP4FE1BmvVfaqrpHYobSwrxplSw8rpZeZ_pOuyfL-McYILaOzTqAUj3gTWl8FHXsQoZt78674JwzgTr70kyJKhsrQHHkumgPmI2606wCkyW9a6g_GIJA8Ss10l8bONp2w6IhuDk-1O7cFvQg4Tnyg_9HV-jA6ZjcueFh7gHwfWbHl5cIFUuxuPOhn7L4VpfAwGj0qb4ElLFMsgvMpu2fTU7hKO24ayiAIvT49GDADpQpF8DscMc50X8z-MKRR7nl4cPRBt74skKqvOmixKEoavbHCWz-bqqTx6LpZuuGHfc9VoMHTag'

Example response

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

{
  "_embedded" : {
    "configList" : [ {
      "id" : "38e5c8a6-184c-4e0c-a293-3080febda4ba",
      "networkId" : "598a1297-db57-4003-8538-01cc59aebb25",
      "name" : "My Config 1072184164483",
      "configTypeId" : "2d57a7fb-80a4-4982-b811-98490e5bdfa8",
      "zitiId" : "ziti.id.domuun6a",
      "data" : {
        "number" : 2303,
        "street_name" : "Ziti",
        "street_type" : "Boulevard"
      },
      "ownerIdentityId" : "54db544c-6d8e-4ece-8351-5b5fb1226976",
      "createdBy" : "54db544c-6d8e-4ece-8351-5b5fb1226976",
      "createdAt" : "2025-01-11T20:37:57.571947Z",
      "updatedAt" : "2025-01-11T20:37:57.582062Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "exclusiveToId" : null,
      "addressAndPortIndex" : null,
      "exclusiveTo" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs/38e5c8a6-184c-4e0c-a293-3080febda4ba",
          "title" : "My Config 1072184164483"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/598a1297-db57-4003-8538-01cc59aebb25",
          "profile" : "parent"
        },
        "configType" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/2d57a7fb-80a4-4982-b811-98490e5bdfa8",
          "deprecation" : "Use config-type link instead"
        },
        "config-type" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/2d57a7fb-80a4-4982-b811-98490e5bdfa8"
        }
      }
    }, {
      "id" : "510e7c82-7e19-4674-83aa-16abcf287bbf",
      "networkId" : "2775b9bb-f1b1-453f-9ee4-a09093944031",
      "name" : "My Config 1072186917895",
      "configTypeId" : "c1410868-c57f-4fb1-8ae9-0dd3f803d1ef",
      "zitiId" : "ziti.id.donnurw3",
      "data" : {
        "hostname" : "abc.com",
        "port" : 11222
      },
      "ownerIdentityId" : "e17cf233-39f2-4f3c-bf52-1bd25e779769",
      "createdBy" : "e17cf233-39f2-4f3c-bf52-1bd25e779769",
      "createdAt" : "2025-01-11T20:37:57.626277Z",
      "updatedAt" : "2025-01-11T20:37:57.630782Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "exclusiveToId" : null,
      "addressAndPortIndex" : null,
      "exclusiveTo" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs/510e7c82-7e19-4674-83aa-16abcf287bbf",
          "title" : "My Config 1072186917895"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2775b9bb-f1b1-453f-9ee4-a09093944031",
          "profile" : "parent"
        },
        "configType" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/c1410868-c57f-4fb1-8ae9-0dd3f803d1ef",
          "deprecation" : "Use config-type link instead"
        },
        "config-type" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/c1410868-c57f-4fb1-8ae9-0dd3f803d1ef"
        }
      }
    }, {
      "id" : "f043d1fa-9ef4-49ae-b7f8-db97f3d6b1ae",
      "networkId" : "2775b9bb-f1b1-453f-9ee4-a09093944031",
      "name" : "My Config 1072187235864",
      "configTypeId" : "5adafb56-eed5-41fe-ac95-afd3f52116a3",
      "zitiId" : "ziti.id.dop6cram",
      "data" : {
        "number" : 2303,
        "street_name" : "Ziti",
        "street_type" : "Boulevard"
      },
      "ownerIdentityId" : "fe29bebf-b8ae-4c8a-8d11-419aacf4eb51",
      "createdBy" : "fe29bebf-b8ae-4c8a-8d11-419aacf4eb51",
      "createdAt" : "2025-01-11T20:37:57.713418Z",
      "updatedAt" : "2025-01-11T20:37:57.722298Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "exclusiveToId" : null,
      "addressAndPortIndex" : null,
      "exclusiveTo" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs/f043d1fa-9ef4-49ae-b7f8-db97f3d6b1ae",
          "title" : "My Config 1072187235864"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2775b9bb-f1b1-453f-9ee4-a09093944031",
          "profile" : "parent"
        },
        "configType" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/5adafb56-eed5-41fe-ac95-afd3f52116a3",
          "deprecation" : "Use config-type link instead"
        },
        "config-type" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/5adafb56-eed5-41fe-ac95-afd3f52116a3"
        }
      }
    }, {
      "id" : "f8137aa6-ab14-4163-92d9-9d256b075e21",
      "networkId" : "598a1297-db57-4003-8538-01cc59aebb25",
      "name" : "My Config 1072183655018",
      "configTypeId" : "976a5d6a-9c1e-469f-8a87-3ae9bb0e22a0",
      "zitiId" : "ziti.id.dokhwxqm",
      "data" : {
        "hostname" : "abc.com",
        "port" : 11222
      },
      "ownerIdentityId" : "fedb8116-c64d-457f-8348-2058735275c5",
      "createdBy" : "fedb8116-c64d-457f-8348-2058735275c5",
      "createdAt" : "2025-01-11T20:37:57.434684Z",
      "updatedAt" : "2025-01-11T20:37:57.439598Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "exclusiveToId" : null,
      "addressAndPortIndex" : null,
      "exclusiveTo" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/configs/f8137aa6-ab14-4163-92d9-9d256b075e21",
          "title" : "My Config 1072183655018"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/598a1297-db57-4003-8538-01cc59aebb25",
          "profile" : "parent"
        },
        "configType" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/976a5d6a-9c1e-469f-8a87-3ae9bb0e22a0",
          "deprecation" : "Use config-type link instead"
        },
        "config-type" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/976a5d6a-9c1e-469f-8a87-3ae9bb0e22a0"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Config

GET /v2/configs/{id}

Authorization

This endpoint requires read action on the config resource type.

Path parameters

Parameter Type Optional Description

id

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/configs/f043d1fa-9ef4-49ae-b7f8-db97f3d6b1ae' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJLZWFOQlVOSVpxM3ZFUXpEb0Q5VEJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkzOGM1YWE0LTRjZDgtNGZjYy1iZjVhLTU3Y2NlNTlkY2I0NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NywiZXhwIjoxNzM2NjMxNDc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdkNDI5ZmZkLWRkZDMtNGUwYS04ZDFhLWEyOTljMWM1MzhjZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.DPg_TmfiN5guq1F_TO_ktaHdH2CM7wWd4IPO483MMaGUiROgePyBDnVLzDtFDJ0nsLgA1FJNALsWg4J2knNd6l7l9OcAECX_C8VPVbwGC8IBunarDRTDjJwHnc_0ZCT3sPaH0nYldD-BOKgUjsCdRVUNnx2o2mJSDoCgedcOLDWgx4OzCP4feWFT4ReWzXfQFcCfkztHjGnRY96fXO2rBdoDNLpK5dPvkHZ_csP6_apqb3D6uBWcPSwD0L1wXGAy9J5slAGXJPsGIsPiuWVhxGDN-fyiHM4In2JsUdP1NcrXJKh5HjBCeSb14PUBnIhmn_gMpioQ0nduCuHKvgsADw'

Example response

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

{
  "id" : "f043d1fa-9ef4-49ae-b7f8-db97f3d6b1ae",
  "networkId" : "2775b9bb-f1b1-453f-9ee4-a09093944031",
  "name" : "My Config 1072187235864",
  "configTypeId" : "5adafb56-eed5-41fe-ac95-afd3f52116a3",
  "zitiId" : "ziti.id.dop6cram",
  "data" : {
    "number" : 2303,
    "street_name" : "Ziti",
    "street_type" : "Boulevard"
  },
  "ownerIdentityId" : "fe29bebf-b8ae-4c8a-8d11-419aacf4eb51",
  "createdBy" : "fe29bebf-b8ae-4c8a-8d11-419aacf4eb51",
  "createdAt" : "2025-01-11T20:37:57.713418Z",
  "updatedAt" : "2025-01-11T20:37:57.722298Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "exclusiveToId" : null,
  "addressAndPortIndex" : null,
  "exclusiveTo" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs/f043d1fa-9ef4-49ae-b7f8-db97f3d6b1ae",
      "title" : "My Config 1072187235864"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2775b9bb-f1b1-453f-9ee4-a09093944031",
      "profile" : "parent"
    },
    "configType" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/5adafb56-eed5-41fe-ac95-afd3f52116a3",
      "deprecation" : "Use config-type link instead"
    },
    "config-type" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/5adafb56-eed5-41fe-ac95-afd3f52116a3"
    }
  }
}

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

Specifies the id of the {@link Network} within which the resulting {@link Config} should be created.

name

String

true

Specifies the name to assign to the {@link Config}.

configTypeId

String

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have by the id of that {@link ConfigType}. The referenced {@link ConfigType} must exist, be in a valid state for use, and not be 'exclusive' or otherwise reserved by some other resource. This method of specifying the {@link ConfigType} is mutually exclusive with name and embedded create based declarations.

configTypeName

String

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have by the name of that {@link ConfigType}. The referenced {@link ConfigType} must exist, be in a valid state for use, and not be 'exclusive' or otherwise reserved by some other resource. This method of specifying the {@link ConfigType} is mutually exclusive with id and embedded create based declarations.

configType

Object

true

Specifies the {@link ConfigType} that the resulting {@link Config} should have. The form of this {@link ConfigType} declaration is an embedded "command" to create a {@link ConfigType}. The resulting {@link ConfigType} instance will only be usable by this {@link Config} and it will be deleted when this {@link Config} is deleted. This method of specifying the {@link ConfigType} is mutually exclusive with id and name based declarations.

configType.networkId

String

true

Specifies the id of the {@link Network} within which the resulting {@link ConfigType} should be created.

configType.name

String

true

Specifies the name to assign to the {@link ConfigType}.

configType.schema

Object

true

Specifies the JSON Schema to assign to the {@link ConfigType}.

data

Object

true

Specifies the data to assign to the {@link Config}.

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/configs' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJMZGZ3bk43Y1BWaFhLbXEtMTRHelJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZlMjliZWJmLWI4YWUtNGM4YS04ZDExLTQxOWFhY2Y0ZWI1MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3NywiZXhwIjoxNzM2NjMxNDc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgwOTkxMjhjLWMzZmYtNDVmMS1iNDMyLTg0Y2Y5Y2Y2ZTY3MVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3N30se1wiaWRcIjpcImFlNzZlYTMyLTIyYTYtNDA4OC1hMTBkLTVkODg3Y2VmYTkxN1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.M9Ok3bQGzjUu6OwNsImg9UXV59FyZfnBmEVxrLSesNSwRUDPjsXZePYWRl6jLa2YPwrEi742s6OzS1Lo3T8ngR2S4mBGZij5MkwTEgpbg7Ciq9QlHDA7AghvqM_22klr5Nh2SuZc69mMAxZ9oVm-GvK_pkyfq0MVP1PdJ3dIlWXaSlSx5mPs-DGfP_WuUIE1wayz-tfUEToLy7MPj2LO0dgn9Vxo79n-iZLibVyLhK90SZiR4--C6M1Kt-T-LMc_0qUnclOJib2WxRzDqDDZNZapUhio5ZrCr2jgDiIVdmOy0kAkEP5pAZDqVBtPvLq-GwGYaNcbsipIb0AQPzGOpQ' \
    -d '{"networkId":"2775b9bb-f1b1-453f-9ee4-a09093944031","name":"My Config 1072187235864","configTypeId":null,"configTypeName":null,"configType":{"networkId":"2775b9bb-f1b1-453f-9ee4-a09093944031","name":"My ConfigType 1072187235864","schema":{"type":"object","properties":{"number":{"type":"number"},"street_name":{"type":"string"},"street_type":{"type":"string","enum":["Street","Avenue","Boulevard"]}}}},"data":{"number":2303,"street_name":"Ziti","street_type":"Boulevard"}}'

Example response

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

{
  "id" : "f043d1fa-9ef4-49ae-b7f8-db97f3d6b1ae",
  "networkId" : "2775b9bb-f1b1-453f-9ee4-a09093944031",
  "name" : "My Config 1072187235864",
  "configTypeId" : "5adafb56-eed5-41fe-ac95-afd3f52116a3",
  "zitiId" : "ziti.id.dop6cram",
  "data" : {
    "number" : 2303,
    "street_name" : "Ziti",
    "street_type" : "Boulevard"
  },
  "ownerIdentityId" : "fe29bebf-b8ae-4c8a-8d11-419aacf4eb51",
  "createdBy" : "fe29bebf-b8ae-4c8a-8d11-419aacf4eb51",
  "createdAt" : "2025-01-11T20:37:57.713418Z",
  "updatedAt" : "2025-01-11T20:37:57.722298Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "exclusiveToId" : null,
  "addressAndPortIndex" : null,
  "exclusiveTo" : null
}

Delete Config

DELETE /v2/configs/{id}

Authorization

This endpoint requires delete action on the config resource type.

Path parameters

Parameter Type Optional Description

id

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/configs/f043d1fa-9ef4-49ae-b7f8-db97f3d6b1ae' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJKM1NPWGlmcW1yUDY4Mm9mVm56OXRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIyZmI4MmMwLWVjMTItNDczZS1iNDIxLTQwZThjYzhlMTVkYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg3OCwiZXhwIjoxNzM2NjMxNDc4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVjMzg1MjllLTZhMDQtNDk1Ni1hMDM0LWMwMmJlOTU1MWFiNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg3OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.RwHySMlwyohLVu4-moCY-9sQQohhdUPe7L-rZVlUKSuNRMj514onnuC8HoO6Pm4E18Fe2-OcTlHLWPtPIzLNqS3YjsKgrDHfijv0D1VAD2cqTwogullbgUe9s8ORK2JDMytXFhYecDE9dc7q_oVILJXmNJoTOFNaOF3Xtrha5L7PfzMkCM6eZFIcQ2_yWey18Qh6_Alq3lMVeKwukiEddU2u8-0ypnw4586SzOWHcCaPpNR1Ps9BcymCdM_e5j83NeALt5oToGQAyCmAy5aWk-eXQhglDeWXgqrPvyGA1Ga1a74JgewNdMrL6v8wf_gSQBkR9FHqVUftj1QZP-9GlQ'

Example response

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

{
  "id" : "f043d1fa-9ef4-49ae-b7f8-db97f3d6b1ae",
  "networkId" : "2775b9bb-f1b1-453f-9ee4-a09093944031",
  "name" : "My Config 1072187235864",
  "configTypeId" : "5adafb56-eed5-41fe-ac95-afd3f52116a3",
  "zitiId" : null,
  "data" : {
    "number" : 2303,
    "street_name" : "Ziti",
    "street_type" : "Boulevard"
  },
  "ownerIdentityId" : "fe29bebf-b8ae-4c8a-8d11-419aacf4eb51",
  "createdBy" : "fe29bebf-b8ae-4c8a-8d11-419aacf4eb51",
  "createdAt" : "2025-01-11T20:37:57.713418Z",
  "updatedAt" : "2025-01-11T20:37:58.104066Z",
  "deletedBy" : "22fb82c0-ec12-473e-b421-40e8cc8e15db",
  "deletedAt" : "2025-01-11T20:37:58.098Z",
  "exclusiveToId" : null,
  "addressAndPortIndex" : null,
  "exclusiveTo" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/configs/f043d1fa-9ef4-49ae-b7f8-db97f3d6b1ae",
      "title" : "My Config 1072187235864"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/2775b9bb-f1b1-453f-9ee4-a09093944031",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/755f3981-2e9d-4352-85a8-8b8a57fca5d5",
      "title" : "Delete Config",
      "profile" : "meta"
    },
    "configType" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/5adafb56-eed5-41fe-ac95-afd3f52116a3",
      "deprecation" : "Use config-type link instead"
    },
    "config-type" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/5adafb56-eed5-41fe-ac95-afd3f52116a3"
    }
  }
}

Config Type

Find Config Types

GET /v2/config-types

Authorization

This endpoint requires read action on the config-type 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

id

String

true

networkId

String

true

name

String

true

zitiId

String

true

schema

Object

true

A {@link ConfigType}'s schema is a JSON object conforming to the JSON Schema specification, which itself specifies the schema of {@link Config} data properties that are of this {@link ConfigType}.

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedBy

String

true

deletedAt

String

true

exclusiveToId

String

true

Specifies the id of the {@link Config} to which this type is exclusive to, if this type is exclusive. This property is only populated when this {@link ConfigType} is exclusive. Lack of this property indicates that this {@link ConfigType} is not exclusive.

exclusiveTo

String

true

Deprecated. In favor of the exclusiveToId property, will be removed after 3/1/2023.

@deprecated in favor of the exclusiveToId property, will be removed after 3/1/2023.

reserved

Boolean

true

A computed property indicating whether or not this {@link ConfigType} is "reserved". A reserved {@link ConfigType} is one which has been defined by the platform and which can not be updated or deleted. {@link Config}s may be created using a reserved {@link ConfigType}, and reserved {@link ConfigType}s are by definition non-exclusive.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/config-types' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJTSVhMNF9WOVZYU0RnamVaVnBzWFhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFhYTlhMDYwLWNiM2QtNGViZS1hOGNhLTk0OTg3NmM4ZjhlOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgxNSwiZXhwIjoxNzM2NjMxNDE1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI2MjBjM2RkLTQ2NjMtNDljNy04Yjc2LTM4NDAyMGM1YjdhMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgxNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.X4EYD2tW9U5dGRfo6t0uIfQ-7Fefbacitrn2DLe083Y_0kKTr7jx1ANPUKn1Fqv4xAJzSc8hAf8daYK1WI_PmD8R3U1ki6qnM1aHaVrd_-dSe8SD2LjoH4yU76q_0wvnlImB3slORT1QA9rMohsaR0NFYyEQE7StxWDvJTA_jLhR74YoKXljgyBaTy3FEc8TVrwIAabzJWIgoveewS5DanngQNzk0EtvpsonBM6AaGDyJThJQgGa51xirzdRHveXHmtdrSXphH2zPQqKXsr9IWitKXNcF14OMk1_CwufF4q635NfvyxOqt5P5W2jXZ439J0WCt8gx2e37rbNiMRSAg'

Example response

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

{
  "_embedded" : {
    "configTypeList" : [ {
      "id" : "c0160e60-0b57-454b-a3bf-87aec32dd728",
      "networkId" : "63794565-f564-4186-8167-04dde0938977",
      "name" : "Test Config Type 2",
      "zitiId" : "EBaSKAZVfpKzRWlPowkeK",
      "schema" : {
        "type" : "object"
      },
      "ownerIdentityId" : "a5830893-6868-4fd2-b1b4-f20072d7379f",
      "createdBy" : "a5830893-6868-4fd2-b1b4-f20072d7379f",
      "createdAt" : "2025-01-11T20:36:55.928577Z",
      "updatedAt" : "2025-01-11T20:36:55.930497Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "reserved" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/63794565-f564-4186-8167-04dde0938977",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/c0160e60-0b57-454b-a3bf-87aec32dd728",
          "title" : "Test Config Type 2"
        }
      }
    }, {
      "id" : "dd765fa3-5990-4da7-86b5-032c75082957",
      "networkId" : "63794565-f564-4186-8167-04dde0938977",
      "name" : "Test Config Type 1",
      "zitiId" : "EqJk67FVmsfERbsI07jgS",
      "schema" : {
        "type" : "object"
      },
      "ownerIdentityId" : "a5830893-6868-4fd2-b1b4-f20072d7379f",
      "createdBy" : "a5830893-6868-4fd2-b1b4-f20072d7379f",
      "createdAt" : "2025-01-11T20:36:55.886106Z",
      "updatedAt" : "2025-01-11T20:36:55.894952Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "reserved" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/63794565-f564-4186-8167-04dde0938977",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/dd765fa3-5990-4da7-86b5-032c75082957",
          "title" : "Test Config Type 1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Config Type

GET /v2/config-types/{id}

Authorization

This endpoint requires read action on the config-type resource type.

Path parameters

Parameter Type Optional Description

id

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/config-types/93b2b9fe-fa1b-4e4a-81c1-e49e5cb88b0b' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDSFBkM1M3UWRvRHdwa1BEel9kQ1h3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImIwMDc3MTMyLTY2MjEtNGJjNi1hOTliLTgxNzNkZjAyZjZhMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc1MywiZXhwIjoxNzM2NjMxMzUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ0NDI0MDBjLTZlY2ItNGYxYi04NjViLTRhNjRiNmMzZTk1NlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc1M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.aZtmYsCkeyLbbGWip_sLx31PRr7CtumjNgOLYSlcSzS_E9ErYMuq7QT2QF_avlcoPpwN3ti6h2-P-SOGFoY2uxaoH6sjpH58JY6JzATLOrFBaNBmatvJ0QtItPgoDA7G2n9YI5diSDKOtFYogV3sUoq6oUwQkzBcbU7MMOUfovt41xb76w0XaqkNeAiGmAOL2qt8NdWT0XLtaS1WJS1Zw32CZ4lni9rKbpVOz9hN6hjFpRxT3jhwJFvR5IS6v5K5oaHkUx8VvfbwSmtjslXMnpYGBp49rr_wTwr8lBogyBjqaCavXYbankwhTWlmuMdocmYtWmbTF4-5263dwL0vOQ'

Example response

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

{
  "id" : "93b2b9fe-fa1b-4e4a-81c1-e49e5cb88b0b",
  "networkId" : "5226fa94-0ac9-43db-a8eb-11a6e92c96a6",
  "name" : "My ConfigType 946923192652",
  "zitiId" : "ziti.id.c3q2drxh",
  "schema" : {
    "type" : "object",
    "properties" : {
      "number" : {
        "type" : "number"
      },
      "street_name" : {
        "type" : "string"
      },
      "street_type" : {
        "type" : "string",
        "enum" : [ "Street", "Avenue", "Boulevard" ]
      }
    }
  },
  "ownerIdentityId" : "3b15bff0-cf13-4ce3-8636-d7d4fbe630ed",
  "createdBy" : "3b15bff0-cf13-4ce3-8636-d7d4fbe630ed",
  "createdAt" : "2025-01-11T20:35:53.681494Z",
  "updatedAt" : "2025-01-11T20:35:53.702042Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "reserved" : false,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/93b2b9fe-fa1b-4e4a-81c1-e49e5cb88b0b",
      "title" : "My ConfigType 946923192652"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5226fa94-0ac9-43db-a8eb-11a6e92c96a6",
      "profile" : "parent"
    }
  }
}

Create Config Type

POST /v2/config-types

Authorization

This endpoint requires create action on the config-type resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

Specifies the id of the {@link Network} within which the resulting {@link ConfigType} should be created.

name

String

true

Specifies the name to assign to the {@link ConfigType}.

schema

Object

true

Specifies the JSON Schema to assign to the {@link ConfigType}.

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/config-types' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5OEVIUGZnRE1TU09wVFlTZ1FtM0VnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNiMTViZmYwLWNmMTMtNGNlMy04NjM2LWQ3ZDRmYmU2MzBlZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc1MywiZXhwIjoxNzM2NjMxMzUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBiOTEwZTE5LTUyZjAtNDVmMC1hMTA4LTQxZDVhOTNhOGNjYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc1M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ielY_MzhP-4g0C1Ou0KoRFp0-ksxsllHxG5L0hPflkVfaMJgurUJ56bYehGUmSwiakLxtn-ZXaa5GKx1-gaA79wzO3c9_zKX4qp4MGLIcvC2VcWH6T8cM_K-_nr5K43gK44p3HXvWdwUhTXqC1LX7KKQQ_4ENpAwt2TH1Tuuo2urwuK6Z7u1mU9bIrvZd7z8medpQWmxz4Ds56yEgNIIA3KHn8sYxuOUwV-yz7HPuNHWON0hTdLVrdq6sO9Z2TDtBJG3C4WDvqEBQDD0k05i9I0PV7__Y36LdVrYh-qWg7kIFHRl-jReo7up9PeLVTE5F4NlK1G4DmTweeF9oWhZLw' \
    -d '{"networkId":"5226fa94-0ac9-43db-a8eb-11a6e92c96a6","name":"My ConfigType 946923192652","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" : "93b2b9fe-fa1b-4e4a-81c1-e49e5cb88b0b",
  "networkId" : "5226fa94-0ac9-43db-a8eb-11a6e92c96a6",
  "name" : "My ConfigType 946923192652",
  "zitiId" : "ziti.id.c3q2drxh",
  "schema" : {
    "type" : "object",
    "properties" : {
      "number" : {
        "type" : "number"
      },
      "street_name" : {
        "type" : "string"
      },
      "street_type" : {
        "type" : "string",
        "enum" : [ "Street", "Avenue", "Boulevard" ]
      }
    }
  },
  "ownerIdentityId" : "3b15bff0-cf13-4ce3-8636-d7d4fbe630ed",
  "createdBy" : "3b15bff0-cf13-4ce3-8636-d7d4fbe630ed",
  "createdAt" : "2025-01-11T20:35:53.681494Z",
  "updatedAt" : "2025-01-11T20:35:53.702042Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "reserved" : false
}

Delete Config Type

DELETE /v2/config-types/{id}

Authorization

This endpoint requires delete action on the config-type resource type.

Path parameters

Parameter Type Optional Description

id

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/config-types/93b2b9fe-fa1b-4e4a-81c1-e49e5cb88b0b' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJQQzZiT1ZyWl82YUxhb1VtQkdBUklRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk2MTFhZWM0LTQ1ZDItNDkyMS05NzA0LTQ5NTFkYmNmNDU4NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc1NCwiZXhwIjoxNzM2NjMxMzU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJlZjQ2ZGI0LTFmNDEtNDA0MC1hZDEzLTRhZGViZTY4MDU3ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc1NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.QUkePdsG46QaVXTTh67p8bqSYyoSgQQ615tBOmS8AJUezm7bGJqa9xua1OH48X70e0krbTErpUBzU8O4L_WiBaa9cp_B5V3PMRlD-1zOD5rNRjdC_wwfiNGkr5IH-gLwi4aVUASkEWZmlTyq_2Mz-oQwKjp6jMS9D8YCXC58trXa8vDqvyrbdQwmwqYSJE8W7amnCGDySIU9c3qBLBxba6lf68lWrWg5XLZqPJVHxEVeinfW3xWlbQsIOCjjWhWbT10b6XurTVx0uwbN0rOkQArhCkNa3bCBZyMnUkIeJmwixWd11UT3CDkPzEn6-zxh3zoBTd74rpH5JrKoI-Ll0Q'

Example response

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

{
  "id" : "93b2b9fe-fa1b-4e4a-81c1-e49e5cb88b0b",
  "networkId" : "5226fa94-0ac9-43db-a8eb-11a6e92c96a6",
  "name" : "My ConfigType 946923192652",
  "zitiId" : null,
  "schema" : {
    "type" : "object",
    "properties" : {
      "number" : {
        "type" : "number"
      },
      "street_name" : {
        "type" : "string"
      },
      "street_type" : {
        "type" : "string",
        "enum" : [ "Street", "Avenue", "Boulevard" ]
      }
    }
  },
  "ownerIdentityId" : "3b15bff0-cf13-4ce3-8636-d7d4fbe630ed",
  "createdBy" : "3b15bff0-cf13-4ce3-8636-d7d4fbe630ed",
  "createdAt" : "2025-01-11T20:35:53.681494Z",
  "updatedAt" : "2025-01-11T20:35:54.224554Z",
  "deletedBy" : "9611aec4-45d2-4921-9704-4951dbcf4586",
  "deletedAt" : "2025-01-11T20:35:54.199Z",
  "reserved" : false,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/config-types/93b2b9fe-fa1b-4e4a-81c1-e49e5cb88b0b",
      "title" : "My ConfigType 946923192652"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5226fa94-0ac9-43db-a8eb-11a6e92c96a6",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/a75b014d-4971-4d74-b343-987778569ffc",
      "title" : "Delete ConfigType",
      "profile" : "meta"
    }
  }
}

Auth Policy

Find Auth Policies

GET /v2/auth-policies

Authorization

This endpoint requires read action on the auth-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

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/auth-policies?id=b6aaea52-55c1-49cf-a26f-004e2988b9de' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ1dmpZbEx3OVRDQzIxWHNFTThXUnVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNkOTNmNWFhLWYyMzUtNDNlNS04NTg3LTQ3OGJlMjY4ZTFjZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkxNSwiZXhwIjoxNzM2NjMxNTE1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImUzMjMxZjYwLTkyYzEtNGE2NC1hMjM1LWM1NzcxZjA2NmQ2MlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkxNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.cqxZw1SlSWnfrtBFmQdkJb7qEV2_kU5OZqu57otRa9idtjdPXzqalebOlmEjMApnnDaz_eMNLFmo8NvBQV0AVJiv2lSZjUj4CQU5-E-cyF3hcoU8ghG87XIC1qCmPQi_xVgebcrCtg77yJRM3byUu7kp5iQ8__l5FnkkE8029gPs1Vn6ZsVEH9Tp_rvZ94GJxjw5PbrkdenUJW5k_eN-wjU4GEQ7SIbxwW1vlptRNFmZnOeEroY6v1dDhMx2GjySCXsryjo-H42LCbjJs4soDxZbPzI8M43E_F4sPzBtjCTXMEqjI50j4qjW9WhucCYMEDcwGZEf7NuIKD2LoMtMkw'

Example response

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

[ {
  "id" : "b6aaea52-55c1-49cf-a26f-004e2988b9de",
  "networkId" : "e30db053-9abb-41f3-a3a0-2d289c63b886",
  "zitiId" : "ziti.id.e2xojput",
  "name" : "Updated Test AuthPolicy",
  "primary" : {
    "cert" : {
      "allowed" : false,
      "allowExpiredCerts" : true
    },
    "extJwt" : {
      "allowed" : false,
      "allowedSigners" : [ "dd03a87e-8e03-43f9-b030-5e151834d94f", "e2cdb4ea-a09c-4666-bfce-76ad6b89437a" ]
    },
    "updb" : {
      "allowed" : true,
      "lockoutDurationMinutes" : 6,
      "maxAttempts" : 4,
      "minPasswordLength" : 9,
      "requireMixedCase" : false,
      "requireNumberChar" : false,
      "requireSpecialChar" : false
    }
  },
  "secondary" : {
    "requireExtJwtSigner" : "c6d58215-0812-400c-a9e5-89b0f575bb5f",
    "requireTotp" : true
  },
  "createdBy" : "6d5f2421-c2c3-4639-9511-f3175ccb048e",
  "createdAt" : "2025-01-11T20:38:28.705367Z",
  "updatedAt" : "2025-01-11T20:38:35.318950Z",
  "appliedAt" : "2025-01-11T20:38:35.318950Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
} ]

Get Auth Policy

GET /v2/auth-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/auth-policies/b6aaea52-55c1-49cf-a26f-004e2988b9de?meta=ziti,diffZiti' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ1cjZHNHAyNEo4cWZRQW9oMXdQdnBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU1ZTg3YTczLTg1OGItNGVmYi04ZTBlLWEyOWViZTRmNmY1ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkxNCwiZXhwIjoxNzM2NjMxNTE0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImYwMzBmN2U3LWQ1ZTEtNDIyMy04YjlmLTg3NTQ1NGQ0YjJmOVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkxNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jCdWu2k3Ek-Gep-gZULQKpwTWaG6R_vNcjnze2z5f9tDbng2nmngXBE-S5mAAh3c3A-fHVYrXiAckn4UaMLOv-GbpNZ1zvsSE8-DKWAWBXvnc8eZuzM945-Ii6Lb2e1o_8AfowsvrIlyQzf8sIm8o8b4r5zKodE24HUVHJhwpVNQRfIwo9l_mcdkaE-eHF4KghjimHSY3Yrmie0LhiOa8vI1gGsIn-WElKKnZVbUDZAapCjugOQOCuAVh1ZMQ-BR-BxBVKH4fSaEdr0I8bf7TfgFY7VPamCtm7Jot5q7ewqjr2eGoxDA04qQpX6q7NP45a0elo1OXJvXgzm8Cdr69w'

Example response

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

{
  "id" : "b6aaea52-55c1-49cf-a26f-004e2988b9de",
  "networkId" : "e30db053-9abb-41f3-a3a0-2d289c63b886",
  "zitiId" : "ziti.id.e2xojput",
  "name" : "Test AuthPolicy",
  "primary" : {
    "cert" : {
      "allowed" : true,
      "allowExpiredCerts" : false
    },
    "extJwt" : {
      "allowed" : true,
      "allowedSigners" : [ "f11199ba-8e2a-4fbd-a037-6de4a828de46" ]
    },
    "updb" : {
      "allowed" : false,
      "lockoutDurationMinutes" : 5,
      "maxAttempts" : 3,
      "minPasswordLength" : 8,
      "requireMixedCase" : true,
      "requireNumberChar" : true,
      "requireSpecialChar" : true
    }
  },
  "secondary" : {
    "requireExtJwtSigner" : null,
    "requireTotp" : false
  },
  "createdBy" : "6d5f2421-c2c3-4639-9511-f3175ccb048e",
  "createdAt" : "2025-01-11T20:38:28.705367Z",
  "updatedAt" : "2025-01-11T20:38:28.711921Z",
  "appliedAt" : "2025-01-11T20:38:28.711921Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "_meta" : {
    "diffZiti" : {
      "differencesDetected" : false,
      "description" : "No differences detected",
      "comparedAt" : "2025-01-11T20:38:34.922698367Z"
    },
    "ziti" : {
      "id" : "ziti.id.e2xojput",
      "name" : "Test AuthPolicy",
      "primary" : {
        "cert" : {
          "allowExpiredCerts" : false,
          "allowed" : true
        },
        "extJwt" : {
          "allowed" : true,
          "allowedSigners" : [ "ziti-id-3285" ]
        },
        "updb" : {
          "allowed" : false,
          "lockoutDurationMinutes" : 5,
          "maxAttempts" : 3,
          "minPasswordLength" : 8,
          "requireMixedCase" : true,
          "requireNumberChar" : true,
          "requireSpecialChar" : true
        }
      },
      "secondary" : {
        "requireExtJwtSigner" : null,
        "requireTotp" : false
      },
      "tags" : {
        "network-id" : "e30db053-9abb-41f3-a3a0-2d289c63b886",
        "resource-id" : "b6aaea52-55c1-49cf-a26f-004e2988b9de"
      },
      "createdAt" : "2025-01-11T20:38:28.711595508Z",
      "updatedAt" : "2025-01-11T20:38:28.711596403Z"
    }
  }
}

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path 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

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ 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.eyJqdGkiOiJFNjV2a29DQVJaZ1YwbjJNMHVCcHdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZkNWYyNDIxLWMyYzMtNDYzOS05NTExLWYzMTc1Y2NiMDQ4ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwOCwiZXhwIjoxNzM2NjMxNTA4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBkMTBkY2ZmLTY5YmYtNGMwZS04MDNjLTRkNDM4NjU4MGFlZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwOH0se1wiaWRcIjpcImQ3ZTUzNTA5LTdkMjUtNGQ1Yy05ZTViLWQwNDFhZTA2OWMwM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwOH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.nAFDTWl0cvocPfwH8iUk_05-SSy3bpAW8TPXs6PrkQKfdwv6WHgPIvvLCc92sBO4HMKwGIAULh3CnGJrH8Q_xfwxwPaHxZM8HTqsQLMprS9x0PPdH-GvaIUINzwSi3jEXvyOL0_MqhK_ibTNGRLz51BdICgy9FD1V8rF_1-y1WMxIDt2F_4KTdOryLNoc7i-eENYS2h3Zv-23MnH59bMU2CawjDlLYUSqRS9IkgJzVxRLumx_surPoqtLCf5HAaj3X0XvrcCCGDlACN4L8m17hweleUucuJzgooZL_2sQQx7gPLkqwdL49H0zx4uFa8_2AZXUe2fjDqI4oyY2tGSMA' \
    -d '{"networkId":"e30db053-9abb-41f3-a3a0-2d289c63b886","name":"Test AuthPolicy","primary":{"cert":{"allowed":true,"allowExpiredCerts":false},"extJwt":{"allowed":true,"allowedSigners":["f11199ba-8e2a-4fbd-a037-6de4a828de46"]},"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" : "b6aaea52-55c1-49cf-a26f-004e2988b9de",
  "networkId" : "e30db053-9abb-41f3-a3a0-2d289c63b886",
  "zitiId" : "ziti.id.e2xojput",
  "name" : "Test AuthPolicy",
  "primary" : {
    "cert" : {
      "allowed" : true,
      "allowExpiredCerts" : false
    },
    "extJwt" : {
      "allowed" : true,
      "allowedSigners" : [ "f11199ba-8e2a-4fbd-a037-6de4a828de46" ]
    },
    "updb" : {
      "allowed" : false,
      "lockoutDurationMinutes" : 5,
      "maxAttempts" : 3,
      "minPasswordLength" : 8,
      "requireMixedCase" : true,
      "requireNumberChar" : true,
      "requireSpecialChar" : true
    }
  },
  "secondary" : {
    "requireExtJwtSigner" : null,
    "requireTotp" : false
  },
  "createdBy" : "6d5f2421-c2c3-4639-9511-f3175ccb048e",
  "createdAt" : "2025-01-11T20:38:28.705367Z",
  "updatedAt" : "2025-01-11T20:38:28.711921Z",
  "appliedAt" : "2025-01-11T20:38:28.711921Z",
  "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

id

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

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/auth-policies/b6aaea52-55c1-49cf-a26f-004e2988b9de' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ0LU1nUlpQeUZKckZpS3hjYUZ4SzFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVjNzQ3ZGQyLTFlOWQtNDM0OC04YzJmLWZhODhjM2FlMTAwOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkxNSwiZXhwIjoxNzM2NjMxNTE1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRlNTZhYWEyLWE4OTgtNDFlZS1hNTc2LWY1OTM2MGM0NWI1MFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkxNX0se1wiaWRcIjpcImFiYmFlNmIwLWJmNzctNGUwOS1iYWI3LTlkYzczMTY5YjlkZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkxNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Hrv8C8MFVEOD4DSX1rgXd66sr-ZOLWImyZ54Db5sP9x8uhbEYv4EncT7jXrUPxzpoK_47-NczQjnwwehTIJzw6DBO_RYgq0dU7m1plhKgqeihtYFCeJVEV8HW9-yfGOh6HjogfKw_Nw9SurRCzMR9_6CQCIgSd8WIKrAt-dmc2a48NgJzFwKjoj8nAUPsmYeagyta6HIzam3y7clK8pGvXaf10QXK1i3TJhpj8mCe9BgLfp49jCOqsYHPnp9oxthLHF29sRMI-bvsfkS7qVjy_3_wGnVtLmBQ3Zx1Of4RR285rQn9hlpfjh4p-G2SGJ9YhwTijqGbLyZYZZX4ORMxQ' \
    -d '{"name":"Updated Test AuthPolicy","primary":{"cert":{"allowed":false,"allowExpiredCerts":true},"extJwt":{"allowed":false,"allowedSigners":["dd03a87e-8e03-43f9-b030-5e151834d94f","e2cdb4ea-a09c-4666-bfce-76ad6b89437a"]},"updb":{"allowed":true,"lockoutDurationMinutes":6,"maxAttempts":4,"minPasswordLength":9,"requireMixedCase":false,"requireNumberChar":false,"requireSpecialChar":false}},"secondary":{"requireExtJwtSigner":"c6d58215-0812-400c-a9e5-89b0f575bb5f","requireTotp":true}}'

Example response

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

{
  "id" : "b6aaea52-55c1-49cf-a26f-004e2988b9de",
  "networkId" : "e30db053-9abb-41f3-a3a0-2d289c63b886",
  "zitiId" : "ziti.id.e2xojput",
  "name" : "Updated Test AuthPolicy",
  "primary" : {
    "cert" : {
      "allowed" : false,
      "allowExpiredCerts" : true
    },
    "extJwt" : {
      "allowed" : false,
      "allowedSigners" : [ "dd03a87e-8e03-43f9-b030-5e151834d94f", "e2cdb4ea-a09c-4666-bfce-76ad6b89437a" ]
    },
    "updb" : {
      "allowed" : true,
      "lockoutDurationMinutes" : 6,
      "maxAttempts" : 4,
      "minPasswordLength" : 9,
      "requireMixedCase" : false,
      "requireNumberChar" : false,
      "requireSpecialChar" : false
    }
  },
  "secondary" : {
    "requireExtJwtSigner" : "c6d58215-0812-400c-a9e5-89b0f575bb5f",
    "requireTotp" : true
  },
  "createdBy" : "6d5f2421-c2c3-4639-9511-f3175ccb048e",
  "createdAt" : "2025-01-11T20:38:28.705367Z",
  "updatedAt" : "2025-01-11T20:38:35.318950Z",
  "appliedAt" : "2025-01-11T20:38:35.318950Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Delete Auth Policy

DELETE /v2/auth-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/auth-policies/b6aaea52-55c1-49cf-a26f-004e2988b9de' -i -X DELETE \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZaG9XcGhkQWFVZElRTXBDR1AwSWVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEwNDE0YjAzLWMxMzktNDM4ZC04ZjgxLTEwODliY2E2ZTZiOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkxNSwiZXhwIjoxNzM2NjMxNTE1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg3YWRkOGVmLTE2OGQtNDYzMi1iNTU2LTlmNTFkMThiNWRmNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkxNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.HZeG1Pco1AglqQ1BrAS5awqVqVNe64HglMeg5Wj6MhBI2dWdkc2QaRPPvxuE6K07IxNuUvjvru2yWGHkmhaQk86bfcWdvvKFANlLuWptR2XYIu-rzvy7gYCUItPK96uZK4v-X7JcW0fLHnPk15e_pgH6yuyz44j30sP04-oQ9-ZykkOJ1lKPXuc3Vh2AMrnGgeCHKr7C2MK2qoWr1qSRF8aO75-zs5hYNJvDBmqJNZExbpZoDu6jXiOifUDEayvtRaH9OE683vo3XfM868l8zdKpvR_Gpb1of2cqo5IpQbdNIp6dioqW4X01ojFQnNlMwVGMcMsBPYu2N6j_oUWzEg'

Example response

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

{
  "id" : "b6aaea52-55c1-49cf-a26f-004e2988b9de",
  "networkId" : "e30db053-9abb-41f3-a3a0-2d289c63b886",
  "zitiId" : null,
  "name" : "Updated Test AuthPolicy",
  "primary" : {
    "cert" : {
      "allowed" : false,
      "allowExpiredCerts" : true
    },
    "extJwt" : {
      "allowed" : false,
      "allowedSigners" : [ "dd03a87e-8e03-43f9-b030-5e151834d94f", "e2cdb4ea-a09c-4666-bfce-76ad6b89437a" ]
    },
    "updb" : {
      "allowed" : true,
      "lockoutDurationMinutes" : 6,
      "maxAttempts" : 4,
      "minPasswordLength" : 9,
      "requireMixedCase" : false,
      "requireNumberChar" : false,
      "requireSpecialChar" : false
    }
  },
  "secondary" : {
    "requireExtJwtSigner" : "c6d58215-0812-400c-a9e5-89b0f575bb5f",
    "requireTotp" : true
  },
  "createdBy" : "6d5f2421-c2c3-4639-9511-f3175ccb048e",
  "createdAt" : "2025-01-11T20:38:28.705367Z",
  "updatedAt" : "2025-01-11T20:38:35.756921Z",
  "appliedAt" : "2025-01-11T20:38:35.756921Z",
  "deletedAt" : "2025-01-11T20:38:35.750810Z",
  "deletedBy" : "a0414b03-c139-438d-8f81-1089bca6e6b9",
  "deleted" : true
}

External JWT Signer

Find External Jwt Signers

GET /v2/external-jwt-signers

Authorization

This endpoint requires read action on the external-jwt-signer 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

id

String

true

networkId

String

true

zitiId

String

true

name

String

true

enabled

Boolean

true

True means the JWT Signer is enabled, meaning Ziti will accept valid JWTs signed by this signer; False otherwise.

externalAuthUrl

String

true

The URL clients should use to obtain a JWT.

issuer

String

true

When present, specifies the expected issuer of JWTs. If a JWT is presented, and it’s iss (aka, issuer claim) does not contain this value, then the JWT will be rejected.

audience

String

true

When present, specifies the expected audience of JWTs. If a JWT is presented, and it’s aud (aka, audience claim) does not contain this value, then the JWT will be rejected.

jwksEndpoint

String

true

When present, specifies a likely external URL where the expected JWT issuer hosts a JSON Web Key Sets endpoint, as defined in RFC 7515. Such endpoints are common and recommended, as they allow the JWT issuer to rotate keys without having to reconfigure client settings (like those contained in this entity.) <p/> When present, this overrides the {@link #certPem} and {@link #kid} properties, and those properties should be left null.

claimsProperty

String

true

Once a JWT is validated, it must be matched to an Identity in the network. By default, the JWT subject is used as the value to search for within the network’s Identities. However, this property can override the use of the JWT subject and specify an alternate JWT claim to use. The selected JWT value is matched against either Identity’s id or externalId as dictated by {@link #useExternalId}.

useExternalId

Boolean

true

Once a JWT is validated, a JWT must be matched to an Identity in the network. This property controls whether the JWT is matched against Identity’s id or externalId property. The indicated Identity property is matched against a JWT property, either its subject or the value of the property (aka claim) indicated by #claimsProperty.

certPem

String

true

kid

String

true

clientId

String

true

scopes

Array[String]

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

appliedAt

String

true

deletedAt

String

true

deletedBy

String

true

deleted

Boolean

true

True if this resource is in either a deleting or deleted state, false otherwise. <p/> This property provides a more convenient search term than using {@link #deletedAt} directly, and this property is computed based on the {@link #deletedAt} property being null. <p/> To differentiate between a deleting and deleted resource, check the {@link #zitiId} property (null implies deleted.).

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/external-jwt-signers' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJnYWprdnlKSGphQi1tc2FSSkdzUmlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg5NTIyMmUwLWE5OTItNDE3Yy1hNjEzLTI4MzE0MmRiMTU0ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgwMSwiZXhwIjoxNzM2NjMxNDAxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQwYzk3NzdmLWNmNmUtNDMwNy04MzhhLTc0YTI2ZDA0NzJmNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgwMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.EEtzf5eBsVpfhwKS0NR_8Dwor0kqv3v1rbHFVYgfnNweBdbLePg5lUL44TaT4u2MV5usXKfpcQuDpn5_fOVGUw9mVwPHdltnIbs9RQWn-2H6_vnKNgzYaQBP1Gy5_RIhpjFsoNFSS0sbjlmjmIZQ_RDIltEqxJahARghvrdeowMClcQ9RG4TwTzmQWvBNiZP7qDI4vDu6gKlyyOsDfX7S3W-2uMxzN7cJTgHk_Xgjm3fsXXEcPfcYSnadjJrOWBTDNg1pmOx1O5nEhz0G7x4Z_F_DyJvWFMkPrYg17mhdftXidbsEV6R3v8GLkz8A7D-A3iS6KujBrXccc5qpo6sLQ'

Example response

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

{
  "_embedded" : {
    "externalJwtSignerList" : [ {
      "id" : "95fd752d-fd12-416d-ab96-ff20ea25cceb",
      "networkId" : "8e316e32-1de0-47c0-bd96-1d410cb0f86d",
      "zitiId" : "ziti-id-271",
      "name" : "Find Test External JWT Signer 2",
      "enabled" : false,
      "externalAuthUrl" : "http://ext-auth.url.com",
      "issuer" : "iss-two",
      "audience" : "aud-two",
      "jwksEndpoint" : "http://jwks.two.com",
      "claimsProperty" : "my-custom-claim",
      "useExternalId" : false,
      "certPem" : "certificatePEM",
      "kid" : "kId",
      "clientId" : "clientId2",
      "scopes" : null,
      "createdBy" : "f652ba5c-1e10-4dca-8e07-e04ec8b7e96c",
      "createdAt" : "2025-01-11T20:36:41.707458Z",
      "updatedAt" : "2025-01-11T20:36:41.708197Z",
      "appliedAt" : "2025-01-11T20:36:41.708197Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "deleted" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers/95fd752d-fd12-416d-ab96-ff20ea25cceb",
          "title" : "Find Test External JWT Signer 2"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8e316e32-1de0-47c0-bd96-1d410cb0f86d",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "f82066f4-1908-44e5-affa-9c5021b3da05",
      "networkId" : "8e316e32-1de0-47c0-bd96-1d410cb0f86d",
      "zitiId" : "ziti-id-270",
      "name" : "Find Test External JWT Signer 1",
      "enabled" : true,
      "externalAuthUrl" : null,
      "issuer" : "iss-one",
      "audience" : "aud-one",
      "jwksEndpoint" : "http://jwks.one.com",
      "claimsProperty" : null,
      "useExternalId" : true,
      "certPem" : "certificatePEM",
      "kid" : "kId",
      "clientId" : "clientId1",
      "scopes" : null,
      "createdBy" : "f652ba5c-1e10-4dca-8e07-e04ec8b7e96c",
      "createdAt" : "2025-01-11T20:36:41.705762Z",
      "updatedAt" : "2025-01-11T20:36:41.706488Z",
      "appliedAt" : "2025-01-11T20:36:41.706488Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "deleted" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers/f82066f4-1908-44e5-affa-9c5021b3da05",
          "title" : "Find Test External JWT Signer 1"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/8e316e32-1de0-47c0-bd96-1d410cb0f86d",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/external-jwt-signers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get External Jwt Signer

GET /v2/external-jwt-signers/{id}

Authorization

This endpoint requires read action on the external-jwt-signer resource type.

Path parameters

Parameter Type Optional Description

id

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

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/external-jwt-signers/069d03ab-169d-4d42-b28e-d54a0c41ab43?meta=ziti,diffZiti' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJXZVI2cUhGaXFfaGFXbDlwTXBiYTNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg4NDViMDUxLTAxZjctNDk1MC04OThlLTcyNGVmNTY2NmE0NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc3MiwiZXhwIjoxNzM2NjMxMzcyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjI4ODZkODFlLTJkMGUtNDNhMS04MjI4LTZiNDVhODdjMTk4MFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc3Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jEs4BK8U9OPgsCOmQvXyge1ekklB9gZ20Anq94p9XrjFFpcJpIAhrUIf3sgij7F4VriZe2nyfZ5OpbLlGD93hAmPeFRftWC-hydNL0a5V4D8voGL_xRDisd_3UqzA7hVdT2ZXIgvykXOTqpw0Z0kkY99C85d7DGKu1lWY4zL0uWRde-5lNjAKQSunhktMq2SzKWaELC59pEaUEIlOCN6HChx7KdY1dODMqZRD_AWSigVUyrPfsjvsXzJiPaMXtXx3fzSkzH6zrYHZ_r_xSQ0tGTa1a_5brFffkgcQ2s6ywWCtH5a2wI0V3o38yD6WhqtqV_s_uqqlbFXBIzWz5q5dA'

Example response

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

{
  "id" : "069d03ab-169d-4d42-b28e-d54a0c41ab43",
  "networkId" : "93074f8d-6e8e-4958-ac4c-717c66422766",
  "zitiId" : "ziti.id.c97lznob",
  "name" : "Test ExternalJwtSigner",
  "enabled" : true,
  "externalAuthUrl" : "https://externalAuthUrl.com",
  "issuer" : "issuer",
  "audience" : "audience",
  "jwksEndpoint" : "https://jwksEndpoint.com",
  "claimsProperty" : "mySpecialClaim",
  "useExternalId" : false,
  "certPem" : null,
  "kid" : null,
  "clientId" : "myClientId",
  "scopes" : [ "email" ],
  "createdBy" : "3e4aca66-b70c-4a0d-99f9-02f306bd8e6d",
  "createdAt" : "2025-01-11T20:36:05.600993Z",
  "updatedAt" : "2025-01-11T20:36:05.651460Z",
  "appliedAt" : "2025-01-11T20:36:05.651460Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "_meta" : {
    "diffZiti" : {
      "differencesDetected" : false,
      "description" : "No differences detected",
      "comparedAt" : "2025-01-11T20:36:12.424290129Z"
    },
    "ziti" : {
      "id" : "ziti.id.c97lznob",
      "name" : "Test ExternalJwtSigner",
      "enabled" : true,
      "externalAuthUrl" : "https://externalAuthUrl.com",
      "issuer" : "issuer",
      "audience" : "audience",
      "jwksEndpoint" : "https://jwksEndpoint.com",
      "claimsProperty" : "mySpecialClaim",
      "useExternalId" : false,
      "certPem" : null,
      "notAfter" : null,
      "notBefore" : null,
      "kid" : null,
      "clientId" : "myClientId",
      "scopes" : [ "email" ],
      "tags" : {
        "network-id" : "93074f8d-6e8e-4958-ac4c-717c66422766",
        "resource-id" : "069d03ab-169d-4d42-b28e-d54a0c41ab43"
      },
      "createdAt" : "2025-01-11T20:36:05.648967784Z",
      "updatedAt" : "2025-01-11T20:36:05.648978765Z"
    }
  }
}

Create External Jwt Signer

POST /v2/external-jwt-signers

Authorization

This endpoint requires create action on the external-jwt-signer resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

name

String

true

A unique name for this Signer. This must be unique within the network. <p/> Required.

enabled

Boolean

true

Controls whether the resulting ExternalJwtSigner is enabled after creation. <p/> Required property.

externalAuthUrl

String

true

If an unauthenticated request is received, the client will be directed to this url. <p/> There are no constraints or checks on the value to ensure it is a URL, it resolves, etc. Set at your own risk. <p/> Optional.

issuer

String

true

Specifies the expected issuer of JWTs. If a JWT is presented, and it’s iss (aka, issuer claim) does not contain this value, then the JWT will be rejected. <p/> A string value, with the additional requirement that while arbitrary string values MAY be used, any value containing a ":" character MUST be a URI. Values are compared as case-sensitive strings with no transformations or canonicalization applied. <p/> Required.

audience

String

true

Specifies the expected audience of JWTs. If a JWT is presented, and it’s aud (aka, audience claim) does not contain this value, then the JWT will be rejected. <p/> A string value, with the additional requirement that while arbitrary string values MAY be used, any value containing a ":" character MUST be a URI. Values are compared as case-sensitive strings with no transformations or canonicalization applied. <p/> Required.

jwksEndpoint

String

true

Specifies a URL where the JWT issuer hosts a JSON Web Key Sets endpoint, as defined in RFC 7515. Such endpoints are common and recommended, as they allow the JWT issuer to rotate keys without having to reconfigure client settings (like those contained in this entity.) <p/> The value must be a URL, be publicly accessible, and resolve to a valid JWKS response. <p/> Required by MOP. Ziti declares this property as optional when using a cert to validate JWTs. However, MOP does not support cert JWT validation, and thus this property is required by MOP.

claimsProperty

String

true

Once a JWT is validated, it must be matched to an Identity in the network. By default, the JWT subject is used as the value to search for within the network’s Identities. However, this property can override the use of the JWT subject and specify an alternate JWT claim to use. The selected JWT value is matched against either Identity’s id or externalId as dictated by {@link #useExternalId}. <p/> Optional. If omitted, the JWT sub (subject) claim is used.

useExternalId

Boolean

true

Once a JWT is validated, it must be matched to an Identity in the network. This property controls whether the JWT is matched against Identity’s id or externalId property. The indicated Identity property is matched against a JWT property, either its subject or the value of the property (aka claim) indicated by #claimsProperty. <p/> Optional. If not specified in the create command, this will default to false; and JWT matching will be against the Identity’s id property.

certPem

String

true

kid

String

true

clientId

String

true

scopes

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/external-jwt-signers' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzSlVJVTdzLUJVOTFLMEh6NUZaRnhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNlNGFjYTY2LWI3MGMtNGEwZC05OWY5LTAyZjMwNmJkOGU2ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc2NSwiZXhwIjoxNzM2NjMxMzY1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjUzMTJhY2FkLTdjMjgtNGU4NS04MTQ2LTA3ZTFjNWQyNjVkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.QWa-vfAu65H3UZ7CppHcgEMEFt1qnIEhRNvirYhpHJEeARBiQzDSW_aI1mQrkMgAzXdIXjqAl90d7FPJVUCqTYpi9cw2vQFFX_3DVAbJMyfSo6khZn8tQPvzJjrgm6MqXDOE5srPTjNyhKpjdC7TC4cEaEOBFNmxYEatITRw6ay1WLVLtipH-LbuAEHG_QkGxO3vA2EPmS6LWPN3KfcOeM21x6HOEi7t3lPIzEg2rPOLcFLcHiueWXHM2CFacSx6l8KT9t5dioDCUhDodVXfzlZsl62btaoWDyU4GqWiqLjjs3wusqMZA9qrS8uoxb39_sr8WXwNiTag-HoWkgsfkw' \
    -d '{"networkId":"93074f8d-6e8e-4958-ac4c-717c66422766","name":"Test ExternalJwtSigner","enabled":true,"externalAuthUrl":"https://externalAuthUrl.com","issuer":"issuer","audience":"audience","jwksEndpoint":"https://jwksEndpoint.com","claimsProperty":"mySpecialClaim","useExternalId":false,"certPem":null,"kid":null,"clientId":"myClientId","scopes":["email"]}'

Example response

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

{
  "id" : "069d03ab-169d-4d42-b28e-d54a0c41ab43",
  "networkId" : "93074f8d-6e8e-4958-ac4c-717c66422766",
  "zitiId" : "ziti.id.c97lznob",
  "name" : "Test ExternalJwtSigner",
  "enabled" : true,
  "externalAuthUrl" : "https://externalAuthUrl.com",
  "issuer" : "issuer",
  "audience" : "audience",
  "jwksEndpoint" : "https://jwksEndpoint.com",
  "claimsProperty" : "mySpecialClaim",
  "useExternalId" : false,
  "certPem" : null,
  "kid" : null,
  "clientId" : "myClientId",
  "scopes" : [ "email" ],
  "createdBy" : "3e4aca66-b70c-4a0d-99f9-02f306bd8e6d",
  "createdAt" : "2025-01-11T20:36:05.600993Z",
  "updatedAt" : "2025-01-11T20:36:05.651460Z",
  "appliedAt" : "2025-01-11T20:36:05.651460Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Update External Jwt Signer

PATCH /v2/external-jwt-signers/{id}

Authorization

This endpoint requires update action on the external-jwt-signer resource type.

Path parameters

Parameter Type Optional Description

id

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

clientId

String

true

scopes

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/external-jwt-signers/069d03ab-169d-4d42-b28e-d54a0c41ab43' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1T3lwNDN1TFhoeURWQ0o2eEdDY09RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA1NjNjN2Q3LTVhOTYtNGZmNy04MmYzLTllMWY1NTM5MWYxMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc3MywiZXhwIjoxNzM2NjMxMzczLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImUxMTY2NWVhLWM4NzEtNDU5Ni04NDVjLWRkZGI4ODA5MmE2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc3M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.RbvHMWGlXH9k9kXtPhdNZlDYeLzUwpY3t_3IOjLPloadd6_KvDunufV56QUU0_F45dWE3YW1Oy0eoas9DS1o4C3DnMqRkC46WS4uHDVqAOFl2XihssyAU3_HvhhhjqO6e9vXTKyP4BMvi3p37wI5npEt160VNQHH28d1IX0LKLJ5UMR4Vo6FGy2LOroJVfgiQCRVKhry0cv9FP6BBuFceSwQRsNqoVD3vqe_Tz7jq6ByxsVnYngzS9UpA4C5xfsAsOLRBrlGiWLIdUzzLQhQHwJcKGAG60FDIS80bboBRG36X2GSdUG2uAqPkkiNbaN1t3gT7tr1fFakOkxZAQPzTg' \
    -d '{"name":"Updated Test ExternalJwtSigner","enabled":false,"issuer":"issuer","audience":"audience","jwksEndpoint":"https://updated.jwksEndpoint.com","useExternalId":true,"certPem":null,"kid":null,"clientId":"updatedClientId","scopes":["profile"]}'

Example response

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

{
  "id" : "069d03ab-169d-4d42-b28e-d54a0c41ab43",
  "networkId" : "93074f8d-6e8e-4958-ac4c-717c66422766",
  "zitiId" : "ziti.id.c97lznob",
  "name" : "Updated Test ExternalJwtSigner",
  "enabled" : false,
  "externalAuthUrl" : "https://externalAuthUrl.com",
  "issuer" : "issuer",
  "audience" : "audience",
  "jwksEndpoint" : "https://updated.jwksEndpoint.com",
  "claimsProperty" : "mySpecialClaim",
  "useExternalId" : true,
  "certPem" : null,
  "kid" : null,
  "clientId" : "updatedClientId",
  "scopes" : [ "profile" ],
  "createdBy" : "3e4aca66-b70c-4a0d-99f9-02f306bd8e6d",
  "createdAt" : "2025-01-11T20:36:05.600993Z",
  "updatedAt" : "2025-01-11T20:36:13.619359Z",
  "appliedAt" : "2025-01-11T20:36:13.619359Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false
}

Delete External Jwt Signer

DELETE /v2/external-jwt-signers/{id}

Authorization

This endpoint requires delete action on the external-jwt-signer resource type.

Path parameters

Parameter Type Optional Description

id

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

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/external-jwt-signers/069d03ab-169d-4d42-b28e-d54a0c41ab43' -i -X DELETE \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ1bW81d2hCUVY3ZjA5NC1UQjlqN1hnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBhY2VjNzBiLWEzMmItNDkwYS1iZmNiLWJjOWRjODJlZDNkZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc3NCwiZXhwIjoxNzM2NjMxMzc0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdhMjExMjMwLTBlYmYtNGI5OC05MzM2LTU3ZDdmYTBlMTdhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc3NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.OtyItJHBGJeqR8DKS3BZGt8om_NxaI9OiFpksIm4ffjmLiIHT5vHCYX4nnq2wsmqZ2qNjbU552GMdw7iHsit_yooCkUwCnnEn58V9nGSwmBwwurRIW2g1Uc9aMWBkWCXjqsS__AffmO0P5Zvba7PgxiZHMXEFTjV3MGjbirxjpGOB5tVozJkbudGSuh47Cohwmnemw7g84SNrQ4w6mM_Zmxx14QM59SD3SBvkPW5GjpMxdaIQEwaSL-J6O2Iw8EXMAYISNcRp08lTOXr0QVW7NX4_Sn18urnzTCrr99txH0HkWe1i_7_8L3G7CjZ0V5mZzMoZulXeb8jLaGf4L1WKw'

Example response

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

{
  "id" : "069d03ab-169d-4d42-b28e-d54a0c41ab43",
  "networkId" : "93074f8d-6e8e-4958-ac4c-717c66422766",
  "zitiId" : null,
  "name" : "Updated Test ExternalJwtSigner",
  "enabled" : false,
  "externalAuthUrl" : "https://externalAuthUrl.com",
  "issuer" : "issuer",
  "audience" : "audience",
  "jwksEndpoint" : "https://updated.jwksEndpoint.com",
  "claimsProperty" : "mySpecialClaim",
  "useExternalId" : true,
  "certPem" : null,
  "kid" : null,
  "clientId" : "updatedClientId",
  "scopes" : [ "profile" ],
  "createdBy" : "3e4aca66-b70c-4a0d-99f9-02f306bd8e6d",
  "createdAt" : "2025-01-11T20:36:05.600993Z",
  "updatedAt" : "2025-01-11T20:36:14.533430Z",
  "appliedAt" : "2025-01-11T20:36:14.533430Z",
  "deletedAt" : "2025-01-11T20:36:14.522499Z",
  "deletedBy" : "0acec70b-a32b-490a-bfcb-bc9dc82ed3dd",
  "deleted" : true
}

Cloud Providers

List Providers

GET /v2/cloud-providers

Authorization

Authorization not required for this request.

Path parameters

No parameters.

Query parameters

No 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

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

{
  "_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" : "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"
    }
  }
}

Get Provider

GET /v2/cloud-providers/{cloudProvider}

Authorization

Authorization not required for this request.

Path parameters

Parameter Type Optional Description

cloudProvider

String

false

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

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/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"
    }
  }
}

Regions

Find Regions

GET /v2/regions

Aggregates all regions in the selected providers, if no provider is specified it defaults to all providers.

Authorization

Authorization not required for this request.

Path parameters

No parameters.

Query parameters

Parameter Type Optional Description

provider

Object

true

latitude

Decimal

true

longitude

Decimal

true

providers

Object

true

Deprecated.

List of providers, for example: AWS, GCP, OCI, etc.

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

Represents the unique id of this region, for example: us-east-1 (AWS) or us-east-1 (GCP).

name

String

true

Presentation name for the region.

provider

String

true

The provider of the region, for example AWS, GCP, OCI, etc.

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

address

String

true

Street address of the datacenter.

city

String

true

City of the datacenter.

stateCode

String

true

State code of the datacenter, follows standard state abbreviations.

stateName

String

true

Name of the state the datacenter is located in.

countryName

String

true

Country name where the datacenter is located.

countryCode

String

true

Country code where the datacenter is located, follows standard abbreviations.

latitude

Decimal

true

Longitude where datacenter is located.

longitude

Decimal

true

Latitude where datacenter is located.

distance

Decimal

true

Optional: distance from a point, only present when sorted by haversine distance.

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

{
  "_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" : "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" : "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"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/regions"
    },
    "providers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/cloud-providers"
    }
  }
}

Find Regions

GET /v2/regions

Aggregates all regions in the selected providers, if no provider is specified it defaults to all providers.

Authorization

Authorization not required for this request.

Path parameters

No parameters.

Query parameters

Parameter Type Optional Description

provider

Object

true

latitude

Decimal

true

longitude

Decimal

true

providers

Object

true

Deprecated.

List of providers, for example: AWS, GCP, OCI, etc.

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

Represents the unique id of this region, for example: us-east-1 (AWS) or us-east-1 (GCP).

name

String

true

Presentation name for the region.

provider

String

true

The provider of the region, for example AWS, GCP, OCI, etc.

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

address

String

true

Street address of the datacenter.

city

String

true

City of the datacenter.

stateCode

String

true

State code of the datacenter, follows standard state abbreviations.

stateName

String

true

Name of the state the datacenter is located in.

countryName

String

true

Country name where the datacenter is located.

countryCode

String

true

Country code where the datacenter is located, follows standard abbreviations.

latitude

Decimal

true

Longitude where datacenter is located.

longitude

Decimal

true

Latitude where datacenter is located.

distance

Decimal

true

Optional: distance from a point, only present when sorted by haversine distance.

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

Get Region

GET /v2/regions/{provider}/{locationCode}

Retrieve single region from a specific provider by its unique location code.

Authorization

Authorization not required for this request.

Path parameters

Parameter Type Optional Description

provider

String

false

For example: AWS, GCP, OCI, etc.

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

locationCode

String

false

Unique location of the region, for example: us-east-1 (AWS), us-east1 (GCP).

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

locationCode

String

true

Represents the unique id of this region, for example: us-east-1 (AWS) or us-east-1 (GCP).

name

String

true

Presentation name for the region.

provider

String

true

The provider of the region, for example AWS, GCP, OCI, etc.

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

address

String

true

Street address of the datacenter.

city

String

true

City of the datacenter.

stateCode

String

true

State code of the datacenter, follows standard state abbreviations.

stateName

String

true

Name of the state the datacenter is located in.

countryName

String

true

Country name where the datacenter is located.

countryCode

String

true

Country code where the datacenter is located, follows standard abbreviations.

latitude

Decimal

true

Longitude where datacenter is located.

longitude

Decimal

true

Latitude where datacenter is located.

distance

Decimal

true

Optional: distance from a point, only present when sorted by haversine distance.

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

Hosts

Find Hosts

GET /v2/hosts

Authorization

This endpoint requires read action on the host resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter 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

id

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

Represents the 'region' the host is deployed in. For example: us-east-1 (AWS) or us-east1 (GCP). For provider CUSTOMER it will be null.

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.eyJqdGkiOiJyN084U21NUHhZajdJQXUxX3R3bFFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMwMDRhZTQzLWNlYzMtNDI1NC1iNDljLTQwYmQwZjgyOWM1YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc4MywiZXhwIjoxNzM2NjMxMzgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFlNTA0Y2FiLWY2OGMtNDNlZS05ZWJmLWFlODU2YzQ1ZmFjY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.bwu7OS6giUmu7xtZJ3o8cmJjBx4rqpl85tA_LMlLoLULUZ9qHZIaWrC8n3gE9wcvd9HcClH6cwZ6Q8tD1huT6iuhWFoJ73KWpDHDfryiBJ5TO39h3iOYef0y2056v8la08RClbE1_Bh3imPofEag5MUhKS6nwSsvrZ2f4_WdsIsK_H6Nt40Qzpg4NVtgS_LL_Mwa_O_NjWeHnufL2FWldFXQmVKeWJ9ufUhtukHDDdFxkSsdpCfqHYFv0c5TnXLD_k-5Voq7ON9atPnJLW7rmXA7pKPmel84morinv3L1a4VARjPO9cCfLGayeTdPwTD04C2NUc4pWDM0KxmppSw9g'

Example response

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

{
  "_embedded" : {
    "hostList" : [ {
      "id" : "251675b9-7804-4c4e-a63c-a9bb3e56c9b5",
      "networkId" : "707b48a4-2db3-4c34-921b-6db131d13b05",
      "ownerIdentityId" : "48e9603a-3bce-4f77-9f55-2a3a8a164470",
      "provider" : "AWS",
      "region" : "us-east-1",
      "ipAddress" : "0.0.0.15",
      "sshPort" : 22,
      "sshPrivateKeyStoredSecretId" : null,
      "providerInstanceId" : "bae8292e-3bc0-4187-a644-114a5a8f998d",
      "size" : "small",
      "userData" : null,
      "createdBy" : null,
      "createdAt" : "2025-01-11T20:36:23.288205Z",
      "updatedAt" : "2025-01-11T20:36:23.288205Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/251675b9-7804-4c4e-a63c-a9bb3e56c9b5"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/707b48a4-2db3-4c34-921b-6db131d13b05",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "33698923-1abc-4c11-b140-37821d49670c",
      "networkId" : "707b48a4-2db3-4c34-921b-6db131d13b05",
      "ownerIdentityId" : "48e9603a-3bce-4f77-9f55-2a3a8a164470",
      "provider" : "OCI",
      "region" : "us-east-1",
      "ipAddress" : "0.0.0.16",
      "sshPort" : 22,
      "sshPrivateKeyStoredSecretId" : null,
      "providerInstanceId" : "f6c87832-57b0-4b1f-bf81-d0928040ac9a",
      "size" : "medium",
      "userData" : null,
      "createdBy" : null,
      "createdAt" : "2025-01-11T20:36:23.292258Z",
      "updatedAt" : "2025-01-11T20:36:23.292258Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/33698923-1abc-4c11-b140-37821d49670c"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/707b48a4-2db3-4c34-921b-6db131d13b05",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Host

GET /v2/hosts/{id}

Authorization

This endpoint requires read action on the host resource type.

Path parameters

Parameter Type Optional Description

id

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/hosts/99b84a26-5dde-4964-8feb-24b023fb0445' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJBcnh1a21rQ2JTY2lEZmF3a3haVl9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ3MmUwNzM2LTEzMTctNDQ0NC1iYzc0LWM1MjViYWRkNWQ0YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc2MywiZXhwIjoxNzM2NjMxMzYzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjExMmZlODUyLWI4ZjEtNGZlZi04ZmNjLTYzMzM0ODhiYjI5N1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.DQmga664dAqhzBDRWJ4h8nR6oWobwAcePGt0SwumEeyQuxPhuz97DgGA_vX17k4XqWVspMPEy5uvymULyHI7_D41G9LOhpkNt5R8xvtZiQ-KjNkSj8_5Xe_zJXFfb-1nUv3jH3bsiGca2GPgIKyOU97AfNC_1n-dA6HjkPyyPGUJhRNFOkZiPZgccqHZtbypCkRtc54N9EfYbfPG1ztPuIeJcuoKGRUo89ynCzqe5q3GQlDGB78uLLq5Hl0Nzv1zpGWlOQdy8evEjCxEWC0Y2rI-e-snAT0FFyHbQwYKsLhRyED57b9fzkAUFquAmxua6di_MgXiRr4oP3we0kGYrA'

Example response

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

{
  "id" : "99b84a26-5dde-4964-8feb-24b023fb0445",
  "networkId" : "a2776d5d-84ac-4acc-8f29-e59c5d547cd9",
  "ownerIdentityId" : "fbc5f430-b2d7-4b84-9534-8989105a3197",
  "provider" : "AWS",
  "region" : "us-east-1",
  "ipAddress" : "0.0.0.4",
  "sshPort" : 22,
  "sshPrivateKeyStoredSecretId" : null,
  "providerInstanceId" : "2d1bbb4e-e6d6-49ce-bced-6a353dbc8c3a",
  "size" : "small",
  "userData" : null,
  "createdBy" : null,
  "createdAt" : "2025-01-11T20:36:03.771686Z",
  "updatedAt" : "2025-01-11T20:36:03.771686Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/hosts/99b84a26-5dde-4964-8feb-24b023fb0445"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a2776d5d-84ac-4acc-8f29-e59c5d547cd9",
      "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"
    }
  }
}

Host Sizes

Find Host Sizes V 3

GET /v3/host-sizes

An aggregated list of all host sizes in the selected providers for the type. If no providers are specified it defaults to all providers. If no type is specified it defaults to all types.

Authorization

Authorization not required for this request.

Path parameters

No parameters.

Query parameters

Parameter Type Optional Description

provider

Object

true

providers

Object

true

Deprecated.

List of providers, for example: AWS, GCP, OCI, etc.

type

String

true

NC or ER.

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

The abstract NF name for the size, for example: small, medium, large.

hostType

String

true

The type of host this size is intended to support.

Must be one of [NC, ER].

providers

Array[String]

true

All providers that offer this NF size.

description

Array[String]

true

User readable descriptions to indicate the number endpoints it should be able to support.

default

Boolean

true

If true the size is the default for this type. Only 1 size can be default for each type.

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

{
  "_embedded" : {
    "hostSizeList" : [ {
      "name" : "small",
      "hostType" : "ER",
      "providers" : [ "AZURE", "OCI", "AWS", "GCP" ],
      "description" : [ ],
      "default" : true
    }, {
      "name" : "medium",
      "hostType" : "ER",
      "providers" : [ "AZURE", "OCI", "AWS", "GCP" ],
      "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"
    }
  }
}

Find Host Sizes V 3

GET /v3/host-sizes

An aggregated list of all host sizes in the selected providers for the type. If no providers are specified it defaults to all providers. If no type is specified it defaults to all types.

Authorization

Authorization not required for this request.

Path parameters

No parameters.

Query parameters

Parameter Type Optional Description

provider

Object

true

providers

Object

true

Deprecated.

List of providers, for example: AWS, GCP, OCI, etc.

type

String

true

NC or ER.

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

The abstract NF name for the size, for example: small, medium, large.

hostType

String

true

The type of host this size is intended to support.

Must be one of [NC, ER].

providers

Array[String]

true

All providers that offer this NF size.

description

Array[String]

true

User readable descriptions to indicate the number endpoints it should be able to support.

default

Boolean

true

If true the size is the default for this type. Only 1 size can be default for each type.

Example request

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

Example response

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

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

Find Host Sizes V 3

GET /v3/host-sizes

An aggregated list of all host sizes in the selected providers for the type. If no providers are specified it defaults to all providers. If no type is specified it defaults to all types.

Authorization

Authorization not required for this request.

Path parameters

No parameters.

Query parameters

Parameter Type Optional Description

provider

Object

true

providers

Object

true

Deprecated.

List of providers, for example: AWS, GCP, OCI, etc.

type

String

true

NC or ER.

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

The abstract NF name for the size, for example: small, medium, large.

hostType

String

true

The type of host this size is intended to support.

Must be one of [NC, ER].

providers

Array[String]

true

All providers that offer this NF size.

description

Array[String]

true

User readable descriptions to indicate the number endpoints it should be able to support.

default

Boolean

true

If true the size is the default for this type. Only 1 size can be default for each type.

Example request

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

Example response

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

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

Find Host Sizes V 3

GET /v3/host-sizes

An aggregated list of all host sizes in the selected providers for the type. If no providers are specified it defaults to all providers. If no type is specified it defaults to all types.

Authorization

Authorization not required for this request.

Path parameters

No parameters.

Query parameters

Parameter Type Optional Description

provider

Object

true

providers

Object

true

Deprecated.

List of providers, for example: AWS, GCP, OCI, etc.

type

String

true

NC or ER.

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

The abstract NF name for the size, for example: small, medium, large.

hostType

String

true

The type of host this size is intended to support.

Must be one of [NC, ER].

providers

Array[String]

true

All providers that offer this NF size.

description

Array[String]

true

User readable descriptions to indicate the number endpoints it should be able to support.

default

Boolean

true

If true the size is the default for this type. Only 1 size can be default for each type.

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

Executions

Find Executions

GET /v2/executions

Returns all {@link Execution} instances which match the search criteria as specified via query parameters, where query parameter names match the properties of the {@link FindExecution} command.

Instances that the API client does not have authorization to read will be removed from the results. As a side effect of this behavior, this API endpoint will never result in a 403 unauthorized result. In such cases, the results will simply be empty. This applies whether or not any find query parameters exist or not; ie, this API endpoint will never return a 404.

Authorization

This endpoint requires read action on the execution 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

id

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=e0e22461-6fd0-4aec-bb17-213ecc5d3fc4' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ5VnBXUWE2cmhKRlE1M3oyOUptXzJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjllYjRiYzUzLThhYTktNDY2MC1iNmU4LTI0ZWIzYjZiZThhOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc4MSwiZXhwIjoxNzM2NjMxMzgxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQyYzRlOGUwLTNlMTUtNGNiZS04NmY2LWZhOGM2N2JmZWIxNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc4MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.C6rSN3gRDeqby4WoS8LL_ahYXLUm7YMurbuLK5m7U6mN6MN8dgYz_4WsMBDihxmRIDjE5ho9Lbrs3Cz2_w3EcmgUmeH-4ZZTqpy2aPtkhNDEhhonzEXZp7tVe0wiUDejxCAK5Kwfx3PKZl5qQ_VctDxn7C2ms3M6z7IpemxDBz1Uy9K09mh4gDiSAkEqT69iDbInI68kMP5VpZpr1RLp8kIH2OzRLjfhDwfM87vXMcmMefPbZWFqMB3wePxGM3zyCpV0mOq0ZiR5AhtPMh5QNa7hGK9i_n-7PPMj-sbhUcL-m27Jeu2rA6nLCyEEXPvPhVr8aEK_6hJ9c8-5EpIlTg'

Example response

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

{
  "_embedded" : {
    "executionList" : [ {
      "id" : "15ed2db5-a1df-41d8-b270-6d3110870f3c",
      "networkId" : "e0e22461-6fd0-4aec-bb17-213ecc5d3fc4",
      "processId" : "a3e2461c-f105-47a4-b95d-f467ec0f3608",
      "name" : "CreateEndpointProcess",
      "description" : "Fake Process",
      "resourceType" : "component",
      "resourceId" : "725e8dbb-e1d9-497f-9e5d-bf20758e3df3",
      "startedAt" : "2025-01-11T20:36:21.270587Z",
      "finishedAt" : "2025-01-11T20:36:21.270587Z",
      "traceId" : "trace1",
      "status" : "SUCCESS",
      "initiatingIdentityId" : "6f345884-0fb8-465c-ad33-05cebfa331ff",
      "createdAt" : "2025-01-11T20:36:21.271058Z",
      "updatedAt" : "2025-01-11T20:36:21.271058Z",
      "actions" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions/15ed2db5-a1df-41d8-b270-6d3110870f3c",
          "title" : "CreateEndpointProcess"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e0e22461-6fd0-4aec-bb17-213ecc5d3fc4",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "b1c187b9-4443-4e77-b600-a30927ecf5d9",
      "networkId" : "e0e22461-6fd0-4aec-bb17-213ecc5d3fc4",
      "processId" : "7582de32-3fc8-499b-86a8-497fd9474ed7",
      "name" : "CreateNetworkProcess",
      "description" : "Fake Process",
      "resourceType" : "network",
      "resourceId" : null,
      "startedAt" : "2025-01-11T20:36:21.275538Z",
      "finishedAt" : "2025-01-11T20:36:21.275538Z",
      "traceId" : "trace3",
      "status" : "FAILED",
      "initiatingIdentityId" : "e5580d9b-58c7-4fec-9d30-87bf4c4dce23",
      "createdAt" : "2025-01-11T20:36:21.275772Z",
      "updatedAt" : "2025-01-11T20:36:21.275772Z",
      "actions" : [ {
        "title" : "Replay",
        "method" : "PUT",
        "url" : "http://localhost:8080/core/v2/networks/e0e22461-6fd0-4aec-bb17-213ecc5d3fc4/replay"
      } ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions/b1c187b9-4443-4e77-b600-a30927ecf5d9",
          "title" : "CreateNetworkProcess"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e0e22461-6fd0-4aec-bb17-213ecc5d3fc4",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "dccb11b3-6048-46ee-9aba-0fc553748809",
      "networkId" : "e0e22461-6fd0-4aec-bb17-213ecc5d3fc4",
      "processId" : "99c50eea-76ba-4544-8e3b-7ac42b141dd7",
      "name" : "CreateEndpointProcess",
      "description" : "Fake Process",
      "resourceType" : "component",
      "resourceId" : "6eb85c8c-00ae-41ba-811c-7c39b84860ff",
      "startedAt" : "2025-01-11T20:36:21.274821Z",
      "finishedAt" : null,
      "traceId" : "trace2",
      "status" : "RUNNING",
      "initiatingIdentityId" : "704d82b8-4403-4e0d-a9a4-4a397cdf8ef7",
      "createdAt" : "2025-01-11T20:36:21.275223Z",
      "updatedAt" : "2025-01-11T20:36:21.275223Z",
      "actions" : [ {
        "title" : "Cancel",
        "method" : "PUT",
        "url" : "http://localhost:8080/core/v2/executions/dccb11b3-6048-46ee-9aba-0fc553748809/cancel"
      } ],
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/executions/dccb11b3-6048-46ee-9aba-0fc553748809",
          "title" : "CreateEndpointProcess"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e0e22461-6fd0-4aec-bb17-213ecc5d3fc4",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=e0e22461-6fd0-4aec-bb17-213ecc5d3fc4"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Execution

GET /v2/executions/{id}

Authorization

This endpoint requires read action on the execution resource type.

Path parameters

Parameter Type Optional Description

id

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/executions/bb760fad-8697-45ec-8941-196b0dc7564e' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJObFdNUmE3aWs0XzI1VzRNZHlxRHZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZlMWY0YWZlLTdkNzUtNDU1My04OTlmLTQxOWEwYzY5Yjg0ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc4MSwiZXhwIjoxNzM2NjMxMzgxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImNiNTQ4ZDk2LWQ3OTEtNGNkMi05YzEwLTlkZjg4ZDQ2MWJlYVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc4MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.met0of3BSQbKK9ezYJFFdz32iPpEbBq2FFdRd8Ch56xoMZiAmnqi7bXPSuuNjqOHGrrvMz92mPtg6yEtLRPuJmun6w1ZDFpiucG1-eBeNH7mXLE1cuu_o26nOd61s4A5NohgpOm31LNQMnOY9gP2owChdfT2QOPOd5nImhNqj7_7ZbMSzhbU6RZRbbWkS8zeJtmZQTHxz-3bqbyOawO10uJVu5Olj8DqUhbfpzA-XlSIKZ1GPJbXyr1fx1wRDCIma94rjqP7Smf1aCnYfV9qQ2kjl5kCrTDDimyodizWk1RXadIMBf7DWrKDyIDmQ3U66YXtdvtuPUI_1c_2zSrUHw'

Example response

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

{
  "id" : "bb760fad-8697-45ec-8941-196b0dc7564e",
  "networkId" : "1e538121-5dda-44b0-befb-7a6bdf6ebfbe",
  "processId" : "6780dd4d-a377-4730-b949-23e31f858567",
  "name" : "CreateNetworkProcess",
  "description" : "Fake Process",
  "resourceType" : "network",
  "resourceId" : null,
  "startedAt" : "2025-01-11T20:36:21.494029Z",
  "finishedAt" : "2025-01-11T20:36:21.494029Z",
  "traceId" : "trace3",
  "status" : "FAILED",
  "initiatingIdentityId" : "4f092449-de8a-4dd5-b393-dc0d6bd2126f",
  "createdAt" : "2025-01-11T20:36:21.494261Z",
  "updatedAt" : "2025-01-11T20:36:21.494261Z",
  "actions" : [ {
    "title" : "Replay",
    "method" : "PUT",
    "url" : "http://localhost:8080/core/v2/networks/1e538121-5dda-44b0-befb-7a6bdf6ebfbe/replay"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/bb760fad-8697-45ec-8941-196b0dc7564e",
      "title" : "CreateNetworkProcess"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/1e538121-5dda-44b0-befb-7a6bdf6ebfbe",
      "profile" : "parent"
    }
  }
}

Network Versions

Find Network Versions

GET /v2/network-versions

Returns all {@link NetworkVersion} instances which match the search criteria as specified via query parameters or an application/x-www-form-urlencoded encoded query, where query parameter names match the properties of the {@link FindNetworkVersion} command.

Authorization

This endpoint requires read action on the network-version 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

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

networkVersion

Object

true

zitiVersion

Object

true

minimumNetworkVersionForUpgrade

Object

true

minimumEdgeRouterVersionForUpgrade

Object

true

active

Boolean

true

Active means available for new installs. Only kept for existing networks to be able to manage their components.

default

Boolean

true

jsonNode

Object

true

Links to all binaries and other version related data. Could change without prior notice.

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. Use default instead, will be removed 1/1/2023.

The same as the "default" version.
See Network Versions.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-versions' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJYN2IzWEtIcXJHaXlUSkdHaEVNenFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImViNTFhZDQ5LWYzMzUtNGNiMS1hOTBmLTU4NDdiNDBlODRkOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzczOCwiZXhwIjoxNzM2NjMxMzM4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA4ZmI5MmMyLTM4NGYtNDdmYS04ODVjLTQ1MmM2ODZmMTRiN1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzczOH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jmo3RXYf5__I3J4UXYYcOx3DH5lEFeBgJpJowTqb7B6hTve-0df9_V6Wa1Lb3Z7gunMZ7zoVKxTy0KDN-UHZDnxyOle1svSRcw2BqpTbQB6c8ps8ZreSntilQZ3jbmdnpv0dO19ejEzegixqdIFbIDzECGzmqAcqI61HZJ6kLpLyQDHdttnym46QTAMujrAx-OnzjhaHckotI4cuWWzzfJJ9LdTVh0d1Qv7wi4Vy3KtEQ2bTGHn8Q_Bsdft8mOeBykqbcIXs9hjQGjieRJryspoKnMKu2g0quXx8guph1uLQrmoFUUw1pob52lbi3BbrCy60BkQ9gh_zgFh68j7sBw'

Example response

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

{
  "_embedded" : {
    "network-versions" : [ {
      "id" : "03dc7b14-a319-4de9-8952-2a046a1f38c2",
      "networkVersion" : "7.4.13",
      "zitiVersion" : "1.1.12",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.4.13",
          "value" : "7.4.13",
          "major" : 7,
          "minor" : 4,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "1.1.12",
          "value" : "1.1.12",
          "major" : 1,
          "minor" : 1,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        }
      },
      "createdAt" : "2025-01-11T20:35:34.863401Z",
      "updatedAt" : "2025-01-11T20:35:34.863401Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "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" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "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" : "edge-router",
        "introducedAt" : "0.0.0",
        "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" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "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" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "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" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "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" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/03dc7b14-a319-4de9-8952-2a046a1f38c2"
        }
      }
    }, {
      "id" : "09b9fb84-b095-423a-ac80-a53537a80fb8",
      "networkVersion" : "7.3.20",
      "zitiVersion" : "0.19.6",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.20",
          "value" : "7.3.20",
          "major" : 7,
          "minor" : 3,
          "patch" : 20,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.6",
          "value" : "0.19.6",
          "major" : 0,
          "minor" : 19,
          "patch" : 6,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.894727Z",
      "updatedAt" : "2025-01-11T20:35:34.894727Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "config",
        "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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" : "terminator",
        "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" : "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-edge-router-policy",
        "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" : "service-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/09b9fb84-b095-423a-ac80-a53537a80fb8"
        }
      }
    }, {
      "id" : "0af1aa13-0d69-4a99-9732-50a82bf496cd",
      "networkVersion" : "7.3.12",
      "zitiVersion" : "0.18.9",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.12",
          "value" : "7.3.12",
          "major" : 7,
          "minor" : 3,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.18.9",
          "value" : "0.18.9",
          "major" : 0,
          "minor" : 18,
          "patch" : 9,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.827303Z",
      "updatedAt" : "2025-01-11T20:35:34.827303Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "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" : "edge-router",
        "introducedAt" : "0.0.0",
        "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" : "session",
        "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" : "terminator",
        "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" : "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" : "identity-type",
        "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",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/0af1aa13-0d69-4a99-9732-50a82bf496cd"
        }
      }
    }, {
      "id" : "0b826529-308f-4917-a352-ba52fc4b5f21",
      "networkVersion" : "7.3.14",
      "zitiVersion" : "0.19.0",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.14",
          "value" : "7.3.14",
          "major" : 7,
          "minor" : 3,
          "patch" : 14,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.0",
          "value" : "0.19.0",
          "major" : 0,
          "minor" : 19,
          "patch" : 0,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.841514Z",
      "updatedAt" : "2025-01-11T20:35:34.841514Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "identity",
        "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" : "edge-router-policy",
        "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" : "service",
        "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" : "terminator",
        "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" : "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" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-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/0b826529-308f-4917-a352-ba52fc4b5f21"
        }
      }
    }, {
      "id" : "0d75aa08-715d-48ff-b256-797defad324c",
      "networkVersion" : "7.3.25",
      "zitiVersion" : "0.19.11",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.25",
          "value" : "7.3.25",
          "major" : 7,
          "minor" : 3,
          "patch" : 25,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.11",
          "value" : "0.19.11",
          "major" : 0,
          "minor" : 19,
          "patch" : 11,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.573175Z",
      "updatedAt" : "2025-01-11T20:35:34.573175Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "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" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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.mfa",
        "introducedAt" : "0.18.5",
        "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-type.host-v1",
        "introducedAt" : "0.19.11",
        "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" : "service-edge-router-policy",
        "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" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "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" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/0d75aa08-715d-48ff-b256-797defad324c"
        }
      }
    }, {
      "id" : "0fe4a496-ea80-4c73-99fc-563a86b6dbc7",
      "networkVersion" : "7.3.23",
      "zitiVersion" : "0.19.9",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.23",
          "value" : "7.3.23",
          "major" : 7,
          "minor" : 3,
          "patch" : 23,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.9",
          "value" : "0.19.9",
          "major" : 0,
          "minor" : 19,
          "patch" : 9,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.925230Z",
      "updatedAt" : "2025-01-11T20:35:34.925230Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "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" : "authenticator",
        "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" : "transit-router",
        "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" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "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" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "service",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/0fe4a496-ea80-4c73-99fc-563a86b6dbc7"
        }
      }
    }, {
      "id" : "1c2f538f-bddb-44e8-bb48-73af8c3042fc",
      "networkVersion" : "7.3.26",
      "zitiVersion" : "0.19.12",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.26",
          "value" : "7.3.26",
          "major" : 7,
          "minor" : 3,
          "patch" : 26,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.12",
          "value" : "0.19.12",
          "major" : 0,
          "minor" : 19,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.625876Z",
      "updatedAt" : "2025-01-11T20:35:34.625876Z",
      "platformFeatures" : [ {
        "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" : "service-edge-router-policy",
        "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" : "cas",
        "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" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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" : "config-type",
        "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" : "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" : "edge-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" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "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/1c2f538f-bddb-44e8-bb48-73af8c3042fc"
        }
      }
    }, {
      "id" : "1fd55fec-183f-4e2d-a428-a81d91d82dab",
      "networkVersion" : "7.3.69",
      "zitiVersion" : "0.25.13",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.69",
          "value" : "7.3.69",
          "major" : 7,
          "minor" : 3,
          "patch" : 69,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.25.13",
          "value" : "0.25.13",
          "major" : 0,
          "minor" : 25,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.808181Z",
      "updatedAt" : "2025-01-11T20:35:34.808181Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "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" : "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" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "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
      }, {
        "displayName" : "identity-type",
        "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" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "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" : "auth-policy",
        "introducedAt" : "0.25.4",
        "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" : "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" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "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-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" : "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" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/1fd55fec-183f-4e2d-a428-a81d91d82dab"
        }
      }
    }, {
      "id" : "259c43cd-8e8d-41d1-9d19-e33b5e21cc0c",
      "networkVersion" : "8.0.90",
      "zitiVersion" : "0.30.1",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : true,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : true,
        "version" : {
          "originalValue" : "8.0.90",
          "value" : "8.0.90",
          "major" : 8,
          "minor" : 0,
          "patch" : 90,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.30.1",
          "value" : "0.30.1",
          "major" : 0,
          "minor" : 30,
          "patch" : 1,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.655326Z",
      "updatedAt" : "2025-01-11T20:35:34.655326Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.5",
        "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" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "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" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "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" : "posture-check",
        "introducedAt" : "0.16.5",
        "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.external-id",
        "introducedAt" : "0.25.4",
        "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" : "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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" : "service-policy",
        "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
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "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" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : true,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/259c43cd-8e8d-41d1-9d19-e33b5e21cc0c"
        }
      }
    }, {
      "id" : "25cd6253-bf47-4fd9-9a72-1056ec21f08f",
      "networkVersion" : "7.3.6",
      "zitiVersion" : "0.18.2",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.6",
          "value" : "7.3.6",
          "major" : 7,
          "minor" : 3,
          "patch" : 6,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.18.2",
          "value" : "0.18.2",
          "major" : 0,
          "minor" : 18,
          "patch" : 2,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.874708Z",
      "updatedAt" : "2025-01-11T20:35:34.874708Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "service-policy",
        "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" : "config",
        "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" : "identity",
        "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" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "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" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "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-type",
        "introducedAt" : "0.0.0",
        "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/25cd6253-bf47-4fd9-9a72-1056ec21f08f"
        }
      }
    }, {
      "id" : "29dcd17e-6802-4ce0-889a-184322458859",
      "networkVersion" : "7.3.8",
      "zitiVersion" : "0.18.4",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.8",
          "value" : "7.3.8",
          "major" : 7,
          "minor" : 3,
          "patch" : 8,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.18.4",
          "value" : "0.18.4",
          "major" : 0,
          "minor" : 18,
          "patch" : 4,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.881565Z",
      "updatedAt" : "2025-01-11T20:35:34.881565Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "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-policy",
        "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" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "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" : "posture-check",
        "introducedAt" : "0.16.5",
        "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" : "policy-advice",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/29dcd17e-6802-4ce0-889a-184322458859"
        }
      }
    }, {
      "id" : "326d67b2-c476-438f-bd1c-e06a89f557cd",
      "networkVersion" : "7.4.5",
      "zitiVersion" : "1.1.4",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.4.5",
          "value" : "7.4.5",
          "major" : 7,
          "minor" : 4,
          "patch" : 5,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "1.1.4",
          "value" : "1.1.4",
          "major" : 1,
          "minor" : 1,
          "patch" : 4,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        }
      },
      "createdAt" : "2025-01-11T20:35:34.811813Z",
      "updatedAt" : "2025-01-11T20:35:34.811813Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "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" : "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" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "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" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "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" : "browzer",
        "introducedAt" : "0.26.5",
        "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" : "identity",
        "introducedAt" : "0.0.0",
        "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" : "service",
        "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" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "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" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "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" : "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" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.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/326d67b2-c476-438f-bd1c-e06a89f557cd"
        }
      }
    }, {
      "id" : "3eccd50d-af9d-4c13-822b-562b22a87664",
      "networkVersion" : "7.3.37",
      "zitiVersion" : "0.24.14",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.37",
          "value" : "7.3.37",
          "major" : 7,
          "minor" : 3,
          "patch" : 37,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.24.14",
          "value" : "0.24.14",
          "major" : 0,
          "minor" : 24,
          "patch" : 14,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.767116Z",
      "updatedAt" : "2025-01-11T20:35:34.767116Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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" : "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" : "service",
        "introducedAt" : "0.0.0",
        "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" : "transit-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" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "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" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.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" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/3eccd50d-af9d-4c13-822b-562b22a87664"
        }
      }
    }, {
      "id" : "52782105-cc75-40d3-8122-d033f11bbc9d",
      "networkVersion" : "7.3.16",
      "zitiVersion" : "0.19.2",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.16",
          "value" : "7.3.16",
          "major" : 7,
          "minor" : 3,
          "patch" : 16,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.2",
          "value" : "0.19.2",
          "major" : 0,
          "minor" : 19,
          "patch" : 2,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.850370Z",
      "updatedAt" : "2025-01-11T20:35:34.850370Z",
      "platformFeatures" : [ ],
      "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" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "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" : "config",
        "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" : "config-type",
        "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" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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" : "edge-router",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/52782105-cc75-40d3-8122-d033f11bbc9d"
        }
      }
    }, {
      "id" : "551a0603-7d6b-4ae2-89c6-727d8906a5e2",
      "networkVersion" : "7.3.5",
      "zitiVersion" : "0.18.0",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.5",
          "value" : "7.3.5",
          "major" : 7,
          "minor" : 3,
          "patch" : 5,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.18.0",
          "value" : "0.18.0",
          "major" : 0,
          "minor" : 18,
          "patch" : 0,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.870071Z",
      "updatedAt" : "2025-01-11T20:35:34.870071Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "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" : "identity-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" : "config",
        "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" : "authenticator",
        "introducedAt" : "0.0.0",
        "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" : "identity",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/551a0603-7d6b-4ae2-89c6-727d8906a5e2"
        }
      }
    }, {
      "id" : "5ea71b12-44ba-4191-9d04-250caef45b74",
      "networkVersion" : "7.3.32",
      "zitiVersion" : "0.20.9",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.32",
          "value" : "7.3.32",
          "major" : 7,
          "minor" : 3,
          "patch" : 32,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.20.9",
          "value" : "0.20.9",
          "major" : 0,
          "minor" : 20,
          "patch" : 9,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.736668Z",
      "updatedAt" : "2025-01-11T20:35:34.736668Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "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" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "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" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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" : "terminator",
        "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" : "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" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/5ea71b12-44ba-4191-9d04-250caef45b74"
        }
      }
    }, {
      "id" : "60283bb5-596d-40bd-8f67-d2a7fa3a9433",
      "networkVersion" : "7.3.62",
      "zitiVersion" : "0.25.14",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.62",
          "value" : "7.3.62",
          "major" : 7,
          "minor" : 3,
          "patch" : 62,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.25.14",
          "value" : "0.25.14",
          "major" : 0,
          "minor" : 25,
          "patch" : 14,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.775363Z",
      "updatedAt" : "2025-01-11T20:35:34.775363Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "config-type",
        "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" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "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" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "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" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-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",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "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" : "edge-router-policy",
        "introducedAt" : "0.0.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/60283bb5-596d-40bd-8f67-d2a7fa3a9433"
        }
      }
    }, {
      "id" : "6854d512-40bf-436b-985f-9c8819d5bd0c",
      "networkVersion" : "7.3.36",
      "zitiVersion" : "0.24.13",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : false,
      "default" : false,
      "jsonNode" : {
        "active" : false,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.36",
          "value" : "7.3.36",
          "major" : 7,
          "minor" : 3,
          "patch" : 36,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.24.13",
          "value" : "0.24.13",
          "major" : 0,
          "minor" : 24,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.758571Z",
      "updatedAt" : "2025-01-11T20:35:34.758571Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "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" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "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" : "edge-router",
        "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" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "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" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "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" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "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" : "cas",
        "introducedAt" : "0.0.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/6854d512-40bf-436b-985f-9c8819d5bd0c"
        }
      }
    }, {
      "id" : "76d6084e-add1-45aa-846b-336a848c85a0",
      "networkVersion" : "7.3.21",
      "zitiVersion" : "0.19.7",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.21",
          "value" : "7.3.21",
          "major" : 7,
          "minor" : 3,
          "patch" : 21,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.7",
          "value" : "0.19.7",
          "major" : 0,
          "minor" : 19,
          "patch" : 7,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.900974Z",
      "updatedAt" : "2025-01-11T20:35:34.900974Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "identity-type",
        "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",
        "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" : "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" : "transit-router",
        "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" : "service-edge-router-policy",
        "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" : "identity",
        "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" : "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/76d6084e-add1-45aa-846b-336a848c85a0"
        }
      }
    }, {
      "id" : "7b9572c1-176f-457b-b518-c5537d2d8733",
      "networkVersion" : "7.3.18",
      "zitiVersion" : "0.19.4",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : true,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : true,
        "version" : {
          "originalValue" : "7.3.18",
          "value" : "7.3.18",
          "major" : 7,
          "minor" : 3,
          "patch" : 18,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.4",
          "value" : "0.19.4",
          "major" : 0,
          "minor" : 19,
          "patch" : 4,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.857277Z",
      "updatedAt" : "2025-01-11T20:35:34.857277Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "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" : "terminator",
        "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" : "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" : "authenticator",
        "introducedAt" : "0.0.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" : "identity.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" : "cas",
        "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" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : true,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/7b9572c1-176f-457b-b518-c5537d2d8733"
        }
      }
    }, {
      "id" : "7c69c934-38d6-4405-8e53-6231c6df717f",
      "networkVersion" : "7.3.9",
      "zitiVersion" : "0.18.5",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.9",
          "value" : "7.3.9",
          "major" : 7,
          "minor" : 3,
          "patch" : 9,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.18.5",
          "value" : "0.18.5",
          "major" : 0,
          "minor" : 18,
          "patch" : 5,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.891695Z",
      "updatedAt" : "2025-01-11T20:35:34.891695Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "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" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "config",
        "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" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "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" : "service-policy",
        "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-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" : "authenticator",
        "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/7c69c934-38d6-4405-8e53-6231c6df717f"
        }
      }
    }, {
      "id" : "8202def7-9a23-4ffb-8f77-dff75c135a32",
      "networkVersion" : "7.3.19",
      "zitiVersion" : "0.19.5",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.19",
          "value" : "7.3.19",
          "major" : 7,
          "minor" : 3,
          "patch" : 19,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.5",
          "value" : "0.19.5",
          "major" : 0,
          "minor" : 19,
          "patch" : 5,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.860574Z",
      "updatedAt" : "2025-01-11T20:35:34.860574Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "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" : "service-policy",
        "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" : "config",
        "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" : "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" : "edge-router",
        "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/8202def7-9a23-4ffb-8f77-dff75c135a32"
        }
      }
    }, {
      "id" : "9525d426-fcd4-46ef-a1ef-d35ead3fdaa1",
      "networkVersion" : "7.3.17",
      "zitiVersion" : "0.19.3",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.17",
          "value" : "7.3.17",
          "major" : 7,
          "minor" : 3,
          "patch" : 17,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.3",
          "value" : "0.19.3",
          "major" : 0,
          "minor" : 19,
          "patch" : 3,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.854113Z",
      "updatedAt" : "2025-01-11T20:35:34.854113Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router",
        "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" : "service",
        "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" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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" : "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" : "service-policy",
        "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" : "policy-advice",
        "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" : "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/9525d426-fcd4-46ef-a1ef-d35ead3fdaa1"
        }
      }
    }, {
      "id" : "97aa317d-77f5-4adc-98ab-a2311929695f",
      "networkVersion" : "7.3.28",
      "zitiVersion" : "0.20.1",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.28",
          "value" : "7.3.28",
          "major" : 7,
          "minor" : 3,
          "patch" : 28,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.20.1",
          "value" : "0.20.1",
          "major" : 0,
          "minor" : 20,
          "patch" : 1,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.648453Z",
      "updatedAt" : "2025-01-11T20:35:34.648453Z",
      "platformFeatures" : [ {
        "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" : "edge-router-policy",
        "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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.mfa",
        "introducedAt" : "0.18.5",
        "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.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" : "service-edge-router-policy",
        "introducedAt" : "0.0.0",
        "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" : "terminator",
        "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" : "authenticator",
        "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" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/97aa317d-77f5-4adc-98ab-a2311929695f"
        }
      }
    }, {
      "id" : "982f9167-fd9d-45ce-a44d-1d0e8da514d9",
      "networkVersion" : "7.3.27",
      "zitiVersion" : "0.19.13",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.27",
          "value" : "7.3.27",
          "major" : 7,
          "minor" : 3,
          "patch" : 27,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.13",
          "value" : "0.19.13",
          "major" : 0,
          "minor" : 19,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.639655Z",
      "updatedAt" : "2025-01-11T20:35:34.639655Z",
      "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" : "config-type",
        "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
      }, {
        "displayName" : "config",
        "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" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "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" : "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",
        "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" : "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" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/982f9167-fd9d-45ce-a44d-1d0e8da514d9"
        }
      }
    }, {
      "id" : "9f1fc391-1dfd-4a9b-befd-5ae979576584",
      "networkVersion" : "8.0.43",
      "zitiVersion" : "0.25.3",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "8.0.43",
          "value" : "8.0.43",
          "major" : 8,
          "minor" : 0,
          "patch" : 43,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.25.3",
          "value" : "0.25.3",
          "major" : 0,
          "minor" : 25,
          "patch" : 3,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.800960Z",
      "updatedAt" : "2025-01-11T20:35:34.800960Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "identity-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" : "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" : "service-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" : "config-type",
        "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" : "identity",
        "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.host-v1",
        "introducedAt" : "0.19.11",
        "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" : "terminator",
        "introducedAt" : "0.0.0",
        "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" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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" : "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" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/9f1fc391-1dfd-4a9b-befd-5ae979576584"
        }
      }
    }, {
      "id" : "a27c5474-54a1-40e2-ab53-8edf6e148b91",
      "networkVersion" : "7.3.35",
      "zitiVersion" : "0.20.12",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.35",
          "value" : "7.3.35",
          "major" : 7,
          "minor" : 3,
          "patch" : 35,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.20.12",
          "value" : "0.20.12",
          "major" : 0,
          "minor" : 20,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.755395Z",
      "updatedAt" : "2025-01-11T20:35:34.755395Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "identity",
        "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" : "transit-router",
        "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" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "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" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "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" : "authenticator",
        "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
      }, {
        "displayName" : "edge-router-policy",
        "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/a27c5474-54a1-40e2-ab53-8edf6e148b91"
        }
      }
    }, {
      "id" : "acad8d2f-6dee-4028-b5c1-3e9bd747c346",
      "networkVersion" : "8.0.69",
      "zitiVersion" : "0.25.13",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "8.0.69",
          "value" : "8.0.69",
          "major" : 8,
          "minor" : 0,
          "patch" : 69,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.25.13",
          "value" : "0.25.13",
          "major" : 0,
          "minor" : 25,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.658530Z",
      "updatedAt" : "2025-01-11T20:35:34.658530Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "session",
        "introducedAt" : "0.0.0",
        "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" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "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.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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" : "edge-router-policy",
        "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" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "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" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "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" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "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/acad8d2f-6dee-4028-b5c1-3e9bd747c346"
        }
      }
    }, {
      "id" : "b046e796-82c0-4cfc-85a7-567e59e7adf5",
      "networkVersion" : "7.3.92",
      "zitiVersion" : "0.28.4",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.92",
          "value" : "7.3.92",
          "major" : 7,
          "minor" : 3,
          "patch" : 92,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.28.4",
          "value" : "0.28.4",
          "major" : 0,
          "minor" : 28,
          "patch" : 4,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.785062Z",
      "updatedAt" : "2025-01-11T20:35:34.785062Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.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" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "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" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "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" : "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-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" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "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" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "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" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "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" : "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.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "deprecatedAt" : null,
        "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" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.disabled",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/b046e796-82c0-4cfc-85a7-567e59e7adf5"
        }
      }
    }, {
      "id" : "b59abf69-49d4-47e2-9f59-ecb635e32916",
      "networkVersion" : "7.3.30",
      "zitiVersion" : "0.20.3",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.30",
          "value" : "7.3.30",
          "major" : 7,
          "minor" : 3,
          "patch" : 30,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.20.3",
          "value" : "0.20.3",
          "major" : 0,
          "minor" : 20,
          "patch" : 3,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.722711Z",
      "updatedAt" : "2025-01-11T20:35:34.722711Z",
      "platformFeatures" : [ {
        "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.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "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" : "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.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "cas",
        "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" : "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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-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",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "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/b59abf69-49d4-47e2-9f59-ecb635e32916"
        }
      }
    }, {
      "id" : "b96e2757-c365-4c86-95ff-710a0544c8c7",
      "networkVersion" : "7.3.31",
      "zitiVersion" : "0.20.8",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.31",
          "value" : "7.3.31",
          "major" : 7,
          "minor" : 3,
          "patch" : 31,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.20.8",
          "value" : "0.20.8",
          "major" : 0,
          "minor" : 20,
          "patch" : 8,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.733115Z",
      "updatedAt" : "2025-01-11T20:35:34.733115Z",
      "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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" : "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" : "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" : "edge-router",
        "introducedAt" : "0.0.0",
        "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" : "cas",
        "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" : "terminator",
        "introducedAt" : "0.0.0",
        "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" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "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" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/b96e2757-c365-4c86-95ff-710a0544c8c7"
        }
      }
    }, {
      "id" : "bb142b6b-7f17-439a-b650-9966d4f3c866",
      "networkVersion" : "7.3.33",
      "zitiVersion" : "0.20.10",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.33",
          "value" : "7.3.33",
          "major" : 7,
          "minor" : 3,
          "patch" : 33,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.20.10",
          "value" : "0.20.10",
          "major" : 0,
          "minor" : 20,
          "patch" : 10,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.743903Z",
      "updatedAt" : "2025-01-11T20:35:34.743903Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "session",
        "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" : "cas",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "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" : "config",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "introducedAt" : "0.0.0",
        "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "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" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "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" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/bb142b6b-7f17-439a-b650-9966d4f3c866"
        }
      }
    }, {
      "id" : "c9dfd6ae-c4de-4bfc-95ab-00b8eb945794",
      "networkVersion" : "7.3.13",
      "zitiVersion" : "0.18.10",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.13",
          "value" : "7.3.13",
          "major" : 7,
          "minor" : 3,
          "patch" : 13,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.18.10",
          "value" : "0.18.10",
          "major" : 0,
          "minor" : 18,
          "patch" : 10,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.836384Z",
      "updatedAt" : "2025-01-11T20:35:34.836384Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "cas",
        "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" : "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" : "policy-advice",
        "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" : "service",
        "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" : "edge-router-policy",
        "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" : "authenticator",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/c9dfd6ae-c4de-4bfc-95ab-00b8eb945794"
        }
      }
    }, {
      "id" : "cf2e6635-c05d-4a10-846c-382a912ae77a",
      "networkVersion" : "7.3.34",
      "zitiVersion" : "0.20.11",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.34",
          "value" : "7.3.34",
          "major" : 7,
          "minor" : 3,
          "patch" : 34,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.20.11",
          "value" : "0.20.11",
          "major" : 0,
          "minor" : 20,
          "patch" : 11,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.751376Z",
      "updatedAt" : "2025-01-11T20:35:34.751376Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "service-edge-router-policy",
        "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" : "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" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "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.multi-process",
        "introducedAt" : "0.20.2",
        "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",
        "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",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticator",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/cf2e6635-c05d-4a10-846c-382a912ae77a"
        }
      }
    }, {
      "id" : "d14960db-7ee9-4c17-bafa-cc388a7c24fa",
      "networkVersion" : "8.1.12",
      "zitiVersion" : "1.1.12",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "8.1.12",
          "value" : "8.1.12",
          "major" : 8,
          "minor" : 1,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "1.1.12",
          "value" : "1.1.12",
          "major" : 1,
          "minor" : 1,
          "patch" : 12,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        }
      },
      "createdAt" : "2025-01-11T20:35:34.705739Z",
      "updatedAt" : "2025-01-11T20:35:34.705739Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "authenticators.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "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" : "browzer",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.multi-process",
        "introducedAt" : "0.20.2",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.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" : "service",
        "introducedAt" : "0.0.0",
        "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" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "transit-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "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" : "authenticator",
        "introducedAt" : "0.0.0",
        "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "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" : "enrollment.refresh",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "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" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/d14960db-7ee9-4c17-bafa-cc388a7c24fa"
        }
      }
    }, {
      "id" : "d619f2a0-c288-4b51-b85f-53a2bc9f81cb",
      "networkVersion" : "7.3.7",
      "zitiVersion" : "0.08.3",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.7",
          "value" : "7.3.7",
          "major" : 7,
          "minor" : 3,
          "patch" : 7,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.08.3",
          "value" : "0.08.3",
          "major" : 0,
          "minor" : 8,
          "patch" : 3,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.878165Z",
      "updatedAt" : "2025-01-11T20:35:34.878165Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "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" : "session",
        "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
      }, {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "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" : "config",
        "introducedAt" : "0.0.0",
        "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" : "config-type",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity",
        "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/d619f2a0-c288-4b51-b85f-53a2bc9f81cb"
        }
      }
    }, {
      "id" : "d74b04e5-fcb4-400f-a854-5f2fe81e9274",
      "networkVersion" : "7.3.11",
      "zitiVersion" : "0.18.8",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.11",
          "value" : "7.3.11",
          "major" : 7,
          "minor" : 3,
          "patch" : 11,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.18.8",
          "value" : "0.18.8",
          "major" : 0,
          "minor" : 18,
          "patch" : 8,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.820867Z",
      "updatedAt" : "2025-01-11T20:35:34.820867Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "posture-check",
        "introducedAt" : "0.16.5",
        "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" : "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
      }, {
        "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" : "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" : "identity",
        "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" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "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" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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/d74b04e5-fcb4-400f-a854-5f2fe81e9274"
        }
      }
    }, {
      "id" : "de33c8de-57f8-4e0b-a27a-2c6a9d07229b",
      "networkVersion" : "7.3.29",
      "zitiVersion" : "0.20.2",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.29",
          "value" : "7.3.29",
          "major" : 7,
          "minor" : 3,
          "patch" : 29,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.20.2",
          "value" : "0.20.2",
          "major" : 0,
          "minor" : 20,
          "patch" : 2,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.652146Z",
      "updatedAt" : "2025-01-11T20:35:34.652146Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "edge-router",
        "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" : "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" : "config-type.host-v1",
        "introducedAt" : "0.19.11",
        "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" : "posture-check",
        "introducedAt" : "0.16.5",
        "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" : "session",
        "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.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service-policy",
        "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" : "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" : "transit-router",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/de33c8de-57f8-4e0b-a27a-2c6a9d07229b"
        }
      }
    }, {
      "id" : "e09c3c69-4492-493b-bcac-7d62295f9e41",
      "networkVersion" : "7.3.24",
      "zitiVersion" : "0.19.10",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.24",
          "value" : "7.3.24",
          "major" : 7,
          "minor" : 3,
          "patch" : 24,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.10",
          "value" : "0.19.10",
          "major" : 0,
          "minor" : 19,
          "patch" : 10,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.929071Z",
      "updatedAt" : "2025-01-11T20:35:34.929071Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "service",
        "introducedAt" : "0.0.0",
        "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" : "session",
        "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" : "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",
        "introducedAt" : "0.18.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" : "posture-check.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "config",
        "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" : "authenticator",
        "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/e09c3c69-4492-493b-bcac-7d62295f9e41"
        }
      }
    }, {
      "id" : "e9b7628a-83e2-40d4-a09a-38735167daed",
      "networkVersion" : "7.3.10",
      "zitiVersion" : "0.18.7",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.10",
          "value" : "7.3.10",
          "major" : 7,
          "minor" : 3,
          "patch" : 10,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.18.7",
          "value" : "0.18.7",
          "major" : 0,
          "minor" : 18,
          "patch" : 7,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.817393Z",
      "updatedAt" : "2025-01-11T20:35:34.817393Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "policy-advice",
        "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" : "edge-router",
        "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" : "identity",
        "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" : "config",
        "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" : "terminator",
        "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" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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
      } ],
      "recommended" : false,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions/e9b7628a-83e2-40d4-a09a-38735167daed"
        }
      }
    }, {
      "id" : "eab3a45d-1f22-4ed0-9a58-ec269b6fed8a",
      "networkVersion" : "7.3.22",
      "zitiVersion" : "0.19.8",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.22",
          "value" : "7.3.22",
          "major" : 7,
          "minor" : 3,
          "patch" : 22,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.8",
          "value" : "0.19.8",
          "major" : 0,
          "minor" : 19,
          "patch" : 8,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.914605Z",
      "updatedAt" : "2025-01-11T20:35:34.914605Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "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" : "identity",
        "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" : "authenticator",
        "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" : "config-type",
        "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" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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",
        "introducedAt" : "0.16.5",
        "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" : "edge-router",
        "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/eab3a45d-1f22-4ed0-9a58-ec269b6fed8a"
        }
      }
    }, {
      "id" : "f092ebb2-ec40-4a76-ba3e-78183fdc7afd",
      "networkVersion" : "7.3.4",
      "zitiVersion" : "0.17.5",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.4",
          "value" : "7.3.4",
          "major" : 7,
          "minor" : 3,
          "patch" : 4,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.17.5",
          "value" : "0.17.5",
          "major" : 0,
          "minor" : 17,
          "patch" : 5,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.867216Z",
      "updatedAt" : "2025-01-11T20:35:34.867216Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "service",
        "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" : "transit-router",
        "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" : "posture-check",
        "introducedAt" : "0.16.5",
        "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" : "policy-advice",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "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" : "service-policy",
        "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" : "config-type",
        "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/f092ebb2-ec40-4a76-ba3e-78183fdc7afd"
        }
      }
    }, {
      "id" : "f292bf7d-798c-4aef-9329-f2b483664ae3",
      "networkVersion" : "7.3.15",
      "zitiVersion" : "0.19.1",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.15",
          "value" : "7.3.15",
          "major" : 7,
          "minor" : 3,
          "patch" : 15,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.19.1",
          "value" : "0.19.1",
          "major" : 0,
          "minor" : 19,
          "patch" : 1,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.846470Z",
      "updatedAt" : "2025-01-11T20:35:34.846470Z",
      "platformFeatures" : [ ],
      "zitiFeatures" : [ {
        "displayName" : "identity-type",
        "introducedAt" : "0.0.0",
        "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" : "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" : "identity.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" : "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",
        "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" : "identity",
        "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" : "service",
        "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/f292bf7d-798c-4aef-9329-f2b483664ae3"
        }
      }
    }, {
      "id" : "f777ca0c-836f-473d-809d-c782c2b292a5",
      "networkVersion" : "7.3.89",
      "zitiVersion" : "0.27.9",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.89",
          "value" : "7.3.89",
          "major" : 7,
          "minor" : 3,
          "patch" : 89,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.27.9",
          "value" : "0.27.9",
          "major" : 0,
          "minor" : 27,
          "patch" : 9,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.684343Z",
      "updatedAt" : "2025-01-11T20:35:34.684343Z",
      "platformFeatures" : [ {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "displayName" : "service",
        "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.list.enrollments",
        "introducedAt" : "0.25.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config-type",
        "introducedAt" : "0.0.0",
        "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" : "edge-router",
        "introducedAt" : "0.0.0",
        "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" : "posture-check",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "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" : "edge-router.is-tunneler-enabled",
        "introducedAt" : "0.20.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "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" : "identity",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "enrollment.create.delete",
        "introducedAt" : "0.25.9",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "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" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.wss-listener",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.router.enabled",
        "introducedAt" : "0.27.6",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "authenticators.list.authenticators",
        "introducedAt" : "0.22.10",
        "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.process",
        "introducedAt" : "0.16.5",
        "deprecatedAt" : "0.20.0",
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa.timeout-seconds",
        "introducedAt" : "0.20.14",
        "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" : "identity-type",
        "introducedAt" : "0.0.0",
        "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/f777ca0c-836f-473d-809d-c782c2b292a5"
        }
      }
    }, {
      "id" : "fe68866a-2ec0-479f-909d-9c0b5b338637",
      "networkVersion" : "7.3.90",
      "zitiVersion" : "0.27.10",
      "minimumNetworkVersionForUpgrade" : null,
      "minimumEdgeRouterVersionForUpgrade" : null,
      "active" : true,
      "default" : false,
      "jsonNode" : {
        "active" : true,
        "defaultVersion" : false,
        "version" : {
          "originalValue" : "7.3.90",
          "value" : "7.3.90",
          "major" : 7,
          "minor" : 3,
          "patch" : 90,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : true
        },
        "zitiVersion" : {
          "originalValue" : "0.27.10",
          "value" : "0.27.10",
          "major" : 0,
          "minor" : 27,
          "patch" : 10,
          "suffixTokens" : [ ],
          "build" : null,
          "type" : "STRICT",
          "stable" : false
        }
      },
      "createdAt" : "2025-01-11T20:35:34.779387Z",
      "updatedAt" : "2025-01-11T20:35:34.779387Z",
      "platformFeatures" : [ {
        "displayName" : "browzer",
        "introducedAt" : "7.3.90",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint",
        "introducedAt" : "7.3.25",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "service.advanced-tunneler-to-endpoint.source-ip-transparency",
        "introducedAt" : "7.3.32",
        "deprecatedAt" : null,
        "removedAt" : null
      } ],
      "zitiFeatures" : [ {
        "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" : "config-type.intercept-v1",
        "introducedAt" : "0.19.11",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge-router.no-traversal",
        "introducedAt" : "0.24.13",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "terminator",
        "introducedAt" : "0.0.0",
        "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" : "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" : "authenticator",
        "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" : "session",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "posture-check.mfa",
        "introducedAt" : "0.18.5",
        "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" : "identity.external-id",
        "introducedAt" : "0.25.4",
        "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" : "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" : "service-edge-router-policy",
        "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" : "edge-router-policy",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "identity.mfa",
        "introducedAt" : "0.18.5",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "edge.routers.re.enroll",
        "introducedAt" : "0.25.10",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "auth-policy",
        "introducedAt" : "0.25.4",
        "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" : "service",
        "introducedAt" : "0.0.0",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "config",
        "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" : "identity.disabled",
        "introducedAt" : "0.25.4",
        "deprecatedAt" : null,
        "removedAt" : null
      }, {
        "displayName" : "browzer",
        "introducedAt" : "0.26.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/fe68866a-2ec0-479f-909d-9c0b5b338637"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 45,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Network Version

GET /v2/network-versions/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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

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/551a0603-7d6b-4ae2-89c6-727d8906a5e2' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJxQ1BqM2tLNGxKWVRqNktFdUVjM013IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI5YTMzZTk4LWYyZWQtNDU1NC1iMGRiLTYxMDg5MTE3ZjQ5NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzczNSwiZXhwIjoxNzM2NjMxMzM1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI4YTcxYzBiLTQ1MWEtNGQ4OC1iMjQzLWUyNzM5MWZkYjc5NFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzczNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.G-nFQsjoytGRP6hu1mD1CzhAGnnwSFZ1DAqNO1oTu9HIxF95jfO3C2uymeR9j2o4d1R4bnaDWws6y2WrBXZVS_ktohPsQzhx80m7jhvQtVKwBBKPCmacDREd9curvj7laUAlFk30gFpnyLAs3XMb2f6fiWHEYGdGXji_RY8P6ijIDiJm1_eZYLs1Jx3GEQHAZc7kRdJTynZ_QPHMOHG73MPaUC5RrOfn52D1YhxBQ9TzurwH9N4BjIasla1aWPuj6pTo9mcDlqoyYnaUdpu1h31lcjMWLd2y9NZ1Sxf_GRiJpkpJRYmDFXPNn7ulEibkRbKAOdS0Zbah6N_TLDGb3Q'

Example response

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

{
  "id" : "551a0603-7d6b-4ae2-89c6-727d8906a5e2",
  "networkVersion" : "7.3.5",
  "zitiVersion" : "0.18.0",
  "minimumNetworkVersionForUpgrade" : null,
  "minimumEdgeRouterVersionForUpgrade" : null,
  "active" : true,
  "default" : false,
  "jsonNode" : {
    "active" : true,
    "defaultVersion" : false,
    "version" : {
      "originalValue" : "7.3.5",
      "value" : "7.3.5",
      "major" : 7,
      "minor" : 3,
      "patch" : 5,
      "suffixTokens" : [ ],
      "build" : null,
      "type" : "STRICT",
      "stable" : true
    },
    "zitiVersion" : {
      "originalValue" : "0.18.0",
      "value" : "0.18.0",
      "major" : 0,
      "minor" : 18,
      "patch" : 0,
      "suffixTokens" : [ ],
      "build" : null,
      "type" : "STRICT",
      "stable" : false
    }
  },
  "createdAt" : "2025-01-11T20:35:34.870071Z",
  "updatedAt" : "2025-01-11T20:35:34.870071Z",
  "platformFeatures" : [ ],
  "zitiFeatures" : [ {
    "displayName" : "config",
    "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" : "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",
    "introducedAt" : "0.16.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" : "edge-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" : "service",
    "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" : "cas",
    "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/551a0603-7d6b-4ae2-89c6-727d8906a5e2"
    },
    "versions" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-versions",
      "profile" : "parent"
    }
  }
}

Network Group Limits

Create Network Group Limit

POST /v2/network-group-limits

Authorization

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type 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.eyJqdGkiOiJ6MnZjaGk5aWZELWp3T0pQUDk2c2pBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ1YTlhMzdjLWQyMGEtNDg1MS1hZDA5LTg1ODE3YmE0YmE5ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwNSwiZXhwIjoxNzM2NjMxNTA1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjZiOTJjMDA2LTUwYmItNDMwMi1iMDdiLWNlZmUwMzFjMzc3Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Qy4sMwEDD-j_gI-mw0Kuwk9U3NHOE9ufROUXerMaRF3bAA8Pqgn28wpYDoc_qtz_qVVZNDLKGboGae1rm0RMjn-twPjKNbZKCYw07oc6oQDDY6HUU4PqYXOGY7kOvrUeRgGiEbdSPvYZntSDtt8z4jN-bQsELWMDpBj9zEVqBnwKkBRKHtGeXt96Ek_GUpHoGAl5sI3XuCQTVhiBMdu7iNBT_ET5-QGegPnH4C9iLybP4zC0zRIEP6SZOketrlouHk_N-nHbfsIq39pGY7gp18ASyQkSU4ND3XqD-CuIX4p0vpHNPQSVxGeDqD3JGxSSps7RsBUPklcmIaqWGDSdIA' \
    -d '{"networkCount":1,"defaultEndpointCount":1,"defaultControllerCount":null,"networkGroupId":"0c2a9f2b-0ca1-4212-8b4d-9dff7d0413fa"}'

Example response

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

{
  "id" : "cc322690-23f6-4c8a-af17-97824c1121da",
  "networkCount" : 1,
  "defaultEndpointCount" : 1,
  "defaultControllerCount" : -1,
  "networkGroupId" : "0c2a9f2b-0ca1-4212-8b4d-9dff7d0413fa",
  "createdBy" : "45a9a37c-d20a-4851-ad09-85817ba4ba9d",
  "createdAt" : "2025-01-11T20:38:25.817402Z",
  "updatedAt" : "2025-01-11T20:38:25.817402Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/cc322690-23f6-4c8a-af17-97824c1121da"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/0c2a9f2b-0ca1-4212-8b4d-9dff7d0413fa",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/787de327-dcb2-4a94-9b38-8b0e4f39abb5",
      "title" : "Create NetworkGroupLimit",
      "profile" : "meta"
    }
  }
}

Delete Network Group Limit

DELETE /v2/network-group-limits/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/network-group-limits/daff16fc-ed45-403d-8d37-9810b609f1b7' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZdEpIa3NIWHU1RVVBaTREV0tSM3NnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQyZDhkNTcwLWUwOTQtNGZiYS1iYWJhLTM3ZDY0ZWM3NDQyNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwNSwiZXhwIjoxNzM2NjMxNTA1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhjMmU5YWE0LTYwMWYtNDgyMi1iOGNkLWNlY2I2MWZmODZmNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.mfUdOl90FaOIKkDFWUdXFg7G7Zck-oafZ1J4xwBTS5L4ofM_NqyRld1em-Glf85anZAw0Ui3MlhAgcwn8kMWQOlaFs9iPCauYscG19fEEkVGHOeUgEfXPHb2bGJ02oRYmd7tAGaS3JrIj0KAdxYEZxxr_c4D_VnoSR7tbDjtXDcfuSOwc7C_zZxvC3nSd3ULAGWDt9fQeOBb0nApkVi2QjsNtee1HPsE2DDr_Cb9y2TvR6yo3Vm5VPJZBBJa159EDIPxIDvHQMDoeHlon8JG6O8yWgB1dLYlOCn42W-vHXtHUAv75HkxlyogNNlzdEZbQ40lac2yBdrEn7Tw0tMtQw'

Example response

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

{
  "id" : "daff16fc-ed45-403d-8d37-9810b609f1b7",
  "networkCount" : 1,
  "defaultEndpointCount" : 1,
  "defaultControllerCount" : -1,
  "networkGroupId" : "dd91d5ae-4bbd-4c2e-a153-543f5d8698af",
  "createdBy" : "1ed85457-99ea-4737-ae87-73baf0ccbb3f",
  "createdAt" : "2025-01-11T20:38:25.719762Z",
  "updatedAt" : "2025-01-11T20:38:25.725668Z",
  "deletedBy" : "42d8d570-e094-4fba-baba-37d64ec74425",
  "deletedAt" : "2025-01-11T20:38:25.725Z",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/daff16fc-ed45-403d-8d37-9810b609f1b7"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/dd91d5ae-4bbd-4c2e-a153-543f5d8698af",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/6ea1866e-ea63-45c6-81fc-1d0b6d8ba417",
      "title" : "Delete NetworkGroupLimit",
      "profile" : "meta"
    }
  }
}

Get Network Group Limit

GET /v2/network-group-limits/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/network-group-limits/066d637c-6fc0-4b66-9b9a-75a616764971' -i -X GET \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJuMUY5ZlhCTDFxSi1zSmpXU2FHZ3FRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFjODYyMzE1LTU1OGUtNGQ4OS05MjEwLWVlN2U2N2M5ZWNmNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwNSwiZXhwIjoxNzM2NjMxNTA1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjMxMTA3M2ZlLWY3OGItNDc4Yy1hOGFhLWIyNTdjYzIwYjFkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.tCq0rBkl18RJfF2xO3MJoW8c-VvtG8XZ5kCmGZIZSqgWV4JJdYDYV802goUhyF9cwOKyXZWzvQYOfCyT-6VX_iNPlTcOKAQOC4XqQ2UDiHSJa758JLySd6BjHGbShujTHKWUofVzVnetfxSVdYL_BS-Kxj8T8UO3Yrh8NUrR8TpR5vNM5kemEufHO0YPPoRi_SMNTubNPIFYeM56UJQic_LaXJivTbB-9LBhDVNfgqpZrM2f8iDg5qSjWpWfXXqz0h0ith6ML10epBeCQjc4qRQH4OpJPHPRzpJR6hJmE-t718RH8S91j_6Loah_qFfqmyON2MkRFpM2EduymkZEqA'

Example response

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

{
  "id" : "066d637c-6fc0-4b66-9b9a-75a616764971",
  "networkCount" : 1,
  "defaultEndpointCount" : 1,
  "defaultControllerCount" : -1,
  "networkGroupId" : "c37b9f46-bb5f-472a-a278-e7fe2d497329",
  "createdBy" : "8e90e377-ee99-4995-a95e-443dd4654874",
  "createdAt" : "2025-01-11T20:38:25.668718Z",
  "updatedAt" : "2025-01-11T20:38:25.668718Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/066d637c-6fc0-4b66-9b9a-75a616764971"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/c37b9f46-bb5f-472a-a278-e7fe2d497329",
      "profile" : "parent"
    }
  }
}

Find Network Group Limits

GET /v2/network-group-limits

Authorization

This endpoint requires read action on the network-group-limit 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

id

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.eyJqdGkiOiI0MTA1TzFQSlNuVC1rbWMybTVHTTNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImMwNDg1YzU1LTA0ZWItNGIzMC04OWU1LWUyOTljZDc1YjJhNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwNSwiZXhwIjoxNzM2NjMxNTA1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjkyNjEwYzk4LWFiY2MtNDExNS04NmNhLTUxZGU5ZjJkOTZjNFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.MwsFmMjEPLTRYcbRxC8mfM0N0kUAnIyqXpZTcqZAsT_JII8ltHqY24VMMK0Jdf9w30a1v68BwTZMikUMfAh2SIToHBki0x1FOnKExIrtxMLJvGVg_1kboeAbnhdikqDoxS7qR0M_JE-5WIJYrEWP1kkg8TS87PbqoQBzx1mOSVBhfpCZ4HUwd_ZrTFMUHfoPprBgE68hBdWx7ZmxADJKKx0HgyosGnzmJ2Y45heYxNv3YkK8DId3OT2fgDCZtpYfBHjnwnrOy0q2KkJ7yfzpxZEUe4jxvDmznZ_mVkOXeY5gxZNNuguTxctTC3_PPOKcOGBKSmaYTimia-mYwRKN3w'

Example response

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

{
  "_embedded" : {
    "networkGroupLimitList" : [ {
      "id" : "066d637c-6fc0-4b66-9b9a-75a616764971",
      "networkCount" : 1,
      "defaultEndpointCount" : 1,
      "defaultControllerCount" : -1,
      "networkGroupId" : "c37b9f46-bb5f-472a-a278-e7fe2d497329",
      "createdBy" : "8e90e377-ee99-4995-a95e-443dd4654874",
      "createdAt" : "2025-01-11T20:38:25.668718Z",
      "updatedAt" : "2025-01-11T20:38:25.668718Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/066d637c-6fc0-4b66-9b9a-75a616764971"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/c37b9f46-bb5f-472a-a278-e7fe2d497329",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "99e72ede-f1d3-4788-b1f2-6e1d72bf8089",
      "networkCount" : 1,
      "defaultEndpointCount" : 1,
      "defaultControllerCount" : -1,
      "networkGroupId" : "5d4f0d0a-7b74-4bc1-aa87-6c77114333c1",
      "createdBy" : "c1c8f117-da54-4b10-b8e7-fc40097ab33c",
      "createdAt" : "2025-01-11T20:38:25.754063Z",
      "updatedAt" : "2025-01-11T20:38:25.754063Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/99e72ede-f1d3-4788-b1f2-6e1d72bf8089"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/5d4f0d0a-7b74-4bc1-aa87-6c77114333c1",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "adc7bb70-bb61-4446-aa96-f6fc34fc5a7f",
      "networkCount" : 1,
      "defaultEndpointCount" : 1,
      "defaultControllerCount" : -1,
      "networkGroupId" : "b38d6aa2-2584-451b-9486-42cdc966abb7",
      "createdBy" : "795dfed8-b0bf-438d-a2bf-581cc57e8965",
      "createdAt" : "2025-01-11T20:38:25.840955Z",
      "updatedAt" : "2025-01-11T20:38:25.840955Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/adc7bb70-bb61-4446-aa96-f6fc34fc5a7f"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/b38d6aa2-2584-451b-9486-42cdc966abb7",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "cc322690-23f6-4c8a-af17-97824c1121da",
      "networkCount" : 1,
      "defaultEndpointCount" : 1,
      "defaultControllerCount" : -1,
      "networkGroupId" : "0c2a9f2b-0ca1-4212-8b4d-9dff7d0413fa",
      "createdBy" : "45a9a37c-d20a-4851-ad09-85817ba4ba9d",
      "createdAt" : "2025-01-11T20:38:25.817402Z",
      "updatedAt" : "2025-01-11T20:38:25.817402Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/cc322690-23f6-4c8a-af17-97824c1121da"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/0c2a9f2b-0ca1-4212-8b4d-9dff7d0413fa",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "daff16fc-ed45-403d-8d37-9810b609f1b7",
      "networkCount" : 1,
      "defaultEndpointCount" : 1,
      "defaultControllerCount" : -1,
      "networkGroupId" : "dd91d5ae-4bbd-4c2e-a153-543f5d8698af",
      "createdBy" : "1ed85457-99ea-4737-ae87-73baf0ccbb3f",
      "createdAt" : "2025-01-11T20:38:25.719762Z",
      "updatedAt" : "2025-01-11T20:38:25.725668Z",
      "deletedBy" : "42d8d570-e094-4fba-baba-37d64ec74425",
      "deletedAt" : "2025-01-11T20:38:25.725Z",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/daff16fc-ed45-403d-8d37-9810b609f1b7"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/dd91d5ae-4bbd-4c2e-a153-543f5d8698af",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits?networkCount=1"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}

Update Network Group Limit

PATCH /v2/network-group-limits/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/7df70f80-9db3-4861-aaa9-4ec7f7a0e913' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJnMEZlVktKZXZjbUR1YnRNMjlyeE93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI0NmZjM2RkLWRiYTYtNDM3NS1hZmU0LWE1ZDgyNGMyZDQ0NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkwNSwiZXhwIjoxNzM2NjMxNTA1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjA4NjRkYTEwLTc4NjMtNDZiZC05ZjdkLTYyNTI0MjA3ZDEwMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkwNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.AjZOeoWRhIgwJXK7tb6gj2pt1JzdxdFh57WZl44hZlHg-F3K3SOrS_wj_vu5wxrX8uUzrlfcuNP98Y9wRCFi0587Ksu8tNB7vHoXFiGr0YAk5jWL-6RHjDs2kBIpPnV1VfY6vSDObMvXRnDJM0OgiAEfkViUbT2ioqEYCLVNWwFEu97k-T-u7EUPP4XE4PURcE4K-_KaIKPNXCmOjL9gcx6jEyw3WzPiIgdEQ_L50TbYQvmZJtVBX0aUG42UbUApiUjYBjR9kWEWc_CiNjPE1hehIBNHdcnCZccG-_MAcPUVrgd8zJLxAPK3mGKZtv2naBsor3vGtc7a7u0_TM6WEA' \
    -d '{"networkCount":2,"defaultEndpointCount":null,"defaultControllerCount":null}'

Example response

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

{
  "id" : "7df70f80-9db3-4861-aaa9-4ec7f7a0e913",
  "networkCount" : 2,
  "defaultEndpointCount" : 1,
  "defaultControllerCount" : -1,
  "networkGroupId" : "bbc6fcd3-83ee-4469-ae72-c784a8011f2e",
  "createdBy" : "67b5e386-81c5-45c7-86a9-7725e10d7243",
  "createdAt" : "2025-01-11T20:38:25.876730Z",
  "updatedAt" : "2025-01-11T20:38:25.890027Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-group-limits/7df70f80-9db3-4861-aaa9-4ec7f7a0e913"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/bbc6fcd3-83ee-4469-ae72-c784a8011f2e",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/46990133-d9d1-4f59-8bc8-2ab786142115",
      "title" : "Update NetworkGroupLimit",
      "profile" : "meta"
    }
  }
}

Network Limits

Create Network Limit

POST /v2/network-limits

Authorization

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type 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.eyJqdGkiOiJnRlBMMUI3a2hDQU5tNEt4UlpISXBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI1MWMxYzM2LWNkNGYtNDI5Yy05NWE1LWUwY2MwMGY1ZWIzNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkxNywiZXhwIjoxNzM2NjMxNTE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFlOGZkZjhjLWFiMzctNDk1NS1iNDVmLTI5ZjJhMmExOTExOFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkxN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.RIkWVJ6KdQsJXUkyLPDb4mABszxF8HX0dDJ5uHEBhZkoOPX5trL4tBotPHdiZtchcLAMDd0HhOawxEuI8GZVNswXjbEvozBsfcOHVwsqtu-oVPBFfxrlHD4A3st9b8L4f1HCeI9odQxI_KlF-pYveVkT94Zl8K9gH4ykA2B42p9mQU-JTnYNK3a55tUJlRvz3UYAJBsZujXmENUYfi90Z1sXywy1bGCj9tuWsrwcDnis82LY6P4cA5mMsvlLVH64MNsuM0jH3euWUxrYKm24tN42lNEmyNLsfxCa9VOlG0COX-8kYovw6JWU-PXBe7SB-gh8OkICUfroWPa-HImnNg' \
    -d '{"endpointCount":1,"controllerCount":null,"networkId":"f331bf9c-d978-4b79-ae9b-6fa6b92c2c95"}'

Example response

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

{
  "id" : "f73a0147-a9d6-4962-891e-e11421a57390",
  "endpointCount" : 1,
  "controllerCount" : 1,
  "networkId" : "f331bf9c-d978-4b79-ae9b-6fa6b92c2c95",
  "createdBy" : "251c1c36-cd4f-429c-95a5-e0cc00f5eb35",
  "createdAt" : "2025-01-11T20:38:37.977341Z",
  "updatedAt" : "2025-01-11T20:38:37.977341Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f331bf9c-d978-4b79-ae9b-6fa6b92c2c95",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits/f73a0147-a9d6-4962-891e-e11421a57390"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/db95fc5e-724b-49a3-b02d-21f44dd6cbde",
      "title" : "Create NetworkLimit",
      "profile" : "meta"
    }
  }
}

Delete Network Limit

DELETE /v2/network-limits/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/network-limits/f3f74ddd-99d1-4003-b5e4-f25c75bf31f7' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI4NTlRYXczcTRKVFg4enh3R1hncGR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY0YzgzM2Y2LWRiMDAtNGM3Yy05OTdjLTBlNjg2NWUwZTQ4NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkxNywiZXhwIjoxNzM2NjMxNTE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImEzYjZjMjkzLWNiZmMtNGZjMy05ODc5LTY5NjExMTQzOGIxZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkxN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.QmqXZhgLgvtx_ysYc_bjZI8Q8jInpteI6YoZbZtdQgukx5UIEpcX4WGzi8EYwHeGILAhXaPVdYgA59jfzhu3KYSuuMxWyjqnuv-3R06jmLohz5nKm4nI74yAyNFMeyWGI2OgSy8Y9RLoyls3BCI2RuLd_7DLfNdNOyfTti8nM7jrB49SDM_Ometq3m3GXu5Bo3CzBmF-MPSrhBvmtlkwaLdF99hsXUX_sPiH2v1B8zE7wph_sYClnOHsOcYDzNE1PZlztANbph2zrueQvYNjF8w8Lmk_n0EB3QZwPcdqNe-cfdUg1KBvnwBuPylL98ucsO5SLaR2ea9hZ99HPB6SkQ'

Example response

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

{
  "id" : "f3f74ddd-99d1-4003-b5e4-f25c75bf31f7",
  "endpointCount" : 1,
  "controllerCount" : 1,
  "networkId" : "9aedb239-269d-454d-b872-b1ad474ec9dc",
  "createdBy" : "2d955cce-b797-497c-b18a-2e3833ac303f",
  "createdAt" : "2025-01-11T20:38:37.753416Z",
  "updatedAt" : "2025-01-11T20:38:37.764875Z",
  "deletedBy" : "f4c833f6-db00-4c7c-997c-0e6865e0e484",
  "deletedAt" : "2025-01-11T20:38:37.764Z",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9aedb239-269d-454d-b872-b1ad474ec9dc",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits/f3f74ddd-99d1-4003-b5e4-f25c75bf31f7"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/1391ad9f-f880-4202-88b3-4c2f1914c2bb",
      "title" : "Delete NetworkLimit",
      "profile" : "meta"
    }
  }
}

Get Network Limit

GET /v2/network-limits/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/network-limits/31c4764e-a683-4cfb-b3cd-8cd3fa9eb59b' -i -X GET \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJQejI1UUJmNnhxWk9JQXc5VXpzY3BBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBmZDQ5MTI4LTZhNTUtNDE1Ni1iZjc2LTIwOTBjNmJiNTcyNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkxNywiZXhwIjoxNzM2NjMxNTE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImU4NDMwNmVjLWNlZTQtNDc5ZC05MzZjLTFhOTYwYTg4N2Y3MFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkxN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Cj5CQ17m2fJktJyh6E00JyncAahQywokJdEoi_VK-_tAogCOeCSP_thF4qaOVljDsejoQiqRmXNG4WcUQTm0qVxMC8sgj_skd7W_fZO8G6h39WOJclXYYZCviM_gWKhpgBxH6OOJ4vqszH7LSeLK0ieduFyoXAspGDYf18e2NUKhj3EtvjigDZdlhfmPOb_rQLHr9TOv4v1Dqp0Z2E9HpaQ3JK1FvTo3D5Fv8V4SnNaIOGZNIxZ9wU24fa0EFa4E3srvDhzl_4IYcLwnznwPV2UQodYMPgMUL-k-LRuER3v41HNKAyOls9tmhxBZNdg8l1UNepCppDB9xE62AhhiPg'

Example response

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

{
  "id" : "31c4764e-a683-4cfb-b3cd-8cd3fa9eb59b",
  "endpointCount" : 1,
  "controllerCount" : 1,
  "networkId" : "ee3a89f2-d852-49bf-8aff-a4a46463f751",
  "createdBy" : "cacf55f0-7221-40a7-ab96-9a6accf5ed4f",
  "createdAt" : "2025-01-11T20:38:37.904115Z",
  "updatedAt" : "2025-01-11T20:38:37.904115Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ee3a89f2-d852-49bf-8aff-a4a46463f751",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits/31c4764e-a683-4cfb-b3cd-8cd3fa9eb59b"
    }
  }
}

Find Network Limits

GET /v2/network-limits

Authorization

This endpoint requires read action on the network-limit 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

id

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=b7e70181-917e-4043-8c0f-bfe4bf8c0ffd' -i -X GET \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJsVzZZeC1OZE5JRE1BSTNrSWNSOTFRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA3MzY2YWEyLWUzY2EtNDdjMS04MjY5LWRkNjY1ZTYzNzI2ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkxNywiZXhwIjoxNzM2NjMxNTE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdmM2I5YWFjLTMyYmUtNDBiNi05NTMwLTY0NjNhNWU0NmQxZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkxN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.E-Q1p9rJGarxRB8l6Ev9EW9JasCAt846mRc0X3t5fvZ1OXn9i_fSWA2FwCxhdSL40psLQfdabb_E51SQB281Q4lB2BXd_hfuxPjZqdZvQIvnFR1ntORKpVUOqWvvB4OOMzeubS4reWBI7DUC3e7Jej39VvPltHKRipNDe645KFzwnKbQCK7cqJspBcAaJNd0GOmpGpFKV_qN82RjzJ8_ZnANvFs96xWpKK1VEpIqeImlZuDunUZBK-0j56fcQtvxO8T0YIsjbf8uUyI6eurg2dWqcswbgl6gXdqCUDzYCIHyiYhtINbcSEw0g77SOuHVa_qxlE_UTy9dOM4DcPdx7g'

Example response

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

{
  "_embedded" : {
    "networkLimitList" : [ {
      "id" : "91a6debf-b1f9-4964-8250-30f8899aa0f4",
      "endpointCount" : 1,
      "controllerCount" : 1,
      "networkId" : "b7e70181-917e-4043-8c0f-bfe4bf8c0ffd",
      "createdBy" : "77337ddf-33f4-416f-94fe-d694fe72d3b0",
      "createdAt" : "2025-01-11T20:38:37.934914Z",
      "updatedAt" : "2025-01-11T20:38:37.934914Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b7e70181-917e-4043-8c0f-bfe4bf8c0ffd",
          "profile" : "parent"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits/91a6debf-b1f9-4964-8250-30f8899aa0f4"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits?networkId=b7e70181-917e-4043-8c0f-bfe4bf8c0ffd"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Update Network Limit

PATCH /v2/network-limits/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/5bc4cb7e-e007-44fe-ad62-35439b54541d' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ2d0Z4ZGdoS1pDQW5pMXNxTWJXYjl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhkNDBjMzc5LTc4MjItNGEzMy05MmYzLTZlY2E5ODdmODA0OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzkxNywiZXhwIjoxNzM2NjMxNTE3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImVhMWQxOTFjLWJmMjQtNDRjOS1iYjlhLTE1MzU0ZmJmOTQxZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzkxN31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.M6GoVQegyHC6ZmFzvBRH59-WVemZmRSOdI6QsCkGmznTk3633V1zi4KB_s1pzRfEsmusL4Lqt2sBQI8j0MpOeEPr1b_omFu0zzusBY4YFOIlPfueSgjhZbaJ8EOyYYpzaU9IfNJUn8aSNxZmJ0EUKwbQyRwxwLW4fJZbEq0NVTT7ELrN68pSoCRXux4MB5Igb-Vm9tOHRVZ2nck4vWDi52kbWgtLqZODbrIRPFOM9WFadwC8i6Ky2SlrfeRTfn4mDmKyJf-9efs4B8T3XqsvcdaMdFwFNoWJ6b0LMkVKXoJLIYdcMd_ugbN2-txf5sJY8WFp3YzqC-I3d3APlf64QA' \
    -d '{"endpointCount":2,"controllerCount":null}'

Example response

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

{
  "id" : "5bc4cb7e-e007-44fe-ad62-35439b54541d",
  "endpointCount" : 2,
  "controllerCount" : 1,
  "networkId" : "d18e154e-2288-47c1-a412-dcb99ffffe16",
  "createdBy" : "85af182b-e1ed-48b5-b866-952fa5655002",
  "createdAt" : "2025-01-11T20:38:37.803023Z",
  "updatedAt" : "2025-01-11T20:38:37.817586Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d18e154e-2288-47c1-a412-dcb99ffffe16",
      "profile" : "parent"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-limits/5bc4cb7e-e007-44fe-ad62-35439b54541d"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/executions/97aa7e35-7360-4175-8500-0704ea94c961",
      "title" : "Update NetworkLimit",
      "profile" : "meta"
    }
  }
}

DNS Zones

Create Dns Zone

POST /v3/dns-zones

Authorization

This endpoint requires create action on the dns-zone resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type 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.eyJqdGkiOiJSRFhZNUhKMUtQNDlLd1hjaDlFczJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjViZTMzZjY3LTE5YjEtNDdmYi05OGM1LTBmMmVmYzQ5YzI3YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NywiZXhwIjoxNzM2NjMxNDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVjZTYyZGRkLTIwZDAtNGFkMy1iODIwLWE3M2ExYjNiNjFlM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.KGIif-QFtoSL5vzmSKKZWena9WHN8TA6uHpwtMYFaNw8Grnzerl0AJOWXMAPWooV4Ng5WjvWb7r1wi-SFPD19C9isp1Jmiru2ZDYSPBOgv-1KrLUcPCwF3wCHqNMV5YXasTPBngnPvZpCWCa2MDXawIi3m6VfJt4MqZVs9Hn_RZTyWddIyEANVIx707v6CnvM-6X9xjGdFEWlLp0Y0pGTywfG2uKnjtZwOvwJjEgogXIl2pitribwbbRpW43pfKCdnta7jA4_D0ROf_BCGUS1PZImjwPl4U4WvVdVA20EPq62KDWFEvpHUamIlpFfU1g2HYtdSjbzPomo5mOkta7oQ' \
    -d '{"networkGroupId":"84aa7531-cc10-4255-a37b-4eee61b0fd43","name":"testName-1751","route53ZoneId":"zoneId","domain":null}'

Example response

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

{
  "id" : "1d7a684b-6f91-48ee-9c75-7f0f743b833f",
  "networkGroupId" : "84aa7531-cc10-4255-a37b-4eee61b0fd43",
  "name" : "testName-1751",
  "route53ZoneId" : "zoneId",
  "domain" : "domainResult",
  "validated" : false,
  "createdBy" : "5be33f67-19b1-47fb-98c5-0f2efc49c27b",
  "createdAt" : "2025-01-11T20:37:47.115813Z",
  "updatedAt" : "2025-01-11T20:37:47.115813Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/1d7a684b-6f91-48ee-9c75-7f0f743b833f",
      "title" : "testName-1751"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/84aa7531-cc10-4255-a37b-4eee61b0fd43",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/executions/a12b1696-c0e4-4f0b-94b6-9b42c4e7d28f",
      "title" : "Create DnsZone",
      "profile" : "meta"
    }
  }
}

Delete Dns Zone

DELETE /v3/dns-zones/{id}

Authorization

This endpoint requires delete action on the dns-zone resource type.

Path parameters

Parameter Type Optional Description

id

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/v3/dns-zones/afb9271f-794c-4687-952b-09740ac2018b' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDcm5qTnpIY19aSng1d1FfMG91S19RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNhZTMyOTUxLTBkYWEtNDVkZi1iZDI1LTE3ZDdiMTI2ZDQwOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NywiZXhwIjoxNzM2NjMxNDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImYyNWM4OGIxLWEzNjUtNDYzYS05NmFmLTNlMzE0YWNjNDRhM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Y1cobbmb13PRljGz5xz2-2yhPKPZfJ5PHSRZVfrthelXF7M4CukAdpgBCQbVAQ2YVtsEzyrxN0ZcnkkUE00XRmuBl43DE-_7E3_I2wI9bm_dZA8s22HI0XSJiCbSx_oRsjFk1HXSipOqMG49M6YHTianB6ieo51ablDB8p20a-cZ-GGoBDX4Xg81sGtwwLMwnI4W3dlZiA1A2BOR3tv8yDQkkVhJGLlq7OgJ3bfuS1PlfQJlIZqkvgG_hfbe2BFEtFyCbLm3GyVvCGvSJj8KND-mINhxryic16AIwNRSHtQYXdljfJm4fu2m6kEr94Eq4w5I3EIlHe82zeVSdLaIbw'

Example response

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

{
  "id" : "afb9271f-794c-4687-952b-09740ac2018b",
  "networkGroupId" : "8669ee7c-676d-4fa4-9a0d-a245494daa48",
  "name" : "toDelete",
  "route53ZoneId" : "zoneId-1772",
  "domain" : "domain.io.",
  "validated" : false,
  "createdBy" : "82c68b25-322b-4de4-a0e8-14167737f920",
  "createdAt" : "2025-01-11T20:37:47.260479Z",
  "updatedAt" : "2025-01-11T20:37:47.271967Z",
  "deletedAt" : "2025-01-11T20:37:47.271Z",
  "deletedBy" : "3ae32951-0daa-45df-bd25-17d7b126d409",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/afb9271f-794c-4687-952b-09740ac2018b",
      "title" : "toDelete"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/8669ee7c-676d-4fa4-9a0d-a245494daa48",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/executions/e7c83c39-fb69-41df-a3ac-38c7c59107b6",
      "title" : "Delete DnsZone",
      "profile" : "meta"
    }
  }
}

Get Dns Zone

GET /v3/dns-zones/{id}

Authorization

This endpoint requires read action on the dns-zone resource type.

Path parameters

Parameter Type Optional Description

id

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/v3/dns-zones/654efec3-72bb-4efb-ba58-f660205620c3' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJienB3a1JMLXRteHJzSG1INC1MU2xRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFjODlmMWRlLTJlODktNGUxZC05NmNjLTk0M2EwNDA5MTM4YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NiwiZXhwIjoxNzM2NjMxNDY2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQxNzFhOTI2LWZjNjctNDI5OC1iOTUwLTRjODFmZjM4ZjgxMFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jZdoL0HWk8kKSbE2Y8ge2mcqo91rbgpcEtY_Mc0X0pDsHLdFj0gA_x8z23xVSXjN2eSHAtnnWFlQ9vXd0nwNb3U7R3tbjmMaLi06cBrEdjOzaEKQ3_DgArSPhCGiV0ZJReHACbBkZCb3OVbizTqqD5aYM7aTyLewi1GpJfpmuPNhM7yIi32SC6k9pr2GuonxPS8pCHHrvD6vudhxvJeDDVXQCKmXf1L7HODR2k5ACOiDtncNyJj9HxJxF4o0jQPIn1xiQE6Gv_W8NkGKV7Tp5pq2hDpba2Lynsyw8zduNOhh1mIhbHU9ERRiT9H3hekSXVbiUOVUEgh5-6ewQAuTzA'

Example response

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

{
  "id" : "654efec3-72bb-4efb-ba58-f660205620c3",
  "networkGroupId" : "278475b3-c68b-4729-8037-8067ee006928",
  "name" : "test-v3-domain.com",
  "route53ZoneId" : "zoneId-1736",
  "domain" : "domain.io.",
  "validated" : false,
  "createdBy" : "81358699-3299-44b1-a04f-fbdb4a4ab481",
  "createdAt" : "2025-01-11T20:37:46.995605Z",
  "updatedAt" : "2025-01-11T20:37:46.995605Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/654efec3-72bb-4efb-ba58-f660205620c3",
      "title" : "test-v3-domain.com"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/278475b3-c68b-4729-8037-8067ee006928",
      "profile" : "parent"
    }
  }
}

Find Dns Zones

GET /v3/dns-zones

Authorization

This endpoint requires read action on the dns-zone 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

id

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.eyJqdGkiOiJ2cUN4a1VaMEdlOEUxQ1RUUUViNjlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE5YTM4NjBiLTY1ZGItNDEyYi1hYWI1LTE1ZDVhMTI0MmEyZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NywiZXhwIjoxNzM2NjMxNDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk3ZjgyNTBkLTJjOTgtNDUxYy1hZTFiLTY4MTU1Y2JmYThkMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.kPymClKk9bKXoXpiA9i0cjUyqqkK_vuXhcEuaJBN-NegbHf-_4gvbes6Q3LQcaR7FgW0hSN1ssgeKQvYyBvUU_TpVHizcOfsVs9ms_aVZj-CR4R4-jSYeYtLAFBFqJ9wO3OsWvo4HQC1Wm-6L1pd0eEGIfTPi7uAJk2PPRe4PMG_LgqMRHWymWqPDMFWb31Ut1kCV1nEnMy3V6Use4NOomcbWVEphkVZRIzCGdT8W88XoH1sGDUsYOzHxiyubmExMSQtlJt1E1zlgFcI5A7IoApgKEpTCCAeOTWEnrkkpDur5V5GzxJeNhbOy-isiM_toJhzwPZdIY4tJQM_iYbumg'

Example response

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

{
  "_embedded" : {
    "dnsZoneList" : [ {
      "id" : "07f905ab-f002-4b8d-b53f-82d68fd85b25",
      "networkGroupId" : "84aa7531-cc10-4255-a37b-4eee61b0fd43",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-1750",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "081ecf77-e10e-409c-a168-eab3f259d1b8",
      "createdAt" : "2025-01-11T20:37:47.089877Z",
      "updatedAt" : "2025-01-11T20:37:47.089877Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/07f905ab-f002-4b8d-b53f-82d68fd85b25",
          "title" : "test-v3-domain.com"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/84aa7531-cc10-4255-a37b-4eee61b0fd43",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "1c1fb0a2-4d23-4cf4-9dc4-d84421ff0712",
      "networkGroupId" : "5aef9aad-da7e-4095-8fd5-76c80c869465",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-1763",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "884a173e-4ecf-48fa-aee9-40077456f6fd",
      "createdAt" : "2025-01-11T20:37:47.165575Z",
      "updatedAt" : "2025-01-11T20:37:47.165575Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/1c1fb0a2-4d23-4cf4-9dc4-d84421ff0712",
          "title" : "test-v3-domain.com"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/5aef9aad-da7e-4095-8fd5-76c80c869465",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "1cef3bba-a45c-4b3b-9b0a-ae7879983c3a",
      "networkGroupId" : "3642ad7e-0a9a-4df9-ad83-69b48437340c",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-1767",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "7becc773-a1ca-43f8-8550-efa4b0c26c3d",
      "createdAt" : "2025-01-11T20:37:47.217060Z",
      "updatedAt" : "2025-01-11T20:37:47.217060Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/1cef3bba-a45c-4b3b-9b0a-ae7879983c3a",
          "title" : "test-v3-domain.com"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/3642ad7e-0a9a-4df9-ad83-69b48437340c",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "1d7a684b-6f91-48ee-9c75-7f0f743b833f",
      "networkGroupId" : "84aa7531-cc10-4255-a37b-4eee61b0fd43",
      "name" : "testName-1751",
      "route53ZoneId" : "zoneId",
      "domain" : "domainResult",
      "validated" : false,
      "createdBy" : "5be33f67-19b1-47fb-98c5-0f2efc49c27b",
      "createdAt" : "2025-01-11T20:37:47.115813Z",
      "updatedAt" : "2025-01-11T20:37:47.115813Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/1d7a684b-6f91-48ee-9c75-7f0f743b833f",
          "title" : "testName-1751"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/84aa7531-cc10-4255-a37b-4eee61b0fd43",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "2663dc05-c426-4479-81ac-415d8cf245e0",
      "networkGroupId" : "f178956f-e17c-4828-b01d-1c97c0c524ac",
      "name" : "firstName-1756",
      "route53ZoneId" : "zoneId-1757",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "84670bad-e9d8-4f66-8150-483dae83febe",
      "createdAt" : "2025-01-11T20:37:47.144034Z",
      "updatedAt" : "2025-01-11T20:37:47.144034Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/2663dc05-c426-4479-81ac-415d8cf245e0",
          "title" : "firstName-1756"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/f178956f-e17c-4828-b01d-1c97c0c524ac",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "291e5b8a-fae5-4185-8468-a4656ac64ea8",
      "networkGroupId" : "d5e612be-d86c-4d2f-9708-d2dbf316fd7c",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-1730",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "efd85660-4cc9-4572-89bf-6a227246c0e5",
      "createdAt" : "2025-01-11T20:37:46.888012Z",
      "updatedAt" : "2025-01-11T20:37:46.888012Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/291e5b8a-fae5-4185-8468-a4656ac64ea8",
          "title" : "test-v3-domain.com"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/d5e612be-d86c-4d2f-9708-d2dbf316fd7c",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "654efec3-72bb-4efb-ba58-f660205620c3",
      "networkGroupId" : "278475b3-c68b-4729-8037-8067ee006928",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-1736",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "81358699-3299-44b1-a04f-fbdb4a4ab481",
      "createdAt" : "2025-01-11T20:37:46.995605Z",
      "updatedAt" : "2025-01-11T20:37:46.995605Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/654efec3-72bb-4efb-ba58-f660205620c3",
          "title" : "test-v3-domain.com"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/278475b3-c68b-4729-8037-8067ee006928",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "8872587a-e403-48ad-b3d3-2ef8509c954b",
      "networkGroupId" : "875d98f8-dc6d-4cd1-868e-a8129de6a202",
      "name" : "updated-1746",
      "route53ZoneId" : "zoneId-1745",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "a9513816-5b9d-4fa0-aadb-0d348ba0ea49",
      "createdAt" : "2025-01-11T20:37:47.055512Z",
      "updatedAt" : "2025-01-11T20:37:47.062342Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/8872587a-e403-48ad-b3d3-2ef8509c954b",
          "title" : "updated-1746"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/875d98f8-dc6d-4cd1-868e-a8129de6a202",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "9332a306-01f9-4034-9fae-531d926fd210",
      "networkGroupId" : "f178956f-e17c-4828-b01d-1c97c0c524ac",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-1755",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "d68268d9-5fe1-425e-9b6a-4174030b9617",
      "createdAt" : "2025-01-11T20:37:47.143219Z",
      "updatedAt" : "2025-01-11T20:37:47.143219Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/9332a306-01f9-4034-9fae-531d926fd210",
          "title" : "test-v3-domain.com"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/f178956f-e17c-4828-b01d-1c97c0c524ac",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "9b1a4a45-8fb8-4588-b44b-02534ee78cbe",
      "networkGroupId" : "d5e612be-d86c-4d2f-9708-d2dbf316fd7c",
      "name" : "updated-1732",
      "route53ZoneId" : "zoneId-1731",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "2a01b9af-d53a-4a18-9434-4748288e0fb1",
      "createdAt" : "2025-01-11T20:37:46.889316Z",
      "updatedAt" : "2025-01-11T20:37:46.932358Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/9b1a4a45-8fb8-4588-b44b-02534ee78cbe",
          "title" : "updated-1732"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/d5e612be-d86c-4d2f-9708-d2dbf316fd7c",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "b14ff27f-77f3-40e5-b1f2-082ef84ef785",
      "networkGroupId" : "875d98f8-dc6d-4cd1-868e-a8129de6a202",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-1744",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "c04cd19a-6618-4285-8ca9-561d8f5bab64",
      "createdAt" : "2025-01-11T20:37:47.054675Z",
      "updatedAt" : "2025-01-11T20:37:47.054675Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/b14ff27f-77f3-40e5-b1f2-082ef84ef785",
          "title" : "test-v3-domain.com"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/875d98f8-dc6d-4cd1-868e-a8129de6a202",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "f9cbbfbe-f3e6-40db-8fef-1b8ddb51b8f8",
      "networkGroupId" : "f178956f-e17c-4828-b01d-1c97c0c524ac",
      "name" : "toUpdate-1758",
      "route53ZoneId" : "zoneId-1759",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "98742b1e-720b-4bcc-b190-688e194464cd",
      "createdAt" : "2025-01-11T20:37:47.144527Z",
      "updatedAt" : "2025-01-11T20:37:47.144527Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/f9cbbfbe-f3e6-40db-8fef-1b8ddb51b8f8",
          "title" : "toUpdate-1758"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/f178956f-e17c-4828-b01d-1c97c0c524ac",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "fec35b8f-8e26-4c91-aefc-3a3ee1c84433",
      "networkGroupId" : "f2e3a188-7a2e-4e57-95e2-8ad148fbfcf4",
      "name" : "test-v3-domain.com",
      "route53ZoneId" : "zoneId-1740",
      "domain" : "domain.io.",
      "validated" : false,
      "createdBy" : "170cff0b-9f6c-4b46-aaad-1565bb2d5a93",
      "createdAt" : "2025-01-11T20:37:47.035766Z",
      "updatedAt" : "2025-01-11T20:37:47.035766Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/fec35b8f-8e26-4c91-aefc-3a3ee1c84433",
          "title" : "test-v3-domain.com"
        },
        "network-group" : {
          "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/f2e3a188-7a2e-4e57-95e2-8ad148fbfcf4",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 13,
    "totalPages" : 1,
    "number" : 0
  }
}

Update Dns Zone

PATCH /v3/dns-zones/{id}

Authorization

This endpoint requires update action on the dns-zone resource type.

Path parameters

Parameter Type Optional Description

id

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/8872587a-e403-48ad-b3d3-2ef8509c954b' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5N0Rqek8wQ1hCMHRkT0U0bHBLQWJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ5MDQzOGJjLTMzZDMtNGQ5YS04ZGE0LTcyMjVjMTlmN2EwNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NywiZXhwIjoxNzM2NjMxNDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRkM2ExOTkwLWE1OWUtNGJjYS1iYmM2LWJiOWE4YzNkMmQyY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ImVwZ0bARmeFQybICxokzlWiZ74yQ9PNM_Lb2E5A-fsCiKf3hFO-laeD7qWsGwgRate8kB9UR05Bbp3r97V5vKR4gkRarzg_CO7ZlN_Ds8w8s6HwmagXMV6m1aJ3Ps9anj6PxdhMv85SYiCOOjQ9KgHyzZ6iwl5Xik3JN_42P7GOBjsD6mufvytctoBN-_sXTgUleJHtrTUxSvhaRulXQVvNMZIZRUJDZ7Wn6l-ehil_xsdeTwIFlVZs7nDhAHAaZCvlgneT8PyrJyFDd8cd3IfDo0K763rLeCJ-oKA3ub6e_G1rhZnBeUcpyK1SOzJPORAO9TOGGKxop2Vc9GtxkA' \
    -d '{"name":"updated-1746"}'

Example response

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

{
  "id" : "8872587a-e403-48ad-b3d3-2ef8509c954b",
  "networkGroupId" : "875d98f8-dc6d-4cd1-868e-a8129de6a202",
  "name" : "updated-1746",
  "route53ZoneId" : "zoneId-1745",
  "domain" : "domain.io.",
  "validated" : false,
  "createdBy" : "a9513816-5b9d-4fa0-aadb-0d348ba0ea49",
  "createdAt" : "2025-01-11T20:37:47.055512Z",
  "updatedAt" : "2025-01-11T20:37:47.062342Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/8872587a-e403-48ad-b3d3-2ef8509c954b",
      "title" : "updated-1746"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/875d98f8-dc6d-4cd1-868e-a8129de6a202",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/executions/70170e04-f1c1-435d-9d65-d7fe99acc8e6",
      "title" : "Update DnsZone",
      "profile" : "meta"
    }
  }
}

Update Dns Zone

PUT /v3/dns-zones/{id}

Authorization

This endpoint requires update action on the dns-zone resource type.

Path parameters

Parameter Type Optional Description

id

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/9b1a4a45-8fb8-4588-b44b-02534ee78cbe' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfWF9xTWczOVNLMTh3dERtOWR5RGV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRjNmNmYTc3LTg3N2MtNDlmMS1hMWY1LWUyZjg1YzhkYjUxNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NiwiZXhwIjoxNzM2NjMxNDY2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImY2N2ZkYTNiLTEzMDUtNDFlMy05N2JjLTFhNTg1YTUxYWVkMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Zxv-jGZmp3KEKOEr52jyB40sUQkRA4gMA0M-mHDPCJdu5GF4Kvhp8AFmlB7HBwMFt4F6-H_OEPLAmjuVsmOeCk094jbm7lUKeK7vXm-lQs2NZVv9PdtJ3rZXQbLOrm2U05VLECNlaWRthqkjKAcfScCn5UTZ6LhVMQSC-QENeqbWQmyj1MqaYTOqNec3byPL60mFrE-fg42ntY697zS7Xv7MaDzxcwC2TxfSDxhtpFDr5fR0_j8poBTQt0XyvkQDRgOm4Tkmjiq2ds8dU4XswrOz1ePhhlmVzfo-3e0Q3VmjDbiyFObOZWCskLJohJwbiO7H92a3iVvDp4oFxS2e9g' \
    -d '{"name":"updated-1732"}'

Example response

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

{
  "id" : "9b1a4a45-8fb8-4588-b44b-02534ee78cbe",
  "networkGroupId" : "d5e612be-d86c-4d2f-9708-d2dbf316fd7c",
  "name" : "updated-1732",
  "route53ZoneId" : "zoneId-1731",
  "domain" : "domain.io.",
  "validated" : false,
  "createdBy" : "2a01b9af-d53a-4a18-9434-4748288e0fb1",
  "createdAt" : "2025-01-11T20:37:46.889316Z",
  "updatedAt" : "2025-01-11T20:37:46.932358Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/dns-zones/9b1a4a45-8fb8-4588-b44b-02534ee78cbe",
      "title" : "updated-1732"
    },
    "network-group" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/network-groups/d5e612be-d86c-4d2f-9708-d2dbf316fd7c",
      "profile" : "parent"
    },
    "execution" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/executions/ef84aa5b-597f-476f-a6be-30e6d2f9c0e6",
      "title" : "Update DnsZone",
      "profile" : "meta"
    }
  }
}

Validate Dns Zone

POST /v3/dns-zones/{id}/validate

Authorization

This endpoint requires update action on the dns-zone resource type.

Path parameters

Parameter Type Optional Description

id

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

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v3/dns-zones/252a3249-7f46-4894-9a8c-4931ed1dc317/validate' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJzbnFTWWNfMFV4ajc0bFRKZ0RJandRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY4MjQxZTRlLWFkMTMtNDRiMC05MDdmLWU5NmU0OTY5MDdiNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2NywiZXhwIjoxNzM2NjMxNDY3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjYwODA3MGQ3LTQ1MDEtNDY4YS04OGYxLTE4YmYyNjk3MjViZVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.X0Arl8WaxUDjKDpOGBAzosCkjJLAbMLHoXVAu4Z2kT6FMGT5nU3qx3oWFvgUF-3S0qXUKvUeeTbKfuS_5QCqAaKzquR7w3tlof9Cc08WgjhGI5OPwKN1WWzBzS1LIZB7uhiFYXBlUWdKDH9C2srdDyChQrO6whz47TKIB4Bec52J2zBLBvtp09Fkd7j-zIFlVZLxCFByQhSt29tSi1XrnpArD30Qoczdmd9fACd8UaSV0QBgg-GepTelUQwAf2QWkAegH3Zyyg4l36u02XGquyCmB5Ev7-zUf7BwGC7ED20QsVErAd-5Bt2d88i-F0yYJHxHOhaay-GfQKy5a6yTtQ'

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

BrowZer

Create Browzer

POST /v3/browzers

Authorization

This endpoint requires create action on the browzer resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type 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/v3/browzers' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJCMWdYZE5Xd05XRHBUeEQyUWVZLTVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgzMjQzYTBmLWFhZGItNDFlOS1hNWI1LTI4NzU4NDQxZDBkOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2MiwiZXhwIjoxNzM2NjMxNDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImE0ZWE2MTVjLTAxMWEtNDRiOS05ZTBiLTM4OTdmODk0ZDE5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.sqRVJtqdz7CwdX9rjS933YFAJ130xVCd-ECfPk7t7RXKAP8PsNCbTcb0MfUDlEbjrBoLfqPnveqBaP1-MOGQJh8vSw_7pSGJPOimKfUPLdJ0d3uLlZOdz2ebgLASLgjI44tt1vn4gkZZcvh0MfbPFyzLxg5-MGgweyX8ZfgLeY5chWo4zenT6KZFO5GbbOTebsguzUR8FMe5f9yKp17KJiLsU1JaufCAtMG91gU0voqr9c8yluqyXzUBcnpeFfc7pra9OKI9A1nBkXI3WRh_VTPXW9nqdyHfBhKLPasulHRC5PNQapNGZjB-jEycISnS9oZ6RSw9BE9wHpuREvxfjg' \
    -d '{"networkId":"81675bca-35ec-4d29-8a29-01f6f05bae9b","domainNameLabel":"cxmfmcqa","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" : "0248359a-827c-4344-b950-962fa6f306fd",
  "networkId" : "81675bca-35ec-4d29-8a29-01f6f05bae9b",
  "domainNameLabel" : "cxmfmcqa",
  "createdBy" : "83243a0f-aadb-41e9-a5b5-28758441d0d9",
  "createdAt" : "2025-01-11T20:37:42.237572Z",
  "updatedAt" : "2025-01-11T20:37:42.237572Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "wssListener" : false,
  "publicCertEnabled" : false,
  "bootstrapper" : false,
  "executionId" : null,
  "status" : "ERROR",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzers/0248359a-827c-4344-b950-962fa6f306fd"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/networks/81675bca-35ec-4d29-8a29-01f6f05bae9b",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=81675bca-35ec-4d29-8a29-01f6f05bae9b&wssListener=true"
    },
    "browzer-bootstrappers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-bootstrappers?networkId=81675bca-35ec-4d29-8a29-01f6f05bae9b"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-apps?networkId=81675bca-35ec-4d29-8a29-01f6f05bae9b"
    }
  }
}

Get Browzer

GET /v3/browzers/{id}

Authorization

This endpoint requires read action on the browzer resource type.

Path parameters

Parameter Type Optional Description

id

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/v3/browzers/8dd2205f-58fd-4da4-be41-af02b24e14a1' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJlM3h6Zk1VcjJrMnZkMmFWWGEzNUpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI1NzI2ZmQ1LWFlM2EtNGE3Yi1hNzBiLTUxNmNkMjFiNzYwYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2MiwiZXhwIjoxNzM2NjMxNDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjUxZGQ0NDRjLTZhN2YtNGJmNy04YmY1LTAwMmJjNTU1YzcyNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.O2RzSjEwDz35FC2-7lTcIwnAvIMD4BD3MKluIFJi0iKPrj5kIF1ZBcXM6ljbE8C4Dhky9xM2noe5WULTXm2QsIXk3-ABDNrpFTYYPvrFrIj_gqrFAORGq7wm_vl80djVk3J1QUhW7yFgbETH0E8rxtrbhJ91ne54lNbYPu7m3qtUzDZIt998OXAnISYBx13LXV0It_8ZGcPTgnkfve9Gcr9-EEMFkVFMQk9wdUWCleJ_xojll1MGiNaI46TlPJfOQQpzvjIJjqjNtWiIfhQm_frZAG7h6BBiMwneG0S5Qsm-1O_Vol6MGIxNaeVfA74u0lPo-a2m91WwmcXxexnfqQ'

Example response

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

{
  "id" : "8dd2205f-58fd-4da4-be41-af02b24e14a1",
  "networkId" : "f7c6f435-c32d-4dbd-8fcd-1a4720d2bb9f",
  "domainNameLabel" : "-aAA9zZ9",
  "createdBy" : "a49485c9-10cd-43b4-b7bc-89d066a6ede1",
  "createdAt" : "2025-01-11T20:37:42.529637Z",
  "updatedAt" : "2025-01-11T20:37:42.529637Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "wssListener" : false,
  "publicCertEnabled" : true,
  "bootstrapper" : false,
  "executionId" : null,
  "status" : "ERROR",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzers/8dd2205f-58fd-4da4-be41-af02b24e14a1"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/networks/f7c6f435-c32d-4dbd-8fcd-1a4720d2bb9f",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=f7c6f435-c32d-4dbd-8fcd-1a4720d2bb9f&wssListener=true"
    },
    "browzer-bootstrappers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-bootstrappers?networkId=f7c6f435-c32d-4dbd-8fcd-1a4720d2bb9f"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-apps?networkId=f7c6f435-c32d-4dbd-8fcd-1a4720d2bb9f"
    }
  }
}

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

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

id

String

true

networkId

String

true

domainNameLabel

String

true

Once set to a non-null value, it cannot be updated. The value must be unique across all Browzer instances for all customers. Domain Name labels must start with a letter and must end with either a letter or number. Characters within the label (ie, neither first nor last character) must be a letter, number, or hyphen. A domain name label has a max length of 63 characters and the overall domain name can not exceed 253 characters.

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.eyJqdGkiOiIxSWQtaVl4MVB4Wk45T3l2QnMwUmlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcxNTY4YzA2LWJkZTEtNDM2MC1hZDkwLTA5OTZlMWFlZDkzMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc5NiwiZXhwIjoxNzM2NjMxMzk2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImIwMDE3MTJkLTE5YjQtNDhhYy1hNDc1LTgwYWUxZDJjN2Q1NlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5Nn0se1wiaWRcIjpcIjZiZTlkMjFkLWI2ZTUtNGY0Yy05NjFjLWI3YzFhNTNjY2RlM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc5Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.B3lK4BeX0kjvI7bG836R41V5hhh1V4uwILZ5W1KQG8MzX9uOAlgUBKWxqtuH4hrn8sSatAaM8nwE2YeBQCEOqnB_U3_rRFDsBRKbi_gQhbFALPur1Av4MmAEa4o1H7yfOlHTyQuDBntGF-OPo_c2ru1B6OMxfDp9IUt590HeF3UcT4PBt3OWQJWG_83GwKnBU4O7BX3fCfw_WYIjhbqOhGkcLmNwCWOgUoAW-ssoQJb50KDw3DU2MTCIDIWvIe4sWYESFXU-T8M4q-_wIMve_BucYSi989hs7_ZHxKxg8RO9Qo8gHPvPxOjIMyYuzAgiEy3Y1dyORW2gMUdn4txxvA'

Example response

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

{
  "_embedded" : {
    "browzerList" : [ {
      "id" : "6a0b59b2-9682-4e2a-be3e-459f131bc94d",
      "networkId" : "4e425f20-e87b-403d-937e-eb69d90ea8db",
      "domainNameLabel" : "9a--0--9",
      "createdBy" : "9a9a44b9-6563-4d86-8d5f-7fa245cb62d2",
      "createdAt" : "2025-01-11T20:36:36.149772Z",
      "updatedAt" : "2025-01-11T20:36:36.149772Z",
      "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/6a0b59b2-9682-4e2a-be3e-459f131bc94d"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4e425f20-e87b-403d-937e-eb69d90ea8db",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=4e425f20-e87b-403d-937e-eb69d90ea8db&wssListener=true"
        },
        "browzer-bootstrappers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers?networkId=4e425f20-e87b-403d-937e-eb69d90ea8db"
        },
        "browzer-apps" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=4e425f20-e87b-403d-937e-eb69d90ea8db"
        }
      }
    }, {
      "id" : "f3f09db8-e667-42cd-b590-3b391dca0d45",
      "networkId" : "5beaf0b9-2e76-439d-88cd-9529b2a9dad0",
      "domainNameLabel" : "AZ--A9A-",
      "createdBy" : "232f1981-5d9c-4813-a90a-dd17638d4e85",
      "createdAt" : "2025-01-11T20:36:36.147938Z",
      "updatedAt" : "2025-01-11T20:36:36.147938Z",
      "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/f3f09db8-e667-42cd-b590-3b391dca0d45"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5beaf0b9-2e76-439d-88cd-9529b2a9dad0",
          "profile" : "parent"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=5beaf0b9-2e76-439d-88cd-9529b2a9dad0&wssListener=true"
        },
        "browzer-bootstrappers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers?networkId=5beaf0b9-2e76-439d-88cd-9529b2a9dad0"
        },
        "browzer-apps" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=5beaf0b9-2e76-439d-88cd-9529b2a9dad0"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzers"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Update Browzer

PATCH /v3/browzers/{id}

Authorization

This endpoint requires update action on the browzer resource type.

Path parameters

Parameter Type Optional Description

id

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/v3/browzers/8fde65ae-6f87-4cd3-bef2-4ac723449014' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJHbnFwSnhTTUVNZmZYa3F3cVEyVFJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjIzNjg5N2FlLTc0MWYtNDI4YS1hNGYwLTRkMGFkNzBiODFkMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2MiwiZXhwIjoxNzM2NjMxNDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU1YjljMDRiLTQyMGMtNGYwYy04OWRjLTFiMjU5MjY4ZGE4OFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Gk7qoWSn6_Vm1jaLzcCubG8t6ONbb2gg2QSHcR_xLZiezotleYb9rA2DnWs3ATZlcQPkWAWAnvS3_hYllaZn96-Nk12hW7p2wVfQsfeHfoQ5A0D5_v1ACa7astebKiHSdCj5INRgxXO6N6uci4vVCwXoJg89WWC4XkznxycbmNmPxtaSJupP6rpqtT85AWmEFb1uVmgSNerLKACKE8By7CGI0Z_z9FhiCCXcxRfRuIIpc_TPZpJCZFDG6NRgMYPkuZ6GsOeQNvobcARZ8I366TwYn6QxUo-K1CCtbQGpCHOcfs4fok8ZqR4Axu4-k92vCOMg7KllzXZKmX4ok3Un0Q' \
    -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" : "8fde65ae-6f87-4cd3-bef2-4ac723449014",
  "networkId" : "627194db-a640-4e5b-955e-c94063154337",
  "domainNameLabel" : "0Zz9--Aa",
  "createdBy" : "a86d2a74-3ffd-4833-90c9-4da919245983",
  "createdAt" : "2025-01-11T20:37:42.615656Z",
  "updatedAt" : "2025-01-11T20:37:42.615656Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "wssListener" : false,
  "publicCertEnabled" : true,
  "bootstrapper" : true,
  "executionId" : null,
  "status" : "ERROR",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzers/8fde65ae-6f87-4cd3-bef2-4ac723449014"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/networks/627194db-a640-4e5b-955e-c94063154337",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=627194db-a640-4e5b-955e-c94063154337&wssListener=true"
    },
    "browzer-bootstrappers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-bootstrappers?networkId=627194db-a640-4e5b-955e-c94063154337"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-apps?networkId=627194db-a640-4e5b-955e-c94063154337"
    }
  }
}

Update Browzer

PUT /v3/browzers/{id}

Authorization

This endpoint requires update action on the browzer resource type.

Path parameters

Parameter Type Optional Description

id

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/v3/browzers/c7161125-4fe6-4f44-ad67-c710ad7fd4b7' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJVOHcyRjAyWUlMZF8tQzZsNmhISl9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcwMzUyOTcyLTNlZDMtNDg0YS1iZTZiLTkzMTY4ODhiOWE3MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzg2MiwiZXhwIjoxNzM2NjMxNDYyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU4YTlkNTYzLTg5MTgtNDQ4My05ZGY3LWM5ZDVjYTg1ODgxZlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzg2Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Kjm3Zig1CgXprjCR1ldYZgeIA2Q-Kkbl4NuU38_iA148eZVAwsqjPoRtnlhKC2lZJQpULcuKdfV3uezaUKrtAUe_5smNCZmPSqrvQxjSnhdRS7Hfa3Veh5vFcTTt1lVJMX604FKu4TtHa9Q5qo_MVQOlhXif-ohZHBJBF5UMJe09TGMmStIWv7QCJ4hXv6NZhDDYzBngUwpzmf-wZp8ohy-f6vamxfSnw1gkfxq0OH8K5qepwNqQOiAd6ww_GcD7mbUDkiClqZWC1rQWOw6zdP7ZLSzl0C7tkBIje6-He_YcJ0WJOQ0xAsduoU5Bi-uaobh_dcVr4_2FaS5lCuOZJw' \
    -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" : "c7161125-4fe6-4f44-ad67-c710ad7fd4b7",
  "networkId" : "98e0470b-9e0c-4c52-8e8d-cd50a43545e9",
  "domainNameLabel" : "--AZ--9z",
  "createdBy" : "fbbab290-6b41-418c-9d33-2c757b29ba3b",
  "createdAt" : "2025-01-11T20:37:42.457036Z",
  "updatedAt" : "2025-01-11T20:37:42.457036Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "wssListener" : false,
  "publicCertEnabled" : true,
  "bootstrapper" : false,
  "executionId" : null,
  "status" : "ERROR",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzers/c7161125-4fe6-4f44-ad67-c710ad7fd4b7"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/networks/98e0470b-9e0c-4c52-8e8d-cd50a43545e9",
      "profile" : "parent"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=98e0470b-9e0c-4c52-8e8d-cd50a43545e9&wssListener=true"
    },
    "browzer-bootstrappers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-bootstrappers?networkId=98e0470b-9e0c-4c52-8e8d-cd50a43545e9"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-apps?networkId=98e0470b-9e0c-4c52-8e8d-cd50a43545e9"
    }
  }
}

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

id

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

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzers/7c3aecda-0568-4e62-b08d-a8537261a561' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'nf-validate: ' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJQNlkxNzh1UTlOeENGcDVkbFJ2Wk5RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ4ZGRlMDIxLWFmMzYtNDRmMi05MmJhLThiYTc2MWVmYmIwYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc4MiwiZXhwIjoxNzM2NjMxMzgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFhNWNlMWFiLTQ4YjItNDVlNC05ODAxLTViYmQ5Y2JhODFlY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc4Mn0se1wiaWRcIjpcImRhNTE5ZWVjLWRjZWYtNGVlYi04ZTU5LTIxZTQxNGI3OGZmMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc4Mn0se1wiaWRcIjpcImY1YzhlOTA3LTRhNjQtNGEwNS05ZDllLTAwYTExZWVhNzdjMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc4Mn0se1wiaWRcIjpcIjM4NzM3NjFlLTc3MzItNDA0Zi04MzQwLTczN2JhNzQ3Nzg0ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc4Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.I_d-aH_fDy_z9hRnFA_rGN4INp4Fk_9F_fhrTK2JlGjbs3mdy4OyzoO0cnpQzOPE1grdzv4Tj_nai8SMFLz1OOY99xXtqUX7TLACUXAIamYvJphZ5CgvSy8KKXQsBG-I3pWfTS3tVlQTioTpFArYqNwpGKNqr-2mBiOU9-tXew46Mc89VwM6L-wxNhQOfWD-OZ4mG6AlQBpHGva7isGvT0iHtoWHDUoFB8cI7kwNn6TbwgGFg_udzzIb1nMAaagHNs3jnpK894fTk7p50EpHTbSzseoPhiYa3d6wpuumJ8DKHtsDUk5dSWe6r-p2TUikdaAS3pVvmn5a8OOfOZlUPg' \
    -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."
} ]

BrowZer Bootstrapper

Create Browzer Bootstrapper

POST /v2/browzer-bootstrappers

Authorization

This endpoint requires create action on the browzer-bootstrapper resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path 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

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.eyJqdGkiOiJjLW9uSHVUOGVnNWZDYzZHMnAwc013IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk1NTZhYjRlLWZkZGMtNDZmNS04MjhiLTM3YWQwMTRmMzI4ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgxMSwiZXhwIjoxNzM2NjMxNDExLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgyZDIyMTZiLWQyZDYtNGVmOC1hNWM5LTAyYjEwNDg0NjdhNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgxMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.fXlZ35lx6mJTtRzFV6U7eAwuq6Zzr0-NJz9kQgfU1386pPPRNhBRzxS4mLsIqx2X7SSz5clGsgXqQ2pJpbArBqYsrgMbQTGblEWQiMqNi5-Ep7txa8LraX2qS5eFOEVf1Phfvgr0yEAx-RZNPIi_U3wMtaGMh8umnLqCJIHIiQF_1cxcyTCVNklfA_4L94ZMpvYwzdVR-SvlDIBWMOMCPifoqRgfWYWOndd3YHmqzacbGz-K6v6HmeRQDA4H-0o3qS08u0j-UbUBzuzceF_3RUh2f4IbXvTMdgfBltHv2lYUH1sR6bWy_xDhqR_kNffIcl34NIpUcD-JjrUEvePfbA' \
    -d '{"networkId":"5831085f-33ba-4433-87f1-0ba5bb38f1bc","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" : "e83b29b7-1207-4edc-bff2-fb41c1702391",
  "networkId" : "5831085f-33ba-4433-87f1-0ba5bb38f1bc",
  "createdBy" : "c29c12e5-94f1-4c11-90a5-19f6fe7fa668",
  "createdAt" : "2025-01-11T20:36:51.423553814Z",
  "updatedAt" : "2025-01-11T20:36:51.423553953Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "containerId" : "16752d1b-47e7-4b49-9798-8a5b0d7bfe05",
  "status" : "PROVISIONING",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/e83b29b7-1207-4edc-bff2-fb41c1702391"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5831085f-33ba-4433-87f1-0ba5bb38f1bc",
      "profile" : "parent"
    },
    "container" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/containers/16752d1b-47e7-4b49-9798-8a5b0d7bfe05"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=5831085f-33ba-4433-87f1-0ba5bb38f1bc"
    }
  }
}

Get Browzer Bootstrapper

GET /v2/browzer-bootstrappers/{id}

Authorization

This endpoint requires read action on the browzer-bootstrapper resource type.

Path parameters

Parameter Type Optional Description

id

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/browzer-bootstrappers/9eac5a6c-bad7-45d7-932b-23a0fb1388c7' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJGQi1aLWJNVE55WER3WFN6Y2xLSVJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI5OWZmZmRhLTgxZTctNGY4Yi1hNzc4LWExN2QwYTIzNTdmYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgxMSwiZXhwIjoxNzM2NjMxNDExLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImJkY2QxYmI5LTJlMjMtNDdiZC1iNWUxLWY3NjhkMjI5NjhmY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgxMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Xz-MZZUz0aSlgRFC3WJ7Ac3lhgq1o5FSQBPrCTWzQKI1SDojnTcxFWK0ZYmPzHwIm8PUhvuFzpU0BnHljsKxXzBtMhc1BBL2-LYTMo0acMbCTuYXHhPtfsBEP4hCUPs5Y-LZy7E4wbsZ-8NSuQqCyooY6lJCc3UeB6JhirVRvbt_CPidwMpMhOhqRzk64_7qWBqxRBzu_bhc7CV-2ngD_PZPN4HqT0Q7mSjDGC_Z18IlvcRxrMKC2kIg3H9moHiDL0NC6uNtmvRyAgpVGay7j6YeIqPz2PH_rON1n6scP_zyp3xscwBK6uLj2GNcq-9iacwzE7EmKsvGdUmFsO4F2Q'

Example response

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

{
  "id" : "9eac5a6c-bad7-45d7-932b-23a0fb1388c7",
  "networkId" : "5831085f-33ba-4433-87f1-0ba5bb38f1bc",
  "createdBy" : "f9e4f794-262a-47f9-bd5b-ecebe8a83b1b",
  "createdAt" : "2025-01-11T20:36:50.963241Z",
  "updatedAt" : "2025-01-11T20:36:50.963615Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "containerId" : "a52a4788-db0e-4f67-8459-99243b422e81",
  "status" : "PROVISIONED",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/9eac5a6c-bad7-45d7-932b-23a0fb1388c7"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5831085f-33ba-4433-87f1-0ba5bb38f1bc",
      "profile" : "parent"
    },
    "container" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/containers/a52a4788-db0e-4f67-8459-99243b422e81"
    },
    "browzer-apps" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=5831085f-33ba-4433-87f1-0ba5bb38f1bc"
    }
  }
}

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

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

id

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.eyJqdGkiOiJWdDJoT0cyS05NMER0Y0dYMUN2X3pBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMwZGY5YTc1LTI2NTMtNGM2Ny1hZDk3LTNkZDhkMjBmYWZhNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgwMywiZXhwIjoxNzM2NjMxNDAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdhMGQwNTY5LTEyODgtNDFkOS05NjA1LWNiZmVhOGZkNmE1MVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgwM30se1wiaWRcIjpcIjUwNDk1MjYxLTIwMWMtNDczMi05ZjFmLTYwMjM1MmQ1Nzk1YVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.nEANi3FDDgasUE4ebGTekAywSFV8nAZUXDnEU3nY5V6vZXRrw4BiDoADF-GFmL3gV2PUgTBSTIsza4BeXbr0KZTT4S246HaPwOSgME1CroWazWTklZQgMXk-9YFa1xaAktE_Xqaj0SW0Z8s_djUxAA4t3P1p-uWV2S7zLv0VGkbSsnW2MdMpSpYI_TRF5fHoNQnT86ODDtPaAhHDFmhDm6pqzx8tTZTDUnqdiPDIsEWgW16rwi-0GpDDYNCHwF9KWkMvde59ULIpSY6ckp_8RBMbgnLZwjipfReVlK9ZKmGn9-H_EwwE1fGM9K54KMmlZx9ZjfRlcA04Ex8dMzESlg'

Example response

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

{
  "_embedded" : {
    "browzerBootstrapperList" : [ {
      "id" : "26907af9-0f5a-431f-b299-2debfc54d50d",
      "networkId" : "459aa426-1ec1-47fe-b316-bfc916f854a4",
      "createdBy" : "3d3384e3-bec5-4621-b676-dc7e37a786d2",
      "createdAt" : "2025-01-11T20:36:43.394058Z",
      "updatedAt" : "2025-01-11T20:36:43.394458Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "containerId" : "2d7aa37c-9ef9-4c10-95ce-527a80b9b83a",
      "status" : "PROVISIONED",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/26907af9-0f5a-431f-b299-2debfc54d50d"
        },
        "container" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/containers/2d7aa37c-9ef9-4c10-95ce-527a80b9b83a"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/459aa426-1ec1-47fe-b316-bfc916f854a4",
          "profile" : "parent"
        },
        "browzer-apps" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=459aa426-1ec1-47fe-b316-bfc916f854a4"
        }
      }
    }, {
      "id" : "29af3031-e6f7-45d0-a807-06e3fe6d379f",
      "networkId" : "d86a8e98-ad2a-429a-9a0e-996329bcab5d",
      "createdBy" : "42c49619-dab3-435a-9018-a2dee529deba",
      "createdAt" : "2025-01-11T20:36:43.390372Z",
      "updatedAt" : "2025-01-11T20:36:43.392453Z",
      "deletedBy" : null,
      "deletedAt" : null,
      "containerId" : "ff26f75b-47ca-4c01-aaab-ecb8fdaed340",
      "status" : "PROVISIONED",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/29af3031-e6f7-45d0-a807-06e3fe6d379f"
        },
        "container" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/containers/ff26f75b-47ca-4c01-aaab-ecb8fdaed340"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d86a8e98-ad2a-429a-9a0e-996329bcab5d",
          "profile" : "parent"
        },
        "browzer-apps" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps?networkId=d86a8e98-ad2a-429a-9a0e-996329bcab5d"
        }
      }
    } ]
  },
  "_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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path 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

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ 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.eyJqdGkiOiJIS0dYR18xakQ4aEdWZ1B1YTdPQ3FnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA5NjA0ODk3LTg0NDYtNDc0NC04MGM3LTBkOTlhMTVkMTQ5YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc2NCwiZXhwIjoxNzM2NjMxMzY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZkZTYyMmExLThmODAtNDU3OS1hOGI2LTAxMDAxNDJlZGMxYVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2NH0se1wiaWRcIjpcImQyNTJmMThiLTZlYjItNDYxYi1iNjYyLTFhNWRjMDhkNTRkM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2NH0se1wiaWRcIjpcIjNiNmQ2ZGQ5LWQxNTgtNDgxYi1hNDAyLTkwMzM4MmRlMjM1OVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2NH0se1wiaWRcIjpcIjFkOTEwYTEwLTczN2ItNDdjMS1iM2MxLTNiMzhiZjhkYTJmMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.XgO8nUDmJD_f-JV4onsgyoIU66rDj7DyoTYqLwa7Dbz8vgxYgnfGFgqbJh0ARsSEbKT38es6LPM6dg-qyCiW2hfOMmdYZL84EA-F3VhN_gpJ6d8_RgD8OuUkqGFsIaOkKE_aSgCLLUeCBESE0MS7XDT2Jj2_BvbloL2gZir35wgKkfAAVw3soDAryVfVEREG51zkTP72nJDA6q3u8yZmSnxSqRqRBfZKZ3wFXJDJGbXT46leT7H4Y9zIBQyWfiJPBfTCmk77G3LzY-6Haq3PZaJH1f-WKcwyATUDG2H9iJKZ3NjF45lR6l3yUUB4eG8txCsfkp5Otcq0zbYbSo8hCQ' \
    -d '{"networkId":"962d0f16-17ac-4280-8217-70fdf6df4cc8","provider":"AWS","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."
} ]

Delete Browzer Bootstrapper

DELETE /v2/browzer-bootstrappers/{id}

Authorization

This endpoint requires delete action on the browzer-bootstrapper resource type.

Path parameters

Parameter Type Optional Description

id

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/browzer-bootstrappers/9eac5a6c-bad7-45d7-932b-23a0fb1388c7' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJMTHhVblJwWjYxMGRNZGxfT0ZiQ25RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ1YzAwZDE1LWU3OTAtNGViMS05NWQxLWRhMjE2MzEwNmVlMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgxMSwiZXhwIjoxNzM2NjMxNDExLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjAxMWY5ZDZiLWVjYzYtNDE4NC1iZmE4LTY1NjhkODZjZmMwMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgxMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.O15wY4PnYa74o4-fbVLzwpTQV272mu_XfS-NQQsuf2-gdsiuMvpb7lTBpX6E8b1CWxHA24u2EDOB6HjY0rfXVX86NgFWXvet_yMEvRyz-w5HRVd_VMZiSnn30052s4jrPsCd4s5amycUZZ-LmdA4LDQ6DS85QO7OuDOaOJpqMd5PpGSY-3bnnJQ6zyYuLVXcTY9FOvGt2eFMOIrtXJ6J7EU2kS3PVEe1NjJqpXVYtwwmcXexqPzt5HCsRt0Xof7AZcCGSXDIMi_E85oJ7_Cum03Xx-g4SCL0-b2tB8nk2sXnjkGe6VMaJr2zlTw90rycDkGvWC-liAXz7asVtG0XnQ'

Example response

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

{
  "id" : "11dee260-cc5c-48b1-9f2c-95df7ee4ac48",
  "networkId" : "5831085f-33ba-4433-87f1-0ba5bb38f1bc",
  "createdBy" : "e7b9555c-7d98-4354-8aa6-06d586f9ddb9",
  "createdAt" : "2025-01-11T20:36:51.326745326Z",
  "updatedAt" : "2025-01-11T20:36:51.326745432Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "containerId" : "737e6c51-f92e-4b3b-a009-04280dc947ec",
  "status" : "PROVISIONING",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-bootstrappers/11dee260-cc5c-48b1-9f2c-95df7ee4ac48"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/5831085f-33ba-4433-87f1-0ba5bb38f1bc",
      "profile" : "parent"
    },
    "container" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/containers/737e6c51-f92e-4b3b-a009-04280dc947ec"
    }
  }
}

BrowZer App

Create Browzer App

POST /v3/browzer-apps

Authorization

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

name

String

true

path

String

true

serviceId

String

true

Deprecated. In favor of the zitiServiceId property, will be deleted 4/1/2024.

@deprecated in favor of the zitiServiceId property, will be deleted 4/1/2024.

zitiServiceId

String

true

When creating a Browzer App with a ziti service id, as is required in v3 API, this property is required. However, a Browzer App may have a null ziti service id after creation as a result of the deletion of the service in ziti.

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/v3/browzer-apps' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJUZXBwNFNvYXNZSGJsQ3RZazk4bzNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI1OWE2M2JjLTliYmItNGQzNi04MmE5LTJkN2M0ZTJiNjE5NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgzMSwiZXhwIjoxNzM2NjMxNDMxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjc2ZDc0ZTU5LTg2YTUtNGE3Mi05NTVlLWFmYzFiMTZmMWJhOVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgzMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.nl0BY5TCfQhlxcmVAYmysQDddO2BoPyc_Ufd2ZpCQlJVJu0pZKH-7MFWrCiCzSu-pjJcCs6ieMh-aT-AcQGL-UzXWTaNUfIiy572bhptavLup_yaZywq01Mn8_2WYslx_hm8KNwzjVUuYEdhnomkjGEnvcUa-j1sWCzBbPhaAP9xj80qf4EVMQ4fTaqoP8sEqYLOAz1OpO_2srg7TMVGlX4dBzdGksJih9BcYCgbetIzF_v1A9DGofQaL1GzhdXXQ8uyjeECku0CssWQTnl_Yrgwuh72IAL55q0_mMvRh9WCEkDCtz-qAssk5D_qoYInfPZIgFR_alIHxGkLjE97fw' \
    -d '{"networkId":"e6130920-9f42-4b96-bbf5-064af06c16be","name":"tepWqojea1qTm14zD4bpg","path":null,"serviceId":null,"zitiServiceId":"ziti.id.d3mmd3jw","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: 1119

{
  "id" : "72ea3539-b28e-48b7-b798-f78a5cf8ffa7",
  "networkId" : "e6130920-9f42-4b96-bbf5-064af06c16be",
  "name" : "tepWqojea1qTm14zD4bpg",
  "path" : "/",
  "serviceId" : null,
  "zitiServiceId" : "ziti.id.d3mmd3jw",
  "tunnelHttps" : false,
  "access" : {
    "domainNameLabel" : "test-02",
    "dnsZoneId" : null,
    "fqdn" : null
  },
  "auth" : {
    "baseUrl" : "https://fake.com",
    "clientId" : "fake",
    "type" : "OIDC-Default"
  },
  "createdBy" : "259a63bc-9bbb-4d36-82a9-2d7c4e2b6194",
  "createdAt" : "2025-01-11T20:37:11.923191Z",
  "updatedAt" : "2025-01-11T20:37:11.923191Z",
  "versionDate" : "2025-01-11T20:37:11.922482Z",
  "appliedAt" : null,
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "status" : "NEW",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-apps/72ea3539-b28e-48b7-b798-f78a5cf8ffa7",
      "title" : "tepWqojea1qTm14zD4bpg"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/networks/e6130920-9f42-4b96-bbf5-064af06c16be",
      "profile" : "parent"
    }
  }
}

Get Browzer App

GET /v3/browzer-apps/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/v3/browzer-apps/abbab856-5aaa-40f8-9fd1-62377ce482dd' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyNjFZQTVER0ZFR0hOOHUwQnRtcDJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ2NzVjMmU0LTJhOWUtNGI5My04ZTJkLWVjZmJmZjFkNmU1NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgzMSwiZXhwIjoxNzM2NjMxNDMxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ1YmYzNDhlLTY4YWItNDNhNC1hODk1LWEyM2I5YTcxMTc5NlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgzMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.HOeyqGjmIpDFt9DVf5KQn6Uy-qt07cfw9VWbEzdzzbp9y0vTIzyWnmlqki882wFLbGl8JEXh4mqRgQ_zkrRxuxBKAVS1fwZt7VcRGAblpfHLKNlQ2AKbhQZIA1OX-s02XgMpgxb7HSHGICbRBf4q2a4gI9evZ6R0QwP28oSx4P7llYayOvimtSRZuuoFpGG_UkzkFdyXrl83T07evxg1-f4sp5IX_-jZERHxeKWN0GoFsb_RmC-3oTzJB-FvZSqKGZcn-YxXgo0lM7OxZ4eAzNqFQ3lnxLL82pgPbVti3oNp25VSe1qrJZykhIsiHyjUfQxTEyjz91sIUGjnlAqFxA'

Example response

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

{
  "id" : "abbab856-5aaa-40f8-9fd1-62377ce482dd",
  "networkId" : "e6130920-9f42-4b96-bbf5-064af06c16be",
  "name" : "browzer-app-1181",
  "path" : "/",
  "serviceId" : null,
  "zitiServiceId" : "zitiId-1182",
  "tunnelHttps" : true,
  "access" : {
    "domainNameLabel" : null,
    "dnsZoneId" : null,
    "fqdn" : null
  },
  "auth" : {
    "baseUrl" : "https://foo.bar",
    "clientId" : "12345",
    "type" : "OIDC-Default"
  },
  "createdBy" : "56833906-f45d-4c66-a642-e46182bbe0bd",
  "createdAt" : "2025-01-11T20:37:11.509915Z",
  "updatedAt" : "2025-01-11T20:37:11.509915Z",
  "versionDate" : "2025-01-11T20:37:11.508637Z",
  "appliedAt" : null,
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "status" : "NEW",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-apps/abbab856-5aaa-40f8-9fd1-62377ce482dd",
      "title" : "browzer-app-1181"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/networks/e6130920-9f42-4b96-bbf5-064af06c16be",
      "profile" : "parent"
    }
  }
}

Find Browzer Apps

GET /v2/browzer-apps

Authorization

This endpoint requires read action on the browzer-app 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

id

String

true

networkId

String

true

name

String

true

path

String

true

serviceId

String

true

Deprecated. In favor of the zitiServiceId property, will be deleted 4/1/2024.

@deprecated in favor of the zitiServiceId property, will be deleted 4/1/2024.

zitiServiceId

String

true

The ziti service entity’s id that this Browzer App exposes. This property must be set to a valid service within the ziti network, or this Browzer App is not in a deployable state. This value may be null if the ziti service that this Browzer App points too is deleted after creation of this Browzer App.

tunnelHttps

Boolean

true

When true, the Browzer runtime will force requests to the "primary" service to be https. When false, it will force requests from the public origin to the "primary" service to be http.

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

True if this resource is in either a deleting or deleted state, false otherwise. This property provides a more convenient search term than using {@link #deletedAt} directly, and this property is computed based on the {@link #deletedAt} property being null.

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.eyJqdGkiOiItdGJqSDZZck1aQmVKTC04ZnpRMnlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE4NzQ5Yzk1LWUzNGUtNDE1YS05YWZiLTBjM2RjMTI0MjFiMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc0OCwiZXhwIjoxNzM2NjMxMzQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjI1OGM1ZTFmLTYyYzMtNGU2Zi1iNzliLWIyODNmOWJhNWIzNlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc0OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.GK7eVVKdC672Y09wemGszWNjPzWEoKeAhRJ-G4twTBvKsspHdWAKF9hGiV_P2ceCerclfyZa65YqGyQ7WxLpaYoaBhTk8MHDq4OL333rRksrfbFHikUZ7cQWzdRkGrxb-e85i6RKC1SbRwjcXfbvkKsf4ueIewz7AfIT_yQsW0-icgrAtKzQzDBOSGBe_mV-eJagyE4hJqT0OocQXHNy63tNA-_yiqrW6zg0IpZ-2O6_pu5N9UAIcro9j8QrkJCbpLm60Mokbgb5W7l0-HjzHZK2TztkJFbd3fQxfx4K0U1oMUSu6rLX2807iOSF7YiaB6FcrJfVolH68CzsKgjRTg'

Example response

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

{
  "_embedded" : {
    "browzerAppList" : [ {
      "id" : "068f61c5-415f-472a-9ba2-c9aa943e64b6",
      "networkId" : "ba160495-2b62-4e62-b783-096143d62cf1",
      "name" : "app one",
      "path" : "/some-path",
      "serviceId" : null,
      "zitiServiceId" : "zitiId-27",
      "tunnelHttps" : true,
      "access" : {
        "domainNameLabel" : "app1",
        "dnsZoneId" : "4990c9bd-d717-4950-aa6c-7e7fe036fb9e",
        "fqdn" : "app1.fake.nf.io"
      },
      "auth" : {
        "baseUrl" : "fake.nf.io",
        "clientId" : "12345",
        "type" : "OIDC-Default"
      },
      "createdBy" : "6437aa0a-89aa-4939-9c84-d6b093275b7a",
      "createdAt" : "2025-01-11T20:35:48.266317Z",
      "updatedAt" : "2025-01-11T20:35:48.321107Z",
      "versionDate" : "2025-01-11T20:35:48.283186Z",
      "appliedAt" : "2025-01-11T20:35:48.283186Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "deleted" : false,
      "status" : "DEPLOYED",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/068f61c5-415f-472a-9ba2-c9aa943e64b6",
          "title" : "app one"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ba160495-2b62-4e62-b783-096143d62cf1",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "2ab2a657-c616-4da5-88d6-05b86685219a",
      "networkId" : "ba160495-2b62-4e62-b783-096143d62cf1",
      "name" : "app two",
      "path" : "/",
      "serviceId" : null,
      "zitiServiceId" : "zitiId-28",
      "tunnelHttps" : true,
      "access" : {
        "domainNameLabel" : "app2",
        "dnsZoneId" : null,
        "fqdn" : null
      },
      "auth" : {
        "baseUrl" : "fake.nf.io",
        "clientId" : "12345",
        "type" : "OIDC-Default"
      },
      "createdBy" : "9b555ed0-0610-4065-b402-14ce2a976468",
      "createdAt" : "2025-01-11T20:35:48.291029Z",
      "updatedAt" : "2025-01-11T20:35:48.291029Z",
      "versionDate" : "2025-01-11T20:35:48.286036Z",
      "appliedAt" : null,
      "deletedAt" : null,
      "deletedBy" : null,
      "deleted" : false,
      "status" : "NEW",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/2ab2a657-c616-4da5-88d6-05b86685219a",
          "title" : "app two"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ba160495-2b62-4e62-b783-096143d62cf1",
          "profile" : "parent"
        }
      }
    }, {
      "id" : "61b45782-b1b8-4594-9d52-79a8aadd32d0",
      "networkId" : "ba160495-2b62-4e62-b783-096143d62cf1",
      "name" : "deleting",
      "path" : "/deleting",
      "serviceId" : null,
      "zitiServiceId" : "zitiId-29",
      "tunnelHttps" : true,
      "access" : {
        "domainNameLabel" : "app3",
        "dnsZoneId" : null,
        "fqdn" : null
      },
      "auth" : {
        "baseUrl" : "fake.nf.io",
        "clientId" : "12345",
        "type" : "OIDC-Default"
      },
      "createdBy" : "ad29baaa-00ff-435e-8779-26a9a4de0d43",
      "createdAt" : "2025-01-11T20:35:48.297192Z",
      "updatedAt" : "2025-01-11T20:35:48.335053Z",
      "versionDate" : "2025-01-11T20:35:48.335053Z",
      "appliedAt" : null,
      "deletedAt" : "2025-01-11T20:35:48.335053Z",
      "deletedBy" : "aa1774f9-29d3-4bbf-a8ff-82501aa64e56",
      "deleted" : true,
      "status" : "DELETING",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps/61b45782-b1b8-4594-9d52-79a8aadd32d0",
          "title" : "deleting"
        },
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ba160495-2b62-4e62-b783-096143d62cf1",
          "profile" : "parent"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/browzer-apps"
    }
  },
  "page" : {
    "size" : 3500,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Update Browzer App

PATCH /v3/browzer-apps/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

path

String

true

serviceId

String

true

Deprecated. In favor of the zitiServiceId property, will be deleted 3/1/2024.

@deprecated in favor of the zitiServiceId property, will be deleted 3/1/2024.

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/v3/browzer-apps/1d08101e-8cc7-4c98-9676-413aa6ec8793' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJXd1F2cXdDZV9MWWdSZnd2Y1pEcmFnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNhNTRiYWM5LTE2MjAtNGM1OS05OTI5LThiZGJmNzViZDllNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgzMSwiZXhwIjoxNzM2NjMxNDMxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBiYWYzY2FjLTE4YTItNDc1NC1iMDI5LTFiNThjNjMyNjMxMVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgzMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.dFMK-xMZCiXPa6Ertd48y40rjrKjvpvl5NdnSwPC4Z4f1ocwK-HaTtDhVrqksHAZzS9q38oLKI_vbHNFa033BAiCKe1zXJ5XLvXwqEOcWkOSZ1YBl2rTEb-G2Zv6GostQZpDdPM9bJo_O8HcXP2nb_7ucVt-SpjorQrDbAz4RKoKU1ZUqo47DC3uuxTeMFXSwbn_lw5MeNuXackx4_8GgH_pYxKh5gaidzfWWe63Dv9za4OygqAo5u0GoTKlgdsMl62vBIbZRktkVi-kxi1LKXF5Meqy9LvKTw5W-ahvGM6InDYQ_0unSIZOjIJQXgePoxaa22dfqaZah0Ohhl6xNA' \
    -d '{"name":"Kve4QXT7dw3TsyfkUw5zp","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: 1108

{
  "id" : "1d08101e-8cc7-4c98-9676-413aa6ec8793",
  "networkId" : "e6130920-9f42-4b96-bbf5-064af06c16be",
  "name" : "Kve4QXT7dw3TsyfkUw5zp",
  "path" : "/",
  "serviceId" : null,
  "zitiServiceId" : "zitiId-1168",
  "tunnelHttps" : true,
  "access" : {
    "domainNameLabel" : null,
    "dnsZoneId" : null,
    "fqdn" : null
  },
  "auth" : {
    "baseUrl" : "https://foo.bar",
    "clientId" : "12345",
    "type" : "OIDC-Default"
  },
  "createdBy" : "959fb818-4e4e-4411-9c46-79375235c106",
  "createdAt" : "2025-01-11T20:37:11.420429Z",
  "updatedAt" : "2025-01-11T20:37:11.443804Z",
  "versionDate" : "2025-01-11T20:37:11.443661Z",
  "appliedAt" : null,
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "status" : "NEW",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-apps/1d08101e-8cc7-4c98-9676-413aa6ec8793",
      "title" : "Kve4QXT7dw3TsyfkUw5zp"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/networks/e6130920-9f42-4b96-bbf5-064af06c16be",
      "profile" : "parent"
    }
  }
}

Update Browzer App

PUT /v3/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

id

Object

false

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

path

String

true

serviceId

String

true

Deprecated. In favor of the zitiServiceId property, will be deleted 3/1/2024.

@deprecated in favor of the zitiServiceId property, will be deleted 3/1/2024.

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/v3/browzer-apps/0a5a4d8d-4906-4ed3-a924-8477fdc17260' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJlejctRDJTeDgxejNYZkxlOVZWRXRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAyMTQyMGQ0LWIzY2UtNGVjZC1hYmU2LWRkZjM2YzYyNTdmYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgzMSwiZXhwIjoxNzM2NjMxNDMxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI4NTI2MDc2LTBkZWQtNDY4ZC1iNTcxLWU2MjEyMTQ5YjhjMlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgzMX0se1wiaWRcIjpcImFjMmMzODJjLTc1MzQtNDBiNi04MDZmLTdjODM3MTlmZjQxY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgzMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.aITw7tSMEzIAZQn8ms8vlBCfOWEQx3AJRzp2cS75sltTtf_UxahlqLf7smY3j3d8vqhUH2idg-BV8JRJjQA_yuZy_VkIoCpxntP9s2cOZ9cODoHC3qpsqtPKCH6RAtHorlYohlcrJj4NadSDFOkmiGbELijjeoFIIEnKneeWZnbW4m6LEbc70UdfUtqgE9kJa4-yfPcvPaEdtL7HluXSYJmy9X1IT1LyCrWkPaf7EcNLKS7vGp1OC6oq9znSRFj4WAvZkbxhCIVe7y16BEYrF9EJdKibs6b7f4KlzfcY1HqJlykI42mRo1x-JBnwpHzzAxu6taBws4ToSw-Yc6vJtw' \
    -d '{"name":"D90kWkAv47oZlprJ34eMO","path":null,"serviceId":null,"zitiServiceId":"ziti.id.d3cgcjsh","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: 1113

{
  "id" : "0a5a4d8d-4906-4ed3-a924-8477fdc17260",
  "networkId" : "e6130920-9f42-4b96-bbf5-064af06c16be",
  "name" : "D90kWkAv47oZlprJ34eMO",
  "path" : "/",
  "serviceId" : null,
  "zitiServiceId" : "ziti.id.d3cgcjsh",
  "tunnelHttps" : true,
  "access" : {
    "domainNameLabel" : null,
    "dnsZoneId" : null,
    "fqdn" : null
  },
  "auth" : {
    "baseUrl" : "https://fake.com",
    "clientId" : "fake",
    "type" : "OIDC-Default"
  },
  "createdBy" : "d0b8a945-9ba1-45c9-90ce-2a2dfd10d677",
  "createdAt" : "2025-01-11T20:37:11.217332Z",
  "updatedAt" : "2025-01-11T20:37:11.354065Z",
  "versionDate" : "2025-01-11T20:37:11.353189Z",
  "appliedAt" : null,
  "deletedAt" : null,
  "deletedBy" : null,
  "deleted" : false,
  "status" : "NEW",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-apps/0a5a4d8d-4906-4ed3-a924-8477fdc17260",
      "title" : "D90kWkAv47oZlprJ34eMO"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/networks/e6130920-9f42-4b96-bbf5-064af06c16be",
      "profile" : "parent"
    }
  }
}

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

id

Object

false

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

path

String

true

serviceId

String

true

Deprecated. In favor of the zitiServiceId property, will be deleted 3/1/2024.

@deprecated in favor of the zitiServiceId property, will be deleted 3/1/2024.

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

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/browzer-apps/69f5cf86-e4dd-4950-8f21-424b044703a9' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'nf-validate: ' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDWUxBQTdCVDcxUHVtbEpOTlpfOHp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkwM2I2YTBmLTFhZGMtNDVkYy04MzZiLTU2NTg5NWZiMzAzOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzc1NSwiZXhwIjoxNzM2NjMxMzU1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU1MzFmOTZiLTlhYTEtNDY1MC1iZDYwLTEyOGNkNGNhNmQyM1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc1NX0se1wiaWRcIjpcIjQwZjk0ZjI4LTc1YTctNDFjNy05ZWJiLThhOTBlMTkzZmNjY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc1NX0se1wiaWRcIjpcIjlhM2U4YzAwLWJmMmUtNDkzMi04MTJkLWZkOWI3YWNhYmVlY1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc1NX0se1wiaWRcIjpcImZjYTU2MTc1LTJlZTItNGQ3YS1hOTU0LTM4ZGZlZjE3YjBkNVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc1NX0se1wiaWRcIjpcIjg4ZjYwZmE0LTBkYTMtNDQ0NC05YTNhLWQzZTYzOTRjNTc3NVwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc1NX0se1wiaWRcIjpcIjNmOGNkNTEwLWFhZjgtNDk3OS05ZmE1LWM0Y2YzMzMxYWQ5MlwiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzc1NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.MaZWhGuxWXMYX8hdrGoD3BBc1bKLpCJz6z1dKWmHrBkV_XYPIKsd4rmBpICFYAxdy_h0AJwidgOz2qtdAjfaxZGtQWTYwPyjDhWhCYUytdYkDQz6GHXudjmMSLIzsFiHEHARrJnHMkESttkI68927fmZ38lUY29gSie4dte0nCJ1JgCMXMwoQwN21Vplyor7P1J85E6feAnvlt1igKBaaYvTI7iJn86_--R4Cu56WGxY4FDGpi-o7S3I69vQXZdQb41ILOfHS7wYqGNeyZZ7-1yX0YVWkPH7ySJZ-Bv-yBkJS9WPSa-78cOXpHuASkcDmnUXBB6wkODs4SAShiMeQA' \
    -d '{"name":null,"path":"/whatever","serviceId":null,"zitiServiceId":null,"tunnelHttps":null,"domainNameLabel":null,"dnsZoneId":null,"baseUrl":null,"clientId":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

[ ]

Delete Browzer App

DELETE /v3/browzer-apps/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

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/v3/browzer-apps/16fbf7eb-38ef-43c1-820f-c9a98e54ab83' -i -X DELETE \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiVTRIcUJ4SWd3cUhQdngwMGozTDB3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRhYWM4MDRjLWRmM2EtNGVkYy1iNjZmLWU0YWQ4YWRlNjRlOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTczNjYyNzgzMSwiZXhwIjoxNzM2NjMxNDMxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg1MDViYjU4LTEwNWUtNGMyMC04OWU5LWE0Mjg4NTM3YTI5Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTczNjYyNzgzMX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.i6PLpBWHi7T54oQ1BubchM0kzMOquyqb7xexeFNfyYKBbPIrx0rAPoG5SLQ10uDjxrj3euU64nRmHH-a4cCGlImBC0tRwFQM_zbtQ0fKi7u2yPNJxNgvMrAxo_KT6M59MW63Og7mpXmlK3wMnapw4d-AXrrgp3iphqBP23ZeGs0udT103dFNzquYUqkSptBSYupYFHQIzk3bU0j2EwG12ZrDuWA7zAkWoxKTmpRskIC8U0Cc2qcXmvtYlvLLud5A_saXPMc-wkCkGH3aVvwApuqw9ttzvIhhmTGXOI7JkIzZ4juY58UHeIKKvWWI76Ai9l2Nozli8EwpWxoMcJPnGg'

Example response

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

{
  "id" : "16fbf7eb-38ef-43c1-820f-c9a98e54ab83",
  "networkId" : "e6130920-9f42-4b96-bbf5-064af06c16be",
  "name" : "browzer-app-1139",
  "path" : "/",
  "serviceId" : null,
  "zitiServiceId" : "zitiId-1140",
  "tunnelHttps" : true,
  "access" : {
    "domainNameLabel" : null,
    "dnsZoneId" : null,
    "fqdn" : null
  },
  "auth" : {
    "baseUrl" : "https://foo.bar",
    "clientId" : "12345",
    "type" : "OIDC-Default"
  },
  "createdBy" : "83c7bf92-35b2-4f3b-8855-791c299974b9",
  "createdAt" : "2025-01-11T20:37:11.097894Z",
  "updatedAt" : "2025-01-11T20:37:11.123591Z",
  "versionDate" : "2025-01-11T20:37:11.123591Z",
  "appliedAt" : null,
  "deletedAt" : "2025-01-11T20:37:11.123591Z",
  "deletedBy" : "daac804c-df3a-4edc-b66f-e4ad8ade64e9",
  "deleted" : true,
  "status" : "DELETING",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/browzer-apps/16fbf7eb-38ef-43c1-820f-c9a98e54ab83",
      "title" : "browzer-app-1139"
    },
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v3/networks/e6130920-9f42-4b96-bbf5-064af06c16be",
      "profile" : "parent"
    }
  }
}