NetFoundry Core Management (0.6.0)

Download OpenAPI specification:Download

NetFoundry Core Management API

Regions

Retrieves Regions

Get Region

Returns a single Region by cloud provider and location code.

Authorizations:

bearerAuth

path Parameters

provider required	string Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Example: AWS Cloud provider key.
locationCode required	string Example: us-east-1 Unique region location code for the provider.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get region response

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

Find Regions

Returns cloud regions aggregated across the selected provider(s). Optionally provide latitude and longitude to sort by proximity and include distance metadata. If no provider is specified, all providers are included.

Authorizations:

bearerAuth

query Parameters

provider	Array of strings Items Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Example: provider=AWS Filter to cloud provider(s). Repeat to specify multiple.
latitude	number <double> Example: latitude=37.7749 Latitude to compute distance and sort results by proximity.
longitude	number <double> Example: longitude=-122.4194 Longitude to compute distance and sort results by proximity.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample find regions response

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

Host Sizes

Retrieves Host Sizes

Find Host Sizes

Returns host sizes aggregated across the selected cloud providers and optional host type filter. If no provider is specified, all providers are included. If no type is specified, both NC and ER sizes are returned.

Authorizations:

bearerAuth

query Parameters

provider	Array of strings Items Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Example: provider=AWS Filter to cloud provider(s). Repeat to specify multiple.
type	string Example: type=ER Host type filter. Accepts NC (NetworkController) or ER (EdgeRouter).

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample find host sizes response

"[ {\n  \"name\" : \"small\",\n  \"hostType\" : \"ER\",\n  \"providers\" : [ \"GCP\", \"OCI\", \"AWS\", \"AZURE\" ],\n  \"description\" : [ ],\n  \"default\" : true\n}, {\n  \"name\" : \"medium\",\n  \"hostType\" : \"ER\",\n  \"providers\" : [ \"GCP\", \"OCI\", \"AWS\", \"AZURE\" ],\n  \"description\" : [ ],\n  \"default\" : false\n}, {\n  \"name\" : \"small\",\n  \"hostType\" : \"NC\",\n  \"providers\" : [ \"AWS\" ],\n  \"description\" : [ ],\n  \"default\" : true\n}, {\n  \"name\" : \"medium\",\n  \"hostType\" : \"NC\",\n  \"providers\" : [ \"AWS\" ],\n  \"description\" : [ ],\n  \"default\" : false\n} ]"

Network Assemblies

Retrieve a Network as an assembly or create a new Network from an assembly

Export a Network Assembly

Export a composite of the specified network including Ziti controller data and hosting information. Optionally filter which entities to include via the 'entities' query parameter.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8d4a9f4d-9f64-4f24-9a6a-6a7a2bc4b6c1

The Network ID (UUID). The network must exist and be PROVISIONED.

query Parameters

entities

Array of strings

Items Enum: "all" "network-controller" "ca" "certificate-authority" "identity" "edge-router" "service" "config" "config-type" "service-policy" "edge-router-policy" "service-edge-router-policy" "external-jwt-signer" "auth-policy" "posture-check"

Examples:

entities=all - all
entities=identity,service,edge-router - subset

Responses

Response samples

200
400
401
403
500

Content type

application/json

Example Get Network Assembly response

"{\n  \"name\" : \"export-test-0\",\n  \"version\" : \"8.1.4\",\n  \"zitiVersion\" : null,\n  \"identities\" : [ {\n    \"authPolicy\" : \"@NetFoundry Console Integration Auth Policy\",\n    \"disabled\" : false,\n    \"edgeRouterConnectionStatus\" : \"offline\",\n    \"externalId\" : \"5f854c49-b5fd-44a1-b14f-a9c4aa5a7eba\",\n    \"isAdmin\" : true,\n    \"isDefaultAdmin\" : false,\n    \"isMfaEnabled\" : false,\n    \"name\" : \"NF User Identity(managed from 5f854c49-b5fd-44a1-b14f-a9c4aa5a7eba)\",\n    \"roleAttributes\" : [ ],\n    \"tags\" : {\n      \"nf-identity-id\" : \"5f854c49-b5fd-44a1-b14f-a9c4aa5a7eba\"\n    },\n    \"typeId\" : \"Default\"\n  }, {\n    \"authPolicy\" : \"@NetFoundry Console Integration Auth Policy\",\n    \"disabled\" : false,\n    \"edgeRouterConnectionStatus\" : \"offline\",\n    \"externalId\" : \"0ed768fa-7214-4404-8335-c715156dff45\",\n    \"isAdmin\" : true,\n    \"isDefaultAdmin\" : false,\n    \"isMfaEnabled\" : false,\n    \"name\" : \"MOP Ziti Metrics Processor Service(managed from ced768fa-7214-4404-8335-a715156dff45)\",\n    \"roleAttributes\" : [ ],\n    \"tags\" : {\n      \"nf-identity-id\" : \"0ed768fa-7214-4404-8335-a715156dff45\"\n    },\n    \"typeId\" : \"Default\"\n  } ],\n  \"edgeRouters\" : [ {\n    \"appData\" : { },\n    \"disabled\" : false,\n    \"hostname\" : \"281f0ea3-33c2-4354-8c01-e1c0835bba4f-p.sandbox.netfoundry.io\",\n    \"isTunnelerEnabled\" : false,\n    \"name\" : \"test-2\",\n    \"noTraversal\" : false,\n    \"roleAttributes\" : [ ],\n    \"tags\" : { },\n    \"unverifiedCertPem\" : null,\n    \"unverifiedFingerprint\" : null\n  }, {\n    \"appData\" : { },\n    \"disabled\" : false,\n    \"hostname\" : \"cf7149f6-d634-4402-9cbc-a132280bae84-p.sandbox.netfoundry.io\",\n    \"isTunnelerEnabled\" : false,\n    \"name\" : \"test-1\",\n    \"noTraversal\" : false,\n    \"roleAttributes\" : [ ],\n    \"tags\" : { },\n    \"unverifiedCertPem\" : null,\n    \"unverifiedFingerprint\" : null\n  } ],\n  \"services\" : [ ],\n  \"configs\" : null,\n  \"configTypes\" : null,\n  \"servicePolicies\" : [ ],\n  \"serviceEdgeRouterPolicies\" : [ {\n    \"edgeRouterRoles\" : [ \"#all\" ],\n    \"name\" : \"Default Policy\",\n    \"semantic\" : \"AnyOf\",\n    \"serviceRoles\" : [ \"#all\" ],\n    \"tags\" : {\n      \"network-id\" : \"d5cb7263-116f-4ae9-9591-5f657d0c960a\",\n      \"resource-id\" : \"509af4d1-d1fc-40d7-b739-5dc41259c200\"\n    }\n  } ],\n  \"edgeRouterPolicies\" : [ ],\n  \"authPolicies\" : [ {\n    \"name\" : \"NetFoundry Console Integration Auth Policy\",\n    \"primary\" : {\n      \"cert\" : {\n        \"allowExpiredCerts\" : false,\n        \"allowed\" : false\n      },\n      \"extJwt\" : {\n        \"allowed\" : true,\n        \"allowedSigners\" : [ \"@NetFoundry Console Integration External JWT Signer\" ]\n      },\n      \"updb\" : {\n        \"allowed\" : false,\n        \"lockoutDurationMinutes\" : 0,\n        \"maxAttempts\" : 0,\n        \"minPasswordLength\" : 5,\n        \"requireMixedCase\" : false,\n        \"requireNumberChar\" : false,\n        \"requireSpecialChar\" : false\n      }\n    },\n    \"secondary\" : {\n      \"requireTotp\" : false\n    },\n    \"tags\" : {\n      \"network-id\" : \"d5cb7263-116f-4ae9-9591-5f657d0c960a\",\n      \"resource-id\" : \"24d5cc4b-3094-4762-a8b7-2b03bc3f55b9\"\n    }\n  } ],\n  \"certificateAuthorities\" : null,\n  \"externalJwtSigners\" : [ {\n    \"audience\" : \"https://gateway.sandbox.netfoundry.io/d5cb7263-116f-4ae9-9591-5f657d0c960a\",\n    \"certPem\" : null,\n    \"claimsProperty\" : \"sub\",\n    \"clientId\" : null,\n    \"enabled\" : true,\n    \"externalAuthUrl\" : null,\n    \"fingerprint\" : null,\n    \"issuer\" : \"https://netfoundry.io/jwt/Swuq_ZYGeVHSZcSnjf-GQ\",\n    \"jwksEndpoint\" : \"https://2qy82qhbz8xe.in.staging.zrok.io/network-auth/v1/public/.well-known/Swuq_ZYGeVHSZcSnjf-GQ/jwks.json\",\n    \"kid\" : null,\n    \"name\" : \"NetFoundry Console Integration External JWT Signer\",\n    \"scopes\" : null,\n    \"tags\" : { },\n    \"targetToken\" : null,\n    \"useExternalId\" : false\n  } ],\n  \"postureChecks\" : null,\n  \"hosting\" : {\n    \"networkControllers\" : [ {\n      \"name\" : \"test-nc-2\",\n      \"provider\" : \"AWS\",\n      \"region\" : \"us-east-1\",\n      \"size\" : \"small\",\n      \"productVersion\" : \"7.3.37\",\n      \"haPrimaryNode\" : true\n    }, {\n      \"name\" : \"export-test-0-nc\",\n      \"provider\" : \"AWS\",\n      \"region\" : \"us-east-1\",\n      \"size\" : \"small\",\n      \"productVersion\" : \"8.1.4\",\n      \"haPrimaryNode\" : true\n    } ],\n    \"edgeRouters\" : [ {\n      \"name\" : \"test-2\",\n      \"provider\" : \"AWS\",\n      \"region\" : \"us-east-1\",\n      \"size\" : \"small\",\n      \"alternateDomainName\" : null\n    }, {\n      \"name\" : \"test-1\",\n      \"provider\" : \"AWS\",\n      \"region\" : \"us-east-1\",\n      \"size\" : \"small\",\n      \"alternateDomainName\" : null\n    } ]\n  },\n  \"haEnabled\" : false\n}"

Import a Network Assembly into an existing Network

Import a Network Assembly into an existing Network. This process updates the network, imports the specified Ziti entities, and creates hosting for any new edge routers.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

header Parameters

nf-validate

string

Request Body schema: application/json
required

A Network Assembly object that defines the components to import into the network.

name required	string Display name for the Network to be created.
haEnabled	boolean Enable High Availability (multiple controller nodes).
productVersion	string Desired product version for the Network (semantic version). If omitted, current default is used.
	object (CustomerProviderDetails) Provider details required when using CUSTOMER hosting for controllers/routers.
entities	Array of strings unique Subset of entities from the Ziti export to import when creating the Network.
	object (ZitiData) Ziti export data to seed the Network with services, identities, policies, etc.
required	object (CreateNetworkAssemblyHosting) Hosting directives that define controller nodes and edge routers to create.
dnsZoneId	string <uuid> Optional DNS Zone to use for public DNS records.

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"test-network-assembly\",\"haEnabled\":false,\"productVersion\":null,\"customerProviderDetails\":null,\"entities\":[],\"hosting\":{\"networkControllers\":[{\"name\":\"test-controller\",\"provider\":\"AWS\",\"region\":\"us-east-1\",\"size\":\"medium\",\"productVersion\":\"8.0.43\",\"alternateDomainName\":null,\"haPrimaryNode\":null}],\"edgeRouters\":null},\"dnsZoneId\":null,\"networkGroupId\":\"38570e26-c378-4829-b5ad-7685fa99a80a\"}"

Response samples

202
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"076c27fa-6fd9-4538-9759-44772332ce26\",\n  \"ownerIdentityId\" : \"dc616281-4ba0-4a4f-b860-c593bfb2adfb\",\n  \"createdBy\" : \"dc616281-4ba0-4a4f-b860-c593bfb2adfb\",\n  \"createdAt\" : \"2025-12-18T22:57:05.315760Z\",\n  \"updatedAt\" : \"2025-12-18T22:57:05.323967Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"network-assembly-test-30\",\n  \"networkGroupId\" : \"38570e26-c378-4829-b5ad-7685fa99a80a\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.1.4\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONED\",\n  \"publicCertEnabled\" : false,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/38570e26-c378-4829-b5ad-7685fa99a80a\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/076c27fa-6fd9-4538-9759-44772332ce26\",\n      \"title\" : \"network-assembly-test-30\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/076c27fa-6fd9-4538-9759-44772332ce26\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=076c27fa-6fd9-4538-9759-44772332ce26\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=076c27fa-6fd9-4538-9759-44772332ce26\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=076c27fa-6fd9-4538-9759-44772332ce26\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=076c27fa-6fd9-4538-9759-44772332ce26\"\n    }\n  }\n}"

Create a Network from a Network Assembly

Create a new Network and its components from the provided Network Assembly. This process includes creating the network, all specified Ziti entities, and the hosting infrastructure for network controllers and edge routers.

Authorizations:

bearerAuth

header Parameters

nf-validate

string

Request Body schema: application/json
required

A Network Assembly object that defines the network to create.

name required	string Display name for the Network to be created.
haEnabled	boolean Enable High Availability (multiple controller nodes).
productVersion	string Desired product version for the Network (semantic version). If omitted, current default is used.
	object (CustomerProviderDetails) Provider details required when using CUSTOMER hosting for controllers/routers.
entities	Array of strings unique Subset of entities from the Ziti export to import when creating the Network.
	object (ZitiData) Ziti export data to seed the Network with services, identities, policies, etc.
required	object (CreateNetworkAssemblyHosting) Hosting directives that define controller nodes and edge routers to create.
dnsZoneId	string <uuid> Optional DNS Zone to use for public DNS records.
networkGroupId required	string <uuid> ID of the Network Group in which to create the Network.

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"test-network-assembly\",\"haEnabled\":false,\"productVersion\":null,\"customerProviderDetails\":null,\"entities\":[\"network-controllers\",\"services\"],\"hosting\":{\"networkControllers\":[{\"name\":\"test-network-controller\",\"provider\":\"AWS\",\"region\":\"us-east-1\",\"size\":\"large\",\"productVersion\":\"8.0.43\",\"alternateDomainName\":null,\"haPrimaryNode\":null}],\"edgeRouters\":null},\"dnsZoneId\":null,\"networkGroupId\":\"8a8fbe1d-ffca-4a31-a4f6-02411fb9b8ff\"}"

Response samples

202
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"3860b7c5-25a0-43b2-96ed-cf33cbb063b6\",\n  \"ownerIdentityId\" : \"b7248771-6f41-417e-9ee0-fc654546bb06\",\n  \"createdBy\" : \"b7248771-6f41-417e-9ee0-fc654546bb06\",\n  \"createdAt\" : \"2025-12-18T22:57:04.772590Z\",\n  \"updatedAt\" : \"2025-12-18T22:57:04.782874Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"network-assembly-test-15\",\n  \"networkGroupId\" : \"8a8fbe1d-ffca-4a31-a4f6-02411fb9b8ff\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.1.4\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONED\",\n  \"publicCertEnabled\" : false,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/8a8fbe1d-ffca-4a31-a4f6-02411fb9b8ff\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/3860b7c5-25a0-43b2-96ed-cf33cbb063b6\",\n      \"title\" : \"network-assembly-test-15\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/3860b7c5-25a0-43b2-96ed-cf33cbb063b6\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=3860b7c5-25a0-43b2-96ed-cf33cbb063b6\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=3860b7c5-25a0-43b2-96ed-cf33cbb063b6\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=3860b7c5-25a0-43b2-96ed-cf33cbb063b6\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=3860b7c5-25a0-43b2-96ed-cf33cbb063b6\"\n    }\n  }\n}"

Software Deployment States

Retrieves or updates SoftwareDeploymentStates

Get Software Deployment State

Returns a single SoftwareDeploymentState by its unique identifier. The caller must have read permissions on the SoftwareDeploymentState resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the SoftwareDeploymentState.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get SoftwareDeploymentState response

"{\n  \"id\" : \"2366279d-8745-41bf-b1ad-eb48b756fddc\",\n  \"networkId\" : \"f065c214-ff0c-4c1a-947d-373cf94ef5f3\",\n  \"resourceId\" : \"7624dcae-8d19-4ec7-8103-4c44243aadd2\",\n  \"resourceType\" : \"NETWORK_CONTROLLER\",\n  \"enabled\" : false,\n  \"online\" : false,\n  \"lastOnlineAt\" : null,\n  \"softwareConfigurationPortEnabled\" : true,\n  \"lastCheckedAt\" : \"2025-11-17T16:25:56.128330Z\",\n  \"nextCheckAt\" : \"2025-11-17T17:35:56.128340Z\",\n  \"createdBy\" : \"dbb3e5d7-7cc4-444c-a5e0-4f101316a174\",\n  \"createdAt\" : \"2025-11-17T16:35:56.133808Z\",\n  \"updatedAt\" : \"2025-11-17T16:35:56.133808Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/f065c214-ff0c-4c1a-947d-373cf94ef5f3\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/2366279d-8745-41bf-b1ad-eb48b756fddc\"\n    },\n    \"network-controller\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/7624dcae-8d19-4ec7-8103-4c44243aadd2\",\n      \"title\" : \"parent\"\n    }\n  }\n}"

Update Software Deployment State

Updates mutable fields of a SoftwareDeploymentState. Currently supports toggling software configuration management flags. The caller must have update-software-configuration-port permission on the SoftwareDeploymentState resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the SoftwareDeploymentState.

header Parameters

nf-validate

string

Request Body schema: application/json
required

SoftwareDeploymentState update payload.

softwareConfigurationPortEnabled

boolean

Enable or disable the privileged software configuration management port on the resource.

Responses

Request samples

Payload

Content type

application/json

enable-config-port

{"softwareConfigurationPortEnabled": true
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Sample patch SoftwareDeploymentState response

"{\n  \"id\" : \"304eb566-41f9-4425-ab43-933190ac3812\",\n  \"networkId\" : \"bfbf82ff-2a93-4a4c-a989-7a0b8e6908b8\",\n  \"resourceId\" : \"bb7420e5-b6fc-4c1a-9909-5190c14699cc\",\n  \"resourceType\" : \"NETWORK_CONTROLLER\",\n  \"enabled\" : true,\n  \"online\" : true,\n  \"lastOnlineAt\" : \"2025-12-05T15:12:35.971797Z\",\n  \"softwareConfigurationPortEnabled\" : true,\n  \"lastCheckedAt\" : \"2025-12-05T15:12:35.971797Z\",\n  \"nextCheckAt\" : \"2025-12-05T16:22:35.971805Z\",\n  \"createdBy\" : \"c40c82a8-75d3-4b38-80f5-9b400fe5ecc9\",\n  \"createdAt\" : \"2025-12-05T15:22:35.971541Z\",\n  \"updatedAt\" : \"2025-12-05T15:22:35.971541Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/bfbf82ff-2a93-4a4c-a989-7a0b8e6908b8\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/304eb566-41f9-4425-ab43-933190ac3812\"\n    },\n    \"network-controller\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers/bb7420e5-b6fc-4c1a-9909-5190c14699cc\",\n      \"title\" : \"parent\"\n    }\n  }\n}"

Update Software Deployment State

Updates mutable fields of a SoftwareDeploymentState. Currently supports toggling software configuration management flags. The caller must have update-software-configuration-port permission on the SoftwareDeploymentState resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the SoftwareDeploymentState.

header Parameters

nf-validate

string

Request Body schema: application/json
required

SoftwareDeploymentState update payload.

softwareConfigurationPortEnabled

boolean

Enable or disable the privileged software configuration management port on the resource.

Responses

Request samples

Payload

Content type

application/json

enable-config-port

{"softwareConfigurationPortEnabled": true
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Sample patch SoftwareDeploymentState response

"{\n  \"id\" : \"304eb566-41f9-4425-ab43-933190ac3812\",\n  \"networkId\" : \"bfbf82ff-2a93-4a4c-a989-7a0b8e6908b8\",\n  \"resourceId\" : \"bb7420e5-b6fc-4c1a-9909-5190c14699cc\",\n  \"resourceType\" : \"NETWORK_CONTROLLER\",\n  \"enabled\" : true,\n  \"online\" : true,\n  \"lastOnlineAt\" : \"2025-12-05T15:12:35.971797Z\",\n  \"softwareConfigurationPortEnabled\" : true,\n  \"lastCheckedAt\" : \"2025-12-05T15:12:35.971797Z\",\n  \"nextCheckAt\" : \"2025-12-05T16:22:35.971805Z\",\n  \"createdBy\" : \"c40c82a8-75d3-4b38-80f5-9b400fe5ecc9\",\n  \"createdAt\" : \"2025-12-05T15:22:35.971541Z\",\n  \"updatedAt\" : \"2025-12-05T15:22:35.971541Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/bfbf82ff-2a93-4a4c-a989-7a0b8e6908b8\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/304eb566-41f9-4425-ab43-933190ac3812\"\n    },\n    \"network-controller\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers/bb7420e5-b6fc-4c1a-9909-5190c14699cc\",\n      \"title\" : \"parent\"\n    }\n  }\n}"

Refresh Software State

Schedules a background refresh of Software Deployment State for the specified resource. The caller must have update permission on the SoftwareDeploymentState resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the SoftwareDeploymentState to refresh.

Responses

Response samples

400
401
403
500

Content type

*/*

No sample

Refresh Software State in Network

Schedules a background refresh of Software Deployment State for all resources in the specified Network. The caller must have update permission on the Network resource.

Authorizations:

bearerAuth

query Parameters

networkId

required

string <uuid>

Example: networkId=11111111-2222-3333-4444-555555555555

The unique identifier of the Network whose software state should be refreshed.

Responses

Response samples

400
401
403
500

Content type

*/*

No sample

Find Software Deployment States

Returns SoftwareDeploymentStates matching the optional query parameters. Results are filtered to only include resources the caller may read.

Authorizations:

bearerAuth

query Parameters

id	any Example: id=8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b Filter by SoftwareDeploymentState ID(s). Repeat to specify multiple.
networkId	any Example: networkId=11111111-2222-3333-4444-555555555555 Filter by Network ID(s).
resourceId	any Example: resourceId=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Filter by resource ID(s) the state applies to (Edge Router or Network Controller).
resourceType	any Example: resourceType=EDGE_ROUTER Filter by resource type.
createdBy	any Example: createdBy=bbbbbbbb-1111-2222-3333-cccccccccccc Filter by creator identity ID(s).
deletedBy	any Example: deletedBy=dddddddd-eeee-ffff-1111-222222222222 Filter by deleter identity ID(s).
enabled	any Example: enabled=true Filter by whether software management is enabled.
online	any Example: online=true Filter by current online status.
softwareConfigurationPortEnabled	any Filter by whether the software configuration port is enabled.
lastCheckedAt	any Example: lastCheckedAt=>=2025-01-01T00:00:00Z Last-checked-at filter expressions. Supports >, >=, <, <=, =, != (e.g., lastCheckedAt=>=2025-01-01T00:00:00Z).
nextCheckAt	any Example: nextCheckAt=<=2025-12-31T23:59:59Z Next-check-at filter expressions.
createdAt	any Example: createdAt=>=2025-01-01T00:00:00Z Created-at filter expressions.
updatedAt	any Example: updatedAt=<=2025-12-31T23:59:59Z Updated-at filter expressions.
deletedAt	any Example: deletedAt=>2025-10-01T00:00:00Z Deleted-at filter expressions.
page	any Page index (0-based).
size	any Example: size=20 Page size.
sort	any Example: sort=updatedAt,desc Sort expressions, e.g., resourceType,updatedAt,desc.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample find SoftwareDeploymentStates response

"{\n  \"_embedded\" : {\n    \"softwareDeploymentStateList\" : [ {\n      \"id\" : \"10df1c9f-fd6e-4985-9007-8aafaca6eef8\",\n      \"networkId\" : \"09e18668-7c9e-445e-a046-7a4f539bfb8d\",\n      \"resourceId\" : \"41f006a0-6b1e-4097-b457-8337962cd983\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : true,\n      \"online\" : true,\n      \"lastOnlineAt\" : \"2025-11-17T16:25:55.221599Z\",\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:55.221599Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:55.221643Z\",\n      \"createdBy\" : \"4f3c8e5b-bcfa-4015-8bdd-572a2d3b292b\",\n      \"createdAt\" : \"2025-11-17T16:35:55.268968Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:55.268968Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/09e18668-7c9e-445e-a046-7a4f539bfb8d\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/10df1c9f-fd6e-4985-9007-8aafaca6eef8\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/41f006a0-6b1e-4097-b457-8337962cd983\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"2366279d-8745-41bf-b1ad-eb48b756fddc\",\n      \"networkId\" : \"f065c214-ff0c-4c1a-947d-373cf94ef5f3\",\n      \"resourceId\" : \"7624dcae-8d19-4ec7-8103-4c44243aadd2\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : false,\n      \"online\" : false,\n      \"lastOnlineAt\" : null,\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:56.128330Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:56.128340Z\",\n      \"createdBy\" : \"dbb3e5d7-7cc4-444c-a5e0-4f101316a174\",\n      \"createdAt\" : \"2025-11-17T16:35:56.133808Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:56.133808Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/f065c214-ff0c-4c1a-947d-373cf94ef5f3\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/2366279d-8745-41bf-b1ad-eb48b756fddc\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/7624dcae-8d19-4ec7-8103-4c44243aadd2\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"3e4b767b-e2dd-4e95-b57d-a6816b23899b\",\n      \"networkId\" : \"a9af388f-6867-4183-a4d2-b5df6988dce9\",\n      \"resourceId\" : \"49015156-d5df-49be-94dc-82010bc2ee3f\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : true,\n      \"online\" : true,\n      \"lastOnlineAt\" : \"2025-11-17T16:25:58.062047Z\",\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:58.062047Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:58.062056Z\",\n      \"createdBy\" : \"8aed7e2b-6770-4b56-8dba-7d207f1c31e8\",\n      \"createdAt\" : \"2025-11-17T16:35:58.065808Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:58.065808Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/a9af388f-6867-4183-a4d2-b5df6988dce9\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/3e4b767b-e2dd-4e95-b57d-a6816b23899b\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/49015156-d5df-49be-94dc-82010bc2ee3f\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"45f1eab5-3239-455d-adeb-6c4d66561018\",\n      \"networkId\" : \"3e6dd1c9-d69a-4395-90d5-58692967fdb9\",\n      \"resourceId\" : \"9945a75a-a160-43ed-a003-ba3979ed31e7\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : true,\n      \"online\" : true,\n      \"lastOnlineAt\" : \"2025-11-17T16:25:59.443847Z\",\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:59.443847Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:59.443858Z\",\n      \"createdBy\" : \"6ceb2c1a-f3d4-4dac-bac9-1023272811b4\",\n      \"createdAt\" : \"2025-11-17T16:35:59.449676Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:59.449676Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/3e6dd1c9-d69a-4395-90d5-58692967fdb9\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/45f1eab5-3239-455d-adeb-6c4d66561018\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/9945a75a-a160-43ed-a003-ba3979ed31e7\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"6dafdfba-e24c-48af-8b32-c357c987e9f2\",\n      \"networkId\" : \"485b22c0-1c30-493d-8c13-faacfdd9f3a4\",\n      \"resourceId\" : \"5592b4b6-053a-458b-9f88-f8c19109612f\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : true,\n      \"online\" : true,\n      \"lastOnlineAt\" : \"2025-11-17T16:25:56.458501Z\",\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:56.458501Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:56.458511Z\",\n      \"createdBy\" : \"3269161b-ac37-4806-bbb4-1a08b3a1e95b\",\n      \"createdAt\" : \"2025-11-17T16:35:56.460339Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:56.460339Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/485b22c0-1c30-493d-8c13-faacfdd9f3a4\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6dafdfba-e24c-48af-8b32-c357c987e9f2\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/5592b4b6-053a-458b-9f88-f8c19109612f\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"73ab54a5-0f61-4eb5-b230-33665b3ba1c0\",\n      \"networkId\" : \"466e4c84-d83f-41f0-a7e6-09f6aee32adc\",\n      \"resourceId\" : \"febc4c8b-9df5-40c1-87a6-f2d4db854171\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : false,\n      \"online\" : false,\n      \"lastOnlineAt\" : null,\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:59.697542Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:59.697554Z\",\n      \"createdBy\" : \"0b3de52f-cc41-43fb-bbe5-26e6fb88ede2\",\n      \"createdAt\" : \"2025-11-17T16:35:59.705123Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:59.705123Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/466e4c84-d83f-41f0-a7e6-09f6aee32adc\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/73ab54a5-0f61-4eb5-b230-33665b3ba1c0\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/febc4c8b-9df5-40c1-87a6-f2d4db854171\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"8476e791-2db1-46f3-89a2-41d123620646\",\n      \"networkId\" : \"4cade0a1-7fc6-418f-bbf8-3a79b58bf01d\",\n      \"resourceId\" : \"1c55c967-2057-46b7-80c3-21777717c378\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : false,\n      \"online\" : false,\n      \"lastOnlineAt\" : null,\n      \"softwareConfigurationPortEnabled\" : false,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:57.104927Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:57.104936Z\",\n      \"createdBy\" : \"eeb98584-2444-46bd-a106-5413b66e916b\",\n      \"createdAt\" : \"2025-11-17T16:35:57.108225Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:57.682245Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/4cade0a1-7fc6-418f-bbf8-3a79b58bf01d\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/8476e791-2db1-46f3-89a2-41d123620646\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1c55c967-2057-46b7-80c3-21777717c378\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"94b9264f-f32b-4ee0-acd4-fa8598179050\",\n      \"networkId\" : \"333be85e-a7a1-4c41-9c0d-a82ae5aebe8a\",\n      \"resourceId\" : \"fa571a49-7839-455c-98e8-8dc8681ed108\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : false,\n      \"online\" : false,\n      \"lastOnlineAt\" : null,\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:30:55.457425Z\",\n      \"nextCheckAt\" : \"2025-11-17T16:37:25.556570Z\",\n      \"createdBy\" : \"bc73a8be-0a38-4b2f-9d4d-bfb66e7a833c\",\n      \"createdAt\" : \"2025-11-17T16:35:55.434725Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:55.561278Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/333be85e-a7a1-4c41-9c0d-a82ae5aebe8a\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/94b9264f-f32b-4ee0-acd4-fa8598179050\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/fa571a49-7839-455c-98e8-8dc8681ed108\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"c95c8cb3-1069-4ce1-83a2-c8089bc1e9fe\",\n      \"networkId\" : \"f4983204-3ffc-4ada-82f5-dacfb4f2d517\",\n      \"resourceId\" : \"9ac442db-a3fe-4161-b541-bce1a4c39d76\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : false,\n      \"online\" : false,\n      \"lastOnlineAt\" : null,\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:56.631497Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:56.631506Z\",\n      \"createdBy\" : \"56809872-17fa-41f5-b9fd-80c59df5ee43\",\n      \"createdAt\" : \"2025-11-17T16:35:56.633333Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:56.633333Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/f4983204-3ffc-4ada-82f5-dacfb4f2d517\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/c95c8cb3-1069-4ce1-83a2-c8089bc1e9fe\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/9ac442db-a3fe-4161-b541-bce1a4c39d76\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"cf38286c-e132-4249-b876-a1a560938f69\",\n      \"networkId\" : \"d473542d-f893-45d0-9809-296e590928c0\",\n      \"resourceId\" : \"57b2afe1-60bc-412a-a8e7-0f30998f8cc0\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : true,\n      \"online\" : true,\n      \"lastOnlineAt\" : \"2025-11-17T16:25:55.960830Z\",\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:55.960830Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:55.960838Z\",\n      \"createdBy\" : \"ba99319d-02a8-4287-824a-ade7a28e6ad6\",\n      \"createdAt\" : \"2025-11-17T16:35:55.964203Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:55.964203Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/d473542d-f893-45d0-9809-296e590928c0\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/cf38286c-e132-4249-b876-a1a560938f69\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/57b2afe1-60bc-412a-a8e7-0f30998f8cc0\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"d0105f4c-4e61-440d-a47d-291a54209cee\",\n      \"networkId\" : \"2da780b4-2cab-4dc0-a5f9-97da10c5dec8\",\n      \"resourceId\" : \"dd857c98-903d-44ff-9684-b5bb1e005902\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : false,\n      \"online\" : false,\n      \"lastOnlineAt\" : null,\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:30:59.147702Z\",\n      \"nextCheckAt\" : \"2025-11-17T16:37:29.223028Z\",\n      \"createdBy\" : \"cd03b940-615c-43bd-ab24-93b8aa9da036\",\n      \"createdAt\" : \"2025-11-17T16:35:59.131674Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:59.223851Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/2da780b4-2cab-4dc0-a5f9-97da10c5dec8\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/d0105f4c-4e61-440d-a47d-291a54209cee\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/dd857c98-903d-44ff-9684-b5bb1e005902\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"d27860a8-99cf-4a96-9b8f-13d7ee20d0a6\",\n      \"networkId\" : \"ec5dc045-74a3-4250-b8b4-74dbb96ebb95\",\n      \"resourceId\" : \"d81b5558-03da-4bc0-aa88-2da9f021ac8c\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : true,\n      \"online\" : true,\n      \"lastOnlineAt\" : \"2025-11-17T16:25:58.916975Z\",\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:58.916975Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:58.916983Z\",\n      \"createdBy\" : \"48213ca0-7f5c-42de-a416-45acfcd46c1d\",\n      \"createdAt\" : \"2025-11-17T16:35:58.921207Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:58.921207Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/ec5dc045-74a3-4250-b8b4-74dbb96ebb95\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/d27860a8-99cf-4a96-9b8f-13d7ee20d0a6\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/d81b5558-03da-4bc0-aa88-2da9f021ac8c\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"f966cb01-903c-43d2-8d5f-8e72a4196ff4\",\n      \"networkId\" : \"9b32247f-ecc9-4107-ae6d-00b947c4cc9c\",\n      \"resourceId\" : \"d45eef7b-d4ee-45b9-a6cd-d3a78d59dd17\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : true,\n      \"online\" : true,\n      \"lastOnlineAt\" : \"2025-11-17T16:25:56.956513Z\",\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:56.956513Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:56.956523Z\",\n      \"createdBy\" : \"8e3649a4-476e-41cc-b41f-320467060420\",\n      \"createdAt\" : \"2025-11-17T16:35:56.960350Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:56.960350Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/9b32247f-ecc9-4107-ae6d-00b947c4cc9c\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/f966cb01-903c-43d2-8d5f-8e72a4196ff4\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/d45eef7b-d4ee-45b9-a6cd-d3a78d59dd17\",\n          \"title\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"fb364da6-9fb5-472c-9476-a815f5b61b63\",\n      \"networkId\" : \"e6254b59-b1e6-446d-ab27-8558d63b6700\",\n      \"resourceId\" : \"17274d32-8048-4104-afef-4a4284c8486a\",\n      \"resourceType\" : \"NETWORK_CONTROLLER\",\n      \"enabled\" : false,\n      \"online\" : false,\n      \"lastOnlineAt\" : null,\n      \"softwareConfigurationPortEnabled\" : true,\n      \"lastCheckedAt\" : \"2025-11-17T16:25:58.229324Z\",\n      \"nextCheckAt\" : \"2025-11-17T17:35:58.229333Z\",\n      \"createdBy\" : \"45e40de9-d8f4-4d2b-a4d1-efabb0d3e988\",\n      \"createdAt\" : \"2025-11-17T16:35:58.233963Z\",\n      \"updatedAt\" : \"2025-11-17T16:35:58.233963Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/e6254b59-b1e6-446d-ab27-8558d63b6700\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/fb364da6-9fb5-472c-9476-a815f5b61b63\"\n        },\n        \"network-controller\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/17274d32-8048-4104-afef-4a4284c8486a\",\n          \"title\" : \"parent\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 3500,\n    \"totalElements\" : 14,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Host Addresses

Manages Host addresses

Find Cloud Addresses

Returns reserved Host addresses within the specified Network, optionally filtered by cloud provider and region. Results are filtered to only include resources the caller may read.

Authorizations:

bearerAuth

query Parameters

provider	Array of strings Items Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Example: provider=AWS Filter to cloud provider(s). Repeat to specify multiple.
networkId required	string <uuid> Example: networkId=11111111-2222-3333-4444-555555555555 Network ID to scope the search.
region	string Example: region=us-east-1 Filter by cloud region code.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample find cloud addresses response

"{\n  \"_embedded\" : {\n    \"hostAddressList\" : [ {\n      \"ip\" : \"1.2.3.4\",\n      \"networkId\" : \"b941e6b5-209a-4075-9a0f-9abcabc83107\",\n      \"provider\" : \"AWS\",\n      \"region\" : \"us-east-1\",\n      \"createdAt\" : \"2025-11-17T16:33:16.416805Z\",\n      \"expiresAt\" : \"2025-11-27T16:33:16.416806Z\",\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses/1.2.3.4\"\n        },\n        \"addresses\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses?networkId=b941e6b5-209a-4075-9a0f-9abcabc83107\"\n        }\n      }\n    }, {\n      \"ip\" : \"2.3.4.5\",\n      \"networkId\" : \"b941e6b5-209a-4075-9a0f-9abcabc83107\",\n      \"provider\" : \"GCP\",\n      \"region\" : \"us-east1\",\n      \"createdAt\" : \"2025-11-17T16:33:16.416816Z\",\n      \"expiresAt\" : \"2025-11-27T16:33:16.416816Z\",\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses/2.3.4.5\"\n        },\n        \"addresses\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses?networkId=b941e6b5-209a-4075-9a0f-9abcabc83107\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses?networkId=b941e6b5-209a-4075-9a0f-9abcabc83107\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 2,\n    \"totalElements\" : 2,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Allocate Cloud Address

Reserves a public IP address with the specified cloud provider and region within the given Network. The caller must have create permission for Networks.

Authorizations:

bearerAuth

header Parameters

nf-validate

string

Request Body schema: application/json
required

Cloud address allocation payload.

provider required	string Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Cloud provider where the address will be allocated.
networkId required	string <uuid> ID of the Network in which to allocate the address.
region required	string Cloud region code where the address will be allocated.

Responses

Request samples

Payload

Content type

application/json

aws-east-1

{"provider": "AWS",
"networkId": "11111111-2222-3333-4444-555555555555",
"region": "us-east-1"
}

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample allocate cloud address response

"{\n  \"ip\" : \"1.2.3.4\",\n  \"networkId\" : \"ec4c4313-4818-4385-88cd-9ad2f24f00b6\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"createdAt\" : \"2025-11-17T16:33:15.894872Z\",\n  \"expiresAt\" : \"2025-11-27T16:33:15.894883Z\",\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses/1.2.3.4\"\n    },\n    \"addresses\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses?networkId=ec4c4313-4818-4385-88cd-9ad2f24f00b6\"\n    }\n  }\n}"

Get Cloud Address

Returns the reserved Host address resource for the specified IP. The caller must have read permission on the owning Network.

Authorizations:

bearerAuth

path Parameters

ip

required

string

Example: 203.0.113.10

The IP address for which to retrieve the cloud address resource.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get cloud address response

"{\n  \"ip\" : \"1.2.3.4\",\n  \"networkId\" : \"66df3494-8726-4847-9c22-74aae27cc696\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"createdAt\" : \"2025-11-17T16:33:13.865113Z\",\n  \"expiresAt\" : \"2025-11-27T16:33:13.865214Z\",\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses/1.2.3.4\"\n    },\n    \"addresses\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses?networkId=66df3494-8726-4847-9c22-74aae27cc696\"\n    }\n  }\n}"

Release Cloud Address

Releases the reserved Host address identified by IP. The address is released but the address record is not expired. This action cannot be undone. The caller must have delete permission on the owning Network.

Authorizations:

bearerAuth

path Parameters

ip

required

string

Example: 203.0.113.10

The IP address of the cloud address to be released.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample release cloud address response

"{\n  \"ip\" : \"1.2.3.4\",\n  \"networkId\" : \"f965c1b4-c62f-42b9-a2bc-a3c4dc049b38\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"createdAt\" : \"2025-11-17T16:33:16.322872Z\",\n  \"expiresAt\" : \"2025-11-27T16:33:16.322873Z\",\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses/1.2.3.4\"\n    },\n    \"addresses\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/host-addresses?networkId=f965c1b4-c62f-42b9-a2bc-a3c4dc049b38\"\n    }\n  }\n}"

Container Sizes

Retrieves Container Sizes

Find Container Sizes

Returns container sizes aggregated across the selected cloud providers and optional container type filter. If no provider is specified, all providers are included. If no type is specified, both NC and ER sizes are returned.

Authorizations:

bearerAuth

query Parameters

provider	Array of strings Items Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Example: provider=AWS Filter to cloud provider(s). Repeat to specify multiple.
type	string Example: type=ER Container type filter. Accepts NC (NetworkController) or ER (EdgeRouter).

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample find container sizes response

"{\n  \"_embedded\" : {\n    \"containerSizeList\" : [ {\n      \"name\" : \"small\",\n      \"containerType\" : \"BOOTSTRAPPER\",\n      \"providers\" : [ \"GCP\", \"OCI\", \"AWS\", \"AZURE\" ],\n      \"description\" : [ ],\n      \"default\" : true,\n      \"containerImage\" : null,\n      \"containerPort\" : null\n    }, {\n      \"name\" : \"medium\",\n      \"containerType\" : \"BOOTSTRAPPER\",\n      \"providers\" : [ \"GCP\", \"OCI\", \"AWS\", \"AZURE\" ],\n      \"description\" : [ ],\n      \"default\" : false,\n      \"containerImage\" : null,\n      \"containerPort\" : null\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/container-sizes\"\n    },\n    \"providers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/cloud-providers\"\n    }\n  }\n}"

Network Groups

Manage Network Groups

Get a Network Group by ID

Returns a single Network Group by its unique identifier. The caller must have read permission on the NetworkGroup resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the NetworkGroup.

query Parameters

embed

Array of strings

Items Enum: "all" "networks" "dns-zones"

Embed related resources in the result. Allowed: all | networks | dns-zones.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get network group response

"{\n  \"id\" : \"deeb86cd-4321-4cb3-a047-cda66dcc9aa0\",\n  \"name\" : \"Test-NG\",\n  \"shortName\" : \"nw-7741\",\n  \"billingAccountId\" : \"6fbabe55-82c4-4670-b19e-1c256e491a22\",\n  \"ownerIdentityId\" : \"69f5a9e3-0cab-48cd-9cb5-6a79ba75717f\",\n  \"createdBy\" : \"9d274476-2abf-4644-80b1-484841034446\",\n  \"createdAt\" : \"2025-11-17T16:26:00.134545Z\",\n  \"updatedAt\" : \"2025-11-17T16:26:00.134545Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/deeb86cd-4321-4cb3-a047-cda66dcc9aa0\",\n      \"title\" : \"Test-NG\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks?networkGroupId=deeb86cd-4321-4cb3-a047-cda66dcc9aa0\"\n    },\n    \"dns-zones\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones?networkGroupId=deeb86cd-4321-4cb3-a047-cda66dcc9aa0\"\n    }\n  }\n}"

Update a Network Group

Updates mutable fields of a Network Group. Only provided fields will be changed. The caller must have update permission on the NetworkGroup resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the NetworkGroup.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Network Group update payload

name	string New human-friendly name for the Network Group.
billingAccountId	string <uuid> Billing Account ID to associate with this Network Group.
ownerIdentityId	string <uuid> Identity ID of the owner for this Network Group.

Responses

Request samples

Payload

Content type

application/json

rename

{"name": "eng-platform"
}

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample update network group response

"{\n  \"id\" : \"cc99d3d0-8254-4749-af29-58086fe5623e\",\n  \"name\" : \"Updated NG Name-767\",\n  \"shortName\" : \"nw-7691\",\n  \"billingAccountId\" : \"39e0a8de-bf1c-4ec7-b0ab-bb32759ffdf8\",\n  \"ownerIdentityId\" : \"50ddbd4b-4d84-48c1-8c7d-740184987c81\",\n  \"createdBy\" : \"55e0291e-cc12-4458-a9ee-6d3e9ba49f79\",\n  \"createdAt\" : \"2025-11-17T16:25:59.929869Z\",\n  \"updatedAt\" : \"2025-11-17T16:25:59.948231Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/cc99d3d0-8254-4749-af29-58086fe5623e\",\n      \"title\" : \"Updated NG Name-767\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/776e1758-10c7-41cc-a280-dd2472e07a85\",\n      \"title\" : \"Update NetworkGroup\",\n      \"profile\" : \"meta\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks?networkGroupId=cc99d3d0-8254-4749-af29-58086fe5623e\"\n    },\n    \"dns-zones\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones?networkGroupId=cc99d3d0-8254-4749-af29-58086fe5623e\"\n    }\n  }\n}"

Delete a Network Group

Deletes a Network Group and returns the deleted resource with execution metadata if available. The caller must have delete permission on the NetworkGroup resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the NetworkGroup.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample delete network group response

"{\n  \"id\" : \"a89ad72d-af65-41cb-a2ec-cca9e747ddac\",\n  \"name\" : \"Test-NG\",\n  \"shortName\" : \"nw-7661\",\n  \"billingAccountId\" : \"188111b9-9407-4286-ac6f-286c1491b65e\",\n  \"ownerIdentityId\" : \"47705e07-9adf-4069-bddf-24cc1e50e6ef\",\n  \"createdBy\" : \"4846c4fa-924f-4a96-bb98-43e6b6358112\",\n  \"createdAt\" : \"2025-11-17T16:25:59.878599Z\",\n  \"updatedAt\" : \"2025-11-17T16:25:59.889243Z\",\n  \"deletedBy\" : \"5bb7d738-2f86-4118-82aa-9d4ea20f6e64\",\n  \"deletedAt\" : \"2025-11-17T16:25:59.889Z\",\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/a89ad72d-af65-41cb-a2ec-cca9e747ddac\",\n      \"title\" : \"Test-NG\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/da6cc486-ac67-4a93-a6e4-36b59f29398a\",\n      \"title\" : \"Delete NetworkGroup\",\n      \"profile\" : \"meta\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks?networkGroupId=a89ad72d-af65-41cb-a2ec-cca9e747ddac\"\n    },\n    \"dns-zones\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones?networkGroupId=a89ad72d-af65-41cb-a2ec-cca9e747ddac\"\n    }\n  }\n}"

Update a Network Group

Updates mutable fields of a Network Group. Only provided fields will be changed. The caller must have update permission on the NetworkGroup resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the NetworkGroup.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Network Group update payload

name	string New human-friendly name for the Network Group.
billingAccountId	string <uuid> Billing Account ID to associate with this Network Group.
ownerIdentityId	string <uuid> Identity ID of the owner for this Network Group.

Responses

Request samples

Payload

Content type

application/json

rename

{"name": "eng-platform"
}

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample update network group response

"{\n  \"id\" : \"cc99d3d0-8254-4749-af29-58086fe5623e\",\n  \"name\" : \"Updated NG Name-767\",\n  \"shortName\" : \"nw-7691\",\n  \"billingAccountId\" : \"39e0a8de-bf1c-4ec7-b0ab-bb32759ffdf8\",\n  \"ownerIdentityId\" : \"50ddbd4b-4d84-48c1-8c7d-740184987c81\",\n  \"createdBy\" : \"55e0291e-cc12-4458-a9ee-6d3e9ba49f79\",\n  \"createdAt\" : \"2025-11-17T16:25:59.929869Z\",\n  \"updatedAt\" : \"2025-11-17T16:25:59.948231Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/cc99d3d0-8254-4749-af29-58086fe5623e\",\n      \"title\" : \"Updated NG Name-767\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/776e1758-10c7-41cc-a280-dd2472e07a85\",\n      \"title\" : \"Update NetworkGroup\",\n      \"profile\" : \"meta\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks?networkGroupId=cc99d3d0-8254-4749-af29-58086fe5623e\"\n    },\n    \"dns-zones\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones?networkGroupId=cc99d3d0-8254-4749-af29-58086fe5623e\"\n    }\n  }\n}"

Find Network Groups

Returns Network Groups matching the optional query parameters. Results are filtered to only include resources the caller may read.

Authorizations:

bearerAuth

query Parameters

id	any Example: id=8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b Filter by Network Group ID(s). Repeat to specify multiple.
name	any Example: name=engineering-networks Filter by exact name(s). Repeat to specify multiple.
shortName	any Example: shortName=eng123 Filter by short name(s).
billingAccountId	any Example: billingAccountId=11111111-2222-3333-4444-555555555555 Filter by Billing Account ID(s).
ownerIdentityId	any Example: ownerIdentityId=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Filter by Owner Identity ID(s).
createdBy	any Example: createdBy=bbbbbbbb-1111-2222-3333-cccccccccccc Filter by creator identity ID(s).
deletedBy	any Example: deletedBy=dddddddd-eeee-ffff-1111-222222222222 Filter by deleter identity ID(s).
createdAt	any Example: createdAt=>=2025-01-01T00:00:00Z Created-at filter expressions. Supports >, >=, <, <=, =, != (e.g., createdAt=>=2025-01-01T00:00:00Z).
updatedAt	any Example: updatedAt=<=2025-12-31T23:59:59Z Updated-at filter expressions.
deletedAt	any Example: deletedAt=>2025-10-01T00:00:00Z Deleted-at filter expressions.
page	any Page index (0-based).
size	any Example: size=20 Page size.
sort	any Example: sort=name,asc Sort expressions, e.g., name,updatedAt,desc.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample find network groups response

"{\n  \"_embedded\" : {\n    \"networkGroupList\" : [ {\n      \"id\" : \"50deab14-9dc9-49b2-8ad3-fcb9c332f10c\",\n      \"name\" : \"Test-NG\",\n      \"shortName\" : \"nw-7641\",\n      \"billingAccountId\" : \"a8d8e318-22e9-40e5-8b28-3077a5e60a27\",\n      \"ownerIdentityId\" : \"db041d3e-aa20-45a7-aede-503dc2d6c13b\",\n      \"createdBy\" : \"c61829f9-1949-42cf-8660-ea688af61481\",\n      \"createdAt\" : \"2025-11-17T16:25:59.766564Z\",\n      \"updatedAt\" : \"2025-11-17T16:25:59.805406Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/50deab14-9dc9-49b2-8ad3-fcb9c332f10c\",\n          \"title\" : \"Test-NG\"\n        },\n        \"networks\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks?networkGroupId=50deab14-9dc9-49b2-8ad3-fcb9c332f10c\"\n        },\n        \"dns-zones\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones?networkGroupId=50deab14-9dc9-49b2-8ad3-fcb9c332f10c\"\n        }\n      }\n    }, {\n      \"id\" : \"abb73aa1-649e-4ff2-b82d-7dbaa7cdb7ba\",\n      \"name\" : \"Test-NG\",\n      \"shortName\" : \"nw-7721\",\n      \"billingAccountId\" : \"4286e3bd-83a4-4a74-9ea6-df43a0ad7648\",\n      \"ownerIdentityId\" : \"aa0e33c5-9526-457d-8c14-5d41d0284e7b\",\n      \"createdBy\" : \"ebb82001-fdb1-4a1d-a9da-30d7747607de\",\n      \"createdAt\" : \"2025-11-17T16:26:00.082643Z\",\n      \"updatedAt\" : \"2025-11-17T16:26:00.082643Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/abb73aa1-649e-4ff2-b82d-7dbaa7cdb7ba\",\n          \"title\" : \"Test-NG\"\n        },\n        \"networks\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks?networkGroupId=abb73aa1-649e-4ff2-b82d-7dbaa7cdb7ba\"\n        },\n        \"dns-zones\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones?networkGroupId=abb73aa1-649e-4ff2-b82d-7dbaa7cdb7ba\"\n        }\n      }\n    }, {\n      \"id\" : \"cc99d3d0-8254-4749-af29-58086fe5623e\",\n      \"name\" : \"Updated NG Name-767\",\n      \"shortName\" : \"nw-7691\",\n      \"billingAccountId\" : \"39e0a8de-bf1c-4ec7-b0ab-bb32759ffdf8\",\n      \"ownerIdentityId\" : \"50ddbd4b-4d84-48c1-8c7d-740184987c81\",\n      \"createdBy\" : \"55e0291e-cc12-4458-a9ee-6d3e9ba49f79\",\n      \"createdAt\" : \"2025-11-17T16:25:59.929869Z\",\n      \"updatedAt\" : \"2025-11-17T16:25:59.948231Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/cc99d3d0-8254-4749-af29-58086fe5623e\",\n          \"title\" : \"Updated NG Name-767\"\n        },\n        \"networks\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks?networkGroupId=cc99d3d0-8254-4749-af29-58086fe5623e\"\n        },\n        \"dns-zones\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones?networkGroupId=cc99d3d0-8254-4749-af29-58086fe5623e\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 3500,\n    \"totalElements\" : 3,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Create a Network Group

Creates a new Network Group. Requires the caller to have create NetworkGroup permission.

Authorizations:

bearerAuth

header Parameters

nf-validate

string

Request Body schema: application/json
required

Network Group creation payload

name	string Human-friendly name for the Network Group (unique within your organization).
billingAccountId	string <uuid> Billing Account ID that will be charged for this Network Group.
ownerIdentityId	string <uuid> Identity ID of the owner for this Network Group. If omitted, defaults to the caller's identity.

Responses

Request samples

Payload

Content type

application/json

basic

{"name": "engineering-networks",
"billingAccountId": "11111111-2222-3333-4444-555555555555",
"ownerIdentityId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample create network group response

"{\n  \"id\" : \"8916be5a-e9fc-4e69-8b45-366529c60356\",\n  \"name\" : \"New NG\",\n  \"shortName\" : \"NEWNG\",\n  \"billingAccountId\" : \"6a528dd4-e082-4e7e-9598-1851662c5150\",\n  \"ownerIdentityId\" : \"c028edcc-f537-429e-862d-f6ea14863a89\",\n  \"createdBy\" : \"811b10d1-c77a-46ac-96f9-165a43bf359e\",\n  \"createdAt\" : \"2025-11-17T16:26:00.180419Z\",\n  \"updatedAt\" : \"2025-11-17T16:26:00.180419Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/8916be5a-e9fc-4e69-8b45-366529c60356\",\n      \"title\" : \"New NG\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/681ea7c7-dbc5-4531-90bf-a981efcc146d\",\n      \"title\" : \"Create NetworkGroup\",\n      \"profile\" : \"meta\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks?networkGroupId=8916be5a-e9fc-4e69-8b45-366529c60356\"\n    },\n    \"dns-zones\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones?networkGroupId=8916be5a-e9fc-4e69-8b45-366529c60356\"\n    }\n  }\n}"

Dns Zones

Manage DnsZone resources

Get DnsZone

Returns a single DnsZone by its unique identifier. The caller must have read permission on the DnsZone resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the DnsZone.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get DnsZone response

"{\n  \"id\" : \"7b63d2c4-2f7c-462d-bf71-f8bd4752455a\",\n  \"networkGroupId\" : \"2dd67abf-abdf-46ea-a0c5-5aeef81f5447\",\n  \"name\" : \"test-v3-domain.com\",\n  \"route53ZoneId\" : \"zoneId-1911\",\n  \"domain\" : \"domain.io.\",\n  \"validated\" : false,\n  \"createdBy\" : \"47ad074f-2f7d-4066-bd94-f320e86bdda2\",\n  \"createdAt\" : \"2025-12-05T15:21:16.828933Z\",\n  \"updatedAt\" : \"2025-12-05T15:21:16.828933Z\",\n  \"deletedAt\" : null,\n  \"deletedBy\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/7b63d2c4-2f7c-462d-bf71-f8bd4752455a\",\n      \"title\" : \"test-v3-domain.com\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/2dd67abf-abdf-46ea-a0c5-5aeef81f5447\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Update DnsZone

Updates mutable fields of a DnsZone. Currently only the name is supported. The caller must have update permission on the DnsZone resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the DnsZone.

header Parameters

nf-validate

string

Request Body schema: application/json
required

DnsZone update payload.

name	string New human-friendly name for the DnsZone.

Responses

Request samples

Payload

Content type

application/json

rename

{"name": "corp-zone-renamed"
}

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample update DnsZone response

"{\n  \"id\" : \"98467000-bcc6-438c-b9ea-af3c0a39f8ae\",\n  \"networkGroupId\" : \"892632d0-0be5-49e9-86d2-19a45dfad558\",\n  \"name\" : \"updated-1921\",\n  \"route53ZoneId\" : \"zoneId-1920\",\n  \"domain\" : \"domain.io.\",\n  \"validated\" : false,\n  \"createdBy\" : \"e059f248-8100-451a-b497-50ecb25fcd11\",\n  \"createdAt\" : \"2025-12-05T15:21:16.944558Z\",\n  \"updatedAt\" : \"2025-12-05T15:21:16.960957Z\",\n  \"deletedAt\" : null,\n  \"deletedBy\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/98467000-bcc6-438c-b9ea-af3c0a39f8ae\",\n      \"title\" : \"updated-1921\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/892632d0-0be5-49e9-86d2-19a45dfad558\",\n      \"profile\" : \"parent\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/4fc9f009-f3e9-45bc-85c1-ae209abd2986\",\n      \"title\" : \"Update DnsZone\",\n      \"profile\" : \"meta\"\n    }\n  }\n}"

Delete DnsZone

Deletes a DnsZone by ID after ensuring it is not referenced by any Network. Requires delete permission on the DnsZone resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the DnsZone to delete.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample delete DnsZone response

"{\n  \"id\" : \"2005d176-eb73-4531-936e-953078e61f3e\",\n  \"networkGroupId\" : \"304e6164-8186-40d4-90fc-bb191161f2de\",\n  \"name\" : \"toDelete\",\n  \"route53ZoneId\" : \"zoneId-1947\",\n  \"domain\" : \"domain.io.\",\n  \"validated\" : false,\n  \"createdBy\" : \"ebda3917-48c8-43ef-91e6-9991a8107b67\",\n  \"createdAt\" : \"2025-12-05T15:21:17.378379Z\",\n  \"updatedAt\" : \"2025-12-05T15:21:17.404725Z\",\n  \"deletedAt\" : \"2025-12-05T15:21:17.405Z\",\n  \"deletedBy\" : \"e9443adf-45cd-4444-8cc1-2d44fd0095d6\",\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/2005d176-eb73-4531-936e-953078e61f3e\",\n      \"title\" : \"toDelete\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/304e6164-8186-40d4-90fc-bb191161f2de\",\n      \"profile\" : \"parent\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/c9a24cd2-f21f-4e13-9f41-f776f5090acd\",\n      \"title\" : \"Delete DnsZone\",\n      \"profile\" : \"meta\"\n    }\n  }\n}"

Update DnsZone

Updates mutable fields of a DnsZone. Currently only the name is supported. The caller must have update permission on the DnsZone resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the DnsZone.

header Parameters

nf-validate

string

Request Body schema: application/json
required

DnsZone update payload.

name	string New human-friendly name for the DnsZone.

Responses

Request samples

Payload

Content type

application/json

rename

{"name": "corp-zone-renamed"
}

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample update DnsZone response

"{\n  \"id\" : \"98467000-bcc6-438c-b9ea-af3c0a39f8ae\",\n  \"networkGroupId\" : \"892632d0-0be5-49e9-86d2-19a45dfad558\",\n  \"name\" : \"updated-1921\",\n  \"route53ZoneId\" : \"zoneId-1920\",\n  \"domain\" : \"domain.io.\",\n  \"validated\" : false,\n  \"createdBy\" : \"e059f248-8100-451a-b497-50ecb25fcd11\",\n  \"createdAt\" : \"2025-12-05T15:21:16.944558Z\",\n  \"updatedAt\" : \"2025-12-05T15:21:16.960957Z\",\n  \"deletedAt\" : null,\n  \"deletedBy\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/98467000-bcc6-438c-b9ea-af3c0a39f8ae\",\n      \"title\" : \"updated-1921\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/892632d0-0be5-49e9-86d2-19a45dfad558\",\n      \"profile\" : \"parent\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/4fc9f009-f3e9-45bc-85c1-ae209abd2986\",\n      \"title\" : \"Update DnsZone\",\n      \"profile\" : \"meta\"\n    }\n  }\n}"

Validate DnsZone

Validates the DNS Zone by comparing public DNS TXT records against the provider's hosted zone records. Returns a validation result indicating success or the failure reason. The caller must have update permission on the DnsZone resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the DnsZone to validate.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample validate DnsZone response

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

Find DnsZones

Returns DnsZones matching the optional query parameters. Results are filtered to only include resources the caller may read.

Authorizations:

bearerAuth

query Parameters

id	any Example: id=8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b Filter by DnsZone ID(s).
networkGroupId	any Example: networkGroupId=11111111-2222-3333-4444-555555555555 Filter by Network Group ID(s).
name	any Example: name=corp-zone Filter by DnsZone name(s).
route53ZoneId	any Example: route53ZoneId=Z04008363AMXYS4T3J7OB Filter by provider hosted zone identifier(s).
domain	any Example: domain=example.com Filter by root domain(s). Supports % wildcard.
validated	any Example: validated=true Filter by validation status.
createdBy	any Example: createdBy=bbbbbbbb-1111-2222-3333-cccccccccccc Filter by creator identity ID(s).
deletedBy	any Example: deletedBy=dddddddd-eeee-ffff-1111-222222222222 Filter by deleter identity ID(s).
createdAt	any Example: createdAt=>=2025-01-01T00:00:00Z Created-at filter expressions. Supports >, >=, <, <=, =, != (e.g., createdAt=>=2025-01-01T00:00:00Z).
updatedAt	any Example: updatedAt=<=2025-12-31T23:59:59Z Updated-at filter expressions.
deletedAt	any Example: deletedAt=>2025-10-01T00:00:00Z Deleted-at filter expressions.
page	any Page index (0-based).
size	any Example: size=20 Page size.
sort	any Example: sort=name,asc Sort expressions, e.g., name,updatedAt,desc.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample find DnsZones response

"{\n  \"_embedded\" : {\n    \"dnsZoneList\" : [ {\n      \"id\" : \"2d1c33ec-e98d-4074-bbcd-4e2b6b451945\",\n      \"networkGroupId\" : \"d744a5e9-387c-4cbc-a303-cb6af4b772e7\",\n      \"name\" : \"test-v3-domain.com\",\n      \"route53ZoneId\" : \"zoneId-1942\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"d202f524-7f3b-4c35-ae13-e030202c0c6b\",\n      \"createdAt\" : \"2025-12-05T15:21:17.308445Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:17.308445Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/2d1c33ec-e98d-4074-bbcd-4e2b6b451945\",\n          \"title\" : \"test-v3-domain.com\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/d744a5e9-387c-4cbc-a303-cb6af4b772e7\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"459a527a-6de6-4d3f-a3fd-b2538ccc0f29\",\n      \"networkGroupId\" : \"99c27478-ae51-4535-b9a9-74289881bc43\",\n      \"name\" : \"firstName-1931\",\n      \"route53ZoneId\" : \"zoneId-1932\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"185a9c85-afb7-431b-b6b0-5793b2fe8039\",\n      \"createdAt\" : \"2025-12-05T15:21:17.141968Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:17.141968Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/459a527a-6de6-4d3f-a3fd-b2538ccc0f29\",\n          \"title\" : \"firstName-1931\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/99c27478-ae51-4535-b9a9-74289881bc43\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"4dcbe027-c3bb-4c1e-8f51-f0bf750cc74a\",\n      \"networkGroupId\" : \"fa7ab687-e791-47fd-a239-28e1383b00ac\",\n      \"name\" : \"test-v3-domain.com\",\n      \"route53ZoneId\" : \"zoneId-1938\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"e65ff7ae-b96e-4572-be67-4e9f05fd3791\",\n      \"createdAt\" : \"2025-12-05T15:21:17.195446Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:17.195446Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/4dcbe027-c3bb-4c1e-8f51-f0bf750cc74a\",\n          \"title\" : \"test-v3-domain.com\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/fa7ab687-e791-47fd-a239-28e1383b00ac\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"73c2040e-4e9c-4123-9d96-2c2ec3aeb330\",\n      \"networkGroupId\" : \"19055a09-cac4-4770-9cb4-c3bf2aebbd73\",\n      \"name\" : \"test-v3-domain.com\",\n      \"route53ZoneId\" : \"zoneId-1925\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"ed206c83-7e8b-492e-9ee8-9fe5ef4f50a7\",\n      \"createdAt\" : \"2025-12-05T15:21:17.011654Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:17.011654Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/73c2040e-4e9c-4123-9d96-2c2ec3aeb330\",\n          \"title\" : \"test-v3-domain.com\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/19055a09-cac4-4770-9cb4-c3bf2aebbd73\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"7b63d2c4-2f7c-462d-bf71-f8bd4752455a\",\n      \"networkGroupId\" : \"2dd67abf-abdf-46ea-a0c5-5aeef81f5447\",\n      \"name\" : \"test-v3-domain.com\",\n      \"route53ZoneId\" : \"zoneId-1911\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"47ad074f-2f7d-4066-bd94-f320e86bdda2\",\n      \"createdAt\" : \"2025-12-05T15:21:16.828933Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:16.828933Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/7b63d2c4-2f7c-462d-bf71-f8bd4752455a\",\n          \"title\" : \"test-v3-domain.com\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/2dd67abf-abdf-46ea-a0c5-5aeef81f5447\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"877b756d-8d9d-47b6-bddb-a9c561c758f9\",\n      \"networkGroupId\" : \"99c27478-ae51-4535-b9a9-74289881bc43\",\n      \"name\" : \"toUpdate-1933\",\n      \"route53ZoneId\" : \"zoneId-1934\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"704536cb-958a-444d-ad4e-a5aa34049c58\",\n      \"createdAt\" : \"2025-12-05T15:21:17.145112Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:17.145112Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/877b756d-8d9d-47b6-bddb-a9c561c758f9\",\n          \"title\" : \"toUpdate-1933\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/99c27478-ae51-4535-b9a9-74289881bc43\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"8a48d038-24d9-4ece-bc79-fe96d0134fc6\",\n      \"networkGroupId\" : \"892632d0-0be5-49e9-86d2-19a45dfad558\",\n      \"name\" : \"test-v3-domain.com\",\n      \"route53ZoneId\" : \"zoneId-1919\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"c084599a-1a54-489a-882f-7528a79da399\",\n      \"createdAt\" : \"2025-12-05T15:21:16.940432Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:16.940432Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/8a48d038-24d9-4ece-bc79-fe96d0134fc6\",\n          \"title\" : \"test-v3-domain.com\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/892632d0-0be5-49e9-86d2-19a45dfad558\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"98467000-bcc6-438c-b9ea-af3c0a39f8ae\",\n      \"networkGroupId\" : \"892632d0-0be5-49e9-86d2-19a45dfad558\",\n      \"name\" : \"updated-1921\",\n      \"route53ZoneId\" : \"zoneId-1920\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"e059f248-8100-451a-b497-50ecb25fcd11\",\n      \"createdAt\" : \"2025-12-05T15:21:16.944558Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:16.960957Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/98467000-bcc6-438c-b9ea-af3c0a39f8ae\",\n          \"title\" : \"updated-1921\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/892632d0-0be5-49e9-86d2-19a45dfad558\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"b0d319c6-fa33-450b-97c0-d2d7036e4b3e\",\n      \"networkGroupId\" : \"19055a09-cac4-4770-9cb4-c3bf2aebbd73\",\n      \"name\" : \"testName-1926\",\n      \"route53ZoneId\" : \"zoneId\",\n      \"domain\" : \"domainResult\",\n      \"validated\" : false,\n      \"createdBy\" : \"0f5c462c-15e1-4f12-82f3-157005463650\",\n      \"createdAt\" : \"2025-12-05T15:21:17.092608Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:17.092608Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/b0d319c6-fa33-450b-97c0-d2d7036e4b3e\",\n          \"title\" : \"testName-1926\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/19055a09-cac4-4770-9cb4-c3bf2aebbd73\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"b3109e9a-d3c7-4533-a7fa-246428cae463\",\n      \"networkGroupId\" : \"99c27478-ae51-4535-b9a9-74289881bc43\",\n      \"name\" : \"test-v3-domain.com\",\n      \"route53ZoneId\" : \"zoneId-1930\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"3fe67d80-4af0-4be8-8846-c267827d166f\",\n      \"createdAt\" : \"2025-12-05T15:21:17.137648Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:17.137648Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/b3109e9a-d3c7-4533-a7fa-246428cae463\",\n          \"title\" : \"test-v3-domain.com\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/99c27478-ae51-4535-b9a9-74289881bc43\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"bf677e32-2d29-4da4-98e3-c326b4aed67e\",\n      \"networkGroupId\" : \"b544cfa0-4afb-45b3-bdc5-14025f497f1e\",\n      \"name\" : \"test-v3-domain.com\",\n      \"route53ZoneId\" : \"zoneId-1915\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"baeebb83-d599-40e6-8d71-8847f90300c0\",\n      \"createdAt\" : \"2025-12-05T15:21:16.908829Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:16.908829Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/bf677e32-2d29-4da4-98e3-c326b4aed67e\",\n          \"title\" : \"test-v3-domain.com\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/b544cfa0-4afb-45b3-bdc5-14025f497f1e\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"c80e3d84-d198-4ce1-b813-8b36d6be191b\",\n      \"networkGroupId\" : \"d5e197e1-cf93-4ead-a417-9de94b8c1260\",\n      \"name\" : \"updated-1907\",\n      \"route53ZoneId\" : \"zoneId-1906\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"4fad044c-6630-4664-8bba-4ce9815680a8\",\n      \"createdAt\" : \"2025-12-05T15:21:15.586661Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:16.298798Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/c80e3d84-d198-4ce1-b813-8b36d6be191b\",\n          \"title\" : \"updated-1907\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/d5e197e1-cf93-4ead-a417-9de94b8c1260\",\n          \"profile\" : \"parent\"\n        }\n      }\n    }, {\n      \"id\" : \"ca90728e-7ace-4145-b0a8-2bca2422a2a4\",\n      \"networkGroupId\" : \"d5e197e1-cf93-4ead-a417-9de94b8c1260\",\n      \"name\" : \"test-v3-domain.com\",\n      \"route53ZoneId\" : \"zoneId-1905\",\n      \"domain\" : \"domain.io.\",\n      \"validated\" : false,\n      \"createdBy\" : \"e9f2a4bc-4e0d-4b1b-b945-c5d81213bc98\",\n      \"createdAt\" : \"2025-12-05T15:21:15.570172Z\",\n      \"updatedAt\" : \"2025-12-05T15:21:15.570172Z\",\n      \"deletedAt\" : null,\n      \"deletedBy\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/ca90728e-7ace-4145-b0a8-2bca2422a2a4\",\n          \"title\" : \"test-v3-domain.com\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/d5e197e1-cf93-4ead-a417-9de94b8c1260\",\n          \"profile\" : \"parent\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 3500,\n    \"totalElements\" : 13,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Create DnsZone

Creates a new DnsZone within a Network Group. Exactly one of route53ZoneId or domain must be provided. Requires create permission on DnsZone in the specified Network Group.

Authorizations:

bearerAuth

header Parameters

nf-validate

string

Request Body schema: application/json
required

DnsZone creation payload. Provide either a Route53 hosted zone ID to reference an existing hosted zone, or a root domain to request creation/association.

networkGroupId	string <uuid> ID of the Network Group that will own this DnsZone.
name	string Human-friendly name for the DnsZone (unique within the Network Group).
route53ZoneId	string AWS Route53 hosted zone identifier. Provide this to reference an existing hosted zone.
domain	string Root domain name to host (used when creating/associating a hosted zone).

Responses

Request samples

Payload

Content type

application/json

Example

reference-existing-hosted-zone

{"networkGroupId": "11111111-2222-3333-4444-555555555555",
"name": "corp-zone",
"route53ZoneId": "Z04008363AMXYS4T3J7OB"
}

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample create DnsZone response

"{\n  \"id\" : \"b0d319c6-fa33-450b-97c0-d2d7036e4b3e\",\n  \"networkGroupId\" : \"19055a09-cac4-4770-9cb4-c3bf2aebbd73\",\n  \"name\" : \"testName-1926\",\n  \"route53ZoneId\" : \"zoneId\",\n  \"domain\" : \"domainResult\",\n  \"validated\" : false,\n  \"createdBy\" : \"0f5c462c-15e1-4f12-82f3-157005463650\",\n  \"createdAt\" : \"2025-12-05T15:21:17.092608Z\",\n  \"updatedAt\" : \"2025-12-05T15:21:17.092608Z\",\n  \"deletedAt\" : null,\n  \"deletedBy\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/dns-zones/b0d319c6-fa33-450b-97c0-d2d7036e4b3e\",\n      \"title\" : \"testName-1926\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/19055a09-cac4-4770-9cb4-c3bf2aebbd73\",\n      \"profile\" : \"parent\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/37362758-2ed4-477d-b2da-46b38b518c04\",\n      \"title\" : \"Create DnsZone\",\n      \"profile\" : \"meta\"\n    }\n  }\n}"

Edge Routers

Manages Edge Routers

Suspend Edge Router

Suspend the specified Edge Router. This will stop the edge router from running without deleting it. The operation is asynchronous and returns the updated Edge Router resource with related links. The caller must have the update-suspend permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Edge Router to suspend

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response

"{\n  \"id\" : \"c5a14b20-5311-4a7a-85d1-fa9b072a194e\",\n  \"hostId\" : \"ff2bba00-eeb9-498c-bb5b-ac43e27c3354\",\n  \"ownerIdentityId\" : \"a937e803-2fdb-428a-9ff1-b83e91f9fc5b\",\n  \"createdBy\" : \"a937e803-2fdb-428a-9ff1-b83e91f9fc5b\",\n  \"createdAt\" : \"2025-12-05T15:20:19.793074Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:19.857932Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1204\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"c5a14b20-5311-4a7a-85d1-fa9b072a194e-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1203\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"116df4d4-5b1c-43ee-bbfa-731fc3b5794f\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/c5a14b20-5311-4a7a-85d1-fa9b072a194e\",\n      \"title\" : \"er-test-1203\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/116df4d4-5b1c-43ee-bbfa-731fc3b5794f\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/ff2bba00-eeb9-498c-bb5b-ac43e27c3354\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Suspend Edge Router

Suspend the specified Edge Router. This will stop the edge router from running without deleting it. The operation is asynchronous and returns the updated Edge Router resource with related links. The caller must have the update-suspend permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Edge Router to suspend

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response

"{\n  \"id\" : \"c5a14b20-5311-4a7a-85d1-fa9b072a194e\",\n  \"hostId\" : \"ff2bba00-eeb9-498c-bb5b-ac43e27c3354\",\n  \"ownerIdentityId\" : \"a937e803-2fdb-428a-9ff1-b83e91f9fc5b\",\n  \"createdBy\" : \"a937e803-2fdb-428a-9ff1-b83e91f9fc5b\",\n  \"createdAt\" : \"2025-12-05T15:20:19.793074Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:19.857932Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1204\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"c5a14b20-5311-4a7a-85d1-fa9b072a194e-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1203\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"116df4d4-5b1c-43ee-bbfa-731fc3b5794f\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/c5a14b20-5311-4a7a-85d1-fa9b072a194e\",\n      \"title\" : \"er-test-1203\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/116df4d4-5b1c-43ee-bbfa-731fc3b5794f\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/ff2bba00-eeb9-498c-bb5b-ac43e27c3354\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Resume Edge Router

Resume the specified Edge Router. This restarts the edge router host if it is suspended. The operation is asynchronous and returns the updated Edge Router resource with related links. The caller must have the update-resume permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Edge Router to resume

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response

"{\n  \"id\" : \"47cdb694-884f-4a4f-903e-9ff3e1f45512\",\n  \"hostId\" : \"35c82219-3193-4b48-a871-d0da13dd0f3b\",\n  \"ownerIdentityId\" : \"4cc4d242-c7aa-4d18-acd7-e91300e5d6d6\",\n  \"createdBy\" : \"4cc4d242-c7aa-4d18-acd7-e91300e5d6d6\",\n  \"createdAt\" : \"2025-12-05T15:20:26.618658Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:26.680386Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1669\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"47cdb694-884f-4a4f-903e-9ff3e1f45512-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1668\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"b8d7c7cc-24f8-47aa-a4d2-7e41b981c797\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"c90b7e0b-e7b9-4c60-8d19-89f6d4f506d8\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/47cdb694-884f-4a4f-903e-9ff3e1f45512\",\n      \"title\" : \"er-test-1668\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/c90b7e0b-e7b9-4c60-8d19-89f6d4f506d8\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/b8d7c7cc-24f8-47aa-a4d2-7e41b981c797\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/35c82219-3193-4b48-a871-d0da13dd0f3b\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/c90b7e0b-e7b9-4c60-8d19-89f6d4f506d8\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Resume Edge Router

Resume the specified Edge Router. This restarts the edge router host if it is suspended. The operation is asynchronous and returns the updated Edge Router resource with related links. The caller must have the update-resume permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Edge Router to resume

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response

"{\n  \"id\" : \"47cdb694-884f-4a4f-903e-9ff3e1f45512\",\n  \"hostId\" : \"35c82219-3193-4b48-a871-d0da13dd0f3b\",\n  \"ownerIdentityId\" : \"4cc4d242-c7aa-4d18-acd7-e91300e5d6d6\",\n  \"createdBy\" : \"4cc4d242-c7aa-4d18-acd7-e91300e5d6d6\",\n  \"createdAt\" : \"2025-12-05T15:20:26.618658Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:26.680386Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1669\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"47cdb694-884f-4a4f-903e-9ff3e1f45512-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1668\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"b8d7c7cc-24f8-47aa-a4d2-7e41b981c797\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"c90b7e0b-e7b9-4c60-8d19-89f6d4f506d8\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/47cdb694-884f-4a4f-903e-9ff3e1f45512\",\n      \"title\" : \"er-test-1668\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/c90b7e0b-e7b9-4c60-8d19-89f6d4f506d8\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/b8d7c7cc-24f8-47aa-a4d2-7e41b981c797\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/35c82219-3193-4b48-a871-d0da13dd0f3b\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/c90b7e0b-e7b9-4c60-8d19-89f6d4f506d8\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Restart Edge Router Process

Schedules a restart of the Edge Router application process on the underlying host. The caller must have the update-heal permission on the Edge Router resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Edge Router whose process should be restarted.

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Sample restart process response

"{\n  \"id\" : \"0b849af9-5cc3-40cd-a28a-2628ff204259\",\n  \"hostId\" : \"0fc1038b-f971-477e-ae43-e189e99b6100\",\n  \"ownerIdentityId\" : \"9b37397b-c843-42b2-8841-76a310c64bc2\",\n  \"createdBy\" : \"9b37397b-c843-42b2-8841-76a310c64bc2\",\n  \"createdAt\" : \"2025-12-05T15:20:21.895580Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:21.950843Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1525\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"0b849af9-5cc3-40cd-a28a-2628ff204259-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1524\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"df1218f4-503f-4c25-81d4-610623f464bb\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"7b0fc820-2ffe-4123-8811-0153803934c0\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/0b849af9-5cc3-40cd-a28a-2628ff204259\",\n      \"title\" : \"er-test-1524\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/7b0fc820-2ffe-4123-8811-0153803934c0\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/df1218f4-503f-4c25-81d4-610623f464bb\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/0fc1038b-f971-477e-ae43-e189e99b6100\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/7b0fc820-2ffe-4123-8811-0153803934c0\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Restart Edge Router Process

Schedules a restart of the Edge Router application process on the underlying host. The caller must have the update-heal permission on the Edge Router resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Edge Router whose process should be restarted.

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Sample restart process response

"{\n  \"id\" : \"0b849af9-5cc3-40cd-a28a-2628ff204259\",\n  \"hostId\" : \"0fc1038b-f971-477e-ae43-e189e99b6100\",\n  \"ownerIdentityId\" : \"9b37397b-c843-42b2-8841-76a310c64bc2\",\n  \"createdBy\" : \"9b37397b-c843-42b2-8841-76a310c64bc2\",\n  \"createdAt\" : \"2025-12-05T15:20:21.895580Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:21.950843Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1525\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"0b849af9-5cc3-40cd-a28a-2628ff204259-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1524\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"df1218f4-503f-4c25-81d4-610623f464bb\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"7b0fc820-2ffe-4123-8811-0153803934c0\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/0b849af9-5cc3-40cd-a28a-2628ff204259\",\n      \"title\" : \"er-test-1524\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/7b0fc820-2ffe-4123-8811-0153803934c0\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/df1218f4-503f-4c25-81d4-610623f464bb\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/0fc1038b-f971-477e-ae43-e189e99b6100\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/7b0fc820-2ffe-4123-8811-0153803934c0\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Move Edge Router host

Move the Edge Router host to a different cloud provider/region or within the same provider/region. When moving within the same provider and region, you may either request a new IP to be assigned or specify a previously allocated IP address. The caller must have the update-move permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Edge Router to move

header Parameters

nf-validate

string

Request Body schema: application/json
required

Move request describing target provider/region and optional IP assignment.

provider required	string Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Target cloud provider for the host.
region required	string Target region within the selected provider.
assignNewIp	boolean If true, force assignment of a new IP address when moving within the same provider and region. Ignored when moving across providers/regions.
ipAddress	string A previously allocated IPv4 address to assign to the host. Provide either this value or set assignNewIp to true, but not both.
skipBackup	boolean If true, skip taking a new backup before moving. The latest existing backup will be used.

Responses

Request samples

Payload

Content type

application/json

Example

move-within-provider-assign-new-ip

Move within the same provider/region and assign a new IP

{"provider": "AWS",
"region": "us-east-1",
"assignNewIp": true
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response with links

"{\n  \"id\" : \"c5a14b20-5311-4a7a-85d1-fa9b072a194e\",\n  \"hostId\" : \"ff2bba00-eeb9-498c-bb5b-ac43e27c3354\",\n  \"ownerIdentityId\" : \"a937e803-2fdb-428a-9ff1-b83e91f9fc5b\",\n  \"createdBy\" : \"a937e803-2fdb-428a-9ff1-b83e91f9fc5b\",\n  \"createdAt\" : \"2025-12-05T15:20:19.793074Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:19.857932Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1204\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"c5a14b20-5311-4a7a-85d1-fa9b072a194e-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1203\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"116df4d4-5b1c-43ee-bbfa-731fc3b5794f\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/c5a14b20-5311-4a7a-85d1-fa9b072a194e\",\n      \"title\" : \"er-test-1203\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/116df4d4-5b1c-43ee-bbfa-731fc3b5794f\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/ff2bba00-eeb9-498c-bb5b-ac43e27c3354\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Move Edge Router host

Move the Edge Router host to a different cloud provider/region or within the same provider/region. When moving within the same provider and region, you may either request a new IP to be assigned or specify a previously allocated IP address. The caller must have the update-move permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Edge Router to move

header Parameters

nf-validate

string

Request Body schema: application/json
required

Move request describing target provider/region and optional IP assignment.

provider required	string Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Target cloud provider for the host.
region required	string Target region within the selected provider.
assignNewIp	boolean If true, force assignment of a new IP address when moving within the same provider and region. Ignored when moving across providers/regions.
ipAddress	string A previously allocated IPv4 address to assign to the host. Provide either this value or set assignNewIp to true, but not both.
skipBackup	boolean If true, skip taking a new backup before moving. The latest existing backup will be used.

Responses

Request samples

Payload

Content type

application/json

Example

move-within-provider-assign-new-ip

Move within the same provider/region and assign a new IP

{"provider": "AWS",
"region": "us-east-1",
"assignNewIp": true
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response with links

"{\n  \"id\" : \"c5a14b20-5311-4a7a-85d1-fa9b072a194e\",\n  \"hostId\" : \"ff2bba00-eeb9-498c-bb5b-ac43e27c3354\",\n  \"ownerIdentityId\" : \"a937e803-2fdb-428a-9ff1-b83e91f9fc5b\",\n  \"createdBy\" : \"a937e803-2fdb-428a-9ff1-b83e91f9fc5b\",\n  \"createdAt\" : \"2025-12-05T15:20:19.793074Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:19.857932Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1204\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"c5a14b20-5311-4a7a-85d1-fa9b072a194e-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1203\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"116df4d4-5b1c-43ee-bbfa-731fc3b5794f\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/c5a14b20-5311-4a7a-85d1-fa9b072a194e\",\n      \"title\" : \"er-test-1203\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/116df4d4-5b1c-43ee-bbfa-731fc3b5794f\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/ff2bba00-eeb9-498c-bb5b-ac43e27c3354\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/499a1b3c-c2ca-4a0e-a05c-d27cde3d030f\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Restart Edge Router Host

Schedules a restart of the Edge Router underlying host. The caller must have the update-heal permission on the Edge Router resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Edge Router whose process should be restarted.

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Sample restart process response

"{\n  \"id\" : \"2a874e05-eb13-4fe4-b088-1c5745e3bb88\",\n  \"hostId\" : \"74ba4881-65c1-4dbf-8ded-5164ad1c4897\",\n  \"ownerIdentityId\" : \"05d04d91-0d9a-4183-8d09-396431407500\",\n  \"createdBy\" : \"05d04d91-0d9a-4183-8d09-396431407500\",\n  \"createdAt\" : \"2025-12-05T15:20:17.661120Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:18.083279Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1069\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"2a874e05-eb13-4fe4-b088-1c5745e3bb88-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1068\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"b6a5a80c-3d1a-48a9-94af-89032cee34a9\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"46c08964-8c5d-465d-a675-5b4de57987a7\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/2a874e05-eb13-4fe4-b088-1c5745e3bb88\",\n      \"title\" : \"er-test-1068\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/46c08964-8c5d-465d-a675-5b4de57987a7\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/b6a5a80c-3d1a-48a9-94af-89032cee34a9\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/74ba4881-65c1-4dbf-8ded-5164ad1c4897\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/46c08964-8c5d-465d-a675-5b4de57987a7\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Restart Edge Router Host

Schedules a restart of the Edge Router underlying host. The caller must have the update-heal permission on the Edge Router resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Edge Router whose process should be restarted.

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Sample restart process response

"{\n  \"id\" : \"2a874e05-eb13-4fe4-b088-1c5745e3bb88\",\n  \"hostId\" : \"74ba4881-65c1-4dbf-8ded-5164ad1c4897\",\n  \"ownerIdentityId\" : \"05d04d91-0d9a-4183-8d09-396431407500\",\n  \"createdBy\" : \"05d04d91-0d9a-4183-8d09-396431407500\",\n  \"createdAt\" : \"2025-12-05T15:20:17.661120Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:18.083279Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1069\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"2a874e05-eb13-4fe4-b088-1c5745e3bb88-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1068\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"b6a5a80c-3d1a-48a9-94af-89032cee34a9\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"46c08964-8c5d-465d-a675-5b4de57987a7\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/2a874e05-eb13-4fe4-b088-1c5745e3bb88\",\n      \"title\" : \"er-test-1068\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/46c08964-8c5d-465d-a675-5b4de57987a7\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/b6a5a80c-3d1a-48a9-94af-89032cee34a9\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/74ba4881-65c1-4dbf-8ded-5164ad1c4897\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/46c08964-8c5d-465d-a675-5b4de57987a7\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Resize Edge Router host

Resize the underlying host instance for the specified Edge Router. Provide the desired deployment size identifier in the request body. The caller must have the update-heal permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Edge Router to resize

Request Body schema: application/json
required

Resize host request payload

size

required

string

Desired deployment size identifier for the host.

Responses

Request samples

Payload

Content type

application/json

Example

small

Resize the host to a small deployment size

{"size": "small"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response

"{\n  \"id\" : \"ab2e408d-6971-46dd-a82b-d8d4242a6ddf\",\n  \"hostId\" : \"90b51d64-4850-415d-8d2e-5312ab8a620b\",\n  \"ownerIdentityId\" : \"a67e4b4b-dcc9-42cf-9f3b-40ac76320169\",\n  \"createdBy\" : \"a67e4b4b-dcc9-42cf-9f3b-40ac76320169\",\n  \"createdAt\" : \"2025-12-05T15:20:18.922210Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:19.028037Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1096\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"ab2e408d-6971-46dd-a82b-d8d4242a6ddf-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1095\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"14089cd9-32ec-420c-8738-47f7db9bd18d\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"a3a6a660-727c-46ea-b75a-862446d176c8\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/ab2e408d-6971-46dd-a82b-d8d4242a6ddf\",\n      \"title\" : \"er-test-1095\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/a3a6a660-727c-46ea-b75a-862446d176c8\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/14089cd9-32ec-420c-8738-47f7db9bd18d\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/90b51d64-4850-415d-8d2e-5312ab8a620b\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/a3a6a660-727c-46ea-b75a-862446d176c8\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Resize Edge Router host

Resize the underlying host instance for the specified Edge Router. Provide the desired deployment size identifier in the request body. The caller must have the update-heal permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Edge Router to resize

Request Body schema: application/json
required

Resize host request payload

size

required

string

Desired deployment size identifier for the host.

Responses

Request samples

Payload

Content type

application/json

Example

small

Resize the host to a small deployment size

{"size": "small"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response

"{\n  \"id\" : \"ab2e408d-6971-46dd-a82b-d8d4242a6ddf\",\n  \"hostId\" : \"90b51d64-4850-415d-8d2e-5312ab8a620b\",\n  \"ownerIdentityId\" : \"a67e4b4b-dcc9-42cf-9f3b-40ac76320169\",\n  \"createdBy\" : \"a67e4b4b-dcc9-42cf-9f3b-40ac76320169\",\n  \"createdAt\" : \"2025-12-05T15:20:18.922210Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:19.028037Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1096\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"ab2e408d-6971-46dd-a82b-d8d4242a6ddf-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1095\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"14089cd9-32ec-420c-8738-47f7db9bd18d\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"UPDATING\",\n  \"softwareDeploymentStateId\" : \"a3a6a660-727c-46ea-b75a-862446d176c8\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/ab2e408d-6971-46dd-a82b-d8d4242a6ddf\",\n      \"title\" : \"er-test-1095\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/a3a6a660-727c-46ea-b75a-862446d176c8\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/14089cd9-32ec-420c-8738-47f7db9bd18d\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/90b51d64-4850-415d-8d2e-5312ab8a620b\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/a3a6a660-727c-46ea-b75a-862446d176c8\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Get Edge Router

Returns a single Edge Router by its unique identifier. The caller must have read permission on the Edge Router resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Edge Router.

query Parameters

embed

Array of strings

Items Enum: "all" "host" "software-deployment-state"

Embed related resources in the result. Allowed: all | host | software-deployment-state.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get edge router response

"{\n  \"id\" : \"f9ab1547-bb1f-487a-a481-4f81105b5fe8\",\n  \"hostId\" : \"a69ed55f-e5b4-4696-8bab-01dd4c3f7d29\",\n  \"ownerIdentityId\" : \"a1ef42e5-b510-4924-84f3-888e6f8cbca8\",\n  \"createdBy\" : \"a1ef42e5-b510-4924-84f3-888e6f8cbca8\",\n  \"createdAt\" : \"2025-12-05T15:20:47.541889Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:47.549017Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1806\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"f9ab1547-bb1f-487a-a481-4f81105b5fe8-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1805\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"feb03672-34e7-4bba-86c9-e5ed4aacc462\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"PROVISIONED\",\n  \"softwareDeploymentStateId\" : \"1adde1e7-fcee-4f61-b3b5-a9839dd3c975\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/f9ab1547-bb1f-487a-a481-4f81105b5fe8\",\n      \"title\" : \"er-test-1805\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/1adde1e7-fcee-4f61-b3b5-a9839dd3c975\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/feb03672-34e7-4bba-86c9-e5ed4aacc462\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/a69ed55f-e5b4-4696-8bab-01dd4c3f7d29\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/1adde1e7-fcee-4f61-b3b5-a9839dd3c975\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Update Edge Router (complete)

Updates an existing Edge Router. The operation is asynchronous and returns the Edge Router resource with related links. The caller must have the update permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

Id of the Edge Router to update

Request Body schema: application/json
required

Update Edge Router payload.

name	string Display name for the Edge Router.
linkListener	boolean Enable or disable link listener (TCP) for hosted edge routers only.
attributes	Array of strings unique Attributes to apply to the Edge Router.
empty	boolean

Responses

Request samples

Payload

Content type

application/json

Example

rename

{"name": "er-nyc-02"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response

"{\n  \"id\" : \"72263f05-4122-480f-a156-4c81fce51331\",\n  \"hostId\" : \"0f3aac12-3626-45c2-9326-abad8bd18eee\",\n  \"ownerIdentityId\" : \"1cd2d754-8e36-4fb6-ae05-e6527ba24f96\",\n  \"createdBy\" : \"1cd2d754-8e36-4fb6-ae05-e6527ba24f96\",\n  \"createdAt\" : \"2025-12-05T15:20:19.290463Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:19.451347Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1150\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"72263f05-4122-480f-a156-4c81fce51331-p.fake.netfoundry.io\",\n  \"name\" : \"Updated name\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"2319c918-9cae-4fff-a860-ccd8cd35521a\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"PROVISIONED\",\n  \"softwareDeploymentStateId\" : \"1f4f4666-d8d2-4564-840b-72200fd59d09\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/72263f05-4122-480f-a156-4c81fce51331\",\n      \"title\" : \"Updated name\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/1f4f4666-d8d2-4564-840b-72200fd59d09\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/2319c918-9cae-4fff-a860-ccd8cd35521a\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/0f3aac12-3626-45c2-9326-abad8bd18eee\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/1f4f4666-d8d2-4564-840b-72200fd59d09\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Delete Edge Router

Deletes an Edge Router by ID after validating it is not hosting a service and that the owning Network is provisioned. Requires delete permission on the Edge Router resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Edge Router to delete.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample delete Edge Router response

"{\n  \"id\" : \"59ab7370-45ae-438b-a3cd-28930dd194e9\",\n  \"hostId\" : \"aa8e3ae7-df8e-49f6-8dfb-9adfcbeac0d0\",\n  \"ownerIdentityId\" : \"1883994e-781a-4bce-b6fd-2631959e273e\",\n  \"createdBy\" : \"1883994e-781a-4bce-b6fd-2631959e273e\",\n  \"createdAt\" : \"2025-12-05T15:20:20.005413Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:20.066511Z\",\n  \"deletedBy\" : \"54f126ba-32c0-4157-995b-b941de40b8a2\",\n  \"deletedAt\" : null,\n  \"zitiId\" : \"zitiId\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"59ab7370-45ae-438b-a3cd-28930dd194e9-p.fake.netfoundry.io\",\n  \"name\" : \"er-test-1233\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"bc22559c-3d25-4b56-8ada-9fe5c47aa000\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"DELETING\",\n  \"softwareDeploymentStateId\" : null,\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/59ab7370-45ae-438b-a3cd-28930dd194e9\",\n      \"title\" : \"er-test-1233\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/bc22559c-3d25-4b56-8ada-9fe5c47aa000\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/aa8e3ae7-df8e-49f6-8dfb-9adfcbeac0d0\"\n    }\n  }\n}"

Update Edge Router (partial)

Partially updates an existing Edge Router. Only the provided fields are modified. The operation is asynchronous and returns the Edge Router resource with related links. The caller must have the update permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

Id of the Edge Router to update

Request Body schema: application/json
required

Partial Update Edge Router payload.

name	string Display name for the Edge Router.
linkListener	boolean Enable or disable link listener (TCP) for hosted edge routers only.
attributes	Array of strings unique Attributes to apply to the Edge Router.
empty	boolean

Responses

Request samples

Payload

Content type

application/json

Example

rename

{"name": "er-nyc-02"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response

"{\n  \"id\" : \"dbfe6af6-fe51-4c58-809f-8b26a7bf803d\",\n  \"hostId\" : \"0700afc8-5602-48c7-aae5-b6b69f8415ff\",\n  \"ownerIdentityId\" : \"8cac4e88-e239-4054-9d06-1ec8bac2e2cb\",\n  \"createdBy\" : \"8cac4e88-e239-4054-9d06-1ec8bac2e2cb\",\n  \"createdAt\" : \"2025-12-05T15:20:20.715009Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:20.777324Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1315\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"dbfe6af6-fe51-4c58-809f-8b26a7bf803d-p.fake.netfoundry.io\",\n  \"name\" : \"Updated name\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"edc8ab85-5e44-4fd3-bc3a-87a3987e4fa7\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : true,\n  \"status\" : \"PROVISIONED\",\n  \"softwareDeploymentStateId\" : \"2f5dc97e-66f1-42ce-8071-622163c606b6\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/dbfe6af6-fe51-4c58-809f-8b26a7bf803d\",\n      \"title\" : \"Updated name\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/2f5dc97e-66f1-42ce-8071-622163c606b6\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/edc8ab85-5e44-4fd3-bc3a-87a3987e4fa7\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/0700afc8-5602-48c7-aae5-b6b69f8415ff\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/2f5dc97e-66f1-42ce-8071-622163c606b6\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Find Edge Routers

Returns Edge Routers matching the provided filters. Results are limited to resources the caller may read. Supports standard paging and sorting.

Authorizations:

bearerAuth

query Parameters

id	any Example: id=8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b Filter by Edge Router ID.
name	any Example: name=er-nyc-01 Filter by Edge Router name.
networkId	any Example: networkId=6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11 Filter by Network ID.
zitiId	any Example: zitiId=zi:er:abcd1234 Filter by Ziti ID.
provider	any Examples: provider=CUSTOMER - customer provider=AWS - aws Filter by hosting provider.
linkListener	any Example: linkListener=true Filter by whether linkListener is enabled.
wssListener	any Example: wssListener=true Filter by whether wssListener is enabled.
hostId	any Example: hostId=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Filter by Host ID.
status	any Examples: status=PROVISIONED - provisioned status=SUSPENDED - suspended Filter by status.
attribute	any Example: attribute=key=value Filter by attribute expression. When used, exactly one networkId must also be provided.
createdAt	any Examples: createdAt=>2025-01-01T00:00:00Z - created-after Filter by createddAt with comparison operators. Supports >, >=, <, <=, =, != (e.g., createdAt=>=2025-01-01T00:00:00Z)
updatedAt	any Example: updatedAt=<2025-12-31T23:59:59Z Filter by updatedAt with comparison operators.
deletedAt	any Example: deletedAt=>2025-05-10T13:37:00Z Filter by deletedAt with comparison operators.
page	any Zero-based page index.
size	any Example: size=20 The size of the page to be returned.
sort	any Examples: sort=name,asc - name-asc sort=createdAt,desc - createdAt-desc Sorting criteria in the format: property,(asc\|desc). Multiple sort params are supported.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

No sample

Create Edge Router

Creates a managed Edge Router within the specified Network. For NF-hosted providers, a host is provisioned in the given cloud region. The operation is asynchronous and returns the Edge Router resource with related links.

Authorizations:

bearerAuth

header Parameters

nf-validate

string

Request Body schema: application/json
required

Create Edge Router payload.

networkId required	string <uuid> ID of the Network in which to create the Edge Router.
zitiId required	string The Ziti ID to assign to the Edge Router.
provider required	string Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Hosting provider. Use CUSTOMER for customer-hosted routers.
region	string Cloud region code. Required for NF-hosted providers; ignored for CUSTOMER.
hostSize	string Host size or instance type for NF-hosted Edge Router.
linkListener	boolean Enable legacy link listener (TCP).
wssListener	boolean Enable WSS listener for the Edge Router.
alternateDomainName	string Optional alternate DNS name to assign to the Edge Router host. Ignored for CUSTOMER hosted routers.

Responses

Request samples

Payload

Content type

application/json

Example

nf-hosted-aws

NF-hosted Edge Router in AWS us-east-1

{"networkId": "11111111-2222-3333-4444-555555555555",
"zitiId": "abcd1234",
"provider": "AWS",
"region": "us-east-1",
"hostSize": "SMALL",
"linkListener": true,
"wssListener": true,
"alternateDomainName": "er1.example.net"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response

"{\n  \"id\" : \"efe8c328-1a4e-4936-bf74-fd2db21f32e2\",\n  \"hostId\" : null,\n  \"ownerIdentityId\" : \"96797e44-e206-44f0-a835-2f9a4547de04\",\n  \"createdBy\" : \"96797e44-e206-44f0-a835-2f9a4547de04\",\n  \"createdAt\" : \"2025-12-05T15:20:47.830888Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:47.843093Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"zitiId\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"name\" : \"NtiHk-0TO7hjJxhEUe7CU\",\n  \"productVersion\" : \"8.0.43\",\n  \"networkId\" : \"e50ad80e-7f3a-4e9c-8a4a-3f8b0fb14205\",\n  \"jwt\" : null,\n  \"linkListener\" : false,\n  \"online\" : false,\n  \"verified\" : false,\n  \"status\" : \"PROVISIONING\",\n  \"softwareDeploymentStateId\" : \"a278363d-0f24-40c2-b54e-9aab8f525984\",\n  \"provider\" : null,\n  \"region\" : null,\n  \"hostSize\" : null,\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/efe8c328-1a4e-4936-bf74-fd2db21f32e2\",\n      \"title\" : \"NtiHk-0TO7hjJxhEUe7CU\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/a278363d-0f24-40c2-b54e-9aab8f525984\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/e50ad80e-7f3a-4e9c-8a4a-3f8b0fb14205\",\n      \"profile\" : \"parent\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/a278363d-0f24-40c2-b54e-9aab8f525984\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Reissue Edge Router certificate or enrollment

Reissues the Edge Router's certificate or re-enrolls the Edge Router, depending on network features and current verification state. The operation is asynchronous and returns the Edge Router resource with related links. The caller must have update permissions sufficient to create an Edge Router certificate (create on Edge Router within the Network).

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

Id of the Edge Router to reissue

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router response when re-enrolling a verified, customer-hosted router

"{\n  \"id\" : \"584bd777-9e6b-4929-89da-221358d527b8\",\n  \"hostId\" : \"d60f945b-0ecf-44ae-9079-8fd181bd9cd1\",\n  \"ownerIdentityId\" : \"418c1479-99df-4622-8a3c-ac554c6b0745\",\n  \"createdBy\" : \"418c1479-99df-4622-8a3c-ac554c6b0745\",\n  \"createdAt\" : \"2025-12-05T15:20:26.868188Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:26.905964Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-1714\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"584bd777-9e6b-4929-89da-221358d527b8-p.fake.netfoundry.io\",\n  \"name\" : \"edgerouter-1715\",\n  \"productVersion\" : \"7.3.69\",\n  \"networkId\" : \"21a4480c-9344-4432-8cb5-142c6469c547\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"tunnelerEnabled\" : true,\n  \"noTraversal\" : false,\n  \"online\" : false,\n  \"verified\" : false,\n  \"status\" : \"PROVISIONED\",\n  \"softwareDeploymentStateId\" : null,\n  \"provider\" : \"CUSTOMER\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/584bd777-9e6b-4929-89da-221358d527b8\",\n      \"title\" : \"edgerouter-1715\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/21a4480c-9344-4432-8cb5-142c6469c547\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/d60f945b-0ecf-44ae-9079-8fd181bd9cd1\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/d4289831-4a4f-40c1-9d8b-48f18fb473e4\",\n      \"title\" : \"Update EdgeRouter\",\n      \"profile\" : \"meta\"\n    }\n  }\n}"

Compare an Edge Router's host with its definition

Compare the actual Edge Router host in the cloud provider with the desired definition stored in NetFoundry. Useful for troubleshooting and support. The caller must have read permission on the specified Edge Router.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

Id of the Edge Router

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/db7c7777-ecad-457e-be30-2949ffe8f062\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/6a2ce648-1638-4631-9bba-7d1cc671420e\"\n    }\n  },\n  \"matches\" : true,\n  \"checks\" : [ {\n    \"type\" : \"EXIST\",\n    \"matches\" : true\n  }, {\n    \"type\" : \"STATE\",\n    \"matches\" : true,\n    \"expected\" : \"RUNNING\",\n    \"actual\" : \"RUNNING\"\n  }, {\n    \"type\" : \"IP\",\n    \"matches\" : true,\n    \"expected\" : \"0.0.1.156\",\n    \"actual\" : \"0.0.1.156\"\n  }, {\n    \"type\" : \"INSTANCE_TYPE\",\n    \"matches\" : true,\n    \"expected\" : [ \"t2.small\", \"t3.small\" ],\n    \"actual\" : \"t2.small\"\n  } ],\n  \"networkId\" : \"6a2ce648-1638-4631-9bba-7d1cc671420e\",\n  \"edgeRouterId\" : \"db7c7777-ecad-457e-be30-2949ffe8f062\",\n  \"hostId\" : \"44fa4fb9-18c1-49aa-8714-f6099351d547\",\n  \"provider\" : \"AWS\",\n  \"providerInstanceId\" : \"e7b70555-9f21-4c30-93d4-c9764170da39\"\n}"

Edge Router Registrations

Manages Edge Router Registrations

Create Edge Router Registration Key

Creates (or fetches if one already exists) a short-lived registration key for an Edge Router identified by Ziti ID within the specified Network. The Network must be provisioned and the Edge Router must not already be provisioned. Caller must have update permissions on the Network resource.

Authorizations:

bearerAuth

header Parameters

nf-validate

string

Request Body schema: application/json
required

Registration key request payload.

networkId required	string <uuid> ID of the Network in which the Edge Router is being registered.
zitiId required	string Ziti ID of the Edge Router to register. Must correspond to an unprovisioned router.

Responses

Request samples

Payload

Content type

application/json

Create or fetch a registration key for an unprovisioned Edge Router.

{"networkId": "11111111-2222-3333-4444-555555555555",
"zitiId": "abcd1234"
}

Response samples

200
400
401
403
500

Content type

application/json

Example registration key response

"{\n \"registrationKey\" : \"TEST8BN5WKIOTZM\",\n \"expiresAt\" : \"2025-12-08T15:22:23.744Z\"\n}"

Retrieve Edge Router registration bundle

Used by Edge Router registration scripts. Given a valid, unexpired registration key, returns the registration payload including the Edge Router resource, the Network Controller host, configuration template content, and expiration. Each key has a limited number of retrievals and will automatically be deleted after attempts are exhausted. Fails if the key is invalid/expired or if the Edge Router is already provisioned.

Authorizations:

bearerAuth

path Parameters

registrationKey

required

string

Example: YIFKR39HBG

Short-lived registration key obtained from createEdgeRouterRegistrationKey.

Responses

Response samples

200
400
401
403
500

Content type

application/json

Example registration response for a valid key.

"{\n  \"edgeRouter\" : {\n    \"id\" : \"a38370ae-7f59-40cd-a7e4-90897b409c73\",\n    \"hostId\" : \"5a8eb397-378a-4c3f-bba7-b246e9d50bba\",\n    \"ownerIdentityId\" : null,\n    \"createdBy\" : null,\n    \"createdAt\" : \"2025-12-05T15:22:24.213160Z\",\n    \"updatedAt\" : \"2025-12-05T15:22:24.228428Z\",\n    \"deletedBy\" : null,\n    \"deletedAt\" : null,\n    \"zitiId\" : \"gordTXCEwjtMYamVZfEw5\",\n    \"domainName\" : null,\n    \"alternateDomainName\" : null,\n    \"name\" : \"UasnDHoNtCNmF4BrcKuXy\",\n    \"productVersion\" : \"7.3.37\",\n    \"networkId\" : \"27382385-ae39-4fe1-9725-78ba0513476f\",\n    \"jwt\" : \"2gsYnj0OI_m4yTzahuwYr\",\n    \"linkListener\" : false,\n    \"wssListener\" : false,\n    \"tunnelerEnabled\" : false,\n    \"noTraversal\" : false,\n    \"online\" : false,\n    \"verified\" : false,\n    \"enabled\" : true,\n    \"status\" : \"NEW\",\n    \"softwareDeploymentStateId\" : \"c3cd5413-386f-4f26-b0a3-9b0263e05293\",\n    \"provider\" : \"CUSTOMER\",\n    \"region\" : null,\n    \"hostSize\" : null,\n    \"attributes\" : [ ],\n    \"registration\" : null\n  },\n  \"networkControllerHost\" : \"26e29db2-6412-4bd4-b29c-b9c65f2ea162.nf.io\",\n  \"template\" : \"v: 3\\n\\n# (required) The certificates, ca chains, and private key used to represent this routers identity\\n#\\n# If the 'edge\\\" section is enabled and enrollment is run, the files in this section will be written to with the results.\\n# The \\\"key\\\" value can be provided through any of the support private key engines (file, etc.).\\n#\\n# If the 'key' value is a file and that file exists; it is expected to a pre-generated private key. It will be used for\\n# the  enrollment process and it will back the certificates generated during enrollment. If the file does not exist, it\\n# will be generated.\\n#\\n# The 'cert', 'server_cert', and 'ca' files will be overwritten with the results of the enrollment process.\\n#\\n# When running the ziti-router the files/values in this section will be read and used. The 'cert' value will be used\\n# as the client certificate to connect to the controller. The 'server_cert' is used for all servers/listeners. The\\n# 'ca' value is used to populate an internally Trusted CA pool.\\n\\nidentity:\\n  cert:        \\\"certs/client.cert.pem\\\"\\n  server_cert: \\\"certs/server.cert.pem\\\"\\n  key:         \\\"certs/client.key.pem\\\"\\n  ca:          \\\"certs/intermediate-chain.pem\\\"\\n\\n\\n#trace:\\n# path:                 001.trace\\n\\n#profile:\\n#  memory:\\n#    path:               001.memprof\\n#  cpu:\\n#    path:               001.cpuprof\\n\\nctrl:\\n  endpoint: \\\"tls:{{ controller_ip }}:80\\\"\\n\\n\\nlink:\\n  dialers:\\n    - binding:          transport\\n{% if link_listener %}    \\n  listeners:\\n    - binding:          transport\\n      bind:             tls:0.0.0.0:80\\n      advertise:        tls:{{ advertise_value }}:80 \\n      options:\\n        outQueueSize:   16\\n{%- endif %}\\n{% if fabric_link_listener %}    \\n  listeners:\\n    - binding:          transport\\n      bind:             tls:0.0.0.0:80\\n      advertise:        tls:{{ fabric_value }}:80 \\n      options:\\n        outQueueSize:   16\\n{%- endif %} \\n\\n# By having an 'edge' section defined, the ziti-router will attempt to parse the edge configuration. Removing this\\n# section, commenting out, or altering the name of the section will cause the router to no longer operate as an Edge\\n# Router.\\n\\nedge:\\n  # (required) Information used to generate the initial registration CSR. For documentation on these fields please\\n  # refer to the openssl documentation. These values MUST be supplied and have no defaults.\\n  csr:\\n    country: US\\n    province: NC\\n    locality: Charlotte\\n    organization: NetFoundry\\n    organizationalUnit: Ziti\\n    # (required) SANs that this Gateways certs should contain. At least one IP or DNS SAN should be defined that matches\\n    # the edge listeners \\\"advertise\\\" value from the \\\"listeners\\\" section.\\n    sans:\\n      {% if type == \\\"ip\\\" -%}\\n      ip:\\n        - 127.0.0.1\\n        - {{ advertise_value }}\\n      {%- endif %}\\n      {%- if type == \\\"dns\\\" -%}\\n      dns:\\n        - localhost\\n        - {{ advertise_value }}\\n      {%- endif %}\\n     {%- if manual_configuration -%}\\n      {% if ip -%}\\n      ip:\\n        - 127.0.0.1\\n        {%- for ip in ip_list %}\\n        - {{ ip }}\\n        {%- endfor -%}\\n      {%- endif %}\\n      {% if dns -%}\\n      dns:\\n        - localhost\\n        {%- for dns in dns_list %}\\n        - {{ dns }}\\n        {%- endfor -%}\\n      {%- endif -%}\\n     {%- endif %}\\n\\nlisteners:\\n  - binding: edge\\n    address: tls:0.0.0.0:443\\n    options:\\n      # (required) The public hostname and port combination that Ziti SDKs should connect on. Previously this was in the chanIngress section.\\n      advertise: {{ advertise_value }}:443 \\n \\n  {% if salt -%}\\n  # Netfoundry SaltStack 4505\\n  - binding:            proxy\\n    address:            tcp:127.0.0.1:4505\\n    service:            salt4505\\n  # NetFoundry SaltStack 4506\\n  - binding:            proxy\\n    address:            tcp:127.0.0.1:4506\\n    service:            salt4506\\n  {%- endif -%}\\n\",\n  \"expiresAt\" : \"2025-12-05T15:24:24.195799Z\",\n  \"productVersion\" : \"7.3.37\",\n  \"productMetadata\" : {\n    \"active\" : true,\n    \"version\" : {\n      \"type\" : \"STRICT\",\n      \"build\" : null,\n      \"major\" : 7,\n      \"minor\" : 3,\n      \"patch\" : 37,\n      \"value\" : \"7.3.37\",\n      \"stable\" : true,\n      \"suffixTokens\" : [ ],\n      \"originalValue\" : \"7.3.37\"\n    },\n    \"zitiVersion\" : {\n      \"type\" : \"STRICT\",\n      \"build\" : null,\n      \"major\" : 0,\n      \"minor\" : 24,\n      \"patch\" : 14,\n      \"value\" : \"0.24.14\",\n      \"stable\" : false,\n      \"suffixTokens\" : [ ],\n      \"originalValue\" : \"0.24.14\"\n    },\n    \"defaultVersion\" : false\n  },\n  \"haEnabled\" : false\n}"

Acknowledge Edge Router registration result

Used by Edge Router registration scripts to report the outcome of a registration attempt. A status of 0 indicates success; any non-zero value indicates an error. The registration key is short-lived and may become invalid after use.

Authorizations:

bearerAuth

path Parameters

registrationKey

required

string

Example: YIFKR39HBG

Short-lived registration key obtained from createEdgeRouterRegistrationKey.

Request Body schema: application/json
required

Result payload posted by the registering Edge Router.

status	integer <int32> Registration status code reported by the Edge Router. 0 = success; non-zero = error.
message	string Optional descriptive message about the registration result.

Responses

Request samples

Payload

Content type

application/json

Example

success

{"status": 0,
"message": "Successful"
}

Response samples

400
401
403
500

Content type

*/*

No sample

Network Controller Upgrades

Handles upgrades of Network Controllers

Upgrade a Network Controller

Initiates an upgrade for a specific Network Controller. The target version must be provided in the request body.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

The ID of the Network Controller to upgrade.

Request Body schema: application/json
required

Specifies the target version for the upgrade.

required

object (Semver)

The target version for the upgrade.

originalValue	string
value	string
major	integer <int32>
minor	integer <int32>
patch	integer <int32>
suffixTokens	Array of strings
build	string
type	string Enum: "STRICT" "LOOSE" "NPM" "COCOAPODS" "IVY"
stable	boolean

Responses

Request samples

Payload

Content type

application/json

Specific Version

{"target": "8.3.0"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller Upgrade response

"{\n  \"id\" : \"b358be3f-f32a-4ece-8c8a-3fccca61a2fe\",\n  \"ownerIdentityId\" : \"8140fe43-9786-41ee-a2f7-8f75bca0062b\",\n  \"networkId\" : \"b44db455-a09a-4b18-adf7-fe3a5cc5872c\",\n  \"domainName\" : \"b358be3f-f32a-4ece-8c8a-3fccca61a2fe.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"network-2029-nc\",\n  \"productVersion\" : \"8.0.14\",\n  \"hostId\" : \"da87223e-e1cd-44c0-85e1-330d6a500930\",\n  \"status\" : \"PROVISIONED\",\n  \"createdAt\" : \"2025-12-05T15:22:03.852640Z\",\n  \"updatedAt\" : \"2025-12-05T15:22:03.865111Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"8140fe43-9786-41ee-a2f7-8f75bca0062b\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"cad3e691-62d0-4b2d-b970-9b7541029971\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers/b358be3f-f32a-4ece-8c8a-3fccca61a2fe\",\n      \"title\" : \"network-2029-nc\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/cad3e691-62d0-4b2d-b970-9b7541029971\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/da87223e-e1cd-44c0-85e1-330d6a500930\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/b44db455-a09a-4b18-adf7-fe3a5cc5872c\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Edge Router Upgrades

Handles upgrades of Edge Routers

Upgrade an Edge Router

Initiates an upgrade process for a specific edge router. You can specify the target version in the request body. If you omit the version, the edge router will be upgraded to the latest version available for the network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

The ID of the Edge Router to upgrade.

Request Body schema: application/json

Specifies the target version for the upgrade. If omitted, the edge router will be upgraded to the latest version available for the network.

object (Semver)

The target version for the upgrade. If not specified, the Edge Router will be upgraded to the latest version available for the network.

originalValue	string
value	string
major	integer <int32>
minor	integer <int32>
patch	integer <int32>
suffixTokens	Array of strings
build	string
type	string Enum: "STRICT" "LOOSE" "NPM" "COCOAPODS" "IVY"
stable	boolean

Responses

Request samples

Payload

Content type

application/json

Specific Version

{"target": "8.3.0"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Edge Router Upgrade response

"{\n  \"id\" : \"444d4fb9-dd4c-47f7-909d-afcf14bc1c86\",\n  \"hostId\" : \"8a57ea2d-e715-40b0-a9f1-e034d7f82b98\",\n  \"ownerIdentityId\" : \"9c78234e-700b-4c2c-b1ad-0e26d09b165e\",\n  \"createdBy\" : \"9c78234e-700b-4c2c-b1ad-0e26d09b165e\",\n  \"createdAt\" : \"2025-12-05T15:22:14.561735Z\",\n  \"updatedAt\" : \"2025-12-05T15:22:15.423833Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"zitiId\" : \"ziti-id-2060\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"publicDomainName\" : \"444d4fb9-dd4c-47f7-909d-afcf14bc1c86-p.fake.netfoundry.io\",\n  \"name\" : \"edgerouter-2061\",\n  \"productVersion\" : \"8.4.1\",\n  \"networkId\" : \"c767548f-8b2e-47fe-877d-1a1b3148999c\",\n  \"jwt\" : null,\n  \"linkListener\" : true,\n  \"online\" : false,\n  \"verified\" : false,\n  \"status\" : \"PROVISIONED\",\n  \"softwareDeploymentStateId\" : \"25950230-8682-41f0-8449-65e99ae79cf6\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"hostSize\" : \"small\",\n  \"attributes\" : [ ],\n  \"registration\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers/444d4fb9-dd4c-47f7-909d-afcf14bc1c86\",\n      \"title\" : \"edgerouter-2061\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/25950230-8682-41f0-8449-65e99ae79cf6\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/c767548f-8b2e-47fe-877d-1a1b3148999c\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/8a57ea2d-e715-40b0-a9f1-e034d7f82b98\"\n    }\n  }\n}"

Network Upgrades

Handles upgrades of a Network

Upgrade a Network

Initiates an upgrade for a network and its components. The behavior of the upgrade is determined by the UpgradeNetwork object in the request body.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

The ID of the Network to upgrade.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Specifies the details of the network upgrade.

	object (Semver) The target version for the upgrade. If not specified, the network will be upgraded to the latest version available.
ignoreOffline	boolean Whether to ignore offline edge routers during the upgrade.
edgeRouterIds	Array of strings <uuid> unique [ items <uuid > ] A set of edge router IDs to include in the upgrade. If not specified, all edge routers in the network will be upgraded.
upgradeMode	string Enum: "FULL" "CONTROLLERS_ONLY" "EDGE_ROUTERS_ONLY" The upgrade mode to use. `FULL` will upgrade controllers and routers. `CONTROLLERS_ONLY` will upgrade only controllers. `EDGE_ROUTERS_ONLY` will upgrade only edge routers.
concurrentControllerUpgrades	boolean Whether to upgrade network controllers concurrently.

Responses

Request samples

Payload

Content type

application/json

Example

Full Upgrade

Upgrade the network controllers and all edge routers to version 8.3.0.

{"target": "8.3.0",
"upgradeMode": "FULL"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Upgrade response

"{\n  \"id\" : \"80ee8155-1e94-4238-b63b-6af81c332a51\",\n  \"ownerIdentityId\" : \"9caccc42-dfea-409b-ab0b-820ff0251d13\",\n  \"createdBy\" : \"9caccc42-dfea-409b-ab0b-820ff0251d13\",\n  \"createdAt\" : \"2025-11-13T23:56:36.713181Z\",\n  \"updatedAt\" : \"2025-11-13T23:56:36.724485Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"upgrade-network-0\",\n  \"networkGroupId\" : \"1e6f7f03-3f7d-4b23-a1a0-9509edc5d99b\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.90\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONED\",\n  \"publicCertEnabled\" : false,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/80ee8155-1e94-4238-b63b-6af81c332a51\",\n      \"title\" : \"upgrade-network-0\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/1e6f7f03-3f7d-4b23-a1a0-9509edc5d99b\",\n      \"profile\" : \"parent\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"service-policies\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/service-policies?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"certificate-authorities\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/certificate-authorities?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"services\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/services?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"service-edge-router-policies\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/service-edge-router-policies?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"edge-router-policies\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-router-policies?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"app-wans\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/app-wans?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"process-executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/process-executions?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"configs\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/configs?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"endpoints\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/endpoints?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"terminators\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/terminators?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"config-types\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/config-types?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    },\n    \"posture-checks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/posture-checks?networkId=80ee8155-1e94-4238-b63b-6af81c332a51\"\n    }\n  }\n}"

Stored Secrets

Manage StoredSecret resources

Get a Stored Secret

Retrieve a single StoredSecret resource by its ID. The value of the secret is not returned by this endpoint. To retrieve the value, call the includeValue=true variant which requires additional authorization. The caller must have read permission on the StoredSecret.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get stored secret response

"{\n  \"id\" : \"6e005edc-171b-4bee-b427-48324a40a03b\",\n  \"createdBy\" : \"815f7f5d-cf8b-4c4b-a567-f6ee1e4cb6d3\",\n  \"createdAt\" : \"2025-12-05T15:20:07.057665Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:07.057665Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"test-v2\",\n  \"type\" : \"PRIVATE_KEY\",\n  \"networkGroupId\" : \"0156165e-c9d9-4b9c-bbd2-4e613df2237d\",\n  \"ott\" : null,\n  \"ottCreatedAt\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/stored-secrets/6e005edc-171b-4bee-b427-48324a40a03b\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/0156165e-c9d9-4b9c-bbd2-4e613df2237d\"\n    }\n  }\n}"

Update a Stored Secret

Update mutable properties of a Stored Secret such as its human-friendly name and/or the secret value. Omit fields to leave them unchanged. When the secret type is PRIVATE_KEY and a value is supplied, it must be a PEM-formatted private key. To update the value via a one-time token (OTT) without normal auth, use the text/plain OTT variant on the same path with the 'token' query parameter. The caller must have update permission on the StoredSecret.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Stored Secret.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Fields to update on the Stored Secret. Omitted fields remain unchanged.

name	string New human-friendly name for the secret (must be unique within the Network Group). When omitted, the name is unchanged.
value	any New secret value to store. Treated as opaque. If the secret type is PRIVATE_KEY, provide a PEM formatted private key string. When omitted (or empty string for JSON requests), the value is not updated. In the OTT flow, this field is required and the request body is plain text.

Responses

Request samples

Payload

Content type

application/json

Example

rename-only

Change only the secret's name; value remains unchanged.

{"name": "my-ssh-key-updated"
}

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get stored secret response

"{\n  \"id\" : \"4fd7d146-0136-4d51-a146-37a958e0a708\",\n  \"createdBy\" : \"098e27a2-aa8d-4bd0-b92e-f314c3cedce8\",\n  \"createdAt\" : \"2025-12-05T15:20:06.719569Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:06.737183Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"Test Name vZzplt3Kj75lE_B-1n17E\",\n  \"type\" : \"PRIVATE_KEY\",\n  \"networkGroupId\" : \"517a3bf6-0680-4e10-81be-cf52551df3bf\",\n  \"ott\" : null,\n  \"ottCreatedAt\" : null,\n  \"_links\" : {\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/517a3bf6-0680-4e10-81be-cf52551df3bf\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/stored-secrets/4fd7d146-0136-4d51-a146-37a958e0a708\",\n      \"title\" : \"Test Name vZzplt3Kj75lE_B-1n17E\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/cb79b0b3-9c5b-4adf-8c38-4fae63d16b25\",\n      \"title\" : \"Update StoredSecret\",\n      \"profile\" : \"meta\"\n    }\n  }\n}"

Delete a Stored Secret

Delete a Stored Secret by ID. Deletion fails if the secret is referenced by any Host (e.g., as an SSH private key). The caller must have delete permission on the Stored Secret.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Stored Secret.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get stored secret response

"{\n  \"id\" : \"969bb79d-ae5d-481a-88f0-5e52056924d0\",\n  \"createdBy\" : \"8b34df73-d3fc-46f4-9f87-d9506b1b32ff\",\n  \"createdAt\" : \"2025-12-05T15:20:06.649493Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:06.649493Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"test-v2\",\n  \"type\" : \"PRIVATE_KEY\",\n  \"networkGroupId\" : \"de0bd342-ebb2-406e-bcf0-950dc2e890ab\",\n  \"ott\" : null,\n  \"ottCreatedAt\" : null,\n  \"_links\" : {\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/de0bd342-ebb2-406e-bcf0-950dc2e890ab\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/stored-secrets/969bb79d-ae5d-481a-88f0-5e52056924d0\",\n      \"title\" : \"test-v2\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/b64e81ef-879e-426d-aa8f-283aa88ebdb1\",\n      \"title\" : \"Delete StoredSecret\",\n      \"profile\" : \"meta\"\n    }\n  }\n}"

Update a Stored Secret

Update mutable properties of a Stored Secret such as its human-friendly name and/or the secret value. Omit fields to leave them unchanged. When the secret type is PRIVATE_KEY and a value is supplied, it must be a PEM-formatted private key. To update the value via a one-time token (OTT) without normal auth, use the text/plain OTT variant on the same path with the 'token' query parameter. The caller must have update permission on the StoredSecret.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Stored Secret.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Fields to update on the Stored Secret. Omitted fields remain unchanged.

name	string New human-friendly name for the secret (must be unique within the Network Group). When omitted, the name is unchanged.
value	any New secret value to store. Treated as opaque. If the secret type is PRIVATE_KEY, provide a PEM formatted private key string. When omitted (or empty string for JSON requests), the value is not updated. In the OTT flow, this field is required and the request body is plain text.

Responses

Request samples

Payload

Content type

application/json

Example

rename-only

Change only the secret's name; value remains unchanged.

{"name": "my-ssh-key-updated"
}

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get stored secret response

"{\n  \"id\" : \"4fd7d146-0136-4d51-a146-37a958e0a708\",\n  \"createdBy\" : \"098e27a2-aa8d-4bd0-b92e-f314c3cedce8\",\n  \"createdAt\" : \"2025-12-05T15:20:06.719569Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:06.737183Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"Test Name vZzplt3Kj75lE_B-1n17E\",\n  \"type\" : \"PRIVATE_KEY\",\n  \"networkGroupId\" : \"517a3bf6-0680-4e10-81be-cf52551df3bf\",\n  \"ott\" : null,\n  \"ottCreatedAt\" : null,\n  \"_links\" : {\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/517a3bf6-0680-4e10-81be-cf52551df3bf\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/stored-secrets/4fd7d146-0136-4d51-a146-37a958e0a708\",\n      \"title\" : \"Test Name vZzplt3Kj75lE_B-1n17E\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/cb79b0b3-9c5b-4adf-8c38-4fae63d16b25\",\n      \"title\" : \"Update StoredSecret\",\n      \"profile\" : \"meta\"\n    }\n  }\n}"

Update a Stored Secret value using a one-time token (OTT)

Update the value of a Stored Secret using a one-time token (OTT) without normal authentication. Provide the token as a query parameter and the new value as a text/plain request body. When the secret type is PRIVATE_KEY, the body must contain a PEM formatted private key. This operation returns 200 OK with no response body.

Authorizations:

bearerAuth

path Parameters

idUsingOtt

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Stored Secret to update.

query Parameters

token

any

Example: token=abc123de

The one-time token (OTT) that authorizes this update.

Request Body schema: text/plain
required

The new secret value to store, sent as text/plain. For PRIVATE_KEY secrets, must be a PEM formatted key.

string

Responses

Request samples

Payload

Content type

text/plain

Example

opaque

Update an opaque/GENERIC secret value

s3cr3t-v4lu3

Response samples

400
401
403
500

Content type

*/*

No sample

Update a Stored Secret value using a one-time token (OTT)

Update the value of a Stored Secret using a one-time token (OTT) without normal authentication. Provide the token as a query parameter and the new value as a text/plain request body. When the secret type is PRIVATE_KEY, the body must contain a PEM formatted private key. This operation returns 200 OK with no response body.

Authorizations:

bearerAuth

path Parameters

idUsingOtt

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Stored Secret to update.

query Parameters

token

any

Example: token=abc123de

The one-time token (OTT) that authorizes this update.

Request Body schema: text/plain
required

The new secret value to store, sent as text/plain. For PRIVATE_KEY secrets, must be a PEM formatted key.

string

Responses

Request samples

Payload

Content type

text/plain

Example

opaque

Update an opaque/GENERIC secret value

s3cr3t-v4lu3

Response samples

400
401
403
500

Content type

*/*

No sample

Update a Stored Secret value using a one-time token (OTT)

Update the value of a Stored Secret using a one-time token (OTT) without normal authentication. Provide the token as a query parameter and the new value as a text/plain request body. When the secret type is PRIVATE_KEY, the body must contain a PEM formatted private key. This operation returns 200 OK with no response body.

Authorizations:

bearerAuth

path Parameters

idUsingOtt

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Stored Secret to update.

query Parameters

token

any

Example: token=abc123de

The one-time token (OTT) that authorizes this update.

Request Body schema: text/plain
required

The new secret value to store, sent as text/plain. For PRIVATE_KEY secrets, must be a PEM formatted key.

string

Responses

Request samples

Payload

Content type

text/plain

Example

opaque

Update an opaque/GENERIC secret value

s3cr3t-v4lu3

Response samples

400
401
403
500

Content type

*/*

No sample

Share a Stored Secret for OTT update

Generate a one-time token (OTT) and share URL for updating the Stored Secret's value without normal authentication. The response contains the Stored Secret metadata (unwrapped) and a URL that includes the OTT as a query parameter. Use this URL with a text/plain body to POST/PUT/PATCH the new value. The caller must have update permission on the StoredSecret.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Stored Secret to share.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample share stored secret response including the OTT URL

{"id": "8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b",
"name": "my-ssh-key",
"type": "PRIVATE_KEY",
"networkGroupId": "11111111-2222-3333-4444-555555555555",
"createdAt": "2025-10-09T12:34:56Z",
"updatedAt": "2025-10-09T12:40:00Z",
"url": "https://gateway.production.netfoundry.io/core/v2/stored-secrets/8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b?token=abc123de",
"_links": {"self": {"href": "https://gateway.production.netfoundry.io/core/v2/stored-secrets/8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b"
},
"network-group": {"href": "https://gateway.production.netfoundry.io/core/v2/network-groups/11111111-2222-3333-4444-555555555555"
}
}
}

Find Stored Secrets

Find all StoredSecret instances that match the specified search criteria. Results exclude resources the caller is not authorized to read; therefore this endpoint never returns 403/404, only an empty list when no authorized results are found.

Authorizations:

bearerAuth

query Parameters

id	any Example: id=8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b Filter by Stored Secret ID.
name	any Example: name=my-ssh-key Filter by Stored Secret name.
parameterName	any Example: parameterName=ssm:/netfoundry/ng-1111/ssh-key Filter by backing parameter name (internal identifier).
networkGroupId	any Example: networkGroupId=11111111-2222-3333-4444-555555555555 Filter by Network Group ID that owns the secret.
createdBy	any Example: createdBy=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Filter by creator identity ID.
deletedBy	any Example: deletedBy=bbbbbbbb-1111-2222-3333-cccccccccccc Filter by deleter identity ID.
createdAt	any Examples: createdAt=>2025-01-01T00:00:00Z - created-after createdAt=<2025-12-31T23:59:59Z - created-before Filter by createdAt with comparison operators. Supports >, >=, <, <=, =, !=
updatedAt	any Example: updatedAt=>=2025-01-01T00:00:00Z Filter by updatedAt with comparison operators.
deletedAt	any Example: deletedAt==2025-05-10T13:37:00Z Filter by deletedAt with comparison operators.
page	any Zero-based page index.
size	any Example: size=20 The size of the page to be returned.
sort	any Examples: sort=name,asc - name-asc sort=createdAt,desc - createdAt-desc Sorting criteria in the format: property,(asc\|desc). Multiple sort params are supported.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

No sample

Create a Stored Secret

Create a new Stored Secret within a Network Group. The caller must have create permission for StoredSecret resources in the specified Network Group. If a value is provided, it is stored immediately; otherwise the secret metadata is created and the value can be set later via the one-time token (OTT) flow.

Authorizations:

bearerAuth

header Parameters

nf-validate

string

Request Body schema: application/json
required

Details of the Stored Secret to create.

networkGroupId required	string <uuid> ID of the Network Group that will own the secret.
name required	string Human-friendly name of the secret (must be unique within the Network Group).
type	string Enum: "GENERIC" "PRIVATE_KEY" Type of the secret to store. Defaults to GENERIC when omitted.
value	any Secret value to store. Treated as opaque. When type is PRIVATE_KEY, provide a PEM formatted private key string.

Responses

Request samples

Payload

Content type

application/json

Example

generic-no-value

Create a GENERIC secret without an initial value (value can be set later via OTT).

{"networkGroupId": "11111111-2222-3333-4444-555555555555",
"name": "my-ssh-key"
}

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get stored secret response

"{\n  \"id\" : \"c4ca3def-4c2f-4ad4-8187-3d67a18f4bbc\",\n  \"createdBy\" : \"73bd5ded-62ac-4194-857a-bf650ea01be0\",\n  \"createdAt\" : \"2025-12-05T15:20:06.019921Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:06.019921Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"Test Name H4rMP5b9TxlqeGBSoZjzU\",\n  \"type\" : \"PRIVATE_KEY\",\n  \"networkGroupId\" : \"b7560740-0100-4c32-8e12-34d10d2782ba\",\n  \"ott\" : null,\n  \"ottCreatedAt\" : null,\n  \"_links\" : {\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/b7560740-0100-4c32-8e12-34d10d2782ba\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/stored-secrets/c4ca3def-4c2f-4ad4-8187-3d67a18f4bbc\",\n      \"title\" : \"Test Name H4rMP5b9TxlqeGBSoZjzU\"\n    },\n    \"execution\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/ac6e9e71-2a35-477c-9d80-f6ee051bc27d\",\n      \"title\" : \"Create StoredSecret\",\n      \"profile\" : \"meta\"\n    }\n  }\n}"

Get a Stored Secret with value

Retrieve a single StoredSecret resource by its ID including its secret value. This variant requires the 'read-secret' authorization. Use the non-includeValue variant if you do not need the secret value.

Authorizations:

bearerAuth

path Parameters

idWithValue

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Stored Secret.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get stored secret with value response

"{\n  \"id\" : \"2288a3f7-03d7-4493-8246-c2b152368a91\",\n  \"createdBy\" : \"60f4ea06-2c2c-45a5-988d-7e1828e2606c\",\n  \"createdAt\" : \"2025-12-05T15:20:06.990746Z\",\n  \"updatedAt\" : \"2025-12-05T15:20:06.990746Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"test-v2\",\n  \"type\" : \"PRIVATE_KEY\",\n  \"networkGroupId\" : \"dc08718c-b84c-45e7-a274-43f43ac59a57\",\n  \"ott\" : null,\n  \"ottCreatedAt\" : null,\n  \"value\" : \"aiqpkvyYen3bC3Pg6NAr-\",\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/stored-secrets/2288a3f7-03d7-4493-8246-c2b152368a91\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/dc08718c-b84c-45e7-a274-43f43ac59a57\"\n    }\n  }\n}"

Clusters

Manage Cluster resources

Retrieve a single Cluster

Retrieve a single Cluster resource by its ID. The platform creates the Cluster resource automatically when the network is enabled for HA. The network version must support cluster operations and the caller must have read permissions on the Cluster resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Retrieve a cluster by ID

"{\n  \"id\" : \"f7a48c07-0d1d-4433-b52a-a24db68ea2d4\",\n  \"networkId\" : \"4df7faa8-b2fc-4cda-b72d-c3d99c7b6d44\",\n  \"leaderId\" : \"1d4761f1-26d6-4f11-bb6e-ff13adab3ddd\",\n  \"createdAt\" : \"2025-11-17T16:30:43.929097Z\",\n  \"updatedAt\" : \"2025-11-17T16:30:43.929097Z\",\n  \"deletedAt\" : null,\n  \"readOnly\" : false,\n  \"partitioned\" : false,\n  \"leaderMemberInfos\" : [ {\n    \"id\" : \"1d4761f1-26d6-4f11-bb6e-ff13adab3ddd\",\n    \"address\" : \"1d4761f1-26d6-4f11-bb6e-ff13adab3ddd\",\n    \"voter\" : true,\n    \"leader\" : true,\n    \"version\" : null,\n    \"connected\" : true,\n    \"readOnly\" : false\n  } ],\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/4df7faa8-b2fc-4cda-b72d-c3d99c7b6d44\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/clusters/f7a48c07-0d1d-4433-b52a-a24db68ea2d4\"\n    },\n    \"leader\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1d4761f1-26d6-4f11-bb6e-ff13adab3ddd\"\n    }\n  }\n}"

Set the leader of a Cluster

Set the leader of a cluster to the specified network controller. The network controller must be a member of the network. The caller must have update permissions on the Cluster resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

header Parameters

nf-validate

string

Request Body schema: application/json
required

The details of the update, including the ID of the new leader.

leaderId

string <uuid>

Identifies the network controller that leads the cluster.

Responses

Request samples

Payload

Content type

application/json

Sample update cluster request

"{\"leaderId\":\"3aa2d402-7e9e-454e-b496-d218911d3065\"}"

Response samples

200
400
401
403
500

Content type

application/hal+json

No sample

Set the leader of a Cluster

Set the leader of a cluster to the specified network controller. The network controller must be a member of the network. The caller must have update permissions on the Cluster resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

header Parameters

nf-validate

string

Request Body schema: application/json
required

The details of the update, including the ID of the new leader.

leaderId

string <uuid>

Identifies the network controller that leads the cluster.

Responses

Request samples

Payload

Content type

application/json

Sample update cluster request

"{\"leaderId\":\"3aa2d402-7e9e-454e-b496-d218911d3065\"}"

Response samples

200
400
401
403
500

Content type

application/hal+json

No sample

Find and retrieve a list of Clusters

Retrieve a paginated list of clusters. Filter the results by providing query parameters that correspond to the fields in the FindCluster object. Each cluster in the response contains links to itself, its parent network, and its leader. Instances that the API client does not have authorization to read will be removed from the results.

Authorizations:

bearerAuth

query Parameters

id	string <uuid> Filter by Cluster ID.
networkId	string <uuid> Filter by Network ID.
leaderId	string <uuid> Filter by Leader (Network Controller) ID.
createdAt	string Filter by creation timestamp using InstantFilter syntax (e.g., >2025-01-01T00:00:00Z, <2025-12-31T23:59:59Z).
updatedAt	string Filter by update timestamp using InstantFilter syntax (e.g., >2025-01-01T00:00:00Z).
deletedAt	string Filter by deletion timestamp using InstantFilter syntax.
page	integer >= 0 Default: 0 Zero-based page index.
size	integer >= 1 Default: 20 The number of resources returned per page.
sort	string Sorting criteria in the format: property,(asc\|desc).

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample find clusters request

"{\n  \"_embedded\" : {\n    \"clusterList\" : [ {\n      \"id\" : \"c2d807d4-5604-4e83-8b33-3ac271c38502\",\n      \"networkId\" : \"5216bf18-ea8c-4346-ba21-426127201d78\",\n      \"leaderId\" : \"364330fb-1db0-4e3c-a678-a48e57fa1a92\",\n      \"createdAt\" : \"2025-11-17T16:30:43.439882Z\",\n      \"updatedAt\" : \"2025-11-17T16:30:43.439882Z\",\n      \"deletedAt\" : null,\n      \"readOnly\" : false,\n      \"partitioned\" : false,\n      \"leaderMemberInfos\" : [ {\n        \"id\" : \"364330fb-1db0-4e3c-a678-a48e57fa1a92\",\n        \"address\" : \"364330fb-1db0-4e3c-a678-a48e57fa1a92\",\n        \"voter\" : true,\n        \"leader\" : true,\n        \"version\" : null,\n        \"connected\" : true,\n        \"readOnly\" : false\n      } ],\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/5216bf18-ea8c-4346-ba21-426127201d78\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/clusters/c2d807d4-5604-4e83-8b33-3ac271c38502\"\n        },\n        \"leader\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/364330fb-1db0-4e3c-a678-a48e57fa1a92\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/clusters\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 3500,\n    \"totalElements\" : 1,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Cloud Providers

Retrieves Cloud Providers

Get Cloud Provider

Returns a single Cloud Provider by its machine-readable key (e.g., AWS, GCP, OCI).

Authorizations:

bearerAuth

path Parameters

cloudProvider

required

string

Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER"

Example: AWS

Cloud provider key.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get cloud provider response

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

List Cloud Providers

Returns the list of supported cloud providers.

Authorizations:

bearerAuth

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample list cloud providers response

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

NetworkJwtSets

Retrieves NetworkJwtSets

Get Network JWT Set

Returns the set of JWT descriptors issued by the specified Network. The result may be empty if none exist.

Authorizations:

bearerAuth

path Parameters

networkId

required

string <uuid>

Example: 11111111-2222-3333-4444-555555555555

The unique identifier of the Network whose JWT set is requested.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get Network JWT Set response

"{\n  \"networkId\" : \"bd6a117f-6f1e-40e7-ad45-095b215b9433\",\n  \"zitiNetworkJwts\" : [ {\n    \"name\" : \"mock-network-jwt\",\n    \"token\" : \"token-value\"\n  } ],\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/bd6a117f-6f1e-40e7-ad45-095b215b9433\"\n    }\n  }\n}"

Hosts

Retrieves Hosts

Get Host

Returns a single Host by its unique identifier. Results are filtered to only include resources the caller may read.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Host.

query Parameters

meta	Array of strings Items Value: "describeCloudHost" Query and return (external) resources. Allowed meta values: describeCloudHost: Return detailed cloud host data

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get host response

"{\n  \"id\" : \"fde28f76-9b7e-4f63-8e90-994b5156849a\",\n  \"networkId\" : \"05f40cf1-8f54-4175-a762-9cbc350cdb70\",\n  \"ownerIdentityId\" : \"3ce688c9-b4be-4c22-8065-498fb351fc11\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"ipAddress\" : \"0.0.5.33\",\n  \"sshPort\" : 22,\n  \"sshPrivateKeyStoredSecretId\" : null,\n  \"providerInstanceId\" : \"be057ede-642d-4f37-b4e9-7bfad18254be\",\n  \"size\" : \"small\",\n  \"userData\" : null,\n  \"createdBy\" : null,\n  \"createdAt\" : \"2025-11-17T16:32:24.030264Z\",\n  \"updatedAt\" : \"2025-11-17T16:32:24.030264Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/05f40cf1-8f54-4175-a762-9cbc350cdb70\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/fde28f76-9b7e-4f63-8e90-994b5156849a\"\n    },\n    \"provider\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/cloud-providers/AWS\"\n    },\n    \"region\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/regions/AWS/us-east-1\"\n    }\n  }\n}"

Find Hosts

Returns Hosts matching the optional query parameters. Results are filtered to only include resources the caller may read.

Authorizations:

bearerAuth

query Parameters

networkId	any Example: networkId=11111111-2222-3333-4444-555555555555 Filter by Network ID(s). Repeat to specify multiple.
provider	any Example: provider=AWS Filter by cloud provider(s). Repeat to specify multiple.
providerInstanceId	any Example: providerInstanceId=i-0abc123def4567890 Filter by provider instance identifier(s).
port	any Deprecated Example: port=8443 Deprecated: previous controller port filter; use component-specific resources.
ipAddress	any Example: ipAddress=203.0.113.10 Filter by IP address(es).
sshPort	any Example: sshPort=22 Filter by SSH port(s).
sshPrivateKeyStoredSecretId	any Example: sshPrivateKeyStoredSecretId=bbbbbbbb-1111-2222-3333-cccccccccccc Filter by StoredSecret ID that holds the SSH private key.
hostSize	any Example: hostSize=small Filter by abstract Host size(s).
region	any Example: region=us-east-1 Filter by cloud region code(s).
ownerIdentityId	any Example: ownerIdentityId=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Filter by Owner Identity ID(s).
createdBy	any Example: createdBy=bbbbbbbb-1111-2222-3333-cccccccccccc Filter by creator identity ID(s).
deletedBy	any Example: deletedBy=dddddddd-eeee-ffff-1111-222222222222 Filter by deleter identity ID(s).
createdAt	any Example: createdAt=>=2025-01-01T00:00:00Z Created-at filter expressions. Supports >, >=, <, <=, =, != (e.g., createdAt=>=2025-01-01T00:00:00Z).
updatedAt	any Example: updatedAt=<=2025-12-31T23:59:59Z Updated-at filter expressions.
deletedAt	any Example: deletedAt=>2025-10-01T00:00:00Z Deleted-at filter expressions.
page	any Page index (0-based).
size	any Example: size=20 Page size.
sort	any Example: sort=provider,asc Sort expressions, e.g., provider,updatedAt,desc.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

No sample

Executions

Manage Execution resources

Cancel an Execution

Cancel a running or pending Execution by ID. If the underlying process is still active, the service attempts to cancel it and returns the updated Execution resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Execution to cancel.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get execution response

"{\n  \"id\" : \"c5e80418-a4ff-4eea-aab3-0438c391a21e\",\n  \"networkId\" : \"12b04999-4903-41eb-b781-79df991fc3b4\",\n  \"processId\" : \"e7590fc8-5edc-4ab0-95bc-eb7d832b4ea9\",\n  \"name\" : \"CreateEndpointProcess\",\n  \"description\" : \"Create Endpoint\",\n  \"resourceType\" : \"component\",\n  \"resourceId\" : \"e57d6e0d-29c1-489e-8608-b549a85febb1\",\n  \"startedAt\" : \"2025-12-05T15:18:13.347396Z\",\n  \"finishedAt\" : \"2025-12-05T15:18:13.407543Z\",\n  \"traceId\" : \"trace1\",\n  \"status\" : \"CANCELED\",\n  \"initiatingIdentityId\" : \"54263e60-3c9e-4193-9bbd-eb3accc5880f\",\n  \"createdAt\" : \"2025-12-05T15:18:13.348219Z\",\n  \"updatedAt\" : \"2025-12-05T15:18:13.409966Z\",\n  \"actions\" : [ ],\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/12b04999-4903-41eb-b781-79df991fc3b4\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/c5e80418-a4ff-4eea-aab3-0438c391a21e\",\n      \"title\" : \"CreateEndpointProcess\"\n    }\n  }\n}"

Cancel an Execution

Cancel a running or pending Execution by ID. If the underlying process is still active, the service attempts to cancel it and returns the updated Execution resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Execution to cancel.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get execution response

"{\n  \"id\" : \"c5e80418-a4ff-4eea-aab3-0438c391a21e\",\n  \"networkId\" : \"12b04999-4903-41eb-b781-79df991fc3b4\",\n  \"processId\" : \"e7590fc8-5edc-4ab0-95bc-eb7d832b4ea9\",\n  \"name\" : \"CreateEndpointProcess\",\n  \"description\" : \"Create Endpoint\",\n  \"resourceType\" : \"component\",\n  \"resourceId\" : \"e57d6e0d-29c1-489e-8608-b549a85febb1\",\n  \"startedAt\" : \"2025-12-05T15:18:13.347396Z\",\n  \"finishedAt\" : \"2025-12-05T15:18:13.407543Z\",\n  \"traceId\" : \"trace1\",\n  \"status\" : \"CANCELED\",\n  \"initiatingIdentityId\" : \"54263e60-3c9e-4193-9bbd-eb3accc5880f\",\n  \"createdAt\" : \"2025-12-05T15:18:13.348219Z\",\n  \"updatedAt\" : \"2025-12-05T15:18:13.409966Z\",\n  \"actions\" : [ ],\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/12b04999-4903-41eb-b781-79df991fc3b4\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions/c5e80418-a4ff-4eea-aab3-0438c391a21e\",\n      \"title\" : \"CreateEndpointProcess\"\n    }\n  }\n}"

Get an Execution

Retrieve a single Execution resource by its ID. The caller must have read permission on the associated Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Execution.

query Parameters

meta	Array of strings Items Value: "processData" Query and return (external) resources. Allowed meta values: processData: Return detailed process step data

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get execution response

"{\n  \"id\" : \"2b7a084e-2d98-40a0-8cf5-9942a1f5d6f4\",\n  \"networkId\" : \"453e2d2f-3578-4022-963c-db7663cb35ff\",\n  \"processId\" : \"46221766-5fed-4a11-99d2-0626f9ac0372\",\n  \"name\" : \"CreateNetworkProcess\",\n  \"description\" : \"Fake Process\",\n  \"resourceType\" : \"network\",\n  \"resourceId\" : null,\n  \"startedAt\" : \"2025-11-17T16:31:32.975506Z\",\n  \"finishedAt\" : \"2025-11-17T16:31:32.975506Z\",\n  \"traceId\" : \"trace3\",\n  \"status\" : \"FAILED\",\n  \"initiatingIdentityId\" : \"59405773-3867-4422-a281-bf3bf77814b7\",\n  \"createdAt\" : \"2025-11-17T16:31:32.975430Z\",\n  \"updatedAt\" : \"2025-11-17T16:31:32.975430Z\",\n  \"actions\" : [ {\n    \"title\" : \"Replay\",\n    \"method\" : \"PUT\",\n    \"url\" : \"http://localhost:8080/core/v2/networks/453e2d2f-3578-4022-963c-db7663cb35ff/replay\"\n  } ],\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/453e2d2f-3578-4022-963c-db7663cb35ff\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/executions/2b7a084e-2d98-40a0-8cf5-9942a1f5d6f4\",\n      \"title\" : \"CreateNetworkProcess\"\n    }\n  }\n}"

Find Executions

Find all Execution instances that match the specified search criteria. Results exclude resources the caller is not authorized to read; therefore this endpoint never returns 403/404, only an empty list when no authorized results are found.

Authorizations:

bearerAuth

query Parameters

id	any Example: id=8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b Filter by Execution ID.
networkId	any Example: networkId=6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11 Filter by associated Network ID.
name	any Example: name=Delete: myNetwork Filter by execution name (supports multiple values).
description	any Example: description=Deletes the specified network and its resources. Filter by execution description.
resourceType	any Example: resourceType=Network Filter by resource type acted upon (e.g., Network, NetworkController).
resourceId	any Example: resourceId=11111111-2222-3333-4444-555555555555 Filter by resource ID.
processId	any Example: processId=2f1b4a2e-9a2b-4c53-9e6c-9f1e8b6a7c21 Filter by underlying process ID.
traceId	any Example: traceId=trace-0af7651916cd43dd8448eb211c80319c Filter by trace correlation ID.
status	any Examples: status=RUNNING - running status=SUCCESS - success status=FAILED - failed Filter by execution status.
initiatingIdentityId	any Example: initiatingIdentityId=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Filter by the initiating identity ID.
startedAt	any Examples: startedAt=>2025-01-01T00:00:00Z - started-after startedAt=<2025-12-31T23:59:59Z - started-before Filter by startedAt with comparison operators. Supports >, >=, <, <=, =, != (e.g., startedAt=>=2025-01-01T00:00:00Z)
finishedAt	any Example: finishedAt==2025-05-10T13:37:00Z Filter by finishedAt with comparison operators.
createdAt	any Example: createdAt=>=2025-01-01T00:00:00Z Filter by createdAt with comparison operators.
updatedAt	any Example: updatedAt=<=2025-10-09T18:00:00Z Filter by updatedAt with comparison operators.
page	any Zero-based page index.
size	any Example: size=20 The size of the page to be returned.
sort	any Examples: sort=name,asc - name-asc sort=createdAt,desc - createdAt-desc Sorting criteria in the format: property,(asc\|desc). Multiple sort params are supported.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample find executions response

"{\n  \"_embedded\" : {\n    \"executionList\" : [ {\n      \"id\" : \"2561979f-ace4-41a0-96c8-36f140c1c716\",\n      \"networkId\" : \"60efa278-d9c1-442c-98cb-7dd862406776\",\n      \"processId\" : \"0188a610-dcb6-4c45-8962-570e55d1a7c7\",\n      \"name\" : \"CreateNetworkProcess\",\n      \"description\" : \"Fake Process\",\n      \"resourceType\" : \"network\",\n      \"resourceId\" : null,\n      \"startedAt\" : \"2025-11-17T16:31:32.579616Z\",\n      \"finishedAt\" : \"2025-11-17T16:31:32.579616Z\",\n      \"traceId\" : \"trace3\",\n      \"status\" : \"FAILED\",\n      \"initiatingIdentityId\" : \"806b0712-d415-4433-9fbc-c518d6365069\",\n      \"createdAt\" : \"2025-11-17T16:31:32.579442Z\",\n      \"updatedAt\" : \"2025-11-17T16:31:32.579442Z\",\n      \"actions\" : [ {\n        \"title\" : \"Replay\",\n        \"method\" : \"PUT\",\n        \"url\" : \"http://localhost:8080/core/v2/networks/60efa278-d9c1-442c-98cb-7dd862406776/replay\"\n      } ],\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/60efa278-d9c1-442c-98cb-7dd862406776\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/executions/2561979f-ace4-41a0-96c8-36f140c1c716\",\n          \"title\" : \"CreateNetworkProcess\"\n        }\n      }\n    }, {\n      \"id\" : \"68c31949-3bf4-4dba-aa9d-e3240a4db84b\",\n      \"networkId\" : \"60efa278-d9c1-442c-98cb-7dd862406776\",\n      \"processId\" : \"252e502c-8979-4f5d-81e0-cba9e8061db1\",\n      \"name\" : \"CreateEndpointProcess\",\n      \"description\" : \"Fake Process\",\n      \"resourceType\" : \"component\",\n      \"resourceId\" : \"98f9de14-67de-4104-bc63-254b42dd023f\",\n      \"startedAt\" : \"2025-11-17T16:31:32.573991Z\",\n      \"finishedAt\" : null,\n      \"traceId\" : \"trace2\",\n      \"status\" : \"RUNNING\",\n      \"initiatingIdentityId\" : \"9dd9fefb-f1fe-4222-8365-aacfaa7f62cf\",\n      \"createdAt\" : \"2025-11-17T16:31:32.574793Z\",\n      \"updatedAt\" : \"2025-11-17T16:31:32.574793Z\",\n      \"actions\" : [ {\n        \"title\" : \"Cancel\",\n        \"method\" : \"PUT\",\n        \"url\" : \"http://localhost:8080/core/v2/executions/68c31949-3bf4-4dba-aa9d-e3240a4db84b/cancel\"\n      } ],\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/60efa278-d9c1-442c-98cb-7dd862406776\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/executions/68c31949-3bf4-4dba-aa9d-e3240a4db84b\",\n          \"title\" : \"CreateEndpointProcess\"\n        }\n      }\n    }, {\n      \"id\" : \"6a41cced-6e9a-4a2c-879f-66379a67e475\",\n      \"networkId\" : \"60efa278-d9c1-442c-98cb-7dd862406776\",\n      \"processId\" : \"a8713822-229b-4f63-8441-dae402bc575d\",\n      \"name\" : \"CreateEndpointProcess\",\n      \"description\" : \"Fake Process\",\n      \"resourceType\" : \"component\",\n      \"resourceId\" : \"6b0088c5-ba19-4040-9e37-7d6116d0ac9b\",\n      \"startedAt\" : \"2025-11-17T16:31:32.529892Z\",\n      \"finishedAt\" : \"2025-11-17T16:31:32.529892Z\",\n      \"traceId\" : \"trace1\",\n      \"status\" : \"SUCCESS\",\n      \"initiatingIdentityId\" : \"3fcde6bc-6288-4af9-88c5-3808bfec70d8\",\n      \"createdAt\" : \"2025-11-17T16:31:32.546710Z\",\n      \"updatedAt\" : \"2025-11-17T16:31:32.546710Z\",\n      \"actions\" : [ ],\n      \"_links\" : {\n        \"network\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/60efa278-d9c1-442c-98cb-7dd862406776\",\n          \"profile\" : \"parent\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v2/executions/6a41cced-6e9a-4a2c-879f-66379a67e475\",\n          \"title\" : \"CreateEndpointProcess\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/executions?networkId=60efa278-d9c1-442c-98cb-7dd862406776\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 3500,\n    \"totalElements\" : 3,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Networks

Manage Network resources

Suspend Network

Suspend the specified Network. This will stop all of the controllers on the Network from running without deleting them. The operation is asynchronous and returns the updated Network resource with related links. The caller must have the update-suspend permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network to suspend

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"e99603ba-70c3-4886-99a3-2936f88aefed\",\n  \"ownerIdentityId\" : \"8b823d48-ca03-4e92-ba85-19187f3bb6c1\",\n  \"createdBy\" : \"8b823d48-ca03-4e92-ba85-19187f3bb6c1\",\n  \"createdAt\" : \"2025-12-05T15:19:42.705537Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:42.782645Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"suspend-test-v3\",\n  \"networkGroupId\" : \"e37e2a44-4784-4c64-a3d5-3e276126c260\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"UPDATING\",\n  \"publicCertEnabled\" : false,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/e99603ba-70c3-4886-99a3-2936f88aefed\",\n      \"title\" : \"suspend-test-v3\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/e37e2a44-4784-4c64-a3d5-3e276126c260\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Suspend Network

Suspend the specified Network. This will stop all of the controllers on the Network from running without deleting them. The operation is asynchronous and returns the updated Network resource with related links. The caller must have the update-suspend permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network to suspend

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"e99603ba-70c3-4886-99a3-2936f88aefed\",\n  \"ownerIdentityId\" : \"8b823d48-ca03-4e92-ba85-19187f3bb6c1\",\n  \"createdBy\" : \"8b823d48-ca03-4e92-ba85-19187f3bb6c1\",\n  \"createdAt\" : \"2025-12-05T15:19:42.705537Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:42.782645Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"suspend-test-v3\",\n  \"networkGroupId\" : \"e37e2a44-4784-4c64-a3d5-3e276126c260\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"UPDATING\",\n  \"publicCertEnabled\" : false,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/e99603ba-70c3-4886-99a3-2936f88aefed\",\n      \"title\" : \"suspend-test-v3\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/e37e2a44-4784-4c64-a3d5-3e276126c260\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Resume Network

Resume the specified Network. This will restart all of the suspended controllers on the Network. The operation is asynchronous and returns the updated Network resource with related links. The caller must have the update-resume permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network to resume

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"019af781-ac45-4a60-b843-1efe4775ddd7\",\n  \"ownerIdentityId\" : \"74d34147-a204-4a66-a1c9-0bd25a25c80e\",\n  \"createdBy\" : \"74d34147-a204-4a66-a1c9-0bd25a25c80e\",\n  \"createdAt\" : \"2025-12-05T15:19:42.226612Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:42.336787Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"resume-test-v3\",\n  \"networkGroupId\" : \"23471914-5628-47bc-b498-325a4853998f\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"UPDATING\",\n  \"publicCertEnabled\" : false,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/019af781-ac45-4a60-b843-1efe4775ddd7\",\n      \"title\" : \"resume-test-v3\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/23471914-5628-47bc-b498-325a4853998f\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Resume Network

Resume the specified Network. This will restart all of the suspended controllers on the Network. The operation is asynchronous and returns the updated Network resource with related links. The caller must have the update-resume permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network to resume

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"019af781-ac45-4a60-b843-1efe4775ddd7\",\n  \"ownerIdentityId\" : \"74d34147-a204-4a66-a1c9-0bd25a25c80e\",\n  \"createdBy\" : \"74d34147-a204-4a66-a1c9-0bd25a25c80e\",\n  \"createdAt\" : \"2025-12-05T15:19:42.226612Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:42.336787Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"resume-test-v3\",\n  \"networkGroupId\" : \"23471914-5628-47bc-b498-325a4853998f\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"UPDATING\",\n  \"publicCertEnabled\" : false,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/019af781-ac45-4a60-b843-1efe4775ddd7\",\n      \"title\" : \"resume-test-v3\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/23471914-5628-47bc-b498-325a4853998f\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Restart network controller processes

Restart all controller processes for the specified Network. Optionally restart controller services concurrently. The caller must have the update-heal permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Options for restarting processes. If omitted, defaults are applied.

concurrentControllerRestart

boolean

If true, restarts controller services concurrently with the primary restart operation. Defaults to false when omitted.

Responses

Request samples

Payload

Content type

application/json

Example

default

{"concurrentControllerRestart": false
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"f6a203e8-a6c6-4350-b983-5295cf899935\",\n  \"ownerIdentityId\" : \"75a5f6f0-5faa-470e-82dc-aa31d4d666c1\",\n  \"createdBy\" : \"75a5f6f0-5faa-470e-82dc-aa31d4d666c1\",\n  \"createdAt\" : \"2025-11-17T16:24:56.099409Z\",\n  \"updatedAt\" : \"2025-11-17T16:24:56.145494Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"network-351\",\n  \"networkGroupId\" : \"83e45c77-c4e3-4c49-b42b-1c3ba034f209\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"7.4.16\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"UPDATING\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"networkController\" : {\n    \"id\" : \"f878bd1f-47d0-4ac3-a13a-b801a1499fe6\",\n    \"ownerIdentityId\" : \"75a5f6f0-5faa-470e-82dc-aa31d4d666c1\",\n    \"networkId\" : \"f6a203e8-a6c6-4350-b983-5295cf899935\",\n    \"domainName\" : \"f878bd1f-47d0-4ac3-a13a-b801a1499fe6.nf.io\",\n    \"alternateDomainName\" : null,\n    \"port\" : 443,\n    \"name\" : \"network-351-nc\",\n    \"productVersion\" : \"7.4.16\",\n    \"hostId\" : \"0a81eae5-a6b0-4481-ba54-06013cb57e86\",\n    \"status\" : \"PROVISIONED\",\n    \"createdAt\" : \"2025-11-17T16:24:56.108395Z\",\n    \"updatedAt\" : \"2025-11-17T16:24:56.119536Z\",\n    \"deletedAt\" : null,\n    \"createdBy\" : \"75a5f6f0-5faa-470e-82dc-aa31d4d666c1\",\n    \"deletedBy\" : null,\n    \"softwareDeploymentStateId\" : \"c5d461ea-60e9-45d7-a9ac-50180ec16190\",\n    \"haPrimaryNode\" : true\n  },\n  \"_links\" : {\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-groups/83e45c77-c4e3-4c49-b42b-1c3ba034f209\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/f6a203e8-a6c6-4350-b983-5295cf899935\",\n      \"title\" : \"network-351\"\n    }\n  }\n}"

Restart network controller processes

Restart all controller processes for the specified Network. Optionally restart controller services concurrently. The caller must have the update-heal permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Options for restarting processes. If omitted, defaults are applied.

concurrentControllerRestart

boolean

If true, restarts controller services concurrently with the primary restart operation. Defaults to false when omitted.

Responses

Request samples

Payload

Content type

application/json

Example

default

{"concurrentControllerRestart": false
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"f6a203e8-a6c6-4350-b983-5295cf899935\",\n  \"ownerIdentityId\" : \"75a5f6f0-5faa-470e-82dc-aa31d4d666c1\",\n  \"createdBy\" : \"75a5f6f0-5faa-470e-82dc-aa31d4d666c1\",\n  \"createdAt\" : \"2025-11-17T16:24:56.099409Z\",\n  \"updatedAt\" : \"2025-11-17T16:24:56.145494Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"network-351\",\n  \"networkGroupId\" : \"83e45c77-c4e3-4c49-b42b-1c3ba034f209\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"7.4.16\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"UPDATING\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"networkController\" : {\n    \"id\" : \"f878bd1f-47d0-4ac3-a13a-b801a1499fe6\",\n    \"ownerIdentityId\" : \"75a5f6f0-5faa-470e-82dc-aa31d4d666c1\",\n    \"networkId\" : \"f6a203e8-a6c6-4350-b983-5295cf899935\",\n    \"domainName\" : \"f878bd1f-47d0-4ac3-a13a-b801a1499fe6.nf.io\",\n    \"alternateDomainName\" : null,\n    \"port\" : 443,\n    \"name\" : \"network-351-nc\",\n    \"productVersion\" : \"7.4.16\",\n    \"hostId\" : \"0a81eae5-a6b0-4481-ba54-06013cb57e86\",\n    \"status\" : \"PROVISIONED\",\n    \"createdAt\" : \"2025-11-17T16:24:56.108395Z\",\n    \"updatedAt\" : \"2025-11-17T16:24:56.119536Z\",\n    \"deletedAt\" : null,\n    \"createdBy\" : \"75a5f6f0-5faa-470e-82dc-aa31d4d666c1\",\n    \"deletedBy\" : null,\n    \"softwareDeploymentStateId\" : \"c5d461ea-60e9-45d7-a9ac-50180ec16190\",\n    \"haPrimaryNode\" : true\n  },\n  \"_links\" : {\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-groups/83e45c77-c4e3-4c49-b42b-1c3ba034f209\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/f6a203e8-a6c6-4350-b983-5295cf899935\",\n      \"title\" : \"network-351\"\n    }\n  }\n}"

Restart network controller hosts

Restart all controller hosts for the specified Network. Optionally restart controller services concurrently. The caller must have the update-heal permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Options for restarting hosts. If omitted, defaults are applied.

concurrentControllerRestart

boolean

If true, restarts controller services concurrently with the primary restart operation. Defaults to false when omitted.

Responses

Request samples

Payload

Content type

application/json

Example

default

{"concurrentControllerRestart": false
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"1edbcee5-14d3-4919-bcf9-65974afb9998\",\n  \"ownerIdentityId\" : \"f2d3f2c4-bf1b-4186-a8aa-119c168d8f6a\",\n  \"createdBy\" : \"f2d3f2c4-bf1b-4186-a8aa-119c168d8f6a\",\n  \"createdAt\" : \"2025-11-17T16:24:55.722276Z\",\n  \"updatedAt\" : \"2025-11-17T16:24:55.775181Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"network-334\",\n  \"networkGroupId\" : \"38d007e0-7b4c-409d-b4d0-18ec1da20bde\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"7.4.16\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"UPDATING\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"networkController\" : {\n    \"id\" : \"5cf90e8d-c86a-4ff0-ba3b-5cc0a0c03fc6\",\n    \"ownerIdentityId\" : \"f2d3f2c4-bf1b-4186-a8aa-119c168d8f6a\",\n    \"networkId\" : \"1edbcee5-14d3-4919-bcf9-65974afb9998\",\n    \"domainName\" : \"5cf90e8d-c86a-4ff0-ba3b-5cc0a0c03fc6.nf.io\",\n    \"alternateDomainName\" : null,\n    \"port\" : 443,\n    \"name\" : \"network-334-nc\",\n    \"productVersion\" : \"7.4.16\",\n    \"hostId\" : \"9f461f88-2d7b-4a3e-bcaf-ce6a630881b7\",\n    \"status\" : \"PROVISIONED\",\n    \"createdAt\" : \"2025-11-17T16:24:55.730847Z\",\n    \"updatedAt\" : \"2025-11-17T16:24:55.741246Z\",\n    \"deletedAt\" : null,\n    \"createdBy\" : \"f2d3f2c4-bf1b-4186-a8aa-119c168d8f6a\",\n    \"deletedBy\" : null,\n    \"softwareDeploymentStateId\" : \"d4ba6464-1c2b-4d4a-8db2-db3491254938\",\n    \"haPrimaryNode\" : true\n  },\n  \"_links\" : {\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-groups/38d007e0-7b4c-409d-b4d0-18ec1da20bde\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/1edbcee5-14d3-4919-bcf9-65974afb9998\",\n      \"title\" : \"network-334\"\n    }\n  }\n}"

Restart network controller hosts

Restart all controller hosts for the specified Network. Optionally restart controller services concurrently. The caller must have the update-heal permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Options for restarting hosts. If omitted, defaults are applied.

concurrentControllerRestart

boolean

If true, restarts controller services concurrently with the primary restart operation. Defaults to false when omitted.

Responses

Request samples

Payload

Content type

application/json

Example

default

{"concurrentControllerRestart": false
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"1edbcee5-14d3-4919-bcf9-65974afb9998\",\n  \"ownerIdentityId\" : \"f2d3f2c4-bf1b-4186-a8aa-119c168d8f6a\",\n  \"createdBy\" : \"f2d3f2c4-bf1b-4186-a8aa-119c168d8f6a\",\n  \"createdAt\" : \"2025-11-17T16:24:55.722276Z\",\n  \"updatedAt\" : \"2025-11-17T16:24:55.775181Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"network-334\",\n  \"networkGroupId\" : \"38d007e0-7b4c-409d-b4d0-18ec1da20bde\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"7.4.16\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"UPDATING\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"networkController\" : {\n    \"id\" : \"5cf90e8d-c86a-4ff0-ba3b-5cc0a0c03fc6\",\n    \"ownerIdentityId\" : \"f2d3f2c4-bf1b-4186-a8aa-119c168d8f6a\",\n    \"networkId\" : \"1edbcee5-14d3-4919-bcf9-65974afb9998\",\n    \"domainName\" : \"5cf90e8d-c86a-4ff0-ba3b-5cc0a0c03fc6.nf.io\",\n    \"alternateDomainName\" : null,\n    \"port\" : 443,\n    \"name\" : \"network-334-nc\",\n    \"productVersion\" : \"7.4.16\",\n    \"hostId\" : \"9f461f88-2d7b-4a3e-bcaf-ce6a630881b7\",\n    \"status\" : \"PROVISIONED\",\n    \"createdAt\" : \"2025-11-17T16:24:55.730847Z\",\n    \"updatedAt\" : \"2025-11-17T16:24:55.741246Z\",\n    \"deletedAt\" : null,\n    \"createdBy\" : \"f2d3f2c4-bf1b-4186-a8aa-119c168d8f6a\",\n    \"deletedBy\" : null,\n    \"softwareDeploymentStateId\" : \"d4ba6464-1c2b-4d4a-8db2-db3491254938\",\n    \"haPrimaryNode\" : true\n  },\n  \"_links\" : {\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-groups/38d007e0-7b4c-409d-b4d0-18ec1da20bde\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/1edbcee5-14d3-4919-bcf9-65974afb9998\",\n      \"title\" : \"network-334\"\n    }\n  }\n}"

Retrieve a Network

Retrieve a single Network resource by its ID. The caller must have the read permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

query Parameters

embed	Array of strings Items Enum: "all" "executions" "network-controllers" "hosts" "network-jwt-sets" "edge-routers" Embed related resources in the result. Allowed: all \| executions \| network-controllers \| hosts \| network-jwt-sets \| edge-routers.
meta	Array of strings Items Value: "zitiVersion" Query and return (external) resources. Allowed meta values: zitiVersion: Return the Ziti version information

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get network response

"{\n  \"id\" : \"238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\",\n  \"ownerIdentityId\" : \"0ae9effc-22d8-45b6-b328-724f944c0c0e\",\n  \"createdBy\" : \"0ae9effc-22d8-45b6-b328-724f944c0c0e\",\n  \"createdAt\" : \"2025-12-05T15:19:14.824653Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:14.826967Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"network-617\",\n  \"networkGroupId\" : \"1b29c5ab-1a40-4405-9a1e-c3fe27b7e7ed\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONED\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : true,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\",\n      \"title\" : \"network-617\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/1b29c5ab-1a40-4405-9a1e-c3fe27b7e7ed\",\n      \"profile\" : \"parent\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    },\n    \"clusters\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/clusters?networkId=238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    }\n  }\n}"

Update a Network

Update mutable properties of a Network such as name, owner identity, HA setting, and additional network controllers. The caller must have the update permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Fields to update on the Network. Omitted fields are left unchanged.

name	string New human-friendly name for the Network.
publicCertEnabled	boolean Enable public certificate for the Network (required for v8 networks). If omitted, controller may enforce defaults.
haEnabled	boolean Enable High Availability (allows additional Network Controllers).
	Array of objects (CreateNetworkController) unique
	Array of objects (CreateEdgeRouter) unique
	Array of objects (CreateEdgeRouterPolicy) unique
	Array of objects (CreateServiceEdgeRouterPolicy) unique
	Array of objects (CreateServicePolicy) unique
	Array of objects (CreateService) unique
	Array of objects (CreateCertificateAuthority) unique
	Array of objects (CreateEndpoint) unique
	Array of objects (CreateAppWan) unique
	Array of objects (CreatePostureCheck) unique
ownerIdentityId	string <uuid> Transfer ownership to another identity.

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"test12345\",\"publicCertEnabled\":null,\"networkControllers\":[],\"edgeRouters\":[],\"edgeRouterPolicies\":[],\"serviceEdgeRouterPolicies\":[],\"servicePolicies\":[],\"services\":[],\"certificateAuthorities\":[],\"endpoints\":[],\"appWans\":[],\"postureChecks\":[]}"

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"6ba21b2d-a46e-4430-aaa9-592cef187f04\",\n  \"ownerIdentityId\" : \"46bf130c-f3af-4fdc-ab60-d6e2008fbb07\",\n  \"createdBy\" : \"46bf130c-f3af-4fdc-ab60-d6e2008fbb07\",\n  \"createdAt\" : \"2025-12-05T15:19:43.186794Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:43.259689Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"test12345\",\n  \"networkGroupId\" : \"8356ad13-1e16-41f1-bb91-5b9341abfa28\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONED\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : true,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/6ba21b2d-a46e-4430-aaa9-592cef187f04\",\n      \"title\" : \"test12345\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/8356ad13-1e16-41f1-bb91-5b9341abfa28\",\n      \"profile\" : \"parent\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    },\n    \"clusters\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/clusters?networkId=6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    }\n  }\n}"

Delete a Network

Delete a Network by ID if it is in an allowed state(PROVISIONED, ERROR, SUSPENDED, DELETED, OFFILINE). The caller must have the delete permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Sample delete network response

"{\n  \"id\" : \"5e45791b-9d93-4910-996b-fd3239f7b0ce\",\n  \"ownerIdentityId\" : \"eda7bd03-a337-44e2-9585-682336a405c0\",\n  \"createdBy\" : \"eda7bd03-a337-44e2-9585-682336a405c0\",\n  \"createdAt\" : \"2025-12-05T15:19:13.628228Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:13.699639Z\",\n  \"deletedBy\" : \"b2f42a21-6eb2-457d-b730-e8758dc8cfc8\",\n  \"deletedAt\" : null,\n  \"name\" : \"network-569\",\n  \"networkGroupId\" : \"793ee764-0ba0-4ea1-a369-e5f857e96986\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"DELETING\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : true,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/5e45791b-9d93-4910-996b-fd3239f7b0ce\",\n      \"title\" : \"network-569\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/793ee764-0ba0-4ea1-a369-e5f857e96986\",\n      \"profile\" : \"parent\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/5e45791b-9d93-4910-996b-fd3239f7b0ce\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=5e45791b-9d93-4910-996b-fd3239f7b0ce\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=5e45791b-9d93-4910-996b-fd3239f7b0ce\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=5e45791b-9d93-4910-996b-fd3239f7b0ce\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=5e45791b-9d93-4910-996b-fd3239f7b0ce\"\n    },\n    \"clusters\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/clusters?networkId=5e45791b-9d93-4910-996b-fd3239f7b0ce\"\n    }\n  }\n}"

Update a Network

Update mutable properties of a Network such as name, owner identity, HA setting, and additional network controllers. The caller must have the update permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Fields to update on the Network. Omitted fields are left unchanged.

name	string New human-friendly name for the Network.
publicCertEnabled	boolean Enable public certificate for the Network (required for v8 networks). If omitted, controller may enforce defaults.
haEnabled	boolean Enable High Availability (allows additional Network Controllers).
	Array of objects (CreateNetworkController) unique
	Array of objects (CreateEdgeRouter) unique
	Array of objects (CreateEdgeRouterPolicy) unique
	Array of objects (CreateServiceEdgeRouterPolicy) unique
	Array of objects (CreateServicePolicy) unique
	Array of objects (CreateService) unique
	Array of objects (CreateCertificateAuthority) unique
	Array of objects (CreateEndpoint) unique
	Array of objects (CreateAppWan) unique
	Array of objects (CreatePostureCheck) unique
ownerIdentityId	string <uuid> Transfer ownership to another identity.

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"test12345\",\"publicCertEnabled\":null,\"networkControllers\":[],\"edgeRouters\":[],\"edgeRouterPolicies\":[],\"serviceEdgeRouterPolicies\":[],\"servicePolicies\":[],\"services\":[],\"certificateAuthorities\":[],\"endpoints\":[],\"appWans\":[],\"postureChecks\":[]}"

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"6ba21b2d-a46e-4430-aaa9-592cef187f04\",\n  \"ownerIdentityId\" : \"46bf130c-f3af-4fdc-ab60-d6e2008fbb07\",\n  \"createdBy\" : \"46bf130c-f3af-4fdc-ab60-d6e2008fbb07\",\n  \"createdAt\" : \"2025-12-05T15:19:43.186794Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:43.259689Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"test12345\",\n  \"networkGroupId\" : \"8356ad13-1e16-41f1-bb91-5b9341abfa28\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONED\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : true,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/6ba21b2d-a46e-4430-aaa9-592cef187f04\",\n      \"title\" : \"test12345\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/8356ad13-1e16-41f1-bb91-5b9341abfa28\",\n      \"profile\" : \"parent\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    },\n    \"clusters\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/clusters?networkId=6ba21b2d-a46e-4430-aaa9-592cef187f04\"\n    }\n  }\n}"

Replay the creation of a Network

Replay the creation of a Network. This is useful if the original creation process failed. If the original payload is no longer cached, the request will fail.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"892a3e37-dfc0-4785-9172-169d292afd8f\",\n  \"ownerIdentityId\" : \"62c3b79f-4d6f-4e98-8754-074fcd807f46\",\n  \"createdBy\" : \"62c3b79f-4d6f-4e98-8754-074fcd807f46\",\n  \"createdAt\" : \"2025-12-05T15:19:19.380504Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:19.407457Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"test-network-722\",\n  \"networkGroupId\" : \"5b8b50cb-719e-42c0-b93e-3b78434b8cf9\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONING\",\n  \"publicCertEnabled\" : false,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/892a3e37-dfc0-4785-9172-169d292afd8f\",\n      \"title\" : \"test-network-722\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/5b8b50cb-719e-42c0-b93e-3b78434b8cf9\",\n      \"profile\" : \"parent\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/892a3e37-dfc0-4785-9172-169d292afd8f\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=892a3e37-dfc0-4785-9172-169d292afd8f\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=892a3e37-dfc0-4785-9172-169d292afd8f\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=892a3e37-dfc0-4785-9172-169d292afd8f\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=892a3e37-dfc0-4785-9172-169d292afd8f\"\n    }\n  }\n}"

Replay the creation of a Network

Replay the creation of a Network. This is useful if the original creation process failed. If the original payload is no longer cached, the request will fail.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"892a3e37-dfc0-4785-9172-169d292afd8f\",\n  \"ownerIdentityId\" : \"62c3b79f-4d6f-4e98-8754-074fcd807f46\",\n  \"createdBy\" : \"62c3b79f-4d6f-4e98-8754-074fcd807f46\",\n  \"createdAt\" : \"2025-12-05T15:19:19.380504Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:19.407457Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"test-network-722\",\n  \"networkGroupId\" : \"5b8b50cb-719e-42c0-b93e-3b78434b8cf9\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONING\",\n  \"publicCertEnabled\" : false,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/892a3e37-dfc0-4785-9172-169d292afd8f\",\n      \"title\" : \"test-network-722\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/5b8b50cb-719e-42c0-b93e-3b78434b8cf9\",\n      \"profile\" : \"parent\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/892a3e37-dfc0-4785-9172-169d292afd8f\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=892a3e37-dfc0-4785-9172-169d292afd8f\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=892a3e37-dfc0-4785-9172-169d292afd8f\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=892a3e37-dfc0-4785-9172-169d292afd8f\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=892a3e37-dfc0-4785-9172-169d292afd8f\"\n    }\n  }\n}"

Find all Networks that match the specified criteria

Find all Network instances that match the specified search criteria. The endpoint removes from the results any instances for which you do not have read authorization. As a side effect, this endpoint never returns a 403 or 404 error. Instead, it returns an empty list.

Authorizations:

bearerAuth

query Parameters

id	any Example: id=6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11 Filter by Network ID.
name	any Example: name=My Network Filter by Network name.
networkGroupId	any Example: networkGroupId=11111111-2222-3333-4444-555555555555 Filter by Network Group ID.
productVersion	any Examples: productVersion=2.3.1 - 2.3.1 productVersion=3.0.0 - 3.0.0 Filter by product version.
status	any Examples: status=RUNNING - running status=SUSPENDED - suspended Filter by Network status.
publicCertEnabled	any Examples: publicCertEnabled=true - true publicCertEnabled=false - false Filter by whether public certificate is enabled.
dnsZoneId	any Example: dnsZoneId=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Filter by DNS Zone ID.
ownerIdentityId	any Example: ownerIdentityId=aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb Filter by owner identity ID.
createdBy	any Example: createdBy=bbbbbbbb-1111-2222-3333-cccccccccccc Filter by creator identity ID.
deletedBy	any Example: deletedBy=cccccccc-1111-2222-3333-dddddddddddd Filter by deleter identity ID.
haEnabled	any Examples: haEnabled=true - true haEnabled=false - false Filter by High Availability (HA) flag.
createdAt	any Examples: createdAt=>2025-01-01T00:00:00Z - created-after createdAt=<2025-12-31T23:59:59Z - created-before Filter by createdAt with comparison operators. Supports >, >=, <, <=, =, !=
updatedAt	any Example: updatedAt=>=2025-01-01T00:00:00Z Filter by updatedAt with comparison operators.
deletedAt	any Example: deletedAt==2025-05-10T13:37:00Z Filter by deletedAt with comparison operators.
page	any Zero-based page index.
size	any Example: size=20 The size of the page to be returned.
sort	any Examples: sort=name,asc - name-asc sort=createdAt,desc - createdAt-desc Sorting criteria in the format: property,(asc\|desc). Multiple sort params are supported.
network.size	Array of strings unique
findByName	string Deprecated
findByNetworkGroupId	string <uuid> Deprecated
region	string Deprecated
locationCode	string Deprecated

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample find networks request

"{\n  \"_embedded\" : {\n    \"networkList\" : [ {\n      \"id\" : \"cd89f366-605d-490f-ad6b-ede1c8587c57\",\n      \"ownerIdentityId\" : \"28a64561-d998-4867-b5a1-56cedd554010\",\n      \"createdBy\" : \"28a64561-d998-4867-b5a1-56cedd554010\",\n      \"createdAt\" : \"2026-01-14T16:32:02.972391Z\",\n      \"updatedAt\" : \"2026-01-14T16:32:02.977500Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"name\" : \"network-6\",\n      \"networkGroupId\" : \"cf87629d-158e-4ef1-bd1e-90819c6dbd05\",\n      \"size\" : \"small\",\n      \"productVersion\" : \"8.0.43\",\n      \"region\" : \"us-east-1\",\n      \"status\" : \"PROVISIONED\",\n      \"publicCertEnabled\" : true,\n      \"haEnabled\" : false,\n      \"dnsZoneId\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/cd89f366-605d-490f-ad6b-ede1c8587c57\",\n          \"title\" : \"network-6\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/cf87629d-158e-4ef1-bd1e-90819c6dbd05\",\n          \"profile\" : \"parent\"\n        },\n        \"networks\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n          \"profile\" : \"parent\"\n        },\n        \"network-jwt-sets\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/cd89f366-605d-490f-ad6b-ede1c8587c57\"\n        },\n        \"network-controllers\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=cd89f366-605d-490f-ad6b-ede1c8587c57\"\n        },\n        \"executions\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=cd89f366-605d-490f-ad6b-ede1c8587c57\"\n        },\n        \"edge-routers\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=cd89f366-605d-490f-ad6b-ede1c8587c57\"\n        },\n        \"hosts\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=cd89f366-605d-490f-ad6b-ede1c8587c57\"\n        }\n      }\n    }, {\n      \"id\" : \"f8095468-5dd4-428c-bd12-fdcd301faae5\",\n      \"ownerIdentityId\" : \"3709ae8f-1016-41b0-80e7-a7bbd1a4ac37\",\n      \"createdBy\" : \"3709ae8f-1016-41b0-80e7-a7bbd1a4ac37\",\n      \"createdAt\" : \"2026-01-14T16:32:02.888714Z\",\n      \"updatedAt\" : \"2026-01-14T16:32:02.903532Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"name\" : \"network-2\",\n      \"networkGroupId\" : \"f3a55921-1fb1-4638-b3f4-f374f322f0a8\",\n      \"size\" : \"small\",\n      \"productVersion\" : \"8.0.43\",\n      \"region\" : \"us-east-1\",\n      \"status\" : \"PROVISIONED\",\n      \"publicCertEnabled\" : true,\n      \"haEnabled\" : true,\n      \"dnsZoneId\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/f8095468-5dd4-428c-bd12-fdcd301faae5\",\n          \"title\" : \"network-2\"\n        },\n        \"network-group\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/f3a55921-1fb1-4638-b3f4-f374f322f0a8\",\n          \"profile\" : \"parent\"\n        },\n        \"networks\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n          \"profile\" : \"parent\"\n        },\n        \"network-jwt-sets\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/f8095468-5dd4-428c-bd12-fdcd301faae5\"\n        },\n        \"network-controllers\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=f8095468-5dd4-428c-bd12-fdcd301faae5\"\n        },\n        \"executions\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=f8095468-5dd4-428c-bd12-fdcd301faae5\"\n        },\n        \"edge-routers\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=f8095468-5dd4-428c-bd12-fdcd301faae5\"\n        },\n        \"hosts\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=f8095468-5dd4-428c-bd12-fdcd301faae5\"\n        },\n        \"clusters\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/core/v3/clusters?networkId=f8095468-5dd4-428c-bd12-fdcd301faae5\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 3500,\n    \"totalElements\" : 2,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Create a new Network

Create a new Network resource. The provider field determines if NetFoundry or the customer hosts the network. The caller must have create permission on Network resources. If the provider is CUSTOMER, the caller must also have create-customer-hosted authorization.

Authorizations:

bearerAuth

header Parameters

nf-validate

string

Request Body schema: application/json
required

The network to create.

networkGroupId required	string <uuid> ID of the Network Group that will own the new Network.
size	string Requested deployment size for controller hosts. If omitted, a provider-specific default is selected.
name required	string Human-friendly name for the Network.
	object (Semver) Desired Network software product version in semantic version format. If omitted, defaults to the current v8 default.
provider required	string Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Cloud provider that will host the Network. Use CUSTOMER for customer-hosted networks.
region	string Cloud region code. Ignored for CUSTOMER provider where it is set to 'none'.
publicCertEnabled	boolean Enable public certificate for the Network (required for v8 networks). If omitted, controller may enforce defaults.
haEnabled	boolean Enable High Availability (allow creation of additional Network Controllers).
dnsZoneId	string <uuid> Reference to a validated DNS Zone to use for public certificates.
alternateDomainName	string Alternate domain name to use for controller endpoints.
	object (CustomerProviderDetails) Details required when provider is CUSTOMER (e.g., SSH key pair name, VPC, etc.).
	Array of objects (CreateNetworkController) unique
	Array of objects (CreateEdgeRouter) unique
	Array of objects (CreateEdgeRouterPolicy) unique
	Array of objects (CreateServiceEdgeRouterPolicy) unique
	Array of objects (CreateServicePolicy) unique
	Array of objects (CreateService) unique
	Array of objects (CreateCertificateAuthority) unique
	Array of objects (CreateEndpoint) unique
	Array of objects (CreateAppWan) unique
	Array of objects (CreatePostureCheck) unique

Responses

Request samples

Payload

Content type

application/json

default

"{\"networkGroupId\":\"0230661b-0992-4394-9c3e-84ae4a487ff4\",\"size\":\"small\",\"name\":\"Create Test Network-512\",\"productVersion\":\"8.0.43\",\"provider\":\"AWS\",\"region\":\"us-east-1\",\"publicCertEnabled\":false,\"haEnabled\":false}"

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"b0979ff1-0f49-45c3-ba21-ea2bd2ff30cf\",\n  \"ownerIdentityId\" : \"dcfc5dc3-8df0-4b33-aba3-77cb1d775af5\",\n  \"createdBy\" : \"dcfc5dc3-8df0-4b33-aba3-77cb1d775af5\",\n  \"createdAt\" : \"2025-12-05T15:18:57.733573Z\",\n  \"updatedAt\" : \"2025-12-05T15:18:57.733573Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"Create Test Network-512\",\n  \"networkGroupId\" : \"0230661b-0992-4394-9c3e-84ae4a487ff4\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONING\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : false,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/b0979ff1-0f49-45c3-ba21-ea2bd2ff30cf\",\n      \"title\" : \"Create Test Network-512\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/0230661b-0992-4394-9c3e-84ae4a487ff4\",\n      \"profile\" : \"parent\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/b0979ff1-0f49-45c3-ba21-ea2bd2ff30cf\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=b0979ff1-0f49-45c3-ba21-ea2bd2ff30cf\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=b0979ff1-0f49-45c3-ba21-ea2bd2ff30cf\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=b0979ff1-0f49-45c3-ba21-ea2bd2ff30cf\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=b0979ff1-0f49-45c3-ba21-ea2bd2ff30cf\"\n    }\n  }\n}"

Repair management access for a Network

Attempt to repair management access for the specified Network. This operation can be used when management access to the Network's controllers has been lost or degraded. The repair is asynchronous and the response contains the Network resource with related links. The caller must have the update permission on the specified Network. The caller must have the update permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\",\n  \"ownerIdentityId\" : \"0ae9effc-22d8-45b6-b328-724f944c0c0e\",\n  \"createdBy\" : \"0ae9effc-22d8-45b6-b328-724f944c0c0e\",\n  \"createdAt\" : \"2025-12-05T15:19:14.824653Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:14.826967Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"network-617\",\n  \"networkGroupId\" : \"1b29c5ab-1a40-4405-9a1e-c3fe27b7e7ed\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONED\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : true,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\",\n      \"title\" : \"network-617\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/1b29c5ab-1a40-4405-9a1e-c3fe27b7e7ed\",\n      \"profile\" : \"parent\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    },\n    \"clusters\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/clusters?networkId=238829e4-c6d0-4ff7-abf8-a3a82c0d5a6a\"\n    }\n  }\n}"

Exchange Core API auth for a Ziti token

Exchange the caller's authenticated Core API context for a Ziti token usable against the Network's Ziti Edge Management API. If no body is provided or the type is omitted, a SESSION token is returned by default. The caller must have the update permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

Request Body schema: application/json

Specify the token type to return. Defaults to SESSION when omitted.

type	string Enum: "AUTO" "SESSION" "BEARER" The type of token to return. Auto will return a Bearer token for HA enabled networks and Session for non-HA networks.

Responses

Request samples

Payload

Content type

application/json

Example

auto-default

Auto detect what token (body omitted) should be returned

"{\"type\":\"AUTO\"}"

Response samples

200
400
401
403
500

Content type

application/hal+json

Example CloudZitiToken response

"{\n  \"type\" : \"BEARER\",\n  \"value\" : \"mock-ziti-session-token-7f759d36-9f81-493f-aab7-d443ff86b8fa\",\n  \"expiresAt\" : \"2025-12-05T15:29:14.504+00:00\",\n  \"networkControllerUrl\" : \"https://d1d576e9-bde8-4089-af3d-9cd776d743a1-p.nf.io:443/edge/management/v1\",\n  \"networkControllerHost\" : \"d1d576e9-bde8-4089-af3d-9cd776d743a1-p.nf.io\",\n  \"networkControllerPort\" : 443,\n  \"zitiVersion\" : \"0.25.3\",\n  \"networkId\" : \"12a97d72-c9b7-49c8-a49a-6b9adc5bb44e\",\n  \"tunnelerAccess\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/12a97d72-c9b7-49c8-a49a-6b9adc5bb44e/exchange\"\n    },\n    \"parent\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/12a97d72-c9b7-49c8-a49a-6b9adc5bb44e\"\n    }\n  }\n}"

Restore a backup from a file in S3

Restore a backup from a file in S3. If you specify 'latest' for the filename, this endpoint restores the latest backup. Note for HA networks, all controllers in the network will be updated to the specified backup version. The caller must have the update-restore permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

header Parameters

nf-validate

string

Request Body schema: application/json
required

Payload specifying the backup file to restore. If omitted or fileName is null/empty, the latest backup will be restored.

fileName

string

Object name (filename) of the backup in S3. Null or empty means restore the latest.

Responses

Request samples

Payload

Content type

application/json

Example

file-by-name

Restore a specific backup file

{"fileName": "backup-2025-10-01T12-00-00Z.tar.gz"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"1c9f20d0-5f14-4880-aa17-0794651a8243\",\n  \"ownerIdentityId\" : \"e1e06406-f9cc-4756-a532-25284b5c575e\",\n  \"createdBy\" : \"e1e06406-f9cc-4756-a532-25284b5c575e\",\n  \"createdAt\" : \"2025-12-05T15:19:41.871093Z\",\n  \"updatedAt\" : \"2025-12-05T15:19:42.065909Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"network-764\",\n  \"networkGroupId\" : \"b45b8e8f-f2a8-4f50-93b6-44d159ecf878\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"UPDATING\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : true,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/1c9f20d0-5f14-4880-aa17-0794651a8243\",\n      \"title\" : \"network-764\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/b45b8e8f-f2a8-4f50-93b6-44d159ecf878\",\n      \"profile\" : \"parent\"\n    },\n    \"networks\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks\",\n      \"profile\" : \"parent\"\n    },\n    \"network-jwt-sets\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-jwt-sets/1c9f20d0-5f14-4880-aa17-0794651a8243\"\n    },\n    \"edge-routers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/edge-routers?networkId=1c9f20d0-5f14-4880-aa17-0794651a8243\"\n    },\n    \"hosts\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts?networkId=1c9f20d0-5f14-4880-aa17-0794651a8243\"\n    },\n    \"network-controllers\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers?networkId=1c9f20d0-5f14-4880-aa17-0794651a8243\"\n    },\n    \"executions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/executions?networkId=1c9f20d0-5f14-4880-aa17-0794651a8243\"\n    },\n    \"clusters\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/clusters?networkId=1c9f20d0-5f14-4880-aa17-0794651a8243\"\n    }\n  }\n}"

List existing backups for the network

List all existing backups for the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Example list of backups

"{\n  \"_embedded\" : {\n    \"backupList\" : [ {\n      \"name\" : \"217dc953-0c07-46c7-b82b-90d20033465c/5323924c-975b-4886-ad00-e0097fceddaa/file.1.gpg\",\n      \"lastModified\" : \"2025-12-05T15:19:17.443600Z\",\n      \"size\" : 123\n    } ]\n  },\n  \"_links\" : {\n    \"parent\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/217dc953-0c07-46c7-b82b-90d20033465c\"\n    }\n  }\n}"

Create a backup for all controllers in the network

Create a backup for all controllers in the specified Network. The operation is asynchronous and returns the Network resource with related links. The caller must have the update-backup permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

header Parameters

nf-validate

string

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network response

"{\n  \"id\" : \"f40d685c-88ee-4540-802c-f22c04658ead\",\n  \"ownerIdentityId\" : \"a956eb82-b8cc-4389-9e95-61d58bc61abe\",\n  \"createdBy\" : \"a956eb82-b8cc-4389-9e95-61d58bc61abe\",\n  \"createdAt\" : \"2025-12-05T15:18:54.275017Z\",\n  \"updatedAt\" : \"2025-12-05T15:18:54.291470Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"name\" : \"network-482\",\n  \"networkGroupId\" : \"47093983-fbe9-49ee-81bd-3f87e7623ee8\",\n  \"size\" : \"small\",\n  \"productVersion\" : \"8.0.43\",\n  \"region\" : \"us-east-1\",\n  \"status\" : \"PROVISIONED\",\n  \"publicCertEnabled\" : true,\n  \"haEnabled\" : true,\n  \"dnsZoneId\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/f40d685c-88ee-4540-802c-f22c04658ead\",\n      \"title\" : \"network-482\"\n    },\n    \"network-group\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-groups/47093983-fbe9-49ee-81bd-3f87e7623ee8\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Ping the Network Ziti Controller

Retrieves the ziti version as a way to check if the controller is online. The caller must have the read permission on the specified Network.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 6b9f3a0e-7f68-4f8a-8f9e-2f3a1c9f2a11

The unique identifier of the Network.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Example Ziti Version response

"{\n  \"networkId\" : \"08db8d6a-5485-4b7b-91cf-94898e70fd70\",\n  \"buildDate\" : \"2025-12-05T15:19:17.972853Z\",\n  \"runtimeVersion\" : \"v0.25.3\",\n  \"revision\" : \"v0.25.3\",\n  \"version\" : \"v0.25.3\",\n  \"semanticVersion\" : \"0.25.3\",\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/08db8d6a-5485-4b7b-91cf-94898e70fd70/ping\"\n    },\n    \"parent\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/08db8d6a-5485-4b7b-91cf-94898e70fd70\"\n    }\n  }\n}"

Containers

Retrieves Containers

Get Container

Returns a single Container by its unique identifier. The caller must have read permissions on the Container resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Container.

query Parameters

meta	Array of strings Items Value: "describeCloudContainer" Query and return (external) resources. Allowed meta values: describeCloudContainer: Return detailed cloud container data

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get container response

"{\n  \"id\" : \"42321e36-4976-4a37-95dd-20399a092755\",\n  \"networkId\" : \"02239445-9a27-4680-984d-caf78df69950\",\n  \"provider\" : \"AWS\",\n  \"region\" : \"us-east-1\",\n  \"clusterId\" : \"cluster-1958\",\n  \"serviceId\" : \"service-1959\",\n  \"certificateId\" : \"service-1959\",\n  \"size\" : \"small\",\n  \"ipAddress1\" : \"1.2.3.4\",\n  \"ipAddress2\" : \"2.3.4.5\",\n  \"revision\" : \"556\",\n  \"image\" : \"ghcr.fake/container:0.2.1\",\n  \"imageDigest\" : \"QmQjNzewPfrhgtH0HBAzq\",\n  \"port\" : 8080,\n  \"createdBy\" : \"b9323d92-6a7b-4062-b136-3b88dfab202b\",\n  \"createdAt\" : \"2025-12-05T15:21:27.087054Z\",\n  \"updatedAt\" : \"2025-12-05T15:21:27.087054Z\",\n  \"deletedBy\" : null,\n  \"deletedAt\" : null,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/containers/42321e36-4976-4a37-95dd-20399a092755\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/02239445-9a27-4680-984d-caf78df69950\",\n      \"profile\" : \"parent\"\n    },\n    \"provider\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/cloud-providers/AWS\"\n    },\n    \"region\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/regions/AWS/us-east-1\"\n    }\n  }\n}"

Find Containers

Returns Containers matching the optional query parameters. Results are filtered to only include resources the caller may read.

Authorizations:

bearerAuth

query Parameters

networkId	any Example: networkId=11111111-2222-3333-4444-555555555555 Filter by Network ID(s). Repeat to specify multiple.
provider	any Example: provider=AWS Filter by cloud provider(s). Repeat to specify multiple.
clusterId	any Example: clusterId=cluster-123456 Filter by provider cluster identifier(s).
serviceId	any Example: serviceId=service-abcdef Filter by provider service/workload identifier(s).
certificateId	any Example: certificateId=cert-xyz Filter by certificate identifier(s) installed on the load balancer.
ipAddress	any Example: ipAddress=203.0.113.10 Filter by IP address(es).
image	any Example: image=netfoundry/edge-router:% Filter by container image reference(s).
port	any Example: port=8443 Filter by exposed container port(s).
revision	any Example: revision=3 Filter by task/workload definition revision(s).
containerSize	any Example: containerSize=small Filter by abstract Container size(s).
region	any Example: region=us-east-1 Filter by cloud region code(s).
availabilityZone	any Example: availabilityZone=us-east-1a Filter by availability zone(s).
createdBy	any Example: createdBy=bbbbbbbb-1111-2222-3333-cccccccccccc Filter by creator identity ID(s).
deletedBy	any Example: deletedBy=dddddddd-eeee-ffff-1111-222222222222 Filter by deleter identity ID(s).
createdAt	any Example: createdAt=>=2025-01-01T00:00:00Z Created-at filter expressions. Supports >, >=, <, <=, =, != (e.g., createdAt=>=2025-01-01T00:00:00Z).
updatedAt	any Example: updatedAt=<=2025-12-31T23:59:59Z Updated-at filter expressions.
deletedAt	any Example: deletedAt=>2025-10-01T00:00:00Z Deleted-at filter expressions.
page	any Page index (0-based).
size	any Example: size=20 Page size.
sort	any Example: sort=provider,asc Sort expressions, e.g., provider,updatedAt,desc.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

No sample

Network Controllers

Manage Network Controller resources

Suspend Network Controller

Suspend the specified Network Controller. This will stop the controller from running without deleting it. The operation is asynchronous and returns the updated Network Controller resource with related links. The caller must have the update-suspend permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller to suspend

header Parameters

nf-validate

string

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller response

"{\n  \"id\" : \"34357c00-b3d5-4055-85b0-23cc63bc765f\",\n  \"ownerIdentityId\" : \"bbd3174d-5c9c-41e2-b0bd-ca520896d3d1\",\n  \"networkId\" : \"dd64a3e3-1342-4006-9d67-93c06a8c462b\",\n  \"domainName\" : \"34357c00-b3d5-4055-85b0-23cc63bc765f.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-v3-controller-test-nc\",\n  \"productVersion\" : \"8.0.43\",\n  \"hostId\" : \"6f9a22fa-03c0-41cf-98c2-8c9ddb37f7ce\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-12-05T15:18:36.128508Z\",\n  \"updatedAt\" : \"2025-12-05T15:18:38.469882Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"bbd3174d-5c9c-41e2-b0bd-ca520896d3d1\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"65f080c8-4c5c-4663-9086-76de7149ea47\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers/34357c00-b3d5-4055-85b0-23cc63bc765f\",\n      \"title\" : \"networkcontroller-v3-controller-test-nc\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/65f080c8-4c5c-4663-9086-76de7149ea47\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/6f9a22fa-03c0-41cf-98c2-8c9ddb37f7ce\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/dd64a3e3-1342-4006-9d67-93c06a8c462b\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Suspend Network Controller

Suspend the specified Network Controller. This will stop the controller from running without deleting it. The operation is asynchronous and returns the updated Network Controller resource with related links. The caller must have the update-suspend permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller to suspend

header Parameters

nf-validate

string

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller response

"{\n  \"id\" : \"34357c00-b3d5-4055-85b0-23cc63bc765f\",\n  \"ownerIdentityId\" : \"bbd3174d-5c9c-41e2-b0bd-ca520896d3d1\",\n  \"networkId\" : \"dd64a3e3-1342-4006-9d67-93c06a8c462b\",\n  \"domainName\" : \"34357c00-b3d5-4055-85b0-23cc63bc765f.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-v3-controller-test-nc\",\n  \"productVersion\" : \"8.0.43\",\n  \"hostId\" : \"6f9a22fa-03c0-41cf-98c2-8c9ddb37f7ce\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-12-05T15:18:36.128508Z\",\n  \"updatedAt\" : \"2025-12-05T15:18:38.469882Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"bbd3174d-5c9c-41e2-b0bd-ca520896d3d1\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"65f080c8-4c5c-4663-9086-76de7149ea47\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers/34357c00-b3d5-4055-85b0-23cc63bc765f\",\n      \"title\" : \"networkcontroller-v3-controller-test-nc\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/65f080c8-4c5c-4663-9086-76de7149ea47\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/6f9a22fa-03c0-41cf-98c2-8c9ddb37f7ce\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/dd64a3e3-1342-4006-9d67-93c06a8c462b\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Resume Network Controller

Resume the specified Network Controller. This restarts the controller service if it is suspended. The operation is asynchronous and returns the updated Network Controller resource with related links. The caller must have the update-resume permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller to resume

header Parameters

nf-validate

string

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller response

"{\n  \"id\" : \"34357c00-b3d5-4055-85b0-23cc63bc765f\",\n  \"ownerIdentityId\" : \"bbd3174d-5c9c-41e2-b0bd-ca520896d3d1\",\n  \"networkId\" : \"dd64a3e3-1342-4006-9d67-93c06a8c462b\",\n  \"domainName\" : \"new-domain.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-v3-controller-test-nc\",\n  \"productVersion\" : \"8.0.43\",\n  \"hostId\" : \"ed7a96b0-f9fa-44b5-bd17-ec5b530408e7\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-12-05T15:18:36.128508Z\",\n  \"updatedAt\" : \"2025-12-05T15:18:44.516251Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"bbd3174d-5c9c-41e2-b0bd-ca520896d3d1\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"d81a2d55-3636-4728-aec8-a064519dd024\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers/34357c00-b3d5-4055-85b0-23cc63bc765f\",\n      \"title\" : \"networkcontroller-v3-controller-test-nc\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/d81a2d55-3636-4728-aec8-a064519dd024\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/ed7a96b0-f9fa-44b5-bd17-ec5b530408e7\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/dd64a3e3-1342-4006-9d67-93c06a8c462b\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Resume Network Controller

Resume the specified Network Controller. This restarts the controller service if it is suspended. The operation is asynchronous and returns the updated Network Controller resource with related links. The caller must have the update-resume permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller to resume

header Parameters

nf-validate

string

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller response

"{\n  \"id\" : \"34357c00-b3d5-4055-85b0-23cc63bc765f\",\n  \"ownerIdentityId\" : \"bbd3174d-5c9c-41e2-b0bd-ca520896d3d1\",\n  \"networkId\" : \"dd64a3e3-1342-4006-9d67-93c06a8c462b\",\n  \"domainName\" : \"new-domain.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-v3-controller-test-nc\",\n  \"productVersion\" : \"8.0.43\",\n  \"hostId\" : \"ed7a96b0-f9fa-44b5-bd17-ec5b530408e7\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-12-05T15:18:36.128508Z\",\n  \"updatedAt\" : \"2025-12-05T15:18:44.516251Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"bbd3174d-5c9c-41e2-b0bd-ca520896d3d1\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"d81a2d55-3636-4728-aec8-a064519dd024\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers/34357c00-b3d5-4055-85b0-23cc63bc765f\",\n      \"title\" : \"networkcontroller-v3-controller-test-nc\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/d81a2d55-3636-4728-aec8-a064519dd024\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/ed7a96b0-f9fa-44b5-bd17-ec5b530408e7\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/dd64a3e3-1342-4006-9d67-93c06a8c462b\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Restart Network Controller process

Restart the Network Controller application process on its host. This schedules a restart operation and returns the controller resource. The operation is asynchronous; check the returned resource for execution links or poll the controller to see updated status. The caller must have the update-heal permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller to restart

header Parameters

nf-validate

string

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Restart process accepted response

"{\n  \"id\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"1acd4a72-a185-4242-ab06-c7b106214117.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-controller-test-nc\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"c8f00e8e-2109-4c3c-a5b4-b7e62f1d69e3\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-11-17T16:28:15.654202Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:16.834932Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"2b152768-fe70-4861-89e1-c7e5ca4353e4\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/c8f00e8e-2109-4c3c-a5b4-b7e62f1d69e3\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/2b152768-fe70-4861-89e1-c7e5ca4353e4\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\",\n      \"title\" : \"networkcontroller-controller-test-nc\"\n    }\n  }\n}"

Restart Network Controller process

Restart the Network Controller application process on its host. This schedules a restart operation and returns the controller resource. The operation is asynchronous; check the returned resource for execution links or poll the controller to see updated status. The caller must have the update-heal permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller to restart

header Parameters

nf-validate

string

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Restart process accepted response

"{\n  \"id\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"1acd4a72-a185-4242-ab06-c7b106214117.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-controller-test-nc\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"c8f00e8e-2109-4c3c-a5b4-b7e62f1d69e3\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-11-17T16:28:15.654202Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:16.834932Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"2b152768-fe70-4861-89e1-c7e5ca4353e4\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/c8f00e8e-2109-4c3c-a5b4-b7e62f1d69e3\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/2b152768-fe70-4861-89e1-c7e5ca4353e4\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\",\n      \"title\" : \"networkcontroller-controller-test-nc\"\n    }\n  }\n}"

Move Network Controller host

Move the Network Controller host to a different cloud provider/region or within the same provider/region. When moving within the same provider and region, you may either request a new IP to be assigned or specify a previously allocated IP address. The caller must have the update-move permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller to move

header Parameters

nf-validate

string

Request Body schema: application/json
required

Move request describing target provider/region and optional IP assignment.

provider required	string Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Target cloud provider for the host.
region required	string Target region within the selected provider.
assignNewIp	boolean If true, force assignment of a new IP address when moving within the same provider and region. Ignored when moving across providers/regions.
ipAddress	string A previously allocated IPv4 address to assign to the host. Provide either this value or set assignNewIp to true, but not both.
skipBackup	boolean If true, skip taking a new backup before moving. The latest existing backup will be used.

Responses

Request samples

Payload

Content type

application/json

Example

move-within-provider-assign-new-ip

Move within the same provider/region and assign a new IP

{"provider": "AWS",
"region": "us-east-1",
"assignNewIp": true
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller response with links

"{\n  \"id\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"1acd4a72-a185-4242-ab06-c7b106214117.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-controller-test-nc\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"c8f00e8e-2109-4c3c-a5b4-b7e62f1d69e3\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-11-17T16:28:15.654202Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:20.521306Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"37b620fc-b7b9-4ea2-884e-f610c1d672bd\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/c8f00e8e-2109-4c3c-a5b4-b7e62f1d69e3\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/37b620fc-b7b9-4ea2-884e-f610c1d672bd\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\",\n      \"title\" : \"networkcontroller-controller-test-nc\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/37b620fc-b7b9-4ea2-884e-f610c1d672bd\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Move Network Controller host

Move the Network Controller host to a different cloud provider/region or within the same provider/region. When moving within the same provider and region, you may either request a new IP to be assigned or specify a previously allocated IP address. The caller must have the update-move permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller to move

header Parameters

nf-validate

string

Request Body schema: application/json
required

Move request describing target provider/region and optional IP assignment.

provider required	string Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Target cloud provider for the host.
region required	string Target region within the selected provider.
assignNewIp	boolean If true, force assignment of a new IP address when moving within the same provider and region. Ignored when moving across providers/regions.
ipAddress	string A previously allocated IPv4 address to assign to the host. Provide either this value or set assignNewIp to true, but not both.
skipBackup	boolean If true, skip taking a new backup before moving. The latest existing backup will be used.

Responses

Request samples

Payload

Content type

application/json

Example

move-within-provider-assign-new-ip

Move within the same provider/region and assign a new IP

{"provider": "AWS",
"region": "us-east-1",
"assignNewIp": true
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller response with links

"{\n  \"id\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"1acd4a72-a185-4242-ab06-c7b106214117.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-controller-test-nc\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"c8f00e8e-2109-4c3c-a5b4-b7e62f1d69e3\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-11-17T16:28:15.654202Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:20.521306Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"37b620fc-b7b9-4ea2-884e-f610c1d672bd\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/c8f00e8e-2109-4c3c-a5b4-b7e62f1d69e3\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/37b620fc-b7b9-4ea2-884e-f610c1d672bd\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\",\n      \"title\" : \"networkcontroller-controller-test-nc\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/37b620fc-b7b9-4ea2-884e-f610c1d672bd\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Restart Network Controller host

Restart the underlying host (VM) for the specified Network Controller. This schedules a host restart operation and returns the controller resource. The operation is asynchronous; check the returned resource for execution links or poll the controller to see updated status. The caller must have the update-heal permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller whose host will be restarted

header Parameters

nf-validate

string

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Restart host accepted response

"{\n  \"id\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"new-domain.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"updatedControllerName-2177\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-11-17T16:28:15.654202Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:20.934223Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"6b36c604-3cf1-4f34-964f-3f11633ba637\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6b36c604-3cf1-4f34-964f-3f11633ba637\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\",\n      \"title\" : \"updatedControllerName-2177\"\n    }\n  }\n}"

Restart Network Controller host

Restart the underlying host (VM) for the specified Network Controller. This schedules a host restart operation and returns the controller resource. The operation is asynchronous; check the returned resource for execution links or poll the controller to see updated status. The caller must have the update-heal permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller whose host will be restarted

header Parameters

nf-validate

string

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Restart host accepted response

"{\n  \"id\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"new-domain.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"updatedControllerName-2177\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-11-17T16:28:15.654202Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:20.934223Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"6b36c604-3cf1-4f34-964f-3f11633ba637\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6b36c604-3cf1-4f34-964f-3f11633ba637\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\",\n      \"title\" : \"updatedControllerName-2177\"\n    }\n  }\n}"

Resize Network Controller host

Resize the underlying host instance for the specified Network Controller. Provide the desired deployment size identifier in the request body. The caller must have the update-heal permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller to resize

header Parameters

nf-validate

string

Request Body schema: application/json
required

Resize host request payload

size

required

string

Desired deployment size identifier for the host.

Responses

Request samples

Payload

Content type

application/json

Example

small

Resize the host to a small deployment size

{"size": "small"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller response

"{\n  \"id\" : \"5c729904-3077-4ee5-bff9-209e15231112\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"new-domain.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-controller-test-nc\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"f53bc7b8-81b8-4077-b559-9acc25ce7348\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-11-17T16:28:20.813642Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:23.444550Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"151624c3-80e8-44ba-a13a-9bf4d4add652\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/f53bc7b8-81b8-4077-b559-9acc25ce7348\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/151624c3-80e8-44ba-a13a-9bf4d4add652\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/5c729904-3077-4ee5-bff9-209e15231112\",\n      \"title\" : \"networkcontroller-controller-test-nc\"\n    }\n  }\n}"

Resize Network Controller host

Resize the underlying host instance for the specified Network Controller. Provide the desired deployment size identifier in the request body. The caller must have the update-heal permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller to resize

header Parameters

nf-validate

string

Request Body schema: application/json
required

Resize host request payload

size

required

string

Desired deployment size identifier for the host.

Responses

Request samples

Payload

Content type

application/json

Example

small

Resize the host to a small deployment size

{"size": "small"
}

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller response

"{\n  \"id\" : \"5c729904-3077-4ee5-bff9-209e15231112\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"new-domain.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-controller-test-nc\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"f53bc7b8-81b8-4077-b559-9acc25ce7348\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-11-17T16:28:20.813642Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:23.444550Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"151624c3-80e8-44ba-a13a-9bf4d4add652\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/f53bc7b8-81b8-4077-b559-9acc25ce7348\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/151624c3-80e8-44ba-a13a-9bf4d4add652\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/5c729904-3077-4ee5-bff9-209e15231112\",\n      \"title\" : \"networkcontroller-controller-test-nc\"\n    }\n  }\n}"

Replay the creation of a Network Controller

Replay the creation of a Network Controller. This is useful if the original creation process failed. If the original payload is no longer cached, the request will fail.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"275e5594-a52c-4ee8-a8a9-7ab7d511158a\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"275e5594-a52c-4ee8-a8a9-7ab7d511158a.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"secondary-controller-1\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"9c6f133c-c96b-486e-908e-67229a7e9d77\",\n  \"status\" : \"PROVISIONING\",\n  \"createdAt\" : \"2025-11-17T16:28:21.466970Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:21.508796Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : null,\n  \"haPrimaryNode\" : false,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/9c6f133c-c96b-486e-908e-67229a7e9d77\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/275e5594-a52c-4ee8-a8a9-7ab7d511158a\",\n      \"title\" : \"secondary-controller-1\"\n    }\n  }\n}"

Replay the creation of a Network Controller

Replay the creation of a Network Controller. This is useful if the original creation process failed. If the original payload is no longer cached, the request will fail.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"275e5594-a52c-4ee8-a8a9-7ab7d511158a\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"275e5594-a52c-4ee8-a8a9-7ab7d511158a.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"secondary-controller-1\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"9c6f133c-c96b-486e-908e-67229a7e9d77\",\n  \"status\" : \"PROVISIONING\",\n  \"createdAt\" : \"2025-11-17T16:28:21.466970Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:21.508796Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : null,\n  \"haPrimaryNode\" : false,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/9c6f133c-c96b-486e-908e-67229a7e9d77\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/275e5594-a52c-4ee8-a8a9-7ab7d511158a\",\n      \"title\" : \"secondary-controller-1\"\n    }\n  }\n}"

Retrieve a Network Controller

Retrieve a single Network Controller by its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

query Parameters

embed

Array of strings

Items Enum: "all" "host" "software-deployment-state"

Embed related resources in the result. Allowed: all | host | software-deployment-state.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Retrieve a Network Controller by ID

"{\n  \"id\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"new-domain.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"updatedControllerName-2177\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\",\n  \"status\" : \"PROVISIONED\",\n  \"createdAt\" : \"2025-11-17T16:28:15.654202Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:21.692088Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"6306a463-1c49-4134-9257-6b80993cd50c\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6306a463-1c49-4134-9257-6b80993cd50c\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\",\n      \"title\" : \"updatedControllerName-2177\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6306a463-1c49-4134-9257-6b80993cd50c\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Update a Network Controller

Update a Network Controller. The caller must have the update permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

header Parameters

nf-validate

string

Request Body schema: application/json
required

Network Controller update payload

name	string New human-friendly name of the Network Controller. Must be unique within the Network.
haVotingMember	boolean Whether this controller participates as a voting member in an HA cluster. If omitted, no change will be made.

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"updatedControllerName-2177\"}"

Response samples

202
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"new-domain.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"updatedControllerName-2177\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\",\n  \"status\" : \"PROVISIONED\",\n  \"createdAt\" : \"2025-11-17T16:28:15.654202Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:21.692088Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"6306a463-1c49-4134-9257-6b80993cd50c\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6306a463-1c49-4134-9257-6b80993cd50c\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\",\n      \"title\" : \"updatedControllerName-2177\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6306a463-1c49-4134-9257-6b80993cd50c\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Delete a Network Controller

Delete a Network Controller by its ID. You cannot delete the primary network controller for a network. The caller must have the delete permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: bdf1b7c1-5a33-4b2c-9b3d-9c7d3f8a4e21

Id of the resource

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"29eb83d9-6ed2-4eb3-b1c7-c67f9f0538c3\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"29eb83d9-6ed2-4eb3-b1c7-c67f9f0538c3.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-controller2-test-nc\",\n  \"productVersion\" : \"7.3.37\",\n  \"hostId\" : \"7c06dd21-9a76-4d67-9f23-9e64ff4f131b\",\n  \"status\" : \"DELETING\",\n  \"createdAt\" : \"2025-11-17T16:28:23.220419Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:23.241288Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : null,\n  \"haPrimaryNode\" : false,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/7c06dd21-9a76-4d67-9f23-9e64ff4f131b\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/29eb83d9-6ed2-4eb3-b1c7-c67f9f0538c3\",\n      \"title\" : \"networkcontroller-controller2-test-nc\"\n    }\n  }\n}"

Update a Network Controller

Update a Network Controller. The caller must have the update permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource

header Parameters

nf-validate

string

Request Body schema: application/json
required

Network Controller update payload

name	string New human-friendly name of the Network Controller. Must be unique within the Network.
haVotingMember	boolean Whether this controller participates as a voting member in an HA cluster. If omitted, no change will be made.

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"updatedControllerName-2177\"}"

Response samples

202
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"new-domain.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"updatedControllerName-2177\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\",\n  \"status\" : \"PROVISIONED\",\n  \"createdAt\" : \"2025-11-17T16:28:15.654202Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:21.692088Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"6306a463-1c49-4134-9257-6b80993cd50c\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6306a463-1c49-4134-9257-6b80993cd50c\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\",\n      \"title\" : \"updatedControllerName-2177\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6306a463-1c49-4134-9257-6b80993cd50c\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

Restore a backup for the network controller

Restore a network controller from a backup file in S3. If you specify 'latest' for the filename, this endpoint restores the latest backup. The caller must have the update-restore permission on the specified Network Controller

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller

header Parameters

nf-validate

string

Request Body schema: application/json
required

fileName

string

Object name (filename) of the backup in S3. Null or empty means restore the latest.

Responses

Request samples

Payload

Content type

application/json

No sample

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller response

"{\n  \"id\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"ownerIdentityId\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : \"new-domain.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"updatedControllerName-2177\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : \"0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\",\n  \"status\" : \"PROVISIONED\",\n  \"createdAt\" : \"2025-11-17T16:28:15.654202Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:21.692088Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"fd4855dd-6ead-4095-88bd-13a2e881751e\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"6306a463-1c49-4134-9257-6b80993cd50c\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/hosts/0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6306a463-1c49-4134-9257-6b80993cd50c\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\",\n      \"title\" : \"updatedControllerName-2177\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/software-deployment-states/6306a463-1c49-4134-9257-6b80993cd50c\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    }\n  }\n}"

List existing backups for the network controller

List all existing backups for the specified network controller. The caller must have the update-backup permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Examples:

2f1b4a2e-9a2b-4c53-9e6c-9f1e8b6a7c21 - example-id

Id of the Network Controller

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Example list of backups

[{"name": "backup-2025-10-01T12-00-00Z.tar.gz",
"lastModified": "2025-10-01T12:00:10Z",
"size": 10485760
},
{"name": "backup-2025-10-02T12-00-00Z.tar.gz",
"lastModified": "2025-10-02T12:00:05Z",
"size": 15728640
}
]

Create a backup for the network controller

Create a backup for the network controller and store the backup file in S3. The caller must have the update-backup permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the Network Controller

header Parameters

nf-validate

string

Responses

Response samples

202
400
401
403
500

Content type

application/hal+json

Example Network Controller response with links

"{\n  \"id\" : \"34357c00-b3d5-4055-85b0-23cc63bc765f\",\n  \"ownerIdentityId\" : \"bbd3174d-5c9c-41e2-b0bd-ca520896d3d1\",\n  \"networkId\" : \"dd64a3e3-1342-4006-9d67-93c06a8c462b\",\n  \"domainName\" : \"34357c00-b3d5-4055-85b0-23cc63bc765f.nf.io\",\n  \"alternateDomainName\" : null,\n  \"port\" : 443,\n  \"name\" : \"networkcontroller-v3-controller-test-nc\",\n  \"productVersion\" : \"8.0.43\",\n  \"hostId\" : \"6f9a22fa-03c0-41cf-98c2-8c9ddb37f7ce\",\n  \"status\" : \"UPDATING\",\n  \"createdAt\" : \"2025-12-05T15:18:36.128508Z\",\n  \"updatedAt\" : \"2025-12-05T15:18:39.176349Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"bbd3174d-5c9c-41e2-b0bd-ca520896d3d1\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : \"fc1d78d3-117b-4cb9-bb99-a33ba5518cda\",\n  \"haPrimaryNode\" : true,\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers/34357c00-b3d5-4055-85b0-23cc63bc765f\",\n      \"title\" : \"networkcontroller-v3-controller-test-nc\"\n    },\n    \"software-deployment-state\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/fc1d78d3-117b-4cb9-bb99-a33ba5518cda\"\n    },\n    \"host\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/hosts/6f9a22fa-03c0-41cf-98c2-8c9ddb37f7ce\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/networks/dd64a3e3-1342-4006-9d67-93c06a8c462b\",\n      \"profile\" : \"parent\"\n    },\n    \"softwareDeploymentState\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/software-deployment-states/fc1d78d3-117b-4cb9-bb99-a33ba5518cda\",\n      \"deprecation\" : \"Use software-deployment-state link instead\"\n    },\n    \"parent\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-controllers/34357c00-b3d5-4055-85b0-23cc63bc765f\"\n    }\n  }\n}"

Find Network Controllers

Find all Network Controllers that match the specified criteria. Instances that the API client does not have authorization to read will be removed from the results. As a side effect, this endpoint never returns a 403 or 404 error. Instead, it returns an empty list.

Authorizations:

bearerAuth

query Parameters

id	string <uuid> Filter by Network Controller ID.
name	string Filter by name.
networkId	string <uuid> Filter by Network ID.
productVersion	string Filter by product version.
hostId	string <uuid> Filter by Host ID.
status	string Enum: "NEW" "PROVISIONING" "PROVISIONED" "ERROR" "UPDATING" "SUSPENDED" "REPLACING" "DELETING" "DELETED" "OFFLINE" Example: status=PROVISIONED Filter by controller status.
domainName	string Filter by domain name.
alternateDomainName	string Filter by alternate domain name.
port	integer Filter by port.
ownerIdentityId	string <uuid> Filter by owner identity ID.
createdBy	string <uuid> Filter by creator identity ID.
deletedBy	string <uuid> Filter by deleter identity ID.
publicCertEnabled	boolean Filter by whether public certificates are enabled.
createdAt	string Filter by creation timestamp using InstantFilter syntax, e.g., >2025-01-01T00:00:00Z.
updatedAt	string Filter by update timestamp using InstantFilter syntax.
deletedAt	string Filter by deletion timestamp using InstantFilter syntax.
page	integer >= 0 Default: 0 Zero-based page index.
size	integer >= 1 Default: 20 The number of resources returned per page.
sort	string Sorting criteria in the format: property,(asc\|desc).
isDeleted	boolean Deprecated

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

No sample

Create a Network Controller

Create a new Network Controller. The provider field determines if NetFoundry or the customer hosts the controller. The caller must have create permission on Network resources. If the provider is CUSTOMER, the caller must also have create-customer-hosted authorization.

Authorizations:

bearerAuth

header Parameters

nf-validate

string

Request Body schema: application/json
required

Network Controller creation payload

networkId required	string <uuid> ID of the Network in which to create the Network Controller.
name required	string Human-friendly name of the Network Controller. Must be unique within the Network.
hostSize	string Deployment size identifier for the controller host. If omitted, a provider-specific default will be used.
provider required	string Enum: "AWS" "AZURE" "GCP" "OCI" "CUSTOMER" Cloud provider that will host the controller. Use CUSTOMER for customer-hosted controllers.
region	string Cloud region for NetFoundry-hosted controllers. Ignored when provider is CUSTOMER.
alternateDomainName	string Optional alternate domain name (CNAME) to use for the controller.
	object (CustomerProviderDetails) Required when provider is CUSTOMER. Connection and access details for the customer-managed host.
haVotingMember	boolean Whether this controller participates as a voting member in an HA cluster. Defaults to true when omitted.

Responses

Request samples

Payload

Content type

application/json

default

"{\"networkId\":\"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\"name\":\"createNetworkController-2142\",\"hostSize\":\"small\",\"provider\":\"AWS\",\"region\":\"us-east-1\",\"haVotingMember\":false}"

Response samples

202
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"cd3f367e-4baa-4610-9d80-9852d84eca7b\",\n  \"ownerIdentityId\" : \"8612b1d6-dea0-471b-a1ed-b0ecf63c09f1\",\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"domainName\" : null,\n  \"alternateDomainName\" : null,\n  \"port\" : 8443,\n  \"name\" : \"createNetworkController-2142\",\n  \"productVersion\" : \"7.4.5\",\n  \"hostId\" : null,\n  \"status\" : \"PROVISIONING\",\n  \"createdAt\" : \"2025-11-17T16:28:20.008782Z\",\n  \"updatedAt\" : \"2025-11-17T16:28:20.008782Z\",\n  \"deletedAt\" : null,\n  \"createdBy\" : \"8612b1d6-dea0-471b-a1ed-b0ecf63c09f1\",\n  \"deletedBy\" : null,\n  \"softwareDeploymentStateId\" : null,\n  \"haPrimaryNode\" : false,\n  \"_links\" : {\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n      \"profile\" : \"parent\"\n    },\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/cd3f367e-4baa-4610-9d80-9852d84eca7b\",\n      \"title\" : \"createNetworkController-2142\"\n    }\n  }\n}"

Compare a Network Controller's host with its definition

Compare a Network Controller's host with its definition. This is useful for debugging and support. The caller must have the read permission on the specified Network Controller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: bdf1b7c1-5a33-4b2c-9b3d-9c7d3f8a4e21

Id of the Network Controller

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/network-controllers/1acd4a72-a185-4242-ab06-c7b106214117\"\n    },\n    \"network\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v2/networks/80caaf72-e1bd-4dee-8db2-efda13114dd1\"\n    }\n  },\n  \"matches\" : true,\n  \"checks\" : [ {\n    \"type\" : \"EXIST\",\n    \"matches\" : true\n  }, {\n    \"type\" : \"STATE\",\n    \"matches\" : true,\n    \"expected\" : \"RUNNING\",\n    \"actual\" : \"RUNNING\"\n  }, {\n    \"type\" : \"IP\",\n    \"matches\" : true,\n    \"expected\" : \"4.3.2.1\",\n    \"actual\" : \"4.3.2.1\"\n  }, {\n    \"type\" : \"INSTANCE_TYPE\",\n    \"matches\" : true,\n    \"expected\" : [ \"t2.medium\", \"t3.medium\" ],\n    \"actual\" : \"t2.medium\"\n  } ],\n  \"networkId\" : \"80caaf72-e1bd-4dee-8db2-efda13114dd1\",\n  \"networkControllerId\" : \"1acd4a72-a185-4242-ab06-c7b106214117\",\n  \"hostId\" : \"0b8dd0f1-f48f-4397-85f9-f7eec2a9b63e\",\n  \"provider\" : \"AWS\",\n  \"providerInstanceId\" : \"i-testncinstance\"\n}"

Network Versions

Retrieves Network Versions

Get Network Version

Returns a single Network Version by its unique identifier. Results are public and not authorization-filtered.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Example: 8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b

The unique identifier of the Network Version.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

Sample get network version response

"{\n  \"id\" : \"d4a9d45a-703f-40f9-94cd-2dfc98169984\",\n  \"networkVersion\" : \"8.4.1\",\n  \"zitiVersion\" : \"1.4.1\",\n  \"minimumNetworkVersionForUpgrade\" : null,\n  \"minimumEdgeRouterVersionForUpgrade\" : null,\n  \"active\" : true,\n  \"default\" : false,\n  \"jsonNode\" : {\n    \"active\" : true,\n    \"version\" : {\n      \"type\" : \"STRICT\",\n      \"build\" : null,\n      \"major\" : 8,\n      \"minor\" : 4,\n      \"patch\" : 1,\n      \"value\" : \"8.4.1\",\n      \"stable\" : true,\n      \"suffixTokens\" : [ ],\n      \"originalValue\" : \"8.4.1\"\n    },\n    \"zitiVersion\" : {\n      \"type\" : \"STRICT\",\n      \"build\" : null,\n      \"major\" : 1,\n      \"minor\" : 4,\n      \"patch\" : 1,\n      \"value\" : \"1.4.1\",\n      \"stable\" : true,\n      \"suffixTokens\" : [ ],\n      \"originalValue\" : \"1.4.1\"\n    },\n    \"defaultVersion\" : false\n  },\n  \"createdAt\" : \"2025-11-17T16:36:45.508066Z\",\n  \"updatedAt\" : \"2025-11-17T16:36:45.508066Z\",\n  \"recommended\" : false,\n  \"platformFeatures\" : [ {\n    \"displayName\" : \"service.advanced-tunneler-to-endpoint\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"7.3.25\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"browzer\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"7.3.90\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"service.advanced-tunneler-to-endpoint.source-ip-transparency\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"7.3.32\",\n    \"deprecatedAt\" : null\n  } ],\n  \"zitiFeatures\" : [ {\n    \"displayName\" : \"enrollment.refresh\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.25.9\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"authenticator\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"identity.mfa\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.18.5\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"posture-check\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.16.5\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"authenticators.list.authenticators\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.22.10\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"enrollment.create.delete\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.25.9\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"edge-router-policy\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"config\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"posture-check.mfa\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.18.5\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"cas\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"auth-policy\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.25.4\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"edge-router.no-traversal\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.24.13\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"service\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"posture-check.process\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.16.5\",\n    \"deprecatedAt\" : \"0.20.0\"\n  }, {\n    \"displayName\" : \"transit-router\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"session\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"terminator\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"posture-check.multi-process\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.20.2\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"edge-router.is-tunneler-enabled\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.20.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"edge.router.enabled\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.27.6\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"authenticators.re.enroll\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.25.10\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"identity-type\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"edge-router.wss-listener\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.26.5\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"identity.external-id\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.25.4\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"posture-check.mfa.timeout-seconds\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.20.14\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"edge-router\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"config-type.intercept-v1\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.19.11\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"edge.routers.re.enroll\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.25.10\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"identity.disabled\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.25.4\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"service-policy\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"config-type\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"service-edge-router-policy\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"config-type.host-v1\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.19.11\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"identity.list.enrollments\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.25.11\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"policy-advice\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"identity\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.0.0\",\n    \"deprecatedAt\" : null\n  }, {\n    \"displayName\" : \"browzer\",\n    \"removedAt\" : null,\n    \"introducedAt\" : \"0.26.5\",\n    \"deprecatedAt\" : null\n  } ],\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-versions/d4a9d45a-703f-40f9-94cd-2dfc98169984\"\n    },\n    \"versions\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/core/v3/network-versions\",\n      \"profile\" : \"parent\"\n    }\n  }\n}"

Find Network Versions

Returns Network Versions matching the optional query parameters. Results are public and not authorization-filtered.

Authorizations:

bearerAuth

query Parameters

id	any Example: id=8f14e45f-ea3c-4c9f-9e9a-8a7d7f3a1c2b Filter by Network Version ID(s). Repeat to specify multiple.
name	any Example: name=8.5.% Filter by semantic version of the Network (alias of networkVersion). Supports % wildcard.
networkVersion	any Example: networkVersion=8.5.% Filter by semantic version of the Network. Supports % wildcard.
zitiVersion	any Example: zitiVersion=1.0.% Filter by semantic version of the bundled Ziti platform. Supports % wildcard.
minimumNetworkVersionRequiredForUpgrade	any Deprecated Example: minimumNetworkVersionRequiredForUpgrade=8.2.0 Filter by minimum Network version required for upgrade.
minimumEdgeRouterVersionRequiredForUpgrade	any Deprecated Example: minimumEdgeRouterVersionRequiredForUpgrade=1.1.0 Filter by minimum Edge Router version required for upgrade.
active	any Example: active=true Filter by active flag (available for new installs).
default	any Example: default=true Filter by default recommended version.
createdAt	any Example: createdAt=>=2025-01-01T00:00:00Z Created-at filter expression. Supports >, >=, <, <=, =, != (e.g., createdAt=>2025-01-01T00:00:00Z).
updatedAt	any Example: updatedAt=<=2025-12-31T23:59:59Z Updated-at filter expression.
page	any Page index (0-based).
size	any Example: size=20 Page size.
sort	any Example: sort=networkVersion,desc Sort expressions, e.g., networkVersion,updatedAt,desc.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

No sample

organizationId	string <uuid>
networkId required	string <uuid>
id required	string
type required	string Enum: "IDENTITY" "EDGEROUTER"
to required	Array of strings non-empty
cc	Array of strings
subject	string

NetFoundry Core Management (0.6.0)

Regions

Get Region

Authorizations:

path Parameters

Responses

Response samples

Find Regions

Authorizations:

query Parameters

Responses

Response samples

Host Sizes

Find Host Sizes

Authorizations:

query Parameters

Responses

Response samples

Network Assemblies

Export a Network Assembly

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Import a Network Assembly into an existing Network

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a Network from a Network Assembly

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Software Deployment States

Get Software Deployment State

Authorizations:

path Parameters

Responses

Response samples

Update Software Deployment State

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update Software Deployment State

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Refresh Software State

Authorizations:

path Parameters

Responses

Response samples

Refresh Software State in Network

Authorizations:

query Parameters

Responses

Response samples

Find Software Deployment States

Authorizations:

query Parameters

Responses

Response samples

Host Addresses

Find Cloud Addresses

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required