Introduction
Welcome! This is the API reference for the NetFoundry Network Management Service (v2), a lexicon of all possible API operations and their parameters. More conceptually and procedurally oriented guides and code samples may be found by visiting the Developer Portal.
Overview
HTTP verbs
NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP verbs.
Verb | Usage |
---|---|
|
Used to retrieve a resource |
|
Used to create a new resource |
|
Used to update an existing resource, full updates only |
|
Used to update an existing resource, partial updates |
|
Used to delete an existing resource |
HTTP status codes
NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP status codes.
Status code | Usage |
---|---|
|
The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action. |
|
The request has been fulfilled and resulted in a new resource being created. |
|
The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services. |
|
The server successfully processed the request, but is not returning any content. |
|
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
|
The request lacks valid authentication credentials for the target resource. |
|
The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource. |
|
The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible. |
Pagination
Paginated services will accept the following optional request parameters:
Path | Type | Optional | Description |
---|---|---|---|
page |
Integer |
true |
Page you want to retrieve, 0 indexed and defaults to 0. |
size |
Integer |
true |
Size of the page you want to retrieve, defaults to 1000. |
sort |
String |
true |
Sort a list of resources by one or more of their properties e.g. |
Pagination response has following structure:
Path | Type | Optional | Description |
---|---|---|---|
content |
Array[Object] |
false |
Actual items. |
totalElements |
Integer |
false |
Total count. |
totalPages |
Integer |
false |
Total pages with current page size. |
last |
Boolean |
false |
If this page is the last one. |
numberOfElements |
Integer |
false |
Actual size of content array (number of items). |
first |
Boolean |
false |
If this page is the first one. |
sort |
Object |
true |
Sort information object. |
size |
Integer |
false |
Requested size of the page. |
number |
Integer |
false |
Page number. |
empty |
booloean |
false |
If this page is empty. |
Content Types
You may request a content type or alternative representation or both for a resource or list of resources with the
Accept
header.
Request a Content Type
The default content type of a response is HAL+JSON when the Accept
header is absent from the request. A table
describing available types is below. Here’s an example of requesting a particular endpoint by ID as YAML.
GET /core/v2/endpoints/{{endpointId}} HTTP/1.1
Accept: application/x-yaml
id: "273a915a-50e4-4994-891e-56a33ce6449e"
ownerIdentityId: "6526771d-d0b4-4325-835a-b57caaa698dd"
createdBy: "6526771d-d0b4-4325-835a-b57caaa698dd"
createdAt:
nano: 448425000
epochSecond: 1616076528
updatedAt:
nano: 661920000
epochSecond: 1623109454
deletedBy: null
deletedAt: null
networkId: "5611d56c-cb91-4b8f-b658-9e066092ff0a"
zitiId: "uIWXyl94U"
name: "ACME Endpoint1"
typeId: "5b53fb49-51b1-4a87-a4e4-edda9716a970"
appId: null
appVersion: null
branch: "main"
revision: "80ece9482fdd"
type: "ziti-sdk-golang"
version: "v0.15.13"
arch: "amd64"
os: "darwin"
osRelease: "17.7.0"
osVersion: "Darwin Kernel Version 17.7.0: Thu Jun 21 22:53:14 PDT 2018; root:xnu-4570.71.2~1/RELEASE_X86_64"
hasApiSession: false
hasEdgeRouterConnection: false
sessionIdentityId: null
syncId: null
syncResourceId: null
attributes:
- "#workFromAnywhere"
sessionActive: true
jwt: null
mfaEnabled: false
jwtExpiresAt: null
Notation | MIME Type | Description |
---|---|---|
HAL+JSON (default) |
application/hal+json |
If you request a single resource by ID then the top level of the response will describe that resource and have
If you request a list of resources then response will have |
JSON |
application/json |
Single resource: response is a JSON dictionary describing the resource List of resources: response is a JSON list where each element describes an individual resource.
For embedded resources in non-HAL formats, the |
YAML |
application/x-yaml |
Single resource: response is a YAML dictionary describing the resource List of resources: response is a YAML list where each element describes an individual resource. |
CSV |
text/csv |
Comma-separated format where the first line is composed of column headers and subsequent lines each represent one resource. |
Request a Representation
A representation is a way of filtering and transforming the properties that are returned for each resource. The default
representation includes all resource properties. There is one alternative representation available at this time: the
create
representation includes only the properties that are necessary to create an identical resource. This is useful
for things like as-code snapshots and cloning resources. You may append the as=create
parameter to the default MIME
type to change only the representation of the resources in the response.
GET /core/v2/endpoints?networkId={{networkId}} HTTP/1.1
Accept:application/hal+json;as=create
{
"_embedded": {
"createEndpointList": [
{
"name": "ACME Endpoint1",
"enrollmentMethod": {
"ott": true,
"updb": null,
"ottca": null
},
"attributes": [
"#workFromAnywhere"
],
"_links": {
"network": {
"href": "https://gateway.production.netfoundry.io/core/v2/networks/5611d56c-cb91-4b8f-b658-9e066092ff0a",
"title": "ACME Network",
"profile": "parent"
},
"self": {
"href": "https://gateway.production.netfoundry.io/core/v2/endpoints/273a915a-50e4-4994-891e-56a33ce6449e"
}
}
}
]
}
}
Parameter | Value | Description |
---|---|---|
as |
create |
Only return the properties necessary to create the same resource. |
Embed Child Resources
When requesting an individual or list of resources you may additionally request child resources be embedded in the
response by sending query parameter embed=all
or embed={{child}}
. The valid names for child resources are the keys
in _links
, except things that are not children like self
, network
. The table below details how the format of the
embedded lists varies depending upon the requested content-type. Embedding is always one level deep. Put another way,
the network is like the trunk which may embed branch lists (e.g. edge routers), and branches may embed individual leaves
(e.g. the edge router’s host).
This example requests that the "edge-routers" child resource list be embedded in the response that describes a particular network.
GET /core/v2/networks/${networkId}?embed=edge-routers
Accept: application/hal+json
The full response would be prohibitively verbose, and so this template will demonstrate the response structure for a single resource with embedded child list "edge-routers".
{
{{ network properties }},
"_embedded": {
"edge-routers": {{ list of edge routers }}
},
"_links": {{ dictionary of related resources}}
}
This example requests the "host" resource be embedded in each element of the list of edge routers
GET /core/v2/edge-routers?networkId=${networkId}&embed=host
Accept: application/hal+json
The full response would be prohibitively verbose, and so this template will demonstrate the response structure for a list of resources with embedded child "host".
{
"_embedded": {
"edgeRouterList": [
{
{{ edge router 1 properties }},
"_links": {{ edge router 1 links }},
"_embedded": {
"host": {{ edge router 1 host's properties }}
}
},
{
{{ edge router 2 properties }},
"_links": {{ edge router 2 links }},
"_embedded": {
"host": {{ edge router 2 host's properties }}
}
}
]
},
"_links": {{ edge router list's links }},
"page": {
"size": 3500,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}
Notation | MIME Type | Embedded Format |
---|---|---|
HAL+JSON (default) |
application/hal+json |
The response has key |
JSON |
application/json |
Each requested, embedded list will appear in a top-level key e.g. |
YAML |
application/x-yaml |
Each requested, embedded list will appear in a top-level key where the resource type has been transposed from
kebab-case to camel-case e.g. |
CSV |
text/csv |
Heterogeneous embedded resources can not be expressed as CSV because they would require different column headers. |
Select Resource Properties
When requesting an individual or list of resources you may additionally request only certain properties be included in the response
by sending an alternate 'accept' header. The properties are specified as a header parameter named includeProperties
, the properties
requested should be separated by |
(pipe).
All requested properties are returned, null values included, as long as the property exists on the requested resource.
The includeProperties
parameter supports nested properties using "dot notation" with ant style patterns, examples are:
-
object.name
would include only the name property of theobject
. -
object.object2.name
would include only the name property ofobject2
nested insideobject
. -
object.*
includes all direct properties ofobject
. -
object.**
includes all properties ofobject
and any nested object inside ofobject
.
This example request would return only the property’s id
, zitiId
, and networkId
.
GET /core/v2/networks/${networkId} Accept: application/json;includeProperties=id|zitiId|networkId
{
"id", "{{ the id of the resource }}",
"zitiId", "{{ the ziti id of the resource }}",
"networkId", "{{ the id of network this resource belongs to }}",
}
This example request would return only the property’s id
and status
.
GET /core/v2/edge-routers Accept: application/hal+json;includeProperties=id|status
{
"_embedded": {
"edgeRouterList": [
{{ edge router 1 properties }}
{
"id", "{{ the id of the resource }}",
"status", "{{ current status of the edge routers }}",
"_links": "{{ dictionary of related resources for this resource }}"
},
{{ edge router 2 properties }}
{
"id", "{{ the id of the resource }}",
"status", "{{ current status of the edge routers }}",
"_links": "{{ dictionary of related resources for this resource }}"
}
]
},
"_links": "{{ dictionary of edge routers related resources }}",
"page": {
"size": 3500,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}
This example request would return the name
of the network and all nested properties of the networkController
but nothing else.
Some properties have been omitted from the example output for brevity.
GET /core/v2/networks/${networkId}?embed=networkController Accept: application/json;includeProperties=name|networkController.*
{
"name":" {{ the name of the network }}"
"networkController": {
"id": "{{ the id of the network controller }}",
"networkGroupId": "{{ the group id of which this network belongs to }}",
"status": "{{ current status of network controller }},"
"hostId": "{{ the host id of the network controller }}",
"domainName": {{ the externally resolvable dns name of this network controller" }}
...
}
}
This example request would return the name
of the network and the id
and status
of the networkController
but nothing else.
GET /core/v2/networks/${networkId}?embed=networkController Accept: application/json;includeProperties=id|name|networkController.id|networkController.status
{
"id": "{{ the id of the network }}",
"name": "{{ the name of the network }}",
"networkController": {
"id": "{{ the id of the network controller }}",
"status": "{{{ current status of network controller }}"
}
}
Backup a Network
You may combine techniques above for requesting embedded resources and the as=create
representation to backup a network.
GET /core/v2/network/{{networkId}}&embed=all
Accept: application/hal+json;as=create
Authentication
Authentication is delegated to an identity provider e.g. Cognito, Auth0, Okta. Use your API account credential to obtain an access token. Know more by reading the Authentication Guide.
Cognito
Follow this example if your authentication URL is for Amazon Cognito.
NETFOUNDRY_API_TOKEN=$( \ (1)
curl --user ${NETFOUNDRY_CLIENT_ID}:${NETFOUNDRY_PASSWORD} \ (2)
--request POST ${NETFOUNDRY_OAUTH_URL} \ (3)
--header 'content-type: application/x-www-form-urlencoded' \
--data 'grant_type=client_credentials&scope=https%3A%2F%2Fgateway.production.netfoundry.io%2F%2Fignore-scope' | \
jq -r .access_token (4)
)
1 | creates an environment variable to hold the token after successful request. The contents of this variable will be used in all subsequent requests |
2 | substitute the client ID and password for your API account |
3 | substitute the authentication URL for your API account |
4 | extract the access token with jq (command-line JSON processor) |
Auth0
Follow this example if your authentication URL is for Auth0.
NETFOUNDRY_API_TOKEN=$( \(1)
curl \(2)
--request POST \
--silent \
--show-error \
--header 'content-type: application/json' \
--data '{
"client_id":"---redacted----", (3)
"client_secret": "---redacted----", (4)
"audience":"https://gateway.production.netfoundry.io/",
"grant_type":"client_credentials"
}' \
https://netfoundry-production.auth0.com/oauth/token |\
jq -r .access_token \(5)
) && echo $NETFOUNDRY_API_TOKEN (6)
1 | creates an environment variable to hold the token after successful request. The contents of this variable will be used in all subsequent requests |
2 | this example uses the cURL command to perform the request |
3 | you will need to insert your actual client ID |
4 | you will need to insert your actual secret |
5 | this example uses jq to parse the response from Auth0 and extract the token |
6 | this line prints the extracted token; it is included for convenience / debugging purposes only |
API request using access token
Execute an http request per the example below (e.g. fetch networks). The access token is presented to the API via the
header, which in turn leverages the Authorization
variable used in the previous example to store the extracted access token.NETFOUNDRY_API_TOKEN
# get networks
curl https://gateway.production.netfoundry.io/core/v2/networks \ (1)
--header "Authorization: Bearer ${NETFOUNDRY_API_TOKEN}" (2)
1 | the URL used to fetch networks (see also [Listing networks]) |
2 | the header transmits the Bearer token |
Resources
Network Groups
Create Network Group
POST /network-groups
Authorization
This endpoint requires create
action on the network-group
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
billingAccountId |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
ownerIdentityId |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
name |
String |
false |
Size must be between 0 and 255 inclusive. |
shortName |
String |
false |
Size must be between 0 and 8 inclusive. |
billingAccountId |
String |
true |
|
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/network-groups' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJTOGVvb0o2ZTY4ZDVZUlFFSEhHb01nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA3Nzc5NTUzLTNhMzQtNGFiYi1iMDQ1LTU4YjBhOTEyNzVjZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzYwMywiZXhwIjoxNjc1MzUxMjAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBmMDkyN2FkLWQ3MDYtNDVlMi1iYmE1LTk4NmVkZTdiNGRkMVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzYwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.iuE0yhYFfYNaqFg-PVZ9niNkSbATYPdMPDOm9V3Y0skjvdTixYFIymiiYkos_zAwPDswEdmcMCSEtFzPdlIejC5rGnx8CCOGhdWTUh06QaLSMsB7Eu5vc4oJh0VJGSp6bYGx_0Lb56rLvaVKl1fJBZ4PwKJLYapCU2-ykszegLvibCLE7hFj8JqXHOx-4RYOoX7qk9trinSjAk4mMHia6TJIZNQqQYzwXGCv4NwhwxqWRMwVyKJWUTh3we1fHP-PROJfrzHBcqfURAYPx170wUCNjdtQnPzlbyjce77xINy7b7e516W1FJVGqIBxUViyXd390kBfBLy44DZkCe_j-g' \
-d '{"name":"New NG","billingAccountId":"86fef6a8-365e-4972-8eb2-c2c9411e910e","ownerIdentityId":"4c9d6fbf-da11-40d9-9c69-e54494dbc35d"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 782
{
"id" : "640f9cbf-1bb3-4b53-aaad-5818695f2dfe",
"name" : "New NG",
"shortName" : "NEWNG1",
"billingAccountId" : "86fef6a8-365e-4972-8eb2-c2c9411e910e",
"ownerIdentityId" : "4c9d6fbf-da11-40d9-9c69-e54494dbc35d",
"createdBy" : "07779553-3a34-4abb-b045-58b0a91275cf",
"createdAt" : "2023-02-02T14:20:03.859792Z",
"updatedAt" : "2023-02-02T14:20:03.859792Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/640f9cbf-1bb3-4b53-aaad-5818695f2dfe"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/f53189e0-4b7c-4af8-b739-4eb9a9b87389",
"title" : "Create NetworkGroup",
"profile" : "meta"
}
}
}
Delete Network Group
DELETE /network-groups/{id}
Authorization
This endpoint requires delete
action on the network-group
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
name |
String |
false |
Size must be between 0 and 255 inclusive. |
shortName |
String |
false |
Size must be between 0 and 8 inclusive. |
billingAccountId |
String |
true |
|
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/network-groups/cd229b5a-1abe-4969-ab68-f3389eb3c6ca' -i -X DELETE \
-H 'Content-Type: application/json' \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJkMHo2WXVpZG15dDVBc2NWajhSU0NnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjcwNTMxMDI5LWJjN2EtNDQ3OS04YTU0LTkyNjZhYzljY2MyYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzYwMywiZXhwIjoxNjc1MzUxMjAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImUzNjc3N2JmLTBkYmMtNDVhZS05YWE5LTBkYTYyMThkZmRhZlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzYwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.U3UAhhlj85cmMsHhW3V3tjTwhEcQL7N24hFY1CNePguYLpoffMKhT7gDTOJ0iwbKMkx9lAlRoh-IN3cgItF1MOZYKiLKr7bfoOwArQcyZJf4fUu88tdCWxviCdXJfW3n92b7mK-Lrlbp3NkdlTIWCpPuVb_q6Lok3mWstaA2MX1FAfNa-zJufPl0jpb38hMrBbEdmOevutMnFmjzs-12ZLPN0LreXnjmoHsCZThAkPcw2_YJUv1pMBBVDKXGdU26D0dkBxuapmgSk_0-krN0ejbFU67Uq-1i1LC3f7cN9Fugb6LDdhu87byyQVJB8mtLZpcdsGofnWoKUO0Dd_t3Rw'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 784
{
"id" : "cd229b5a-1abe-4969-ab68-f3389eb3c6ca",
"name" : "Test-NG",
"shortName" : "nw-6801",
"billingAccountId" : "6667a5b8-4d30-4e23-9c06-5e32ccb40913",
"ownerIdentityId" : "8f084bc3-c2af-4b0c-8dd3-d497afdb973c",
"createdBy" : "84b2b2a1-6847-4f5e-948a-7b5eea9065fe",
"createdAt" : "2023-02-02T14:20:03.268016Z",
"updatedAt" : "2023-02-02T14:20:03.268016Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/cd229b5a-1abe-4969-ab68-f3389eb3c6ca"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/45c74f04-8098-4037-8479-3bb7c9618131",
"title" : "Delete NetworkGroup",
"profile" : "meta"
}
}
}
Get Network Group
GET /network-groups/{id}
Authorization
This endpoint requires read
action on the network-group
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
name |
String |
false |
Size must be between 0 and 255 inclusive. |
shortName |
String |
false |
Size must be between 0 and 8 inclusive. |
billingAccountId |
String |
true |
|
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/network-groups/5547251f-a005-4a18-bc7c-f69e14aa8263' -i -X GET \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJzMklDbldxdDFsVkxGdC1EVldjRHZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZiMGYwNjY5LTc1YjktNGQ5ZC05YTQ1LTZhNzYyOGJjN2IyZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzYwMywiZXhwIjoxNjc1MzUxMjAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZlNWE3OTdkLTQxMjktNGY1Zi1hZGNlLTI4MGI4YmY5NzE2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzYwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.K7wfiXmHQ6MBG2TUTeEl5g6kI3QNdAq5DbT-6OR8fk2FCHPVQMCw05ya8K-6q85TshFKGJinpAHL_PFr_RQexyoQDzzzQUn1xRwf3KJ0mY72NtqMg_pcNMj6IAcgeM4oYjB-7MNVH4ftNq6iMt_KBH9BAhNvSu0cPr_ON2epjBvN5f2-sE3nSa2JD6S66pLtT7HiS_e8NaoAJNIMbfy9NLyyuefVpgeAsKQWfr7miYQc6jDNDizDmQ3bJsaHemloOBj_Oh12PSDjOcJInWLwAxXmWonQ5eg2vQuUQKkuHr_9fn6FTttNm652FjSv3R8BWpFT0My9lpZQdakBte9B-A'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 578
{
"id" : "5547251f-a005-4a18-bc7c-f69e14aa8263",
"name" : "Test-NG",
"shortName" : "nw-6871",
"billingAccountId" : "286c6518-12aa-4240-8e34-b037964974e1",
"ownerIdentityId" : "e9c7611a-75f7-413a-bfb2-b663bbc47b69",
"createdBy" : "97482aae-2437-4955-8e2e-bf5d12543485",
"createdAt" : "2023-02-02T14:20:03.743367Z",
"updatedAt" : "2023-02-02T14:20:03.743367Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/5547251f-a005-4a18-bc7c-f69e14aa8263"
}
}
}
Find Network Groups
GET /network-groups
Authorization
This endpoint requires read
action on the network-group
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
name |
String |
false |
Size must be between 0 and 255 inclusive. |
shortName |
String |
false |
Size must be between 0 and 8 inclusive. |
billingAccountId |
String |
true |
|
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
name |
String |
false |
Size must be between 0 and 255 inclusive. |
shortName |
String |
false |
Size must be between 0 and 8 inclusive. |
billingAccountId |
String |
true |
|
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/network-groups' -i -X GET \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJWZFg3X1A4VXJaWDlxMllIczBJSlBRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYxOWQ4OWZjLWU3NDktNDA3Ny04YmE0LTgyZmRlMGU0YmUwNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzYwMywiZXhwIjoxNjc1MzUxMjAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImRiOTFjMGFjLTM1YjktNDM1ZS05YmNmLTAxNzdiZWZjODAzNlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzYwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.mMcPMKxacpU7Em-4ZMELgxEq1mVb_5r6SBq-SpYynk0W45uFNRM0PQTel_16O7e-mSKPZ0h2bTqMDcWSxCDWULKxOeRgyeLCim8YjBoKmNW7icf4AHGmdqPHaiB6HjO66dv3taHEBVA_ZfV1uV6M6XleQFqRsPtUEb6u-9EYlyNXQYsAgCF9A6aby1MHISQNwmgfOd9aIWaGMaM9NYxvWNgc0IowZHjFsh298wvvKSqWSMHjU0EfLA-y4gTsk8R9ofx2p7tDDKbcod7iTF1NfIwyFWUb0xetL-ZIs4uRCZgUt7R7GsY4I0JV7I2makM_CuALs61abSxmWAUyPfIZzA'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1576
{
"_embedded" : {
"networkGroupList" : [ {
"id" : "567119ce-63ae-472e-9478-9be4a1d18744",
"name" : "Updated NG Name-681",
"shortName" : "nw-6831",
"billingAccountId" : "a85f541f-467d-4045-aa1c-589503c85d6c",
"ownerIdentityId" : "840bdf3d-ae61-4993-b535-ade8d7cb0ca6",
"createdBy" : "3fd1a8a2-0516-4fb1-a225-8745626e71f8",
"createdAt" : "2023-02-02T14:20:03.412586Z",
"updatedAt" : "2023-02-02T14:20:03.499268Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/567119ce-63ae-472e-9478-9be4a1d18744"
}
}
}, {
"id" : "afa1ab88-3249-441b-ae42-07b0d7ac015d",
"name" : "Test-NG",
"shortName" : "nw-6851",
"billingAccountId" : "f9bf6c47-68c2-4180-be53-2da76fa6bc76",
"ownerIdentityId" : "b929f568-5784-4b77-bf2a-9bf7a72696fa",
"createdBy" : "9b4c2caa-ee83-4a29-8a47-41e73ecb9e93",
"createdAt" : "2023-02-02T14:20:03.633327Z",
"updatedAt" : "2023-02-02T14:20:03.633327Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/afa1ab88-3249-441b-ae42-07b0d7ac015d"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups"
}
},
"page" : {
"size" : 3500,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
Update Network Group
PATCH /network-groups/{id}
Authorization
This endpoint requires update
action on the network-group
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
billingAccountId |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
ownerIdentityId |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
name |
String |
false |
Size must be between 0 and 255 inclusive. |
shortName |
String |
false |
Size must be between 0 and 8 inclusive. |
billingAccountId |
String |
true |
|
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/network-groups/567119ce-63ae-472e-9478-9be4a1d18744' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJqTGllTHJ2RlltVGFOUGd1dHBRdnlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYxZGQ0NzhkLTc1ZDUtNDBmNy04NTc1LTc1ZDdiOWY5MTU0ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzYwMywiZXhwIjoxNjc1MzUxMjAzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZlMWJlZDgzLTU1NGMtNGM2NS1hZmFiLTRjNGFkMWI1MjhiNFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzYwM31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.IQyCPE9PaaiTJT673ZA5bZpkwjKTudCTSiiHJm3z73XEeurXO7ZYwqBdSizuCgeVThVouNVVxN-WLY5n-SKvenK0beXMWH3nKsBCUsDOmoxpjwNF_w7Qs1QkNY2JtVtGNv0tw70fVmbk7pKEsiSeB5A-dceqXvNrChR0HTRIzFI5dtRKN-0tvL285lJOZnF3CCjdN0a67wgsENDr_3r-0PDDvSVRbLfr-6UFnWNTcKXcilngRHws6q0hSlLjZw_Q5cxYhEXVk2UyZs-I1IcOCLinWdi9JemIAqRdurIk7gJiL6SRbFbqbql0Ay86dymnWp0ve--ob56pIX_SYSIRlA' \
-d '{"name":"Updated NG Name-681","billingAccountId":"a85f541f-467d-4045-aa1c-589503c85d6c","ownerIdentityId":"840bdf3d-ae61-4993-b535-ade8d7cb0ca6"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 796
{
"id" : "567119ce-63ae-472e-9478-9be4a1d18744",
"name" : "Updated NG Name-681",
"shortName" : "nw-6831",
"billingAccountId" : "a85f541f-467d-4045-aa1c-589503c85d6c",
"ownerIdentityId" : "840bdf3d-ae61-4993-b535-ade8d7cb0ca6",
"createdBy" : "3fd1a8a2-0516-4fb1-a225-8745626e71f8",
"createdAt" : "2023-02-02T14:20:03.412586Z",
"updatedAt" : "2023-02-02T14:20:03.499268Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/567119ce-63ae-472e-9478-9be4a1d18744"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/43bcbd18-ac3a-4506-9364-fcd892db43ca",
"title" : "Update NetworkGroup",
"profile" : "meta"
}
}
}
Networks
Find Networks
GET /networks
Authorization
This endpoint requires read
action on the network
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
network.size |
Object |
true |
|
findByName |
String |
true |
Deprecated.. |
findByNetworkGroupId |
Object |
true |
Deprecated.. |
region |
String |
true |
Deprecated.. |
locationCode |
String |
true |
Deprecated.. |
size |
String |
true |
Deprecated.. |
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkGroupId |
String |
false |
|
size |
String |
false |
Deprecated.. |
productVersion |
Object |
false |
|
region |
String |
false |
Deprecated.. |
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
browzerEnabled |
Boolean |
true |
|
o365BreakoutCategory |
String |
false |
Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE]. |
networkController |
Object |
true |
Deprecated.. |
networkController.id |
String |
false |
|
networkController.ownerIdentityId |
String |
true |
|
networkController.networkId |
String |
false |
|
networkController.domainName |
String |
true |
|
networkController.name |
String |
false |
|
networkController.hostId |
String |
false |
|
networkController.status |
String |
true |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
networkController.createdAt |
String |
false |
|
networkController.updatedAt |
String |
false |
|
networkController.deletedAt |
String |
true |
|
networkController.createdBy |
String |
true |
|
networkController.deletedBy |
String |
true |
|
networkController.softwareDeploymentStateId |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
networkControllers |
false |
|
edgeRouters |
false |
|
edgeRouterPolicies |
false |
|
endpoints |
false |
|
services |
false |
|
appWans |
false |
|
certificateAuthorities |
false |
|
hosts |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkGroupId |
String |
false |
|
size |
String |
false |
Deprecated.. |
productVersion |
Object |
false |
|
region |
String |
false |
Deprecated.. |
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
browzerEnabled |
Boolean |
true |
|
o365BreakoutCategory |
String |
false |
Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE]. |
networkController |
Object |
true |
Deprecated.. |
networkController.id |
String |
false |
|
networkController.ownerIdentityId |
String |
true |
|
networkController.networkId |
String |
false |
|
networkController.domainName |
String |
true |
|
networkController.name |
String |
false |
|
networkController.hostId |
String |
false |
|
networkController.status |
String |
true |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
networkController.createdAt |
String |
false |
|
networkController.updatedAt |
String |
false |
|
networkController.deletedAt |
String |
true |
|
networkController.createdBy |
String |
true |
|
networkController.deletedBy |
String |
true |
|
networkController.softwareDeploymentStateId |
String |
true |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/networks' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJTd2ZnQk4yWUhncHhhNUZaV1lKcWJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjEwZDkxNGZmLTA2YzgtNGFlNC04NWM3LTdmOTdkMTZlZTYzMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzQ4NywiZXhwIjoxNjc1MzUxMDg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjEwNGM1YzAxLWJmY2ItNGMyOS1hODgyLTA1NTExYWYzZWFiNlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzQ4N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.VnjKfYYmTkErCon2A8q10Si8o2i6cfW15LoFdfRx9toa2a8MWjpWYDuwJD4M6Jv4i28CIfVxGPMjdz0W5IpygD0NjC03BUroOGGm-ZmMdGy42cllmRVtMD7y7X-pP5YbpEJEXUm7t5vYzrib-yEvpIpOx8yLZhl9hBu_SRXZ_Q-Rk0yMNfH-OKvn5G76bI5ufT2--YfrSUVg1anvA5mZEeVBO-K9Q-00QKKHW36w1PVgujwZxb1FfAxFUMAcVUNU9PsDFScEIbqJgD3bbVgHq3o0TlppbBhZrRzkAtx2EzAB0ZcoXjL1vjVafJopnM9abuBH3gUaN83aYJe6e-jhRg'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 13759
{
"_embedded" : {
"networkList" : [ {
"id" : "00be956e-d00a-413f-8ab5-c848587df31d",
"ownerIdentityId" : "72d71e18-6e67-4338-bcfc-e6e3ae95682b",
"createdBy" : "72d71e18-6e67-4338-bcfc-e6e3ae95682b",
"createdAt" : "2023-02-02T14:18:07.731342Z",
"updatedAt" : "2023-02-02T14:18:07.732760Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "network-102",
"networkGroupId" : "86c169f8-58f7-4737-89fe-0f6f9a4d27de",
"size" : "small",
"productVersion" : "7.3.37",
"region" : "us-east-1",
"status" : "PROVISIONED",
"o365BreakoutCategory" : "NONE",
"networkController" : {
"id" : "eeebf004-0f51-45f6-a466-d4768b192fcb",
"ownerIdentityId" : "72d71e18-6e67-4338-bcfc-e6e3ae95682b",
"networkId" : "00be956e-d00a-413f-8ab5-c848587df31d",
"domainName" : null,
"name" : "network-102-nc",
"hostId" : "81cc7a8f-9fc9-4a79-8672-b5ead1d36fe7",
"status" : "PROVISIONED",
"createdAt" : "2023-02-02T14:18:07.761962Z",
"updatedAt" : "2023-02-02T14:18:07.761962Z",
"deletedAt" : null,
"createdBy" : "72d71e18-6e67-4338-bcfc-e6e3ae95682b",
"deletedBy" : null,
"softwareDeploymentStateId" : null
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/00be956e-d00a-413f-8ab5-c848587df31d"
},
"network-group" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/86c169f8-58f7-4737-89fe-0f6f9a4d27de",
"profile" : "parent"
},
"networks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks",
"profile" : "parent"
},
"network-controllers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"posture-checks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"terminators" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"service-edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"endpoints" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"services" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"hosts" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"config-types" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"certificate-authorities" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"service-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"process-executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"edge-routers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"app-wans" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
},
"configs" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=00be956e-d00a-413f-8ab5-c848587df31d"
}
}
}, {
"id" : "1b87b11c-5ee7-4d2f-a69b-2025e402e120",
"ownerIdentityId" : "8d18fd34-bdf8-4317-9cf2-d92e107ac4d1",
"createdBy" : "8d18fd34-bdf8-4317-9cf2-d92e107ac4d1",
"createdAt" : "2023-02-02T14:18:03.409186Z",
"updatedAt" : "2023-02-02T14:18:03.410801Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "network-70",
"networkGroupId" : "d6dcad5a-e93b-4290-a6e2-bc349b85ab28",
"size" : "small",
"productVersion" : "7.3.37",
"region" : "us-east-1",
"status" : "PROVISIONED",
"o365BreakoutCategory" : "NONE",
"networkController" : {
"id" : "1b6ee6be-855d-4015-9e0f-7c4aba0ed0b9",
"ownerIdentityId" : "8d18fd34-bdf8-4317-9cf2-d92e107ac4d1",
"networkId" : "1b87b11c-5ee7-4d2f-a69b-2025e402e120",
"domainName" : null,
"name" : "network-70-nc",
"hostId" : "cda68822-9fa3-48b6-856e-ba3d839e62a8",
"status" : "PROVISIONED",
"createdAt" : "2023-02-02T14:18:03.415384Z",
"updatedAt" : "2023-02-02T14:18:03.415384Z",
"deletedAt" : null,
"createdBy" : "8d18fd34-bdf8-4317-9cf2-d92e107ac4d1",
"deletedBy" : null,
"softwareDeploymentStateId" : null
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"network-group" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/d6dcad5a-e93b-4290-a6e2-bc349b85ab28",
"profile" : "parent"
},
"networks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks",
"profile" : "parent"
},
"network-controllers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"posture-checks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"terminators" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"service-edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"endpoints" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"services" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"hosts" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"config-types" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"certificate-authorities" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"service-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"process-executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"edge-routers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"app-wans" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
},
"configs" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=1b87b11c-5ee7-4d2f-a69b-2025e402e120"
}
}
}, {
"id" : "3dacbc42-d440-4dbb-a32e-b21ec15684a5",
"ownerIdentityId" : "2e69b8ef-0c09-433a-ba59-1449c8723333",
"createdBy" : "2e69b8ef-0c09-433a-ba59-1449c8723333",
"createdAt" : "2023-02-02T14:18:05.349483Z",
"updatedAt" : "2023-02-02T14:18:05.351181Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "network-75",
"networkGroupId" : "2edb1bff-de3e-43c4-b18c-d1a2002e272f",
"size" : "small",
"productVersion" : "7.3.37",
"region" : "us-east-1",
"status" : "PROVISIONED",
"o365BreakoutCategory" : "NONE",
"networkController" : {
"id" : "00797b99-c79e-49ad-8a33-3fecfa80438c",
"ownerIdentityId" : "2e69b8ef-0c09-433a-ba59-1449c8723333",
"networkId" : "3dacbc42-d440-4dbb-a32e-b21ec15684a5",
"domainName" : null,
"name" : "network-75-nc",
"hostId" : "1ac17c18-6ad0-410b-9532-ee224ff815a7",
"status" : "PROVISIONED",
"createdAt" : "2023-02-02T14:18:05.382542Z",
"updatedAt" : "2023-02-02T14:18:05.382542Z",
"deletedAt" : null,
"createdBy" : "2e69b8ef-0c09-433a-ba59-1449c8723333",
"deletedBy" : null,
"softwareDeploymentStateId" : null
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"network-group" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/2edb1bff-de3e-43c4-b18c-d1a2002e272f",
"profile" : "parent"
},
"networks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks",
"profile" : "parent"
},
"network-controllers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"posture-checks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"terminators" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"service-edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"endpoints" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"services" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"hosts" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"config-types" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"certificate-authorities" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"service-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"process-executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"edge-routers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"app-wans" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
},
"configs" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=3dacbc42-d440-4dbb-a32e-b21ec15684a5"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks"
}
},
"page" : {
"size" : 3500,
"totalElements" : 11,
"totalPages" : 1,
"number" : 0
}
}
Get Network
GET /networks/{id}
Authorization
This endpoint requires read
action on the network
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkGroupId |
String |
false |
|
size |
String |
false |
Deprecated.. |
productVersion |
Object |
false |
|
region |
String |
false |
Deprecated.. |
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
browzerEnabled |
Boolean |
true |
|
o365BreakoutCategory |
String |
false |
Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE]. |
networkController |
Object |
true |
Deprecated.. |
networkController.id |
String |
false |
|
networkController.ownerIdentityId |
String |
true |
|
networkController.networkId |
String |
false |
|
networkController.domainName |
String |
true |
|
networkController.name |
String |
false |
|
networkController.hostId |
String |
false |
|
networkController.status |
String |
true |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
networkController.createdAt |
String |
false |
|
networkController.updatedAt |
String |
false |
|
networkController.deletedAt |
String |
true |
|
networkController.createdBy |
String |
true |
|
networkController.deletedBy |
String |
true |
|
networkController.softwareDeploymentStateId |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
networkControllers |
false |
|
edgeRouters |
false |
|
edgeRouterPolicies |
false |
|
endpoints |
false |
|
services |
false |
|
appWans |
false |
|
certificateAuthorities |
false |
|
hosts |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/networks/daed4dd8-74e1-4c7a-82ff-9d7fc59593d0' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJFUGtWd0RCX0pfM2RvWWs4bFRKdjhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUzZmZlNmFhLTRkMWYtNDBmOS04ZDQyLTlmYzZmZmEyMGM1MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzQ4NSwiZXhwIjoxNjc1MzUxMDg1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjlkMTk2YjNmLTdjNDMtNGFhNS05MmE5LTEyM2Q0YjJjNWJkNFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzQ4NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.XYTbse_UZ8P8HZf1ReNRkLKZT8snP4QUNxHvtC14a0Zxt2JR1IRQuRsLPAMHTS8xAKaImGm2lT2AwRKuvEPzXOEpHMGqnmol_biSqcbv17KbAxt0M9c9mayl1rsQxfGnkO8gOX9LWJu2ln1_qSX46jgfUNNYe6DZv5h4taL9JYYOSTwL20Mfyyz4EW1D9xEZGxj7xjOMewExn4LzqU4IT_hBsnepCtw3K6_IQ7HFnTDylAPA_Sd0MOEl53aISltqLbGGw-2szx858HF1mPbgh0kl3Q7umwFCD58kd8ptozrda8kO_aBl_LqynYKUWGsEcn8j_9VE029OBrdjHvGgFg'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 4131
{
"id" : "daed4dd8-74e1-4c7a-82ff-9d7fc59593d0",
"ownerIdentityId" : "2b118cbc-f0f1-4248-ab2c-65ad2ec83a96",
"createdBy" : "2b118cbc-f0f1-4248-ab2c-65ad2ec83a96",
"createdAt" : "2023-02-02T14:18:05.478513Z",
"updatedAt" : "2023-02-02T14:18:05.480193Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "network-80",
"networkGroupId" : "f2240154-7ee8-455e-bca2-27f54d1cf35a",
"size" : "small",
"productVersion" : "7.3.37",
"region" : "us-east-1",
"status" : "PROVISIONED",
"o365BreakoutCategory" : "NONE",
"networkController" : {
"id" : "0eeabf12-b71f-4be7-9d79-8fd2342f5398",
"ownerIdentityId" : "2b118cbc-f0f1-4248-ab2c-65ad2ec83a96",
"networkId" : "daed4dd8-74e1-4c7a-82ff-9d7fc59593d0",
"domainName" : null,
"name" : "network-80-nc",
"hostId" : "282cec7a-4d5c-4035-a95b-9e49bf0e2b2f",
"status" : "PROVISIONED",
"createdAt" : "2023-02-02T14:18:05.484378Z",
"updatedAt" : "2023-02-02T14:18:05.484378Z",
"deletedAt" : null,
"createdBy" : "2b118cbc-f0f1-4248-ab2c-65ad2ec83a96",
"deletedBy" : null,
"softwareDeploymentStateId" : null
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"network-group" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/f2240154-7ee8-455e-bca2-27f54d1cf35a",
"profile" : "parent"
},
"networks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks",
"profile" : "parent"
},
"network-controllers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"posture-checks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"terminators" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"service-edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"endpoints" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"services" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"hosts" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"config-types" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"certificate-authorities" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"service-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"process-executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"edge-routers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"app-wans" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
},
"configs" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=daed4dd8-74e1-4c7a-82ff-9d7fc59593d0"
}
}
}
Create Network
POST /networks
Authorization
This endpoint requires create
action on the network
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
networkGroupId |
String |
true |
${reason}. |
size |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
productVersion |
Object |
true |
|
o365BreakoutCategory |
String |
true |
Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE]. |
provider |
String |
true |
Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER]. |
region |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouters |
Array[Object] |
true |
|
edgeRouters[].name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouters[].networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
edgeRouters[].dataCenterId |
String |
true |
Deprecated.. |
edgeRouters[].provider |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouters[].region |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouters[].hostSize |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouters[].linkListener |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouters[].wssListener |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouters[].tunnelerEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouters[].noTraversal |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouters[].attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouters[].endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouterPolicies |
Array[Object] |
true |
|
edgeRouterPolicies[].name |
String |
false |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouterPolicies[].networkId |
String |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
edgeRouterPolicies[].semantic |
String |
false |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouterPolicies[].endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouterPolicies[].edgeRouterAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
services |
Array[Object] |
true |
|
services[].networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
services[].name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
services[].encryptionRequired |
Boolean |
true |
|
services[].configIds |
Array[Object] |
true |
|
services[].configNames |
Array[String] |
true |
|
services[].configs |
Array[Object] |
true |
|
services[].configs[].networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
services[].configs[].name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
services[].configs[].configTypeId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
services[].configs[].configTypeName |
String |
true |
|
services[].configs[].configType |
Object |
true |
|
services[].configs[].configType.networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
services[].configs[].configType.name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
services[].configs[].configType.schema |
Object |
true |
io.netfoundry.common.util.validation.ValidAs. |
services[].configs[].data |
Object |
true |
io.netfoundry.common.util.validation.ValidAs. |
services[].attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
services[].modelType |
String |
true |
Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH]. |
services[].model |
Object |
true |
|
certificateAuthorities |
Array[Object] |
true |
|
certificateAuthorities[].networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
certificateAuthorities[].name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
certificateAuthorities[].autoCaEnrollmentEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
certificateAuthorities[].authEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
certificateAuthorities[].ottCaEnrollmentEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
certificateAuthorities[].certPem |
String |
false |
Size must be between 100 and 2147483647 inclusive. |
certificateAuthorities[].endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
certificateAuthorities[].identityNameFormat |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
endpoints |
Array[Object] |
true |
|
endpoints[].networkId |
String |
true |
${reason}. |
endpoints[].name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
endpoints[].enrollmentMethod |
Object |
false |
|
endpoints[].enrollmentMethod.ott |
Boolean |
true |
|
endpoints[].enrollmentMethod.updb |
String |
true |
|
endpoints[].enrollmentMethod.ottca |
String |
true |
|
endpoints[].externalId |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
endpoints[].authPolicyId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
endpoints[].attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
endpoints[].syncId |
String |
true |
|
endpoints[].syncResourceId |
String |
true |
|
endpoints[].shareRegistration |
Object |
true |
|
endpoints[].shareRegistration.id |
String |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
endpoints[].shareRegistration.toList |
Array[String] |
false |
|
endpoints[].shareRegistration.ccList |
Array[String] |
true |
|
endpoints[].shareRegistration.subject |
String |
true |
|
endpoints[].shareRegistration.type |
String |
true |
Must be one of [Email]. |
appWans |
Array[Object] |
true |
|
appWans[].networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
appWans[].name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
appWans[].serviceAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
appWans[].endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
appWans[].postureCheckAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
postureChecks |
Array[Object] |
true |
|
postureChecks[].name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
postureChecks[].networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
postureChecks[].type |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
postureChecks[].attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
postureChecks[].data |
Object |
false |
io.netfoundry.common.util.validation.ValidAs. |
postureChecks[].data.domains |
Array[String] |
false |
|
postureChecks[].data.macAddresses |
Array[String] |
false |
|
postureChecks[].data.timeoutSeconds |
Integer |
true |
Must be at least 0. |
postureChecks[].data.promptOnWake |
Boolean |
true |
|
postureChecks[].data.promptOnUnlock |
Boolean |
true |
|
postureChecks[].data.ignoreLegacyEndpoints |
Boolean |
true |
|
postureChecks[].data.operatingSystems |
Array[Object] |
false |
|
postureChecks[].data.operatingSystems[].type |
String |
false |
Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer]. |
postureChecks[].data.operatingSystems[].versions |
Array[String] |
false |
|
postureChecks[].data.process |
Object |
false |
|
postureChecks[].data.process.osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
postureChecks[].data.process.path |
String |
false |
|
postureChecks[].data.process.hashes |
Array[String] |
true |
|
postureChecks[].data.process.signerFingerprint |
String |
true |
|
postureChecks[].data.processes |
Array[Object] |
false |
|
postureChecks[].data.processes[].osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
postureChecks[].data.processes[].path |
String |
false |
|
postureChecks[].data.processes[].hashes |
Array[String] |
true |
|
postureChecks[].data.processes[].signerFingerprints |
Array[String] |
true |
|
postureChecks[].data.semantic |
String |
true |
Must be one of [AllOf, AnyOf]. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkGroupId |
String |
false |
|
size |
String |
false |
Deprecated.. |
productVersion |
Object |
false |
|
region |
String |
false |
Deprecated.. |
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
browzerEnabled |
Boolean |
true |
|
o365BreakoutCategory |
String |
false |
Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE]. |
networkController |
Object |
true |
Deprecated.. |
networkController.id |
String |
false |
|
networkController.ownerIdentityId |
String |
true |
|
networkController.networkId |
String |
false |
|
networkController.domainName |
String |
true |
|
networkController.name |
String |
false |
|
networkController.hostId |
String |
false |
|
networkController.status |
String |
true |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
networkController.createdAt |
String |
false |
|
networkController.updatedAt |
String |
false |
|
networkController.deletedAt |
String |
true |
|
networkController.createdBy |
String |
true |
|
networkController.deletedBy |
String |
true |
|
networkController.softwareDeploymentStateId |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
networkControllers |
false |
|
edgeRouters |
false |
|
edgeRouterPolicies |
false |
|
endpoints |
false |
|
services |
false |
|
appWans |
false |
|
certificateAuthorities |
false |
|
hosts |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/networks' -i -X POST \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJCd25USk9jaDBEbk9yMWZsMWZEUkdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEwMjUxMWE3LTk1ZTgtNDdhYy05N2VmLTJjZWJiZGRjNDI2NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzQ4OCwiZXhwIjoxNjc1MzUxMDg4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjlkMWQ5ZmVjLTBlODktNDVhNi1hYmYzLWFiZDM1YThjNGQxNVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzQ4OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Jomtz7RD0scuzx2l_Bt9A9d84u8q_Jz8qtUtAQ-8217egSwVIBWdoJwORF9iEyw84Fy3hbXNigTxGkd8oHaYa61iskFyXNmuVKmJ0Y9_SXE1qBssaZIpFB32013IM74SMTfKLc5vlExK6DW4xc5dexoIxn6RizB64jPkXSDtX5-YFM0irVEW5N8Rz2h5l6zTFAf-fiVqt4wjgnA5JoKZUrQ7x85CMY7JS8k1B2hB2qhD9sPRzA5bZRJEXPq-9CKVZnnjXnYVXw0MZ3zO25lbdy7LIq9OcYCX6WYbWuVsukkKcPxkWv0i1WZ1SIqssrTio-ck1ownUFi8ub2buDQF2g' \
-d '{"networkGroupId":"d0837c92-7218-4f1e-a4d5-a393e55f91e9","size":"small","name":"Create Test Network","o365BreakoutCategory":"NONE","provider":"AWS","region":"us-east-1","edgeRouters":[],"edgeRouterPolicies":[],"services":[],"certificateAuthorities":[],"endpoints":[],"appWans":[],"postureChecks":[]}'
Example response
HTTP/1.1 202 Accepted
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3584
{
"id" : "a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f",
"ownerIdentityId" : "a02511a7-95e8-47ac-97ef-2cebbddc4266",
"createdBy" : "a02511a7-95e8-47ac-97ef-2cebbddc4266",
"createdAt" : "2023-02-02T14:18:08.658026Z",
"updatedAt" : "2023-02-02T14:18:08.658026Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "Create Test Network",
"networkGroupId" : "d0837c92-7218-4f1e-a4d5-a393e55f91e9",
"size" : "small",
"productVersion" : "7.3.43",
"region" : "us-east-1",
"status" : "PROVISIONING",
"o365BreakoutCategory" : "NONE",
"networkController" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"network-group" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/d0837c92-7218-4f1e-a4d5-a393e55f91e9",
"profile" : "parent"
},
"networks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks",
"profile" : "parent"
},
"network-controllers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"posture-checks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"terminators" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"service-edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"endpoints" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"services" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"hosts" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"config-types" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"certificate-authorities" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"service-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"process-executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"edge-routers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"app-wans" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
},
"configs" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=a4ce1e7f-edc8-4bd8-a03d-83795a58fb3f"
}
}
}
Delete Network
DELETE /networks/{id}
Authorization
This endpoint requires delete
action on the network
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkGroupId |
String |
false |
|
size |
String |
false |
Deprecated.. |
productVersion |
Object |
false |
|
region |
String |
false |
Deprecated.. |
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
browzerEnabled |
Boolean |
true |
|
o365BreakoutCategory |
String |
false |
Must be one of [OPTIMIZE, OPTIMIZE_ALLOW, OPTIMIZE_ALLOW_DEFAULT, NONE]. |
networkController |
Object |
true |
Deprecated.. |
networkController.id |
String |
false |
|
networkController.ownerIdentityId |
String |
true |
|
networkController.networkId |
String |
false |
|
networkController.domainName |
String |
true |
|
networkController.name |
String |
false |
|
networkController.hostId |
String |
false |
|
networkController.status |
String |
true |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
networkController.createdAt |
String |
false |
|
networkController.updatedAt |
String |
false |
|
networkController.deletedAt |
String |
true |
|
networkController.createdBy |
String |
true |
|
networkController.deletedBy |
String |
true |
|
networkController.softwareDeploymentStateId |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
networkControllers |
false |
|
edgeRouters |
false |
|
edgeRouterPolicies |
false |
|
endpoints |
false |
|
services |
false |
|
appWans |
false |
|
certificateAuthorities |
false |
|
hosts |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/networks/0e15637c-3ebf-4280-b1d1-313c919cc676' -i -X DELETE \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyelM0LUFjbkVGWExnUzFKZktaNlNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZjZTc1Y2U5LTlmNWMtNDEwYy1hMjUyLWJmYjk5MTFlZjU5YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzQ5MiwiZXhwIjoxNjc1MzUxMDkyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjkzOWY4MTE0LTI4ZTUtNGNkNy1hODU4LTYxNzEwNmViMmFjYVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzQ5Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.NY5XVebJonpSEdr_4bM_rEo56PqLYV1mH0oOxGev1xTFMZavGWW1UcgiU6tzy0PcdkiyPFjcjfDDlWnfEuldWDZSrejyg9-7onsx_pnPsOJfUtDBtrV6C68FqCihXTSl8vOdb0xmFU7QKnvDhIc71RL3xdpOnbqUJzQP80GKVIRAs2Kj0Uqo5Kd8Jl2pOdXNka98KxXV6X0hk4zWz1Do1qTFa3mHqD68xLfB1E5tMSaRFK5O0QzUvE34ON8ozRZH1NLGZr_wXlturXmaVz33YJcGNv5xNrI1WK9zvOHFBkSqr0GRA6l9jReTpzUppZrtH6w_cH9LiAwZbzTxy_pOAw'
Example response
HTTP/1.1 202 Accepted
Content-Type: application/hal+json
Content-Length: 3606
{
"id" : "0e15637c-3ebf-4280-b1d1-313c919cc676",
"ownerIdentityId" : "71cc7817-1cce-4dfb-a76b-01b712b06579",
"createdBy" : "71cc7817-1cce-4dfb-a76b-01b712b06579",
"createdAt" : "2023-02-02T14:18:12.069938Z",
"updatedAt" : "2023-02-02T14:18:12.123330Z",
"deletedBy" : "6ce75ce9-9f5c-410c-a252-bfb9911ef59a",
"deletedAt" : null,
"name" : "network-147",
"networkGroupId" : "cb35a6a3-92f7-4058-9659-fe49c66351c9",
"size" : "small",
"productVersion" : "7.3.37",
"region" : "us-east-1",
"status" : "DELETING",
"o365BreakoutCategory" : "NONE",
"networkController" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"network-group" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-groups/cb35a6a3-92f7-4058-9659-fe49c66351c9",
"profile" : "parent"
},
"networks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks",
"profile" : "parent"
},
"network-controllers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"posture-checks" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"terminators" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/terminators?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"service-edge-router-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-edge-router-policies?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"endpoints" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"services" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"hosts" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"config-types" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/config-types?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"certificate-authorities" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"service-policies" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/service-policies?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"process-executions" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/process-executions?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"edge-routers" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"app-wans" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
},
"configs" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/configs?networkId=0e15637c-3ebf-4280-b1d1-313c919cc676"
}
}
}
Network Controllers
Get Network Controller
GET /network-controllers/{id}
Authorization
This endpoint requires read
action on the network-controller
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
networkId |
String |
false |
|
domainName |
String |
true |
|
name |
String |
false |
|
hostId |
String |
false |
|
status |
String |
true |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedAt |
String |
true |
|
createdBy |
String |
true |
|
deletedBy |
String |
true |
|
softwareDeploymentStateId |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/network-controllers/1ce5a974-f252-4d63-9d50-a44c024ce64d' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJHOXdfZ1FSdzNjWDRLRDcwVzI5cHN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkyNjFiMTJiLTEyMDMtNGVmYy04MDdhLTZmYzI1YmI4M2Q3YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3MiwiZXhwIjoxNjc1MzUxMTcyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg3OTk4MWFjLTQ4YmItNDMyZS1iNjlhLTM0ZTc5MzM3MDA1MFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.FurpFxHUm8A9n_8pHd4qhS1C9RP27pcEj_ZGgcoCM1hmo-2_Gtx6urlNgluBnfcFn3Ruj0r_iqOH0jos9tN2ypbs5acX5k8OclK-hLBVyI2bMly1FCLnhu747MUnoAmC1Ax_VEg_V0u2307G6a2P4gJ2AEy4WHPchPHJyRnd_4bu3bkK_jLb9aCmcWE2v68n2FbTqT1-VIkpuP9GEI6P5IQVyEPcMa5sXta5m-LSAu6-muRR0KH5b8-mPfhi4xOWedHc4zphAlfUYsQDeCy80Gzr6IlmZrPTVv5q0QK3-LCm254IP4VnssEhVhWT64oJj4BGXPFz2-Ei0pCmGudfgg'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1201
{
"id" : "1ce5a974-f252-4d63-9d50-a44c024ce64d",
"ownerIdentityId" : "323242e6-a8c2-4689-88c4-41ff966b71cd",
"networkId" : "8f77b6c0-e5c3-48a4-b04d-d0b00d1aac11",
"domainName" : "new-domain.nf.io",
"name" : "networkcontroller-controller-test-nc",
"hostId" : "43304f9b-10b9-4cf6-8e8e-4228d621483b",
"status" : "PROVISIONED",
"createdAt" : "2023-02-02T14:19:30.501458Z",
"updatedAt" : "2023-02-02T14:19:32.763646Z",
"deletedAt" : null,
"createdBy" : "323242e6-a8c2-4689-88c4-41ff966b71cd",
"deletedBy" : null,
"softwareDeploymentStateId" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/8f77b6c0-e5c3-48a4-b04d-d0b00d1aac11",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/1ce5a974-f252-4d63-9d50-a44c024ce64d"
},
"host" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts/43304f9b-10b9-4cf6-8e8e-4228d621483b"
},
"softwareDeploymentState" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/2aec1222-d879-4f0c-9bc6-932d32bfa0c9"
}
}
}
Get Network Controller Session
GET /network-controllers/{id}/session
Authorization
This endpoint requires read-platform-protected
action on the network-controller
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
sessionToken |
String |
true |
|
expiresAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/network-controllers/1ce5a974-f252-4d63-9d50-a44c024ce64d/session' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJqNWR3bUdwODZ0QUQ3OGg5bmY4OE53IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEyZGU0NDVhLWVjYzItNDQ1My1iODUzLTU0MDlkMWZhZTc0MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3MSwiZXhwIjoxNjc1MzUxMTcxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ4MjBkNGM2LTk5MTEtNDQ5OC04ZThhLTQ4YzBkYTA0Y2QyZFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.m5asp-rV6AaNK2Aq24R7eGTKPs4_8U8RntH4f-LKW9-OXClqXrO3djLknrAuaw-R_RkDYBSLAcsYsZji7-zLfN9UksRJnVgmN0tF0jH7sZUWn77X9DW5jd4no4zG5ATHfRMranMbUsiTStHg5fqevysBaZlqSLlt2zde5UMspsptTR09pfB-6HUAZQM_hUi-VSnw8qyjeKDxpN7MLJfVUY6TQA9ci31l0-A_ijSMFYwu7uHidTR_Lvc9edRkCGrP8Y4iGEQLPN5J_u_UbTmEj8JCF1tTnJka_DDg7HUWb9mTNS3qHnlcuHTbcQyH2LkpXba_Q3mY_JC6L7x69jTFyw'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 408
{
"sessionToken" : "--- session ---",
"expiresAt" : "2023-02-02T14:19:31.098+00:00",
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/1ce5a974-f252-4d63-9d50-a44c024ce64d/session"
},
"parent" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/1ce5a974-f252-4d63-9d50-a44c024ce64d"
}
}
}
Find Network Controllers
GET /network-controllers
Authorization
This endpoint requires read
action on the network-controller
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
isDeleted |
Boolean |
true |
Deprecated.. |
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
networkId |
String |
false |
|
domainName |
String |
true |
|
name |
String |
false |
|
hostId |
String |
false |
|
status |
String |
true |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedAt |
String |
true |
|
createdBy |
String |
true |
|
deletedBy |
String |
true |
|
softwareDeploymentStateId |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
networkId |
String |
false |
|
domainName |
String |
true |
|
name |
String |
false |
|
hostId |
String |
false |
|
status |
String |
true |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedAt |
String |
true |
|
createdBy |
String |
true |
|
deletedBy |
String |
true |
|
softwareDeploymentStateId |
String |
true |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/network-controllers' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJzb3pXTzN3REFFSVpDNVRScm4yQ2VRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI5NDc3ZWU3LWZlYzgtNGNjYS04OGQ0LTRlNzVhYTE4NTc5NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU0OSwiZXhwIjoxNjc1MzUxMTQ5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU2ZTQ4OTU4LTczOTktNGQ1My1hNDUxLTFkNDk1NDFkN2M3Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU0OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jDkYwyzGvxIkLI0yZ7dp_YJ3NxeNaLAPSI9LX075lEPf_jUbQuyVBM8tIWyOp0ufNNE9-QE0BlGL9dqjRYds6vNlgjlEOf-GM6oKf5u50OnEjtbB2QRG0ujdB-ZHXLHc0dzYr9iGUlphJXjLyKbkryt3r4e5nij24Ns4lgW39DqcnfJxe1P9_ANMGH_ZXl6y-a3RLw7rZe22232qtb6CHckk49J02VXNPusetkW1ESL1ZzJJwQpuK9UeLIXj_kzafhHA6BbG2OgzH_rs871WfxyVQ2MVoHXO_TG3PA3LpqZCEIaEoNrcukD59XzgOCxP8y4nra9_AET1DjWbSdjLTQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2949
{
"_embedded" : {
"networkControllerList" : [ {
"id" : "4ca0f2b7-b0b9-441c-96f1-b4ef5febba11",
"ownerIdentityId" : "0328d1ed-09ac-4844-a8a5-c585b3a8201e",
"networkId" : "6972d3a3-f3cb-4805-ad9e-22175529d675",
"domainName" : "k7-3kHFY4NkdbOVgogn_E.fake.com",
"name" : "NetworkController Find Test 2 - NC",
"hostId" : "2017bb3c-56ca-4766-b094-80e4b9ba1dc4",
"status" : "PROVISIONING",
"createdAt" : "2023-02-02T14:19:09.184780Z",
"updatedAt" : "2023-02-02T14:19:09.184780Z",
"deletedAt" : null,
"createdBy" : "0328d1ed-09ac-4844-a8a5-c585b3a8201e",
"deletedBy" : null,
"softwareDeploymentStateId" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/4ca0f2b7-b0b9-441c-96f1-b4ef5febba11"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/6972d3a3-f3cb-4805-ad9e-22175529d675",
"profile" : "parent"
},
"host" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts/2017bb3c-56ca-4766-b094-80e4b9ba1dc4"
},
"softwareDeploymentState" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/340b9ce0-4061-454f-9a81-19598bb76514"
}
}
}, {
"id" : "aa793991-99a4-46cd-bdbd-fa69a08cce0a",
"ownerIdentityId" : "0328d1ed-09ac-4844-a8a5-c585b3a8201e",
"networkId" : "7dd3da72-e707-4d70-a42b-03cbc23b61ba",
"domainName" : "aM7UcieuNh0xCJpY9PSU4.fake.com",
"name" : "NetworkController Find Test 1 - NC",
"hostId" : "14ab9d7a-94a9-4e07-80c0-03fa89805112",
"status" : "PROVISIONED",
"createdAt" : "2023-02-02T14:19:09.176819Z",
"updatedAt" : "2023-02-02T14:19:09.176819Z",
"deletedAt" : null,
"createdBy" : "0328d1ed-09ac-4844-a8a5-c585b3a8201e",
"deletedBy" : null,
"softwareDeploymentStateId" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers/aa793991-99a4-46cd-bdbd-fa69a08cce0a"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/7dd3da72-e707-4d70-a42b-03cbc23b61ba",
"profile" : "parent"
},
"host" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts/14ab9d7a-94a9-4e07-80c0-03fa89805112"
},
"softwareDeploymentState" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/software-deployment-states/95807c67-5226-4185-9cd1-5f4db825c326"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/network-controllers"
}
},
"page" : {
"size" : 3500,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
Endpoints
Find Endpoints
GET /endpoints
Authorization
This endpoint requires read
action on the endpoint
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
attributes |
Object |
true |
Deprecated.. |
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
typeId |
String |
true |
|
appId |
String |
true |
|
appVersion |
String |
true |
|
branch |
String |
true |
|
revision |
String |
true |
|
type |
String |
true |
|
version |
String |
true |
|
arch |
String |
true |
|
os |
String |
true |
|
osRelease |
String |
true |
|
osVersion |
String |
true |
|
externalId |
String |
true |
|
authPolicyId |
String |
true |
|
disabled |
Boolean |
true |
|
disabledAt |
String |
true |
|
disabledUntil |
String |
true |
|
hasApiSession |
Boolean |
true |
|
hasEdgeRouterConnection |
Boolean |
true |
|
lastOnlineAt |
String |
true |
|
syncId |
String |
true |
|
syncResourceId |
String |
true |
|
attributes |
Array[String] |
false |
|
jwt |
String |
true |
|
online |
Boolean |
true |
|
mfaEnabled |
Boolean |
true |
|
jwtExpiresAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
typeId |
String |
true |
|
appId |
String |
true |
|
appVersion |
String |
true |
|
branch |
String |
true |
|
revision |
String |
true |
|
type |
String |
true |
|
version |
String |
true |
|
arch |
String |
true |
|
os |
String |
true |
|
osRelease |
String |
true |
|
osVersion |
String |
true |
|
externalId |
String |
true |
|
authPolicyId |
String |
true |
|
disabled |
Boolean |
true |
|
disabledAt |
String |
true |
|
disabledUntil |
String |
true |
|
hasApiSession |
Boolean |
true |
|
hasEdgeRouterConnection |
Boolean |
true |
|
lastOnlineAt |
String |
true |
|
syncId |
String |
true |
|
syncResourceId |
String |
true |
|
attributes |
Array[String] |
false |
|
jwt |
String |
true |
|
online |
Boolean |
true |
|
mfaEnabled |
Boolean |
true |
|
jwtExpiresAt |
String |
true |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzdUtkQ0RTY19iOEFNZnBVZXItWjZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZmMzNkMzc5LWFhMzctNDU4ZC04M2VlLTc5MTE4NmM4YjBiMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzYxOCwiZXhwIjoxNjc1MzUxMjE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjc2MzIzNTI5LTgxZWQtNDYyNi04ODMzLWY4MWQyZDhkNTM0N1wiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzYxOH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Goklyg3VDT5Q_P78mjXafU8eKWFe9qUockF_chsZfGOzEYffwOOSlruXL7iI2Pt3vnBevBwHnTEnuh8LYrVkh5wlHRYMPrSCHYZvgCCzm1drznGL0fB8B2DzL7-g2cmschqJARUVl_1LQ5bSO3pFwO9BqSqCmQpV_wMb2wDkgkXC8RuNY-rwRzIQGm8lgKnK46xyRff-z3rccKPeYu7vSZUYpqXwMGXrdQ4HS5gaMiiXDcR2dhAWQaLPgiJFb56byMvcfO5iGgVLj5aDUh315uRIeMWbxM-ymoZtlVZ0NXn2qBND9kxfcE2UepYC1fwfYwVVnm5oBFE5qM9E6_SwAg'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 5043
{
"_embedded" : {
"endpointList" : [ {
"id" : "6535afcc-89a7-4195-aba1-b8732a29dc1c",
"ownerIdentityId" : "0f00ae03-950a-4fbd-9661-5ff722f4a6aa",
"createdBy" : "0f00ae03-950a-4fbd-9661-5ff722f4a6aa",
"createdAt" : "2023-02-02T14:20:18.082111Z",
"updatedAt" : "2023-02-02T14:20:18.082111Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "47730094-b3e4-4366-8cc5-2765a03d15af",
"zitiId" : "18ca1d28-1223-4388-a58e-1abe9e454394",
"name" : "Refresh Success Endpoint",
"typeId" : "device",
"appId" : "appId",
"appVersion" : "appVersion",
"branch" : "branch",
"revision" : "revision",
"type" : "User",
"version" : "version",
"arch" : "arch",
"os" : "os",
"osRelease" : "osRelease",
"osVersion" : "osVersion",
"hasApiSession" : false,
"hasEdgeRouterConnection" : false,
"lastOnlineAt" : null,
"syncId" : null,
"syncResourceId" : null,
"attributes" : [ ],
"jwt" : null,
"online" : false,
"mfaEnabled" : false,
"jwtExpiresAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/47730094-b3e4-4366-8cc5-2765a03d15af",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/6535afcc-89a7-4195-aba1-b8732a29dc1c"
},
"app-data-usages" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-data-usages?endpointId=6535afcc-89a7-4195-aba1-b8732a29dc1c"
}
}
}, {
"id" : "8ed0b505-c48e-407b-8574-7847926457cc",
"ownerIdentityId" : "22f03bba-0194-46a2-8b05-71be0b35f8e0",
"createdBy" : "22f03bba-0194-46a2-8b05-71be0b35f8e0",
"createdAt" : "2023-02-02T14:20:18.192817Z",
"updatedAt" : "2023-02-02T14:20:18.192817Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "69189d5e-ea39-4572-a495-81fcd5bb2710",
"zitiId" : "ziti-id-766",
"name" : "endpoint-765",
"typeId" : "type",
"appId" : "appId",
"appVersion" : "appVersion",
"branch" : "branch",
"revision" : "revision",
"type" : "User",
"version" : "version",
"arch" : "arch",
"os" : "os",
"osRelease" : "osRelease",
"osVersion" : "osVersion",
"hasApiSession" : false,
"hasEdgeRouterConnection" : false,
"lastOnlineAt" : null,
"syncId" : null,
"syncResourceId" : null,
"attributes" : [ ],
"jwt" : null,
"online" : false,
"mfaEnabled" : false,
"jwtExpiresAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/69189d5e-ea39-4572-a495-81fcd5bb2710",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/8ed0b505-c48e-407b-8574-7847926457cc"
},
"app-data-usages" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-data-usages?endpointId=8ed0b505-c48e-407b-8574-7847926457cc"
}
}
}, {
"id" : "aa8bb817-c17d-43a8-ac94-9002b8ee203a",
"ownerIdentityId" : "9b6de07f-8d91-4e66-83eb-9f41035ade65",
"createdBy" : "9b6de07f-8d91-4e66-83eb-9f41035ade65",
"createdAt" : "2023-02-02T14:20:18.063857Z",
"updatedAt" : "2023-02-02T14:20:18.063857Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "e0423cb1-99ad-4578-9112-56fceacf9281",
"zitiId" : "ziti-id-739",
"name" : "endpoint-738",
"typeId" : "type",
"appId" : "appId",
"appVersion" : "appVersion",
"branch" : "branch",
"revision" : "revision",
"type" : "User",
"version" : "version",
"arch" : "arch",
"os" : "os",
"osRelease" : "osRelease",
"osVersion" : "osVersion",
"hasApiSession" : false,
"hasEdgeRouterConnection" : false,
"lastOnlineAt" : null,
"syncId" : null,
"syncResourceId" : null,
"attributes" : [ ],
"jwt" : null,
"online" : false,
"mfaEnabled" : false,
"jwtExpiresAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/e0423cb1-99ad-4578-9112-56fceacf9281",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/aa8bb817-c17d-43a8-ac94-9002b8ee203a"
},
"app-data-usages" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-data-usages?endpointId=aa8bb817-c17d-43a8-ac94-9002b8ee203a"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints"
}
},
"page" : {
"size" : 3500,
"totalElements" : 4,
"totalPages" : 1,
"number" : 0
}
}
Get Endpoint
GET /endpoints/{id}
Authorization
This endpoint requires read
action on the endpoint
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
typeId |
String |
true |
|
appId |
String |
true |
|
appVersion |
String |
true |
|
branch |
String |
true |
|
revision |
String |
true |
|
type |
String |
true |
|
version |
String |
true |
|
arch |
String |
true |
|
os |
String |
true |
|
osRelease |
String |
true |
|
osVersion |
String |
true |
|
externalId |
String |
true |
|
authPolicyId |
String |
true |
|
disabled |
Boolean |
true |
|
disabledAt |
String |
true |
|
disabledUntil |
String |
true |
|
hasApiSession |
Boolean |
true |
|
hasEdgeRouterConnection |
Boolean |
true |
|
lastOnlineAt |
String |
true |
|
syncId |
String |
true |
|
syncResourceId |
String |
true |
|
attributes |
Array[String] |
false |
|
jwt |
String |
true |
|
online |
Boolean |
true |
|
mfaEnabled |
Boolean |
true |
|
jwtExpiresAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/cf5a81b3-bed9-454d-842f-9de846ac9d18' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJLbTd3eWFKSC1tTy1mUkRDejNHc1lRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjllNTAwZDkwLTkwZGYtNGU0NS04M2U2LTk2MTBmZDM4ZjI3ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzYxOSwiZXhwIjoxNjc1MzUxMjE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImE0ZDVkNmE5LTExMWQtNDVkNS1iMzMyLTU1M2YxMjVkMjE4MVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzYxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Kp7cp2NNNzvIECo_hEpNQi1dT1c6akoj9vkcKQodsKRfr8VJMXKohZ-dhKEfbbmcNNCkKrpY3Lf3cp8wowYmIIJtCSyErWWDeXh0krcuQXv_gn9i5sN1ps7VJnMxQhiZbudI6LBt9kBidqkwaNgbvXzsKokAJfrIwVnkE_di6R9t7CXQkMGls7JLJZMjkGtwPUvnpExZATsOnYHrAFRw7s6xwG5htm69U6rcsT_wRogRgq8O0SSmiphPUPytW8lSaBo8z7hJ4VCm0P5yQ_tXpNJPrrvUtNWFBIF3_alEZ0JipHQIcCVbo4YM4dbU4OsDlM0tvFyxEyaDL3MP1XPSvA'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1401
{
"id" : "cf5a81b3-bed9-454d-842f-9de846ac9d18",
"ownerIdentityId" : "fdbdcbe6-6c44-477f-8fb0-aa142f1ce448",
"createdBy" : "fdbdcbe6-6c44-477f-8fb0-aa142f1ce448",
"createdAt" : "2023-02-02T14:20:19.542668Z",
"updatedAt" : "2023-02-02T14:20:19.542668Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "a8928a24-9390-4518-be7a-b7fc2253ad2a",
"zitiId" : "ziti-id-940",
"name" : "endpoint-939",
"typeId" : "type",
"appId" : "appId",
"appVersion" : "appVersion",
"branch" : "branch",
"revision" : "revision",
"type" : "User",
"version" : "version",
"arch" : "arch",
"os" : "os",
"osRelease" : "osRelease",
"osVersion" : "osVersion",
"hasApiSession" : false,
"hasEdgeRouterConnection" : false,
"lastOnlineAt" : null,
"syncId" : null,
"syncResourceId" : null,
"attributes" : [ ],
"jwt" : null,
"online" : false,
"mfaEnabled" : false,
"jwtExpiresAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/a8928a24-9390-4518-be7a-b7fc2253ad2a",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/cf5a81b3-bed9-454d-842f-9de846ac9d18"
},
"app-data-usages" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-data-usages?endpointId=cf5a81b3-bed9-454d-842f-9de846ac9d18"
}
}
}
Find Endpoints
GET /endpoints
Authorization
This endpoint requires read
action on the endpoint
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
attributes |
Object |
true |
Deprecated.. |
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
typeId |
String |
true |
|
appId |
String |
true |
|
appVersion |
String |
true |
|
branch |
String |
true |
|
revision |
String |
true |
|
type |
String |
true |
|
version |
String |
true |
|
arch |
String |
true |
|
os |
String |
true |
|
osRelease |
String |
true |
|
osVersion |
String |
true |
|
externalId |
String |
true |
|
authPolicyId |
String |
true |
|
disabled |
Boolean |
true |
|
disabledAt |
String |
true |
|
disabledUntil |
String |
true |
|
hasApiSession |
Boolean |
true |
|
hasEdgeRouterConnection |
Boolean |
true |
|
lastOnlineAt |
String |
true |
|
syncId |
String |
true |
|
syncResourceId |
String |
true |
|
attributes |
Array[String] |
false |
|
jwt |
String |
true |
|
online |
Boolean |
true |
|
mfaEnabled |
Boolean |
true |
|
jwtExpiresAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
typeId |
String |
true |
|
appId |
String |
true |
|
appVersion |
String |
true |
|
branch |
String |
true |
|
revision |
String |
true |
|
type |
String |
true |
|
version |
String |
true |
|
arch |
String |
true |
|
os |
String |
true |
|
osRelease |
String |
true |
|
osVersion |
String |
true |
|
externalId |
String |
true |
|
authPolicyId |
String |
true |
|
disabled |
Boolean |
true |
|
disabledAt |
String |
true |
|
disabledUntil |
String |
true |
|
hasApiSession |
Boolean |
true |
|
hasEdgeRouterConnection |
Boolean |
true |
|
lastOnlineAt |
String |
true |
|
syncId |
String |
true |
|
syncResourceId |
String |
true |
|
attributes |
Array[String] |
false |
|
jwt |
String |
true |
|
online |
Boolean |
true |
|
mfaEnabled |
Boolean |
true |
|
jwtExpiresAt |
String |
true |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ6ZGtqNjlzN3N5MUdLNlNlX1pZWnN3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMwYjI2OTU3LTA5ZTctNDgyZS1iYTBhLTYyNzc3OWEzNmM3MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzUzMiwiZXhwIjoxNjc1MzUxMTMyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJmNjBkMDBmLTY3NGUtNGM1ZS1hNTYwLWRiMmIxNDYzMTgzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzUzMn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.imYGffZGzwbqkpxfRJSCQutrz9iDpIliwU2dZgHYocPJlWPRhxBoAQbtehjisY3FjOBZxy8qFxOo6eJFNVXwOn_BFdBTJBizpTVn0F6Um6g6DO09gKgaTiqFFmLNfHFFs2Gpo60trseMhUUVinJa2Q09uYGJHUqZcR4i4rlC-pNFPZDwRllzz6OQKKOlo2_OKCY9VnrKBBWRzSpe8gJqThGpW1-i9Zq2PpnNrWdBOz9LqweqTXZx34BRGGXIpDOshlfc6Jw2oCJmZTPl8YhUzkpRnm4PPwHlogfnf0xm1aUAUAsZVbY5BL6d9mXPipFv2xQsbCKRrCm0r4cF5rmPDA'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 3733
{
"_embedded" : {
"endpointList" : [ {
"id" : "119aa6eb-2ed8-47fc-a4f8-dde648d51063",
"ownerIdentityId" : "79756997-3371-440f-bdb7-47469165ceed",
"createdBy" : "79756997-3371-440f-bdb7-47469165ceed",
"createdAt" : "2023-02-02T14:18:52.848049Z",
"updatedAt" : "2023-02-02T14:18:52.848049Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "9e4d83b4-443a-46ae-ba24-aaed41f8ec01",
"zitiId" : "ziti-id-180",
"name" : "Test Endpoint 2",
"typeId" : "type",
"appId" : "appId",
"appVersion" : "appVersion",
"branch" : "branch",
"revision" : "revision",
"type" : "User",
"version" : "version",
"arch" : "arch",
"os" : "os",
"osRelease" : "osRelease",
"osVersion" : "osVersion",
"hasApiSession" : false,
"hasEdgeRouterConnection" : false,
"lastOnlineAt" : null,
"syncId" : "35840b75-5161-418b-a00e-cc85249c80ea",
"syncResourceId" : "JsOCD1n_MBn8OrtJkO49H",
"attributes" : [ "#attr3", "#attr1" ],
"jwt" : null,
"online" : false,
"mfaEnabled" : false,
"jwtExpiresAt" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/119aa6eb-2ed8-47fc-a4f8-dde648d51063"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/9e4d83b4-443a-46ae-ba24-aaed41f8ec01",
"profile" : "parent"
},
"app-data-usages" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-data-usages?endpointId=119aa6eb-2ed8-47fc-a4f8-dde648d51063"
}
}
}, {
"id" : "19d65061-1c07-46c8-8f12-f16391579b11",
"ownerIdentityId" : "79756997-3371-440f-bdb7-47469165ceed",
"createdBy" : "79756997-3371-440f-bdb7-47469165ceed",
"createdAt" : "2023-02-02T14:18:52.821636Z",
"updatedAt" : "2023-02-02T14:18:52.821636Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "9e4d83b4-443a-46ae-ba24-aaed41f8ec01",
"zitiId" : "ziti-id-178",
"name" : "Test Endpoint 1",
"typeId" : "type",
"appId" : "appId",
"appVersion" : "appVersion",
"branch" : "branch",
"revision" : "revision",
"type" : "User",
"version" : "version",
"arch" : "arch",
"os" : "os",
"osRelease" : "osRelease",
"osVersion" : "osVersion",
"hasApiSession" : false,
"hasEdgeRouterConnection" : false,
"lastOnlineAt" : null,
"syncId" : "f3bb9d4f-279d-45d9-afe4-cf2f258ffab1",
"syncResourceId" : "Q4-yn9z9YGayvc83pJ0fn",
"attributes" : [ "#attr2", "#attr1" ],
"jwt" : null,
"online" : false,
"mfaEnabled" : false,
"jwtExpiresAt" : null,
"_links" : {
"auth-policy" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/auth-policies/17e9f2f4-fb3b-4aeb-805d-9ed6c9b615ce"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/19d65061-1c07-46c8-8f12-f16391579b11"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/9e4d83b4-443a-46ae-ba24-aaed41f8ec01",
"profile" : "parent"
},
"app-data-usages" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-data-usages?endpointId=19d65061-1c07-46c8-8f12-f16391579b11"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints"
}
},
"page" : {
"size" : 3500,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
Create Endpoint
POST /endpoints
Authorization
This endpoint requires create
action on the endpoint
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
networkId |
String |
true |
${reason}. |
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
enrollmentMethod |
Object |
false |
|
enrollmentMethod.ott |
Boolean |
true |
|
enrollmentMethod.updb |
String |
true |
|
enrollmentMethod.ottca |
String |
true |
|
externalId |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
authPolicyId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
syncId |
String |
true |
|
syncResourceId |
String |
true |
|
shareRegistration |
Object |
true |
|
shareRegistration.id |
String |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
shareRegistration.toList |
Array[String] |
false |
|
shareRegistration.ccList |
Array[String] |
true |
|
shareRegistration.subject |
String |
true |
|
shareRegistration.type |
String |
true |
Must be one of [Email]. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
typeId |
String |
true |
|
appId |
String |
true |
|
appVersion |
String |
true |
|
branch |
String |
true |
|
revision |
String |
true |
|
type |
String |
true |
|
version |
String |
true |
|
arch |
String |
true |
|
os |
String |
true |
|
osRelease |
String |
true |
|
osVersion |
String |
true |
|
externalId |
String |
true |
|
authPolicyId |
String |
true |
|
disabled |
Boolean |
true |
|
disabledAt |
String |
true |
|
disabledUntil |
String |
true |
|
hasApiSession |
Boolean |
true |
|
hasEdgeRouterConnection |
Boolean |
true |
|
lastOnlineAt |
String |
true |
|
syncId |
String |
true |
|
syncResourceId |
String |
true |
|
attributes |
Array[String] |
false |
|
jwt |
String |
true |
|
online |
Boolean |
true |
|
mfaEnabled |
Boolean |
true |
|
jwtExpiresAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints' -i -X POST \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJHX2JYbTQ5ZEJ2WlhPVjNZOFR1SUZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJiOTI0ZDM0LTcyMjAtNDQ0YS1hMzlkLTJiZWVlNjAwYzA0NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzYxOCwiZXhwIjoxNjc1MzUxMjE4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImU3MTUyNGU5LTk1NzEtNDEwNy1hYzk0LTllYzMwYmI2MGE5ZlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzYxOH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.a4FH7JlsPTGnUPMGHDKpNcw6gZ7fQvdgwn2fYIBuBEuVy3ZerjMbsthvy_9GQh_T71YY4Y4HIGZbLrrEboFLstMro9SkMTmRip-8krzdjzZZAvzPeoxFR4B3x4owktlUroYrh1-SwUISH7DqE6cHa1f9ZocWRwSLAXVdunmEh6M_QkIRn402bk24qSxSOMnjDU1pg-GYflsUIjXDLeG4iiOrGtzEYWgsg88wkg4VuIXHBN8a9LQgt2jLYU8jqv6-dV7bXa4JSCtQ_IkhK45PLAeD7RrW3-B-hdxe00qdHTIjVKc7TFoY13ZfQoy2CskYoLOvhhvcYjtFVeDGeiFT3g' \
-d '{"networkId":"891427a7-2a4f-487c-8b94-c4cc21fc0b94","name":"Test endpoint 02","enrollmentMethod":{"ott":true,"updb":null,"ottca":null},"attributes":["#clients"],"shareRegistration":{"id":null,"toList":["fake@example.com"],"ccList":null,"subject":"New Endpoint!!","type":null}}'
Example response
HTTP/1.1 202 Accepted
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1228
{
"id" : "c9788ebb-7d3f-49d5-8dca-d0757ea35e90",
"ownerIdentityId" : "bb924d34-7220-444a-a39d-2beee600c044",
"createdBy" : "bb924d34-7220-444a-a39d-2beee600c044",
"createdAt" : "2023-02-02T14:20:18.853366Z",
"updatedAt" : "2023-02-02T14:20:18.853366Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "891427a7-2a4f-487c-8b94-c4cc21fc0b94",
"zitiId" : null,
"name" : "Test endpoint 02",
"typeId" : null,
"appId" : null,
"appVersion" : null,
"branch" : null,
"revision" : null,
"type" : null,
"version" : null,
"arch" : null,
"os" : null,
"osRelease" : null,
"osVersion" : null,
"hasApiSession" : false,
"hasEdgeRouterConnection" : false,
"lastOnlineAt" : null,
"syncId" : null,
"syncResourceId" : null,
"attributes" : [ "#clients" ],
"jwt" : "jwthere",
"online" : false,
"mfaEnabled" : false,
"jwtExpiresAt" : "2023-02-02T14:20:18.829158Z",
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/891427a7-2a4f-487c-8b94-c4cc21fc0b94",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/c9788ebb-7d3f-49d5-8dca-d0757ea35e90"
}
}
}
Patch Endpoint
PATCH /endpoints/{id}
Authorization
This endpoint requires update
action on the endpoint
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
externalId |
Object |
true |
io.netfoundry.common.util.validation.ValidAs. |
authPolicyId |
Object |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
typeId |
String |
true |
|
appId |
String |
true |
|
appVersion |
String |
true |
|
branch |
String |
true |
|
revision |
String |
true |
|
type |
String |
true |
|
version |
String |
true |
|
arch |
String |
true |
|
os |
String |
true |
|
osRelease |
String |
true |
|
osVersion |
String |
true |
|
externalId |
String |
true |
|
authPolicyId |
String |
true |
|
disabled |
Boolean |
true |
|
disabledAt |
String |
true |
|
disabledUntil |
String |
true |
|
hasApiSession |
Boolean |
true |
|
hasEdgeRouterConnection |
Boolean |
true |
|
lastOnlineAt |
String |
true |
|
syncId |
String |
true |
|
syncResourceId |
String |
true |
|
attributes |
Array[String] |
false |
|
jwt |
String |
true |
|
online |
Boolean |
true |
|
mfaEnabled |
Boolean |
true |
|
jwtExpiresAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/18bb0385-397f-4baf-85f7-d83df73cbb51' -i -X PATCH \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJsaC1hSVF5OW0tZDRUcGlOdGtBOEhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjliOWNlYWIzLThkMDUtNDIzYy04NTcxLTAyMmM4NjJjODJjNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzYxOSwiZXhwIjoxNjc1MzUxMjE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjYzMGY5ODE5LWM0YjEtNDIxOC1hNWNhLTMyZmQ2YmZlYzVmNFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzYxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.P2PRz94TdcHi1WZezkq9JZTSRSGlV2Giq6b1uvBOh0cfRSXMj9v3XnAUJ0k39nS13fyHRL8M7gRSXHCSW5oo4CVn2zcDbnubgIP3TVqxax8arfK7N6C7OZxUElR1OZUkiccVWyacYKwmwoqK38_kj8kwhyIsithtQ_rXuih3UP_uzi1-MQjjNiozzTOBcctrz3MyYPuYSPobjmW_NfzvjDU_YESg-Y-i5GGS0kR5emBZ9KYVgfWc9l8dp7VrW4oExCF03Rc4qdkhCe4wZrbYtnL5VxvhaTrcIZVxMxVzfCaOruU0FNbIlS4P5sLz14W_oxRjIrnkJws9WoaGZy4P2w' \
-d '{"name":"Test endpoint 02 updated"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1250
{
"id" : "18bb0385-397f-4baf-85f7-d83df73cbb51",
"ownerIdentityId" : "4fd4ed7c-67db-4172-b38a-7cb56d877e28",
"createdBy" : "4fd4ed7c-67db-4172-b38a-7cb56d877e28",
"createdAt" : "2023-02-02T14:20:19.372173Z",
"updatedAt" : "2023-02-02T14:20:19.428295Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "f474bc0a-a1f8-49dc-a7df-718f71f6e1d5",
"zitiId" : "ziti-id-920",
"name" : "Test endpoint 02 updated",
"typeId" : "type",
"appId" : "appId",
"appVersion" : "appVersion",
"branch" : "branch",
"revision" : "revision",
"type" : "User",
"version" : "version",
"arch" : "arch",
"os" : "os",
"osRelease" : "osRelease",
"osVersion" : "osVersion",
"hasApiSession" : false,
"hasEdgeRouterConnection" : false,
"lastOnlineAt" : null,
"syncId" : null,
"syncResourceId" : null,
"attributes" : [ ],
"jwt" : null,
"online" : false,
"mfaEnabled" : false,
"jwtExpiresAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/f474bc0a-a1f8-49dc-a7df-718f71f6e1d5",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/18bb0385-397f-4baf-85f7-d83df73cbb51"
}
}
}
Delete Endpoint
DELETE /endpoints/{id}
Authorization
This endpoint requires delete
action on the endpoint
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
typeId |
String |
true |
|
appId |
String |
true |
|
appVersion |
String |
true |
|
branch |
String |
true |
|
revision |
String |
true |
|
type |
String |
true |
|
version |
String |
true |
|
arch |
String |
true |
|
os |
String |
true |
|
osRelease |
String |
true |
|
osVersion |
String |
true |
|
externalId |
String |
true |
|
authPolicyId |
String |
true |
|
disabled |
Boolean |
true |
|
disabledAt |
String |
true |
|
disabledUntil |
String |
true |
|
hasApiSession |
Boolean |
true |
|
hasEdgeRouterConnection |
Boolean |
true |
|
lastOnlineAt |
String |
true |
|
syncId |
String |
true |
|
syncResourceId |
String |
true |
|
attributes |
Array[String] |
false |
|
jwt |
String |
true |
|
online |
Boolean |
true |
|
mfaEnabled |
Boolean |
true |
|
jwtExpiresAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/c15078cf-c092-46c5-83c3-8516bef8fd6b' -i -X DELETE \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJsWDJ5XzVFMkRqUlVqUllfRlJQd29BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdmNTA3YjhiLWI5MDUtNDY3Ni1hNzU1LWIxODhjNmM2NTc2MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzYxOSwiZXhwIjoxNjc1MzUxMjE5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI2MWQ1YTAyLTc3NzktNDA0ZS1hNjA3LTNkOTg3ZmM3MDY2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzYxOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.fW9awxI_29Bhmg9MwpD12ytPQtSvgwaiu_Wj6sGKGPwZsJ-XrmG4QYqEa67WpGxGNp4Z_g09QMdE1Wyxx9TuVxttZ7WrlmWTKUBHTdRpJcro9ltOeM07o3leyPOcazrTkVhaKKODG-lA83weBFGnxqS1XUTNMHtMkE7qwBN9rX4JksBg2Z0z0a5ba6srbOXqc1drz1eb4FpOb9DhDMrJlq522vj4yI9GpFis3pmYTvX2q9nJ11QwPcF1Q2YF7wIT0ZuNfhSR4e0Kj8pFTxKMT30r12tyqoaqrVceYxr_sCg2mZkkLiVvLEasd7C4I1o9_C7gBS8wSLVq1M-XV9ryiA'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1294
{
"id" : "c15078cf-c092-46c5-83c3-8516bef8fd6b",
"ownerIdentityId" : "9ce1e9f4-66d7-4643-afd3-85226daab37a",
"createdBy" : "9ce1e9f4-66d7-4643-afd3-85226daab37a",
"createdAt" : "2023-02-02T14:20:19.811924Z",
"updatedAt" : "2023-02-02T14:20:19.832650Z",
"deletedBy" : "7f507b8b-b905-4676-a755-b188c6c65760",
"deletedAt" : "2023-02-02T14:20:19.832Z",
"networkId" : "d2ee2245-3b2b-4233-9a70-9bafda62d804",
"zitiId" : "ziti-id-983",
"name" : "endpoint-982",
"typeId" : "type",
"appId" : "appId",
"appVersion" : "appVersion",
"branch" : "branch",
"revision" : "revision",
"type" : "User",
"version" : "version",
"arch" : "arch",
"os" : "os",
"osRelease" : "osRelease",
"osVersion" : "osVersion",
"hasApiSession" : false,
"hasEdgeRouterConnection" : false,
"lastOnlineAt" : null,
"syncId" : null,
"syncResourceId" : null,
"attributes" : [ ],
"jwt" : null,
"online" : false,
"mfaEnabled" : false,
"jwtExpiresAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/d2ee2245-3b2b-4233-9a70-9bafda62d804",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/c15078cf-c092-46c5-83c3-8516bef8fd6b"
}
}
}
Edge Routers
Find Edge Routers
GET /edge-routers
Authorization
This endpoint requires read
action on the edge-router
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
attributes |
Object |
true |
Deprecated.. |
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
hostId |
String |
true |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
zitiId |
String |
false |
|
domainName |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
productVersion |
Object |
true |
|
networkId |
String |
false |
|
jwt |
String |
true |
|
linkListener |
Boolean |
true |
|
wssListener |
Boolean |
true |
|
tunnelerEnabled |
Boolean |
true |
|
noTraversal |
Boolean |
true |
|
online |
Boolean |
true |
|
verified |
Boolean |
true |
|
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
softwareDeploymentStateId |
String |
true |
|
provider |
String |
true |
Deprecated.. Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER]. |
region |
String |
true |
Deprecated.. |
hostSize |
String |
true |
Deprecated.. |
attributes |
Array[String] |
false |
|
registration |
Object |
true |
|
registration.id |
String |
false |
|
registration.networkId |
String |
false |
|
registration.edgeRouterId |
String |
false |
|
registration.registrationAttempts |
Integer |
true |
|
registration.expiresAt |
String |
false |
|
registration.issuedAt |
String |
false |
|
registration.usedAt |
String |
true |
|
registration.createdAt |
String |
false |
|
registration.createdBy |
String |
false |
|
registration.updatedAt |
String |
false |
|
registration.deletedAt |
String |
true |
|
registration.deletedBy |
String |
false |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
hostId |
String |
true |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
zitiId |
String |
false |
|
domainName |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
productVersion |
Object |
true |
|
networkId |
String |
false |
|
jwt |
String |
true |
|
linkListener |
Boolean |
true |
|
wssListener |
Boolean |
true |
|
tunnelerEnabled |
Boolean |
true |
|
noTraversal |
Boolean |
true |
|
online |
Boolean |
true |
|
verified |
Boolean |
true |
|
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
softwareDeploymentStateId |
String |
true |
|
provider |
String |
true |
Deprecated.. Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER]. |
region |
String |
true |
Deprecated.. |
hostSize |
String |
true |
Deprecated.. |
attributes |
Array[String] |
false |
|
registration |
Object |
true |
|
registration.id |
String |
false |
|
registration.networkId |
String |
false |
|
registration.edgeRouterId |
String |
false |
|
registration.registrationAttempts |
Integer |
true |
|
registration.expiresAt |
String |
false |
|
registration.issuedAt |
String |
false |
|
registration.usedAt |
String |
true |
|
registration.createdAt |
String |
false |
|
registration.createdBy |
String |
false |
|
registration.updatedAt |
String |
false |
|
registration.deletedAt |
String |
true |
|
registration.deletedBy |
String |
false |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJaRmtlbG1XeXlzdmdJVXJhOVBZWF93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUyNjBlODZkLWE5YmMtNGIwZC1hYzVkLWYwZWQ1NTQxMTU5NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzY4MywiZXhwIjoxNjc1MzUxMjgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImFiYzEzZWQ1LTZhM2EtNDlmMy04MzZkLTQxZmQwYzkyMjcyMVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzY4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.aZnX-upjVnmbIZfcX2X10To_OCi0yx_yIZWvyRpk8ViMnBhNa_4UpDIRC6hMysTCDTT3r8lNwZoTqTquugHGwbDHRUAisJAcS5Pzksb_fjYWC2YdbctIKGn3QpQV7GzXh_gPSOhamPOahgdWEShH6Ny5ijsFMk1us9D3R1ebKskn520MWNCOnCFFgx8JVdKP4vLCu9BT4q87oItRgA6Bpzv4CDWWLbRRfkVDWuGpQz0wZHEwO3s-cjrTvm1ZpGXQCpjjm_PxFKkKU3KB84B8DhhVPvOqLASrdhwavHwEhOeaRx0FHNwyBVrPHsuMzj3kU6s2Zs0Q_8nTl-YzfAiOkg'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 4646
{
"_embedded" : {
"edgeRouterList" : [ {
"id" : "067924ed-3ef9-4351-bd24-b9aa7254c2e6",
"hostId" : "a2c9065b-dcbb-461c-a81f-12a56f8b3b17",
"ownerIdentityId" : "7f4bc0c2-2791-4256-ae3a-3e5ffd53b864",
"createdBy" : "7f4bc0c2-2791-4256-ae3a-3e5ffd53b864",
"createdAt" : "2023-02-02T14:21:20.378472Z",
"updatedAt" : "2023-02-02T14:21:20.378472Z",
"deletedBy" : null,
"deletedAt" : null,
"zitiId" : "ziti-id-1561",
"domainName" : null,
"name" : "er-test-1560",
"productVersion" : "7.3.36",
"networkId" : "3d747fc5-8e41-48f4-8e42-03b5ba46c6ac",
"jwt" : "fake-jwt",
"linkListener" : true,
"tunnelerEnabled" : true,
"noTraversal" : false,
"online" : false,
"verified" : false,
"status" : "PROVISIONED",
"softwareDeploymentStateId" : null,
"provider" : "AWS",
"region" : "us-east-1",
"hostSize" : "small",
"attributes" : [ ],
"registration" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/067924ed-3ef9-4351-bd24-b9aa7254c2e6"
},
"host" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts/a2c9065b-dcbb-461c-a81f-12a56f8b3b17"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/3d747fc5-8e41-48f4-8e42-03b5ba46c6ac",
"profile" : "parent"
}
}
}, {
"id" : "08ee01d7-5024-4555-83a2-32584d618906",
"hostId" : "fb40b7e1-16a5-40f8-8d6b-4355e540e30e",
"ownerIdentityId" : "e124c8a6-a0ec-49d3-b351-fd219f6a1d42",
"createdBy" : "e124c8a6-a0ec-49d3-b351-fd219f6a1d42",
"createdAt" : "2023-02-02T14:21:20.494328Z",
"updatedAt" : "2023-02-02T14:21:20.494328Z",
"deletedBy" : null,
"deletedAt" : null,
"zitiId" : "ziti-id-1576",
"domainName" : null,
"name" : "er-test-1575",
"productVersion" : "7.3.36",
"networkId" : "2f94d51a-5f3b-4e96-af14-b5911c8ff689",
"jwt" : null,
"linkListener" : true,
"tunnelerEnabled" : true,
"noTraversal" : false,
"online" : false,
"verified" : true,
"status" : "PROVISIONED",
"softwareDeploymentStateId" : null,
"provider" : "AWS",
"region" : "us-east-1",
"hostSize" : "small",
"attributes" : [ ],
"registration" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/08ee01d7-5024-4555-83a2-32584d618906"
},
"host" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts/fb40b7e1-16a5-40f8-8d6b-4355e540e30e"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/2f94d51a-5f3b-4e96-af14-b5911c8ff689",
"profile" : "parent"
}
}
}, {
"id" : "0ae7f163-42b5-4cba-b8a3-965ff5fbbddb",
"hostId" : "e06c43d7-4008-4a4d-8906-d78ad4da58ec",
"ownerIdentityId" : "138056dd-794d-4894-a2d0-dc7b44e069e0",
"createdBy" : "138056dd-794d-4894-a2d0-dc7b44e069e0",
"createdAt" : "2023-02-02T14:21:23.788756Z",
"updatedAt" : "2023-02-02T14:21:23.816963Z",
"deletedBy" : null,
"deletedAt" : null,
"zitiId" : "ziti-id-2018",
"domainName" : null,
"name" : "er-test-2017",
"productVersion" : "7.3.36",
"networkId" : "ba041c00-58e7-440b-addb-3c81b44a251f",
"jwt" : null,
"linkListener" : true,
"tunnelerEnabled" : true,
"noTraversal" : false,
"online" : false,
"verified" : true,
"status" : "ERROR",
"softwareDeploymentStateId" : null,
"provider" : "AWS",
"region" : "us-east-1",
"hostSize" : "small",
"attributes" : [ ],
"registration" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/0ae7f163-42b5-4cba-b8a3-965ff5fbbddb"
},
"host" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts/e06c43d7-4008-4a4d-8906-d78ad4da58ec"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/ba041c00-58e7-440b-addb-3c81b44a251f",
"profile" : "parent"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers"
}
},
"page" : {
"size" : 3500,
"totalElements" : 115,
"totalPages" : 1,
"number" : 0
}
}
Get Edge Router
GET /edge-routers/{id}
Authorization
This endpoint requires read
action on the edge-router
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
hostId |
String |
true |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
zitiId |
String |
false |
|
domainName |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
productVersion |
Object |
true |
|
networkId |
String |
false |
|
jwt |
String |
true |
|
linkListener |
Boolean |
true |
|
wssListener |
Boolean |
true |
|
tunnelerEnabled |
Boolean |
true |
|
noTraversal |
Boolean |
true |
|
online |
Boolean |
true |
|
verified |
Boolean |
true |
|
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
softwareDeploymentStateId |
String |
true |
|
provider |
String |
true |
Deprecated.. Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER]. |
region |
String |
true |
Deprecated.. |
hostSize |
String |
true |
Deprecated.. |
attributes |
Array[String] |
false |
|
registration |
Object |
true |
|
registration.id |
String |
false |
|
registration.networkId |
String |
false |
|
registration.edgeRouterId |
String |
false |
|
registration.registrationAttempts |
Integer |
true |
|
registration.expiresAt |
String |
false |
|
registration.issuedAt |
String |
false |
|
registration.usedAt |
String |
true |
|
registration.createdAt |
String |
false |
|
registration.createdBy |
String |
false |
|
registration.updatedAt |
String |
false |
|
registration.deletedAt |
String |
true |
|
registration.deletedBy |
String |
false |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/993c8f2f-9511-404c-9707-ee5b120ff42b' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJZY2wxSGMtU3E4emNBbE1WeTRnLW9RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE0ZDg0ZDMzLTZlMGEtNDE1Mi05OGNjLTYxYjI0MDg3Mzc0YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzY4NCwiZXhwIjoxNjc1MzUxMjg0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ5NGEwMWFmLTRjZTAtNDg1NS04MzdkLTBhMzI4MDQyYWEyYlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzY4NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.C2hzzGRVKZXAJmdYMerScPx_qdEE8-G5BvR_g4dwqSWh817vyDxtLv4WTYQlidYPy5XupwRTmDuV9spZWOiYQyLtgZdo2S8TevmPvQ0PL5GC5VROsCR9QcQXgcMjXPrhFnWllUn46fcjW1N7zcInk0lA8tbMw9nj9DH0QZloY7x_mm7gZruoHLZZ1qA7dfOaWVvRzt6ICF6vQnZqQ99UM4kqf3Un3UhVvmm1c0maZvFpvc7DpLCw4rInSR6eWa7BSRHi59Zax75QQyTnzpmHu-xECHZQnOt6rGTMQlxeygObccaVv3PtGrcddxWWkDkKfLqwDRzvwrFn5t3BvFppKg'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1299
{
"id" : "993c8f2f-9511-404c-9707-ee5b120ff42b",
"hostId" : "7a23877a-a9c0-4739-a23d-61291d75aebb",
"ownerIdentityId" : "bd5fccfb-66f4-4af1-a878-b43efe1ba1db",
"createdBy" : "bd5fccfb-66f4-4af1-a878-b43efe1ba1db",
"createdAt" : "2023-02-02T14:21:24.796268Z",
"updatedAt" : "2023-02-02T14:21:24.796268Z",
"deletedBy" : null,
"deletedAt" : null,
"zitiId" : "ziti-id-2090",
"domainName" : null,
"name" : "er-test-2089",
"productVersion" : "7.3.36",
"networkId" : "8b3692a4-5eca-4d4d-977d-530125e2fb3b",
"jwt" : null,
"linkListener" : true,
"tunnelerEnabled" : true,
"noTraversal" : false,
"online" : false,
"verified" : true,
"status" : "PROVISIONED",
"softwareDeploymentStateId" : null,
"provider" : "AWS",
"region" : "us-east-1",
"hostSize" : "small",
"attributes" : [ ],
"registration" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/993c8f2f-9511-404c-9707-ee5b120ff42b"
},
"host" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts/7a23877a-a9c0-4739-a23d-61291d75aebb"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/8b3692a4-5eca-4d4d-977d-530125e2fb3b",
"profile" : "parent"
}
}
}
Create Edge Router
POST /edge-routers
Authorization
This endpoint requires create
action on the edge-router
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
dataCenterId |
String |
true |
Deprecated.. |
provider |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
region |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
hostSize |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
linkListener |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
wssListener |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
tunnelerEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
noTraversal |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
hostId |
String |
true |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
zitiId |
String |
false |
|
domainName |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
productVersion |
Object |
true |
|
networkId |
String |
false |
|
jwt |
String |
true |
|
linkListener |
Boolean |
true |
|
wssListener |
Boolean |
true |
|
tunnelerEnabled |
Boolean |
true |
|
noTraversal |
Boolean |
true |
|
online |
Boolean |
true |
|
verified |
Boolean |
true |
|
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
softwareDeploymentStateId |
String |
true |
|
provider |
String |
true |
Deprecated.. Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER]. |
region |
String |
true |
Deprecated.. |
hostSize |
String |
true |
Deprecated.. |
attributes |
Array[String] |
false |
|
registration |
Object |
true |
|
registration.id |
String |
false |
|
registration.networkId |
String |
false |
|
registration.edgeRouterId |
String |
false |
|
registration.registrationAttempts |
Integer |
true |
|
registration.expiresAt |
String |
false |
|
registration.issuedAt |
String |
false |
|
registration.usedAt |
String |
true |
|
registration.createdAt |
String |
false |
|
registration.createdBy |
String |
false |
|
registration.updatedAt |
String |
false |
|
registration.deletedAt |
String |
true |
|
registration.deletedBy |
String |
false |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/' -i -X POST \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJLakpxMHB0eExNc3VxV1RIUWhFSl93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjMxZDRiZmMwLWFkODEtNGY2YS05OGU5LWQyMDBmOWVkMzNkZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzY4MiwiZXhwIjoxNjc1MzUxMjgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImI1MmYyMDdjLWRhZDQtNDhhNS1hZGU0LWZhMjY4NjZhMzBhYlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzY4Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.esNB260DCz4fH1kq0_Z6tI57oHD7kSi23C9SVBxHIMRCizvveQK5Qf1Geh5xn1YOeSH6_FESMNCBXJP3ZQZjQFBKKcpVxz4jhkFJRrs3CAZF_w0v_9snPOItcSCYOD5VaoIkE2s8qnrXLiJNg5JRzQOgyCn5LNw8Ovu5F06UWltFWTcArVU1l9qJWrq2NW_0YL7ABW00bzhJvN7lcRkvk0c3dIbaRQmOsb0rZoPud14JsVDjIm_xbos8fxT7uCqEBVi0uHd53tqUeC8hBZhHSf4G_VQ5QGMUkIhBnj22cGBpqp0OtE0iQ-vZMXGFrv-3Ro17365C9dm5cbagqEjXmg' \
-d '{"name":"Test edge router 1675347682","networkId":"c6f0d3c2-f366-421c-81fb-0edbe79de7ee","provider":"AWS","region":"us-east-1","attributes":[]}'
Example response
HTTP/1.1 202 Accepted
X-NF-deprecated-property: dataCenterId; removal 1/1/2023; see https://gateway.production.netfoundry.io/core/v2/docs/index.html#resources-edge-routers-get-edge-routers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1123
{
"id" : "0bed41f4-3bcf-425d-be17-abd58e3ade13",
"hostId" : null,
"ownerIdentityId" : "31d4bfc0-ad81-4f6a-98e9-d200f9ed33de",
"createdBy" : "31d4bfc0-ad81-4f6a-98e9-d200f9ed33de",
"createdAt" : "2023-02-02T14:21:22.289948Z",
"updatedAt" : "2023-02-02T14:21:22.289948Z",
"deletedBy" : null,
"deletedAt" : null,
"zitiId" : null,
"domainName" : null,
"name" : "Test edge router 1675347682",
"productVersion" : "7.3.36",
"networkId" : "c6f0d3c2-f366-421c-81fb-0edbe79de7ee",
"jwt" : null,
"linkListener" : false,
"tunnelerEnabled" : false,
"noTraversal" : false,
"online" : false,
"verified" : false,
"status" : "NEW",
"softwareDeploymentStateId" : null,
"provider" : null,
"region" : null,
"hostSize" : null,
"attributes" : [ ],
"registration" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/0bed41f4-3bcf-425d-be17-abd58e3ade13"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/c6f0d3c2-f366-421c-81fb-0edbe79de7ee",
"profile" : "parent"
}
}
}
Update Edge Router
PATCH /edge-routers/{id}
Authorization
This endpoint requires update
action on the edge-router
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
noTraversal |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
hostId |
String |
true |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
zitiId |
String |
false |
|
domainName |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
productVersion |
Object |
true |
|
networkId |
String |
false |
|
jwt |
String |
true |
|
linkListener |
Boolean |
true |
|
wssListener |
Boolean |
true |
|
tunnelerEnabled |
Boolean |
true |
|
noTraversal |
Boolean |
true |
|
online |
Boolean |
true |
|
verified |
Boolean |
true |
|
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
softwareDeploymentStateId |
String |
true |
|
provider |
String |
true |
Deprecated.. Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER]. |
region |
String |
true |
Deprecated.. |
hostSize |
String |
true |
Deprecated.. |
attributes |
Array[String] |
false |
|
registration |
Object |
true |
|
registration.id |
String |
false |
|
registration.networkId |
String |
false |
|
registration.edgeRouterId |
String |
false |
|
registration.registrationAttempts |
Integer |
true |
|
registration.expiresAt |
String |
false |
|
registration.issuedAt |
String |
false |
|
registration.usedAt |
String |
true |
|
registration.createdAt |
String |
false |
|
registration.createdBy |
String |
false |
|
registration.updatedAt |
String |
false |
|
registration.deletedAt |
String |
true |
|
registration.deletedBy |
String |
false |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/20147bcd-ae4c-47c9-8f60-8d4b3ab0285a' -i -X PATCH \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJmNnNPS0ZqWk84bVBkMnN6SWVUbGZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhlODUxYWJjLTI2ZjgtNDc1NS1iNDhjLTcyZjA2MWRkNjczYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzY4NCwiZXhwIjoxNjc1MzUxMjg0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFjNDY1NGMzLTZkMGUtNDdkMi1iYWE5LTY2YjBmOTZjYTUzOVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzY4NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.EoRs-6fKQfWxJotnxxmqc0cZON7PmuO-MpDpdxfQ2xgRfg0fShG_hgWQdrJI2i-bDkwp7Ftf6k_fvRkMb5thwZAjuAFb4sXQ23q0OxhCzAzShTkq7cdjFBoTe_71I7k3hX1SoEkIeI2drF0JWks8JVPdJBiB1r9WSWXmxMkHJYYPx_RBEj942gDHtmmgB2TxHiln9G6rUfcx0YKaOSWrpY7B-4xcbxIYR2psRLiWvQATQUaLTAGyjcyE35ornsAKQnJhQpeYDgUl70vnX_QxXKDmriqpKvqSIZzEvkCuqX_PwGQX9qMYZ1JuWFyy1PFGTyvitGmlyHgMKDmEBbNWjg' \
-d '{"name":"Updated name"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1299
{
"id" : "20147bcd-ae4c-47c9-8f60-8d4b3ab0285a",
"hostId" : "4bfa3756-4b6b-4aa8-ae58-6b056b452dc9",
"ownerIdentityId" : "31aaa5de-7689-4657-bb48-23a1e3468616",
"createdBy" : "31aaa5de-7689-4657-bb48-23a1e3468616",
"createdAt" : "2023-02-02T14:21:24.711060Z",
"updatedAt" : "2023-02-02T14:21:24.729332Z",
"deletedBy" : null,
"deletedAt" : null,
"zitiId" : "ziti-id-2072",
"domainName" : null,
"name" : "Updated name",
"productVersion" : "7.3.36",
"networkId" : "4037cea2-7bfe-4841-a59d-ab696f5c6a35",
"jwt" : null,
"linkListener" : true,
"tunnelerEnabled" : true,
"noTraversal" : false,
"online" : false,
"verified" : true,
"status" : "PROVISIONED",
"softwareDeploymentStateId" : null,
"provider" : "AWS",
"region" : "us-east-1",
"hostSize" : "small",
"attributes" : [ ],
"registration" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/20147bcd-ae4c-47c9-8f60-8d4b3ab0285a"
},
"host" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts/4bfa3756-4b6b-4aa8-ae58-6b056b452dc9"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/4037cea2-7bfe-4841-a59d-ab696f5c6a35",
"profile" : "parent"
}
}
}
Delete Edge Router
DELETE /edge-routers/{id}
Authorization
This endpoint requires delete
action on the edge-router
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
hostId |
String |
true |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
zitiId |
String |
false |
|
domainName |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
productVersion |
Object |
true |
|
networkId |
String |
false |
|
jwt |
String |
true |
|
linkListener |
Boolean |
true |
|
wssListener |
Boolean |
true |
|
tunnelerEnabled |
Boolean |
true |
|
noTraversal |
Boolean |
true |
|
online |
Boolean |
true |
|
verified |
Boolean |
true |
|
status |
String |
false |
Must be one of [NEW, PROVISIONING, PROVISIONED, ERROR, UPDATING, SUSPENDED, REPLACING, DELETING, DELETED]. |
softwareDeploymentStateId |
String |
true |
|
provider |
String |
true |
Deprecated.. Must be one of [AWS, AZURE, GCP, ALICLOUD, NETFOUNDRY, OCI, OCP, CUSTOMER]. |
region |
String |
true |
Deprecated.. |
hostSize |
String |
true |
Deprecated.. |
attributes |
Array[String] |
false |
|
registration |
Object |
true |
|
registration.id |
String |
false |
|
registration.networkId |
String |
false |
|
registration.edgeRouterId |
String |
false |
|
registration.registrationAttempts |
Integer |
true |
|
registration.expiresAt |
String |
false |
|
registration.issuedAt |
String |
false |
|
registration.usedAt |
String |
true |
|
registration.createdAt |
String |
false |
|
registration.createdBy |
String |
false |
|
registration.updatedAt |
String |
false |
|
registration.deletedAt |
String |
true |
|
registration.deletedBy |
String |
false |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/66736ce6-1d84-4b83-9785-1ffa4d2209c7' -i -X DELETE \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDS240NTgwZWpaUUlIejVUSWFBbXhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAxYmE1ZGFmLTE2NjMtNDY1OC04MDgyLWRjMTVmY2ZjMmZjZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzY4MywiZXhwIjoxNjc1MzUxMjgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM2ZTM4NzJlLTQ2Y2YtNDY1Mi05ZDg3LTA5M2ViZmFlOWQ0NFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzY4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.dtIWHCMH_5Q4Vs2xpwlc8E0kF5kAnAWi1k56T7uGZF4lXMYiZokURu1dLk8FV-jpwiWFrjfYgHTVwShRNvNz2hgFMyrX-mAtCmLTnSN3RXd80VrnnQgFcyF-lkn_Tv4acOI3MXe6FKJa5WFzOGhooElT5RXFMyijAVihHMN9i1h3hwnEeKn02NILQh7AGkpoiXIChnZZ3b3xGfFNhX9Ya7qVyZu9hTodjD0bRSMH2Djdc970LbtybPDxJ0jPZ3VZcXSVAFU-T7GFKvucKSoB96qBFtEwBYs4pHW8TvHwBiXpYQ6TOc447eastX1E3GYs3VIuXwWnJ5zSEbgHMUDSiw'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1330
{
"id" : "66736ce6-1d84-4b83-9785-1ffa4d2209c7",
"hostId" : "a605c6a9-f99f-4aaf-9476-9333b23ad010",
"ownerIdentityId" : "d4a98b27-a3f4-4ba0-9b2b-b6f0b8c3e853",
"createdBy" : "d4a98b27-a3f4-4ba0-9b2b-b6f0b8c3e853",
"createdAt" : "2023-02-02T14:21:23.227346Z",
"updatedAt" : "2023-02-02T14:21:23.255584Z",
"deletedBy" : "01ba5daf-1663-4658-8082-dc15fcfc2fce",
"deletedAt" : null,
"zitiId" : "ziti-id-1921",
"domainName" : null,
"name" : "er-test-1920",
"productVersion" : "7.3.36",
"networkId" : "b15d73e2-d176-4162-8a18-80181f3ee24e",
"jwt" : null,
"linkListener" : true,
"tunnelerEnabled" : true,
"noTraversal" : false,
"online" : false,
"verified" : true,
"status" : "DELETING",
"softwareDeploymentStateId" : null,
"provider" : "AWS",
"region" : "us-east-1",
"hostSize" : "small",
"attributes" : [ ],
"registration" : null,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/66736ce6-1d84-4b83-9785-1ffa4d2209c7"
},
"host" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/hosts/a605c6a9-f99f-4aaf-9476-9333b23ad010"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/b15d73e2-d176-4162-8a18-80181f3ee24e",
"profile" : "parent"
}
}
}
Edge Router Policies
Find Edge Router Policies
GET /edge-router-policies
Authorization
This endpoint requires read
action on the edge-router-policy
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
isSystem |
Boolean |
false |
|
semantic |
String |
false |
Must be one of [AllOf, AnyOf]. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
edgeRouterAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
exclusiveType |
String |
true |
Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy]. |
ownerIdentityId |
String |
true |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
isSystem |
Boolean |
false |
|
semantic |
String |
false |
Must be one of [AllOf, AnyOf]. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
edgeRouterAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
exclusiveType |
String |
true |
Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy]. |
ownerIdentityId |
String |
true |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJlZ3JvODhESENLLThYRktqRHZqMDdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhhY2Q0NDQ0LWVkZTMtNGMxYS1iZDFhLTZmZDNmYzViNmYyNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3NywiZXhwIjoxNjc1MzUxMTc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjMwNDUxNWFlLWZjNDAtNDg0Yi1iYzgzLTdhNWUxNzgzYTU0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.lXhgpVeDXsCUeELD9nRHkK2GB35AWpdn7fVi-B3YNnahZNOHc9FFsCxJSw9AIrJPT-D5pwtvIxCA6oaY5NcPkRKFhX9GO7jvHaFS-LRWjLEQ_hsghWVhHDCPQKKXmtzkdU2_aFWA9kbyVapSbmS8sHtPYSkKwxBqW6qECiUKoqybSQuqdU-hDMKBNyIUVJ1zKfoNG0C8fp4xGK_fVAsiIrnlyYp-X39KRPI6wQZEESsDoCV73D7lxH9DtMmz00WZf6HMASUXZbsOH9vj1mPX8RFxrQcHq-BNWvhOkNeMFk4F2v_xrzCAZeIGppiujNkbOcQG25MWapA9hnft8MfWFw'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2308
{
"_embedded" : {
"edgeRouterPolicyList" : [ {
"id" : "1c5717b6-f4a4-4953-ab27-0dc408ae1899",
"networkId" : "974b294f-b6b1-4bb0-8b6e-975449ddccfd",
"zitiId" : "830975d3-7915-4636-996b-cbad4690918d",
"name" : "PSnxR37Av_-ZpheNBUWXT",
"isSystem" : false,
"semantic" : "AnyOf",
"endpointAttributes" : [ ],
"edgeRouterAttributes" : [ ],
"exclusiveType" : null,
"ownerIdentityId" : "8298f00e-446c-4987-880b-e38d57fec735",
"createdBy" : "8298f00e-446c-4987-880b-e38d57fec735",
"createdAt" : "2023-02-02T14:19:37.028262Z",
"updatedAt" : "2023-02-02T14:19:37.028262Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/974b294f-b6b1-4bb0-8b6e-975449ddccfd",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/1c5717b6-f4a4-4953-ab27-0dc408ae1899"
}
}
}, {
"id" : "aad3bdf3-87fe-4c84-a21e-044df613952e",
"networkId" : "d23b831b-e419-479a-96fd-1e08f8751f87",
"zitiId" : "05a4f980-8720-4a97-ba07-a41d48e80ef1",
"name" : "erp-396",
"isSystem" : false,
"semantic" : "AnyOf",
"endpointAttributes" : [ ],
"edgeRouterAttributes" : [ ],
"exclusiveType" : null,
"ownerIdentityId" : "59710526-5c8c-48c1-a5bb-88f1b3f96d76",
"createdBy" : "59710526-5c8c-48c1-a5bb-88f1b3f96d76",
"createdAt" : "2023-02-02T14:19:15.067545Z",
"updatedAt" : "2023-02-02T14:19:15.067545Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/d23b831b-e419-479a-96fd-1e08f8751f87",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/aad3bdf3-87fe-4c84-a21e-044df613952e"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies"
}
},
"page" : {
"size" : 3500,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
Get Edge Router Policy
GET /edge-router-policies/{id}
Authorization
This endpoint requires read
action on the edge-router-policy
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
isSystem |
Boolean |
false |
|
semantic |
String |
false |
Must be one of [AllOf, AnyOf]. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
edgeRouterAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
exclusiveType |
String |
true |
Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy]. |
ownerIdentityId |
String |
true |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/4036297e-37dc-41fa-9b13-f50856a5408b' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ3TldPSmJiUGw3M3lleWo4Y1dqWl9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZmZTRmOTcwLTBlZmUtNDQ1MC1hNDgzLTY5ZWM4ZjI3NWU1NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3NywiZXhwIjoxNjc1MzUxMTc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ4Yzk0OThkLWUyZTgtNDc3Yi1iNjBlLTk1YjlkNDM0Y2I4YlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.q_dfvM_AIU3522ew_vmGBzPhKLn2CvlGMJoBvjy2plODOaBXJC_QTIyoC-3rf2Fp00wfckW1kATi9fsqgGUgVJ-ifAsrUz1-GyEJd6vBXxLcFObQFn7P3kcCM2ENC6Y7Kun2tqD72xwpJy_U25rgI3_xwku5XwPoddBe0ODsSID4tgj2y-yzmMMFYxIg1OX1HvwuCbhHwkjNgAieAl5OTaI0fBbPpY3KJiiYkfeK9KzKoagATaQVWrJifBYmS3HMOIpysrIP_lbFBGDFfTwB_Pan0U8cMZrljJF6gYLE6RrnTVrByWPTOgrSrRvspUdppz5L-i9Q9M-MucsSlcyScg'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 902
{
"id" : "4036297e-37dc-41fa-9b13-f50856a5408b",
"networkId" : "348c887a-63e5-4b0d-913c-298b553a128e",
"zitiId" : "47dddfc2-a198-45ed-95c0-c9fccb4107a2",
"name" : "erp-554",
"isSystem" : false,
"semantic" : "AnyOf",
"endpointAttributes" : [ ],
"edgeRouterAttributes" : [ ],
"exclusiveType" : null,
"ownerIdentityId" : "7516d903-e936-4a49-9e89-d2a34af97aa8",
"createdBy" : "7516d903-e936-4a49-9e89-d2a34af97aa8",
"createdAt" : "2023-02-02T14:19:37.321356Z",
"updatedAt" : "2023-02-02T14:19:37.321356Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/348c887a-63e5-4b0d-913c-298b553a128e",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/4036297e-37dc-41fa-9b13-f50856a5408b"
}
}
}
Create Edge Router Policy
POST /edge-router-policies
Authorization
This endpoint requires create
action on the edge-router-policy
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
false |
io.netfoundry.common.util.validation.ValidAs. |
networkId |
String |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
semantic |
String |
false |
io.netfoundry.common.util.validation.ValidAs. |
endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouterAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
isSystem |
Boolean |
false |
|
semantic |
String |
false |
Must be one of [AllOf, AnyOf]. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
edgeRouterAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
exclusiveType |
String |
true |
Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy]. |
ownerIdentityId |
String |
true |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies' -i -X POST \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxamI1dTQ5SkRRMHo3QURTMWhpZjFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQzNmQ3YjA2LTY5MmEtNGJhOS05N2MxLThjODlhNDIzNWViNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3NywiZXhwIjoxNjc1MzUxMTc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ5MGMyYzg2LWIxYTUtNDk5YS1hYmZhLWQ2ZmY5MDg1Y2M3N1wiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.i6r7JYjAHmCHHrG48CUvFYNkbQRgJSag8o67BSSzzgarjJjuTTVTvWJV2Jb-tKlRcpd-hXeJdKQyS8x138tsjpnK5dtjkqfOPUsJfRFum0KdWrfRnNL5DgTpq7xJu5DEvNuJLyHh060fHR-0t4szOBodIwUGvu_w7RSU5GMJ37Ren-JK-L140AlV4_73gZYl7swE2f0AAmnjn0R49ODW8VRh_BjRuP3cwiosu_LxmrsNe5e22JWpih-sP29MkV8n6kaI4Ch9gyltOX1hxHQzeV75eYZZ5tYlbbQ42EAvjz6zIHp4gWWvzN8BkBykYpwzjZToh2ZTjkRONHi0g2s2Cw' \
-d '{"name":"Test edge router policy 1675347577","networkId":"021fd378-ce8c-463f-9d68-18c291e2cf7b","semantic":"AnyOf","endpointAttributes":["#topclients"],"edgeRouterAttributes":["#westrouters"]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1151
{
"id" : "9a29e83c-56e4-472d-9c90-d0b7e3214177",
"networkId" : "021fd378-ce8c-463f-9d68-18c291e2cf7b",
"zitiId" : "ziti.id.3bw0yfbc7ea",
"name" : "Test edge router policy 1675347577",
"isSystem" : false,
"semantic" : "AnyOf",
"endpointAttributes" : [ "#topclients" ],
"edgeRouterAttributes" : [ "#westrouters" ],
"exclusiveType" : null,
"ownerIdentityId" : "d36d7b06-692a-4ba9-97c1-8c89a4235eb6",
"createdBy" : "d36d7b06-692a-4ba9-97c1-8c89a4235eb6",
"createdAt" : "2023-02-02T14:19:37.148800Z",
"updatedAt" : "2023-02-02T14:19:37.215553Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/021fd378-ce8c-463f-9d68-18c291e2cf7b",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/9a29e83c-56e4-472d-9c90-d0b7e3214177"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/d66755d1-aab4-436b-b215-0d2885b790a7",
"title" : "Create EdgeRouterPolicy",
"profile" : "meta"
}
}
}
Update Edge Router Policy
PUT /edge-router-policies/{id}
Authorization
This endpoint requires update
action on the edge-router-policy
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
semantic |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
edgeRouterAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
isSystem |
Boolean |
false |
|
semantic |
String |
false |
Must be one of [AllOf, AnyOf]. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
edgeRouterAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
exclusiveType |
String |
true |
Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy]. |
ownerIdentityId |
String |
true |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/94e495aa-6457-421d-9b9d-74fc879175bb' -i -X PUT \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJKTDU3UVYtOFRlNWZ3Yy1zSzhJQzBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQwYzQzNDFlLTA4YjItNDgwZS1iZTg3LTMyYjM4OWM4OTI0MSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3OCwiZXhwIjoxNjc1MzUxMTc4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjczMWU2NGM0LWY2MzAtNGJiYi04ZTgzLTc3NjU0Zjg1NzFlMVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.f2PqIzVLPtg2tFoDK38l18ztuXuXdqxtidqxYA9_ybF2QBoBTkI2KnloqF2bYg9lBpXMjwlcDUcToSpDLjCNjafthC4rca6XUAOaw53ebrZ6Yob9RdVWWPhbHHNW8cMG7REHgWcnmBTsPEGZz4PBkXnBoFM6L1ruSxthaLtPbpzMeg9zEyHRhHYwZ-vDPMJfMFLGurmTYHMTRpDuit8UEoWJu_Gm0j7IhKPDSY7Szja5qGXoRoSJniHgo96Q_XaJsIxUTt01MJ4doe0f0weXHws_BqWcd3QfkmAQRM4guoBjXF0i2scAvv6hxbOgkCDh8aMZClrI3x5-Qg3_uHcWzQ' \
-d '{"name":"Updated edge router policy name","semantic":"AnyOf","endpointAttributes":["#topclients"],"edgeRouterAttributes":["#westrouters"]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1148
{
"id" : "94e495aa-6457-421d-9b9d-74fc879175bb",
"networkId" : "e963853e-dce1-4b6b-898a-8c0029513b32",
"zitiId" : "ziti.id.3bw0yzc2aa8",
"name" : "Updated edge router policy name",
"isSystem" : false,
"semantic" : "AnyOf",
"endpointAttributes" : [ "#topclients" ],
"edgeRouterAttributes" : [ "#westrouters" ],
"exclusiveType" : null,
"ownerIdentityId" : "2cbecfe2-bc09-4594-b412-9c74d05f4d49",
"createdBy" : "2cbecfe2-bc09-4594-b412-9c74d05f4d49",
"createdAt" : "2023-02-02T14:19:38.333155Z",
"updatedAt" : "2023-02-02T14:19:38.566699Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/e963853e-dce1-4b6b-898a-8c0029513b32",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/94e495aa-6457-421d-9b9d-74fc879175bb"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/8016a3cd-0633-449c-8dfb-f2c6feed41ce",
"title" : "Update EdgeRouterPolicy",
"profile" : "meta"
}
}
}
Delete Edge Router Policy
DELETE /edge-router-policies/{id}
Authorization
This endpoint requires delete
action on the edge-router-policy
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
isSystem |
Boolean |
false |
|
semantic |
String |
false |
Must be one of [AllOf, AnyOf]. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
edgeRouterAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
exclusiveType |
String |
true |
Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy]. |
ownerIdentityId |
String |
true |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/827a8499-f3c8-44cd-aa34-06935c3ec420' -i -X DELETE \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfMDdPUV9NNkpVWTZSMjloQUdrZkVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU2MzBlYTZiLTZhNTktNDVlMC05MDlhLWY1M2I1OTRiNWI5OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3NywiZXhwIjoxNjc1MzUxMTc3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgyOGQ4ODY5LWViMjctNDE3Yi05NTQ0LTg2MDM1NTFkYTg1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.UpkHbOxlbMfThJNiavztsQcRgRzsyLXTUmuFb9nhOLIANgRPioNQHXulcsRbGOn-0l5vPOD5TGCZpdFT4G-RHOYhN4PEYB2TEWhNfBWRpvS7bhxFuboPVVqXZZEHHwgB6EGETIO1sw8JZQB3Y-6eYmm8aBQXF1phJ0LyrW1xTTc99ncEtE1LjVwwzcAF-d3TrM1KCuqNG0g4yE5tOcPIpB1FmxL4ut6kAZ11pELQTfsifKAiksEXhbEIXXIEisnXmMwwWCK5C-awwDRW8Nznt8JEznJ-8Bfk38yW9t6jvDhpiK5_Miy2mh-xVp2B2FdtMIWZtJbXBgYLqIUIyDgvHQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1178
{
"id" : "827a8499-f3c8-44cd-aa34-06935c3ec420",
"networkId" : "cc28a206-dee7-479b-b8a3-5f7d1f6816b4",
"zitiId" : "ziti.id.3bw0ypt61x1",
"name" : "Test edge router policy 1675347577",
"isSystem" : false,
"semantic" : "AnyOf",
"endpointAttributes" : [ ],
"edgeRouterAttributes" : [ ],
"exclusiveType" : null,
"ownerIdentityId" : "47a10960-e559-455f-84ac-4df0b7f46391",
"createdBy" : "47a10960-e559-455f-84ac-4df0b7f46391",
"createdAt" : "2023-02-02T14:19:37.783706Z",
"updatedAt" : "2023-02-02T14:19:37.952945Z",
"deletedBy" : "5630ea6b-6a59-45e0-909a-f53b594b5b98",
"deletedAt" : "2023-02-02T14:19:37.952Z",
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/cc28a206-dee7-479b-b8a3-5f7d1f6816b4",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/827a8499-f3c8-44cd-aa34-06935c3ec420"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/6ff6f19d-2be0-4056-922d-e649797645e4",
"title" : "Delete EdgeRouterPolicy",
"profile" : "meta"
}
}
}
Find Edge Router Policies
GET /edge-router-policies
Authorization
This endpoint requires read
action on the edge-router-policy
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
isSystem |
Boolean |
false |
|
semantic |
String |
false |
Must be one of [AllOf, AnyOf]. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
edgeRouterAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
exclusiveType |
String |
true |
Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy]. |
ownerIdentityId |
String |
true |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
isSystem |
Boolean |
false |
|
semantic |
String |
false |
Must be one of [AllOf, AnyOf]. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
edgeRouterAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
exclusiveType |
String |
true |
Must be one of [app-wan, endpoint, service, edge-router, edge-router-policy, certificate-authority, posture-check, service-edge-router-policy]. |
ownerIdentityId |
String |
true |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ1X1pNT0tZVVotS0NPcEc5UWNtc1dnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk0OTAyNjRhLTdlZWItNDgzNS04YWM4LWNhYjEwMTE4ZDlmMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzQ4NywiZXhwIjoxNjc1MzUxMDg3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdlZjkzZjUwLTlkNDUtNDM0OC1iOTE1LTY0MzkzYTM4NzhjY1wiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzQ4N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ljEmIULRRQ1Kc4h8t9IG9W6dU66Aag3zg-UNPm6czyhUoi8xRWqQL7xu7OPy-s0Txgulxswx6SmY_MxdK3jgAABaBk854ZJINK4BHhM7PLKiRBfUsrMNz1KJtepr-RgQwZCjSOGJD20dtclWDLF9Y1u8Tu1ED3PQRTIsLWVx3CYQG_oCtqC_PgDrPc-orH8jP3Awi6UeP5jTqJC_ixEY2Yw5VTSOBt4qMtukWD_Yh5giLp3xQDUZwOu2lYmWXevelTiV_T6esYPQX4kG3yjuNQKjBegCS9Rsc2UoeG7pfcoXddCxb368WG5zcsIxrGN6LFPyQAGNzOZkdKdZDXU2pA'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2417
{
"_embedded" : {
"edgeRouterPolicyList" : [ {
"id" : "444b6510-1034-4ca1-9339-e1c68837a2bb",
"networkId" : "e090e75d-a0d8-4263-b489-f403664a5456",
"zitiId" : "8f454028-f9c4-4c0e-ba64-f26c6a51faa7",
"name" : "Find Test Edge Router Policy 2",
"isSystem" : true,
"semantic" : "AllOf",
"endpointAttributes" : [ "#epAttr1", "#attr3" ],
"edgeRouterAttributes" : [ "#erAttr1" ],
"exclusiveType" : null,
"ownerIdentityId" : "59eb74df-7dc9-4fb1-9d6a-5af532bac208",
"createdBy" : "59eb74df-7dc9-4fb1-9d6a-5af532bac208",
"createdAt" : "2023-02-02T14:18:07.496558Z",
"updatedAt" : "2023-02-02T14:18:07.496558Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/e090e75d-a0d8-4263-b489-f403664a5456",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/444b6510-1034-4ca1-9339-e1c68837a2bb"
}
}
}, {
"id" : "82383b73-0a84-40cf-bfb7-909f9ab8f906",
"networkId" : "e090e75d-a0d8-4263-b489-f403664a5456",
"zitiId" : "5aedf723-3fb2-4353-bc8b-166edbaa6951",
"name" : "Find Test Edge Router Policy 1",
"isSystem" : false,
"semantic" : "AnyOf",
"endpointAttributes" : [ "#epAttr2", "#epAttr1" ],
"edgeRouterAttributes" : [ "#erAttr2", "#erAttr1" ],
"exclusiveType" : null,
"ownerIdentityId" : "59eb74df-7dc9-4fb1-9d6a-5af532bac208",
"createdBy" : "59eb74df-7dc9-4fb1-9d6a-5af532bac208",
"createdAt" : "2023-02-02T14:18:07.470934Z",
"updatedAt" : "2023-02-02T14:18:07.470934Z",
"deletedBy" : null,
"deletedAt" : null,
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/e090e75d-a0d8-4263-b489-f403664a5456",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/82383b73-0a84-40cf-bfb7-909f9ab8f906"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies"
}
},
"page" : {
"size" : 3500,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
Services
Find Services
GET /services
Authorization
This endpoint requires read
action on the service
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
encryptionRequired |
Boolean |
true |
|
modelType |
String |
true |
Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
configIdByConfigTypeId |
Map |
false |
|
attributes |
Array[String] |
false |
|
model |
Object |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
encryptionRequired |
Boolean |
true |
|
modelType |
String |
true |
Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
configIdByConfigTypeId |
Map |
false |
|
attributes |
Array[String] |
false |
|
model |
Object |
true |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/services' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJrckNqSUtqRl9rNzI0NGNzTDVZNlp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg1N2YxZWE4LWU4NjEtNGM0OS04NmMyLWFkM2E0YzhmNDAzZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzQ5OSwiZXhwIjoxNjc1MzUxMDk5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFmOGRjMmQ5LTczM2EtNGFkMi05MzBjLWI4Mjg1MmY5NmZmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzQ5OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.McDpsujbcTvqM3Lb-zizlwnyJmgpuCxOdrotIrBUYx7JBg8OOCybBpveI7O-whyccykstQc54GuucATa481eogJigXUGUvPyBp3UR7X3gciIfyLeyGpNV4IJhjKUxvHqgGRQDAAeNK8ScXyPaRmpyGMe0cLdbZDtwZUMWyk9wfzKi2o8sTkxNtY2mtsuSZG61wL_vAELd2jUBFrI9gWsY2EP8Af-3C6Bis4797q5Wg0SvdekqngGAMde6lPxAJwZHj2nyMDTLQcTkqAV_cnuA8_9XR4rR-NJTyTiH1GoBLh4AM2T6wN2FxwLwbrk-jj5fzTBZswXzglszZjI6KIo_A'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2500
{
"_embedded" : {
"serviceList" : [ {
"id" : "0d4e6377-50e7-4831-a97b-5e8dcdc6457f",
"networkId" : "3b2d210c-8b07-4c4b-b451-abe8bca29159",
"zitiId" : "ziti-id-121",
"name" : "Find Service 1",
"encryptionRequired" : true,
"modelType" : "ZSSH",
"ownerIdentityId" : "d1019c51-744a-4dab-bf42-5059bf6d40d4",
"createdBy" : "d1019c51-744a-4dab-bf42-5059bf6d40d4",
"createdAt" : "2023-02-02T14:18:19.642589Z",
"updatedAt" : "2023-02-02T14:18:19.642589Z",
"deletedBy" : null,
"deletedAt" : null,
"configIdByConfigTypeId" : { },
"attributes" : [ "#attr2", "#attr1" ],
"model" : {
"bindEndpointAttributes" : [ "all" ],
"edgeRouterAttributes" : [ "all" ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/services/0d4e6377-50e7-4831-a97b-5e8dcdc6457f"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/3b2d210c-8b07-4c4b-b451-abe8bca29159",
"profile" : "parent"
}
}
}, {
"id" : "e8337848-ffbc-4444-a825-147f97833b68",
"networkId" : "3b2d210c-8b07-4c4b-b451-abe8bca29159",
"zitiId" : "ziti-id-123",
"name" : "Find Service 2",
"encryptionRequired" : false,
"modelType" : "Generic",
"ownerIdentityId" : "d1019c51-744a-4dab-bf42-5059bf6d40d4",
"createdBy" : "d1019c51-744a-4dab-bf42-5059bf6d40d4",
"createdAt" : "2023-02-02T14:18:19.664228Z",
"updatedAt" : "2023-02-02T14:18:19.664228Z",
"deletedBy" : null,
"deletedAt" : null,
"configIdByConfigTypeId" : { },
"attributes" : [ "#attr3", "#attr1" ],
"model" : {
"configTypes" : [ ],
"configs" : [ ],
"terminators" : [ ],
"serviceEdgeRouterPolicy" : null,
"servicePolicy" : null
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/services/e8337848-ffbc-4444-a825-147f97833b68"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/3b2d210c-8b07-4c4b-b451-abe8bca29159",
"profile" : "parent"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/services"
}
},
"page" : {
"size" : 3500,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
Get Service
GET /services/{id}
Authorization
This endpoint requires read
action on the service
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
encryptionRequired |
Boolean |
true |
|
modelType |
String |
true |
Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
configIdByConfigTypeId |
Map |
false |
|
attributes |
Array[String] |
false |
|
model |
Object |
true |
Hypermedia links
No links.
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/services/54bf3fb1-d3e9-40ac-b26b-fbb097fee54c' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJPdVVTRjdzb3F6RjdUMVZBazFWY1RBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJkOWM5YWIyLWU2ODctNGU4MS05YmFjLTUwOTY3NTJlMjNlZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzUxNSwiZXhwIjoxNjc1MzUxMTE1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjM5NTljMzg2LWY5OTctNDZiMC1iOGFjLTBhYWI0NDVkNmNjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzUxNX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.SL70LrbfYmaqnwcF_yFGztDxLDRHDGvkiBkl4mzviGKRh8V78cxY7M6pb2b3kQ8eQfpWpMbYPXr8l3Np0-QzCyNQsmGa4Em34ML7MKWDjgxjbM2LXX7zmnTHtk5gyL8bVSrf9gp54CuTk2Gz3VE7776-bVwVRs38TKJOWcufv91gxtp3QDHNBVcefb3Hev6WVwA7nVLfd4rMUU4wNcFWRAtd8BcFylhnZsuen4EivfmBnX1TZPV6Vw0XtjP4qrUy42TizxnXmvjhX556Mc1ljdmWMuUz_4JI8XQZy67drsY4ukqkK4_horZN8WQr1yUy0rEXttDoedhSYTNHiAL-Bg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 729
{
"id" : "54bf3fb1-d3e9-40ac-b26b-fbb097fee54c",
"networkId" : "1edca49e-6d66-4ad1-b38d-a1b901c91f92",
"zitiId" : "ziti.id.3bw04t96kpc",
"name" : "My Service 3bvzxwp1rxp",
"encryptionRequired" : true,
"modelType" : "Generic",
"ownerIdentityId" : "9b2ce3ab-e86a-4f20-bf20-0d490c70ee36",
"createdBy" : "9b2ce3ab-e86a-4f20-bf20-0d490c70ee36",
"createdAt" : "2023-02-02T14:18:32.722951Z",
"updatedAt" : "2023-02-02T14:18:32.753725Z",
"deletedBy" : null,
"deletedAt" : null,
"configIdByConfigTypeId" : { },
"attributes" : [ "#Attr-1", "#Attr-2" ],
"model" : {
"configTypes" : null,
"configs" : null,
"terminators" : null,
"serviceEdgeRouterPolicy" : null,
"servicePolicy" : null
}
}
Create Service
POST /services
Authorization
This endpoint requires create
action on the service
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
encryptionRequired |
Boolean |
true |
|
configIds |
Array[Object] |
true |
|
configNames |
Array[String] |
true |
|
configs |
Array[Object] |
true |
|
configs[].networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
configs[].name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
configs[].configTypeId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
configs[].configTypeName |
String |
true |
|
configs[].configType |
Object |
true |
|
configs[].configType.networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
configs[].configType.name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
configs[].configType.schema |
Object |
true |
io.netfoundry.common.util.validation.ValidAs. |
configs[].data |
Object |
true |
io.netfoundry.common.util.validation.ValidAs. |
attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
modelType |
String |
true |
Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH]. |
model |
Object |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
encryptionRequired |
Boolean |
true |
|
modelType |
String |
true |
Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
configIdByConfigTypeId |
Map |
false |
|
attributes |
Array[String] |
false |
|
model |
Object |
true |
Hypermedia links
No links.
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/services' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfdFF0ZGNqbWxpS0xydk5fd0VJUXp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjliMmNlM2FiLWU4NmEtNGYyMC1iZjIwLTBkNDkwYzcwZWUzNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzUxMiwiZXhwIjoxNjc1MzUxMTEyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhjYzBkMzY0LTI1NjItNGFkNS1hMmVmLTRjNzM2OGYyMWUwOVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzUxMn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ErjPgt2DBJ_KAnOhjy3EX1q114Tf6Xfrv_Vr5qoFjgEUX4DQn4vU2Y9JyLOk6aJQ11YDm5waQJss18x9I5yn0usG6IvcJ1f06W8FojofQBGLPIpCM2PkMQnPwVBQQR-4g_mLSOksTSid3DKijB7BnYR2L5SD_1brAGVvE7gSC1jXObttZ8-B7h-ea-neOcok-oXvT18XEI_gSbz3drfRtof44JNmMmJwSEqEU7i3JXaXygty8VjRtbjn-0fPUBpPDr6fc5PNckvTAT4rrcZCE7o4oOySoXiXvdpuLmRH-c0QdEvkQwGv46zPsRLJ6AOwF8jyWFzBsL5pxRnFoioesA' \
-d '{"networkId":"1edca49e-6d66-4ad1-b38d-a1b901c91f92","name":"My Service 3bvzxwp1rxp","encryptionRequired":true,"attributes":["#Attr-2","#Attr-1"],"modelType":"Generic","model":{"configTypes":null,"configs":null,"terminators":null,"serviceEdgeRouterPolicy":null,"servicePolicy":null}}'
Example response
HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 729
{
"id" : "54bf3fb1-d3e9-40ac-b26b-fbb097fee54c",
"networkId" : "1edca49e-6d66-4ad1-b38d-a1b901c91f92",
"zitiId" : "ziti.id.3bw04t96kpc",
"name" : "My Service 3bvzxwp1rxp",
"encryptionRequired" : true,
"modelType" : "Generic",
"ownerIdentityId" : "9b2ce3ab-e86a-4f20-bf20-0d490c70ee36",
"createdBy" : "9b2ce3ab-e86a-4f20-bf20-0d490c70ee36",
"createdAt" : "2023-02-02T14:18:32.722951Z",
"updatedAt" : "2023-02-02T14:18:32.753725Z",
"deletedBy" : null,
"deletedAt" : null,
"configIdByConfigTypeId" : { },
"attributes" : [ "#Attr-1", "#Attr-2" ],
"model" : {
"configTypes" : null,
"configs" : null,
"terminators" : null,
"serviceEdgeRouterPolicy" : null,
"servicePolicy" : null
}
}
Update Service
PATCH /services/{id}
Authorization
This endpoint requires update
action on the service
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
configIds |
Array[Object] |
true |
|
configNames |
Array[String] |
true |
|
updateExclusiveConfigs |
Map |
true |
|
createExclusiveConfigs |
Array[Object] |
true |
|
createExclusiveConfigs[].networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
createExclusiveConfigs[].name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
createExclusiveConfigs[].configTypeId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
createExclusiveConfigs[].configTypeName |
String |
true |
|
createExclusiveConfigs[].configType |
Object |
true |
|
createExclusiveConfigs[].configType.networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
createExclusiveConfigs[].configType.name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
createExclusiveConfigs[].configType.schema |
Object |
true |
io.netfoundry.common.util.validation.ValidAs. |
createExclusiveConfigs[].data |
Object |
true |
io.netfoundry.common.util.validation.ValidAs. |
attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
modelType |
String |
true |
Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH]. |
model |
Object |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
encryptionRequired |
Boolean |
true |
|
modelType |
String |
true |
Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
configIdByConfigTypeId |
Map |
false |
|
attributes |
Array[String] |
false |
|
model |
Object |
true |
Hypermedia links
No links.
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/services/54bf3fb1-d3e9-40ac-b26b-fbb097fee54c' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ2c0pHR2ZNb1g5UXBhOXNRT3NHcV93IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRjODg0NjI5LWQ5ZGUtNGY4My1hYmI1LWJlZjYyYmI4OGFkYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzUyNCwiZXhwIjoxNjc1MzUxMTI0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImMyNDJhYWM1LTlmYmEtNDJmYS1hZmRjLTZjYjUxYjgxZDA0ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzUyNH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ZKy3wXZi2miI2zi33-NR-YHhv7W4Chs3As_icZ3rbQhKgfgqQLeJyGzp8JlpbgKU197UJRl6ocYhMb0Oecya9XOOhyvYlbpZuMdb1pLRXEes8VmSv_wkIv-GUR4eWgaPbJR9eK_RX8BJNKbGxeW3PQgV1-FSXez0BFpVnS_3cPG0x_wJ0_sL_wNDQXqaGiZxKXSUReuAllyVJsc2Mvjo6cgJ1-h-Bu1XaKe6Jc-VMcB_w9ligvfJvRVKZ7Ed-bNIPRpKiF_2Z6UpYbO1Wd8jVNVTpK6NaW0VlZ-oadyESjqCkDE_qYlNKcBbH0KkXRRpNHNXOCXwOfc0p_p4YLX9NA' \
-d '{"name":"Our Service 3bvzxwp1rxp","attributes":["#Attr-2","#Attr-4"],"modelType":"Generic","model":{"configTypes":null,"configs":null,"terminators":null,"serviceEdgeRouterPolicy":null,"servicePolicy":null}}'
Example response
HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 730
{
"id" : "54bf3fb1-d3e9-40ac-b26b-fbb097fee54c",
"networkId" : "1edca49e-6d66-4ad1-b38d-a1b901c91f92",
"zitiId" : "ziti.id.3bw04t96kpc",
"name" : "Our Service 3bvzxwp1rxp",
"encryptionRequired" : true,
"modelType" : "Generic",
"ownerIdentityId" : "9b2ce3ab-e86a-4f20-bf20-0d490c70ee36",
"createdBy" : "9b2ce3ab-e86a-4f20-bf20-0d490c70ee36",
"createdAt" : "2023-02-02T14:18:32.722951Z",
"updatedAt" : "2023-02-02T14:18:44.537646Z",
"deletedBy" : null,
"deletedAt" : null,
"configIdByConfigTypeId" : { },
"attributes" : [ "#Attr-4", "#Attr-2" ],
"model" : {
"configTypes" : null,
"configs" : null,
"terminators" : null,
"serviceEdgeRouterPolicy" : null,
"servicePolicy" : null
}
}
Delete Service
DELETE /services/{id}
Authorization
This endpoint requires delete
action on the service
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
networkId |
String |
false |
|
zitiId |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
encryptionRequired |
Boolean |
true |
|
modelType |
String |
true |
Must be one of [Generic, TunnelerToSdk, TunnelerToEndpoint, TunnelerToEdgeRouter, AdvancedTunnelerToEndpoint, ZSSH]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
configIdByConfigTypeId |
Map |
false |
|
attributes |
Array[String] |
false |
|
model |
Object |
true |
Hypermedia links
No links.
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/services/54bf3fb1-d3e9-40ac-b26b-fbb097fee54c' -i -X DELETE \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvUUxtdmZ6U2Z5MkdxMklFR1MzMTNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg2NjcxMDg3LWJhNDQtNDZkOS05Yzg1LTBmMzQwNWMzM2MyYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzUzMCwiZXhwIjoxNjc1MzUxMTMwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjQ3NmExMmVmLTZjMWYtNGZkYy1iMDJkLTFjYTZkMzk5YjRmMlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzUzMH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.d53SZd6BbprZB5_yCQ1zTRFbG1b2qav2IRDIpCRXUGcdNdH4o8_lx79cLZtyzYZvscAOHTOY9yrYoNgObAZPOalCTw-fGCvyOsjUJRRo3ipr3pMMgw2eKpIhUjQidvetXaFVlEtzsL2BwjwqJQcXuCmGAVQlO-nI9rdUxjTV1Ol6HwtFyO8v-kXMfSdqJ_pB3aSWPh-TdaWU5Kl40CZOktPqY4CFIw6DQmvj10S0v3ysNyfdSYRdNLVX6RD1-sf6mwlVhMXC7Bu_l7kzpKYoEoMIn3efPiqYaYI6JJ8CrvMATT6tWdmBvON3U3ikHGPK7KKBs0GQDKhG6OnqE8kRlQ'
Example response
HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 748
{
"id" : "54bf3fb1-d3e9-40ac-b26b-fbb097fee54c",
"networkId" : "1edca49e-6d66-4ad1-b38d-a1b901c91f92",
"zitiId" : null,
"name" : "Our Service 3bvzxwp1rxp",
"encryptionRequired" : true,
"modelType" : "Generic",
"ownerIdentityId" : "9b2ce3ab-e86a-4f20-bf20-0d490c70ee36",
"createdBy" : "9b2ce3ab-e86a-4f20-bf20-0d490c70ee36",
"createdAt" : "2023-02-02T14:18:32.722951Z",
"updatedAt" : "2023-02-02T14:18:50.190414Z",
"deletedBy" : "86671087-ba44-46d9-9c85-0f3405c33c2b",
"deletedAt" : "2023-02-02T14:18:50.177Z",
"configIdByConfigTypeId" : { },
"attributes" : [ ],
"model" : {
"configTypes" : null,
"configs" : null,
"terminators" : null,
"serviceEdgeRouterPolicy" : null,
"servicePolicy" : null
}
}
App Wans
Find App Wans
GET /app-wans
Authorization
This endpoint requires read
action on the app-wan
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
zitiId |
String |
true |
|
networkId |
String |
false |
|
serviceAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
postureCheckAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
zitiId |
String |
true |
|
networkId |
String |
false |
|
serviceAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
postureCheckAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJldmVTUTVOS3A5ZmJLMlE0Zy04dmdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjRkNWQ4MDliLTkyOTUtNDAyNy05ZTQ5LTNjNjAzMDcwZjMyNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU1MywiZXhwIjoxNjc1MzUxMTUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE4M2U0NTJlLTE5MjktNDUyNS1hMjM2LTQzYjJlN2RlY2UxOVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU1M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.TN5klmtPEkqQMIAv5pf2HsuMqC-ZtKZI9UbKd5ZAsrSZvydczBbArZTU4oN-FRSoxzWRWsvFkLASS5s9oGBPy7A_x99hlqhZ86hiumbeux_YvAAA4FiDARaj6nJdHyJuHYKQWxBIfOyY6U9M3qhYFOSaGiOfDoQ6uuJJ1Mgbr-A_OZRNcn_dgqjv4m8Kdec13LZKeeRlapQw3lgJL1l8yhs1APPKaiJ-WOG5U483Hh0SJzQEEVDI92VAPTf2_IDxF9JBYV6RysmXBld3ecWqq3PNEyAjeKpbcayeBrrw_vHyKv7AHQDYzsLws-6q86fioH-NYBeh-VCyXW7G2EMGGA'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3246
{
"_embedded" : {
"appWanList" : [ {
"id" : "34b4db78-86a9-458d-a586-bac5c43176f4",
"ownerIdentityId" : "c72eca15-396d-4757-931f-5f865b78c0b1",
"createdBy" : "c72eca15-396d-4757-931f-5f865b78c0b1",
"createdAt" : "2023-02-02T14:19:13.284755Z",
"updatedAt" : "2023-02-02T14:19:13.383389Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "Updated App Wan name",
"zitiId" : "cefc492e-4d7f-4ca0-8c4b-366b4fed05a6",
"networkId" : "16d5e809-b015-4942-9759-502b3bae19e3",
"serviceAttributes" : [ "#service03", "#service02", "#service01" ],
"endpointAttributes" : [ "#usendpoints" ],
"postureCheckAttributes" : [ "#windows" ],
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/34b4db78-86a9-458d-a586-bac5c43176f4"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/16d5e809-b015-4942-9759-502b3bae19e3",
"profile" : "parent"
}
}
}, {
"id" : "67b17356-0781-4c3f-b25a-c41b48631d50",
"ownerIdentityId" : "b0ceddcf-0550-4c9b-9ca5-98eed5a148d4",
"createdBy" : "b0ceddcf-0550-4c9b-9ca5-98eed5a148d4",
"createdAt" : "2023-02-02T14:19:13.083162Z",
"updatedAt" : "2023-02-02T14:19:13.083989Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "appwan-274",
"zitiId" : "20df0a67-abcc-42cf-82e7-bbd270e5826e",
"networkId" : "fb46193c-1bc2-4646-a031-4ff1338b44b5",
"serviceAttributes" : [ ],
"endpointAttributes" : [ ],
"postureCheckAttributes" : [ ],
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/67b17356-0781-4c3f-b25a-c41b48631d50"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/fb46193c-1bc2-4646-a031-4ff1338b44b5",
"profile" : "parent"
}
}
}, {
"id" : "9285a275-582d-45d6-b125-c8ea3eeca589",
"ownerIdentityId" : "6227a77b-7d17-4386-9653-666d91e1338a",
"createdBy" : "6227a77b-7d17-4386-9653-666d91e1338a",
"createdAt" : "2023-02-02T14:19:13.502780Z",
"updatedAt" : "2023-02-02T14:19:13.524471Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "appwan-301",
"zitiId" : "771efb8c-7df6-4ad7-893b-f57939155cdd",
"networkId" : "390f191d-4ee1-48ca-8cb7-448ebbfed914",
"serviceAttributes" : [ "#service03", "#service02", "#service01" ],
"endpointAttributes" : [ "#usendpoints" ],
"postureCheckAttributes" : [ "#windows" ],
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/9285a275-582d-45d6-b125-c8ea3eeca589"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/390f191d-4ee1-48ca-8cb7-448ebbfed914",
"profile" : "parent"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans"
}
},
"page" : {
"size" : 3500,
"totalElements" : 6,
"totalPages" : 1,
"number" : 0
}
}
Get App Wan
GET /app-wans/{id}
Authorization
This endpoint requires read
action on the app-wan
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
zitiId |
String |
true |
|
networkId |
String |
false |
|
serviceAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
postureCheckAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/b332a18e-28ef-43c1-bdd3-711b74cdd4c3' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfaW5SOXVaWkFWdkpaTnEyemF3cHNnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYyZmU1MzQ3LTMyM2MtNDRlYy1hNTdhLWQzYmMwMDE4NTU0OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU1MywiZXhwIjoxNjc1MzUxMTUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjYxYzRjNWNhLTRiZGItNGZiZi05NmJlLTZlOWUwMjFlYWI5NVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU1M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.k93Xjbo8WfJmvBTRTSBseXRgxEVIqtvZGgidonVCIARlnzMDsI4Pz4hn1eWCGX-UAr6NOeFa51cN24reNB0V3clcelbcddChKmh-lZXrxbG6FF5jlcS8IgVgTdLgPEbmy8-pJW0U1jrsPnBAZH3MGiNj5upN0IxQNZBJryTkbb7_hDf05fdAvliriqtMxYQ93mGxjpdkrYfIGzzDA2F0bFuH_xpR72_GlGicPSVTAAtCbo3KEbB3mBCNNP8e7kSTjPFh82hY1hLJkockhS5bCNL2_hgRuhpfGx3cxBei-C_35YPHSY3jg3jmkQq_V-8JwrH6tGnKbAHXtsaoXhPrww'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 852
{
"id" : "b332a18e-28ef-43c1-bdd3-711b74cdd4c3",
"ownerIdentityId" : "00584c77-8a36-44c7-9311-7690b5338f32",
"createdBy" : "00584c77-8a36-44c7-9311-7690b5338f32",
"createdAt" : "2023-02-02T14:19:13.803866Z",
"updatedAt" : "2023-02-02T14:19:13.804935Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "appwan-319",
"zitiId" : "d0ea0b59-633f-4588-9d5e-a9f751150690",
"networkId" : "0b176277-ad99-4953-836c-09b58c130281",
"serviceAttributes" : [ ],
"endpointAttributes" : [ ],
"postureCheckAttributes" : [ ],
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/b332a18e-28ef-43c1-bdd3-711b74cdd4c3"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/0b176277-ad99-4953-836c-09b58c130281",
"profile" : "parent"
}
}
}
Find App Wans
GET /app-wans
Authorization
This endpoint requires read
action on the app-wan
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
zitiId |
String |
true |
|
networkId |
String |
false |
|
serviceAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
postureCheckAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
zitiId |
String |
true |
|
networkId |
String |
false |
|
serviceAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
postureCheckAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJBYzJ2aHZBVUo3Qk9IYWtDRFJINTF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ0YTI3ZDFkLTgxYmUtNGZiMS05MTdkLTY1YTZjZWE1Y2U5ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzUyOSwiZXhwIjoxNjc1MzUxMTI5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImYxNjc4YjAwLWQ4YjQtNGI3ZC1hYmFlLWY2MDc1MTlhNGQ1ZVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzUyOX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.IRB3JbNK87t3dkjj_-BRmGNgJjtm7HVLg6qWSUQlWwvtyj3qGH-ZrN9i1n_mUudy3VeCspoM3YD4ClC7Ub2_Pm8b02efLJEc9v8O18AxjLppjlAUTXCNwfo5YoZiBlaT5mfgGtNjAsLa3vKrEIniNbmvz6h1MdK3q_B80cC6SXvbYiW5OE5yZ20HJ1iVR-DIJaWpMvGqNi3cs-5aYsyDJ10VPnfnsczhu0TlgcFPRVK9GCx4hBYggH686INj6kIUP9TPhUzWrvlq7bwmGuI23l63l32plsw42YPNH8P2Vinc-qkqLR9BvEzWT5Pn8FGCHKWtp2zKNUilnSyOCpnELg'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2252
{
"_embedded" : {
"appWanList" : [ {
"id" : "615ec66c-ded3-452f-abd5-bdf791cec602",
"ownerIdentityId" : "d466ee6b-5df1-4808-bbef-00eeaf65a4a7",
"createdBy" : "d466ee6b-5df1-4808-bbef-00eeaf65a4a7",
"createdAt" : "2023-02-02T14:18:49.056013Z",
"updatedAt" : "2023-02-02T14:18:49.058189Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "Find Test AppWan 2",
"zitiId" : "93338d41-ba73-4253-aa9a-b45281d9d911",
"networkId" : "67a9c13e-4190-4e95-babf-5c6bf0d61f09",
"serviceAttributes" : [ "#seAttr1", "#seAttr3" ],
"endpointAttributes" : [ "#epAttr1" ],
"postureCheckAttributes" : [ ],
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/67a9c13e-4190-4e95-babf-5c6bf0d61f09",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/615ec66c-ded3-452f-abd5-bdf791cec602"
}
}
}, {
"id" : "c2789579-521c-4da9-abb1-5374faf1942b",
"ownerIdentityId" : "d466ee6b-5df1-4808-bbef-00eeaf65a4a7",
"createdBy" : "d466ee6b-5df1-4808-bbef-00eeaf65a4a7",
"createdAt" : "2023-02-02T14:18:49.051021Z",
"updatedAt" : "2023-02-02T14:18:49.054083Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "Find Test AppWan 1",
"zitiId" : "264745d6-6c2d-499c-a9dd-3aeccb94fc9e",
"networkId" : "67a9c13e-4190-4e95-babf-5c6bf0d61f09",
"serviceAttributes" : [ "#seAttr1", "#seAttr2" ],
"endpointAttributes" : [ "#epAttr2", "#epAttr1" ],
"postureCheckAttributes" : [ ],
"_links" : {
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/67a9c13e-4190-4e95-babf-5c6bf0d61f09",
"profile" : "parent"
},
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/c2789579-521c-4da9-abb1-5374faf1942b"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans"
}
},
"page" : {
"size" : 3500,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
Create App Wan
POST /app-wans
Authorization
This endpoint requires create
action on the app-wan
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
serviceAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
postureCheckAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
zitiId |
String |
true |
|
networkId |
String |
false |
|
serviceAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
postureCheckAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans' -i -X POST \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1UHVtTVBKN3dGUmxuSmx5UFZqNFdnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE3OTUxZTMwLTRiOGUtNGMyNy05NDkzLTNiNDg0YmJlN2NjYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU1NCwiZXhwIjoxNjc1MzUxMTU0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImJkZjU3ODA5LTNjYzMtNDQzZC04OThiLWU1NzkxNjNkNjRmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU1NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jyFR8oeBEj2Q3gCCks_zq0Mc8ZR-LT7oA3UxRz9AL8T6weFW5Z8hFqLOxpgNJpBu1Cr7bM_Q55FHn8I1XVg4Z1DDEwIL4Ba_WfSWx_v-WVunoEAgRFPNYZ0IlUQCmU_q8pP346LJUkv5X4M8JDC4Ewln7hCZGLj37zerPNEUrFm7tb9Hf9jAAtgMV_wR4w2QFsOe9vLEpBhRAlpdD9XOQhjJFqPjHWJO19VJMVyaKfc_EQed7TB5HhZuRZaKymSbFkKO4ldP3JCL3e7PAFRPwg9_8hMpzDzG-kU5ladav2eiiqNN-iwLozfQzf1lr-0SVQ_DLSV0Y_2SzaVLYaSAww' \
-d '{"networkId":"780ab212-8336-4a8f-8c33-d9332cd970a1","name":"Test App Wan 1675347554","serviceAttributes":["#service01"],"endpointAttributes":["@endpoint-348","#accessclients"],"postureCheckAttributes":["#windows"]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1123
{
"id" : "d42f6034-c7c9-4a32-b24f-bfe54fcc82f1",
"ownerIdentityId" : "a7951e30-4b8e-4c27-9493-3b484bbe7ccb",
"createdBy" : "a7951e30-4b8e-4c27-9493-3b484bbe7ccb",
"createdAt" : "2023-02-02T14:19:14.355055Z",
"updatedAt" : "2023-02-02T14:19:14.360668Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "Test App Wan 1675347554",
"zitiId" : "a3828c68-999d-478f-a066-057eff3e6225",
"networkId" : "780ab212-8336-4a8f-8c33-d9332cd970a1",
"serviceAttributes" : [ "#service01" ],
"endpointAttributes" : [ "@endpoint-348", "#accessclients" ],
"postureCheckAttributes" : [ "#windows" ],
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/d42f6034-c7c9-4a32-b24f-bfe54fcc82f1"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/780ab212-8336-4a8f-8c33-d9332cd970a1",
"profile" : "parent"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/7c6ebeea-6478-4c10-be8d-6719996a4d0d",
"title" : "Create AppWan",
"profile" : "meta"
}
}
}
Update App Wan
PUT /app-wans/{id}
Authorization
This endpoint requires update
action on the app-wan
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
serviceAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
postureCheckAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
zitiId |
String |
true |
|
networkId |
String |
false |
|
serviceAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
postureCheckAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/34b4db78-86a9-458d-a586-bac5c43176f4' -i -X PUT \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJjeVIyRkVCenBoakxxMExpWHBKOVdBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ4N2FlMGNjLWQxZTctNDIxYS1iODA4LTAwOGI2MGEwZGNjMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU1MywiZXhwIjoxNjc1MzUxMTUzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVlZjIyYTg4LTAyOWMtNGMwNC1hMTE5LTRhNWQxNTllZDNmYVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU1M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.KcwbxNfRmAlvOmuDc39eEeHkBIrB7vSzLIr_C47S40MtG86RfqkEr0dlYjqNZlfrSnBxeOhMO107e9-XboWSVKUwwV7q3f5yvlKMjGWU5W40X97JmWlueqQATLeJqGoQv1s9T5MIS_rpKlf5-xtNWysfZydN-ADtuC7bbJRrWt4YeI5V2FgH2ArqIDSVgoEBRdQ-vD15BXWlrrtDfwXsZ83Rge3Tm8l-bCjC8NLW7DtjainqHHPPsIdmJICcjhohsaAw59Gb7_PwUB5SgwrV_51nmvhDGT3hZKWEkt03Rt09rMVgjcOyN4Vp5yzXbpIHihPqJ71KJvOKEscOnr_olg' \
-d '{"name":"Updated App Wan name","serviceAttributes":["#service03","#service02","#service01"],"endpointAttributes":["#usendpoints"],"postureCheckAttributes":["#windows"]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1129
{
"id" : "34b4db78-86a9-458d-a586-bac5c43176f4",
"ownerIdentityId" : "c72eca15-396d-4757-931f-5f865b78c0b1",
"createdBy" : "c72eca15-396d-4757-931f-5f865b78c0b1",
"createdAt" : "2023-02-02T14:19:13.284755Z",
"updatedAt" : "2023-02-02T14:19:13.383389Z",
"deletedBy" : null,
"deletedAt" : null,
"name" : "Updated App Wan name",
"zitiId" : "cefc492e-4d7f-4ca0-8c4b-366b4fed05a6",
"networkId" : "16d5e809-b015-4942-9759-502b3bae19e3",
"serviceAttributes" : [ "#service03", "#service02", "#service01" ],
"endpointAttributes" : [ "#usendpoints" ],
"postureCheckAttributes" : [ "#windows" ],
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/34b4db78-86a9-458d-a586-bac5c43176f4"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/16d5e809-b015-4942-9759-502b3bae19e3",
"profile" : "parent"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/ffbc6dbb-670c-40d3-b291-cfeeebc91bf4",
"title" : "Update AppWan",
"profile" : "meta"
}
}
}
Delete App Wan
DELETE /app-wans/{id}
Authorization
This endpoint requires delete
action on the app-wan
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
zitiId |
String |
true |
|
networkId |
String |
false |
|
serviceAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
endpointAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
postureCheckAttributes |
Array[String] |
false |
#all, when used in an attribute list, must be the only value in the list. |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/d1eed99c-0d61-410c-9bd0-585fb98dd9bc' -i -X DELETE \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJlb3JmTS15TDl1Q09ldzVST0dRdVhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImY5ZWI5NzM4LTUwZjctNDE3MS1iNWExLTRiM2Y5Y2I0NDFmZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU1MiwiZXhwIjoxNjc1MzUxMTUyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjRhNTlkNTRjLWZjOGMtNGFhMC1iMjVmLTg0MDE2ZWE2MWVmNlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU1Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.bCK69jqaMrFqPkQA4O_niMkCeUfcn7z7szyB9JKMNG7kmr-6ZCA1DlOan7c2nj4GdrmiDNrCv8Vf-4F0W5VM4S3Pmdu8EuA4EuqXmn5dtlS8SAXGHs64POhHFJGmVhNl4-NK5KxS80-3KpsG6UkDOgvp2ShHaCgyVDiLz9lsI-NS1cCXdnmOzY5rGufi8e6GRm7ktCkMyOcpOr4m7sIuOgfCEtcYoJxu6XEkywhioiNOoCSBz1lFxIP0YBjt-qruZltUBKGZy5EXOQ3n9DEVssS_7Pz5NaSQ5xTE0m78u5mZCTbYRRLTaST2CF4RaVt15GvSit85piAdHelvqjyMww'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1074
{
"id" : "d1eed99c-0d61-410c-9bd0-585fb98dd9bc",
"ownerIdentityId" : "18716a55-4f76-44c7-a349-5df1d328063c",
"createdBy" : "18716a55-4f76-44c7-a349-5df1d328063c",
"createdAt" : "2023-02-02T14:19:12.944093Z",
"updatedAt" : "2023-02-02T14:19:12.981783Z",
"deletedBy" : "f9eb9738-50f7-4171-b5a1-4b3f9cb441fe",
"deletedAt" : "2023-02-02T14:19:12.978Z",
"name" : "appwan-265",
"zitiId" : null,
"networkId" : "5a6036e7-c2ae-45cf-bb84-77da022db5dc",
"serviceAttributes" : [ ],
"endpointAttributes" : [ ],
"postureCheckAttributes" : [ ],
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/d1eed99c-0d61-410c-9bd0-585fb98dd9bc"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/5a6036e7-c2ae-45cf-bb84-77da022db5dc",
"profile" : "parent"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/61aabba0-c31f-440b-a968-7f2fd233672f",
"title" : "Delete AppWan",
"profile" : "meta"
}
}
}
Posture Checks
Find Posture Checks
GET /posture-checks
Authorization
This endpoint requires read
action on the posture-check
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
deleted |
Boolean |
true |
Deprecated.. |
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
zitiId |
String |
false |
Size must be between 1 and 255 inclusive. |
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkId |
String |
false |
|
type |
String |
false |
Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
attributes |
Array[String] |
false |
|
data |
Object |
false |
|
data.domains |
Array[String] |
false |
|
data.macAddresses |
Array[String] |
false |
|
data.timeoutSeconds |
Integer |
true |
Must be at least 0. |
data.promptOnWake |
Boolean |
true |
|
data.promptOnUnlock |
Boolean |
true |
|
data.ignoreLegacyEndpoints |
Boolean |
true |
|
data.operatingSystems |
Array[Object] |
false |
|
data.operatingSystems[].type |
String |
false |
Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer]. |
data.operatingSystems[].versions |
Array[String] |
false |
|
data.process |
Object |
false |
|
data.process.osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.process.path |
String |
false |
|
data.process.hashes |
Array[String] |
true |
|
data.process.signerFingerprint |
String |
true |
|
data.processes |
Array[Object] |
false |
|
data.processes[].osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.processes[].path |
String |
false |
|
data.processes[].hashes |
Array[String] |
true |
|
data.processes[].signerFingerprints |
Array[String] |
true |
|
data.semantic |
String |
true |
Must be one of [AllOf, AnyOf]. |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
zitiId |
String |
false |
Size must be between 1 and 255 inclusive. |
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkId |
String |
false |
|
type |
String |
false |
Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
attributes |
Array[String] |
false |
|
data |
Object |
false |
|
data.domains |
Array[String] |
false |
|
data.macAddresses |
Array[String] |
false |
|
data.timeoutSeconds |
Integer |
true |
Must be at least 0. |
data.promptOnWake |
Boolean |
true |
|
data.promptOnUnlock |
Boolean |
true |
|
data.ignoreLegacyEndpoints |
Boolean |
true |
|
data.operatingSystems |
Array[Object] |
false |
|
data.operatingSystems[].type |
String |
false |
Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer]. |
data.operatingSystems[].versions |
Array[String] |
false |
|
data.process |
Object |
false |
|
data.process.osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.process.path |
String |
false |
|
data.process.hashes |
Array[String] |
true |
|
data.process.signerFingerprint |
String |
true |
|
data.processes |
Array[Object] |
false |
|
data.processes[].osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.processes[].path |
String |
false |
|
data.processes[].hashes |
Array[String] |
true |
|
data.processes[].signerFingerprints |
Array[String] |
true |
|
data.semantic |
String |
true |
Must be one of [AllOf, AnyOf]. |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDWER5aExYU1hTRjlKMVJ0ZGZLaDJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM0MTU1NDI5LTc3NjUtNDc0NC04NWQ2LTlkNjZmYzExYzEzYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzUxNiwiZXhwIjoxNjc1MzUxMTE2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImJlYTg2ZWVmLTYyY2MtNGQ1ZC05OWZlLWU4OTM1NjgwNWMyMlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzUxNn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.kDA-DJAP18g-Xc11fGq5qG61hcY2TTnA_V1IeWWM58SKqPrhz5AZE8VPqx50q940IcQWNL0LJcwq6oI0QV9pncyWYWWlvXCjxVeHnLmEfDamnEunAFCTpQIe-HzeSrwN91okaQrLDVmF0LrHbAKMcULVissryDPNx4grXZcql5UhVLtYB5rlpl3oKFLPAzYkqj2kRHcpw8CgYan8BihxLIpdCZUAwjrYF_cdNyTax3-5flxM8DSUOdhMe5pbIVEeZXpH4zKPmlp4NBdj3vtuKG-wqKgJZ4Qlw0NcctqMFPMNtNRnIK8EMDoADbWs3FSRo_h4QPqTf6N7QAY4vzSmfw'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2284
{
"_embedded" : {
"postureCheckList" : [ {
"id" : "2f9f8c92-e3db-45f6-b919-2714910b91c9",
"zitiId" : "zitiId-fake-ea81dec8-eac8-4341-8cb0-ec3ffdc5bcaa",
"name" : "Find Test Posture Check 1",
"networkId" : "ce625d6c-27de-4b08-82df-41e3ce8166ca",
"type" : "DOMAIN",
"ownerIdentityId" : "7ef91f57-dec7-4f43-8b9a-924c85b58f11",
"createdBy" : "7ef91f57-dec7-4f43-8b9a-924c85b58f11",
"createdAt" : "2023-02-02T14:18:36.222529Z",
"updatedAt" : "2023-02-02T14:18:36.222529Z",
"deletedBy" : null,
"deletedAt" : null,
"attributes" : [ "#attr2", "#attr1" ],
"data" : {
"domains" : [ "abc.com" ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/2f9f8c92-e3db-45f6-b919-2714910b91c9"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/ce625d6c-27de-4b08-82df-41e3ce8166ca",
"profile" : "parent"
}
}
}, {
"id" : "7908fb27-31b6-4f4b-9fbb-212ec1ab6cb7",
"zitiId" : "zitiId-fake-ef375b02-9ddc-4774-b186-ebf8669a1255",
"name" : "Find Test Posture Check 2",
"networkId" : "ce625d6c-27de-4b08-82df-41e3ce8166ca",
"type" : "DOMAIN",
"ownerIdentityId" : "7ef91f57-dec7-4f43-8b9a-924c85b58f11",
"createdBy" : "7ef91f57-dec7-4f43-8b9a-924c85b58f11",
"createdAt" : "2023-02-02T14:18:36.236916Z",
"updatedAt" : "2023-02-02T14:18:36.236916Z",
"deletedBy" : null,
"deletedAt" : null,
"attributes" : [ "#attr3", "#attr1" ],
"data" : {
"domains" : [ "abc.com" ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks/7908fb27-31b6-4f4b-9fbb-212ec1ab6cb7"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/networks/ce625d6c-27de-4b08-82df-41e3ce8166ca",
"profile" : "parent"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/posture-checks"
}
},
"page" : {
"size" : 3500,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
Get Posture Check
GET /posture-checks/{id}
Authorization
This endpoint requires read
action on the posture-check
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
zitiId |
String |
false |
Size must be between 1 and 255 inclusive. |
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkId |
String |
false |
|
type |
String |
false |
Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
attributes |
Array[String] |
false |
|
data |
Object |
false |
|
data.domains |
Array[String] |
false |
|
data.macAddresses |
Array[String] |
false |
|
data.timeoutSeconds |
Integer |
true |
Must be at least 0. |
data.promptOnWake |
Boolean |
true |
|
data.promptOnUnlock |
Boolean |
true |
|
data.ignoreLegacyEndpoints |
Boolean |
true |
|
data.operatingSystems |
Array[Object] |
false |
|
data.operatingSystems[].type |
String |
false |
Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer]. |
data.operatingSystems[].versions |
Array[String] |
false |
|
data.process |
Object |
false |
|
data.process.osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.process.path |
String |
false |
|
data.process.hashes |
Array[String] |
true |
|
data.process.signerFingerprint |
String |
true |
|
data.processes |
Array[Object] |
false |
|
data.processes[].osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.processes[].path |
String |
false |
|
data.processes[].hashes |
Array[String] |
true |
|
data.processes[].signerFingerprints |
Array[String] |
true |
|
data.semantic |
String |
true |
Must be one of [AllOf, AnyOf]. |
Hypermedia links
No links.
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks/cb285174-60c0-4c99-b084-318e678b80a4' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiYnBCQWUzd0FudEVNYWR5VXJ5dFlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc4ZjI0YWY1LTI1OTYtNDg1MS1hOTlmLTEzYTQyZjU1ZDQyZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzY0NSwiZXhwIjoxNjc1MzUxMjQ1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImVjOWQxN2IyLTMyMzQtNDhjZi1iZDAwLWIzNjg4OTk5MjZmNFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzY0NX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.fAGfFOysjgdfprwTT5o-a81_UBdSPR0fuFzJYHtpRBAQ7qfFxYB0ULOJ5eZ5Lf7iMq90om_HGQJ3-e4evG3sxsFOaQCXpCpBzTZIkqFNy4pIIwu4mA1fp591GEuYFL7je24Cu5LUeMj235_IOuf04nnJQPaxJdZimiuatkPM_b4zEauqDFi8DQeg6-w5f3wU_XhAp6FOxOoy-g5IluhzfjmhEk8azUT2sMCwIamiyOXoOSO69IDr0radBq7j7Kynz70JfysI3JIa4YMGsU9dLo3EXd9t5nrmyL4nUpuic4GwG0qyE3XfSy7p1Yy5CHg6CfjVFxPZd9Q9-kKjFNTgUg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 669
{
"id" : "cb285174-60c0-4c99-b084-318e678b80a4",
"zitiId" : "ziti.id.3bw1srxu9d7",
"name" : "My Posture Check 12176048699752917",
"networkId" : "be408996-4835-41d5-8ad1-0df030755e89",
"type" : "PROCESS",
"ownerIdentityId" : "cbbd7b9d-1862-4de6-9371-4d9288f1cd87",
"createdBy" : "cbbd7b9d-1862-4de6-9371-4d9288f1cd87",
"createdAt" : "2023-02-02T14:20:43.280673Z",
"updatedAt" : "2023-02-02T14:20:43.280673Z",
"deletedBy" : null,
"deletedAt" : null,
"attributes" : [ "#Attr-1", "#Attr-2" ],
"data" : {
"process" : {
"osType" : "Windows",
"path" : "c:\\programs",
"hashes" : [ ],
"signerFingerprint" : null
}
}
}
Create Posture Check
POST /posture-checks
Authorization
This endpoint requires create
action on the posture-check
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
type |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
data |
Object |
false |
io.netfoundry.common.util.validation.ValidAs. |
data.domains |
Array[String] |
false |
|
data.macAddresses |
Array[String] |
false |
|
data.timeoutSeconds |
Integer |
true |
Must be at least 0. |
data.promptOnWake |
Boolean |
true |
|
data.promptOnUnlock |
Boolean |
true |
|
data.ignoreLegacyEndpoints |
Boolean |
true |
|
data.operatingSystems |
Array[Object] |
false |
|
data.operatingSystems[].type |
String |
false |
Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer]. |
data.operatingSystems[].versions |
Array[String] |
false |
|
data.process |
Object |
false |
|
data.process.osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.process.path |
String |
false |
|
data.process.hashes |
Array[String] |
true |
|
data.process.signerFingerprint |
String |
true |
|
data.processes |
Array[Object] |
false |
|
data.processes[].osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.processes[].path |
String |
false |
|
data.processes[].hashes |
Array[String] |
true |
|
data.processes[].signerFingerprints |
Array[String] |
true |
|
data.semantic |
String |
true |
Must be one of [AllOf, AnyOf]. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
zitiId |
String |
false |
Size must be between 1 and 255 inclusive. |
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkId |
String |
false |
|
type |
String |
false |
Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
attributes |
Array[String] |
false |
|
data |
Object |
false |
|
data.domains |
Array[String] |
false |
|
data.macAddresses |
Array[String] |
false |
|
data.timeoutSeconds |
Integer |
true |
Must be at least 0. |
data.promptOnWake |
Boolean |
true |
|
data.promptOnUnlock |
Boolean |
true |
|
data.ignoreLegacyEndpoints |
Boolean |
true |
|
data.operatingSystems |
Array[Object] |
false |
|
data.operatingSystems[].type |
String |
false |
Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer]. |
data.operatingSystems[].versions |
Array[String] |
false |
|
data.process |
Object |
false |
|
data.process.osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.process.path |
String |
false |
|
data.process.hashes |
Array[String] |
true |
|
data.process.signerFingerprint |
String |
true |
|
data.processes |
Array[Object] |
false |
|
data.processes[].osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.processes[].path |
String |
false |
|
data.processes[].hashes |
Array[String] |
true |
|
data.processes[].signerFingerprints |
Array[String] |
true |
|
data.semantic |
String |
true |
Must be one of [AllOf, AnyOf]. |
Hypermedia links
No links.
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJGNTE2VFJDckpVYktFRVRnWVJoV253IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNiYmQ3YjlkLTE4NjItNGRlNi05MzcxLTRkOTI4OGYxY2Q4NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzY0MywiZXhwIjoxNjc1MzUxMjQzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdlM2YwYTRlLWVhNDQtNDIyYy04MDNiLTJhNDBkNjgwMTYyMFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzY0M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.itK4ld4bCbwcsIJ6Rh3c1Hh7-_RJjPbi6W3CraQQdh5rf6NYob-r1Qd9uyHHYLuCJZD1nbnvRBP2PmCdHq4gDCGboS7BD7BJLwM2CXnQhtcZBnwhhRzLVzzu2GTAzPOb3D0j4qguZ1SrTZwNxccuxs77EQIMscOasDHm6pOshzUH5mioVF6LxQoQKTsI3JYfgQ4NXNNxxTDcemhuMA4RvFPyfAgLT7SQwpAl83ThzkAjJ5BrssO5un9l9sG9THptezFxnR27jWaiyiVX57V_DKC1apS9c50iT_KHIIywZjc20j2G23Rnf5xXnA5i19Cx5U9W6t3pfISilFHoMgyJaQ' \
-d '{"name":"My Posture Check 12176048699752917","networkId":"be408996-4835-41d5-8ad1-0df030755e89","type":"PROCESS","attributes":["#Attr-2","#Attr-1"],"data":{"process":{"osType":"Windows","path":"c:\\programs","hashes":null,"signerFingerprint":null}}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 670
{
"id" : "cb285174-60c0-4c99-b084-318e678b80a4",
"zitiId" : "ziti.id.3bw1srxu9d7",
"name" : "My Posture Check 12176048699752917",
"networkId" : "be408996-4835-41d5-8ad1-0df030755e89",
"type" : "PROCESS",
"ownerIdentityId" : "cbbd7b9d-1862-4de6-9371-4d9288f1cd87",
"createdBy" : "cbbd7b9d-1862-4de6-9371-4d9288f1cd87",
"createdAt" : "2023-02-02T14:20:43.280673Z",
"updatedAt" : "2023-02-02T14:20:43.280673Z",
"deletedBy" : null,
"deletedAt" : null,
"attributes" : [ "#Attr-1", "#Attr-2" ],
"data" : {
"process" : {
"osType" : "Windows",
"path" : "c:\\programs",
"hashes" : null,
"signerFingerprint" : null
}
}
}
Update Posture Check
PATCH /posture-checks/{id}
Authorization
This endpoint requires update
action on the posture-check
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
type |
String |
true |
Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI]. |
attributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
ownerIdentityId |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
data |
Object |
true |
|
data.domains |
Array[String] |
false |
|
data.macAddresses |
Array[String] |
false |
|
data.timeoutSeconds |
Integer |
true |
Must be at least 0. |
data.promptOnWake |
Boolean |
true |
|
data.promptOnUnlock |
Boolean |
true |
|
data.ignoreLegacyEndpoints |
Boolean |
true |
|
data.operatingSystems |
Array[Object] |
false |
|
data.operatingSystems[].type |
String |
false |
Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer]. |
data.operatingSystems[].versions |
Array[String] |
false |
|
data.process |
Object |
false |
|
data.process.osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.process.path |
String |
false |
|
data.process.hashes |
Array[String] |
true |
|
data.process.signerFingerprint |
String |
true |
|
data.processes |
Array[Object] |
false |
|
data.processes[].osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.processes[].path |
String |
false |
|
data.processes[].hashes |
Array[String] |
true |
|
data.processes[].signerFingerprints |
Array[String] |
true |
|
data.semantic |
String |
true |
Must be one of [AllOf, AnyOf]. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
zitiId |
String |
false |
Size must be between 1 and 255 inclusive. |
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkId |
String |
false |
|
type |
String |
false |
Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
attributes |
Array[String] |
false |
|
data |
Object |
false |
|
data.domains |
Array[String] |
false |
|
data.macAddresses |
Array[String] |
false |
|
data.timeoutSeconds |
Integer |
true |
Must be at least 0. |
data.promptOnWake |
Boolean |
true |
|
data.promptOnUnlock |
Boolean |
true |
|
data.ignoreLegacyEndpoints |
Boolean |
true |
|
data.operatingSystems |
Array[Object] |
false |
|
data.operatingSystems[].type |
String |
false |
Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer]. |
data.operatingSystems[].versions |
Array[String] |
false |
|
data.process |
Object |
false |
|
data.process.osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.process.path |
String |
false |
|
data.process.hashes |
Array[String] |
true |
|
data.process.signerFingerprint |
String |
true |
|
data.processes |
Array[Object] |
false |
|
data.processes[].osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.processes[].path |
String |
false |
|
data.processes[].hashes |
Array[String] |
true |
|
data.processes[].signerFingerprints |
Array[String] |
true |
|
data.semantic |
String |
true |
Must be one of [AllOf, AnyOf]. |
Hypermedia links
No links.
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks/cb285174-60c0-4c99-b084-318e678b80a4' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIwRUx1YVpVM0toUXQ0OXhVOFdSZTlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFiNzM1ZDYyLWFjMmQtNDNkZS1hNzkzLWJkNjkxNGQ0NGIwMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzY0NywiZXhwIjoxNjc1MzUxMjQ3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBhNzg5NTU3LWVhNzctNDFjNy1hMmU2LTNhYTRmZGUxNjBjMlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzY0N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.D_nl38xw2apKtnXcbBsIwix9ZT9j9EaSnN7B83VWqTP4UvRDW0OXKVRlfyMGyYKkWxfC6A_SBqN-7yes2cn7dHofxUTY5RDI1VdhylaCDH9TVmcKeajbl2YUymoNTOLnGgJCo7xMVWTgCrlwH8-zmyHC5Kqir0Fljz9iQ6QThvDhVXGgof6j4OdpUq5YSLnoADaGsCKSz9zIFqJ_hdQXMN3pYlNhIJnbuBMclxwBd2yvP3c2l4PGMT0Oo-Kds8FPRUPjAsaAqgGyjtCeaqSTq3QsxbSN0JDz4rmQuki457h7fECF84N4m8O8ag_4c1a0GROohHczKy-2ktkIGGOhTQ' \
-d '{"name":"Our Service 12176048699752917","attributes":["#Attr-2","#Attr-4"]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 664
{
"id" : "cb285174-60c0-4c99-b084-318e678b80a4",
"zitiId" : "ziti.id.3bw1srxu9d7",
"name" : "Our Service 12176048699752917",
"networkId" : "be408996-4835-41d5-8ad1-0df030755e89",
"type" : "PROCESS",
"ownerIdentityId" : "cbbd7b9d-1862-4de6-9371-4d9288f1cd87",
"createdBy" : "cbbd7b9d-1862-4de6-9371-4d9288f1cd87",
"createdAt" : "2023-02-02T14:20:43.280673Z",
"updatedAt" : "2023-02-02T14:20:47.454999Z",
"deletedBy" : null,
"deletedAt" : null,
"attributes" : [ "#Attr-4", "#Attr-2" ],
"data" : {
"process" : {
"osType" : "Windows",
"path" : "c:\\programs",
"hashes" : [ ],
"signerFingerprint" : null
}
}
}
Delete Posture Check
DELETE /posture-checks/{id}
Authorization
This endpoint requires delete
action on the posture-check
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
zitiId |
String |
false |
Size must be between 1 and 255 inclusive. |
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
networkId |
String |
false |
|
type |
String |
false |
Must be one of [OS, PROCESS, DOMAIN, MAC, MFA, PROCESS_MULTI]. |
ownerIdentityId |
String |
false |
|
createdBy |
String |
false |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
attributes |
Array[String] |
false |
|
data |
Object |
false |
|
data.domains |
Array[String] |
false |
|
data.macAddresses |
Array[String] |
false |
|
data.timeoutSeconds |
Integer |
true |
Must be at least 0. |
data.promptOnWake |
Boolean |
true |
|
data.promptOnUnlock |
Boolean |
true |
|
data.ignoreLegacyEndpoints |
Boolean |
true |
|
data.operatingSystems |
Array[Object] |
false |
|
data.operatingSystems[].type |
String |
false |
Must be one of [Windows, Android, iOS, Linux, macOS, WindowsServer]. |
data.operatingSystems[].versions |
Array[String] |
false |
|
data.process |
Object |
false |
|
data.process.osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.process.path |
String |
false |
|
data.process.hashes |
Array[String] |
true |
|
data.process.signerFingerprint |
String |
true |
|
data.processes |
Array[Object] |
false |
|
data.processes[].osType |
String |
false |
Must be one of [Windows, WindowsServer, Android, iOS, Linux, macOS]. |
data.processes[].path |
String |
false |
|
data.processes[].hashes |
Array[String] |
true |
|
data.processes[].signerFingerprints |
Array[String] |
true |
|
data.semantic |
String |
true |
Must be one of [AllOf, AnyOf]. |
Hypermedia links
No links.
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/posture-checks/cb285174-60c0-4c99-b084-318e678b80a4' -i -X DELETE \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJjSlpsWEItVldwSE9lazViakVDU3hnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVhMzA1ZDZmLTY1M2EtNGViNi1iNzI3LTk4N2Y1MmZlYjYzNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzY0OSwiZXhwIjoxNjc1MzUxMjQ5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk4ZmQ5ZjU2LTFhZjItNGQ5Zi04M2JlLTE3Y2IwZGQwOGNlMlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzY0OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.EEsGBrV37HYYSiB-wfu1uJ5KRz0vbHhBGbpUWw94Tb4iQlPFthyjMw6Sdn6D-5N0uGwKecAYXYAFYjHvTqDVNILtxAdSXkpy2i2DdW8JV6cw5wIQ_Z7cwZdFTJMQa-Fq8zgfX0g8eLiGnmV7hycUgVDIBKOSUr-_hULde9NsnjsDhaaYaqHzTAcef3-KAOghHH3TkZk_FIwGnqf0nkW_wm-iEm2tJfNyWNE4E7cmauuawKxbP-8o0VAaQl7F0z7vysbHLSKvGK8052ir12jQiNoNZSbqZlDp7rJ-gNqr8PKYYKJmOQbS23uVFoIiz8vyvjgXFfze_jSzsZrVmrpXMg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 700
{
"id" : "cb285174-60c0-4c99-b084-318e678b80a4",
"zitiId" : "ziti.id.3bw1srxu9d7",
"name" : "Our Service 12176048699752917",
"networkId" : "be408996-4835-41d5-8ad1-0df030755e89",
"type" : "PROCESS",
"ownerIdentityId" : "cbbd7b9d-1862-4de6-9371-4d9288f1cd87",
"createdBy" : "cbbd7b9d-1862-4de6-9371-4d9288f1cd87",
"createdAt" : "2023-02-02T14:20:43.280673Z",
"updatedAt" : "2023-02-02T14:20:49.438487Z",
"deletedBy" : "5a305d6f-653a-4eb6-b727-987f52feb636",
"deletedAt" : "2023-02-02T14:20:49.438Z",
"attributes" : null,
"data" : {
"process" : {
"osType" : "Windows",
"path" : "c:\\programs",
"hashes" : [ ],
"signerFingerprint" : null
}
}
}
Certificate Authorities
Find Certificate Authorities
GET /certificate-authorities
Authorization
This endpoint requires read
action on the certificate-authority
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
isAutoCaEnrollment |
Boolean |
true |
Deprecated.. |
isOttCaEnrollmentEnabled |
Boolean |
true |
Deprecated.. |
isAuthEnabled |
Boolean |
true |
Deprecated.. |
isVerified |
Boolean |
true |
Deprecated.. |
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
endpointAttributes |
Array[String] |
false |
|
verificationToken |
String |
true |
|
fingerprint |
String |
true |
|
jwt |
String |
true |
|
certPem |
String |
false |
|
identityNameFormat |
String |
true |
Must match the regular expression |
verified |
Boolean |
true |
|
authEnabled |
Boolean |
true |
|
autoCaEnrollmentEnabled |
Boolean |
true |
|
ottCaEnrollmentEnabled |
Boolean |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
endpointAttributes |
Array[String] |
false |
|
verificationToken |
String |
true |
|
fingerprint |
String |
true |
|
jwt |
String |
true |
|
certPem |
String |
false |
|
identityNameFormat |
String |
true |
Must match the regular expression |
verified |
Boolean |
true |
|
authEnabled |
Boolean |
true |
|
autoCaEnrollmentEnabled |
Boolean |
true |
|
ottCaEnrollmentEnabled |
Boolean |
true |
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities' -i -X GET \
-H 'Accept: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJoRktmN1l2cjFOQXM4bE13R09NWFRBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU1ZDRlZjc0LTU2NGEtNDAxYi04MmI4LTlhMWYxMjI3MGU4OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3OSwiZXhwIjoxNjc1MzUxMTc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImE4MDMzOTZlLTk4MzItNDA5MC04YzhkLTlhMmU3ODBhNzJjYlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Ld-P0A-kdvKKKim1oXjrK3CjbZseJe0N9SivlozkFaTiVegumAEc1x9mo_IwDlCbI97_Oo9tqLu-KPKiqN9tQbtNpiI3w_gclvZ_p0DcvCUiRHxzCNo--J9qR0ZKe2YlzrLTmJpKckgW6KYJZFVgfj2Vd2145gaATOHvdf85GoNRBVm1J7-z30_Tr1bBOCXcqZhgnc0FWnfua7CWs7cslJ9ot_oqSoZF4mJDy6OYGZk1CMl5oAatJEtP0WtapIE51ww3fRlm39-ef5hr9HunGmJmZt0pPHeNW5jAxw5jKkU1YD5RIwJnUb1Dw7JWO2ZL6XBxwXyvGnxBrJYdtApeYQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 3839
{
"_embedded" : {
"certificateAuthorityList" : [ {
"id" : "3d136b10-0bc0-492f-ba07-420dd6673a98",
"ownerIdentityId" : "355474e1-bbff-4b45-89b9-5ce2156951e6",
"createdBy" : "355474e1-bbff-4b45-89b9-5ce2156951e6",
"createdAt" : "2023-02-02T14:19:39.141707Z",
"updatedAt" : "2023-02-02T14:19:39.142958Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "8544cbb9-4755-4904-b55e-db4b708c8e7b",
"zitiId" : "ziti-id-b3a83c1a-7ce8-41d1-a4ba-aab2e9fbb8d8",
"name" : "ca-597",
"endpointAttributes" : [ ],
"verificationToken" : "token",
"fingerprint" : "fingerprint",
"jwt" : "jwt",
"certPem" : "fake-pem",
"identityNameFormat" : "name-format",
"verified" : false,
"authEnabled" : false,
"autoCaEnrollmentEnabled" : false,
"ottCaEnrollmentEnabled" : false,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/3d136b10-0bc0-492f-ba07-420dd6673a98"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/8544cbb9-4755-4904-b55e-db4b708c8e7b"
}
}
}, {
"id" : "69f70168-e7cc-42cb-90d1-73fa0f4a9c91",
"ownerIdentityId" : "89459df3-2aee-4891-add0-3b458e8f705b",
"createdBy" : "89459df3-2aee-4891-add0-3b458e8f705b",
"createdAt" : "2023-02-02T14:19:39.723693Z",
"updatedAt" : "2023-02-02T14:19:39.725017Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "c3b8b3ee-0797-4338-9033-2b9966556c3a",
"zitiId" : "ziti-id-d45e334f-92b7-47b1-9ce8-75aaeb2e7450",
"name" : "ca-625",
"endpointAttributes" : [ ],
"verificationToken" : "token",
"fingerprint" : "fingerprint",
"jwt" : "jwt",
"certPem" : "fake-pem",
"identityNameFormat" : "name-format",
"verified" : false,
"authEnabled" : false,
"autoCaEnrollmentEnabled" : false,
"ottCaEnrollmentEnabled" : false,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/69f70168-e7cc-42cb-90d1-73fa0f4a9c91"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/c3b8b3ee-0797-4338-9033-2b9966556c3a"
}
}
}, {
"id" : "7919b0a6-74a5-4473-b4e0-496470033ab4",
"ownerIdentityId" : "f6844dab-b8ca-450e-9467-8b33d6901719",
"createdBy" : "f6844dab-b8ca-450e-9467-8b33d6901719",
"createdAt" : "2023-02-02T14:19:38.961633Z",
"updatedAt" : "2023-02-02T14:19:38.962811Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "b9c0f934-d586-4d8a-8c47-93e97270a8c7",
"zitiId" : "ziti-id-f9375bde-8857-4038-9866-e67a26cc09f7",
"name" : "ca-590",
"endpointAttributes" : [ ],
"verificationToken" : "token",
"fingerprint" : "fingerprint",
"jwt" : "jwt",
"certPem" : "fake-pem",
"identityNameFormat" : "name-format",
"verified" : false,
"authEnabled" : false,
"autoCaEnrollmentEnabled" : false,
"ottCaEnrollmentEnabled" : false,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/7919b0a6-74a5-4473-b4e0-496470033ab4"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b9c0f934-d586-4d8a-8c47-93e97270a8c7"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities"
}
},
"page" : {
"size" : 3500,
"totalElements" : 8,
"totalPages" : 1,
"number" : 0
}
}
Get Certificate Authority
GET /certificate-authorities/{id}
Authorization
This endpoint requires read
action on the certificate-authority
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
endpointAttributes |
Array[String] |
false |
|
verificationToken |
String |
true |
|
fingerprint |
String |
true |
|
jwt |
String |
true |
|
certPem |
String |
false |
|
identityNameFormat |
String |
true |
Must match the regular expression |
verified |
Boolean |
true |
|
authEnabled |
Boolean |
true |
|
autoCaEnrollmentEnabled |
Boolean |
true |
|
ottCaEnrollmentEnabled |
Boolean |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/ee2fb4e4-9423-4aa3-829d-3153af1af162' -i -X GET \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJwaS03cUFxeGdlMlpjdk9nSS1vYzR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ4YjFlMTNhLTI3ZWMtNDJlYS1iMjU5LTlkMGE3NTI4MDgyMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3OSwiZXhwIjoxNjc1MzUxMTc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImUyZWNiZWRiLTEwMDYtNDdlZS1iMjVhLTMwNmQ5ZWY2YjA1OVwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.cTGgq2QKDQZsJlqi-WKofNeYGtg9STnzzwpH_LjqE8_07P7jLxs-rrIIcSNw9edwJya7yI62F5FDfA00hQT5UTkVRZNhm1ZolEJn25AsAaO6y_nuaoyVkevK95Fq3QZn5q38ThZxMFRjxlglMdd_yRkgAVRQw-p_DErt1CiVto5c8LIjhr42ZqE3AFURoZvB7GgIMHlLQ22MSJE7O1l84GTdd3_kH0PmHgLCTHsrIILJMYW_GzJsKdXZyqbA-VmneQyTwcQRP6eYANfJ5TxGxLly597LYoNmnjrcVQNbtEjF2XJ2w8kNfOgMZdgsE4a1zs_-_chtiLuBTpVUCnUppQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1064
{
"id" : "ee2fb4e4-9423-4aa3-829d-3153af1af162",
"ownerIdentityId" : "88126e8c-cd2b-4bbf-890e-d4f2baea745e",
"createdBy" : "88126e8c-cd2b-4bbf-890e-d4f2baea745e",
"createdAt" : "2023-02-02T14:19:39.972177Z",
"updatedAt" : "2023-02-02T14:19:39.973039Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "608baf4d-a746-4bb5-866c-e2488342a100",
"zitiId" : "ziti-id-3c44b5c9-3dcb-46cc-bdaf-672828e77d1e",
"name" : "ca-639",
"endpointAttributes" : [ ],
"verificationToken" : "token",
"fingerprint" : "fingerprint",
"jwt" : "jwt",
"certPem" : "fake-pem",
"identityNameFormat" : "name-format",
"verified" : false,
"authEnabled" : false,
"autoCaEnrollmentEnabled" : false,
"ottCaEnrollmentEnabled" : false,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/ee2fb4e4-9423-4aa3-829d-3153af1af162"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/608baf4d-a746-4bb5-866c-e2488342a100"
}
}
}
Create Certificate Authority
POST /certificate-authorities
Authorization
This endpoint requires create
action on the certificate-authority
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
networkId |
String |
true |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
autoCaEnrollmentEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
authEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
ottCaEnrollmentEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
certPem |
String |
false |
Size must be between 100 and 2147483647 inclusive. |
endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
identityNameFormat |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
endpointAttributes |
Array[String] |
false |
|
verificationToken |
String |
true |
|
fingerprint |
String |
true |
|
jwt |
String |
true |
|
certPem |
String |
false |
|
identityNameFormat |
String |
true |
Must match the regular expression |
verified |
Boolean |
true |
|
authEnabled |
Boolean |
true |
|
autoCaEnrollmentEnabled |
Boolean |
true |
|
ottCaEnrollmentEnabled |
Boolean |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities' -i -X POST \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ1SXRNQlFGWDJGWFhfbUppTTlVVkdRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjViMTRlYWE2LTRjNzctNGRjYS04ZDUwLTY2NWJmMTM5MzUzNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3OCwiZXhwIjoxNjc1MzUxMTc4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBhMjJlOTk0LTI4MjktNDAyZi1iY2VjLTc4NmZmYTA2YTJkY1wiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.doqb_978pd1wLWrjYw7_KprUTFbgF8o8b1xouJBA1jsbsG8a4Lri6LEF4EmJ0_hDZVE5BibGGw11jOkXY9_YbvdJoQy2MmXoWnRN1-LuYKDJGX2fcCL_iReGcSTGI9Hk-RE0gqxqOP3s7llfDUe3nGS36RdDvd5IJ6OCjz-KDgK5lsHd_w2bXoHEjZPZkFAHqUWAaW-dLIiIvmXosIccIo-Gdb6HfMNIHvzm6D6csM1ks0tK-XzTsof-t8R76zKoiU2CbSyOfJjhdx894kdNNZigwJP3LX9zLHmkSQvkyKu6mhqKBphKxg2RX7kHf1KhrcJ253fcVoUVAxLkJqTwVQ' \
-d '{"networkId":"b9c0f934-d586-4d8a-8c47-93e97270a8c7","name":"Test ca 02","autoCaEnrollmentEnabled":true,"authEnabled":false,"ottCaEnrollmentEnabled":false,"certPem":"-----BEGIN CERTIFICATE-----\nMIIEujCCAqKgAwIBAgIRAL9YVv7hhgdfje0+onHqzogwDQYJKoZIhvcNAQELBQAw\nczELMAkGA1UEBhMCVVMxEjAQBgNVBAcTCUNoYXJsb3R0ZTETMBEGA1UEChMKTmV0\nRm91bmRyeTEQMA4GA1UECxMHQURWLURFVjEpMCcGA1UEAxMgTmV0Rm91bmRyeSwg\nSW5jLiBJbnRlcm1lZGlhdGUgQ0EwHhcNMjEwMTE1MjEwMDU3WhcNMjIwMTE1MjEw\nMTU3WjBcMQswCQYDVQQGEwJVUzESMBAGA1UEBxMJQ2hhcmxvdHRlMRMwEQYDVQQK\nEwpOZXRGb3VuZHJ5MRAwDgYDVQQLEwdBRFYtREVWMRIwEAYDVQQDEwlrWHdMajA0\nWFQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDJDRmC32XN31LU04Q4\nuh2uco+78sxCg8BzBbxQ7LrXRqdnfeuskoOx+b8OcA9Af4U9Co8rqrPaUR3y1bME\n5fIhZTFjesV3Z+V+dRyLlQQ6/tXybBwYeBUUwE/NSECx5jKXbLX3WgLISffxFToB\n5FVhX2okCkOPOOXiirKwUe9pCfWafnEJAevjH001nEMDh2Ir5Yny6PrU3SgRj9F1\n+aZ3kuattq89JybUofN1HHTGPOAUUzXIudhhFQC2HYGABGbxvoWBSFmM6i+oWHS9\nGOX5YnfApcbRDEiWHnGfQEPCOG3sRcA/NfPwV9wChyPMadgXNl+Pc9aFEOj20qmk\n/LK5AgMBAAGjYDBeMA4GA1UdDwEB/wQEAwIF4DAMBgNVHRMBAf8EAjAAMB0GA1Ud\nDgQWBBRERYGCL0A1YBMCUbxwz4sAk6cfkTAfBgNVHSMEGDAWgBTFYtjJ5IqMPUdx\n6X0KdeZqZratzzANBgkqhkiG9w0BAQsFAAOCAgEAekd7/VB1nWpLa/2iu7xz8C0M\nPnkczH4qvWSgoJ7tJ+bXqT4+CL3T4jk7kRFxAj6YXDaTyrhzlwtNxmmH0fcJ0NNX\nF+86pAAJWbjzgpy20YOy++R4FgJM0Mai6FRDeec94BdFV90ZDxfQ7UJtV3DXtzZA\nVZGUMo/hsPWi0g2LzJxj2jScugjHBl5rbdc8eQdenAg4Es47dac7sF4XBLocYZey\nei4LxaAgVW+R8RmU+VrJv8HcTiRaweo5/47DxYTCg69LvKThf/ow2nS+BW1bHEyD\n7EI++UuBk/qwoSEtjpMaXlPzN4hMk/Ht7JeifYvWloz2VgJQm8C7O4jplUcVmHkL\n2OgpGhXiEidA5w1xBInuohQQIK+jSFh7sxG/Ck0EVNIE9BfOc6hhM6emL0xFDoNd\nSXEGLs4Fm4IaazJJxREJZoB2Cb5c7MKvO6EMF08xG2JNf2P9QiQu6nWZFmyh3wUK\nY6/LW6YlOhPAmbQ/gu0q+0UuzgnJU61vrIedekDK8q4ePvFZDEsXKg+gA14d5eGh\n4dRrOqvUZtyE8r6g8vUveQsOpjt7BML6p7kSXW6OGe2K5FrnF2vhJSbHd/zb+VFh\nm355ssqubCpNpfnrHGoquQVbXJ3HyFEQ0i+BugEUDDE2lIofz/qlq9x+vtb13CMI\ny1w5WLo3pCVTsufnZmo=\n-----END CERTIFICATE-----","endpointAttributes":["#secureclients"]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2933
{
"id" : "a9c5b56b-fe5e-47b0-8aaf-80c439fd0d81",
"ownerIdentityId" : "5b14eaa6-4c77-4dca-8d50-665bf1393537",
"createdBy" : "5b14eaa6-4c77-4dca-8d50-665bf1393537",
"createdAt" : "2023-02-02T14:19:39.024395Z",
"updatedAt" : "2023-02-02T14:19:39.030301Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "b9c0f934-d586-4d8a-8c47-93e97270a8c7",
"zitiId" : "52eed6e8-dcf6-485a-8a43-e12db8133df8",
"name" : "Test ca 02",
"endpointAttributes" : [ "#secureclients" ],
"verificationToken" : null,
"fingerprint" : null,
"jwt" : null,
"certPem" : "-----BEGIN CERTIFICATE-----MIIEujCCAqKgAwIBAgIRAL9YVv7hhgdfje0+onHqzogwDQYJKoZIhvcNAQELBQAwczELMAkGA1UEBhMCVVMxEjAQBgNVBAcTCUNoYXJsb3R0ZTETMBEGA1UEChMKTmV0Rm91bmRyeTEQMA4GA1UECxMHQURWLURFVjEpMCcGA1UEAxMgTmV0Rm91bmRyeSwgSW5jLiBJbnRlcm1lZGlhdGUgQ0EwHhcNMjEwMTE1MjEwMDU3WhcNMjIwMTE1MjEwMTU3WjBcMQswCQYDVQQGEwJVUzESMBAGA1UEBxMJQ2hhcmxvdHRlMRMwEQYDVQQKEwpOZXRGb3VuZHJ5MRAwDgYDVQQLEwdBRFYtREVWMRIwEAYDVQQDEwlrWHdMajA0WFQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDJDRmC32XN31LU04Q4uh2uco+78sxCg8BzBbxQ7LrXRqdnfeuskoOx+b8OcA9Af4U9Co8rqrPaUR3y1bME5fIhZTFjesV3Z+V+dRyLlQQ6/tXybBwYeBUUwE/NSECx5jKXbLX3WgLISffxFToB5FVhX2okCkOPOOXiirKwUe9pCfWafnEJAevjH001nEMDh2Ir5Yny6PrU3SgRj9F1+aZ3kuattq89JybUofN1HHTGPOAUUzXIudhhFQC2HYGABGbxvoWBSFmM6i+oWHS9GOX5YnfApcbRDEiWHnGfQEPCOG3sRcA/NfPwV9wChyPMadgXNl+Pc9aFEOj20qmk/LK5AgMBAAGjYDBeMA4GA1UdDwEB/wQEAwIF4DAMBgNVHRMBAf8EAjAAMB0GA1UdDgQWBBRERYGCL0A1YBMCUbxwz4sAk6cfkTAfBgNVHSMEGDAWgBTFYtjJ5IqMPUdx6X0KdeZqZratzzANBgkqhkiG9w0BAQsFAAOCAgEAekd7/VB1nWpLa/2iu7xz8C0MPnkczH4qvWSgoJ7tJ+bXqT4+CL3T4jk7kRFxAj6YXDaTyrhzlwtNxmmH0fcJ0NNXF+86pAAJWbjzgpy20YOy++R4FgJM0Mai6FRDeec94BdFV90ZDxfQ7UJtV3DXtzZAVZGUMo/hsPWi0g2LzJxj2jScugjHBl5rbdc8eQdenAg4Es47dac7sF4XBLocYZeyei4LxaAgVW+R8RmU+VrJv8HcTiRaweo5/47DxYTCg69LvKThf/ow2nS+BW1bHEyD7EI++UuBk/qwoSEtjpMaXlPzN4hMk/Ht7JeifYvWloz2VgJQm8C7O4jplUcVmHkL2OgpGhXiEidA5w1xBInuohQQIK+jSFh7sxG/Ck0EVNIE9BfOc6hhM6emL0xFDoNdSXEGLs4Fm4IaazJJxREJZoB2Cb5c7MKvO6EMF08xG2JNf2P9QiQu6nWZFmyh3wUKY6/LW6YlOhPAmbQ/gu0q+0UuzgnJU61vrIedekDK8q4ePvFZDEsXKg+gA14d5eGh4dRrOqvUZtyE8r6g8vUveQsOpjt7BML6p7kSXW6OGe2K5FrnF2vhJSbHd/zb+VFhm355ssqubCpNpfnrHGoquQVbXJ3HyFEQ0i+BugEUDDE2lIofz/qlq9x+vtb13CMIy1w5WLo3pCVTsufnZmo=-----END CERTIFICATE-----",
"identityNameFormat" : null,
"verified" : false,
"authEnabled" : false,
"autoCaEnrollmentEnabled" : false,
"ottCaEnrollmentEnabled" : false,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/a9c5b56b-fe5e-47b0-8aaf-80c439fd0d81"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/b9c0f934-d586-4d8a-8c47-93e97270a8c7"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/07c54ec5-63a6-446b-a014-6ee40787eaa0",
"title" : "Create CertificateAuthority",
"profile" : "meta"
}
}
}
Verify Certificate Authority
POST /certificate-authorities/{id}/verify
Authorization
This endpoint requires update
action on the certificate-authority
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
endpointAttributes |
Array[String] |
false |
|
verificationToken |
String |
true |
|
fingerprint |
String |
true |
|
jwt |
String |
true |
|
certPem |
String |
false |
|
identityNameFormat |
String |
true |
Must match the regular expression |
verified |
Boolean |
true |
|
authEnabled |
Boolean |
true |
|
autoCaEnrollmentEnabled |
Boolean |
true |
|
ottCaEnrollmentEnabled |
Boolean |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/90673524-9c55-4761-9ec8-ef5a2cd8673b/verify' -i -X POST \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJaRzJ4NU4wdWh6OVVfLUx1c3JoQm9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI1YzE2NjhhLTI2OTAtNDYzNS05MmNhLTBhNTc3ZjNjZTMyNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3OSwiZXhwIjoxNjc1MzUxMTc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImVkMTdjZjI5LTJjZDYtNDZlNC1iNDRiLTI3NjIyMjcxYzVjOFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.gIkyHbQYIK0kPC3aK-pZgxaQX_0qrc7G7c1zfK5ss67GL3rtALnsRXVFoHhREy7AaLFr_9k1fWSAUdd7dc2HMKkueN5h1IrSQRmyUZdljtrNnDTzO5XNegp0dY7kcUu8gVR_8QuB3zU032eZ1OcCRjIsAIsgPjPA7mrSReCt8nNd5JGQfRVreaZ06A-B5CLaBxukhHeEFG6el3rrBJnox86BKolQcyRsbwNAav910OtSvktV1UZQ8gw6hrdzC38pnR2bbQJqBe_ejtm1DbWFHLrMK96-pawuGrR0ZHgfjEVtfzI4sx7i54EkkyGmEI9lEVvRryKwrKgQUv1DUFTQag' \
-d '<testcertverificationbody>'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1064
{
"id" : "90673524-9c55-4761-9ec8-ef5a2cd8673b",
"ownerIdentityId" : "fb17dd50-f0ae-47ec-8df2-2f305cc47304",
"createdBy" : "fb17dd50-f0ae-47ec-8df2-2f305cc47304",
"createdAt" : "2023-02-02T14:19:39.416497Z",
"updatedAt" : "2023-02-02T14:19:39.417597Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "5223ca5c-d7f6-4ccb-93a6-8f28b7b0f9eb",
"zitiId" : "ziti-id-d9203ce7-3c28-4505-9e66-45cbec635d8f",
"name" : "ca-611",
"endpointAttributes" : [ ],
"verificationToken" : "token",
"fingerprint" : "fingerprint",
"jwt" : "jwt",
"certPem" : "fake-pem",
"identityNameFormat" : "name-format",
"verified" : false,
"authEnabled" : false,
"autoCaEnrollmentEnabled" : false,
"ottCaEnrollmentEnabled" : false,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/90673524-9c55-4761-9ec8-ef5a2cd8673b"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/5223ca5c-d7f6-4ccb-93a6-8f28b7b0f9eb"
}
}
}
Patch Certificate Authority
PATCH /certificate-authorities/{id}
Authorization
This endpoint requires update
action on the certificate-authority
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
autoCaEnrollmentEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
authEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
ottCaEnrollmentEnabled |
Boolean |
true |
io.netfoundry.common.util.validation.ValidAs. |
endpointAttributes |
Array[String] |
true |
io.netfoundry.common.util.validation.ValidAs. |
identityNameFormat |
String |
true |
io.netfoundry.common.util.validation.ValidAs. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
endpointAttributes |
Array[String] |
false |
|
verificationToken |
String |
true |
|
fingerprint |
String |
true |
|
jwt |
String |
true |
|
certPem |
String |
false |
|
identityNameFormat |
String |
true |
Must match the regular expression |
verified |
Boolean |
true |
|
authEnabled |
Boolean |
true |
|
autoCaEnrollmentEnabled |
Boolean |
true |
|
ottCaEnrollmentEnabled |
Boolean |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/ce12f852-ff12-4f5b-b5e9-6cf34d4f331a' -i -X PATCH \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIycWYxM0tDTGZsdkdhMV9FRHpvTUl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJhZWE1Y2IyLTM1MzktNDg0My05YWRiLTkxOWJhNWI5MTZkMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3OSwiZXhwIjoxNjc1MzUxMTc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZjMWJkMmQzLTRiMTAtNDQwMS1hMTk3LTMzNjc4YTZkZTNhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Coq4Nif2SmkM-F_TQC7ojCuHDTYW31NqOFXeqWNSkiFS-fdhr3FqbIfn3jTYcyYPZzq-c8yyiCYK7Q1UTvzG0EB7WCHt_hnKgMyuOpb_rJ_H5Vxqzx4j96xycpQXcJkOCPHC2uENUMuhtgCLYhXADoJIiFRExcnt1GRbTlol71NORrADEnyDKxRrRHiZjG7h1jMsWp1qtvth76h3X5BmF-0nsBKRfW0I5rRSNYkbsneEbmGvBeuSNS-D0KjQJunDly0Q86Jtztrl_uiHkvuw8FzNjUGV_eYTsBBJF_VL69wvnsI9DHf2w6ZQSLsVeVe9rqWt1nZrt-hirGbd12Q69A' \
-d '{"name":"Test ca 02 updated"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1278
{
"id" : "ce12f852-ff12-4f5b-b5e9-6cf34d4f331a",
"ownerIdentityId" : "019dc826-e773-4d25-b21f-f607c0b56da7",
"createdBy" : "019dc826-e773-4d25-b21f-f607c0b56da7",
"createdAt" : "2023-02-02T14:19:39.265065Z",
"updatedAt" : "2023-02-02T14:19:39.266172Z",
"deletedBy" : null,
"deletedAt" : null,
"networkId" : "3b278ec6-5902-4c99-8501-1eaf4e5e4c78",
"zitiId" : "ziti-id-445ede51-711d-4979-9157-856880d9dca1",
"name" : "ca-604",
"endpointAttributes" : [ ],
"verificationToken" : "token",
"fingerprint" : "fingerprint",
"jwt" : "jwt",
"certPem" : "fake-pem",
"identityNameFormat" : "name-format",
"verified" : false,
"authEnabled" : false,
"autoCaEnrollmentEnabled" : false,
"ottCaEnrollmentEnabled" : false,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/ce12f852-ff12-4f5b-b5e9-6cf34d4f331a"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/3b278ec6-5902-4c99-8501-1eaf4e5e4c78"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/203c291d-ee33-4598-bdc3-94a661a5edc0",
"title" : "Update CertificateAuthority",
"profile" : "meta"
}
}
}
Delete Certificate Authority
DELETE /certificate-authorities/{id}
Authorization
This endpoint requires delete
action on the certificate-authority
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Client lacks authorization for the '{action}' action on the '{resourceDesc}' resource over the {pathDesc} resource path. |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |
|
updatedAt |
String |
false |
|
deletedBy |
String |
true |
|
deletedAt |
String |
true |
|
networkId |
String |
false |
|
zitiId |
String |
false |
|
name |
String |
false |
io.netfoundry.core.validation.ValidResourceName. |
endpointAttributes |
Array[String] |
false |
|
verificationToken |
String |
true |
|
fingerprint |
String |
true |
|
jwt |
String |
true |
|
certPem |
String |
false |
|
identityNameFormat |
String |
true |
Must match the regular expression |
verified |
Boolean |
true |
|
authEnabled |
Boolean |
true |
|
autoCaEnrollmentEnabled |
Boolean |
true |
|
ottCaEnrollmentEnabled |
Boolean |
true |
Hypermedia links
Path | Optional | Description |
---|---|---|
self |
false |
|
network |
false |
Embedded resources
No embedded resources.
Example request
$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/de7731ed-f594-4fad-af4a-721f8b806203' -i -X DELETE \
-H 'Content-Type: application/hal+json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJWc2hWcGVyVi1HelZ3MEozUGdieURRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImExMmQ4NzI2LWVlODItNDJlNS04OGE4LTMxNzgwZTFmZTJlYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTY3NTM0NzU3OSwiZXhwIjoxNjc1MzUxMTc5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhkZGYyYjY1LTNkNTYtNDY4OC05YzU4LTc2ODU3ZGFjM2UzOFwiLFwibGFzdE1vZGlmaWVkXCI6MTY3NTM0NzU3OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.A0iLZ1Q-5E5hbTnaNbn6FuYgwE992xpuG1Jj6zkJVLgdDOD0TBg81hZsVqFlWxtfox6dszr20Ihy2ixxS_P68YpqKh5q9YoalEhUwFkcLP4mu-5bdNPU8ywbjuGANzGkrFD7hOCNJhKl0wUm5Ul0fPqcdt3Oe33peshQcQE6v7iLn2KSCNamxxL-WxCT3Jgsn9_chg7qAyRu-9-DSxhtTSUPJ7kJ0Nq7hZglGZpXKzHqvoD0aQi7EMMXl4kr9MBh4h2YfMke-AYmBevzqlHytBWr9aKWIex-P9ogznuW32snLHcyAdO88KBFGgjztyQOTzEmuuuMh3k7phZGvsCwQg'
Example response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1334
{
"id" : "de7731ed-f594-4fad-af4a-721f8b806203",
"ownerIdentityId" : "3592fda6-2943-4280-a27e-2a10dfdb1483",
"createdBy" : "3592fda6-2943-4280-a27e-2a10dfdb1483",
"createdAt" : "2023-02-02T14:19:39.598258Z",
"updatedAt" : "2023-02-02T14:19:39.619878Z",
"deletedBy" : "a12d8726-ee82-42e5-88a8-31780e1fe2ec",
"deletedAt" : "2023-02-02T14:19:39.619Z",
"networkId" : "defd2fdd-f895-48ba-972e-ed20fc70f85b",
"zitiId" : "ziti-id-5298a5a2-bfde-422a-81dd-3041c83c638c",
"name" : "ca-618",
"endpointAttributes" : [ ],
"verificationToken" : "token",
"fingerprint" : "fingerprint",
"jwt" : "jwt",
"certPem" : "fake-pem",
"identityNameFormat" : "name-format",
"verified" : false,
"authEnabled" : false,
"autoCaEnrollmentEnabled" : false,
"ottCaEnrollmentEnabled" : false,
"_links" : {
"self" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/de7731ed-f594-4fad-af4a-721f8b806203"
},
"network" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/defd2fdd-f895-48ba-972e-ed20fc70f85b"
},
"execution" : {
"href" : "https://gateway.production.netfoundry.io/core/v2/executions/ae3cc947-b046-4421-a084-1a6faf5cc336",
"title" : "Delete CertificateAuthority",
"profile" : "meta"
}
}
}
Find Certificate Authorities
GET /certificate-authorities
Authorization
This endpoint requires read
action on the certificate-authority
resource type.
Path parameters
No parameters.
Query parameters
Supports standard paging query parameters.
Parameter | Type | Optional | Description |
---|---|---|---|
isAutoCaEnrollment |
Boolean |
true |
Deprecated.. |
isOttCaEnrollmentEnabled |
Boolean |
true |
Deprecated.. |
isAuthEnabled |
Boolean |
true |
Deprecated.. |
isVerified |
Boolean |
true |
Deprecated.. |
Request fields
No request body.
Response fields
Standard paging response where content
field is list of following objects:
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
false |
|
ownerIdentityId |
String |
true |
|
createdBy |
String |
true |
|
createdAt |
String |
false |