API Reference
This document describes the usage of REST API for Release management. You can also use GraphQL API for composite queries.
Create a Release
POST
/api/releases/<project_name>/releases/<release_candidate_version>
This creates a new Release and an associated Release Candidate with the provided commit SHA.
Parameters
Headers
Body
Response
If successful, HTTP 201 response is returned back.
Create a Deployment
POST
/api/releases/<project_name>/environments/<env_name>/deployments
This creates a new Deployment for the provided Release Candidate and Environment. This workflow will also trigger the appropriate deployment workflow configured for that environment.
Headers
Parameters
Body
Response
If successful, HTTP 201 response is returned back.
Update Deployment status
PATCH
/api/releases/<project_name>/environments/<env_name>/deployments
Update the status of the Deployment once it's created. If a Deployment doesn't already exist for the given Release Candidate version and the Environment, a new deployment is also created.
This can be used for a custom CD pipeline to send the deployment status to Aviator.
This method does not trigger the configured deployment workflow.
Headers
Parameters
Body
Response
If successful, HTTP 200 response is returned back. The API returns a 200 response even when a new deployment is created.
Last updated