GET /obp/v7.0.0/management/banks/BANK_ID/domain-apis/DOMAIN_API_ID

One Domain API of a space.

A Domain API publishes the Dynamic Entities and Dynamic Resource Docs (Dynamic Queries included) of one space under a base path of its own, without OBP's own URL structure in front of them: with the base path carbon-registry/v1 over the system space, /carbon-registry/v1/activity answers what /obp/v7.0.0/banks/SYS/dynamic-entities/activity answers, and /carbon-registry/v1/openapi.yaml (or openapi.json) is its OpenAPI document. It only renames: every call runs the same authentication, Roles and access checks as the OBP URL, and a Dynamic Entity record response leaves out bank_id.

BANK_ID is the space: a bank's id, or SYS for the system space. The Role is checked at that BANK_ID.

is_publicly_discoverable says whether anyone, without logging in, may find the Domain API through GET /obp/v7.0.0/banks/BANK_ID/domain-apis. It is false when left out on create and keeps its current value when left out on update. It only controls that listing: the calls under the base path and the OpenAPI document are served the same either way.

base_path is two to five segments of lowercase letters, digits, hyphens and dots, ending with the major version as vN, and must not overlap another Domain API's. version is the full semantic version, MAJOR.MINOR.PATCH, whose MAJOR is the N of the base path: a compatible change edits version and leaves every URL alone, and a breaking change gets a new Domain API with a new base path.

A Domain API is refused while two endpoints of its space are ambiguous with each other under it: a Dynamic Resource Doc whose path starts with a path variable, with the name of one of the space's Dynamic Entities or with a segment the Dynamic Entity URLs or the documentation use (my, public, community, openapi.json, openapi.yaml), or two docs of one verb that would match one request. Creating or changing a Dynamic Entity or Dynamic Resource Doc that would cause one is refused in every space, so this only happens to a space that held one before that rule.

On this instance a change is seen at once by the node that made it, and by the others within 10 seconds.

For more information see here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

DOMAIN_API_ID: DOMAIN_API_ID

{ "domain_api_id": "5f4a1c8e-2b7d-4e9a-9c3f-1d2e3f4a5b6c", "bank_id": "SYS", "base_path": "carbon-registry/v1", "version": "1.0.0", "title": "Open Carbon Registry API", "description": "Activities and land parcels of the registry.", "is_publicly_discoverable": true, "url": "https://api.example.org/carbon-registry/v1", "openapi_url": "https://api.example.org/carbon-registry/v1/openapi.yaml", "created_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "created_at": "2026-10-21T01:45:41Z", "updated_at": "2026-10-21T01:45:41Z" }