Using
Returns metadata for a single relational domain. Needs a permission on the domain (admin keys always pass). A domain in `deleting` state answers 410 Gone (a background purge removes the data later).
applies to v0.5.1GET
/store-api/rel/domains/{name}
const url = 'https://example.com/store-api/rel/domains/example';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/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”name
required
string
Relational domain name
Responses
Section titled “Responses”Domain found
Media typeapplication/json
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"}Forbidden — no permission on the domain (also when it does not exist)
Media typetext/plain
string
Domain not found
Media typetext/plain
string
Domain is being deleted (background purge running)
Media typetext/plain
string
Relational engine disabled
Media typetext/plain
string