API Reference for Releases
This reference page describes the usage of REST API for Release management. Get instructions on how to create a release, create and update deployment, and more.
Last updated
Was this helpful?
This reference page describes the usage of REST API for Release management. Get instructions on how to create a release, create and update deployment, and more.
Last updated
Was this helpful?
This document describes the usage of REST API for Release management. You can also use for composite queries.
POST
/api/releases/<project_name>/releases/<release_candidate_version>
This creates a new and an associated with the provided commit SHA.
Parameters
project_name
release_candidate_version
Release candidate version string represented as: release-version-rcX
when X is an integer. Note that -rcX
is a required suffix for a validate release candidate version.
Headers
Content-Type
application/json
Authorization
Bearer <token>
Body
repo
String
Repository associated with the Release. String of the format: org/repo_name
commit
String
Head commit SHA to cut a release at.
trigger_build_workflow
Boolean. Optional
If set to true
, it will start a build action that is configured in the settings. When set to false, the release candidate is created and marked as ready without triggering the build action. Default is false
.
Response
If successful, HTTP 201 response is returned back.
POST
/api/releases/<project_name>/environments/<env_name>/deployments
Headers
Content-Type
application/json
Authorization
Bearer <token>
Parameters
project_name
env_name
Body
release_candidate_version
String
Response
If successful, HTTP 201 response is returned back.
PATCH
/api/releases/<project_name>/environments/<env_name>/deployments
This can be used for a custom CD pipeline to send the deployment status to Aviator.
Headers
Content-Type
application/json
Authorization
Bearer <token>
Parameters
project_name
env_name
Body
release_candidate_version
string
status
string
Possible values:
- pending
- in_progress
- failure
- canceling
- canceled
- unknown
Response
If successful, HTTP 200 response is returned back. The API returns a 200 response even when a new deployment is created.
Name of the . Case sensitive.
This creates a new for the provided and . This workflow will also trigger the appropriate deployment workflow configured for that environment.
Name of the . Case sensitive.
Name of the within the Release Project. Case sensitive.
Release candidate version associated with the that will be deployed. String represented as: release-version-rcX
when X is an integer. Note that -rcX
is a required suffix for a validate release candidate version.
Update the status of the 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.
Name of the . Case sensitive.
Name of the within the Release Project. Case sensitive.
Release candidate version associated with the that will be deployed. String represented as: release-version-rcX
when X is an integer. Note that -rcX
is a required suffix for a validate release candidate version.