Using

Returns the active relational domains. Admin keys see all of them; any other key sees only the relational domains it has a permission on (an empty list without any).

applies to v0.5.1

GET

/store-api/rel/domains

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

Authorizations

bearer_auth

Responses

200

List of the active relational domains the key may access

application/json

Array<object>

object

created_at

required

Creation timestamp (Unix seconds).

integer format: int64

name

required

string

state

required

Lifecycle state: “active” or “deleting” (background purge running). Always present — so a later list_domains visibility change (surfacing Deleting domains too) needs no REST-contract change.

string

Example ^generated

[
  {
    "created_at": 1,
    "name": "example",
    "state": "example"
  }
]

503

Relational engine disabled

text/plain

string

Returns the active relational domains. Admin keys see all of them; any other key sees only the relational domains it has a permission on (an empty list without any).

Authorizations

Responses

200

Example generated

503

Example ^generated