List the nginx ingress nodes the caller may create routes on

GET

/api/proxy-hosts/ingress-nodes

const url = 'https://gateway.example.com/api/proxy-hosts/ingress-nodes';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://gateway.example.com/api/proxy-hosts/ingress-nodes \
  --header 'Authorization: Bearer <token>'

Needs any proxy:create grant (broad, folder or node) and no node permission. Returns id, displayName, hostname and status of each nginx node a new route may use: every node for a broad or folder grant, only granted nodes for node grants; nodes locked for new services are omitted. groups lists the ingress groups a new route may use (every member is such a node): id, name, slug, DNS failover mode and the members in site order with their state (joining, active, draining); create the route with ingressGroupId to serve it from every member. Pass folderId to limit both lists to a route in that folder. A route created without nodeId uses the node or group of its registered domains, or the only listed node.

Authorizations

bearerAuth

Parameters

Query Parameters

folderId

string format: uuid

Responses

200

Successful response

application/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

string

name

string

key

additional properties

Example

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "domainNames": [
        "app.example.com"
      ],
      "forwardHost": "10.0.0.10",
      "forwardPort": 3000,
      "enabled": true
    }
  ]
}

400

Bad request

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}