API Overview
The Self-Service Portal offers a REST API so that applications, scripts and DevOps pipelines can request and manage certificates without using the web pages. Anything that can be done in the portal for certificates, such as submitting a CSR, searching the inventory, renewing or revoking, can be automated through the API.
The API uses REST over HTTPS, with JSON requests and responses. Every call is authenticated with an API token sent in the request header. The token carries the same roles and permissions as the user or service account that owns it, so the API cannot do more than that account could do in the portal, and every API call is recorded in the portal logs.
The full list of endpoints, request fields and example calls is published on the interactive Swagger (OpenAPI) page, which is available from the portal. Its URL is shared with the customer's administrators during onboarding. The Swagger page can also be used to try calls directly with a token.