API Documentation
Configure8 API documentation
The Configure8 API is based on the REST architecture style. The API uses standard HTTP verbs, codes, and authentication. Endpoints accept and return JSON-encoded data.
Authentication
API keys protect the Configure8 API. You must set up a key with appropriate scopes and roles to use our API. Refer to our documentation's API keys management section for 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 a prefix, so they support secret scanning (i.e., Github secret scanning) to help you avoid exposing API keys.
Authentication is performed via Api-Key Header. All API calls must be authenticated and made over HTTPS.
Errors
As for errors, Configure8 API uses standard HTTP status codes. Below, you see the most common status codes and possible reasons.
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.
409
Conflict. Usually caused by duplicating names in resources, incorrect template usage on entity creation etc.
422
Unprocessable entity. The request syntax is correct, but there is a business logic error from the client's side.
5xx
Configure8 internal server error.
Pagination
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.
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
The sorting of items is defined by this structure:
{
property: 'propertyToSortOn',
order: 'ASC' | 'DESC'
}
Last updated