Remove a member

DELETE

/api/ingress-groups/{id}/members/{nodeId}

const url = 'https://gateway.example.com/api/ingress-groups/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000';
const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"force":false}'
};

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

curl --request DELETE \
  --url https://gateway.example.com/api/ingress-groups/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "force": false }'

Without downtime: DNS first. The member becomes draining (still serving, no longer published), and its config, certificates and Secure Link sources are removed once DNS no longer points at it (the TTL of DNS-only records elapsed and no public name of the group resolves to it; at most 24 hours). force: true removes it at once. The last active member of a group that still serves routes or domains cannot be removed.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

nodeId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Request Body

Optional JSON request body

application/json

object

force

boolean

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