API Documentation
Configure8 API documentation
The Configure8 API is based on REST architecture style. Our API uses standard HTTP verbs, codes and authentication.
Configure8 API is protected by API keys. In order to use our API, you need to set up a key with appropriate scopes and role. You can refer to the API keys management section in our documentation to check out more detailed information.
Please make sure that you are not exposing your API keys. Keep them secure and do not share them publicly!
Configure8 API keys start with
c8ak prefix, so they support secret scanning (i. e. Github secret scanning) to help you to avoid exposing API keys.Authentication is performed via
Api-Key Header. All API calls must be authenticated and made over HTTPS.curl https://app.configure8.io/public/v1/catalog/entities \
--header "Api-Key: my_api_key"
As for errors, Configure8 API uses standard HTTP status codes. Below you see the most common status codes and possible reasons.
Status code | Description |
|---|---|
2xx | OK |
400 | Bad request. Possible reason - malformed request (i.e. body, params). |
401 | Unauthorised. The API key is invalid or was not provided. |
403 | Forbidden. The does not have enough permissions to perform this operation. |
404 | Not found. Requested entity is not found. |
5xx | Configure8 internal server error. |
Endpoints that return multiple items (e. g.
/public/v1/catalog/entities) contain pagination for more convenient usage. It is based on such properties: pageNumber, pageSize and sort.Property | Default | Description |
|---|---|---|
pageNumber | 0 | Page to return. Offset to return is calculated based on pageNumber * pageSize |
pageSize | 20 | Number of items to return |
sort | Sorted by name in ascending order | Sorting of items is defined by this structure:
{
property: 'propertyToSortOn',
order: 'ASC' | 'DESC'
} |
Oops, something is missing.
We could not find the original source to display this content.
Oops, something is missing.
We could not find the original source to display this content.
Oops, something is missing.
We could not find the original source to display this content.
Last modified 1mo ago