Get the API catalog that lists this server's HTTP APIs
Public RFC 9727 linkset naming the public API and the organization API, each with the OpenAPI document this server serves and its documentation, at this...
Warning
Not fully described yet. The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.
GET/.well-known/api-catalog
- Sign-in
- None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
- Rate limit
- Up to 120 requests a minute per IP address.
Public RFC 9727 linkset naming the public API and the organization API, each with the OpenAPI document this server serves and its documentation, at this install's own URL. The same for every organization; cacheable for five minutes.
Request
This operation takes no parameters and no body.
Example request
Replace each YOUR_... value with your own.
curl -X GET "https://api.console.buildbase.app/.well-known/api-catalog"const response = await fetch(
'https://api.console.buildbase.app/.well-known/api-catalog',
{
method: 'GET',
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();import requests
response = requests.get(
"https://api.console.buildbase.app/.well-known/api-catalog",
timeout=30,
)
response.raise_for_status()
data = response.textResponses
A successful answer is not described yet. The server answers with the status and body its handler sends.
Any other status
The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).
Errors
Each refusal, what it means, and what to do. The request changed nothing.
429 Too Many Requests
What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.
What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- Discovery guide: how this part of BuildBase works
- All Discovery operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
discovery.apiCatalog.getin public-v1.json