# Jira Deployments API

**Canonical:** https://apis.io/apis/jira/jira-deployments-api/  
**Provider:** Jira — https://apis.io/providers/jira/  
**Base URL:** https://your-domain.atlassian.net/rest/api/2  
**Documentation:** https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/

Jira Deployments API is one of 132 APIs that [Jira](https://apis.io/providers/jira/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

APIs related to integrating deployment data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the `jiraDeploymentInfoProvider` module in your Connect app's descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/deployment/. They are also related to integrating Jira Software Cloud with on-premises tools using OAuth 2.0 credentials. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/. These APIs are available to Forge apps with the `devops:deploymentInfoProvider` module in the Forge app's manifest. See https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-deployment-info/.

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| POST | `/rest/deployments/0.1/bulk` | Submit deployment data |
| DELETE | `/rest/deployments/0.1/bulkByProperties` | Delete deployments by Property |
| GET | `/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}` | Get a deployment by key |
| DELETE | `/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}` | Delete a deployment by key |
| GET | `/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}/gating-status` | Get deployment gating status by key |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-deployments-api-openapi.yml
- **Documentation** — https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
- **Authentication** — https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#authentication
- **Documentation** — https://developer.atlassian.com/cloud/jira/software/rest/intro/
- **Documentation** — https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/
- **APIReference** — https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/

## Other Jira APIs (12)

- [Jira Cloud Platform REST API v2](https://apis.io/apis/jira/jira-cloud-platform-rest-api-v2/)
- [Jira Service Management Operations REST API](https://apis.io/apis/jira/jira-service-management-operations-rest-api/)
- [Jira Align REST API](https://apis.io/apis/jira/jira-align-rest-api/)
- [Jira Customer Service Management REST API](https://apis.io/apis/jira/jira-customer-service-management-rest-api/)
- [Jira Issue Comments API](https://apis.io/apis/jira/jira-issue-comments-api/)
- [Jira Issue Priorities API](https://apis.io/apis/jira/jira-issue-priorities-api/)
- [Jira Issue Search API](https://apis.io/apis/jira/jira-issue-search-api/)
- [Jira Issue Statuses API](https://apis.io/apis/jira/jira-issue-statuses-api/)
- [Jira Issue Transitions API](https://apis.io/apis/jira/jira-issue-transitions-api/)
- [Jira Issue Types API](https://apis.io/apis/jira/jira-issue-types-api/)
- [Jira Issues API](https://apis.io/apis/jira/jira-issues-api/)
- [Jira Projects API](https://apis.io/apis/jira/jira-projects-api/)

## Tags

Deployment

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/jira/jira-deployments-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/jira/.