REST API

Fetch data and automate your workflows with the Continuous Delivery REST API. Use the API to promote pipelines based on your own criteria and automate workspace setup to make onboarding new users more streamlined.

The Continuous Delivery REST API uses the OpenAPI standard to define and document the API via a specification. The OpenAPI Initiative has extensive documentation of the standard which can be followed. Continuous Delivery uses version 3.0.1 of the standard.

If you are familiar with REST and OpenAPI, skip to the OpenAPI specification section for more specific details on how Continuous Delivery implements OpenAPI.

• Authenticate public APIs
  The Continuous Delivery API supports authentication via personal access tokens associated with Continuous Delivery accounts. Authentication tokens are tied to the permissions granted to the user through role-based access control (RBAC), and they provide the user with the appropriate access to application programming interfaces (APIs).
• REST API tutorial
  Learn how to navigate a Continuous Delivery workflow entirely through the API using curl and bash.
• OpenAPI specification
  Continuous Delivery includes the OpenAPI specification and it can be fetched from the web server from the following endpoint: curl --request GET “https://<hostname>/cd4pe/api/openapi.yaml”
• Common API workflows
  Continuous Delivery’s API enables users to automate many common workflows.