Get Publicly Discoverable Domain APIs
GET /obp/v7.0.0/banks/BANK_ID/domain-apis
OBPv7.0.0-getPubliclyDiscoverableDomainApis No role required DynamicAPI
The Domain APIs of a space whose owners made them publicly discoverable (is_publicly_discoverable),
so that an app or a person can find where a space's API is published and its OpenAPI document without
logging in. A Domain API that is not publicly discoverable is left out, though its base path still serves.
Each one gives its base path, version, title and description, its url (this instance's host followed by
the base path) and its openapi_url; openapi.json beside it is the same document as JSON.
BANK_ID is the space: a bank's id, or SYS for the system space.
No Authentication is Required.
For more information see here
User Authentication is Optional. The User need not be logged in.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields (8)
- bank_id
- gh.29.uk
- base_path
- base_path
- description
- Description of the object. Maximum length is 2000. It can be any characters here.
- domain_apis
- domain_apis
- openapi_url
- openapi_url
- title
- Dr.
- url
- http://www.example.com/id-docs/123/image.png
- version
Example success response
{
"domain_apis": [
{
"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.",
"url": "https://api.example.org/carbon-registry/v1",
"openapi_url": "https://api.example.org/carbon-registry/v1/openapi.yaml"
}
]
}Possible errors (2)
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.