List Datacenters

List the datacenters configured for the control plane.

A namespace token needs a grant on datacenter with list.

GET https://rivet.example.com/datacenters

Examples

curl "https://rivet.example.com/datacenters" \
  -H "Authorization: Bearer $RIVET_TOKEN"

const endpoint = "https://api.rivet.dev";
const token = process.env.RIVET_TOKEN ?? "";

const response = await fetch(`${endpoint}/datacenters`, {
	headers: { Authorization: `Bearer ${token}` },
});
const { datacenters } = await response.json();
console.log(datacenters);

export {};

Authentication

Send the admin token, or a namespace token from Create Token whose grants cover the request, as a bearer token in the Authorization header. The x-rivet-token header is also accepted. Routes with a namespace query parameter use the default namespace when it is omitted. See Authentication.

Responses

200

Configured datacenters.

{
  "datacenters": [
    {
      "name": "default"
    }
  ]
}

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

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