Zrok Connector (1.0)

Download OpenAPI specification:Download

Zrok Connector API

Frontdoor

Management of Frontdoor resources.

Retrieves a single Frontdoor resource by Organization ID.

Retrieves the Frontdoor by the Organization ID it belongs to. The caller must have read permissions on the Frontdoor resource.

Authorizations:

bearerAuth

query Parameters

organizationId

required

string <uuid>

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc",
  "organizationId" : "8892fc6a-1e93-4ea1-b1eb-078b1e368eb1",
  "createdBy" : "ee462ce1-7cd8-4ed4-8584-ba8d51693ac6",
  "createdAt" : "2025-08-29T13:37:31.808765Z",
  "updatedBy" : "ee462ce1-7cd8-4ed4-8584-ba8d51693ac6",
  "updatedAt" : "2025-08-29T13:37:31.856815Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc"
    },
    "metrics" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/metrics"
    },
    "shares" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/shares{?envZId}",
      "templated" : true
    },
    "environments" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/environments"
    }
  }
}

Create Frontdoor

Creates a new Frontdoor resource. The caller must have create permissions on the Frontdoor resource. The response includes the created Frontdoor resource.

Authorizations:

bearerAuth

Request Body schema: application/json
required

organizationId

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

default

"{\"organizationId\":\"8892fc6a-1e93-4ea1-b1eb-078b1e368eb1\"}"

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc",
  "organizationId" : "8892fc6a-1e93-4ea1-b1eb-078b1e368eb1",
  "createdBy" : "ee462ce1-7cd8-4ed4-8584-ba8d51693ac6",
  "createdAt" : "2025-08-29T13:37:31.808765Z",
  "updatedBy" : "ee462ce1-7cd8-4ed4-8584-ba8d51693ac6",
  "updatedAt" : "2025-08-29T13:37:31.856815Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc"
    },
    "metrics" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/metrics"
    },
    "shares" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/shares{?envZId}",
      "templated" : true
    },
    "environments" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/environments"
    }
  }
}

Retrieves a single Frontdoor resource by ID.

Retrieves the Frontdoor by its ID. The caller must have read permissions on the Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc",
  "organizationId" : "8892fc6a-1e93-4ea1-b1eb-078b1e368eb1",
  "createdBy" : "ee462ce1-7cd8-4ed4-8584-ba8d51693ac6",
  "createdAt" : "2025-08-29T13:37:31.808765Z",
  "updatedBy" : "ee462ce1-7cd8-4ed4-8584-ba8d51693ac6",
  "updatedAt" : "2025-08-29T13:37:31.856815Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc"
    },
    "metrics" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/metrics"
    },
    "shares" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/shares{?envZId}",
      "templated" : true
    },
    "environments" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/environments"
    }
  }
}

Delete Frontdoor

Deletes a Frontdoor entity identified by its unique identifier. Deletes all resources tied to the Frontdoor instance. The caller must have delete permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc",
  "organizationId" : "8892fc6a-1e93-4ea1-b1eb-078b1e368eb1",
  "createdBy" : "ee462ce1-7cd8-4ed4-8584-ba8d51693ac6",
  "createdAt" : "2025-08-29T13:37:31.808765Z",
  "updatedBy" : "ee462ce1-7cd8-4ed4-8584-ba8d51693ac6",
  "updatedAt" : "2025-08-29T13:37:32.141130Z",
  "deletedBy" : "846caa25-d906-4807-aaa2-887172edbbaa",
  "deletedAt" : "2025-08-29T13:37:32.140347Z",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc"
    },
    "metrics" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/metrics"
    },
    "shares" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/shares{?envZId}",
      "templated" : true
    },
    "environments" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/environments"
    }
  }
}

Get metrics for single Frontdoor resource by ID.

Retrieves transmitted and received data for the user's Frontdoor. Optionally takes a duration parameter to filter the metrics based on time. An optional duration parameter can be provided to specify the time window for the metrics.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Id of the resource.

query Parameters

duration

string

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc",
  "scope" : "account",
  "id" : "9",
  "period" : "2592000",
  "samples" : [ {
    "rx" : 3821,
    "tx" : 513,
    "timestamp" : "2025-06-23T00:00:00.000+00:00"
  }, {
    "rx" : 3282,
    "tx" : 3053,
    "timestamp" : "2025-06-24T00:00:00.000+00:00"
  }, {
    "rx" : 821,
    "tx" : 302513,
    "timestamp" : "2025-06-25T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-26T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-27T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-28T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-29T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-30T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-01T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-02T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-03T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-04T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-05T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-06T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-07T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-08T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-09T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-10T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-11T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-12T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-13T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-14T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-15T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-16T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-17T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-18T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-19T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-20T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-21T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-22T00:00:00.000+00:00"
  }, {
    "rx" : 32821,
    "tx" : 30513,
    "timestamp" : "2025-07-22T15:56:40.161+00:00"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/metrics"
    },
    "shares" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/shares{?envZId}",
      "templated" : true
    },
    "environments" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc/environments"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/1b3fb20c-51f0-4888-aaa9-1d5d4a0926bc"
    }
  }
}

Auth Provider

Management of Auth Provider resources. Auth Providers are configured on Custom Frontend, they are then assigned to Shares.

Retrieves a single Auth Provider resource by ID.

Retrieves a single Auth Provider by its ID. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "zZOSfXA4kt9nUPz4qUZqi",
  "frontdoorId" : "9ab02ab4-159f-43b7-b6cd-d0cd2205a865",
  "name" : "AuthProvider-7",
  "type" : "OIDC",
  "createdBy" : "bdce414c-b149-4f1a-9375-818c048b7c87",
  "createdAt" : "2025-08-29T13:37:37.855904Z",
  "updatedBy" : "91d6ca44-7622-44a7-86a2-7d355c6d8202",
  "updatedAt" : "2025-08-29T13:37:37.860706Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "data" : {
    "clientId" : "Sz5NbVMRx0fnYxECwXyYp",
    "clientSecret" : "9g_u6CR1ZB0c-l4cBNEry",
    "scopes" : [ "openid", "email", "profile" ],
    "issuer" : "https://accounts.google.com/o/oauth2/v2/auth",
    "supportsPkce" : true
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9ab02ab4-159f-43b7-b6cd-d0cd2205a865/auth-providers/zZOSfXA4kt9nUPz4qUZqi"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9ab02ab4-159f-43b7-b6cd-d0cd2205a865"
    }
  }
}

Put Auth Provider

Performs a full update on an existing Auth Provider resource. All fields must be provided in the request body. The caller must have update permissions on the parent Frontdoor resource. The response includes the updated Auth Provider resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Request Body schema: application/json
required

name	string
type	string Enum: "OIDC" "GITHUB" "GOOGLE" Type of authentication provider
data required	any (JsonNode) Configuration data for the authentication provider

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"auth provider a\",\"type\":null,\"data\":null}"

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "je-v_6I4hREwX6hl3LlD-",
  "frontdoorId" : "180a19e0-b39b-4487-b9d5-43b5c17c0b5d",
  "name" : "auth provider a",
  "type" : "OIDC",
  "createdBy" : "d58c6f26-18a0-4b27-9203-4c83fb62a7b0",
  "createdAt" : "2025-08-29T13:37:37.703277Z",
  "updatedBy" : "36689013-656c-40a2-a45e-0433fc29190b",
  "updatedAt" : "2025-08-29T13:37:37.746980Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "data" : {
    "clientId" : "ukH77PPhqXxUMn0k2SUj2",
    "clientSecret" : "96nb5tLpUry-9ZkpYKmQ6",
    "scopes" : [ "openid", "email", "profile" ],
    "issuer" : "https://accounts.google.com/o/oauth2/v2/auth",
    "supportsPkce" : true
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/180a19e0-b39b-4487-b9d5-43b5c17c0b5d/auth-providers/je-v_6I4hREwX6hl3LlD-"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/180a19e0-b39b-4487-b9d5-43b5c17c0b5d"
    }
  }
}

Delete Auth Provider

Deletes a Auth Provider by its ID. This is a soft delete operation. The caller must have delete permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "nZI-abqcw1jnOugohrvZm",
  "frontdoorId" : "370d61f1-334b-4939-b737-07a90e966ede",
  "name" : "AuthProvider-8",
  "type" : "OIDC",
  "createdBy" : "60bbd266-26fa-440a-8b35-560e11ae06c9",
  "createdAt" : "2025-08-29T13:37:38.041824Z",
  "updatedBy" : "36804549-3529-4fa2-91b9-4b2a064f26d9",
  "updatedAt" : "2025-08-29T13:37:38.065141Z",
  "deletedBy" : "96dc84f5-80f5-4668-a426-07867dff57a2",
  "deletedAt" : "2025-08-29T13:37:38.065058Z",
  "data" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/370d61f1-334b-4939-b737-07a90e966ede/auth-providers/nZI-abqcw1jnOugohrvZm"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/370d61f1-334b-4939-b737-07a90e966ede"
    }
  }
}

Patch Auth Provider

Partially updates an existing Auth Provider resource. Only properties to be updated need to be provided in the request body. The caller must have update permissions on the parent Frontdoor resource. The response includes the updated Auth Provider resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Request Body schema: application/json
required

name	string
type	string Enum: "OIDC" "GITHUB" "GOOGLE" Type of authentication provider
data required	any (JsonNode) Configuration data for the authentication provider

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"auth provider a\",\"type\":null,\"data\":null}"

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "je-v_6I4hREwX6hl3LlD-",
  "frontdoorId" : "180a19e0-b39b-4487-b9d5-43b5c17c0b5d",
  "name" : "auth provider a",
  "type" : "OIDC",
  "createdBy" : "d58c6f26-18a0-4b27-9203-4c83fb62a7b0",
  "createdAt" : "2025-08-29T13:37:37.703277Z",
  "updatedBy" : "36689013-656c-40a2-a45e-0433fc29190b",
  "updatedAt" : "2025-08-29T13:37:37.746980Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "data" : {
    "clientId" : "ukH77PPhqXxUMn0k2SUj2",
    "clientSecret" : "96nb5tLpUry-9ZkpYKmQ6",
    "scopes" : [ "openid", "email", "profile" ],
    "issuer" : "https://accounts.google.com/o/oauth2/v2/auth",
    "supportsPkce" : true
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/180a19e0-b39b-4487-b9d5-43b5c17c0b5d/auth-providers/je-v_6I4hREwX6hl3LlD-"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/180a19e0-b39b-4487-b9d5-43b5c17c0b5d"
    }
  }
}

List Auth Providers

Retrieves a paginated list of Auth Provider resources in a specific Frontdoor. The results can be filtered by providing query parameters that correspond to the properties of an Auth Provider. For example, to filter by name, you can add ?name=my-check to the request URL. Multiple values for the same filter property are supported (e.g., ?name=check1&name=check2). Sorting and pagination are also supported. For instance, ?page=0&size=20&sort=name,asc will retrieve the first page of 20 auth providers, sorted by name in ascending order. The returned list is automatically constrained by the user's access permissions. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

query Parameters

id	string <uuid> Id to filter by, unique IDs of auth provider resources.
name	any Name to filter by.
schema	any The auth provider schema type, see Auth Provider Type resource
deletedAt	string <date-time> If deleted, filter by a range of timestamps. Defaults to to return only resources that are not deleted.
deletedBy	string <uuid> If deleted, filter by a user of the user. Defaults to to return only resources that are not deleted.
createdAt	string <date-time> Filter by a range of timestamps.
createdBy	string <uuid> Filter by a user of the user that created the resource.
updatedAt	string <date-time> Filter by a range of timestamps.
updatedBy	any Filter by a user of the user that last updated the resource.
page	any The page number.
size	any The number of resources returned per page.
sort	any The property to sort by, 'asc' and 'desc' can be appended after a comma

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"_embedded\" : {\n    \"authProviderList\" : [ {\n      \"id\" : \"FQkzr_2F4K-vbFbVfeX1t\",\n      \"frontdoorId\" : \"1edeb3f7-5cd4-49d9-94af-65238585d26f\",\n      \"name\" : \"AuthProvider-10\",\n      \"type\" : \"OIDC\",\n      \"createdBy\" : \"cca90d6e-4448-4509-ab21-6a7556ae3388\",\n      \"createdAt\" : \"2025-08-29T13:37:38.119931Z\",\n      \"updatedBy\" : \"56da5ef1-fc0f-4076-864c-a2ff33aab4fc\",\n      \"updatedAt\" : \"2025-08-29T13:37:38.122889Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"data\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/1edeb3f7-5cd4-49d9-94af-65238585d26f/auth-providers/FQkzr_2F4K-vbFbVfeX1t\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/1edeb3f7-5cd4-49d9-94af-65238585d26f\"\n        }\n      }\n    }, {\n      \"id\" : \"0s8btAJK9DIGx_aYl8Qan\",\n      \"frontdoorId\" : \"1edeb3f7-5cd4-49d9-94af-65238585d26f\",\n      \"name\" : \"AuthProvider-9\",\n      \"type\" : \"OIDC\",\n      \"createdBy\" : \"bf8c21fe-b34e-4f3a-9bc3-148aa42c06da\",\n      \"createdAt\" : \"2025-08-29T13:37:38.109878Z\",\n      \"updatedBy\" : \"7b4cf299-2256-4ca6-ae08-d4d963a53834\",\n      \"updatedAt\" : \"2025-08-29T13:37:38.115953Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"data\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/1edeb3f7-5cd4-49d9-94af-65238585d26f/auth-providers/0s8btAJK9DIGx_aYl8Qan\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/1edeb3f7-5cd4-49d9-94af-65238585d26f\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/1edeb3f7-5cd4-49d9-94af-65238585d26f/auth-providers\"\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/1edeb3f7-5cd4-49d9-94af-65238585d26f\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 20,\n    \"totalElements\" : 2,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Create Auth Provider

Creates a new Auth Provider for a Frontdoor. The caller must have create permissions on the parent Frontdoor resource. The response includes the created Auth Provider resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

Request Body schema: application/json
required

name	string Name of the authentication provider
type	string Type of the authentication provider
data required	any (JsonNode) Configuration data for the authentication provider

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"auth provider 1\",\"type\":\"GOOGLE\",\"data\":{\"clientId\":\"GQhNoN50ESnDE-9YdzIIH\",\"clientSecret\":\"YPX4tKGeV7GeG8ebMNFJS\"}}"

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "eqvzFWI_lE6pSxLa_HyOF",
  "frontdoorId" : "0bdd1fc8-2fbb-4c01-a69d-e9d3bd5ad561",
  "name" : "auth provider 1",
  "type" : "GOOGLE",
  "createdBy" : "7ad0d734-d9e9-4b75-a58a-75bcaa6b5dc7",
  "createdAt" : "2025-08-29T13:37:37.975175Z",
  "updatedBy" : "7ad0d734-d9e9-4b75-a58a-75bcaa6b5dc7",
  "updatedAt" : "2025-08-29T13:37:37.978415Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "data" : {
    "clientId" : "GQhNoN50ESnDE-9YdzIIH",
    "clientSecret" : "YPX4tKGeV7GeG8ebMNFJS"
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/0bdd1fc8-2fbb-4c01-a69d-e9d3bd5ad561/auth-providers/eqvzFWI_lE6pSxLa_HyOF"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/0bdd1fc8-2fbb-4c01-a69d-e9d3bd5ad561"
    }
  }
}

Custom Frontend

Management of Custom Frontend resources. Custom Frontends can't be updated. Also see Frontend.

Retrieves a single Custom Frontend resource by ID.

Retrieves a single Custom Frontend by its ID. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "xI801pot7WLa15-fl16cO",
  "frontdoorId" : "9125f8b1-446e-4942-b3fa-64f635701d07",
  "status" : "ONLINE",
  "domainName" : "8no0h-PmvwSKg7nTwpJpH.com",
  "authProviderIds" : [ ],
  "createdBy" : "7374be49-969c-4ce6-9cd4-db68603e1d51",
  "createdAt" : "2025-08-29T13:37:33.458310Z",
  "updatedBy" : "5062609c-27f2-4d29-b9d9-5ac7423bbcd9",
  "updatedAt" : "2025-08-29T13:37:33.474727Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/xI801pot7WLa15-fl16cO"
    },
    "dns-records" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/xI801pot7WLa15-fl16cO/dns-records"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07"
    }
  }
}

Update Custom Frontend

Updates a Custom Frontend in the specific Frontdoor. The domain of the Custom Frontend can't be updated, only the Auth Providers. Frontends are updated asynchronously because the orchestration can take a little while to update. The caller must have update permissions on the parent Frontdoor resource. The response includes the updated Custom Frontend resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Id of the Frontdoor resource.
id required	string

Request Body schema: application/json
required

authProviderIds

Array of strings unique

Responses

Request samples

Payload

Content type

application/json

default

"{\"authProviderIds\":[\"JyeBD0YgiSO3uB7KTcCAr\",\"bboo3BZKo3WgvMlgg5QnN\"]}"

Response samples

202
400
401
403
500

Content type

*/*

default

{
  "id" : "m_ClUtj3kTx85niyxH0OY",
  "frontdoorId" : "9125f8b1-446e-4942-b3fa-64f635701d07",
  "status" : "PENDING",
  "domainName" : "example.com",
  "authProviderIds" : [ "JyeBD0YgiSO3uB7KTcCAr", "bboo3BZKo3WgvMlgg5QnN" ],
  "createdBy" : "cbcda06d-bd4b-4fa1-9f00-03a35cf2cf1f",
  "createdAt" : "2025-08-29T13:37:32.683327Z",
  "updatedBy" : "5344baf2-704c-4976-9a9e-6fbc6473189d",
  "updatedAt" : "2025-08-29T13:37:32.780751Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/m_ClUtj3kTx85niyxH0OY"
    },
    "dns-records" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/m_ClUtj3kTx85niyxH0OY/dns-records"
    },
    "auth-providers" : {
      "href" : "/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/auth-providers?id=JyeBD0YgiSO3uB7KTcCAr,bboo3BZKo3WgvMlgg5QnN"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07"
    }
  }
}

Delete Custom Frontend

Deletes a Custom Frontend by its ID. Deleting a Custom Frontend is an asynchronous operation. The caller must have delete permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "cbG3DxP2pqp9sPEzAtkfB",
  "frontdoorId" : "9125f8b1-446e-4942-b3fa-64f635701d07",
  "status" : "DELETED",
  "domainName" : "example.com",
  "authProviderIds" : [ ],
  "createdBy" : "9171dc70-321a-40b1-bbcd-37e33d95c4f7",
  "createdAt" : "2025-08-29T13:37:33.280597Z",
  "updatedBy" : "2d2a03d6-5b67-4aca-b650-e85d0634e091",
  "updatedAt" : "2025-08-29T13:37:33.345516Z",
  "deletedBy" : "9cb1b350-aa42-4982-a223-9ee4e24e2aa2",
  "deletedAt" : "2025-08-29T13:37:33.345377Z",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/cbG3DxP2pqp9sPEzAtkfB"
    },
    "dns-records" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/cbG3DxP2pqp9sPEzAtkfB/dns-records"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07"
    }
  }
}

Update Custom Frontend

Updates a Custom Frontend in the specific Frontdoor. The domain of the Custom Frontend can't be updated, only the Auth Providers. Frontends are updated asynchronously because the orchestration can take a little while to update. The caller must have update permissions on the parent Frontdoor resource. The response includes the updated Custom Frontend resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Id of the Frontdoor resource.
id required	string

Request Body schema: application/json
required

authProviderIds

Array of strings unique

Responses

Request samples

Payload

Content type

application/json

default

"{\"authProviderIds\":[\"JyeBD0YgiSO3uB7KTcCAr\",\"bboo3BZKo3WgvMlgg5QnN\"]}"

Response samples

202
400
401
403
500

Content type

*/*

default

{
  "id" : "m_ClUtj3kTx85niyxH0OY",
  "frontdoorId" : "9125f8b1-446e-4942-b3fa-64f635701d07",
  "status" : "PENDING",
  "domainName" : "example.com",
  "authProviderIds" : [ "JyeBD0YgiSO3uB7KTcCAr", "bboo3BZKo3WgvMlgg5QnN" ],
  "createdBy" : "cbcda06d-bd4b-4fa1-9f00-03a35cf2cf1f",
  "createdAt" : "2025-08-29T13:37:32.683327Z",
  "updatedBy" : "5344baf2-704c-4976-9a9e-6fbc6473189d",
  "updatedAt" : "2025-08-29T13:37:32.780751Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/m_ClUtj3kTx85niyxH0OY"
    },
    "dns-records" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/m_ClUtj3kTx85niyxH0OY/dns-records"
    },
    "auth-providers" : {
      "href" : "/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/auth-providers?id=JyeBD0YgiSO3uB7KTcCAr,bboo3BZKo3WgvMlgg5QnN"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07"
    }
  }
}

List Custom Frontends

Retrieves a paginated list of Custom Frontend resources in a specific Frontdoor. The results can be filtered by providing query parameters that correspond to the properties of a Custom Frontend. For example, to filter by name, you can add ?name=my-check to the request URL. Multiple values for the same filter property are supported (e.g., ?name=check1&name=check2). Sorting and pagination are also supported. For instance, ?page=0&size=20&sort=name,asc will retrieve the first page of 20 custom frontends, sorted by name in ascending order. The returned list is automatically constrained by the user's access permissions. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

query Parameters

id	string <uuid> Id to filter by, unique IDs of custom frontend resources.
domainNames	any Domain Name to filter by.
status	any Status to filter by, see Status
deletedAt	string <date-time> If deleted, filter by a range of timestamps. Defaults to to return only resources that are not deleted.
deletedBy	string <uuid> If deleted, filter by a user of the user. Defaults to to return only resources that are not deleted.
createdAt	string <date-time> Filter by a range of timestamps.
createdBy	string <uuid> Filter by a user of the user that created the resource.
updatedAt	string <date-time> Filter by a range of timestamps.
updatedBy	any Filter by a user of the user that last updated the resource.
page	any The page number.
size	any The number of resources returned per page.
sort	any The property to sort by, 'asc' and 'desc' can be appended after a comma

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"_embedded\" : {\n    \"customFrontendList\" : [ {\n      \"id\" : \"61YaExAZMtrZdBn0zE2EF\",\n      \"frontdoorId\" : \"c996659a-39f0-4b0e-b422-dc23be3ec099\",\n      \"status\" : \"ONLINE\",\n      \"domainName\" : \"rUZ5Gj4ZHnqCV_n9CaZQ8.com\",\n      \"authProviderIds\" : [ \"WRoAtvuMSZNK5kFqe4cDp\" ],\n      \"createdBy\" : \"07d31579-8c8d-470a-9b47-3a59ffa63ad8\",\n      \"createdAt\" : \"2025-08-29T13:37:49.560893Z\",\n      \"updatedBy\" : \"a447e996-0d52-4432-adbe-a6bbe2db9aa1\",\n      \"updatedAt\" : \"2025-08-29T13:37:49.570554Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099/custom-frontends/61YaExAZMtrZdBn0zE2EF\"\n        },\n        \"dns-records\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099/custom-frontends/61YaExAZMtrZdBn0zE2EF/dns-records\"\n        },\n        \"auth-providers\" : {\n          \"href\" : \"/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099/auth-providers?id=WRoAtvuMSZNK5kFqe4cDp\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099\"\n        }\n      }\n    }, {\n      \"id\" : \"ASX_OhzjmTxtVcFqhgmyq\",\n      \"frontdoorId\" : \"c996659a-39f0-4b0e-b422-dc23be3ec099\",\n      \"status\" : \"ONLINE\",\n      \"domainName\" : \"eKjOVaZvG9d4BCg9pvfUC.com\",\n      \"authProviderIds\" : [ \"OzG29B5rzdC8hHwz3LzvV\" ],\n      \"createdBy\" : \"a43b5201-6beb-4af3-9845-97f8610e2ae6\",\n      \"createdAt\" : \"2025-08-29T13:37:49.539858Z\",\n      \"updatedBy\" : \"63b2eecf-1367-4514-a58a-70422d33106c\",\n      \"updatedAt\" : \"2025-08-29T13:37:49.556371Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099/custom-frontends/ASX_OhzjmTxtVcFqhgmyq\"\n        },\n        \"dns-records\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099/custom-frontends/ASX_OhzjmTxtVcFqhgmyq/dns-records\"\n        },\n        \"auth-providers\" : {\n          \"href\" : \"/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099/auth-providers?id=OzG29B5rzdC8hHwz3LzvV\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099\"\n        }\n      }\n    }, {\n      \"id\" : \"VkFik80l4BkRVB1-REK7f\",\n      \"frontdoorId\" : \"c996659a-39f0-4b0e-b422-dc23be3ec099\",\n      \"status\" : \"NEW\",\n      \"domainName\" : \"qPzB4rlU1312kVzsyD6uT.com\",\n      \"authProviderIds\" : [ ],\n      \"createdBy\" : \"4a2a396a-2e25-4331-b525-d022a9b3ef78\",\n      \"createdAt\" : \"2025-08-29T13:37:49.575946Z\",\n      \"updatedBy\" : \"4d53781b-c851-47ee-85ef-bd7b59650bd5\",\n      \"updatedAt\" : \"2025-08-29T13:37:49.583076Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099/custom-frontends/VkFik80l4BkRVB1-REK7f\"\n        },\n        \"dns-records\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099/custom-frontends/VkFik80l4BkRVB1-REK7f/dns-records\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099/custom-frontends\"\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c996659a-39f0-4b0e-b422-dc23be3ec099\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 20,\n    \"totalElements\" : 3,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Create Custom Frontend

Creates a new Custom Frontend for use in the specific Frontdoor. The user creates a Custom Frontends to use a custom domain to serve the Shares on. They are created asynchronously because the user needs to configure the DNS entry during the process and a certificate needs to be created.

The caller must have create permissions on the parent Frontdoor resource. The response includes the created Custom Frontend resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

Request Body schema: application/json
required

domainName required	string
authProviderIds	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

default

"{\"domainName\":\"fake.com\",\"authProviderIds\":null}"

Response samples

202
400
401
403
500

Content type

*/*

default

{
  "id" : "gqIYRtJW6-zRUthYIgwxf",
  "frontdoorId" : "9125f8b1-446e-4942-b3fa-64f635701d07",
  "status" : "NEW",
  "domainName" : "fake.com",
  "authProviderIds" : [ ],
  "createdBy" : "93912005-f225-46c0-9310-acaca8558076",
  "createdAt" : "2025-08-29T13:37:33.038292Z",
  "updatedBy" : "93912005-f225-46c0-9310-acaca8558076",
  "updatedAt" : "2025-08-29T13:37:33.038292Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/gqIYRtJW6-zRUthYIgwxf"
    },
    "dns-records" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/gqIYRtJW6-zRUthYIgwxf/dns-records"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07"
    }
  }
}

Retrieves the dns validation records for a single Custom Frontend resource by ID.

Retrieves the DNS records for a specified custom frontend within a given frontdoor context. For this operation to succeed, the status of the Custom Frontend needs to be PENDING, ONLINE, or ERROR or it will return an error. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "9125f8b1-446e-4942-b3fa-64f635701d07",
  "customFrontendId" : "hzFNFGTi5I4DUE-DM0p6j",
  "domainName" : "example.com",
  "aRecord" : {
    "name" : "*.example.com",
    "ipAddress" : [ "75.5.114.129", "166.17.13.68" ]
  },
  "cnameRecords" : [ {
    "name" : "_3e3e8de9516be6c3d242a143c16da5d0.example.com",
    "value" : "example.com.domains.zrok.sandbox.netfoundry.io"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/hzFNFGTi5I4DUE-DM0p6j/dns-records"
    },
    "custom-frontend" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07/custom-frontends/hzFNFGTi5I4DUE-DM0p6j"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/9125f8b1-446e-4942-b3fa-64f635701d07"
    }
  }
}

Share

Management of Share resources. Shares can't be updated.

List Shares

Retrieves a list of Share resources in a specific Frontdoor. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

query Parameters

envZId

string

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"_embedded\" : {\n    \"shareList\" : [ {\n      \"frontdoorId\" : \"2dbd48f3-8091-4f9b-9d07-dd0d105780c7\",\n      \"authProviderId\" : null,\n      \"frontendId\" : null,\n      \"name\" : \"share1\",\n      \"zId\" : \"KF4GwDIwiL\",\n      \"shareMode\" : \"public\",\n      \"backendMode\" : \"proxy\",\n      \"envZId\" : \"ijcrWb-ZOq\",\n      \"frontendSelection\" : null,\n      \"frontendEndpoint\" : \"https://share1.share.zrok.sandbox.netfoundry.io\",\n      \"backendProxyEndpoint\" : \"https://google.com\",\n      \"oauthProvider\" : null,\n      \"oauthEmailDomains\" : null,\n      \"oauthAuthorizationCheckInterval\" : null,\n      \"reserved\" : true,\n      \"limited\" : false,\n      \"createdAt\" : \"2025-06-20T21:01:07.126+00:00\",\n      \"updatedAt\" : \"2025-06-20T21:01:07.126+00:00\",\n      \"activity\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/shares/share1\"\n        },\n        \"shares\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/shares{?envZId}\",\n          \"templated\" : true\n        },\n        \"environments\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/environments/{envZId}\",\n          \"templated\" : true\n        },\n        \"metrics\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/shares/share1/metrics{?duration}\",\n          \"templated\" : true\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7\"\n        }\n      }\n    }, {\n      \"frontdoorId\" : \"2dbd48f3-8091-4f9b-9d07-dd0d105780c7\",\n      \"authProviderId\" : null,\n      \"frontendId\" : null,\n      \"name\" : \"share2\",\n      \"zId\" : \"k0G3gIYfVw\",\n      \"shareMode\" : \"public\",\n      \"backendMode\" : \"proxy\",\n      \"envZId\" : \"ijcrWb-ZOq\",\n      \"frontendSelection\" : null,\n      \"frontendEndpoint\" : \"https://share2.share.zrok.sandbox.netfoundry.io\",\n      \"backendProxyEndpoint\" : \"https://yahoo.com\",\n      \"oauthProvider\" : null,\n      \"oauthEmailDomains\" : null,\n      \"oauthAuthorizationCheckInterval\" : null,\n      \"reserved\" : true,\n      \"limited\" : false,\n      \"createdAt\" : \"2025-06-20T21:01:07.226+00:00\",\n      \"updatedAt\" : \"2025-06-20T21:01:07.226+00:00\",\n      \"activity\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/shares/share2\"\n        },\n        \"shares\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/shares{?envZId}\",\n          \"templated\" : true\n        },\n        \"environments\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/environments/{envZId}\",\n          \"templated\" : true\n        },\n        \"metrics\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/shares/share2/metrics{?duration}\",\n          \"templated\" : true\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/shares{?envZId}\",\n      \"templated\" : true\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7\"\n    },\n    \"sparklines\" : {\n      \"href\" : \"/frontdoor/{frontdoorId}/sparklines{?shares,environments}\",\n      \"templated\" : true\n    }\n  }\n}"

Get metrics for single Share resource by ID.

Retrieves transmitted and received data for a specific share. This endpoint fetches metrics data for a given share within a specific frontdoor. An optional duration parameter can be provided to specify the time window for the metrics.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Id of the Frontdoor resource.
token required	string <uuid> The unique token identifying the Share.

query Parameters

duration

string

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "2dbd48f3-8091-4f9b-9d07-dd0d105780c7",
  "shareToken" : "share1",
  "scope" : "account",
  "id" : "9",
  "period" : "2592000",
  "samples" : [ {
    "rx" : 3821,
    "tx" : 513,
    "timestamp" : "2025-06-23T00:00:00.000+00:00"
  }, {
    "rx" : 3282,
    "tx" : 3053,
    "timestamp" : "2025-06-24T00:00:00.000+00:00"
  }, {
    "rx" : 821,
    "tx" : 302513,
    "timestamp" : "2025-06-25T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-26T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-27T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-28T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-29T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-30T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-01T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-02T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-03T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-04T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-05T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-06T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-07T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-08T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-09T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-10T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-11T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-12T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-13T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-14T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-15T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-16T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-17T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-18T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-19T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-20T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-21T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-22T00:00:00.000+00:00"
  }, {
    "rx" : 32821,
    "tx" : 30513,
    "timestamp" : "2025-07-22T15:56:40.161+00:00"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/shares/share1/metrics{?duration}",
      "templated" : true
    },
    "share" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/shares/share1"
    },
    "shares" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/shares{?envZId}",
      "templated" : true
    },
    "environments" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7/environments/{envZId}",
      "templated" : true
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/2dbd48f3-8091-4f9b-9d07-dd0d105780c7"
    }
  }
}

List Environments

Retrieves a list of Environments resources in a specific Frontdoor. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"_embedded\" : {\n    \"environmentList\" : [ {\n      \"frontdoorId\" : \"c9b82d94-4fb4-4510-9177-19dd6f21575b\",\n      \"description\" : \"computer@Mac\",\n      \"host\" : \"computer; Mac; darwin; darwin; Standalone Workstation; 15.5; 24.5.0; arm64\",\n      \"address\" : \"201.124.246.91\",\n      \"zId\" : \"VW8TidQV5WLxVWwAIS6Hs\",\n      \"limited\" : null,\n      \"createdAt\" : \"2025-06-20T20:56:24.648+00:00\",\n      \"updatedAt\" : \"2025-06-20T20:56:24.648+00:00\",\n      \"activity\" : null,\n      \"_links\" : {\n        \"shares\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/shares?envZId=VW8TidQV5WLxVWwAIS6Hs\"\n        },\n        \"metrics\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments/VW8TidQV5WLxVWwAIS6Hs/metrics{?duration}\",\n          \"templated\" : true\n        },\n        \"environments\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments/VW8TidQV5WLxVWwAIS6Hs\"\n        },\n        \"sparklines\" : {\n          \"href\" : \"/frontdoor/{frontdoorId}/sparklines{?shares,environments}\",\n          \"templated\" : true\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b\"\n        }\n      }\n    }, {\n      \"frontdoorId\" : \"c9b82d94-4fb4-4510-9177-19dd6f21575b\",\n      \"description\" : \"computer1@Mac\",\n      \"host\" : \"computer; Mac; darwin; darwin; Standalone Workstation; 15.5; 24.5.0; arm64\",\n      \"address\" : \"201.124.246.92\",\n      \"zId\" : \"3clkhwXjgHSFD7k3ydpnw\",\n      \"limited\" : null,\n      \"createdAt\" : \"2025-06-20T20:56:24.648+00:00\",\n      \"updatedAt\" : \"2025-06-20T20:56:24.648+00:00\",\n      \"activity\" : null,\n      \"_links\" : {\n        \"shares\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/shares?envZId=3clkhwXjgHSFD7k3ydpnw\"\n        },\n        \"metrics\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments/3clkhwXjgHSFD7k3ydpnw/metrics{?duration}\",\n          \"templated\" : true\n        },\n        \"environments\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments\"\n        },\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments/3clkhwXjgHSFD7k3ydpnw\"\n        },\n        \"sparklines\" : {\n          \"href\" : \"/frontdoor/{frontdoorId}/sparklines{?shares,environments}\",\n          \"templated\" : true\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments\"\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b\"\n    }\n  }\n}"

Get details of a single Environment resource by ID.

Retrieves a single Environment by its ID. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Id of the Frontdoor resource.
envZId required	string

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "c9b82d94-4fb4-4510-9177-19dd6f21575b",
  "description" : "computer@Mac",
  "host" : "computer; Mac; darwin; darwin; Standalone Workstation; 15.5; 24.5.0; arm64",
  "address" : "201.124.246.91",
  "zId" : "uuV4QrQt2HEJa6e0F7fLA",
  "limited" : null,
  "createdAt" : "2025-06-20T20:56:24.648+00:00",
  "updatedAt" : "2025-06-20T20:56:24.648+00:00",
  "activity" : null,
  "_links" : {
    "shares" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/shares?envZId=uuV4QrQt2HEJa6e0F7fLA"
    },
    "metrics" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments/uuV4QrQt2HEJa6e0F7fLA/metrics{?duration}",
      "templated" : true
    },
    "environments" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments/uuV4QrQt2HEJa6e0F7fLA"
    },
    "sparklines" : {
      "href" : "/frontdoor/{frontdoorId}/sparklines{?shares,environments}",
      "templated" : true
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b"
    }
  }
}

Delete Environment

Deletes a Environment by its ID. The caller must have delete permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Id of the Frontdoor resource.
envZId required	string

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "c9b82d94-4fb4-4510-9177-19dd6f21575b",
  "description" : "computer@Mac",
  "host" : "computer; Mac; darwin; darwin; Standalone Workstation; 15.5; 24.5.0; arm64",
  "address" : "201.124.246.91",
  "zId" : "I55kNzjzrp75gxWPcvxBQ",
  "limited" : null,
  "createdAt" : "2025-06-20T20:56:24.648+00:00",
  "updatedAt" : "2025-06-20T20:56:24.648+00:00",
  "activity" : null,
  "_links" : {
    "shares" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/shares?envZId=I55kNzjzrp75gxWPcvxBQ"
    },
    "metrics" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments/I55kNzjzrp75gxWPcvxBQ/metrics{?duration}",
      "templated" : true
    },
    "environments" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments/I55kNzjzrp75gxWPcvxBQ"
    },
    "sparklines" : {
      "href" : "/frontdoor/{frontdoorId}/sparklines{?shares,environments}",
      "templated" : true
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b"
    }
  }
}

Get metrics for single Environment resource by ID.

Retrieves transmitted and received data for a specific environment. This endpoint fetches metrics data for a given environment within a specific frontdoor. An optional duration parameter can be provided to specify the time window for the metrics.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Id of the Frontdoor resource.
envZId required	string

query Parameters

duration

string

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "c9b82d94-4fb4-4510-9177-19dd6f21575b",
  "envZId" : "Jibtq6nteJwtI0pY0cEbf",
  "scope" : "account",
  "id" : "9",
  "period" : "2592000",
  "samples" : [ {
    "rx" : 3821,
    "tx" : 513,
    "timestamp" : "2025-06-23T00:00:00.000+00:00"
  }, {
    "rx" : 3282,
    "tx" : 3053,
    "timestamp" : "2025-06-24T00:00:00.000+00:00"
  }, {
    "rx" : 821,
    "tx" : 302513,
    "timestamp" : "2025-06-25T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-26T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-27T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-28T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-29T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-06-30T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-01T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-02T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-03T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-04T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-05T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-06T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-07T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-08T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-09T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-10T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-11T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-12T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-13T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-14T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-15T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-16T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-17T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-18T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-19T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-20T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-21T00:00:00.000+00:00"
  }, {
    "rx" : 0,
    "tx" : 0,
    "timestamp" : "2025-07-22T00:00:00.000+00:00"
  }, {
    "rx" : 32821,
    "tx" : 30513,
    "timestamp" : "2025-07-22T15:56:40.161+00:00"
  } ],
  "_links" : {
    "shares" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/shares?envZId=Jibtq6nteJwtI0pY0cEbf"
    },
    "environments" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments"
    },
    "environment" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments/Jibtq6nteJwtI0pY0cEbf"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b/environments/Jibtq6nteJwtI0pY0cEbf/metrics{?duration}",
      "templated" : true
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/c9b82d94-4fb4-4510-9177-19dd6f21575b"
    }
  }
}

Health Checks

Management of Health Check resources. Health Checks are used to check if a Share is able to respond to external requests.

Retrieves a single Health Check resource by ID.

Retrieves a single Health Check by its ID. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "hi6SqV-8e_xrsOW2N0VoN",
  "frontdoorId" : "cd4749d1-4e08-44c6-945d-03c32f226ffd",
  "name" : "HealthCheck-24",
  "envZId" : "RfyH1WAt8bVVqWaY1Vl64",
  "shareToken" : "pOd08IFBVAwlA1dcZfqQ_",
  "httpVerb" : "GET",
  "endpoint" : "/status",
  "expectedHttpResponse" : 200,
  "timeoutMilliseconds" : 1000,
  "createdBy" : "82d9c855-781a-4115-81b3-4a68127e14e3",
  "createdAt" : "2025-08-29T13:37:47.958841Z",
  "updatedBy" : "d0625836-f674-480c-8fa8-6ed0fd40c7e9",
  "updatedAt" : "2025-08-29T13:37:47.962583Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/cd4749d1-4e08-44c6-945d-03c32f226ffd/health-checks/hi6SqV-8e_xrsOW2N0VoN"
    },
    "share" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/cd4749d1-4e08-44c6-945d-03c32f226ffd/shares/pOd08IFBVAwlA1dcZfqQ_"
    },
    "environment" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/cd4749d1-4e08-44c6-945d-03c32f226ffd/environments/RfyH1WAt8bVVqWaY1Vl64"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/cd4749d1-4e08-44c6-945d-03c32f226ffd"
    }
  }
}

Put Health Check

Performs a full update of an existing Health Check. All fields must be provided in the request body. The caller must have update permissions on the parent Frontdoor resource. The response includes the updated Health Check resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Request Body schema: application/json
required

name required	string non-empty A unique name for the health check within the frontdoor.
shareToken required	string non-empty The token of the share to health check.
endpoint required	string non-empty ^/.* The endpoint to call on the share.
httpVerb required	any (HttpMethod) The HTTP verb to use for the health check.
expectedHttpResponse	integer <int32> The expected HTTP response code. If not specified, defaults to 200.
timeoutMilliseconds	integer <int32> The timeout in milliseconds for the health check. If not specified, defaults to 10000.

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"health check a\",\"shareToken\":\"X9zWE0juWYALLtWDb6Mv9\",\"endpoint\":\"/status\",\"httpVerb\":\"GET\",\"expectedHttpResponse\":200,\"timeoutMilliseconds\":1000}"

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "uSUtm5FmQyFxmRg6vtQdc",
  "frontdoorId" : "4f07a15f-0d4f-41db-baca-fac9eb8b09cb",
  "name" : "health check a",
  "envZId" : "tzoq1MPu9UgYf5",
  "shareToken" : "X9zWE0juWYALLtWDb6Mv9",
  "httpVerb" : "GET",
  "endpoint" : "/status",
  "expectedHttpResponse" : 200,
  "timeoutMilliseconds" : 1000,
  "createdBy" : "51e5cbfd-2a58-47d0-a470-9f9dd5a960a3",
  "createdAt" : "2025-08-29T13:37:47.602702Z",
  "updatedBy" : "41a0c1a7-fde9-46cc-97f1-bbec5f42173e",
  "updatedAt" : "2025-08-29T13:37:47.658421Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/4f07a15f-0d4f-41db-baca-fac9eb8b09cb/health-checks/uSUtm5FmQyFxmRg6vtQdc"
    },
    "share" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/4f07a15f-0d4f-41db-baca-fac9eb8b09cb/shares/X9zWE0juWYALLtWDb6Mv9"
    },
    "environment" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/4f07a15f-0d4f-41db-baca-fac9eb8b09cb/environments/tzoq1MPu9UgYf5"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/4f07a15f-0d4f-41db-baca-fac9eb8b09cb"
    }
  }
}

Delete Health Check

Deletes a Health Check by its ID. The caller must have delete permissions on the parent Frontdoor resource. Deleting a share deletes all Health Checks configured for the share.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "wbyzexTtDzT6d39b1UBF-",
  "frontdoorId" : "56cd0f26-685c-4f21-a397-9331c0eb9eda",
  "name" : "HealthCheck-18",
  "envZId" : "BzstAwNWpXVPV0ARt4JMR",
  "shareToken" : "LlI46_x9fjfK149VUgQqS",
  "httpVerb" : "GET",
  "endpoint" : "/status",
  "expectedHttpResponse" : 200,
  "timeoutMilliseconds" : 1000,
  "createdBy" : "41570de0-34a0-48b8-b03f-3c0a66420554",
  "createdAt" : "2025-08-29T13:37:47.252815Z",
  "updatedBy" : "9cb24300-af28-4cf5-b81f-21ae82b0a0d8",
  "updatedAt" : "2025-08-29T13:37:47.278450Z",
  "deletedBy" : "90016e1e-f168-400e-8ccd-af940c724952",
  "deletedAt" : "2025-08-29T13:37:47.278100Z",
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/56cd0f26-685c-4f21-a397-9331c0eb9eda/health-checks/wbyzexTtDzT6d39b1UBF-"
    },
    "share" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/56cd0f26-685c-4f21-a397-9331c0eb9eda/shares/LlI46_x9fjfK149VUgQqS"
    },
    "environment" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/56cd0f26-685c-4f21-a397-9331c0eb9eda/environments/BzstAwNWpXVPV0ARt4JMR"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/56cd0f26-685c-4f21-a397-9331c0eb9eda"
    }
  }
}

Patch Health Check

Partially updates an existing Health Check resource. Only properties to be updated need to be provided in the request body. The caller must have update permissions on the parent Frontdoor resource. The response includes the updated Health Check resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Request Body schema: application/json
required

name required	string non-empty A unique name for the health check within the frontdoor.
shareToken required	string non-empty The token of the share to health check.
endpoint required	string non-empty ^/.* The endpoint to call on the share.
httpVerb required	any (HttpMethod) The HTTP verb to use for the health check.
expectedHttpResponse	integer <int32> The expected HTTP response code. If not specified, defaults to 200.
timeoutMilliseconds	integer <int32> The timeout in milliseconds for the health check. If not specified, defaults to 10000.

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"health check a\",\"shareToken\":\"Ow2oAAYyeiJyH5cmHaAEe\",\"endpoint\":null,\"httpVerb\":null,\"expectedHttpResponse\":null,\"timeoutMilliseconds\":null}"

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "eFjDwTgKGap--_jY_cspL",
  "frontdoorId" : "bbbf18f8-d320-4681-8743-990ec91213af",
  "name" : "health check a",
  "envZId" : "E_hxRqqshpvNk5jwsFSwe",
  "shareToken" : "Ow2oAAYyeiJyH5cmHaAEe",
  "httpVerb" : "GET",
  "endpoint" : "/status",
  "expectedHttpResponse" : 200,
  "timeoutMilliseconds" : 1000,
  "createdBy" : "d58e99b4-a1f6-4416-b378-525279cb04ad",
  "createdAt" : "2025-08-29T13:37:47.876228Z",
  "updatedBy" : "ad1a6485-216d-424b-ac49-aac5fd4fff92",
  "updatedAt" : "2025-08-29T13:37:47.908337Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/bbbf18f8-d320-4681-8743-990ec91213af/health-checks/eFjDwTgKGap--_jY_cspL"
    },
    "share" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/bbbf18f8-d320-4681-8743-990ec91213af/shares/Ow2oAAYyeiJyH5cmHaAEe"
    },
    "environment" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/bbbf18f8-d320-4681-8743-990ec91213af/environments/E_hxRqqshpvNk5jwsFSwe"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/bbbf18f8-d320-4681-8743-990ec91213af"
    }
  }
}

List Health Checks

Retrieves a paginated list of Health Check resources in a specific Frontdoor. The results can be filtered by providing query parameters that correspond to the properties of a Health Check. For example, to filter by name, you can add ?name=my-check to the request URL. Multiple values for the same filter property are supported (e.g., ?name=check1&name=check2). Sorting and pagination are also supported. For instance, ?page=0&size=20&sort=name,asc will retrieve the first page of 20 health checks, sorted by name in ascending order. The returned list is automatically constrained by the user's access permissions. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

query Parameters

id	string <uuid> Id to filter by, unique IDs of health check resources.
name	any Name to filter by.
environment	any Environment ZID to filter by, unique id of the environment.
shareToken	any Share token to filter by, unique name of the share, uses 'like' semantics.
endpoint	any Endpoint to filter by, the target of the health check like /status or /health.
httpVerb	any The HTTP verb to filter by, example GET, POST, HEAD, etc.
expectedHttpResponse	any The expected HTTP response code to filter by, example 200.
timeoutMilliseconds	any The timeout in milliseconds to filter by, example 10000.
deletedAt	string <date-time> If deleted, filter by a range of timestamps. Defaults to to return only resources that are not deleted.
deletedBy	string <uuid> If deleted, filter by a user of the user. Defaults to to return only resources that are not deleted.
createdAt	string <date-time> Filter by a range of timestamps.
createdBy	string <uuid> Filter by a user of the user that created the resource.
updatedAt	string <date-time> Filter by a range of timestamps.
updatedBy	any Filter by a user of the user that last updated the resource.
page	any The page number.
size	any The number of resources returned per page.
sort	any The property to sort by, 'asc' and 'desc' can be appended after a comma

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"_embedded\" : {\n    \"healthCheckList\" : [ {\n      \"id\" : \"SaeydR4WU3rMvDtyGeVr-\",\n      \"frontdoorId\" : \"abd1dc52-73d6-45a2-9155-e127b3a5a9e5\",\n      \"name\" : \"HealthCheck-19\",\n      \"envZId\" : \"Pezd8OkKX4QW9nDDS_YFq\",\n      \"shareToken\" : \"MEQy4uOpYOaL9zB4j69r3\",\n      \"httpVerb\" : \"GET\",\n      \"endpoint\" : \"/status\",\n      \"expectedHttpResponse\" : 200,\n      \"timeoutMilliseconds\" : 1000,\n      \"createdBy\" : \"46c8e8d9-5475-4f70-a72f-74b6c87dfb18\",\n      \"createdAt\" : \"2025-08-29T13:37:47.361091Z\",\n      \"updatedBy\" : \"91922bfd-fe22-4b95-99d2-57d44c8eb84e\",\n      \"updatedAt\" : \"2025-08-29T13:37:47.367573Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/abd1dc52-73d6-45a2-9155-e127b3a5a9e5/health-checks/SaeydR4WU3rMvDtyGeVr-\"\n        },\n        \"share\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/abd1dc52-73d6-45a2-9155-e127b3a5a9e5/shares/MEQy4uOpYOaL9zB4j69r3\"\n        },\n        \"environment\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/abd1dc52-73d6-45a2-9155-e127b3a5a9e5/environments/Pezd8OkKX4QW9nDDS_YFq\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/abd1dc52-73d6-45a2-9155-e127b3a5a9e5\"\n        }\n      }\n    }, {\n      \"id\" : \"bPkipkqaKznr-aFsDhQc3\",\n      \"frontdoorId\" : \"abd1dc52-73d6-45a2-9155-e127b3a5a9e5\",\n      \"name\" : \"HealthCheck-20\",\n      \"envZId\" : \"txlyay1t6enpE2Suieh5Y\",\n      \"shareToken\" : \"fuy4zLSMwa_prCjKnOAvU\",\n      \"httpVerb\" : \"HEAD\",\n      \"endpoint\" : \"/health\",\n      \"expectedHttpResponse\" : 200,\n      \"timeoutMilliseconds\" : 1000,\n      \"createdBy\" : \"cb3e2533-7023-48ea-8568-0cbdc12f5333\",\n      \"createdAt\" : \"2025-08-29T13:37:47.371119Z\",\n      \"updatedBy\" : \"6b23b475-8c53-4b91-9403-cac52b1e9592\",\n      \"updatedAt\" : \"2025-08-29T13:37:47.376049Z\",\n      \"deletedBy\" : null,\n      \"deletedAt\" : null,\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/abd1dc52-73d6-45a2-9155-e127b3a5a9e5/health-checks/bPkipkqaKznr-aFsDhQc3\"\n        },\n        \"share\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/abd1dc52-73d6-45a2-9155-e127b3a5a9e5/shares/fuy4zLSMwa_prCjKnOAvU\"\n        },\n        \"environment\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/abd1dc52-73d6-45a2-9155-e127b3a5a9e5/environments/txlyay1t6enpE2Suieh5Y\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/abd1dc52-73d6-45a2-9155-e127b3a5a9e5\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/abd1dc52-73d6-45a2-9155-e127b3a5a9e5/health-checks\"\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/abd1dc52-73d6-45a2-9155-e127b3a5a9e5\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 20,\n    \"totalElements\" : 2,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Create Health Check

Creates a new Health Check for a Frontdoor. The caller must have create permissions on the parent Frontdoor resource. The response includes the created Health Check resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

Request Body schema: application/json
required

name required	string non-empty A unique name for the health check within the frontdoor.
shareToken required	string non-empty The token of the share to health check.
endpoint required	string non-empty ^/.* The endpoint to call on the share.
httpVerb required	any (HttpMethod) The HTTP verb to use for the health check.
expectedHttpResponse	integer <int32> The expected HTTP response code. If not specified, defaults to 200.
timeoutMilliseconds	integer <int32> The timeout in milliseconds for the health check. If not specified, defaults to 10000.

Responses

Request samples

Payload

Content type

application/json

default

"{\"name\":\"health check 1\",\"shareToken\":\"O5p0WSNq_WL5putcRGYLQ\",\"endpoint\":\"/status\",\"httpVerb\":\"GET\",\"expectedHttpResponse\":null,\"timeoutMilliseconds\":null}"

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "IkTFdjPLlGdGDmBwFxfOj",
  "frontdoorId" : "e77f87a4-3148-43a4-a9cf-1b913ec1bf6a",
  "name" : "health check 1",
  "envZId" : "YcWUPWCOZ2gI5Q9N_KSVq",
  "shareToken" : "O5p0WSNq_WL5putcRGYLQ",
  "httpVerb" : "GET",
  "endpoint" : "/status",
  "expectedHttpResponse" : 200,
  "timeoutMilliseconds" : 1000,
  "createdBy" : "318f430a-c0ce-432a-bb6c-3ed0ee39be2e",
  "createdAt" : "2025-08-29T13:37:47.539713Z",
  "updatedBy" : "318f430a-c0ce-432a-bb6c-3ed0ee39be2e",
  "updatedAt" : "2025-08-29T13:37:47.539713Z",
  "deletedBy" : null,
  "deletedAt" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/e77f87a4-3148-43a4-a9cf-1b913ec1bf6a/health-checks/IkTFdjPLlGdGDmBwFxfOj"
    },
    "share" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/e77f87a4-3148-43a4-a9cf-1b913ec1bf6a/shares/O5p0WSNq_WL5putcRGYLQ"
    },
    "environment" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/e77f87a4-3148-43a4-a9cf-1b913ec1bf6a/environments/YcWUPWCOZ2gI5Q9N_KSVq"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/e77f87a4-3148-43a4-a9cf-1b913ec1bf6a"
    }
  }
}

Executes a HealthCheck without storing it.

Executes a transient Health Check without saving it. This is useful for testing health check parameters before creating a resource. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

Request Body schema: application/json
required

name required	string non-empty A unique name for the health check within the frontdoor.
shareToken required	string non-empty The token of the share to health check.
endpoint required	string non-empty ^/.* The endpoint to call on the share.
httpVerb required	any (HttpMethod) The HTTP verb to use for the health check.
expectedHttpResponse	integer <int32> The expected HTTP response code. If not specified, defaults to 200.
timeoutMilliseconds	integer <int32> The timeout in milliseconds for the health check. If not specified, defaults to 10000.

Responses

Request samples

Payload

Content type

application/json

No sample

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "2e0e183f-04ad-4713-a63b-f4f442f6ac16",
  "id" : null,
  "healthy" : true,
  "error" : null,
  "_links" : {
    "health-check" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/2e0e183f-04ad-4713-a63b-f4f442f6ac16/health-checks/{id}",
      "templated" : true
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/2e0e183f-04ad-4713-a63b-f4f442f6ac16"
    }
  }
}

Executes a stored HealthCheck by ID.

Executes a previously stored Health Check immediately. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "761db084-9371-490a-a9a8-1bce91556899",
  "id" : "lZt7TB97XZsVCYJnNuhtR",
  "healthy" : true,
  "error" : null,
  "_links" : {
    "health-check" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/761db084-9371-490a-a9a8-1bce91556899/health-checks/lZt7TB97XZsVCYJnNuhtR"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/761db084-9371-490a-a9a8-1bce91556899"
    }
  }
}

Sparklines

Sparkline data for the Frontdoor.

Get Sparklines for the Frontdoor

This retrieves sparkline data for a specific frontdoor. Sparklines provide a concise view of network traffic metrics (receive and transmit) over a period of time. The data can be filtered by providing a set of environment ZIDs or a set of share tokens. It is mandatory to provide at least one environment or one share for the query to be valid.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

query Parameters

id	string <uuid> Id to filter by, unique IDs of health check resources.
shares	any Share Tokens to filter by.
environments	any Environment ZID to filter by, unique id of the environment.
required	object (SparklinesInput) A request to show sparklines, filtering by environments and/or shares.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"frontdoorId\" : \"51cd27c5-ed9a-4402-bc78-aa529fa8e2fe\",\n  \"sparklines\" : [ {\n    \"scope\" : \"environment\",\n    \"id\" : \"e3qg6i24ez3fnsa70nv8v\",\n    \"period\" : null,\n    \"samples\" : [ {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 21756,\n      \"tx\" : 2334,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 175611,\n      \"tx\" : 1124,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 16,\n      \"tx\" : 22834,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    }, {\n      \"rx\" : 0,\n      \"tx\" : 0,\n      \"timestamp\" : null\n    } ]\n  } ],\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"/frontdoor/{frontdoorId}/sparklines{?shares,environments}\",\n      \"templated\" : true\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/51cd27c5-ed9a-4402-bc78-aa529fa8e2fe\"\n    }\n  }\n}"

Agent

Management of Agent resources. An Agent is installed on a client host to host Shares. Agents can't be updated.

Create Enrollment Token

Creates a new Enrollment Token, for use with installing a Frontdoor Agent. The caller must have create permissions on the parent Frontdoor resource. The response includes the Enrollment Token.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "id" : "7uaLEs2founwz__AmVS9B",
  "frontdoorId" : "6ac61252-ba93-4d0a-a754-fbf6750691c5",
  "bootstrapToken" : "g0wevhqx",
  "enrollmentExpiryDate" : "2025-08-31T13:37:50.737935Z",
  "enrollmentAttempts" : 0,
  "createdAt" : "2025-08-29T13:37:50.738104Z",
  "createdBy" : "067c58cf-a793-49ad-86fa-63e09baec298",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5/agent/enrollment"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5"
    }
  }
}

Get Bootstrap Token

Get the Bootstrap token for the Enrollment Token, called by the Frontdoor Agent during bootstrapping process. The response includes the Bootstrap Token.

Authorizations:

bearerAuth

path Parameters

code

required

string

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "accountToken" : "QvYMVa2CxAHG0OmeH7t5A",
  "apiEndpoint" : "https://localhost:0"
}

Retrieves a single Agent resource by ID.

Retrieves a single Agent by its ID. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "6ac61252-ba93-4d0a-a754-fbf6750691c5",
  "shares" : [ {
    "token" : "share1",
    "shareMode" : "public",
    "backendMode" : "proxy",
    "reserved" : true,
    "frontendEndpoints" : [ "https://share1.shares.netfoundry.io" ],
    "backendEndpoint" : "https://google.com",
    "status" : "online"
  } ],
  "accesses" : null,
  "_links" : {
    "version" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5/agents/mJKChCoCU0iOEykkN11DN/version"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5/agents/mJKChCoCU0iOEykkN11DN/status"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5"
    }
  }
}

Delete agent

Deletes a agent by its ID. The caller must have delete permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "6ac61252-ba93-4d0a-a754-fbf6750691c5",
  "shares" : [ {
    "token" : "share1",
    "shareMode" : "public",
    "backendMode" : "proxy",
    "reserved" : true,
    "frontendEndpoints" : [ "https://share1.shares.netfoundry.io" ],
    "backendEndpoint" : "https://google.com",
    "status" : "online"
  } ],
  "accesses" : null,
  "_links" : {
    "version" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5/agents/vXHWqZFNz0CvNdKZNUFH2/version"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5/agents/vXHWqZFNz0CvNdKZNUFH2/status"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5"
    }
  }
}

Retrieves the version of single Agent resource by ID.

Retrieves the version of an Agent by its ID. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> Id of the resource.
frontdoorId required	string <uuid> Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "frontdoorId" : "6ac61252-ba93-4d0a-a754-fbf6750691c5",
  "version" : "1.0.1",
  "_links" : {
    "status" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5/agents/dSoVCUpCm8QpLPs-QjOFy/status"
    },
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5/agents/dSoVCUpCm8QpLPs-QjOFy/version"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/6ac61252-ba93-4d0a-a754-fbf6750691c5"
    }
  }
}

Executions

Operations related to Frontdoor executions. Executions are created any time a resource is created or updated.

Cancel a running execution

Cancels a RUNNING execution. If an execution is in any other status than RUNNING it will silently do nothing. The caller must have update permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Example: a8b8c8d8-e8f8-g8h8-i8j8-k8l8m8n8o8p8 ID of the frontdoor
id required	string <uuid> Example: b9c9d9e9-f9g9-h9i9-j9k9-l9m9n9o9p9q9 ID of the execution to cancel

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"aoITfT_dnyvjExLwuX8bn\",\n  \"frontdoorId\" : \"91934d8b-9d04-44d6-af2b-750d488ebd0b\",\n  \"processId\" : \"7b14cb3a-c79d-40ce-8449-bd1e618c751a\",\n  \"name\" : \"CreateCustomFrontendProcess\",\n  \"description\" : \"Fake Process\",\n  \"resourceType\" : \"component\",\n  \"resourceId\" : \"BIx152iOeap3EgGhe0prY\",\n  \"startedAt\" : \"2025-08-29T13:37:53.662287Z\",\n  \"finishedAt\" : \"2025-08-29T13:37:53.697697Z\",\n  \"traceId\" : \"trace1\",\n  \"status\" : \"CANCELED\",\n  \"initiatingIdentityId\" : \"f664d0c2-a7b1-4ebc-95bb-5d9695c7dd63\",\n  \"createdAt\" : \"2025-08-29T13:37:53.662645Z\",\n  \"updatedAt\" : \"2025-08-29T13:37:53.697749Z\",\n  \"actions\" : [ ],\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/91934d8b-9d04-44d6-af2b-750d488ebd0b/executions/aoITfT_dnyvjExLwuX8bn\"\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/91934d8b-9d04-44d6-af2b-750d488ebd0b\"\n    }\n  }\n}"

Cancel a running execution

Cancels a RUNNING execution. If an execution is in any other status than RUNNING it will silently do nothing. The caller must have update permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Example: a8b8c8d8-e8f8-g8h8-i8j8-k8l8m8n8o8p8 ID of the frontdoor
id required	string <uuid> Example: b9c9d9e9-f9g9-h9i9-j9k9-l9m9n9o9p9q9 ID of the execution to cancel

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"aoITfT_dnyvjExLwuX8bn\",\n  \"frontdoorId\" : \"91934d8b-9d04-44d6-af2b-750d488ebd0b\",\n  \"processId\" : \"7b14cb3a-c79d-40ce-8449-bd1e618c751a\",\n  \"name\" : \"CreateCustomFrontendProcess\",\n  \"description\" : \"Fake Process\",\n  \"resourceType\" : \"component\",\n  \"resourceId\" : \"BIx152iOeap3EgGhe0prY\",\n  \"startedAt\" : \"2025-08-29T13:37:53.662287Z\",\n  \"finishedAt\" : \"2025-08-29T13:37:53.697697Z\",\n  \"traceId\" : \"trace1\",\n  \"status\" : \"CANCELED\",\n  \"initiatingIdentityId\" : \"f664d0c2-a7b1-4ebc-95bb-5d9695c7dd63\",\n  \"createdAt\" : \"2025-08-29T13:37:53.662645Z\",\n  \"updatedAt\" : \"2025-08-29T13:37:53.697749Z\",\n  \"actions\" : [ ],\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/91934d8b-9d04-44d6-af2b-750d488ebd0b/executions/aoITfT_dnyvjExLwuX8bn\"\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/91934d8b-9d04-44d6-af2b-750d488ebd0b\"\n    }\n  }\n}"

List executions for a frontdoor

List all Execution instances which match the search criteria as specified via query parameters. Instances that the API client does not have authorization to read will be removed from the results.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Example: a8b8c8d8-e8f8-g8h8-i8j8-k8l8m8n8o8p8

ID of the frontdoor

query Parameters

page	any The page number.
size	any The number of resources returned per page.
sort	any The property to sort by, 'asc' and 'desc' can be appended after a comma

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"_embedded\" : {\n    \"executionList\" : [ {\n      \"id\" : \"-PLoX5owWLMiPeuMtGgeG\",\n      \"frontdoorId\" : \"5938c263-2234-4efa-b513-aaeed4ee3849\",\n      \"processId\" : \"f90feab1-eace-405e-a771-a6774196f2f4\",\n      \"name\" : \"ExecutionType1\",\n      \"description\" : \"Test Execution 1\",\n      \"resourceType\" : \"test-component\",\n      \"resourceId\" : \"6RaPqyklWLE5thZ2ONRf3\",\n      \"startedAt\" : \"2025-08-29T13:37:28.377417Z\",\n      \"finishedAt\" : \"2025-08-29T13:37:33.377429Z\",\n      \"traceId\" : \"d5QigvAWuHr38_3gHNGvi\",\n      \"status\" : \"SUCCESS\",\n      \"initiatingIdentityId\" : \"cf66276d-5f93-4cce-b22f-ea32c80f13aa\",\n      \"createdAt\" : \"2025-08-29T13:37:38.377749Z\",\n      \"updatedAt\" : \"2025-08-29T13:37:38.377749Z\",\n      \"actions\" : [ ],\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/5938c263-2234-4efa-b513-aaeed4ee3849/executions/-PLoX5owWLMiPeuMtGgeG\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/5938c263-2234-4efa-b513-aaeed4ee3849\"\n        }\n      }\n    }, {\n      \"id\" : \"fbFZDLL-vgTM7mX6V8D2b\",\n      \"frontdoorId\" : \"5938c263-2234-4efa-b513-aaeed4ee3849\",\n      \"processId\" : \"e41efeec-6d7b-4b97-bdbe-a7fcda880e3d\",\n      \"name\" : \"ExecutionType2\",\n      \"description\" : \"Test Execution 2\",\n      \"resourceType\" : \"test-component\",\n      \"resourceId\" : \"_8DPRpVrVVQ3WTXa6mgFo\",\n      \"startedAt\" : \"2025-08-29T13:37:28.380664Z\",\n      \"finishedAt\" : \"2025-08-29T13:37:33.380667Z\",\n      \"traceId\" : \"D3Jkq9-xacDgV-4N-OI89\",\n      \"status\" : \"FAILED\",\n      \"initiatingIdentityId\" : \"107e1bb1-b8c9-47ee-bdac-14c0ea019153\",\n      \"createdAt\" : \"2025-08-29T13:37:38.380902Z\",\n      \"updatedAt\" : \"2025-08-29T13:37:38.380902Z\",\n      \"actions\" : [ ],\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/5938c263-2234-4efa-b513-aaeed4ee3849/executions/fbFZDLL-vgTM7mX6V8D2b\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/5938c263-2234-4efa-b513-aaeed4ee3849\"\n        }\n      }\n    }, {\n      \"id\" : \"pJt58EDsJWSj5IXVdTMkq\",\n      \"frontdoorId\" : \"5938c263-2234-4efa-b513-aaeed4ee3849\",\n      \"processId\" : \"cb28edfc-a76c-4a33-95f0-6975f1813e3b\",\n      \"name\" : \"ExecutionType3\",\n      \"description\" : \"Test Execution 3\",\n      \"resourceType\" : \"test-component\",\n      \"resourceId\" : \"Ln1tKqhP2-C6C901zc9_X\",\n      \"startedAt\" : \"2025-08-29T13:37:28.384112Z\",\n      \"finishedAt\" : \"2025-08-29T13:37:33.384114Z\",\n      \"traceId\" : \"SOu9-69VURrrBtddjBVh1\",\n      \"status\" : \"CANCELED\",\n      \"initiatingIdentityId\" : \"ba668a67-42b3-47ec-90ee-f90c0afa1970\",\n      \"createdAt\" : \"2025-08-29T13:37:38.387051Z\",\n      \"updatedAt\" : \"2025-08-29T13:37:38.387051Z\",\n      \"actions\" : [ ],\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/5938c263-2234-4efa-b513-aaeed4ee3849/executions/pJt58EDsJWSj5IXVdTMkq\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/5938c263-2234-4efa-b513-aaeed4ee3849\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/5938c263-2234-4efa-b513-aaeed4ee3849/executions\"\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/5938c263-2234-4efa-b513-aaeed4ee3849\"\n    }\n  },\n  \"page\" : {\n    \"size\" : 20,\n    \"totalElements\" : 3,\n    \"totalPages\" : 1,\n    \"number\" : 0\n  }\n}"

Get a specific execution

Get the details of a specific Execution. If the Execution was asynchronous the data will contain a processId. The process data can be embedded by adding meta=processData as a request parameter. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Example: a8b8c8d8-e8f8-g8h8-i8j8-k8l8m8n8o8p8 ID of the frontdoor
id required	string <uuid> Example: b9c9d9e9-f9g9-h9i9-j9k9-l9m9n9o9p9q9 ID of the execution

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"id\" : \"uDa5pKyAq2Ls3xYX7XkCA\",\n  \"frontdoorId\" : \"23686e31-c27d-4c68-bc92-a751cd6534dd\",\n  \"processId\" : \"6028e9b6-3d4b-4718-afd2-6af2a0ed0da1\",\n  \"name\" : \"DeleteCustomFrontendProcess\",\n  \"description\" : \"Fake Process\",\n  \"resourceType\" : \"CustomFrontend\",\n  \"resourceId\" : null,\n  \"startedAt\" : \"2025-08-29T13:37:53.589649Z\",\n  \"finishedAt\" : \"2025-08-29T13:37:53.589649Z\",\n  \"traceId\" : \"trace3\",\n  \"status\" : \"FAILED\",\n  \"initiatingIdentityId\" : \"e39c4634-f801-4167-85e6-6ce94c70fca1\",\n  \"createdAt\" : \"2025-08-29T13:37:53.589756Z\",\n  \"updatedAt\" : \"2025-08-29T13:37:53.589756Z\",\n  \"actions\" : [ ],\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/23686e31-c27d-4c68-bc92-a751cd6534dd/executions/uDa5pKyAq2Ls3xYX7XkCA\"\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/23686e31-c27d-4c68-bc92-a751cd6534dd\"\n    }\n  }\n}"

Frontend

Frontends available to use when creating Shares.

Retrieves all Frontends available.

Lists all Frontends available in the specific Frontdoor. Includes both company-hosted and user-hosted Custom Frontends. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

*/*

default

{
  "_embedded" : {
    "frontendList" : [ {
      "urlTemplate" : "https://{token}.nf.io",
      "publicName" : "public1",
      "_links" : {
        "frontdoor" : {
          "href" : "https://gateway.production.netfoundry.io/frontdoor/d7b0978e-6621-4713-b812-fff036c247ff"
        }
      }
    }, {
      "urlTemplate" : "https://{token}.example.com",
      "publicName" : "custom1",
      "_links" : {
        "frontdoor" : {
          "href" : "https://gateway.production.netfoundry.io/frontdoor/d7b0978e-6621-4713-b812-fff036c247ff"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/d7b0978e-6621-4713-b812-fff036c247ff/frontends"
    },
    "frontdoor" : {
      "href" : "https://gateway.production.netfoundry.io/frontdoor/d7b0978e-6621-4713-b812-fff036c247ff"
    }
  }
}

Auth Provider Type

Auth Providers are used when creating an Auth Provider. They are an informational resource only.

List Auth Provider Types

Retrieves a list of Auth Provider Types available to be configured. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId

required

string <uuid>

Id of the Frontdoor resource.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"_embedded\" : {\n    \"authProviderTypeList\" : [ {\n      \"type\" : \"GITHUB\",\n      \"description\" : \"GitHub OAuth\",\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1/auth-provider-types/GITHUB\"\n        },\n        \"schema\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1/auth-provider-types/GITHUB/schema\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1\"\n        }\n      }\n    }, {\n      \"type\" : \"GOOGLE\",\n      \"description\" : \"Google OAuth\",\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1/auth-provider-types/GOOGLE\"\n        },\n        \"schema\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1/auth-provider-types/GOOGLE/schema\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1\"\n        }\n      }\n    }, {\n      \"type\" : \"OIDC\",\n      \"description\" : \"Standard OIDC\",\n      \"_links\" : {\n        \"self\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1/auth-provider-types/OIDC\"\n        },\n        \"schema\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1/auth-provider-types/OIDC/schema\"\n        },\n        \"frontdoor\" : {\n          \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1\"\n        }\n      }\n    } ]\n  },\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1/auth-provider-types\"\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1\"\n    }\n  }\n}"

Get a single Auth Provider Type

Retrieves a single Auth Provider Types by it's name. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Id of the Frontdoor resource.
name required	string The name of the Auth Provider Type.

Responses

Response samples

200
400
401
403
500

Content type

application/hal+json

default

"{\n  \"type\" : \"OIDC\",\n  \"description\" : \"Standard OIDC\",\n  \"_links\" : {\n    \"self\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1/auth-provider-types/OIDC\"\n    },\n    \"schema\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1/auth-provider-types/OIDC/schema\"\n    },\n    \"frontdoor\" : {\n      \"href\" : \"https://gateway.production.netfoundry.io/frontdoor/9ba9d1c4-0279-477c-89f6-ea4a212682c1\"\n    }\n  }\n}"

Get the JSON schema of a Auth Provider Type

Retrieves the JSON schema for a specific Auth Provider Type in order to validate the input when creating an Auth Provider. The caller must have read permissions on the parent Frontdoor resource.

Authorizations:

bearerAuth

path Parameters

frontdoorId required	string <uuid> Id of the Frontdoor resource.
name required	string The name of the Auth Provider Type.

Responses

Response samples

200
400
401
403
500

Content type

application/json

default

"{\n  \"$schema\" : \"http://json-schema.org/draft-07/schema#\",\n  \"type\" : \"object\",\n  \"properties\" : {\n    \"clientId\" : {\n      \"type\" : \"string\"\n    },\n    \"clientSecret\" : {\n      \"type\" : \"string\"\n    },\n    \"scopes\" : {\n      \"type\" : \"array\",\n      \"items\" : [ {\n        \"type\" : \"string\"\n      } ]\n    },\n    \"authUrl\" : {\n      \"type\" : \"string\"\n    },\n    \"issuer\" : {\n      \"type\" : \"string\"\n    },\n    \"supportsPkce\" : {\n      \"type\" : \"boolean\"\n    }\n  },\n  \"required\" : [ \"clientId\", \"clientSecret\", \"scopes\" ]\n}"

name required	string non-empty ^[A-Za-z][A-Za-z0-9]*$
envZId required	string
target required	string
frontends required	Array of strings non-empty
authProviderId	string
oauthEmailDomains	Array of strings
oauthAuthorizationCheckInterval	string
insecure	boolean

Zrok Connector (1.0)

Frontdoor

Retrieves a single Frontdoor resource by Organization ID.

Authorizations:

query Parameters

Responses

Response samples

Create Frontdoor

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieves a single Frontdoor resource by ID.

Authorizations:

path Parameters

Responses

Response samples

Delete Frontdoor

Authorizations:

path Parameters

Responses

Response samples

Get metrics for single Frontdoor resource by ID.

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Auth Provider

Retrieves a single Auth Provider resource by ID.

Authorizations:

path Parameters

Responses

Response samples

Put Auth Provider

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Auth Provider

Authorizations:

path Parameters

Responses

Response samples

Patch Auth Provider

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List Auth Providers

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Create Auth Provider

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Custom Frontend

Retrieves a single Custom Frontend resource by ID.

Authorizations:

path Parameters

Responses

Response samples

Update Custom Frontend

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required