Skip to main content

Retrieve a domain

GET 
/api/v1/domains/:domain_uuid

Returns a single domain the caller is allowed to access.

Access rules:

  • If the user has the domain_all permission, any domain may be retrieved.
  • If the user has assigned domain groups or individual domains, the domain must be in those assignments (even if the user's own domain is not included).
  • If nothing is assigned, the user may only retrieve their own domain.

Notes:

  • If the domain does not exist, a resource_missing error is returned.
  • If the domain exists but is not accessible, a forbidden_domain error is returned.

Request​

Responses​

Success