Introduction

This is the NetFoundry Network Management Service

Overview

HTTP verbs

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

Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT

Used to update an existing resource, full updates only

PATCH

Used to update an existing resource, partial updates

DELETE

Used to delete an existing resource

HTTP status codes

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

Status code Usage

200 OK

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

201 Created

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

202 Accepted

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

204 No Content

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

400 Bad Request

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

401 Unauthorized

The request lacks valid authentication credentials for the target resource.

403 Forbidden

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

404 Not Found

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

Pagination

Paginated services will accept the following optional request parameters:

Table 1. Request parameters
Path Type Optional Description

page

Integer

true

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

size

Integer

true

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

sort

String

true

Properties that should be sorted by in the format property,property(,ASC|DESC). Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. ?sort=firstname&sort=lastname,asc.

Pagination response has following structure:

Table 2. Response structure
Path Type Optional Description

content

Array[Object]

false

Actual items.

totalElements

Integer

false

Total count.

totalPages

Integer

false

Total pages with current page size.

last

Boolean

false

If this page is the last one.

numberOfElements

Integer

false

Actual size of content array (number of items).

first

Boolean

false

If this page is the first one.

sort

Object

true

Sort information object.

size

Integer

false

Requested size of the page.

number

Integer

false

Page number.

empty

booloean

false

If this page is empty.

Resources

Data Centers

Find Data Centers

GET /data-centers

Authorization

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

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

hostType

String

true

Must be one of [NC, ER].

productVersion

String

true

provider

String

true

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

Request fields

No request body.

Response fields

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

Path Type Optional Description

id

String

true

address

String

true

city

String

true

stateCode

String

true

stateName

String

true

continentName

String

true

continentCode

String

true

countryName

String

true

countryCode

String

true

isp

String

true

lat

Decimal

true

lng

Decimal

true

locationCode

String

true

locationName

String

true

provider

String

true

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

Path Optional Description

self

false

network

false

Embedded resources

Path Type Optional Description

id

String

true

address

String

true

city

String

true

stateCode

String

true

stateName

String

true

continentName

String

true

continentCode

String

true

countryName

String

true

countryCode

String

true

isp

String

true

lat

Decimal

true

lng

Decimal

true

locationCode

String

true

locationName

String

true

provider

String

true

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

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/data-centers' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJielNoRUZDU3IwcktWT3I3S21BSmpBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhhODhhMGNjLWYwZGQtNGNmZS1hY2I5LWNkNTU0YThkYzQ1NCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE0MCwiZXhwIjoxNTk5Nzc0NzQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZkOTYwZWQ2LTMwOWItNDE1OS05YmYwLTI3NWZmYTZjYjYzNlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.bNax--T54_ytNudEh-QT5dA1niFTW9yHnPWJuDaoa5Y5nOKSfKQrOnQxmtoDhr3VEbPS8la1FzpeuvirB-FEMTzB18SrR9VbRl7ejGjAq77Br60hVIbSqs4TI5s98_RKoI9Zm3VBNKZKRjKaL7ys9Re20Lry6V0twKrHhS2cEXStk-srFjKJxBUT_3HHytWbh0bdBv76Ogri4ia_HqUc90kAJSxmA3DhHkD0PHsxZAnoTA9hijr5cc8iKBcPHr5NiPQjlZpI0NPGQgfFYkz7tEMJwvOE9-PQ779buuZr4VstwtyLqNbWjkBxsu6CZ4YBZjxq4UiMRaBtENjb7xHO6g'

Example response

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

{
  "_embedded" : {
    "dataCenters" : [ {
      "id" : "96cae2ed-2ae1-41c7-86b9-97d720c8fa22",
      "address" : null,
      "city" : null,
      "stateCode" : null,
      "stateName" : null,
      "continentName" : null,
      "continentCode" : null,
      "countryName" : null,
      "countryCode" : null,
      "isp" : null,
      "lat" : null,
      "lng" : null,
      "locationCode" : "us-east4-a",
      "locationName" : null,
      "provider" : "GCP",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/data-centers/96cae2ed-2ae1-41c7-86b9-97d720c8fa22"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/data-centers"
    }
  },
  "page" : {
    "size" : 2000,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Network Configurations

Find Network Config Metadata

GET /network-configs

Authorization

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

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

name

String

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

id

String

true

name

String

true

awsNetworkControllerSize

String

true

awsGatewaySize

String

true

awsTransferNodeSize

String

true

azureTransferNodeSize

String

true

alicloudTransferNodeSize

String

true

gcpTransferNodeSize

String

true

networkControllerVolumeSize

Integer

true

transferNodeVolumeSize

Integer

true

gatewayVolumeSize

Integer

true

Path Optional Description

self

false

network

false

Embedded resources

Path Type Optional Description

id

String

true

address

String

true

city

String

true

stateCode

String

true

stateName

String

true

continentName

String

true

continentCode

String

true

countryName

String

true

countryCode

String

true

isp

String

true

lat

Decimal

true

lng

Decimal

true

locationCode

String

true

locationName

String

true

provider

String

true

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

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/network-configs' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJSWmJfdGZUd3k3S0xOY3BrTE9OMjJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYyMDNiYzA5LTQ2Y2ItNDVkMC04OTY1LTZlOTQyMTZiMTU5MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE0MCwiZXhwIjoxNTk5Nzc0NzQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjdjYjhkNDFhLTliNzEtNGYzNC1hMTZjLTExY2ExNDQ3OGZiMlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE0MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.VFsj94zsUu7jKUz7Ps1Fwx5mPfj7-PglViGuZ5ERAiCp906bds44xYY0XWRznezA6bPFaKARtubbVlahWM95EnTKuTsMPLEOlFKJmTb3MHeHf7AKK0Q2TMq62ATZoGP-VSx43Ve_obyjSThbZQjn4fUkRmm-9wegHG0tD2yIvIaI8jj0Bux_ltqzNzeOOEKfq6YwP3oHFTV-JR0HDB-cLSBv0a5WI31p9aIBrDzbQfkcu3GbHTKUz7L_a0mnhcNzgZlaBtY5f8OV8rLeXfPDVRTU6xy-yoGkJk66EcgHHr0SFky9uYOL9nR6VPjrRcEV7ukBswUdm9GJt7qQCZJbIA'

Example response

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

{
  "_embedded" : {
    "networkConfigMetadataList" : [ {
      "id" : "061c5409-86a4-4a94-96d2-8be96c02b2c2",
      "name" : "small",
      "awsNetworkControllerSize" : null,
      "awsGatewaySize" : null,
      "awsTransferNodeSize" : null,
      "azureTransferNodeSize" : null,
      "alicloudTransferNodeSize" : null,
      "gcpTransferNodeSize" : null,
      "networkControllerVolumeSize" : 0,
      "transferNodeVolumeSize" : 0,
      "gatewayVolumeSize" : 0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-configs/061c5409-86a4-4a94-96d2-8be96c02b2c2"
        }
      }
    }, {
      "id" : "fb8c85c8-d255-49e6-ad06-a16419b723bb",
      "name" : "medium",
      "awsNetworkControllerSize" : null,
      "awsGatewaySize" : null,
      "awsTransferNodeSize" : null,
      "azureTransferNodeSize" : null,
      "alicloudTransferNodeSize" : null,
      "gcpTransferNodeSize" : null,
      "networkControllerVolumeSize" : 0,
      "transferNodeVolumeSize" : 0,
      "gatewayVolumeSize" : 0,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/network-configs/fb8c85c8-d255-49e6-ad06-a16419b723bb"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/network-configs"
    }
  },
  "page" : {
    "size" : 2000,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Networks

Find Networks

GET /networks

Authorization

This endpoint requires read action on the network resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

findByName

String

true

findByNetworkGroupId

Object

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

name

String

true

id

String

true

Network ID.

updatedAt

String

true

status

String

true

networkGroupId

String

true

deletedAt

String

true

createdAt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

productVersion

String

true

networkConfigMetadataId

String

true

o365BreakoutCategory

String

true

Path Optional Description

self

false

A canonical URI; The link to this resource.

edgeRouters

false

Link to the collection of edge-routers within this Network.

edgeRouterPolicies

false

Link to the collection of edge-router-policies within this Network.

endpoints

false

Link to the collection of endpoints within this Network.

services

false

Link to the collection of services within this Network.

appWans

false

Link to the collection of app-wans within this Network.

certificateAuthorities

false

Link to the collection of certificate-authorities within this Network.

Embedded resources

Path Type Optional Description

name

String

true

id

String

true

Network ID.

updatedAt

String

true

status

String

true

networkGroupId

String

true

deletedAt

String

true

createdAt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

productVersion

String

true

networkConfigMetadataId

String

true

o365BreakoutCategory

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJjQk50Y0pTYlJldUpFazl4VURrajZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjY0ZGU5NWMzLTQ0YzgtNDg3MS1iZmQxLThmMWY5Zjk3MmViYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE4OSwiZXhwIjoxNTk5Nzc0Nzg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBlMTJlNTA5LTRiMWMtNGRiMS04NDkwLTExMDQxNzcwYWQ3OFwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.HEeGZFAXOxd2vYhltX-3WqsGNNwIMhgGYkYtF3ZR2L-PzltrEBMM5utXVYy4ZzoyfQblbE4LxvDG7ty8RRDvX0s9T9PsvGjbktONaBRLCPOaxFc5SjPrAe4KsEq1RiFOdHM5BUp8WNhsi9O-tDeCU1aLGZEMllx1k3zZuRMjPF22Hrjkkuse-MPARely8j1yX8z5xZZi63emx_Y-Ve4aQsmaPgECc68d7ElsmgcXoNz7S5v1k0MILN8DwsftOIwDzRBr1Gsf4KRfcGZvMo1Eu0xBPVyRS5TTBsmUDTgCUCSfpIYqbPVz94bz2KTpORMCTJJLMxunxtF80-VOjhWjwA'

Example response

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

{
  "_embedded" : {
    "networkList" : [ {
      "name" : "ACME Network2020-09-10T20:53:09.148Z",
      "id" : "4dba3124-737d-4962-bbe4-14a788616de7",
      "updatedAt" : "2020-09-10T20:53:09.150Z",
      "status" : "PROVISIONED",
      "networkGroupId" : "69a6dde4-7ac5-4257-89e6-3ed80d60d46c",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:53:09.149Z",
      "ownerIdentityId" : "580258a6-8aee-4a67-9c74-07c9dcbd05af",
      "createdBy" : "580258a6-8aee-4a67-9c74-07c9dcbd05af",
      "deletedBy" : null,
      "productVersion" : "7.0.0",
      "networkConfigMetadataId" : "8ea42b94-f99d-4d21-8dc9-6cfdfe1ad828",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4dba3124-737d-4962-bbe4-14a788616de7"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
        }
      }
    }, {
      "name" : "ACME Network Unprovisioned 2020-09-10T20:53:09.150Z",
      "id" : "9fab7234-7f7e-4fba-a9a3-118c307bba7d",
      "updatedAt" : "2020-09-10T20:53:09.150Z",
      "status" : "PROVISIONING",
      "networkGroupId" : "69a6dde4-7ac5-4257-89e6-3ed80d60d46c",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:53:09.150Z",
      "ownerIdentityId" : "580258a6-8aee-4a67-9c74-07c9dcbd05af",
      "createdBy" : "580258a6-8aee-4a67-9c74-07c9dcbd05af",
      "deletedBy" : null,
      "productVersion" : "7.0.0",
      "networkConfigMetadataId" : "3fd580df-58da-48af-8c83-fc8c12d220cf",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9fab7234-7f7e-4fba-a9a3-118c307bba7d"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=9fab7234-7f7e-4fba-a9a3-118c307bba7d"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=9fab7234-7f7e-4fba-a9a3-118c307bba7d"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=9fab7234-7f7e-4fba-a9a3-118c307bba7d"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=9fab7234-7f7e-4fba-a9a3-118c307bba7d"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=9fab7234-7f7e-4fba-a9a3-118c307bba7d"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=9fab7234-7f7e-4fba-a9a3-118c307bba7d"
        }
      }
    }, {
      "name" : "ACME Network With Breakout2020-09-10T20:53:09.150Z",
      "id" : "f4b155b1-ba93-4457-b0d8-726400f9d3b3",
      "updatedAt" : "2020-09-10T20:53:09.150Z",
      "status" : "PROVISIONING",
      "networkGroupId" : "69a6dde4-7ac5-4257-89e6-3ed80d60d46c",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:53:09.150Z",
      "ownerIdentityId" : "580258a6-8aee-4a67-9c74-07c9dcbd05af",
      "createdBy" : "580258a6-8aee-4a67-9c74-07c9dcbd05af",
      "deletedBy" : null,
      "productVersion" : "7.0.0",
      "networkConfigMetadataId" : "f68a22e5-f5d3-404c-81d9-6565d4f99503",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f4b155b1-ba93-4457-b0d8-726400f9d3b3"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=f4b155b1-ba93-4457-b0d8-726400f9d3b3"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=f4b155b1-ba93-4457-b0d8-726400f9d3b3"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=f4b155b1-ba93-4457-b0d8-726400f9d3b3"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=f4b155b1-ba93-4457-b0d8-726400f9d3b3"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=f4b155b1-ba93-4457-b0d8-726400f9d3b3"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=f4b155b1-ba93-4457-b0d8-726400f9d3b3"
        }
      }
    }, {
      "name" : "ACME Network2020-09-10T20:53:09.298Z",
      "id" : "f427f3bd-22ee-4383-a9a3-9880a0447fa9",
      "updatedAt" : "2020-09-10T20:53:09.299Z",
      "status" : "PROVISIONED",
      "networkGroupId" : "69a6dde4-7ac5-4257-89e6-3ed80d60d46c",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:53:09.298Z",
      "ownerIdentityId" : "5f86a56a-0fa1-444e-8f36-45222b6c0d3a",
      "createdBy" : "5f86a56a-0fa1-444e-8f36-45222b6c0d3a",
      "deletedBy" : null,
      "productVersion" : "7.0.0",
      "networkConfigMetadataId" : "db276034-d983-4c9a-9c53-fd21259c60fb",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f427f3bd-22ee-4383-a9a3-9880a0447fa9"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=f427f3bd-22ee-4383-a9a3-9880a0447fa9"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=f427f3bd-22ee-4383-a9a3-9880a0447fa9"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=f427f3bd-22ee-4383-a9a3-9880a0447fa9"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=f427f3bd-22ee-4383-a9a3-9880a0447fa9"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=f427f3bd-22ee-4383-a9a3-9880a0447fa9"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=f427f3bd-22ee-4383-a9a3-9880a0447fa9"
        }
      }
    }, {
      "name" : "ACME Network Unprovisioned 2020-09-10T20:53:09.299Z",
      "id" : "13878524-3c62-4f0c-bea6-5e1d4c51b147",
      "updatedAt" : "2020-09-10T20:53:09.299Z",
      "status" : "PROVISIONING",
      "networkGroupId" : "69a6dde4-7ac5-4257-89e6-3ed80d60d46c",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:53:09.299Z",
      "ownerIdentityId" : "5f86a56a-0fa1-444e-8f36-45222b6c0d3a",
      "createdBy" : "5f86a56a-0fa1-444e-8f36-45222b6c0d3a",
      "deletedBy" : null,
      "productVersion" : "7.0.0",
      "networkConfigMetadataId" : "e2d3d2e9-385f-42d5-bc2b-6e43b84a7abe",
      "o365BreakoutCategory" : "NONE",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/13878524-3c62-4f0c-bea6-5e1d4c51b147"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=13878524-3c62-4f0c-bea6-5e1d4c51b147"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=13878524-3c62-4f0c-bea6-5e1d4c51b147"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=13878524-3c62-4f0c-bea6-5e1d4c51b147"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=13878524-3c62-4f0c-bea6-5e1d4c51b147"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=13878524-3c62-4f0c-bea6-5e1d4c51b147"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=13878524-3c62-4f0c-bea6-5e1d4c51b147"
        }
      }
    }, {
      "name" : "ACME Network With Breakout2020-09-10T20:53:09.299Z",
      "id" : "f6e67f5a-c079-4710-886a-10bf8c5ad550",
      "updatedAt" : "2020-09-10T20:53:09.299Z",
      "status" : "PROVISIONING",
      "networkGroupId" : "69a6dde4-7ac5-4257-89e6-3ed80d60d46c",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:53:09.299Z",
      "ownerIdentityId" : "5f86a56a-0fa1-444e-8f36-45222b6c0d3a",
      "createdBy" : "5f86a56a-0fa1-444e-8f36-45222b6c0d3a",
      "deletedBy" : null,
      "productVersion" : "7.0.0",
      "networkConfigMetadataId" : "af4bdc08-cad3-4d65-b873-cb7d44fbe691",
      "o365BreakoutCategory" : "OPTIMIZE_ALLOW",
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/f6e67f5a-c079-4710-886a-10bf8c5ad550"
        },
        "networks" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
        },
        "edge-routers" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=f6e67f5a-c079-4710-886a-10bf8c5ad550"
        },
        "edge-router-policies" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=f6e67f5a-c079-4710-886a-10bf8c5ad550"
        },
        "endpoints" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=f6e67f5a-c079-4710-886a-10bf8c5ad550"
        },
        "services" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=f6e67f5a-c079-4710-886a-10bf8c5ad550"
        },
        "app-wans" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=f6e67f5a-c079-4710-886a-10bf8c5ad550"
        },
        "certificate-authorities" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=f6e67f5a-c079-4710-886a-10bf8c5ad550"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks{?findByName,findByNetworkGroupId}",
      "templated" : true
    }
  },
  "page" : {
    "size" : 2000,
    "totalElements" : 6,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Network

GET /networks/{id}

Authorization

This endpoint requires read action on the network resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

name

String

true

id

String

true

Network ID.

updatedAt

String

true

status

String

true

networkGroupId

String

true

deletedAt

String

true

createdAt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

productVersion

String

true

networkConfigMetadataId

String

true

o365BreakoutCategory

String

true

Path Optional Description

self

false

A canonical URI; The link to this resource.

edgeRouters

false

Link to the collection of edge-routers within this Network.

edgeRouterPolicies

false

Link to the collection of edge-router-policies within this Network.

endpoints

false

Link to the collection of endpoints within this Network.

services

false

Link to the collection of services within this Network.

appWans

false

Link to the collection of app-wans within this Network.

certificateAuthorities

false

Link to the collection of certificate-authorities within this Network.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks/4dba3124-737d-4962-bbe4-14a788616de7' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJDbmoyNDRXcW0ycTNuLXFkRzN6SXBBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJkZDQ1MDUwLWM2ODktNGJjNi05YThiLTIzMGFiNmU1NzM3NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE4OSwiZXhwIjoxNTk5Nzc0Nzg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM4ZWJkMGI0LTUyMGItNDFiNS1hNTUxLWFhN2IwZjQxZGVlNVwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.fYtuD7gWyqa7Szi5MEg3_PDartHV57-Nw4mI2cZtmyFTLH7JCIZA1iaXZUSTP0k8ncSYXvhxy1vUAcIvU-wCqc25RUb3seMgulO6f1nHTE22HVCTftLBtKJ0xGZVZaancBtonVbCzWz2mt-e6q6ofoNtwbw3HP-ELivxJostICNwzStf8xCF4y6SBr4YtCiI4Hv4ku7ZxWwBzhI2VLITs43-OfjcRScTp8QsDjKQSIAZERo1HUcoQSBE4YxVVNZCVbt2PABdhu-LaO8ZbXgz-mOCByqtCnvvjmmm2mLOxdq_6gk0Uhcp6X3-EdwjqlqmVBHHk3S4XnwhBcxwYvNlAQ'

Example response

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

{
  "name" : "ACME Network2020-09-10T20:53:09.148Z",
  "id" : "4dba3124-737d-4962-bbe4-14a788616de7",
  "updatedAt" : "2020-09-10T20:53:09.150Z",
  "status" : "PROVISIONED",
  "networkGroupId" : "69a6dde4-7ac5-4257-89e6-3ed80d60d46c",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:53:09.149Z",
  "ownerIdentityId" : "580258a6-8aee-4a67-9c74-07c9dcbd05af",
  "createdBy" : "580258a6-8aee-4a67-9c74-07c9dcbd05af",
  "deletedBy" : null,
  "productVersion" : "7.0.0",
  "networkConfigMetadataId" : "8ea42b94-f99d-4d21-8dc9-6cfdfe1ad828",
  "o365BreakoutCategory" : "NONE",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/4dba3124-737d-4962-bbe4-14a788616de7"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=4dba3124-737d-4962-bbe4-14a788616de7"
    }
  }
}

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

false

Client must have create action under the annotated resource.

networkConfigMetadataId

String

false

name

String

false

productVersion

String

true

o365BreakoutCategory

String

true

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

locationCode

String

false

Response fields

Path Type Optional Description

name

String

true

id

String

true

Network ID.

updatedAt

String

true

status

String

true

networkGroupId

String

true

deletedAt

String

true

createdAt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

productVersion

String

true

networkConfigMetadataId

String

true

o365BreakoutCategory

String

true

Path Optional Description

self

false

A canonical URI; The link to this resource.

edgeRouters

false

Link to the collection of edge-routers within this Network.

edgeRouterPolicies

false

Link to the collection of edge-router-policies within this Network.

endpoints

false

Link to the collection of endpoints within this Network.

services

false

Link to the collection of services within this Network.

appWans

false

Link to the collection of app-wans within this Network.

certificateAuthorities

false

Link to the collection of certificate-authorities within this Network.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJXREpXUTJfSzFXR0hfOU16Rlphcm9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjVjODIzMzMwLTg2MWYtNGE3NS1hZGI2LTA4NzAwMDQwNjlmYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE4OSwiZXhwIjoxNTk5Nzc0Nzg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjc5YzI4MzllLWFmMzQtNGRlNi1iMzNjLTYxYTU1MTQ4ODE3M1wiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.E-OLEwHrwUJB9OQuhCLon2NEgvfq2CKJoflxJjOnab4UGwMFjPCnmgEXn5TDDjUQgyJPNqbaxIX8EIdiMrzR4E8U_8u-J5cJm5Shm9z5hlOsHLmvGHSL4wCd8mjhcVQRP1rJaFk381WuQf45U7C6kJ9RgQYKQfIIMKdPmZKdntwta4GoG0qZPGsDaF2eNZFce-HMAvY8BTAQpbOCWr6nD9FH0-Q3w1Ck3tcnIT-kzA1kTV0QYAXfbfe3-6WOc6KxD5cHoyORpSzIHUcAwY6Y9EWX1cXcVc5GYT_-NMxdo-CrPhVOG8kwZ-1FXlriazXnc8iTQ_EONkMMerYCoVXdrA' \
    -d '{"networkGroupId":"69a6dde4-7ac5-4257-89e6-3ed80d60d46c","networkConfigMetadataId":"4020b9d9-59e8-4c16-b6aa-cc3b8693b4da","name":"SecOps Test Network","productVersion":null,"o365BreakoutCategory":"NONE","locationCode":"us-east-1"}'

Example response

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

{
  "name" : "SecOps Test Network",
  "id" : "3d8bd574-ffa7-4c5d-8467-37e1515e0588",
  "updatedAt" : "2020-09-10T20:53:09.381Z",
  "status" : "PROVISIONING",
  "networkGroupId" : "69a6dde4-7ac5-4257-89e6-3ed80d60d46c",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:53:09.381Z",
  "ownerIdentityId" : "5c823330-861f-4a75-adb6-0870004069fb",
  "createdBy" : "5c823330-861f-4a75-adb6-0870004069fb",
  "deletedBy" : null,
  "productVersion" : "7.1.0-59578434",
  "networkConfigMetadataId" : "4020b9d9-59e8-4c16-b6aa-cc3b8693b4da",
  "o365BreakoutCategory" : "NONE",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/3d8bd574-ffa7-4c5d-8467-37e1515e0588"
    },
    "networks" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks"
    },
    "edge-routers" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers?networkId=3d8bd574-ffa7-4c5d-8467-37e1515e0588"
    },
    "edge-router-policies" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies?networkId=3d8bd574-ffa7-4c5d-8467-37e1515e0588"
    },
    "endpoints" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints?networkId=3d8bd574-ffa7-4c5d-8467-37e1515e0588"
    },
    "services" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/services?networkId=3d8bd574-ffa7-4c5d-8467-37e1515e0588"
    },
    "app-wans" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans?networkId=3d8bd574-ffa7-4c5d-8467-37e1515e0588"
    },
    "certificate-authorities" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities?networkId=3d8bd574-ffa7-4c5d-8467-37e1515e0588"
    }
  }
}

Delete Network

DELETE /networks/{id}

Authorization

This endpoint requires delete action on the network resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/networks/ecb1c75a-bf8d-4ad1-833a-1003f36bb8c7' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJzVHJBLVNLUU43bGJYRVNtbHF6UDVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYxYmVjNGNiLTU0YTEtNDg5MC1hOWY5LTk3ZTMyOGEzYWZlZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE4OSwiZXhwIjoxNTk5Nzc0Nzg5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImJlZTAwODgzLWFmMDAtNDVlMC1iNGJmLTQyN2FjZjNjZDQ0YVwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE4OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ZdiO3-cZlHbKCg8ypHXJy4AR8tis14fBk4XKCUye3Y_j3VBNdwxKFVoh_yYu56E499TslcQE35lYQ1BsYNn3oeLorsTzVU4d4lNS3wUBD-mq7ckqvsuHtlcSiSljzjFxvAhNJFugHzfmfGSg9K2AYOqVkP9TD6sd8HpwVJ8NWujxTK0p_PS_inan2rPP2QWiIIxJOfF4Mq_eBqj1YZ1RtkXjg-qHmG04BtEtGEj2_1jyJUIrCoGz0wf2X6apc-xNE5VzQxQS0VbYKnH1E8zT8H59d7tjyhZecAFh2lGRlOkcDXpWxpGHP3zPxaIKxryhP1Kpg278_zTTC8gMcvEb-w'

Example response

HTTP/1.1 202 Accepted

Endpoints

Find Endpoints

GET /endpoints

Authorization

This endpoint requires read action on the endpoint resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

sessionActive

Boolean

true

osVersion

String

true

arch

String

true

name

String

false

id

String

true

type

String

true

attributes

Array[String]

true

version

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

revision

String

true

sessionIdentityId

String

true

enrollmentMethod

Object

true

enrollmentMethod.ott

Object

true

enrollmentMethod.ott.token

String

true

enrollmentMethod.ott.jwt

String

true

enrollmentMethod.ott.expiresAt

String

true

enrollmentMethod.ott.issuedAt

String

true

enrollmentMethod.ottca

Object

true

enrollmentMethod.ottca.certificateAuthorityId

String

true

enrollmentMethod.ottca.token

String

true

enrollmentMethod.ottca.jwt

String

true

enrollmentMethod.ottca.expiresAt

String

true

enrollmentMethod.ottca.issuedAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

syncId

String

true

syncResourceId

String

true

branch

String

true

os

String

true

osRelease

String

true

Path Optional Description

self

false

network

false

Embedded resources

Path Type Optional Description

sessionActive

Boolean

true

osVersion

String

true

arch

String

true

name

String

false

id

String

true

type

String

true

attributes

Array[String]

true

version

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

revision

String

true

sessionIdentityId

String

true

enrollmentMethod

Object

true

enrollmentMethod.ott

Object

true

enrollmentMethod.ott.token

String

true

enrollmentMethod.ott.jwt

String

true

enrollmentMethod.ott.expiresAt

String

true

enrollmentMethod.ott.issuedAt

String

true

enrollmentMethod.ottca

Object

true

enrollmentMethod.ottca.certificateAuthorityId

String

true

enrollmentMethod.ottca.token

String

true

enrollmentMethod.ottca.jwt

String

true

enrollmentMethod.ottca.expiresAt

String

true

enrollmentMethod.ottca.issuedAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

syncId

String

true

syncResourceId

String

true

branch

String

true

os

String

true

osRelease

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ5Qjk4ZDRBQW9Kc2JGQjBpeEVWVkVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQyOTNiZDU5LWU0ZWUtNDNjMy1hN2YxLTgyMGViMTE3ZDQyNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3MCwiZXhwIjoxNTk5Nzc0NzcwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjY2Yzk1OWU4LTg2ZDYtNDU4ZC1hZTFiLTQ3N2E1NDQ5ZDA1NlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.nMrIVvoGL7fSlfijP1qFsvQQ7iZXI0UV8PchxHjU0FOxb_FUlITGu734iKt2uhnomxAzgDzGSgINsyAybTs998TEcAa7_FYr00RFN7dn-ARY5fAOQQO7NxxuiR_mS3-zMnL1MjGS30GtN5qAWbtJ2yqmDBQlZb6BWX1YWCkX_CQQrwPNMSSE8ksZs7V9GiMWqxP7v_xJ1PcTpZtUKoFHP6zhTNRn3wZf0A0qJipzJ4DQNsuNok9NsIvhpbiQNJwKvxlJm_wXDpkwF1-9mtGu7L0G3eZCS6448L-GPOBxnNhB_vw4t0R0wOtIQUpH_xBJ_b5jDADmDfJKIKTHRdUxLQ'

Example response

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

{
  "_embedded" : {
    "endpointList" : [ {
      "sessionActive" : true,
      "osVersion" : null,
      "arch" : null,
      "name" : "Test_endpoint2020-09-10T20:52:50.694Z",
      "id" : "722ca107-2784-438e-bd13-63fe3b60819a",
      "type" : null,
      "attributes" : [ ],
      "version" : null,
      "updatedAt" : "2020-09-10T20:52:50.694Z",
      "networkId" : "802bc3f0-ff1a-446c-a0ee-cf104e9b9c4b",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:50.694Z",
      "revision" : null,
      "sessionIdentityId" : null,
      "enrollmentMethod" : {
        "ott" : {
          "token" : "newtoken",
          "jwt" : "jwthere",
          "expiresAt" : "2020-09-10T20:52:50.694Z",
          "issuedAt" : "2020-09-10T20:52:50.694Z"
        },
        "ottca" : {
          "certificateAuthorityId" : null,
          "token" : "newtokenupdb",
          "jwt" : "jwthereupdb",
          "expiresAt" : "2020-09-10T20:52:50.696Z",
          "issuedAt" : "2020-09-10T20:52:50.696Z"
        }
      },
      "jwt" : "jwthere",
      "ownerIdentityId" : "4adbf89d-3245-4c9c-91f4-a0192e051e3e",
      "createdBy" : "4adbf89d-3245-4c9c-91f4-a0192e051e3e",
      "deletedBy" : null,
      "syncId" : null,
      "syncResourceId" : null,
      "branch" : null,
      "os" : null,
      "osRelease" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/802bc3f0-ff1a-446c-a0ee-cf104e9b9c4b"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/722ca107-2784-438e-bd13-63fe3b60819a"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints"
    }
  },
  "page" : {
    "size" : 2000,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Endpoint

GET /endpoints/{id}

Authorization

This endpoint requires read action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

sessionActive

Boolean

true

osVersion

String

true

arch

String

true

name

String

false

id

String

true

type

String

true

attributes

Array[String]

true

version

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

revision

String

true

sessionIdentityId

String

true

enrollmentMethod

Object

true

enrollmentMethod.ott

Object

true

enrollmentMethod.ott.token

String

true

enrollmentMethod.ott.jwt

String

true

enrollmentMethod.ott.expiresAt

String

true

enrollmentMethod.ott.issuedAt

String

true

enrollmentMethod.ottca

Object

true

enrollmentMethod.ottca.certificateAuthorityId

String

true

enrollmentMethod.ottca.token

String

true

enrollmentMethod.ottca.jwt

String

true

enrollmentMethod.ottca.expiresAt

String

true

enrollmentMethod.ottca.issuedAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

syncId

String

true

syncResourceId

String

true

branch

String

true

os

String

true

osRelease

String

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/91d69f8b-fb70-40e4-a7f9-4a98ac9e4a64' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJRb19yUV9OT3A2UWNBY1BlOGk2dXpBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhkZGZhY2IyLTczNzQtNDkwZi1hMGU4LTliNjllOTBhNjA0MiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3MSwiZXhwIjoxNTk5Nzc0NzcxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjU2MDIxYzM3LWNhZjMtNDdlMi05N2NlLTIwMGI5N2EwN2VmMVwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.o3gh4oB6QmsJ1cxRCQuFSxSJlrVh3rc_2Rb4lZbK6JGQnh3Go5H4nDfFurkOF3kB-69QP_k-bRRYzG3T00cYg1ClC86hEE2bgwYoPLaXmSvVB_KTRpAw3EeyaKx8dDDmjvnzh6Tsfb1-0UwZ3KSXRolPLPC9DCkHmGnPEUX_6ooufJMI2-udN_evWBsS6n29wTgApzrBp2BUVW5VOUW67os130PGXDBpX4dm5uGs94GcET5M6l6JB9Uipde5Bpv5yJCqOLJFu5NPfAYf8uh9wu__zvQUfrwvPzn_g1pBvM_l2yB_QklKLzTZD9QCQ-oBf5sFSQt4Gu6QTTGPhLOnIQ'

Example response

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

{
  "sessionActive" : true,
  "osVersion" : null,
  "arch" : null,
  "name" : "Test_endpoint2020-09-10T20:52:51.406Z",
  "id" : "91d69f8b-fb70-40e4-a7f9-4a98ac9e4a64",
  "type" : null,
  "attributes" : [ ],
  "version" : null,
  "updatedAt" : "2020-09-10T20:52:51.406Z",
  "networkId" : "e86a73f5-d245-49ad-95f9-76ef9dcfaa52",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:51.406Z",
  "revision" : null,
  "sessionIdentityId" : null,
  "enrollmentMethod" : {
    "ott" : {
      "token" : "newtoken",
      "jwt" : "jwthere",
      "expiresAt" : "2020-09-10T20:52:51.406Z",
      "issuedAt" : "2020-09-10T20:52:51.406Z"
    },
    "ottca" : {
      "certificateAuthorityId" : null,
      "token" : "newtokenupdb",
      "jwt" : "jwthereupdb",
      "expiresAt" : "2020-09-10T20:52:51.407Z",
      "issuedAt" : "2020-09-10T20:52:51.407Z"
    }
  },
  "jwt" : "jwthereca",
  "ownerIdentityId" : "1d33683c-6b97-46cd-80cc-f3e87642e679",
  "createdBy" : "1d33683c-6b97-46cd-80cc-f3e87642e679",
  "deletedBy" : null,
  "syncId" : null,
  "syncResourceId" : null,
  "branch" : null,
  "os" : null,
  "osRelease" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/e86a73f5-d245-49ad-95f9-76ef9dcfaa52"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/91d69f8b-fb70-40e4-a7f9-4a98ac9e4a64"
    }
  }
}

Get Endpoint Policy Advice

GET /endpoints/{id}/policy-advice/{serviceId}

Authorization

This endpoint requires read action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

serviceId

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

commonRouters

Array[Object]

true

commonRouters[].name

String

false

commonRouters[].id

String

true

commonRouters[].attributes

Array[String]

true

commonRouters[].verified

Boolean

true

commonRouters[].online

Boolean

true

commonRouters[].linkListener

Boolean

true

commonRouters[].provider

String

true

commonRouters[].updatedAt

String

true

commonRouters[].status

String

true

commonRouters[].networkId

String

false

commonRouters[].deletedAt

String

true

commonRouters[].createdAt

String

true

commonRouters[].ipAddress

String

true

commonRouters[].locationMetadataId

String

true

commonRouters[].dataCenterId

String

true

commonRouters[].jwt

String

true

commonRouters[].ownerIdentityId

String

true

commonRouters[].createdBy

String

true

commonRouters[].deletedBy

String

true

networkId

String

false

serviceName

String

true

serviceId

String

true

endpointId

String

true

serviceRouterCount

Integer

true

dialAllowed

Boolean

true

endpointName

String

true

endpointRouterCount

Integer

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/7c0e7177-e5e9-43c4-8576-71f74a4c2431/policy-advice/abeb1564-7d68-4fc3-9ab8-9a0b3c056981' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ2aUx3dllCUXl2LXZOaUgwU3R6ajVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU3ZTg0MDU3LWQ2YmItNGRiZS1hY2VhLTU4Nzg4OWE1MzQ2ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3MSwiZXhwIjoxNTk5Nzc0NzcxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjFiM2YyMTVkLTAxNDktNGQ3ZS1iY2RhLTQ1YjI4OGJhMDczZFwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jQs7hgGhTWttmlRXJxBJqSwab_wFjM5DaK5cNYQwQpJ4Ee-56xHDgaLu_m-T0Bu6JM9_2ZeiqQLrkOqv-y-45yLdgNFPNi0n_rPUjmEZDREGpnPX4ObkpCMLbP1KyoIcWKpm48a06pr0JwPvjCS_OBUMdIZmd2106F3apjVqJjaogGBMVuL_JHCCj6ZXwcU_0wBKmgraZTZxclU7Soz2WshbwF3BQaunWVUIdbvHRoCF1q_UpE_rgoP7c7NYzJmfbRx2DWGD1nJp2iA2_q_Y_D4mqf5vpncsOdLjxDNhep2FMnyqocVdL0UdQ1rMwozSi9XuqLHj7QhdvRKhoXQwUQ'

Example response

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

{
  "commonRouters" : [ {
    "name" : "ACME_edge_router_2020-09-10T20:52:51.248Z",
    "id" : "76651a57-9fcb-41a1-b7df-4143851dfc15",
    "attributes" : [ ],
    "verified" : true,
    "online" : false,
    "linkListener" : true,
    "provider" : "AWS",
    "updatedAt" : "2020-09-10T20:52:51.248Z",
    "status" : "PROVISIONING",
    "networkId" : "5f7abe83-e4e2-4a73-8fc7-1897d3bedfa7",
    "deletedAt" : null,
    "createdAt" : "2020-09-10T20:52:51.248Z",
    "ipAddress" : "1.2.3.4",
    "locationMetadataId" : "4ff3184c-85c0-4ba2-bcf3-47b7511d53f8",
    "dataCenterId" : "5353ba4e-1649-4c6a-b22d-d1a50cb4f6c9",
    "jwt" : null,
    "ownerIdentityId" : "7cd08ca7-50fc-4655-98ab-baee4f004543",
    "createdBy" : "7cd08ca7-50fc-4655-98ab-baee4f004543",
    "deletedBy" : null
  } ],
  "networkId" : "5f7abe83-e4e2-4a73-8fc7-1897d3bedfa7",
  "serviceName" : "ACME_Service01_2020-09-10T20:52:51.250Z",
  "serviceId" : "abeb1564-7d68-4fc3-9ab8-9a0b3c056981",
  "endpointId" : "7c0e7177-e5e9-43c4-8576-71f74a4c2431",
  "serviceRouterCount" : 1,
  "dialAllowed" : true,
  "endpointName" : "Test_endpoint2020-09-10T20:52:51.246Z",
  "endpointRouterCount" : 1,
  "_links" : {
    "policy-advice" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/7c0e7177-e5e9-43c4-8576-71f74a4c2431/policy-advice/abeb1564-7d68-4fc3-9ab8-9a0b3c056981"
    },
    "endpoint" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/7c0e7177-e5e9-43c4-8576-71f74a4c2431"
    }
  }
}

Create Endpoint

POST /endpoints

Authorization

This endpoint requires create action on the endpoint resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

Client must have create action under the annotated resource.

name

String

true

enrollmentMethod

Object

true

enrollmentMethod.ott

Boolean

true

enrollmentMethod.updb

String

true

enrollmentMethod.ottca

String

true

attributes

Array[String]

true

sessionIdentityId

String

true

syncId

String

true

syncResourceId

String

true

Response fields

Path Type Optional Description

sessionActive

Boolean

true

osVersion

String

true

arch

String

true

name

String

false

id

String

true

type

String

true

attributes

Array[String]

true

version

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

revision

String

true

sessionIdentityId

String

true

enrollmentMethod

Object

true

enrollmentMethod.ott

Object

true

enrollmentMethod.ott.token

String

true

enrollmentMethod.ott.jwt

String

true

enrollmentMethod.ott.expiresAt

String

true

enrollmentMethod.ott.issuedAt

String

true

enrollmentMethod.ottca

Object

true

enrollmentMethod.ottca.certificateAuthorityId

String

true

enrollmentMethod.ottca.token

String

true

enrollmentMethod.ottca.jwt

String

true

enrollmentMethod.ottca.expiresAt

String

true

enrollmentMethod.ottca.issuedAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

syncId

String

true

syncResourceId

String

true

branch

String

true

os

String

true

osRelease

String

true

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.eyJqdGkiOiJNbzNFSHUzSF9MUElFVFB5dzR3bFZBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjkxN2Q2NDNiLWYzMmEtNDM3MC1hYTM3LTc3MTU3NDI0OTFiZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3MCwiZXhwIjoxNTk5Nzc0NzcwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgwNjdmOGVlLWM3OTQtNGJiMC1hYzNlLWMzMzU0ZGQ0MzM5ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3MH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.o1ITMD0OMryRqaiO_KL6gTfhu3hK7Y7CyUop2mv6xB7UvNW_Vd4K_U_cdxHlYRg62agC5et1-5ImYidmRBeQxMomBa2VV9apYMNtNfBAdmMPCtNIu6b2vVm6W5TJ0zUQpg_n3eRozvvMFncun3sxkJ5dAxJhUsOioJDJi0iMNrHh0SSgfDADZKOorj3B0J0B8lQ8bD6v7aFZ8EtmMiwsbEnh6lBpbHnUcDgKnIPsTIeGYrP6b7Z8UfxmIdO4IFRHF80gyP-C7duHmTbXhtZODLBGm0gwdYebRUxiWhnE39Ba4BTeHx9CT6DnJPjHCWfyOxHKeagBYgrdjfxeTHBHzQ' \
    -d '{"networkId":"d69e5bcb-b5bb-4dce-916a-5c070e717736","name":"Test endpoint 02","enrollmentMethod":{"ott":true,"updb":null,"ottca":null},"attributes":["#clients"],"sessionIdentityId":null,"syncId":null,"syncResourceId":null}'

Example response

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

{
  "sessionActive" : true,
  "osVersion" : "ver01",
  "arch" : "arch",
  "name" : "Test endpoint 02",
  "id" : "ad28047d-26e4-4f72-9c89-242955d610b1",
  "type" : "device",
  "attributes" : [ "#clients" ],
  "version" : "version100",
  "updatedAt" : "2020-09-10T20:52:50.896Z",
  "networkId" : "d69e5bcb-b5bb-4dce-916a-5c070e717736",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:50.895Z",
  "revision" : "rev01",
  "sessionIdentityId" : null,
  "enrollmentMethod" : {
    "ott" : {
      "token" : "token",
      "jwt" : "jwthere",
      "expiresAt" : "2020-09-10T20:52:50.890Z",
      "issuedAt" : "2020-09-10T20:52:50.890Z"
    },
    "ottca" : {
      "certificateAuthorityId" : null,
      "token" : "token",
      "jwt" : "jwthere",
      "expiresAt" : "2020-09-10T20:52:50.890Z",
      "issuedAt" : "2020-09-10T20:52:50.890Z"
    }
  },
  "jwt" : "jwthere",
  "ownerIdentityId" : "917d643b-f32a-4370-aa37-7715742491be",
  "createdBy" : "917d643b-f32a-4370-aa37-7715742491be",
  "deletedBy" : null,
  "syncId" : null,
  "syncResourceId" : null,
  "branch" : "branch",
  "os" : "osd01",
  "osRelease" : "osrev01",
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d69e5bcb-b5bb-4dce-916a-5c070e717736"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/ad28047d-26e4-4f72-9c89-242955d610b1"
    }
  }
}

Patch Endpoint

PATCH /endpoints/{id}

Authorization

This endpoint requires update action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

attributes

Array[String]

true

sessionIdentityId

String

true

Response fields

Path Type Optional Description

sessionActive

Boolean

true

osVersion

String

true

arch

String

true

name

String

false

id

String

true

type

String

true

attributes

Array[String]

true

version

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

revision

String

true

sessionIdentityId

String

true

enrollmentMethod

Object

true

enrollmentMethod.ott

Object

true

enrollmentMethod.ott.token

String

true

enrollmentMethod.ott.jwt

String

true

enrollmentMethod.ott.expiresAt

String

true

enrollmentMethod.ott.issuedAt

String

true

enrollmentMethod.ottca

Object

true

enrollmentMethod.ottca.certificateAuthorityId

String

true

enrollmentMethod.ottca.token

String

true

enrollmentMethod.ottca.jwt

String

true

enrollmentMethod.ottca.expiresAt

String

true

enrollmentMethod.ottca.issuedAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

syncId

String

true

syncResourceId

String

true

branch

String

true

os

String

true

osRelease

String

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/bf396899-f72f-4fcf-9099-b00670ca64b1' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyVFNYVHJGOU5YLXZTTjNBUUR2Q21BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUyMjRiNDhlLWVkMWEtNDVlNi04M2M3LWEzN2QzYWRjMWMwMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3MSwiZXhwIjoxNTk5Nzc0NzcxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjM3YTNkODkyLWE3NDUtNGJiZi1iOTBjLWUzZjZiMTRlYzBiNlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Yo2uGGGnC1TAMwyZVyQD7t4yeXq_sAJkmDG4_pydPWyjN_gvqNi0EMd-MBOvyrnA95ubolfAGxJiYT06OeOP9ZCpnN1LlrqDKmhicIgyy0Pvb4L5fuxUfu-Ip5f5wY9tgVxELriUTdNtyzn2wXDFG7xXJS84Dmv2AavagIHdISWgejXINScUKZKbrHLvRXJprSrFyuII8IdQPcdVc85O-gnQCTny4bT_msSkWU1rZHM6XKePORiczdDo5vBGB4BLchuLsY1nXPcOcHRrduNBPLUNSIVk3cxm22GJ_FJa0Wcc9NTuMpHvnhjUoDl-yqoY1AMQPGxkJ94XsFdp7V3sEA' \
    -d '{"name":"Test endpoint 02 updated","attributes":null,"sessionIdentityId":null}'

Example response

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

{
  "sessionActive" : true,
  "osVersion" : null,
  "arch" : null,
  "name" : "Test endpoint 02 updated",
  "id" : "bf396899-f72f-4fcf-9099-b00670ca64b1",
  "type" : null,
  "attributes" : [ ],
  "version" : null,
  "updatedAt" : "2020-09-10T20:52:51.369Z",
  "networkId" : "92c5e446-2222-4cc4-907c-7841f016143d",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:51.347Z",
  "revision" : null,
  "sessionIdentityId" : null,
  "enrollmentMethod" : {
    "ott" : {
      "token" : "newtoken",
      "jwt" : "jwthere",
      "expiresAt" : "2020-09-10T20:52:51.347Z",
      "issuedAt" : "2020-09-10T20:52:51.347Z"
    },
    "ottca" : {
      "certificateAuthorityId" : null,
      "token" : "newtokenupdb",
      "jwt" : "jwthereupdb",
      "expiresAt" : "2020-09-10T20:52:51.349Z",
      "issuedAt" : "2020-09-10T20:52:51.349Z"
    }
  },
  "jwt" : "jwthereca",
  "ownerIdentityId" : "cd27523c-2a2b-4ffb-a686-d83390156570",
  "createdBy" : "cd27523c-2a2b-4ffb-a686-d83390156570",
  "deletedBy" : null,
  "syncId" : null,
  "syncResourceId" : null,
  "branch" : null,
  "os" : null,
  "osRelease" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/92c5e446-2222-4cc4-907c-7841f016143d"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/endpoints/bf396899-f72f-4fcf-9099-b00670ca64b1"
    }
  }
}

Delete Endpoint

DELETE /endpoints/{id}

Authorization

This endpoint requires delete action on the endpoint resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/endpoints/75e4b3c8-c8db-49e9-a884-d8cd88184782' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJTUHNVREQ2c3RfYXNHeHY4bzFsdGVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZlNmJkYzI0LWNlOTctNDAxYy1iYTk4LTljM2UwYmVmZGJkZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3MSwiZXhwIjoxNTk5Nzc0NzcxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjRhYzhlNzcxLWEwZjEtNGQ0MS1hNjM1LTQ2OGE3MzgwN2I1NFwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3MX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.X2TcPAInIKUTbQ-Ej3Hk4iZVQg9uCEven4DOBxXK9npYki2S1UG-a-qytQjlZvCX3fMvt25InfWxiKVyLFTIWItLUN__fUIL0xAZNlX9LZlz5sdMOHa_NoZiUsrpy8nTMxbd-64DUQ_8uZP4yjzRnelnaHl-gWegkJM979sD_U87MPYV3-MIFA2Txh-ACaYhsZO3gwfSztNKthKQqAS8j1oqtIFJ3tteJ9KiSzKBAPMCsn8MFj087bRJYFHHYjpbEC3aMPfEx7Xa5VFIIWFAaO9EqtQTYyj0VPKYjKyNP2tzZdN_1YFg658c6v96a2tYTY6FkHmPPlu6Tj71ASKj4A'

Example response

HTTP/1.1 200 OK

Edge Routers

Find Edge Routers

GET /edge-routers

Authorization

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

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

name

String

false

id

String

true

attributes

Array[String]

true

verified

Boolean

true

online

Boolean

true

linkListener

Boolean

true

provider

String

true

updatedAt

String

true

status

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

ipAddress

String

true

locationMetadataId

String

true

dataCenterId

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

Path Optional Description

self

false

network

false

Embedded resources

Path Type Optional Description

name

String

false

id

String

true

attributes

Array[String]

true

verified

Boolean

true

online

Boolean

true

linkListener

Boolean

true

provider

String

true

updatedAt

String

true

status

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

ipAddress

String

true

locationMetadataId

String

true

dataCenterId

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyMnNXZDVKVGl6eVVTZzhlNnFqY01BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc0MWU3Yzg5LWRhZWQtNDU5Yi1iNGQyLTcwYjI2MTAyY2NmZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE1NywiZXhwIjoxNTk5Nzc0NzU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJlNTVjNDEyLTViMDUtNGZmMi04MWQ5LWZjYmUxZjY4YjI2MFwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE1N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Iy2S67IUnpNREs6wS8aMnff9KA1wvAAKeVQgsJT-R4BGgMWd8UUi-JQpWpuyjCtLxP604Lynon4Zj80OgSAU88yz3iDK18-jBa1KbPg-nOs_w3FL_fSAw4lEP2ktVdXg1Bow6AjYG-UqlGF5t2XMHi9px76RUo1nVROWIZn9YV2Ae_qUIRidTunYkI6bFZHo4rjYDk6lYIUX_bvRvqtmB_nwKUwkgo-o7fztI0h7AhAmpD4u_gXbzfLpOHKlzdPtD1GAjR-MmcpD35J-E5n830PIW0F7DtKVVMM06glTF29457c1qfXr_-54ypQr0HwghVOkHQmBLIWJYkLrkjqjoQ'

Example response

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

{
  "_embedded" : {
    "edgeRouterList" : [ {
      "name" : "ACME_edge_router_2020-09-10T20:52:36.171Z",
      "id" : "88e9e7d0-cdda-484a-966c-372f677f6d06",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.172Z",
      "status" : "PROVISIONING",
      "networkId" : "ea1e5341-8f39-40f1-8d40-b5b4653923c0",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.172Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "45c16676-b9f4-41fc-bb18-52bc950ee965",
      "dataCenterId" : "11b856dd-56e2-4a39-8b1b-f95722fc75a8",
      "jwt" : null,
      "ownerIdentityId" : "be3a403c-df24-449b-af99-b0b5b156e2ab",
      "createdBy" : "be3a403c-df24-449b-af99-b0b5b156e2ab",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ea1e5341-8f39-40f1-8d40-b5b4653923c0"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/88e9e7d0-cdda-484a-966c-372f677f6d06"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:36.172Z",
      "id" : "0710efc3-518a-4886-a76f-21b1221bdf56",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.173Z",
      "status" : "PROVISIONING",
      "networkId" : "ea1e5341-8f39-40f1-8d40-b5b4653923c0",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.173Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "6ae5d7c3-5651-4bfb-a497-eb84e1e92e59",
      "dataCenterId" : "d25c5050-131e-4c8e-966d-c7a86ee344dc",
      "jwt" : null,
      "ownerIdentityId" : "be3a403c-df24-449b-af99-b0b5b156e2ab",
      "createdBy" : "be3a403c-df24-449b-af99-b0b5b156e2ab",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ea1e5341-8f39-40f1-8d40-b5b4653923c0"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/0710efc3-518a-4886-a76f-21b1221bdf56"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:36.173Z",
      "id" : "f3c4e38f-40e4-4972-b8bb-eb96a7047ed4",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.173Z",
      "status" : "PROVISIONING",
      "networkId" : "ea1e5341-8f39-40f1-8d40-b5b4653923c0",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.173Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "e1af755e-d677-4571-9948-9b075a6807e3",
      "dataCenterId" : "ecd78c02-c06e-47d2-9417-652cf2d40930",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "be3a403c-df24-449b-af99-b0b5b156e2ab",
      "createdBy" : "be3a403c-df24-449b-af99-b0b5b156e2ab",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ea1e5341-8f39-40f1-8d40-b5b4653923c0"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/f3c4e38f-40e4-4972-b8bb-eb96a7047ed4"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:36.256Z",
      "id" : "5e240de3-4b48-42f6-b4ad-729e3e88b914",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.256Z",
      "status" : "PROVISIONING",
      "networkId" : "6eded6ea-b061-43a6-b815-ffabd21c4d8b",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.256Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "15516c9f-067a-4c4e-873d-8feb214c36e4",
      "dataCenterId" : "1d51b9be-809a-4f33-aca3-7984f0730a32",
      "jwt" : null,
      "ownerIdentityId" : "2f7fead8-dc82-4b81-9bff-11fc03aafda7",
      "createdBy" : "2f7fead8-dc82-4b81-9bff-11fc03aafda7",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6eded6ea-b061-43a6-b815-ffabd21c4d8b"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/5e240de3-4b48-42f6-b4ad-729e3e88b914"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:36.256Z",
      "id" : "40aba803-e1a7-4c5f-9a07-e96286442a31",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.257Z",
      "status" : "PROVISIONING",
      "networkId" : "6eded6ea-b061-43a6-b815-ffabd21c4d8b",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.257Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "339ec164-90a8-4b9f-be44-6abe808625dc",
      "dataCenterId" : "53f5d5a7-0cd7-405f-9962-a7c0b6581dd7",
      "jwt" : null,
      "ownerIdentityId" : "2f7fead8-dc82-4b81-9bff-11fc03aafda7",
      "createdBy" : "2f7fead8-dc82-4b81-9bff-11fc03aafda7",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6eded6ea-b061-43a6-b815-ffabd21c4d8b"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/40aba803-e1a7-4c5f-9a07-e96286442a31"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:36.257Z",
      "id" : "c63d3c99-23c9-48ea-8af3-c1014b6b379c",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.257Z",
      "status" : "PROVISIONING",
      "networkId" : "6eded6ea-b061-43a6-b815-ffabd21c4d8b",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.257Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "50c02442-6fd4-452f-9b1b-836ac536a425",
      "dataCenterId" : "e6e6d5b3-6ea1-46c9-be3b-9a9094a9758e",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "2f7fead8-dc82-4b81-9bff-11fc03aafda7",
      "createdBy" : "2f7fead8-dc82-4b81-9bff-11fc03aafda7",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6eded6ea-b061-43a6-b815-ffabd21c4d8b"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/c63d3c99-23c9-48ea-8af3-c1014b6b379c"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:36.310Z",
      "id" : "b2e3dc09-9ac6-4312-a524-22462181c342",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.310Z",
      "status" : "PROVISIONING",
      "networkId" : "d188f232-42cd-4f77-9f44-9a7600f2d609",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.310Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "476b9086-8806-4592-b934-9ad9daa6669c",
      "dataCenterId" : "84dabfa7-c8c7-4588-bc2c-471c0b0eabf5",
      "jwt" : null,
      "ownerIdentityId" : "92096ee2-f990-4098-8868-115a1fb6886a",
      "createdBy" : "92096ee2-f990-4098-8868-115a1fb6886a",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d188f232-42cd-4f77-9f44-9a7600f2d609"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/b2e3dc09-9ac6-4312-a524-22462181c342"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:36.310Z",
      "id" : "2c86e275-2416-4dcf-80ab-087f902a7aa6",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.311Z",
      "status" : "PROVISIONING",
      "networkId" : "d188f232-42cd-4f77-9f44-9a7600f2d609",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.311Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "8145e546-d0bf-4ab7-9b5d-ee20b45231b0",
      "dataCenterId" : "b6ad7f21-e8df-4167-822b-a113005874bd",
      "jwt" : null,
      "ownerIdentityId" : "92096ee2-f990-4098-8868-115a1fb6886a",
      "createdBy" : "92096ee2-f990-4098-8868-115a1fb6886a",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d188f232-42cd-4f77-9f44-9a7600f2d609"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/2c86e275-2416-4dcf-80ab-087f902a7aa6"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:36.311Z",
      "id" : "65626753-7523-4414-90e9-0d1036c7de41",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.311Z",
      "status" : "PROVISIONING",
      "networkId" : "d188f232-42cd-4f77-9f44-9a7600f2d609",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.311Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "9c78efe5-1058-421f-8a51-bc3441612c2c",
      "dataCenterId" : "8ab5b2ce-8de7-43f5-8528-92d544e76a31",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "92096ee2-f990-4098-8868-115a1fb6886a",
      "createdBy" : "92096ee2-f990-4098-8868-115a1fb6886a",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d188f232-42cd-4f77-9f44-9a7600f2d609"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/65626753-7523-4414-90e9-0d1036c7de41"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:36.545Z",
      "id" : "990939c3-f363-4a9a-b3d9-fe6ebf3c8df2",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.545Z",
      "status" : "PROVISIONING",
      "networkId" : "b27e0441-646b-4679-b0e6-1a4acbc39697",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.545Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "25ea2126-26e7-47be-bf91-f63df93b31f0",
      "dataCenterId" : "2d74ee64-8a8c-42fd-9ab0-a2ccc39c8f07",
      "jwt" : null,
      "ownerIdentityId" : "e7754b12-6fd1-430a-9d83-a587bbf89c4d",
      "createdBy" : "e7754b12-6fd1-430a-9d83-a587bbf89c4d",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b27e0441-646b-4679-b0e6-1a4acbc39697"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/990939c3-f363-4a9a-b3d9-fe6ebf3c8df2"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:36.545Z",
      "id" : "0f2951bc-5ed9-40e4-81aa-bc4b52e49728",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.546Z",
      "status" : "PROVISIONING",
      "networkId" : "b27e0441-646b-4679-b0e6-1a4acbc39697",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.546Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "404ba7e7-47b6-4915-93ef-e65506f2b4d5",
      "dataCenterId" : "9f85b31c-b8ea-4445-a498-40481703afde",
      "jwt" : null,
      "ownerIdentityId" : "e7754b12-6fd1-430a-9d83-a587bbf89c4d",
      "createdBy" : "e7754b12-6fd1-430a-9d83-a587bbf89c4d",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b27e0441-646b-4679-b0e6-1a4acbc39697"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/0f2951bc-5ed9-40e4-81aa-bc4b52e49728"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:36.546Z",
      "id" : "b12a0dcf-977b-4070-bb7b-7c2c3d24296a",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.546Z",
      "status" : "PROVISIONING",
      "networkId" : "b27e0441-646b-4679-b0e6-1a4acbc39697",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.546Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "4393d0cc-ac3b-47be-87fb-2732ce48a903",
      "dataCenterId" : "e3390fe4-510d-45b8-8fc8-aae8bd9218bd",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "e7754b12-6fd1-430a-9d83-a587bbf89c4d",
      "createdBy" : "e7754b12-6fd1-430a-9d83-a587bbf89c4d",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b27e0441-646b-4679-b0e6-1a4acbc39697"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/b12a0dcf-977b-4070-bb7b-7c2c3d24296a"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:36.594Z",
      "id" : "1a0e10b6-387f-4594-bc5b-bc4db4b60974",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.595Z",
      "status" : "PROVISIONING",
      "networkId" : "379f15ab-8014-406c-973b-0be5718e8272",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.595Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "c0924f12-f0ce-426e-bdae-4646ef46691d",
      "dataCenterId" : "4c91fe2a-03a7-4289-aeab-31d6dd27be90",
      "jwt" : null,
      "ownerIdentityId" : "c7f48751-a341-40b5-a5a3-6c99cbc36df6",
      "createdBy" : "c7f48751-a341-40b5-a5a3-6c99cbc36df6",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/379f15ab-8014-406c-973b-0be5718e8272"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/1a0e10b6-387f-4594-bc5b-bc4db4b60974"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:36.595Z",
      "id" : "fbed30d4-f79a-4c6a-a06a-5b617eb820ab",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.595Z",
      "status" : "PROVISIONING",
      "networkId" : "379f15ab-8014-406c-973b-0be5718e8272",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.595Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "3e18a763-ce8e-44bb-9c81-0dee9d7c3ad5",
      "dataCenterId" : "7345a27f-3073-41dc-9a4f-555f85fa954e",
      "jwt" : null,
      "ownerIdentityId" : "c7f48751-a341-40b5-a5a3-6c99cbc36df6",
      "createdBy" : "c7f48751-a341-40b5-a5a3-6c99cbc36df6",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/379f15ab-8014-406c-973b-0be5718e8272"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/fbed30d4-f79a-4c6a-a06a-5b617eb820ab"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:36.595Z",
      "id" : "8465e37f-7668-47e4-8c0d-bbc1027a111f",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.595Z",
      "status" : "PROVISIONING",
      "networkId" : "379f15ab-8014-406c-973b-0be5718e8272",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.595Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "e50cda3b-f8c3-4fe5-a29c-bb4e44a59566",
      "dataCenterId" : "68a50340-7986-4ba8-8dfc-33e84b8640e7",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "c7f48751-a341-40b5-a5a3-6c99cbc36df6",
      "createdBy" : "c7f48751-a341-40b5-a5a3-6c99cbc36df6",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/379f15ab-8014-406c-973b-0be5718e8272"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/8465e37f-7668-47e4-8c0d-bbc1027a111f"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:36.639Z",
      "id" : "467358a5-6e27-4569-9f00-bb25ecdbc140",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.639Z",
      "status" : "PROVISIONING",
      "networkId" : "76fdc693-abad-4494-b0f1-d8d0f8627e23",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.639Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "c7a5aa1e-6cc3-412b-a372-ad64c4348e2a",
      "dataCenterId" : "7a2940bd-0d25-4da3-a151-a1a109518d21",
      "jwt" : null,
      "ownerIdentityId" : "a9d0e2fc-7035-4bdc-b5aa-58a133c81e16",
      "createdBy" : "a9d0e2fc-7035-4bdc-b5aa-58a133c81e16",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/76fdc693-abad-4494-b0f1-d8d0f8627e23"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/467358a5-6e27-4569-9f00-bb25ecdbc140"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:36.639Z",
      "id" : "70e9658d-8d48-4f57-b386-c93e1beca7b4",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.640Z",
      "status" : "PROVISIONING",
      "networkId" : "76fdc693-abad-4494-b0f1-d8d0f8627e23",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.640Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "1370c516-8366-4814-9704-09cea9256885",
      "dataCenterId" : "f663117b-7d61-4e49-8e28-b9c3a45a48ca",
      "jwt" : null,
      "ownerIdentityId" : "a9d0e2fc-7035-4bdc-b5aa-58a133c81e16",
      "createdBy" : "a9d0e2fc-7035-4bdc-b5aa-58a133c81e16",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/76fdc693-abad-4494-b0f1-d8d0f8627e23"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/70e9658d-8d48-4f57-b386-c93e1beca7b4"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:36.640Z",
      "id" : "cda8d504-792a-4615-9e22-9d4ac0608090",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.640Z",
      "status" : "PROVISIONING",
      "networkId" : "76fdc693-abad-4494-b0f1-d8d0f8627e23",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.640Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "eb985ac8-1631-474c-9386-81f4bf32a5a4",
      "dataCenterId" : "57c37960-2921-4372-8a39-49a8d4c35eac",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "a9d0e2fc-7035-4bdc-b5aa-58a133c81e16",
      "createdBy" : "a9d0e2fc-7035-4bdc-b5aa-58a133c81e16",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/76fdc693-abad-4494-b0f1-d8d0f8627e23"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/cda8d504-792a-4615-9e22-9d4ac0608090"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:36.706Z",
      "id" : "22bcb23e-fd67-4d46-88ed-b3f3d896d9bc",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.706Z",
      "status" : "PROVISIONING",
      "networkId" : "a001e734-51a9-4f30-ab6a-e55f88b5ec99",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.706Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "fd5d0c11-ee89-46ca-9c51-946d378ffa0c",
      "dataCenterId" : "b47c05b9-1e75-4d2b-9016-c4fce0cb5020",
      "jwt" : null,
      "ownerIdentityId" : "54abe6f6-0c9c-4c79-9852-33c618d7f27a",
      "createdBy" : "54abe6f6-0c9c-4c79-9852-33c618d7f27a",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a001e734-51a9-4f30-ab6a-e55f88b5ec99"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/22bcb23e-fd67-4d46-88ed-b3f3d896d9bc"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:36.707Z",
      "id" : "fb796ba0-58b4-4310-9cb4-f9ac789f53e7",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.707Z",
      "status" : "PROVISIONING",
      "networkId" : "a001e734-51a9-4f30-ab6a-e55f88b5ec99",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.707Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "f484a68f-7cde-4457-8e38-62c0067b67ce",
      "dataCenterId" : "cfe1ad84-fb36-47d4-a5bb-9d00cbb39aeb",
      "jwt" : null,
      "ownerIdentityId" : "54abe6f6-0c9c-4c79-9852-33c618d7f27a",
      "createdBy" : "54abe6f6-0c9c-4c79-9852-33c618d7f27a",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a001e734-51a9-4f30-ab6a-e55f88b5ec99"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/fb796ba0-58b4-4310-9cb4-f9ac789f53e7"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:36.707Z",
      "id" : "a1794e53-4208-495b-940f-d974638cdced",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.707Z",
      "status" : "PROVISIONING",
      "networkId" : "a001e734-51a9-4f30-ab6a-e55f88b5ec99",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.707Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "b7d5e484-c6d7-460d-9346-5c45b8014b29",
      "dataCenterId" : "fe6ab46d-b09a-4df7-9d18-1c75ba440e9b",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "54abe6f6-0c9c-4c79-9852-33c618d7f27a",
      "createdBy" : "54abe6f6-0c9c-4c79-9852-33c618d7f27a",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a001e734-51a9-4f30-ab6a-e55f88b5ec99"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/a1794e53-4208-495b-940f-d974638cdced"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:36.776Z",
      "id" : "421dec23-f8ec-4493-a11a-38e8f2ec1d90",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.776Z",
      "status" : "PROVISIONING",
      "networkId" : "efef4593-f9c0-46a5-b3b5-9389101dff62",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.776Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "38929cf9-85ad-42b7-832b-11cd12c8d761",
      "dataCenterId" : "326890e0-0731-4b2e-b758-372ce5c38c92",
      "jwt" : null,
      "ownerIdentityId" : "9d60c844-75d7-46e8-b8b7-623b2a690bde",
      "createdBy" : "9d60c844-75d7-46e8-b8b7-623b2a690bde",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/efef4593-f9c0-46a5-b3b5-9389101dff62"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/421dec23-f8ec-4493-a11a-38e8f2ec1d90"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:36.777Z",
      "id" : "80442cb3-0f62-4f35-86c6-de113e5e2143",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.777Z",
      "status" : "PROVISIONING",
      "networkId" : "efef4593-f9c0-46a5-b3b5-9389101dff62",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.777Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "dd52553d-9995-46a1-a030-b24cc4696e34",
      "dataCenterId" : "e5c5c9bc-2389-43fb-aa14-1f8b9706a1af",
      "jwt" : null,
      "ownerIdentityId" : "9d60c844-75d7-46e8-b8b7-623b2a690bde",
      "createdBy" : "9d60c844-75d7-46e8-b8b7-623b2a690bde",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/efef4593-f9c0-46a5-b3b5-9389101dff62"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/80442cb3-0f62-4f35-86c6-de113e5e2143"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:36.777Z",
      "id" : "33faae70-de81-43c1-9cdf-e6a4f93cd23b",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.777Z",
      "status" : "PROVISIONING",
      "networkId" : "efef4593-f9c0-46a5-b3b5-9389101dff62",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.777Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "9507b8f8-9c99-4a37-b959-5bd178e2a7a6",
      "dataCenterId" : "d741c78e-d440-4178-9527-9cbd9d62f3b8",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "9d60c844-75d7-46e8-b8b7-623b2a690bde",
      "createdBy" : "9d60c844-75d7-46e8-b8b7-623b2a690bde",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/efef4593-f9c0-46a5-b3b5-9389101dff62"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/33faae70-de81-43c1-9cdf-e6a4f93cd23b"
        }
      }
    }, {
      "name" : "Test edge router 1599771156",
      "id" : "58ba8277-8d0b-4ccd-bc59-5fdf47f6264c",
      "attributes" : [ ],
      "verified" : false,
      "online" : false,
      "linkListener" : false,
      "provider" : null,
      "updatedAt" : "2020-09-10T20:52:36.898Z",
      "status" : "NEW",
      "networkId" : "efef4593-f9c0-46a5-b3b5-9389101dff62",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.896Z",
      "ipAddress" : null,
      "locationMetadataId" : null,
      "dataCenterId" : null,
      "jwt" : null,
      "ownerIdentityId" : "aafce8fc-a8b5-4dad-b93e-1ebd767443c7",
      "createdBy" : "aafce8fc-a8b5-4dad-b93e-1ebd767443c7",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/efef4593-f9c0-46a5-b3b5-9389101dff62"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/58ba8277-8d0b-4ccd-bc59-5fdf47f6264c"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:36.948Z",
      "id" : "e6210eb4-58ee-40a7-8aca-5c1df920c41f",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.948Z",
      "status" : "PROVISIONING",
      "networkId" : "132191ec-a010-4d49-8b3f-13b5d05a5dd9",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.948Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "f0ee3f30-d76d-47fe-81ce-4ab07b1596e7",
      "dataCenterId" : "5c29e7de-169b-4ca4-818d-54859516aae9",
      "jwt" : null,
      "ownerIdentityId" : "def86b20-34f1-4cdb-a5d1-fdc4650e6592",
      "createdBy" : "def86b20-34f1-4cdb-a5d1-fdc4650e6592",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/132191ec-a010-4d49-8b3f-13b5d05a5dd9"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/e6210eb4-58ee-40a7-8aca-5c1df920c41f"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:36.949Z",
      "id" : "5fd2047d-e657-4b41-b346-8ee9cb2b39a5",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.949Z",
      "status" : "PROVISIONING",
      "networkId" : "132191ec-a010-4d49-8b3f-13b5d05a5dd9",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.949Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "c7f42eb3-35a9-4de4-8de3-d58deaefaee3",
      "dataCenterId" : "3bc676f8-c305-48b0-88bc-1900a9a6522a",
      "jwt" : null,
      "ownerIdentityId" : "def86b20-34f1-4cdb-a5d1-fdc4650e6592",
      "createdBy" : "def86b20-34f1-4cdb-a5d1-fdc4650e6592",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/132191ec-a010-4d49-8b3f-13b5d05a5dd9"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/5fd2047d-e657-4b41-b346-8ee9cb2b39a5"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:36.949Z",
      "id" : "21e58dc0-5f89-49a2-a256-34a33d515519",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:36.949Z",
      "status" : "PROVISIONING",
      "networkId" : "132191ec-a010-4d49-8b3f-13b5d05a5dd9",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.949Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "68356849-c3ab-4864-95d6-4a4525608553",
      "dataCenterId" : "1e056e10-1af4-459d-a1a5-601837fc65e1",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "def86b20-34f1-4cdb-a5d1-fdc4650e6592",
      "createdBy" : "def86b20-34f1-4cdb-a5d1-fdc4650e6592",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/132191ec-a010-4d49-8b3f-13b5d05a5dd9"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/21e58dc0-5f89-49a2-a256-34a33d515519"
        }
      }
    }, {
      "name" : "Test edge router 1599771156",
      "id" : "5808fda3-bbcd-4e09-a078-f894fcdd50d6",
      "attributes" : [ ],
      "verified" : false,
      "online" : false,
      "linkListener" : true,
      "provider" : null,
      "updatedAt" : "2020-09-10T20:52:36.961Z",
      "status" : "NEW",
      "networkId" : "132191ec-a010-4d49-8b3f-13b5d05a5dd9",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:36.960Z",
      "ipAddress" : null,
      "locationMetadataId" : null,
      "dataCenterId" : "64976871-ca5b-45da-affe-87f16ff5ba4b",
      "jwt" : null,
      "ownerIdentityId" : "52e51cb3-1bba-43b6-ba58-cbcff0a08c5c",
      "createdBy" : "52e51cb3-1bba-43b6-ba58-cbcff0a08c5c",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/132191ec-a010-4d49-8b3f-13b5d05a5dd9"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/5808fda3-bbcd-4e09-a078-f894fcdd50d6"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:37.004Z",
      "id" : "117178c7-9107-4270-b239-63eebf852992",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.004Z",
      "status" : "PROVISIONING",
      "networkId" : "59b6c7e7-a33d-4ae9-8012-76032e8c695c",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.004Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "b653485c-74b1-4b39-a84e-a93f226b7e60",
      "dataCenterId" : "b24a8ede-4a76-46cb-8a12-c7d3bb1d9b7d",
      "jwt" : null,
      "ownerIdentityId" : "efe1868a-feaa-47ac-a06c-2a38e7547934",
      "createdBy" : "efe1868a-feaa-47ac-a06c-2a38e7547934",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/59b6c7e7-a33d-4ae9-8012-76032e8c695c"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/117178c7-9107-4270-b239-63eebf852992"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:37.005Z",
      "id" : "4575afc7-f886-4969-a749-830d74277b7b",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.005Z",
      "status" : "PROVISIONING",
      "networkId" : "59b6c7e7-a33d-4ae9-8012-76032e8c695c",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.005Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "6ad103aa-32d1-4eb0-9805-6656cdab8279",
      "dataCenterId" : "576e1a68-6d90-4ad7-bac4-85c1f9d293dd",
      "jwt" : null,
      "ownerIdentityId" : "efe1868a-feaa-47ac-a06c-2a38e7547934",
      "createdBy" : "efe1868a-feaa-47ac-a06c-2a38e7547934",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/59b6c7e7-a33d-4ae9-8012-76032e8c695c"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/4575afc7-f886-4969-a749-830d74277b7b"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:37.005Z",
      "id" : "8296811a-109f-4ac9-b681-c0e2fabd6de2",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.005Z",
      "status" : "PROVISIONING",
      "networkId" : "59b6c7e7-a33d-4ae9-8012-76032e8c695c",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.005Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "54fd97e7-7e82-4293-8615-dbd4450cc56e",
      "dataCenterId" : "31642be1-7ee7-4de4-9299-973141f239cb",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "efe1868a-feaa-47ac-a06c-2a38e7547934",
      "createdBy" : "efe1868a-feaa-47ac-a06c-2a38e7547934",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/59b6c7e7-a33d-4ae9-8012-76032e8c695c"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/8296811a-109f-4ac9-b681-c0e2fabd6de2"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:37.046Z",
      "id" : "0033c0ad-7982-4699-a6d1-2e9cf4f4cabf",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.046Z",
      "status" : "PROVISIONING",
      "networkId" : "05cdb143-a84b-4e54-bd29-30864069468e",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.046Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "a9aa1cfd-a586-4020-9c8b-1d32519ab581",
      "dataCenterId" : "57d6d88c-64f6-4076-9c2e-ecb17770cfaa",
      "jwt" : null,
      "ownerIdentityId" : "a5df81c8-82ad-4cf3-8953-492545c64af4",
      "createdBy" : "a5df81c8-82ad-4cf3-8953-492545c64af4",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/05cdb143-a84b-4e54-bd29-30864069468e"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/0033c0ad-7982-4699-a6d1-2e9cf4f4cabf"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:37.046Z",
      "id" : "f029608b-1473-4fdf-ad68-ccf43dc157ff",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.057Z",
      "status" : "DELETING",
      "networkId" : "05cdb143-a84b-4e54-bd29-30864069468e",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.046Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "513d471d-87a8-42fa-89d7-a2613762f1ac",
      "dataCenterId" : "158c0794-33ba-43b0-a261-313f04745023",
      "jwt" : null,
      "ownerIdentityId" : "a5df81c8-82ad-4cf3-8953-492545c64af4",
      "createdBy" : "a5df81c8-82ad-4cf3-8953-492545c64af4",
      "deletedBy" : "46aab04f-2487-4766-b3e4-f9195409f373",
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/05cdb143-a84b-4e54-bd29-30864069468e"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/f029608b-1473-4fdf-ad68-ccf43dc157ff"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:37.046Z",
      "id" : "7c83bf14-3a92-497a-abb1-5e108714b6e1",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.047Z",
      "status" : "PROVISIONING",
      "networkId" : "05cdb143-a84b-4e54-bd29-30864069468e",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.047Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "47296f9e-8785-4d23-b710-789de2c2e7f3",
      "dataCenterId" : "873e2205-22c1-4c6c-a40d-09c6735b116b",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "a5df81c8-82ad-4cf3-8953-492545c64af4",
      "createdBy" : "a5df81c8-82ad-4cf3-8953-492545c64af4",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/05cdb143-a84b-4e54-bd29-30864069468e"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/7c83bf14-3a92-497a-abb1-5e108714b6e1"
        }
      }
    }, {
      "name" : "Updated name",
      "id" : "3e01340c-d8cd-429e-92b6-88b032910be2",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.137Z",
      "status" : "PROVISIONING",
      "networkId" : "79af4e43-14b5-48cb-bc05-7c9d0374ceee",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.116Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "131d1d00-4622-40b9-b2fc-909a8d05b8d8",
      "dataCenterId" : "65ae00b8-523b-4659-8ab8-d76ab7f31043",
      "jwt" : null,
      "ownerIdentityId" : "d03e82bd-d7fc-43dc-9545-83970b44263a",
      "createdBy" : "d03e82bd-d7fc-43dc-9545-83970b44263a",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/79af4e43-14b5-48cb-bc05-7c9d0374ceee"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/3e01340c-d8cd-429e-92b6-88b032910be2"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:37.116Z",
      "id" : "3104b7db-9af6-46de-9421-ed26662664df",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.116Z",
      "status" : "PROVISIONING",
      "networkId" : "79af4e43-14b5-48cb-bc05-7c9d0374ceee",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.116Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "33fa1eab-27c5-46fa-927f-e1fa64f1290c",
      "dataCenterId" : "bc177a71-3c0a-466d-89e8-0e4bd26d59be",
      "jwt" : null,
      "ownerIdentityId" : "d03e82bd-d7fc-43dc-9545-83970b44263a",
      "createdBy" : "d03e82bd-d7fc-43dc-9545-83970b44263a",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/79af4e43-14b5-48cb-bc05-7c9d0374ceee"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/3104b7db-9af6-46de-9421-ed26662664df"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:37.116Z",
      "id" : "d19afed2-4319-47ed-842b-7601f69c7262",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.117Z",
      "status" : "PROVISIONING",
      "networkId" : "79af4e43-14b5-48cb-bc05-7c9d0374ceee",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.117Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "7e10deaf-85e5-4c16-bd79-4c0de27604af",
      "dataCenterId" : "f858bc1d-db24-4e8e-a0d6-b2ae07f50461",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "d03e82bd-d7fc-43dc-9545-83970b44263a",
      "createdBy" : "d03e82bd-d7fc-43dc-9545-83970b44263a",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/79af4e43-14b5-48cb-bc05-7c9d0374ceee"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/d19afed2-4319-47ed-842b-7601f69c7262"
        }
      }
    }, {
      "name" : "ACME_edge_router_2020-09-10T20:52:37.178Z",
      "id" : "0327de7b-1987-481d-b7da-9b5463e944b1",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.178Z",
      "status" : "PROVISIONING",
      "networkId" : "dd6e41dc-c51b-4276-8978-560f14f443e2",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.178Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "5ee3a804-ba22-4cf2-a59a-fc0cf0a61027",
      "dataCenterId" : "05561156-cce0-4435-827f-584cc052b859",
      "jwt" : null,
      "ownerIdentityId" : "c286c52f-0727-4ae7-ae0e-e2d1f707b31c",
      "createdBy" : "c286c52f-0727-4ae7-ae0e-e2d1f707b31c",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dd6e41dc-c51b-4276-8978-560f14f443e2"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/0327de7b-1987-481d-b7da-9b5463e944b1"
        }
      }
    }, {
      "name" : "ACME edge router 02 2020-09-10T20:52:37.178Z",
      "id" : "562c6a75-24c7-4e82-a106-af39e07609ff",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.178Z",
      "status" : "PROVISIONING",
      "networkId" : "dd6e41dc-c51b-4276-8978-560f14f443e2",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.178Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "e1673b93-4d34-4eb1-a168-98e383d6e42e",
      "dataCenterId" : "bf1ef04f-d265-47ea-9e8b-0c9872953a83",
      "jwt" : null,
      "ownerIdentityId" : "c286c52f-0727-4ae7-ae0e-e2d1f707b31c",
      "createdBy" : "c286c52f-0727-4ae7-ae0e-e2d1f707b31c",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dd6e41dc-c51b-4276-8978-560f14f443e2"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/562c6a75-24c7-4e82-a106-af39e07609ff"
        }
      }
    }, {
      "name" : "ACME edge router 03 2020-09-10T20:52:37.179Z",
      "id" : "62f0b787-e4de-4cc9-9a77-e31527d5f8cc",
      "attributes" : [ ],
      "verified" : true,
      "online" : false,
      "linkListener" : true,
      "provider" : "AWS",
      "updatedAt" : "2020-09-10T20:52:37.179Z",
      "status" : "PROVISIONING",
      "networkId" : "dd6e41dc-c51b-4276-8978-560f14f443e2",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:37.179Z",
      "ipAddress" : "1.2.3.4",
      "locationMetadataId" : "cb50571f-b355-4355-a9dc-2eeb6a75e42c",
      "dataCenterId" : "241244b8-dfbe-41c0-bd60-0f19b9e71a41",
      "jwt" : "jwtdata",
      "ownerIdentityId" : "c286c52f-0727-4ae7-ae0e-e2d1f707b31c",
      "createdBy" : "c286c52f-0727-4ae7-ae0e-e2d1f707b31c",
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/dd6e41dc-c51b-4276-8978-560f14f443e2"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/62f0b787-e4de-4cc9-9a77-e31527d5f8cc"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers"
    }
  },
  "page" : {
    "size" : 2000,
    "totalElements" : 41,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edge Router

GET /edge-routers/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

name

String

false

id

String

true

attributes

Array[String]

true

verified

Boolean

true

online

Boolean

true

linkListener

Boolean

true

provider

String

true

updatedAt

String

true

status

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

ipAddress

String

true

locationMetadataId

String

true

dataCenterId

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/bc14a0d5-ca6b-4ace-b74e-f0846a3ce0a2' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJxMWh4YjJBamVObzRPTHhoTi1sWkhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBlYWY0YWRiLTk4ZmQtNDI5ZC1hMDUwLWM4YTNkZTBmMTAyOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE1NywiZXhwIjoxNTk5Nzc0NzU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImM4ZTI0ZTA0LTg1NzYtNGY1ZS1hZGE2LTQ0ZDI2M2RmMGYxOVwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE1N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.QR-rDzlh1j6BTcGZYv75H2dS2Br1ibS4pyHV-U131kvaq6AWq2bufGnVUz5XsSif2bhLQMnH6qRl-VSr_7uHyj7AsHNZ0ahUEmdbH0u29ceKjiiJInsWEAiSRtr0GMUqUPDxbyxG4rKgXdzVamq2wybZDrD6IapX0mh9ie03RiYyzCMzAkAnps-f8Se0UbVNFZJum2lRS6j-2RL_RQeoReNWL0wvOHaUUGE5dJa4QOYM0Vlh5VbIkX2hsd-9LSzRWq3NKpaf369xRJicM39fqT69Bc9nc_47fSPa5NSaHg2DjMIkVZqUwBV39q5OfoA0sskdAhqnwTVgQFx6Wi1CvQ'

Example response

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

{
  "name" : "ACME_edge_router_2020-09-10T20:52:37.379Z",
  "id" : "bc14a0d5-ca6b-4ace-b74e-f0846a3ce0a2",
  "attributes" : [ ],
  "verified" : true,
  "online" : false,
  "linkListener" : true,
  "provider" : "AWS",
  "updatedAt" : "2020-09-10T20:52:37.379Z",
  "status" : "PROVISIONING",
  "networkId" : "363196c6-4cb1-43e9-9de8-a2a24faeab49",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:37.379Z",
  "ipAddress" : "1.2.3.4",
  "locationMetadataId" : "c60c9b9f-c957-4032-b454-d17c4388a04f",
  "dataCenterId" : "230abd7d-406e-4b3e-b148-4b755da145d2",
  "jwt" : null,
  "ownerIdentityId" : "a98a0ab2-b710-44eb-8cac-eedab7245977",
  "createdBy" : "a98a0ab2-b710-44eb-8cac-eedab7245977",
  "deletedBy" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/363196c6-4cb1-43e9-9de8-a2a24faeab49"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/bc14a0d5-ca6b-4ace-b74e-f0846a3ce0a2"
    }
  }
}

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

networkId

String

true

Client must have create action under the annotated resource.

dataCenterId

String

true

linkListener

Boolean

true

attributes

Array[String]

true

Response fields

Path Type Optional Description

name

String

false

id

String

true

attributes

Array[String]

true

verified

Boolean

true

online

Boolean

true

linkListener

Boolean

true

provider

String

true

updatedAt

String

true

status

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

ipAddress

String

true

locationMetadataId

String

true

dataCenterId

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

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.eyJqdGkiOiJnT3V6Q2ZXTG8xRVJIUHY0M1Jwckl3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImFhZmNlOGZjLWE4YjUtNGRhZC1iOTNlLTFlYmQ3Njc0NDNjNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE1NiwiZXhwIjoxNTk5Nzc0NzU2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjhhZWJiNzZjLTAyNjQtNGFhZS04MmVmLWVhNGYwNTAxNjQ5NFwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE1Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.tB6M9lwkhh8s1i7HKH624pCff2HihjFBXnmYiR4rxewvyTHrXHzkYj9fZnYLMpvEhw-MWmDPXEcLAWKWt0CQzqBv3v4BGjj5c9tgCE5SEEaWmhuOP7StiGdprr34bVe0apiFl9-dN8-Z2-AqSmBHn1i5OOM1naa1yo73bUsHQxVi3ONZS3ewJ4TOM6WZK9ZzzKIRZts2K552NHuoAVSRvR2-YWmlMywc-FhsVlIQNR_lgGDk2Yrxq2tc75VFIpOG1WhfZqDf3bIw2n1sUYIZKfd8-chVR2aqqv-ew-kWzvaryya9YEONn6-VAgjlifeqSicfBuV_wyQaaVpZ5p_6tQ' \
    -d '{"name":"Test edge router 1599771156","networkId":"efef4593-f9c0-46a5-b3b5-9389101dff62","dataCenterId":null,"linkListener":false,"attributes":[]}'

Example response

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

{
  "name" : "Test edge router 1599771156",
  "id" : "58ba8277-8d0b-4ccd-bc59-5fdf47f6264c",
  "attributes" : [ ],
  "verified" : false,
  "online" : false,
  "linkListener" : false,
  "provider" : null,
  "updatedAt" : "2020-09-10T20:52:36.898Z",
  "status" : "NEW",
  "networkId" : "efef4593-f9c0-46a5-b3b5-9389101dff62",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:36.896Z",
  "ipAddress" : null,
  "locationMetadataId" : null,
  "dataCenterId" : null,
  "jwt" : null,
  "ownerIdentityId" : "aafce8fc-a8b5-4dad-b93e-1ebd767443c7",
  "createdBy" : "aafce8fc-a8b5-4dad-b93e-1ebd767443c7",
  "deletedBy" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/efef4593-f9c0-46a5-b3b5-9389101dff62"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/58ba8277-8d0b-4ccd-bc59-5fdf47f6264c"
    }
  }
}

Patch Edge Router

PATCH /edge-routers/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

attributes

Array[String]

true

Response fields

Path Type Optional Description

name

String

false

id

String

true

attributes

Array[String]

true

verified

Boolean

true

online

Boolean

true

linkListener

Boolean

true

provider

String

true

updatedAt

String

true

status

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

ipAddress

String

true

locationMetadataId

String

true

dataCenterId

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/ecf0ce63-a66c-4d86-9865-ec8d9f271099' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJpV3I4YWt3ZjBlZGtQUmdHS3pKLTZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjgzY2FjZGFlLTM2MTAtNDA1My04OGRiLTVmMjNhM2ZkNDY4YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE1NywiZXhwIjoxNTk5Nzc0NzU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImViMGIxNzgwLThjNWEtNDJjMi1hYmUwLTQ4Yjk5YTUxYmI4MVwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE1N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Jve8D_7SdL_YkjVu2VrqO4E8AIlEOO1FMMttncl1BGxg6Hf1GFo1GzPUCrKQCwBUv-hj0SZsxV1MSiHkSNs5FLWOTl44DbrWdbeBazK4_aP--xJiicHZid0P3f02AlPaQwx9RCWgbMOMN4BYjcuCe4PN4AHnLcGu982bd97oOoQV8cceHKzgXX8_bDUrzujEjHMRDpaslf0JrzF4DbDnxs4ZbF1UdpUMVbnrDmj_vzOTvcEI-ym-JolmqUeGERb9w7U4fGkRtGkdUe3t-PvrCm-BhHfyGFO47QEoyG7A8cVpSDmRdjA_WBvHQm2rzcskzJb8AWUaHuMRza0CN54HuQ' \
    -d '{"name":"Updated name","attributes":null}'

Example response

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

{
  "name" : "Updated name",
  "id" : "ecf0ce63-a66c-4d86-9865-ec8d9f271099",
  "attributes" : [ ],
  "verified" : true,
  "online" : false,
  "linkListener" : true,
  "provider" : "AWS",
  "updatedAt" : "2020-09-10T20:52:37.331Z",
  "status" : "PROVISIONING",
  "networkId" : "9854dd95-7abd-4d00-a10b-f83e60a86fd6",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:37.317Z",
  "ipAddress" : "1.2.3.4",
  "locationMetadataId" : "b1eb2fe0-3355-41b4-bff9-39f3a5a11913",
  "dataCenterId" : "2fb02dfa-a53f-4372-8d84-557e3d47922b",
  "jwt" : null,
  "ownerIdentityId" : "309bdede-cc43-4fe3-bc8a-535d68589d8b",
  "createdBy" : "309bdede-cc43-4fe3-bc8a-535d68589d8b",
  "deletedBy" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9854dd95-7abd-4d00-a10b-f83e60a86fd6"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-routers/ecf0ce63-a66c-4d86-9865-ec8d9f271099"
    }
  }
}

Delete Edge Router

DELETE /edge-routers/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-routers/f029608b-1473-4fdf-ad68-ccf43dc157ff' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJfUkxNUmNGYXY5OGg0dWNIcExGb2NnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ2YWFiMDRmLTI0ODctNDc2Ni1iM2U0LWY5MTk1NDA5ZjM3MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE1NywiZXhwIjoxNTk5Nzc0NzU3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE1NDA5ZGM3LWM5MGQtNGRhMi1iMTcxLThkNWQ5ZDMxNWQwZlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE1N31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.WM3hMgh80XwRIXWryApltF6ZramUCjGgfFFIWWRXzBF1H233ICdJ0N6yJjt9823y_vqWYNuIHgRAetdCqg9Dp8g-GIJ37xP05S92mOTvA4_Tm7kH2VXUjBrnwvz6LBAFInMNeWITkQWzI-jfVKe4h5J0KItZUQCXx0z86ung3i7HB1_iM-OvuJuJATOYOLICn9KtG97x8GhHuQ0SV0WpJLVdg6H-HU7RujCXRFdbRngfAGdCBkkXBtzWQ0oRFi2OA-HNac5XWcOHRDN6LlMCMWnNobwCwtNOIkSt1oRI6B95El0bmpU9QrWMtsfZ7h2b5D1LGNZKAJxUCf3pd4bHcw'

Example response

HTTP/1.1 200 OK

Edge Router Policies

Find Edge Router Policies

GET /edge-router-policies

Authorization

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

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

name

String

false

id

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

edgeRouterAttributes

Array[String]

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

true

Path Optional Description

self

false

network

false

Embedded resources

Path Type Optional Description

name

String

false

id

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

edgeRouterAttributes

Array[String]

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ4QUhHTFhtUkVJeFJBUGtFMDZnVWhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM0ZjM1NGEwLTdmMzctNGZiNS1hMDRiLWZiMmIxNTU3ODdiYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE4MiwiZXhwIjoxNTk5Nzc0NzgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjE3MzYxYTVhLWJiYjgtNDU5Zi1hMzEwLTJkZjJjNzVkNDEwN1wiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE4Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.s7HeAUlLx7lNUY8o6U3k77RcGPQiT7R7WF4B6PtEYAfJ1fWhPJfgNfnVIhNYOekCORKzPO4dPCS-VsknXNoM6EIlIeVPA9YQRWEqQw_mwL814rddtSZfXsgbuYd0KPXPNTulTvrq2TA2siRmlnws1dgrrK96M2oeTbDdvHWmq3t86L-lCEUs8NrYA3EfVifDmjDMkfyoWkWr3yyo1dW2OosQcBGbQz2PmHQewQLowkWuVLQcdlq06Dn_nge8dT5HJMUXxxITWFfG0gyYAvnJbz5aAcypB0Mhxmo3RTvMFPC64QYMPGU7Ya5ni4SdqHdCybWHg8hrjnQBWH1MM6VxpA'

Example response

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

{
  "_embedded" : {
    "edgeRouterPolicyList" : [ {
      "name" : "ACME edge router policy 2020-09-10T20:53:02.859Z",
      "id" : "b1bfdf36-7404-4982-af0d-8d6960125872",
      "updatedAt" : "2020-09-10T20:53:02.859Z",
      "networkId" : "21354fa6-ce03-4926-a929-26f8205bafbb",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:53:02.859Z",
      "edgeRouterAttributes" : [ ],
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/21354fa6-ce03-4926-a929-26f8205bafbb"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/b1bfdf36-7404-4982-af0d-8d6960125872"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies"
    }
  },
  "page" : {
    "size" : 2000,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edge Router Policy

GET /edge-router-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

name

String

false

id

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

edgeRouterAttributes

Array[String]

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

true

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/c7ef26ef-021f-47e0-81d5-331a831f057f' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJieS1zQTNUenA3RHRZbTI2VUh5OTJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZlOThjN2RjLTFkZWQtNDBlNC1iNDE5LTUyNGRmOTIxMmVhZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE4MiwiZXhwIjoxNTk5Nzc0NzgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBkNDM3OTQ3LTEzMmMtNDFhNi1iZDNlLWRlNTI5YTNlYTg2ZFwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE4Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.l3YUsGv61SlBprMgG9nU4oTA3VFJyTlMkT-Vf9ccjZyeYiYVftGVAQpRBxRvck5Ea2LwmN1ZnNIRqvEFEeN_BkxiPcH0J76vd45kzVBxPIyd1877f6ZFFVNPrEWTY2wloTPZBngHcCOeuf17Ofubul3nRBSUGUgjUPPR3ugPL-SrFsVmlBLtr0B-fVdrGvEQyirxO0KFjUmk1gD56c3nnfYHkAMik6rJrzEJn9TXWIHhsmigrWy9NHoWODw4h7h0fev8zCJEd6SJC3jYYZXha_sTuyVqm0CxEiO6YICv9W7qwY_oh4wxVkfjO1Q0uBydKBznvFE2uNoT0DJtPeV9SQ'

Example response

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

{
  "name" : "ACME edge router policy 2020-09-10T20:53:02.991Z",
  "id" : "c7ef26ef-021f-47e0-81d5-331a831f057f",
  "updatedAt" : "2020-09-10T20:53:02.991Z",
  "networkId" : "28012fcb-af84-44d9-ae88-570431f521a2",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:53:02.991Z",
  "edgeRouterAttributes" : [ ],
  "ownerIdentityId" : null,
  "createdBy" : null,
  "deletedBy" : null,
  "endpointAttributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/28012fcb-af84-44d9-ae88-570431f521a2"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/c7ef26ef-021f-47e0-81d5-331a831f057f"
    }
  }
}

Create Edge Router Policy

POST /edge-router-policies

Authorization

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

networkId

String

true

Client must have create action under the annotated resource.

endpointAttributes

Array[String]

true

edgeRouterAttributes

Array[String]

true

Response fields

Path Type Optional Description

name

String

false

id

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

edgeRouterAttributes

Array[String]

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

true

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.eyJqdGkiOiJLeXFtT1Z1bmtIa2JwSV9QaHk3UmpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM5MTk3YTBkLWIyODktNDZkMy05NzhkLTkyMmJlZDlkMjc0ZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE4MiwiZXhwIjoxNTk5Nzc0NzgyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImZkNDgzNDQwLTFhZWItNGU1OS05ZTc0LTU1M2ZkZjJkZTRmM1wiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE4Mn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.flIbeIvpB5zMjiaBiUsKrMujf_owggb0e4iWfnUJICjJPWr3NJ0OPar4rDVaBQP7BimKQ18ASNq1QgON5C-f7KnpdKK4-50z_xzQNMWseXuERorV-T8X9SMQiIYEKdBO553QaAr0L5TME5I8DO3Utoz_1rhY58w_GnLNBsuE4O-F9bc3zb9YrufFzknsp5F7aihGAwhDTzS4XjTZmHotiwAES9Kx8yB8FFJLX9uvsyjoxizc0wCS5pseEjMoONU6d9XRN2pzd4lRlOVuVbGZ2B4WkQEyEUxeEDMolC0fW8DFbHlHz5nB9f7OSkDKG9tHwBeSbX_74uzdhtkxAs9udw' \
    -d '{"name":"Test edge router policy 1599771182","networkId":"9d52925d-0778-4b15-af25-59dd7ede6b99","endpointAttributes":["#topclients"],"edgeRouterAttributes":["#westrouters","@ACME_edge_router_2020-09-10T20:53:02.932Z"]}'

Example response

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

{
  "name" : "Test edge router policy 1599771182",
  "id" : "f335b5b4-0722-4b2a-87d5-1f0b601e69ef",
  "updatedAt" : "2020-09-10T20:53:02.956Z",
  "networkId" : "9d52925d-0778-4b15-af25-59dd7ede6b99",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:53:02.955Z",
  "edgeRouterAttributes" : [ "#westrouters", "@ACME_edge_router_2020-09-10T20:53:02.932Z" ],
  "ownerIdentityId" : "39197a0d-b289-46d3-978d-922bed9d274f",
  "createdBy" : "39197a0d-b289-46d3-978d-922bed9d274f",
  "deletedBy" : null,
  "endpointAttributes" : [ "#topclients" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/9d52925d-0778-4b15-af25-59dd7ede6b99"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/f335b5b4-0722-4b2a-87d5-1f0b601e69ef"
    }
  }
}

Update Edge Router Policy

PUT /edge-router-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

networkId

String

true

endpointAttributes

Array[String]

true

edgeRouterAttributes

Array[String]

true

Response fields

Path Type Optional Description

name

String

false

id

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

edgeRouterAttributes

Array[String]

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

true

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/21a10806-6dc5-457f-9ba5-8b4bb6c8d1da' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhUnFtejN5M2xVaERaZkE1OUE0WWlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVhZDhjNmZlLWJhMGUtNDgwNS1iMDhmLWNlOTc2YjQxYTk0MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE4MywiZXhwIjoxNTk5Nzc0NzgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjNkZjYxODFlLTFlNjAtNGQ2MS04NWM1LTFhZTgzN2UzNTFhN1wiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.j-M2ts4B3Bm_U3EK3y6JUFieD2Y4h6NeB2_jWtVAKiL9t03oJ8YQFSrQWKqLIWSMpEr52AZpYUM1atD8UKEy7Cx2E83CiT3j4CLA7NvywX2DM1hjmRFVDtGdbm60DQGf3rdcUK1fsoK99OWye_J8r6KjlLh5W3UAmXCO5WZ-m283Zx3_Em6lScoOPgHVZpw_6ptNepPAVOTEs_9HqyPXJjpFmxLLsZe_AgxMCkuxS7nKI-2cZl-_uJgbZDsx-pnrq9fwoAPaAcUiZaq7hQsA-OX482zSRTIFHYRrbDnKEeBeFdTTGNrLcJFUkbD9EDgJBH6xBY5c6_ARk8LsN7R5tg' \
    -d '{"name":"Updated edge router policy name","networkId":"d4cb49e7-778d-4c8d-bfcd-cfa98d10fd0e","endpointAttributes":["#useastrouters"],"edgeRouterAttributes":["#usendpoints"]}'

Example response

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

{
  "name" : "Updated edge router policy name",
  "id" : "21a10806-6dc5-457f-9ba5-8b4bb6c8d1da",
  "updatedAt" : "2020-09-10T20:53:03.180Z",
  "networkId" : "d4cb49e7-778d-4c8d-bfcd-cfa98d10fd0e",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:53:03.171Z",
  "edgeRouterAttributes" : [ "#usendpoints" ],
  "ownerIdentityId" : null,
  "createdBy" : null,
  "deletedBy" : null,
  "endpointAttributes" : [ "#useastrouters" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/d4cb49e7-778d-4c8d-bfcd-cfa98d10fd0e"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/edge-router-policies/21a10806-6dc5-457f-9ba5-8b4bb6c8d1da"
    }
  }
}

Delete Edge Router Policy

DELETE /edge-router-policies/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/edge-router-policies/962f25b2-24c6-4e4a-85d8-6991aefef4dc' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ2eVN6YjJfWUdoWDJiMVpNejRtSDZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZlNWYzOGI2LTkwNDEtNDUxYy1iODNkLTRkOTkwZmFlOWZjMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE4MywiZXhwIjoxNTk5Nzc0NzgzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjUyYjA1MzBmLWVhYmUtNDI2ZS04NTE0LTA0OTk0ZmIyNTFkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE4M31dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ZKSBXvk_rfx7ku3wRi87zjyOdw1r6buPPfSSh17e2ogqfAdflb8261uBIxUh5idUf4b2DL9mbTkXO5UR98pMfbQSskYAGKD_E4gQKz-5JwTIe1deuoYgK_7R6BUWTZk-fv2FVeTJw2qW0AL-FumXo95efPFsIS2Pn0pC4TyWdgGGL_mQkur7lRe67WEjKYRH6tHKLl_BhtX2giPvb4EkFl2gdfyGxmNxY_1f97YnyMNm4GMmNyl3a8AtKh0_bt3Xn3NqaOiUsTvwgqlkKexKLipdU0Kg3sRxcXsx4_4SKsjguRSdoeCip3bG12JMFbn7DZSqZW1kSst0gqf5VSPkjg'

Example response

HTTP/1.1 200 OK

Services

Find Services

GET /services

Authorization

This endpoint requires read action on the service resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

name

String

false

id

String

true

attributes

Array[String]

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

endpoints

Array[String]

true

egressRouterId

String

true

edgeRouterAttributes

Array[String]

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

Path Optional Description

self

false

network

false

Embedded resources

Path Type Optional Description

name

String

false

id

String

true

attributes

Array[String]

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

endpoints

Array[String]

true

egressRouterId

String

true

edgeRouterAttributes

Array[String]

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/services' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvR0tnbkwxVnZzaEZvWHRVLWhLam5nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU2YzAyYWIzLWNhMzYtNGIxOS04ODRjLTk3ZDg3MjYyOWE0ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE0OCwiZXhwIjoxNTk5Nzc0NzQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImYzYmE4MjY3LWQzMzctNDM5Mi1hYzNiLTVmYzE5MmMzMjM0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE0OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.dHm0_cQr_GEN-lYRNIKluwfkaFYUA02gm0YBRMUiLrXLKCR5w5bfwJ2DoRqxDyCUa8tVH41X0Ni_RaF5vA1FvQzpMeerPp1AtPnipxFtoFvnJrVWCdGUIIxGfmggRIED9KgEpYsoi50emcU8sV8lcdyVKuPX--g-mDb_9XfhYzPd685JBzfjsvoTd8vxfBkw30L8kCKQVNqiNSmfc6e4RxuNcEqat9lslFYh9RtRZKE1GtNoD2wGZfatb04upg-dpj3wQ31MZ5Yk6pmXHHCdYKtEUf8oBfxgcS0mUMvu3VSGF0jcdvtGBtQ_5klJFTdr_y3Uja176y7MKnmN5-OFLw'

Example response

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

{
  "_embedded" : {
    "serviceList" : [ {
      "name" : "ACME_Service01_2020-09-10T20:52:28.217Z",
      "id" : "7a236bbc-0803-4e35-807e-a64e85602e2e",
      "attributes" : [ ],
      "updatedAt" : "2020-09-10T20:52:28.217Z",
      "networkId" : "0aef069f-a47a-431d-9dc2-10ecd85613e5",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.217Z",
      "endpoints" : [ ],
      "egressRouterId" : "b3884088-ae9e-4d73-8814-bd25f2d8723e",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "outlook.office.com",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/0aef069f-a47a-431d-9dc2-10ecd85613e5"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/7a236bbc-0803-4e35-807e-a64e85602e2e"
        }
      }
    }, {
      "name" : "ACME Service02 2020-09-10T20:52:28.218Z",
      "id" : "b6297465-b5a0-4da2-9397-432df214b589",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.218Z",
      "networkId" : "0aef069f-a47a-431d-9dc2-10ecd85613e5",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.218Z",
      "endpoints" : [ ],
      "egressRouterId" : "b3884088-ae9e-4d73-8814-bd25f2d8723e",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/0aef069f-a47a-431d-9dc2-10ecd85613e5"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/b6297465-b5a0-4da2-9397-432df214b589"
        }
      }
    }, {
      "name" : "ACME Service03 2020-09-10T20:52:28.220Z",
      "id" : "6fb7c5ff-f0a7-425d-8125-6c09059406c2",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.220Z",
      "networkId" : "0aef069f-a47a-431d-9dc2-10ecd85613e5",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.220Z",
      "endpoints" : [ ],
      "egressRouterId" : "b3884088-ae9e-4d73-8814-bd25f2d8723e",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/0aef069f-a47a-431d-9dc2-10ecd85613e5"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/6fb7c5ff-f0a7-425d-8125-6c09059406c2"
        }
      }
    }, {
      "name" : "ACME Service04 2020-09-10T20:52:28.222Z",
      "id" : "0dfb79f8-6487-4797-b41e-aa9428680634",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.222Z",
      "networkId" : "0aef069f-a47a-431d-9dc2-10ecd85613e5",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.222Z",
      "endpoints" : [ ],
      "egressRouterId" : null,
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/0aef069f-a47a-431d-9dc2-10ecd85613e5"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/0dfb79f8-6487-4797-b41e-aa9428680634"
        }
      }
    }, {
      "name" : "Test Service 1599771148",
      "id" : "0e6d4c4f-c430-472f-937b-7df15f05ae2d",
      "attributes" : [ "#service01" ],
      "updatedAt" : "2020-09-10T20:52:28.422Z",
      "networkId" : "0aef069f-a47a-431d-9dc2-10ecd85613e5",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.408Z",
      "endpoints" : [ "03cb1680-4a21-418d-9a86-c7a9581aa972" ],
      "egressRouterId" : null,
      "edgeRouterAttributes" : [ "#accessrouters" ],
      "clientHostName" : "newclient.com",
      "clientPortRange" : "80",
      "serverHostName" : "newserver.com",
      "serverPortRange" : "80",
      "serverProtocol" : "UDP",
      "ownerIdentityId" : "395a5ed4-d833-4b7b-b883-8cf3b2ddd275",
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/0aef069f-a47a-431d-9dc2-10ecd85613e5"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/0e6d4c4f-c430-472f-937b-7df15f05ae2d"
        }
      }
    }, {
      "name" : "Test Service 1599771148",
      "id" : "f4372a6f-771f-42e5-981b-8cbedfc80d3e",
      "attributes" : [ "#service01" ],
      "updatedAt" : "2020-09-10T20:52:28.536Z",
      "networkId" : "fdb4dcf8-262e-4618-b9ee-2a748702cf64",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.518Z",
      "endpoints" : [ ],
      "egressRouterId" : "4e14c61e-b5e8-41bd-a8a4-605d9e17cdb1",
      "edgeRouterAttributes" : [ "#accessrouterswest", "#accessrouterseast" ],
      "clientHostName" : "newclient.com",
      "clientPortRange" : "443",
      "serverHostName" : "newserver.com",
      "serverPortRange" : "443",
      "serverProtocol" : "UDP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/fdb4dcf8-262e-4618-b9ee-2a748702cf64"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/f4372a6f-771f-42e5-981b-8cbedfc80d3e"
        }
      }
    }, {
      "name" : "ACME Service02 2020-09-10T20:52:28.519Z",
      "id" : "067b9907-08a5-448b-b5ff-62bfb1fc3dd0",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.519Z",
      "networkId" : "fdb4dcf8-262e-4618-b9ee-2a748702cf64",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.519Z",
      "endpoints" : [ ],
      "egressRouterId" : "4e14c61e-b5e8-41bd-a8a4-605d9e17cdb1",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/fdb4dcf8-262e-4618-b9ee-2a748702cf64"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/067b9907-08a5-448b-b5ff-62bfb1fc3dd0"
        }
      }
    }, {
      "name" : "ACME Service03 2020-09-10T20:52:28.520Z",
      "id" : "eceb1b54-bcbc-467d-b6c7-c5ff0d64f7a7",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.520Z",
      "networkId" : "fdb4dcf8-262e-4618-b9ee-2a748702cf64",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.520Z",
      "endpoints" : [ ],
      "egressRouterId" : "4e14c61e-b5e8-41bd-a8a4-605d9e17cdb1",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/fdb4dcf8-262e-4618-b9ee-2a748702cf64"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/eceb1b54-bcbc-467d-b6c7-c5ff0d64f7a7"
        }
      }
    }, {
      "name" : "ACME Service04 2020-09-10T20:52:28.521Z",
      "id" : "30b79e38-e325-4746-a47e-5bf295bbcb70",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.522Z",
      "networkId" : "fdb4dcf8-262e-4618-b9ee-2a748702cf64",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.522Z",
      "endpoints" : [ ],
      "egressRouterId" : null,
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/fdb4dcf8-262e-4618-b9ee-2a748702cf64"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/30b79e38-e325-4746-a47e-5bf295bbcb70"
        }
      }
    }, {
      "name" : "ACME_Service01_2020-09-10T20:52:28.609Z",
      "id" : "c00265b8-9b27-456e-93e1-7a0e7601bfe6",
      "attributes" : [ ],
      "updatedAt" : "2020-09-10T20:52:28.609Z",
      "networkId" : "c0be88a1-83c3-4126-8f5c-20ee88d054f9",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.609Z",
      "endpoints" : [ ],
      "egressRouterId" : "919fc509-70fe-40e6-8079-d84a3770a01f",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "outlook.office.com",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/c0be88a1-83c3-4126-8f5c-20ee88d054f9"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/c00265b8-9b27-456e-93e1-7a0e7601bfe6"
        }
      }
    }, {
      "name" : "ACME Service02 2020-09-10T20:52:28.610Z",
      "id" : "383db34b-ebd2-4580-8833-d1bc6d9b7f60",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.610Z",
      "networkId" : "c0be88a1-83c3-4126-8f5c-20ee88d054f9",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.610Z",
      "endpoints" : [ ],
      "egressRouterId" : "919fc509-70fe-40e6-8079-d84a3770a01f",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/c0be88a1-83c3-4126-8f5c-20ee88d054f9"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/383db34b-ebd2-4580-8833-d1bc6d9b7f60"
        }
      }
    }, {
      "name" : "ACME Service03 2020-09-10T20:52:28.611Z",
      "id" : "bfda9f17-c92a-4fc4-a01f-65959e2f4826",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.611Z",
      "networkId" : "c0be88a1-83c3-4126-8f5c-20ee88d054f9",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.611Z",
      "endpoints" : [ ],
      "egressRouterId" : "919fc509-70fe-40e6-8079-d84a3770a01f",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/c0be88a1-83c3-4126-8f5c-20ee88d054f9"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/bfda9f17-c92a-4fc4-a01f-65959e2f4826"
        }
      }
    }, {
      "name" : "ACME Service04 2020-09-10T20:52:28.612Z",
      "id" : "e098b0a7-8e76-444d-82aa-c037d15f323c",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.612Z",
      "networkId" : "c0be88a1-83c3-4126-8f5c-20ee88d054f9",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.612Z",
      "endpoints" : [ ],
      "egressRouterId" : null,
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/c0be88a1-83c3-4126-8f5c-20ee88d054f9"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/e098b0a7-8e76-444d-82aa-c037d15f323c"
        }
      }
    }, {
      "name" : "ACME_Service01_2020-09-10T20:52:28.674Z",
      "id" : "e8ec55bc-3bcc-4d1a-8c4a-b0cb26b10048",
      "attributes" : [ ],
      "updatedAt" : "2020-09-10T20:52:28.675Z",
      "networkId" : "beb4bc72-0f01-445a-8c78-ad55236c8272",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.675Z",
      "endpoints" : [ ],
      "egressRouterId" : "be7dedf4-9f0c-452b-826a-b0531c48159a",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "outlook.office.com",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/beb4bc72-0f01-445a-8c78-ad55236c8272"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/e8ec55bc-3bcc-4d1a-8c4a-b0cb26b10048"
        }
      }
    }, {
      "name" : "ACME Service02 2020-09-10T20:52:28.676Z",
      "id" : "505153af-c238-46ab-9e5f-538cb3a6825d",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.676Z",
      "networkId" : "beb4bc72-0f01-445a-8c78-ad55236c8272",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.676Z",
      "endpoints" : [ ],
      "egressRouterId" : "be7dedf4-9f0c-452b-826a-b0531c48159a",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/beb4bc72-0f01-445a-8c78-ad55236c8272"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/505153af-c238-46ab-9e5f-538cb3a6825d"
        }
      }
    }, {
      "name" : "ACME Service03 2020-09-10T20:52:28.678Z",
      "id" : "5b32390c-750e-4254-b69c-56925c6d4597",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.678Z",
      "networkId" : "beb4bc72-0f01-445a-8c78-ad55236c8272",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.678Z",
      "endpoints" : [ ],
      "egressRouterId" : "be7dedf4-9f0c-452b-826a-b0531c48159a",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/beb4bc72-0f01-445a-8c78-ad55236c8272"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/5b32390c-750e-4254-b69c-56925c6d4597"
        }
      }
    }, {
      "name" : "ACME Service04 2020-09-10T20:52:28.680Z",
      "id" : "b49fda57-c3a7-4d84-9914-a9e4fc5bc746",
      "attributes" : [ "#service01" ],
      "updatedAt" : "2020-09-10T20:52:28.691Z",
      "networkId" : "beb4bc72-0f01-445a-8c78-ad55236c8272",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.680Z",
      "endpoints" : [ "2e34bd72-aeab-4757-9fe8-f995bc63ee7c" ],
      "egressRouterId" : null,
      "edgeRouterAttributes" : [ "#accessrouterswest", "#accessrouterseast" ],
      "clientHostName" : "newclient.com",
      "clientPortRange" : "443",
      "serverHostName" : "newserver.com",
      "serverPortRange" : "443",
      "serverProtocol" : "UDP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/beb4bc72-0f01-445a-8c78-ad55236c8272"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/b49fda57-c3a7-4d84-9914-a9e4fc5bc746"
        }
      }
    }, {
      "name" : "ACME_Service01_2020-09-10T20:52:28.748Z",
      "id" : "55131de6-e9ba-473b-82fc-fd953a3ac417",
      "attributes" : [ ],
      "updatedAt" : "2020-09-10T20:52:28.748Z",
      "networkId" : "1d1b4ede-5ecb-4a2a-bc45-466912d48402",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.748Z",
      "endpoints" : [ ],
      "egressRouterId" : "e76ff510-8fc7-4aab-ac8f-c18522a35cee",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "outlook.office.com",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/1d1b4ede-5ecb-4a2a-bc45-466912d48402"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/55131de6-e9ba-473b-82fc-fd953a3ac417"
        }
      }
    }, {
      "name" : "ACME Service02 2020-09-10T20:52:28.749Z",
      "id" : "8a3efe00-9a92-4cbb-af86-aad91c2624b4",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.749Z",
      "networkId" : "1d1b4ede-5ecb-4a2a-bc45-466912d48402",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.749Z",
      "endpoints" : [ ],
      "egressRouterId" : "e76ff510-8fc7-4aab-ac8f-c18522a35cee",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "13.107.6.152",
      "clientPortRange" : "443",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/1d1b4ede-5ecb-4a2a-bc45-466912d48402"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/8a3efe00-9a92-4cbb-af86-aad91c2624b4"
        }
      }
    }, {
      "name" : "ACME Service03 2020-09-10T20:52:28.750Z",
      "id" : "bff906f0-47cc-48bd-8abc-7a13ac781efa",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.750Z",
      "networkId" : "1d1b4ede-5ecb-4a2a-bc45-466912d48402",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.750Z",
      "endpoints" : [ ],
      "egressRouterId" : "e76ff510-8fc7-4aab-ac8f-c18522a35cee",
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/1d1b4ede-5ecb-4a2a-bc45-466912d48402"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/bff906f0-47cc-48bd-8abc-7a13ac781efa"
        }
      }
    }, {
      "name" : "ACME Service04 2020-09-10T20:52:28.751Z",
      "id" : "3aea9d81-ab90-4e04-a95a-4926dd7e5f81",
      "attributes" : [ "#clientservices" ],
      "updatedAt" : "2020-09-10T20:52:28.751Z",
      "networkId" : "1d1b4ede-5ecb-4a2a-bc45-466912d48402",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:28.751Z",
      "endpoints" : [ ],
      "egressRouterId" : null,
      "edgeRouterAttributes" : [ ],
      "clientHostName" : "",
      "clientPortRange" : "",
      "serverHostName" : "server.com",
      "serverPortRange" : "443",
      "serverProtocol" : "TCP",
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/networks/1d1b4ede-5ecb-4a2a-bc45-466912d48402"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/services/3aea9d81-ab90-4e04-a95a-4926dd7e5f81"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/services"
    }
  },
  "page" : {
    "size" : 2000,
    "totalElements" : 21,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Service

GET /services/{id}

Authorization

This endpoint requires read action on the service resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

name

String

false

id

String

true

attributes

Array[String]

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

endpoints

Array[String]

true

egressRouterId

String

true

edgeRouterAttributes

Array[String]

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/services/c00265b8-9b27-456e-93e1-7a0e7601bfe6' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI4enExTlZiRWVaWThIdW9xNlk5SUVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI2MzAxZDI0LWM2NDctNDJjZi04YzFmLTU5YjdiN2ZkNjRiMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE0OCwiZXhwIjoxNTk5Nzc0NzQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjRmMTA5ZmIyLTU2MjAtNGM4OC04OWFkLTNlMjllNTI0OTliM1wiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE0OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.XOFYbAzPslPQwbj6X0EL5Uot5jGNvAHNUAwMciTl8TWOmNsWKHd7kJ4FI4jstyTWsvkcVpdq0TifIuRLUmGdyDf55jdD6rNIepDrCRw0FXbsQPF0Om6yrQOj4NTLs-UV8wnnK3Zsy2pIy3QrNrqUTGK93FP3SFARuUSNvEeoYD5mapRhav6Q6LyeOrEoH5XyaGozydRN647kp4nzPPuj9vDfcX99YgRZs91psvG2b9c7ll1SS-6TnmgU0PO_Q7eUFfo8ribFEKPWFB3mnW1gcgxBdcsUFowsJ3l2JS8o0hVFspgNuBx2kr64-4SbdvowCT-xgOq67FVZkY-w0t-IQw'

Example response

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

{
  "name" : "ACME_Service01_2020-09-10T20:52:28.609Z",
  "id" : "c00265b8-9b27-456e-93e1-7a0e7601bfe6",
  "attributes" : [ ],
  "updatedAt" : "2020-09-10T20:52:28.609Z",
  "networkId" : "c0be88a1-83c3-4126-8f5c-20ee88d054f9",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:28.609Z",
  "endpoints" : [ ],
  "egressRouterId" : "919fc509-70fe-40e6-8079-d84a3770a01f",
  "edgeRouterAttributes" : [ ],
  "clientHostName" : "outlook.office.com",
  "clientPortRange" : "443",
  "serverHostName" : "server.com",
  "serverPortRange" : "443",
  "serverProtocol" : "TCP",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "deletedBy" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/networks/c0be88a1-83c3-4126-8f5c-20ee88d054f9"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/services/c00265b8-9b27-456e-93e1-7a0e7601bfe6"
    }
  }
}

Create Service

POST /services

Authorization

This endpoint requires create action on the service resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

networkId

String

true

Client must have create action under the annotated resource.

egressRouterId

String

true

endpoints

Array[String]

true

attributes

Array[String]

true

edgeRouterAttributes

Array[String]

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

Must be one of [TCP, UDP].

Response fields

Path Type Optional Description

name

String

false

id

String

true

attributes

Array[String]

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

endpoints

Array[String]

true

egressRouterId

String

true

edgeRouterAttributes

Array[String]

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/services' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiItdDd6WXlDeXc5NUs1UVd1N1BrSzRnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBkZGQ4NGUxLWE4MDEtNDQ3OC1iMzgxLTU3NWNhNmQ2YzM5OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE0OSwiZXhwIjoxNTk5Nzc0NzQ5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjBkMzEyOGEwLWI5YWUtNDQ2YS05ZmFhLWFiOGM5ZjgyNzMzNlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE0OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ApmiZB4yZjedAzxjOdWXE3XxUgsBQW06J7pTEBPDXQBtvtT5QdI0zU14aFpNOD1tsJZqs24jGKM-UtmQC_PQ_ZuYmB_MO6ia7H4WnHcg-qRJbE7jzHGzW0_AuwDfJ36qYMPStD7rSxIoX7UD1hUkDMUcCM8OcvXkwJgvM7fCwJ8nJOmIt4keAOGgzjyhe6QX0_kuvva60veFjHMtrQX5wbU92YaK7fCQi8htVja4MFdYoq0CLsv3TTccIt3Ui-pFT63abztlfNW0k_8wZ8yaHY3LngLbVeyfkUVj43Y9Obzj2BQ_6sdndhn3NE3rCQG8GzXEEAGrj4Q54wcDwhECew' \
    -d '{"name":"Test Service 1599771149","networkId":"735be04e-a0bb-4f3c-9c1a-db9f9f8f4c18","egressRouterId":"6d2c3a08-e3ec-4bfb-b6ed-9d82737ab38f","endpoints":null,"attributes":["#service01"],"edgeRouterAttributes":["#accessrouters"],"clientHostName":"newclient.com","clientPortRange":"80","serverHostName":"newserver.com","serverPortRange":"80","serverProtocol":"UDP"}'

Example response

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

{
  "name" : "Test Service 1599771149",
  "id" : "a117ccea-6552-4592-9bf7-afe98acc228e",
  "attributes" : [ "#service01" ],
  "updatedAt" : "2020-09-10T20:52:29.097Z",
  "networkId" : "735be04e-a0bb-4f3c-9c1a-db9f9f8f4c18",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:29.097Z",
  "endpoints" : [ ],
  "egressRouterId" : "6d2c3a08-e3ec-4bfb-b6ed-9d82737ab38f",
  "edgeRouterAttributes" : [ "#accessrouters" ],
  "clientHostName" : "newclient.com",
  "clientPortRange" : "80",
  "serverHostName" : "newserver.com",
  "serverPortRange" : "80",
  "serverProtocol" : "UDP",
  "ownerIdentityId" : "0ddd84e1-a801-4478-b381-575ca6d6c399",
  "createdBy" : null,
  "deletedBy" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/networks/735be04e-a0bb-4f3c-9c1a-db9f9f8f4c18"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/services/a117ccea-6552-4592-9bf7-afe98acc228e"
    }
  }
}

Update Service

PUT /services/{id}

Authorization

This endpoint requires update action on the service resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

egressRouterId

String

true

endpoints

Array[String]

true

attributes

Array[String]

true

edgeRouterAttributes

Array[String]

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

Must be one of [TCP, UDP].

Response fields

Path Type Optional Description

name

String

false

id

String

true

attributes

Array[String]

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

endpoints

Array[String]

true

egressRouterId

String

true

edgeRouterAttributes

Array[String]

true

clientHostName

String

true

clientPortRange

String

true

serverHostName

String

true

serverPortRange

String

true

serverProtocol

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/services/f4372a6f-771f-42e5-981b-8cbedfc80d3e' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJjNVhsMzJUckQxTHlINzVuWnpFbEJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdlYWFlY2M0LTkzNzgtNGEwOS05OTRiLWU3NjllOGY5MjZmMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE0OCwiZXhwIjoxNTk5Nzc0NzQ4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImQ0ZDQ5ODVhLTdmZTctNDU0ZS05MWI2LWM5NGVjNTY3ZWNhMFwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE0OH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.rV9UH_iYhAZmXyERc-kJ0uE5yjAEn2bx-JwU222Hmq1pTodMBApJY8x4iDPdVeqrN813zFcTBFMO11VeNM905Kz3xlvEVsz1WrY8U7-8-IUPeVu_NCjriQcy05vVaIdKw7zy4gEt049MdtRfPsNV_v7mtHxrJ2qLQ_HCrTCEoeoLphSTc0V1ICH2jbom9j3LCiYZ0-4zsIht0xsa1hjfgRbsqkAVyb9UQhmwcrkar_7ZX2U9JvUjfV43ohHwJgPnpzd_e9-dCGvQ78j1IW4127_jwxq_zmniKqhmbUA_I0rQEtlXcEMGlSfRsFuiOZ-PoEz6nV21eoNB7vPVJd6AMg' \
    -d '{"name":"Test Service 1599771148","egressRouterId":"4e14c61e-b5e8-41bd-a8a4-605d9e17cdb1","endpoints":null,"attributes":["#service01"],"edgeRouterAttributes":["#accessrouterseast","#accessrouterswest"],"clientHostName":"newclient.com","clientPortRange":"443","serverHostName":"newserver.com","serverPortRange":"443","serverProtocol":"UDP"}'

Example response

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

{
  "name" : "Test Service 1599771148",
  "id" : "f4372a6f-771f-42e5-981b-8cbedfc80d3e",
  "attributes" : [ "#service01" ],
  "updatedAt" : "2020-09-10T20:52:28.536Z",
  "networkId" : "fdb4dcf8-262e-4618-b9ee-2a748702cf64",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:28.518Z",
  "endpoints" : [ ],
  "egressRouterId" : "4e14c61e-b5e8-41bd-a8a4-605d9e17cdb1",
  "edgeRouterAttributes" : [ "#accessrouterswest", "#accessrouterseast" ],
  "clientHostName" : "newclient.com",
  "clientPortRange" : "443",
  "serverHostName" : "newserver.com",
  "serverPortRange" : "443",
  "serverProtocol" : "UDP",
  "ownerIdentityId" : null,
  "createdBy" : null,
  "deletedBy" : null,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/networks/fdb4dcf8-262e-4618-b9ee-2a748702cf64"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/services/f4372a6f-771f-42e5-981b-8cbedfc80d3e"
    }
  }
}

Delete Service

DELETE /services/{id}

Authorization

This endpoint requires delete action on the service resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/services/c5b523f0-7a65-423c-b7cc-a56346de9e44' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ4aTFhSjdiY2xhSXFyUWN4TjJ3NElRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImVhZjZiYWQ3LTgxOGItNGIyNi05MDM3LTU5MmJjNzE5MTExOSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE0OSwiZXhwIjoxNTk5Nzc0NzQ5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjIwYjFjMDFjLTIzZDYtNGYzOS1hMWQ4LTU0MTcxM2E1MWNhMlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE0OX1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.LaBpeQeb9aoA9EZTadgRSZVqGu5296nqjtqRKD2ItcGGJrsvAvG5nHxW6puVmdAS5fEQi78S1t2bRiprP3uw1PK9LqzpKVKAsYZSldWBKRBzLVlnPKdfLlFGvNMPGG7mG9Q7pPnsgRAMOUiJs9_FdRKQhVHaKjjSZuOebFGj7zQOdbk7-h0AGYrxzbicCRfGDsoRS7R09541VUqnuULl1zdR6roOA8IaNRtyxdEyVrKnJOVfFw7U1pUB8yP_nOz7YI5Bvyp7icEMSpwKqZXRpygn5ceEDjI2thEaBfqOxojRPkCLJ1VxVXyhsv1H0KTt4wcDKMP6PlfKeMGocOYrjQ'

Example response

HTTP/1.1 200 OK

App Wans

Find App Wans

GET /app-wans

Authorization

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

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

name

String

false

id

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

true

serviceAttributes

Array[String]

true

Path Optional Description

self

false

network

false

Embedded resources

Path Type Optional Description

name

String

false

id

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

true

serviceAttributes

Array[String]

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhTURFa2lES1BPdGJ6TTNOa09aeWJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ2ZDVlNTAzLTgxOWEtNDdmMC05MmZlLTdlNmZhMTU3MjA4NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3NiwiZXhwIjoxNTk5Nzc0Nzc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImJlNWY3YTBlLWNkNzItNDRmZC1hOGY0LWRhMzE0OTJiMDkwNlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.ecacBVpeHvDJ5nKYooR2htGyKF2PxmS7myXSKupPd70KXzE8RkFixcX1x15vJYoT3bBEcXP7blJG50Q9DOVAx-UdrRLBAL9zQ9hnp1Djnd7QPzpFc_NyeQvDbMqs_SkB_6s3c5koH-XowqW7J2OKI-TXxExr_SgnJK52XmjOk38ldizvjSop3fQqcGJ_Ra0oAwmcNtgvjNxlZow01ajmhdWXEHLL55MbIJRY7NlW5Qu2XJ7BJkqO4Zx_rUfYCFKjTj6fgEv_u2i6AN6bro-QfpMICflOyOFG-kCR46lqARGaJ6HMUpnqcTnOEFKSH0B4jtnTWfiwE147eupebaVmvQ'

Example response

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

{
  "_embedded" : {
    "appWanList" : [ {
      "name" : "ACME App Wan 2020-09-10T20:52:56.276Z",
      "id" : "c3132763-176f-48a9-9e0b-8fc7a3e5ed81",
      "updatedAt" : "2020-09-10T20:52:56.276Z",
      "networkId" : "90039e1c-13b6-4c7e-9434-5abcb92b7f3a",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:56.276Z",
      "ownerIdentityId" : "d9dab561-6c02-4ea1-973d-69f1405be146",
      "createdBy" : "d9dab561-6c02-4ea1-973d-69f1405be146",
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "serviceAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/90039e1c-13b6-4c7e-9434-5abcb92b7f3a"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/c3132763-176f-48a9-9e0b-8fc7a3e5ed81"
        }
      }
    }, {
      "name" : "Updated App Wan name",
      "id" : "53b6901f-012f-4ac5-82f0-9f998164f020",
      "updatedAt" : "2020-09-10T20:52:56.338Z",
      "networkId" : "6be16922-00fd-4f01-b951-a678ffd63b52",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:56.331Z",
      "ownerIdentityId" : "0b265d07-3404-431d-b246-169a948da341",
      "createdBy" : "0b265d07-3404-431d-b246-169a948da341",
      "deletedBy" : null,
      "endpointAttributes" : [ "#usendpoints" ],
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6be16922-00fd-4f01-b951-a678ffd63b52"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/53b6901f-012f-4ac5-82f0-9f998164f020"
        }
      }
    }, {
      "name" : "ACME App Wan 2020-09-10T20:52:56.386Z",
      "id" : "7d9c18d4-1d6e-472c-8782-ab048d9edc24",
      "updatedAt" : "2020-09-10T20:52:56.386Z",
      "networkId" : "25d2af5f-2551-421f-8c33-5981ef0f2b61",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:56.386Z",
      "ownerIdentityId" : "43b84271-195f-4ac6-b977-738fb28f87d9",
      "createdBy" : "43b84271-195f-4ac6-b977-738fb28f87d9",
      "deletedBy" : null,
      "endpointAttributes" : [ "#usendpoints" ],
      "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/25d2af5f-2551-421f-8c33-5981ef0f2b61"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/7d9c18d4-1d6e-472c-8782-ab048d9edc24"
        }
      }
    }, {
      "name" : "ACME App Wan 2020-09-10T20:52:56.428Z",
      "id" : "c1830254-b7a3-460d-a2c0-20edc525bcce",
      "updatedAt" : "2020-09-10T20:52:56.429Z",
      "networkId" : "21798879-1ffc-4d81-9146-005a70015bd4",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:56.429Z",
      "ownerIdentityId" : "7008a5c3-7065-4385-bca9-b58b03c1891f",
      "createdBy" : "7008a5c3-7065-4385-bca9-b58b03c1891f",
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "serviceAttributes" : [ ],
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/21798879-1ffc-4d81-9146-005a70015bd4"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/c1830254-b7a3-460d-a2c0-20edc525bcce"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans"
    }
  },
  "page" : {
    "size" : 2000,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

Get App Wan

GET /app-wans/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

name

String

false

id

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

true

serviceAttributes

Array[String]

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/56d193fc-20a8-45dd-9ae2-7f9637046818' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzbUZXM0NoMThTbUhfcnlDMTFLb3NRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc5ZWM5MTMzLTZkMjMtNDhjYy05Yjc3LTAwOGQzZGE5NGQ1YiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3NiwiZXhwIjoxNTk5Nzc0Nzc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjk5MTk4OTRjLTk4NjEtNGNhYy1iY2NiLTdmOTQ3N2I2M2M4M1wiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Nr0lzyrk8Jr9PqxVO3TOqVdZ9oIlDUxsbrcWUMTzunMCZOdu3JaF1B_DWd5HN9cuPOdsXWqaKn5ImxZosMhfrl_X8Dkog_SrjpCGpZAJrNWr0NVEQrcb4eNQjKQiKzzrr0oQtrN05PnuoMg0Bi4Od8xn360StSSo4PlEOmiMYUd4L3N98j0eZAIfcxmvozi9Saim-Rsd0CAq7TpNJ_6C1iMqbm8yevp45Iltot9uu0GSt6uzp-EQ2rXNoXhxvCeUin2Yr6xEbF3BKVlcwkdKuPaU-TjzR1nbqJgpyyxKkeNsMiXv81heuBH0gtzEVbZgJ0IWTuX0SBwGSMHji749-Q'

Example response

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

{
  "name" : "ACME App Wan 2020-09-10T20:52:56.482Z",
  "id" : "56d193fc-20a8-45dd-9ae2-7f9637046818",
  "updatedAt" : "2020-09-10T20:52:56.482Z",
  "networkId" : "ef2ac526-3df5-413e-a3cd-fc149c62df50",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:56.482Z",
  "ownerIdentityId" : "3b458aef-9ade-4602-b14e-d77cd4a5a144",
  "createdBy" : "3b458aef-9ade-4602-b14e-d77cd4a5a144",
  "deletedBy" : null,
  "endpointAttributes" : [ ],
  "serviceAttributes" : [ ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/ef2ac526-3df5-413e-a3cd-fc149c62df50"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/56d193fc-20a8-45dd-9ae2-7f9637046818"
    }
  }
}

Create App Wan

POST /app-wans

Authorization

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

Client must have create action under the annotated resource.

name

String

true

endpointAttributes

Array[String]

true

serviceAttributes

Array[String]

true

Response fields

Path Type Optional Description

name

String

false

id

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

true

serviceAttributes

Array[String]

true

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.eyJqdGkiOiI4N3hYNnhya3VraWUzb2l3cjE3WFZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE0ZjYyZjNjLTI1ZWItNGNmMC1iMmMxLThmNjc1ODMwNjNmNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3NiwiZXhwIjoxNTk5Nzc0Nzc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjNmZmVmZjQ5LWRhMTQtNGEwYS1iNDEzLTVlMDE0YTI1NDIyYlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.K3nbv8A_KAhiX0T96xYbMgHv2MXsH6eB5DyJJ8ALinC_CgPvDHTbXt1S__mG6O9NrFJ5CMol8HD-_Iwq2MD7qNtZkPt0iqPMOVqqnNwE_zR7ZoM1f2q4qOo12PYiWrMuQUlUktCn3upk-_p5AkJbXFdBCAAzZ5wej6G8gAIopzAwzgxfuu_grh3IYLdVZ8pXaEsG3WJUagY3jmuTL4Wl7Ec3eWAeJC_WEIIHysHNKpDbx_sQRUmLa2nZDDawj1-tz_hzEctzoSzJDf8VgE8TJ03e7O4U58vNPQL242_yfreGaoiV35wNy-ZacecxAVI7dVu9qj8VwbQeYkn-tgJaMQ' \
    -d '{"networkId":"bdeb754a-2db7-4c41-8aa9-447dbb181029","name":"Test App Wan 1599771176","endpointAttributes":["#accessclients","@Test_endpoint2020-09-10T20:52:56.596Z"],"serviceAttributes":["#service01","@ACME_Service01_2020-09-10T20:52:56.598Z"]}'

Example response

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

{
  "name" : "Test App Wan 1599771176",
  "id" : "4b62f313-6284-44cc-ac7a-5cd18dc0d7b5",
  "updatedAt" : "2020-09-10T20:52:56.618Z",
  "networkId" : "bdeb754a-2db7-4c41-8aa9-447dbb181029",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:56.615Z",
  "ownerIdentityId" : "a4f62f3c-25eb-4cf0-b2c1-8f67583063f5",
  "createdBy" : "a4f62f3c-25eb-4cf0-b2c1-8f67583063f5",
  "deletedBy" : null,
  "endpointAttributes" : [ "#accessclients", "@Test_endpoint2020-09-10T20:52:56.596Z" ],
  "serviceAttributes" : [ "@ACME_Service01_2020-09-10T20:52:56.598Z", "#service01" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/bdeb754a-2db7-4c41-8aa9-447dbb181029"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/4b62f313-6284-44cc-ac7a-5cd18dc0d7b5"
    }
  }
}

Update App Wan

PUT /app-wans/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

networkId

String

true

endpointAttributes

Array[String]

true

serviceAttributes

Array[String]

true

Response fields

Path Type Optional Description

name

String

false

id

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

true

serviceAttributes

Array[String]

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/53b6901f-012f-4ac5-82f0-9f998164f020' -i -X PUT \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJFb0xuX0FFaVNlR2Y0ZmxPOGFhZnBnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA3ODYxYzVlLWJmN2EtNDNlNy1iY2E1LTEyOTUyMmMyYjhlNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3NiwiZXhwIjoxNTk5Nzc0Nzc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjRjMzYzNjJmLTllNDQtNDlkOC1hNmE3LTNkNTBjMDQyYTU4MlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.MlEe5Tk0MVqvFLae2uycremT4iKI2Z3uhuWNJvedKUcIxql2GvlzTxqPF9EBuiYx14jo4EVH_sRHoD_lXJYUcYo2ak81t8jWM5wOf6LvGZ_u_ve8n7vwhVsOF6WMFKH_mhaveZaKBgXoGBWL4PuiCOBpPzqILwSxLKwKsV9sorYpJqO-1amVh9xk6RuuIjeKIO_d9GDto-oyldsZgKg85mZshqgG10c7xFVMfJLMGKE1JSMyk3zQhDMTbRQtO86QwsxKa-xOjvTbfN-OSn3cUBNEq_ISse5ANNnyLW7UI6cLkYKMkvNYR7ctxe1QnTujh-qhNytN3zjraAIFe4repg' \
    -d '{"name":"Updated App Wan name","networkId":"6be16922-00fd-4f01-b951-a678ffd63b52","endpointAttributes":["#usendpoints"],"serviceAttributes":["#service02","#service03","#service01"]}'

Example response

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

{
  "name" : "Updated App Wan name",
  "id" : "53b6901f-012f-4ac5-82f0-9f998164f020",
  "updatedAt" : "2020-09-10T20:52:56.338Z",
  "networkId" : "6be16922-00fd-4f01-b951-a678ffd63b52",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:56.331Z",
  "ownerIdentityId" : "0b265d07-3404-431d-b246-169a948da341",
  "createdBy" : "0b265d07-3404-431d-b246-169a948da341",
  "deletedBy" : null,
  "endpointAttributes" : [ "#usendpoints" ],
  "serviceAttributes" : [ "#service03", "#service02", "#service01" ],
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6be16922-00fd-4f01-b951-a678ffd63b52"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/app-wans/53b6901f-012f-4ac5-82f0-9f998164f020"
    }
  }
}

Delete App Wan

DELETE /app-wans/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/app-wans/fe6604e7-d34d-4685-9c0b-0c995f5494d5' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJQRzNrcFphNEM2c3R2bGdZQktSdHJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ4ZTJlMjc2LTJhZjgtNGFlZC1hZmVhLTJmZWZhMjk4N2Q0NyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE3NiwiZXhwIjoxNTk5Nzc0Nzc2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcImVlN2JjYWIyLThkZjgtNDBlMS05NTFmLWRkZTYxNmMwNmI4M1wiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE3Nn1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.mOI0yY2DW6fYHWPow3nbMOj8OnLDRR4VMpE4uKHS1un7sDhem6FIlggw_S5qf9UgtWl-gfUG33VlOwLqVwDlUXb4QI1uoBfOzk25zLvXMk_9_reTAAAu_2gowlVL22S1AfOHxwos5UMZwgr3hKErm0HsvFKtZVHLk2o53eFoupdWL0YmUPRc6A2q1wjm79I3iUpkepbJrHFrc5P0fVLgx-NjBJFr9qXhe05mIZVTYhUcL3j2GiBfwWujWS5KoiPZFJ7ikx8yetIFv4pU_Okx8B_mN3obmAt2PC2bDzGtQNJ0GWLgmtHlDCNyfHvX810isq6eg4mjZbA4FuGRzQbLLw'

Example response

HTTP/1.1 200 OK

Certificate Authorities

Find Certificate Authoritys

GET /certificate-authorities

Authorization

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

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

networkId

Object

true

Request fields

No request body.

Response fields

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

Path Type Optional Description

fingerprint

String

true

name

String

false

id

String

true

verificationToken

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

false

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

Boolean

true

authEnabled

Boolean

true

Path Optional Description

self

false

network

false

Embedded resources

Path Type Optional Description

fingerprint

String

true

name

String

false

id

String

true

verificationToken

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

false

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

Boolean

true

authEnabled

Boolean

true

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJYcFdIYUd3eFU0S0FzTWhZemhSRG5BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU4Njg4MTY5LWU2MTUtNGY1Yi1hOWVlLTE5YzVjNGFmMWI5MCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE2NCwiZXhwIjoxNTk5Nzc0NzY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjIzM2E1NzNjLTk4MzYtNDg0ZC1hMzk0LTc3MjE0ZjA0Nzc1YlwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.Epxx-R5QVvnT1q3EinkJZ1xB8fXhJL9ypxKC4tRCmL6lrNZPubaF3Okl6c2sx0qLvGv9EKpBYcrd7KY-BBMoU_klV_G5RXOMATbvZQpCRaYCwVFQz2pxlfH4Da3iJ2pFbTEvpBPShTs-m3iHg5TpKjNaNPtxKe6smRdPUIBxSOSfJUAN5-lV_N5QSLZmAyoLuwa--wRx9Nqkemy20n93B1blh9kLqesleuQeKa9W4oyAQ1EYnw3Qye3nbr6YoAEYxOgEnYo9ACcZoCXxFt1-NJLFmYzSEfk1VLvxL04UayDbbHs1OD-7etBfa_iieWCHsZ9gmoV7Qv8HHMdPIftU9w'

Example response

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

{
  "_embedded" : {
    "certificateAuthorityList" : [ {
      "fingerprint" : null,
      "name" : "ACME CA 2020-09-10T20:52:44.270Z",
      "id" : "0cc60020-af29-4107-9023-0fb549b3575d",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.270Z",
      "networkId" : "28958b25-2726-4048-9fff-8de9012121ed",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.270Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/28958b25-2726-4048-9fff-8de9012121ed"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/0cc60020-af29-4107-9023-0fb549b3575d"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "ACME CA NO 2020-09-10T20:52:44.270Z",
      "id" : "7560b45a-89fd-40b9-9c74-f1d9184c2508",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.271Z",
      "networkId" : "28958b25-2726-4048-9fff-8de9012121ed",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.271Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/28958b25-2726-4048-9fff-8de9012121ed"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/7560b45a-89fd-40b9-9c74-f1d9184c2508"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "ACME CA 2020-09-10T20:52:44.284Z",
      "id" : "0ed77208-f7d5-4c28-a247-8d437201e354",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.284Z",
      "networkId" : "6df3d754-d520-4dfc-8439-737f55bb250f",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.284Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6df3d754-d520-4dfc-8439-737f55bb250f"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/0ed77208-f7d5-4c28-a247-8d437201e354"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "ACME CA NO 2020-09-10T20:52:44.284Z",
      "id" : "354cd1e8-7489-4de4-8749-793d5a5a7c40",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.284Z",
      "networkId" : "6df3d754-d520-4dfc-8439-737f55bb250f",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.284Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6df3d754-d520-4dfc-8439-737f55bb250f"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/354cd1e8-7489-4de4-8749-793d5a5a7c40"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "Test ca 02",
      "id" : "892f2e0a-bd1a-4247-aaaa-fe0afa792b56",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.337Z",
      "networkId" : "6df3d754-d520-4dfc-8439-737f55bb250f",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.335Z",
      "jwt" : null,
      "ownerIdentityId" : "cafeab1e-923f-43bb-a618-9a6ef27eb90c",
      "createdBy" : "cafeab1e-923f-43bb-a618-9a6ef27eb90c",
      "deletedBy" : null,
      "endpointAttributes" : [ "#secureclients" ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6df3d754-d520-4dfc-8439-737f55bb250f"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/892f2e0a-bd1a-4247-aaaa-fe0afa792b56"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "Test ca 02 updated",
      "id" : "9e9ec386-698e-453d-9ddf-a0a590d87aca",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.413Z",
      "networkId" : "a04bd488-1112-4396-83e2-a28868ae37b3",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.393Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a04bd488-1112-4396-83e2-a28868ae37b3"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/9e9ec386-698e-453d-9ddf-a0a590d87aca"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "ACME CA NO 2020-09-10T20:52:44.393Z",
      "id" : "f1927b91-3c33-4f84-be9b-ed8755b30d36",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.393Z",
      "networkId" : "a04bd488-1112-4396-83e2-a28868ae37b3",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.393Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a04bd488-1112-4396-83e2-a28868ae37b3"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/f1927b91-3c33-4f84-be9b-ed8755b30d36"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "ACME CA 2020-09-10T20:52:44.449Z",
      "id" : "4324e182-b7d7-442e-bbb4-a24eb882539b",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.449Z",
      "networkId" : "b9555579-6576-4771-b749-ea57e0364d8a",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.449Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b9555579-6576-4771-b749-ea57e0364d8a"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/4324e182-b7d7-442e-bbb4-a24eb882539b"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "ACME CA NO 2020-09-10T20:52:44.449Z",
      "id" : "c8058895-84c1-43b6-b338-89cb1b37645a",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.449Z",
      "networkId" : "b9555579-6576-4771-b749-ea57e0364d8a",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.449Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b9555579-6576-4771-b749-ea57e0364d8a"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/c8058895-84c1-43b6-b338-89cb1b37645a"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "ACME CA 2020-09-10T20:52:44.495Z",
      "id" : "d9036554-85fb-4097-9309-e1a6138f8fa7",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.496Z",
      "networkId" : "a862e673-5253-4839-bc1a-fb137000e7ca",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.496Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a862e673-5253-4839-bc1a-fb137000e7ca"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/d9036554-85fb-4097-9309-e1a6138f8fa7"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "ACME CA 2020-09-10T20:52:44.535Z",
      "id" : "929d963e-6658-4ad3-bc0d-9cd1844c7087",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.536Z",
      "networkId" : "79836e19-01c9-4c66-b668-f2d161bae389",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.536Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/79836e19-01c9-4c66-b668-f2d161bae389"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/929d963e-6658-4ad3-bc0d-9cd1844c7087"
        }
      }
    }, {
      "fingerprint" : null,
      "name" : "ACME CA NO 2020-09-10T20:52:44.536Z",
      "id" : "c0c538b4-7d7d-4336-a15b-a83b94dd04a4",
      "verificationToken" : null,
      "updatedAt" : "2020-09-10T20:52:44.536Z",
      "networkId" : "79836e19-01c9-4c66-b668-f2d161bae389",
      "deletedAt" : null,
      "createdAt" : "2020-09-10T20:52:44.536Z",
      "jwt" : null,
      "ownerIdentityId" : null,
      "createdBy" : null,
      "deletedBy" : null,
      "endpointAttributes" : [ ],
      "autoCaEnrollmentEnabled" : false,
      "ottCaEnrollmentEnabled" : false,
      "verified" : false,
      "authEnabled" : false,
      "_links" : {
        "network" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/networks/79836e19-01c9-4c66-b668-f2d161bae389"
        },
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/c0c538b4-7d7d-4336-a15b-a83b94dd04a4"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities"
    }
  },
  "page" : {
    "size" : 2000,
    "totalElements" : 12,
    "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 must have read action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

fingerprint

String

true

name

String

false

id

String

true

verificationToken

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

false

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

Boolean

true

authEnabled

Boolean

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/486bffda-8450-411b-be35-3e4ab86b96c1' -i -X GET \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ2S3cxX21uWm1falhTcFhEd1Q5M3RRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBmOWJlODUyLTRiMTctNDgzNS05NzMxLWExNTlkZDY3ZjVjMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE2NCwiZXhwIjoxNTk5Nzc0NzY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjVhOTkwM2IwLTNjMGQtNDZkOS1iZTRlLTI5YzA3NDZlMWY2Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.j--OmzFZypaRCfFu4gnTup4ZRcyt9uF3wvE942VatC67FKhl6YUaEl6XvrzkSlSeD2cFVPu3yfpQAllg1c-Ldi3VVr_D0XaR6ruHxVJ6ULwkrpXOnVtQoey7hXlojdOOpz6ZSyescaXm3bAC_cAMhcmGimuuTEaCsHhVD2gk0EwTxM-YVd8tR2D1Xg9XoNR3ZvNMAHQ-A-Ofg4NpnhULucW-oEfBPsEcPX-LShufnx32UefD1YzW-HEqoWwTnCfgWKKl1FL4hctk6Z_WJfh0UU1WqK0re48u6vFyOCW7WbrNKFAox9ANUtQ5MeIanXJX1v1xTmomod2PYfMaxkvEGg'

Example response

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

{
  "fingerprint" : null,
  "name" : "ACME CA 2020-09-10T20:52:44.597Z",
  "id" : "486bffda-8450-411b-be35-3e4ab86b96c1",
  "verificationToken" : null,
  "updatedAt" : "2020-09-10T20:52:44.598Z",
  "networkId" : "49e85bce-a83a-4349-8a91-43ad87aef8d9",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:44.598Z",
  "jwt" : null,
  "ownerIdentityId" : null,
  "createdBy" : null,
  "deletedBy" : null,
  "endpointAttributes" : [ ],
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "verified" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/49e85bce-a83a-4349-8a91-43ad87aef8d9"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/486bffda-8450-411b-be35-3e4ab86b96c1"
    }
  }
}

Create Certificate Authority

POST /certificate-authorities

Authorization

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

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

networkId

String

true

Client must have create action under the annotated resource.

name

String

true

autoCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

certPem

String

true

endpointAttributes

Array[String]

true

Response fields

Path Type Optional Description

fingerprint

String

true

name

String

false

id

String

true

verificationToken

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

false

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

Boolean

true

authEnabled

Boolean

true

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.eyJqdGkiOiJwb3A0NUloQ2JpUGIxU0xITkJ1ZUR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImNhZmVhYjFlLTkyM2YtNDNiYi1hNjE4LTlhNmVmMjdlYjkwYyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE2NCwiZXhwIjoxNTk5Nzc0NzY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjM4ODUwNTIwLWIwYjYtNGE1ZC1hMjU5LTg4YjQ2OWQxYmJkZFwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.jhvlQSEx3K_pvs9EKJiF0LItH2Pq9OzaR9ZoHhXtHYgSuJLA9x3Qj7qhR0OZP7-gbtffE7uB2O5dq-jQI3e_VixlKMw8_ITrKBZuHAPDlIIMUvA54moBpaZftvn4m3JFN8gCgrWMSBHHXyb8946ZqSZeVK5ilr1l1765YA-2GtwYiNT35kEZkVA1YfRh9D_ty6gS3Rak3a1OrRh7lbKatU35Aq1z-bhSsP5pkCmHVyIS2FR4IrOsqLnHRQDiAVSfsv4LUZ5cMEC17KoNLd4S6J8tGzHf4FtbJn9wQBLXld6xwFuutJGawUlton7MiQKF61J9o2kEPtNvVqLh4r7DJg' \
    -d '{"networkId":"6df3d754-d520-4dfc-8439-737f55bb250f","name":"Test ca 02","autoCaEnrollmentEnabled":true,"authEnabled":false,"ottCaEnrollmentEnabled":false,"certPem":"fakepemdata","endpointAttributes":["#secureclients"]}'

Example response

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

{
  "fingerprint" : null,
  "name" : "Test ca 02",
  "id" : "892f2e0a-bd1a-4247-aaaa-fe0afa792b56",
  "verificationToken" : null,
  "updatedAt" : "2020-09-10T20:52:44.337Z",
  "networkId" : "6df3d754-d520-4dfc-8439-737f55bb250f",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:44.335Z",
  "jwt" : null,
  "ownerIdentityId" : "cafeab1e-923f-43bb-a618-9a6ef27eb90c",
  "createdBy" : "cafeab1e-923f-43bb-a618-9a6ef27eb90c",
  "deletedBy" : null,
  "endpointAttributes" : [ "#secureclients" ],
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "verified" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/6df3d754-d520-4dfc-8439-737f55bb250f"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/892f2e0a-bd1a-4247-aaaa-fe0afa792b56"
    }
  }
}

Verify Certificate Authority

POST /certificate-authorities/{id}/verify

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

fingerprint

String

true

name

String

false

id

String

true

verificationToken

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

false

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

Boolean

true

authEnabled

Boolean

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/4324e182-b7d7-442e-bbb4-a24eb882539b/verify' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiItUm8zdEJNcXc1c2YwSkxXVDFjbEVRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEzYWFmYjI5LWI3MzUtNDMwZC04NzY3LTUwYjVkYzQyYTRkMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE2NCwiZXhwIjoxNTk5Nzc0NzY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjg1Y2UzMTIxLTRhNmYtNGQ4NC04MTAyLTM2YmNkYWM0NzJiZVwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.WPAIr4YM5KQVBSt3yKq3nKUSkD75fY7D-89-ynBga7_B2UrTrsxvITZAgJF4iGVfLvQ_31u2NcBqMECQ7Gx4hFskTN-eGOwt3VvJdTIa_O3E67pAP1IwmQtavHovC6QKmG7bNSkJcQGcAeq09a-zYzScLN5tbRO6b5qWgC2zhNEBnx8x033P0Q3mZ_atwf9CRdrV5y4NAkyeMRkDmfvjbw3yzOx5taFgSXO8itgwS8HHiaaiIkg2_CzLhC9UuXiyM23AMJJW-MAG7Pv1IC6ibxJyY7g9qtQevPnNXZ9Mb_O0YDZRGL0KdXxobbVq7qKASVtmgyjAIP-GRlVDXbIy2A' \
    -d '<testcertverificationbody>'

Example response

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

{
  "fingerprint" : null,
  "name" : "ACME CA 2020-09-10T20:52:44.449Z",
  "id" : "4324e182-b7d7-442e-bbb4-a24eb882539b",
  "verificationToken" : null,
  "updatedAt" : "2020-09-10T20:52:44.449Z",
  "networkId" : "b9555579-6576-4771-b749-ea57e0364d8a",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:44.449Z",
  "jwt" : null,
  "ownerIdentityId" : null,
  "createdBy" : null,
  "deletedBy" : null,
  "endpointAttributes" : [ ],
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "verified" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/b9555579-6576-4771-b749-ea57e0364d8a"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/4324e182-b7d7-442e-bbb4-a24eb882539b"
    }
  }
}

Patch Certificate Authority

PATCH /certificate-authorities/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have update action on the annotated resource.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

autoCaEnrollmentEnabled

Boolean

true

authEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

endpointAttributes

Array[String]

true

Response fields

Path Type Optional Description

fingerprint

String

true

name

String

false

id

String

true

verificationToken

String

true

updatedAt

String

true

networkId

String

false

deletedAt

String

true

createdAt

String

true

jwt

String

true

ownerIdentityId

String

true

createdBy

String

true

deletedBy

String

true

endpointAttributes

Array[String]

false

autoCaEnrollmentEnabled

Boolean

true

ottCaEnrollmentEnabled

Boolean

true

verified

Boolean

true

authEnabled

Boolean

true

Path Optional Description

self

false

network

false

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/9e9ec386-698e-453d-9ddf-a0a590d87aca' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJPVXhJbk9qSXQ0aFo3N2RTQ1Y0M2JnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBhMzI5M2YzLWRkOGYtNDg3Zi05NTRmLWUzMzQwNGU5ZmQ5MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE2NCwiZXhwIjoxNTk5Nzc0NzY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjgxYzA2ZTNhLWVlNjgtNGMyMi1hYmRkLTcyMzg1YmI4MGExZVwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.H92m2rneWseJSAF9hoPLv46exaCC3qRlyULQyX_sWtLxXvJLIpgXGPGa9jpfM-8EspkK3AN0mEUvEBtskrVdH_C3Fz6FqhhEz6D8Hgx1CWn0qSma_0l9ph8D1DfcZ5mLKywnVn8aT4Jl05W_RKewSR4YEgm-9j3h3r1EHBJgBmHNxoXn-tAMt3ouuJ0GIth56nW1U9xDc36tVho2YmKU7tBaT3vkchHaIJDzzkQnkja-Y1hkOIViMtL1hRnRxtzNhZocZT2tCcDY3ZtJPfq3RM06g9haoq1rn9lVRD7JKDZeuw7k8OFcI7_DzvaAedZu_fNaH8vtyt6hEC5VrspXsw' \
    -d '{"name":"Test ca 02 updated","autoCaEnrollmentEnabled":null,"authEnabled":null,"ottCaEnrollmentEnabled":null,"endpointAttributes":[]}'

Example response

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

{
  "fingerprint" : null,
  "name" : "Test ca 02 updated",
  "id" : "9e9ec386-698e-453d-9ddf-a0a590d87aca",
  "verificationToken" : null,
  "updatedAt" : "2020-09-10T20:52:44.413Z",
  "networkId" : "a04bd488-1112-4396-83e2-a28868ae37b3",
  "deletedAt" : null,
  "createdAt" : "2020-09-10T20:52:44.393Z",
  "jwt" : null,
  "ownerIdentityId" : null,
  "createdBy" : null,
  "deletedBy" : null,
  "endpointAttributes" : [ ],
  "autoCaEnrollmentEnabled" : false,
  "ottCaEnrollmentEnabled" : false,
  "verified" : false,
  "authEnabled" : false,
  "_links" : {
    "network" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/networks/a04bd488-1112-4396-83e2-a28868ae37b3"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/core/v2/certificate-authorities/9e9ec386-698e-453d-9ddf-a0a590d87aca"
    }
  }
}

Delete Certificate Authority

DELETE /certificate-authorities/{id}

Authorization

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

Path parameters

Parameter Type Optional Description

id

Object

false

Client must have delete action on the annotated resource.

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/core/v2/certificate-authorities/2767e6d5-2667-4a26-bd6f-49970c0a5eca' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJyN1c3WW50RFpXbHpMTlZPdE4zYTNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjBlYjM1NmRjLWRiNjctNDdlZC1hOWM0LWRjNWUwZGQyYjkzMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkubmV0d29yayIsImlhdCI6MTU5OTc3MTE2NCwiZXhwIjoxNTk5Nzc0NzY0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbXSIsImdyYW50cy1hY3Rpb24iOiJbe1wiaWRcIjpcIjJiMThhODBjLTNiZTItNDI0YS1hY2M0LWYyZTY1MTcxMjBhZFwiLFwibGFzdE1vZGlmaWVkXCI6MTU5OTc3MTE2NH1dIiwiZ3JhbnRzLXN0YW5kYXJkIjoiW10ifQ.deIl5rC1PnUdknPFoUtyTz47bYnAMecBv6PW1lvWFLzYbjH1J3vG4fMfNIDSxFqo7mpyplTuc9N7bJSAfGTdGysFiZ0SUYZftsXXdPbr92ehXE74nw_UOPlwYgt8Y0NAM3aeom_iDIVBOwpWwVl-Qi_aU40yVl5I6egLwfymKmDZyRwbiY40VERw185L1vy4MVEoQhB9gQN7MN1k727t7E-oHc4_G0LOX6bTJm-1xAdYznK-dTxy_8errQFxDPJ54S0zAiEBQxLw0EgdjR0rl-e6K-epE_XpL9Sa_UMoSh6cBHz7TK1xq4s9Qb6Y4FiKNQVYB6WRXRuk-Nn-l-Ifug'

Example response

HTTP/1.1 200 OK