Get the environment's neighbours

GET

/content/management/v1/topology

const url = 'https://api.ebitex.io/content/management/v1/topology';
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://api.ebitex.io/content/management/v1/topology \
  --header 'Authorization: Bearer <token>'

Where the key’s authoring environment sits: the delivery environments it publishes to, the environments it promotes to and is promoted from, the environment it inherits content from, and the environments that inherit from it.

Only direct neighbours are reported, each by id and name only. Nothing here lets the key act on a neighbour: every write still lands in the key’s own environment. The platform does not record which environment is production, so that is not reported either.

Use it to pick a deliveryEnvironmentId before publishing when there is more than one delivery target, and to learn whether content you write here is inherited by, or promoted into, other environments.

Key: a management key with content.management.read.

Authorizations

apiKey

Responses

200

{ "environment": { "id", "name", "kind": "authoring" }, "publishesTo": [ { "id", "name" } ], "promotesTo": [ … ], "promotedFrom": [ … ], "inheritsFrom": { "id", "name" } | null, "inheritedBy": [ … ] }. Lists are empty rather than absent, and ordered the way the environments are ordered in Content.

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

402

payment_required: the organization’s subscription needs attention.

403

scope_denied: the key lacks this route’s scope. tier_required: the Content Management API needs the Pro plan or above. ip_denied: the caller’s address is outside the key’s allowed ranges. app_not_available: Content is not enabled for the organization.

429

Rate limit or quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.