Delete Pool

Delete a node pool.

Fails with pool.nodes_connected while any node of the pool is connected.

DELETE https://rivet.example.com/pools/{pool}

Examples

curl -X DELETE "https://rivet.example.com/pools/$RIVET_POOL?namespace=$RIVET_NAMESPACE" \
  -H "Authorization: Bearer $RIVET_TOKEN"

const endpoint = "https://api.rivet.dev";
const namespace = process.env.RIVET_NAMESPACE ?? "default";
const token = process.env.RIVET_TOKEN ?? "";
const pool = process.env.RIVET_POOL ?? "default";

const params = new URLSearchParams({ namespace });
const response = await fetch(
	`${endpoint}/pools/${encodeURIComponent(pool)}?${params}`,
	{
		method: "DELETE",
		headers: { Authorization: `Bearer ${token}` },
	},
);
console.log(response.status);

export {};

Authentication

Send your namespace token as a bearer token in the Authorization header. Every control plane request also requires the namespace query parameter. See Authentication.

Path Parameters

Query Parameters

Responses

200

The node pool was deleted.

{}

400

envoy.invalid_pool_name: the pool name is not valid. envoy.invalid_namespace_name: the namespace value is not a DNS label of 1 to 63 lowercase letters, digits and hyphens.

{
  "group": "envoy",
  "code": "invalid_pool_name",
  "message": "Pool name must be a DNS label of 1 to 63 lowercase letters, digits and hyphens."
}

401

auth.invalid_token: the request carries no token, or the token is not valid. auth.token_expired: the token has expired.

{
  "group": "auth",
  "code": "invalid_token",
  "message": "Authentication token is invalid."
}

403

auth.insufficient_permissions: the token’s grants do not cover this request.

{
  "group": "auth",
  "code": "insufficient_permissions",
  "message": "Insufficient permissions to access this resource."
}

404

pool.not_found: the node pool does not exist. namespace.not_found: the namespace does not exist.

{
  "group": "pool",
  "code": "not_found",
  "message": "The node pool does not exist."
}

409

pool.nodes_connected: the node pool still has connected nodes.

{
  "group": "pool",
  "code": "nodes_connected",
  "message": "The node pool still has connected nodes."
}

500

core.internal_error: an unexpected failure. Details are only logged on the server.

{
  "group": "core",
  "code": "internal_error",
  "message": "An internal error occurred"
}

503

auth.verification_unavailable: token verification keys are temporarily unavailable. Retry the request.

{
  "group": "auth",
  "code": "verification_unavailable",
  "message": "The server could not verify the authentication token because verification keys are temporarily unavailable. Retry the request."
}