Ceptor Agent REST API

Ceptor Agent REST API is available as an API Deployed on Ceptor Internal Gateway.

Ceptor Internal Gateway is a specific gateway instance provided in the example configuration distributed with Ceptor. This instance exposes all the Ceptor REST APIs.

If a new installation is setup not to use the example configuration and use a new database, the Ceptor APIs can be imported using the import/export feature from the "Ceptor_apis.zip" file in the samples folder. Afterwards the APis can be published on the internal gateway.

Authentication to it is by default provided using basicauth with the same credentials as the Ceptor Console uses - the ones defined in the config server.
This authentication can be customized by changing the Ceptor Internal Gateway session resolver configuration.

OpenAPI specification for Agent API:

Open API (Swagger) Documentation is only supported by the cloud editor

Because Forge macros arent supported by the legacy editor, you'll need to convert this content to the cloud editor to display this macro properly. Find out more about converting to the cloud editor