List ingress groups

GET

/api/ingress-groups

const url = 'https://gateway.example.com/api/ingress-groups';
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/ingress-groups \
  --header 'Authorization: Bearer <token>'

An ingress group is a set of nginx ingress nodes (normally one per site) that serve the same routes and domains: every member gets the same config, certificates, access lists, Pages artifacts and its own Secure Link sources. Groups live in node folders; viewing needs nodes:details, changing needs nodes:manage (broadly or on the group folder), adding a member also needs nodes:manage on that node. Creating, changing and converting require the multi-node availability entitlement (Business and Enterprise); existing groups keep serving without it. DNS failover mode none: the Cloudflare records of the group’s domains list every active member (round robin, no health checks). Each group lists its members with state (joining, active, draining), node status, published addresses, the health their daemon reports for /.well-known/gateway-ingress-health, and per-member delivery counts.

Authorizations

bearerAuth

Parameters

Query Parameters

search

string

<= 255 characters

folderId

string format: uuid

Responses

200

Successful response

application/json

object

data

required

Array<object>

Resource object. Exact fields depend on the endpoint.

object

string

name

string

key

additional properties

Example

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example resource",
      "createdAt": "2024-01-01T12:00:00.000Z",
      "updatedAt": "2024-01-01T12:30:00.000Z"
    }
  ]
}

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"
}