Jira

Jira Deployments API

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/.

GitHub OpenAPI
Business capability
Deployment Orchestration BC-4210.40

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /rest/deployments/0.1/bulk Send deployment data to Jira · Submit deployment data #
Ask an LLM
“How do I report deployments from my CI/CD pipeline so they show on Jira issues?”
“Does submitting a deployment with the same pipeline, environment and sequence number overwrite it?”
Tell an agent
Submit deployments {deployments} to Jira.
Send deployment data {deployments} with provider metadata {providerMetadata}.
DELETE /rest/deployments/0.1/bulkByProperties Delete all deployments matching given properties · Delete deployments by Property #
Ask an LLM
“Can I wipe every deployment tagged with a certain property?”
“Which deployments get removed when I bulk delete by property?”
Tell an agent destructive · confirm first
Delete all deployments that match the properties I pass as query parameters.
Bulk delete deployments by property using update sequence number {_updateSequenceNumber}.
GET /rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber} Get a stored deployment by its key · Get a deployment by key #
Ask an LLM
“What deployment data does Jira currently hold for a pipeline run?”
“Can I read back a deployment I submitted using its pipeline, environment and sequence number?”
Tell an agent
Get deployment {deploymentSequenceNumber} in environment {environmentId} of pipeline {pipelineId}.
Show the stored data for pipeline {pipelineId}, environment {environmentId}, deployment {deploymentSequenceNumber}.
DELETE /rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber} Delete one deployment by its key · Delete a deployment by key #
Ask an LLM
“How do I delete a single deployment record from Jira?”
“Is deleting a deployment by key immediate or asynchronous?”
Tell an agent destructive · confirm first
Delete deployment {deploymentSequenceNumber} in environment {environmentId} of pipeline {pipelineId}.
Remove the stored deployment for pipeline {pipelineId}, environment {environmentId}, sequence {deploymentSequenceNumber}.
GET /rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}/gating-status Check a deployment's gating status · Get deployment gating status by key #
Ask an LLM
“Is my deployment currently gated or allowed to proceed?”
“Can my deployment provider app check the gating status of a deployment?”
Tell an agent
Get the gating status of deployment {deploymentSequenceNumber} in environment {environmentId} of pipeline {pipelineId}.
Check whether pipeline {pipelineId} deployment {deploymentSequenceNumber} to {environmentId} is gated.

Documentation

📖
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/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-deployments-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jira:jira-deployments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jira-deployments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    url: https://getsupport.atlassian.com
  description: Jira Software Cloud REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://atlassian.com/terms/
  title: Jira Software Cloud Deployments API
  version: 1001.0.0
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-deployments-api-openapi.yml