Apis related to the backlog

Apis related to boards

APIs related to integrating builds data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the Build module see https://developer.atlassian.com/cloud/jira/software/modules/build/ in your app's descriptor. 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/.

APIs related to integrating deployments data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the Deployment module see https://developer.atlassian.com/cloud/jira/software/modules/deployment/ in your app's descriptor. 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/.

APIs related to integrating development information (commits, branches and pull requests) with Jira. These APIs are available to Atlassian Connect apps and on-premise integrations using OAuth. Connect apps using these APIs must have the Development Tool module in the app descriptor, see https://developer.atlassian.com/cloud/jira/software/modules/development-tool/. For more details on 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/.

APIs related to integrating Dev Ops Components affected by Incident data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the DevOps Component module in your app's descriptor. Read more about Jira Software modules here.

Module

The DevOps Component module allows third-party providers to add devops components through a public REST API.

Supplied devops components information will be used by the Connection Manager tab in Jira to allow users to associate devops components with Jira projects. All incident and PIR information related to that devops component will be presented in the Incidents page in Jira Software, and as a link to any issues created via the Incidents Page.

This module also provides actions, two will be used by Jira to let the provider know when the devops component has been associated or disassociated with a Jira project, and two can be used by the Provider to associate a devops component with a Jira Issue.

Note that the module key and name are not private and therefore should not contain any sensitive or personally identifiable information.

Example Module

An example can also be found at jira-data-provider-sample-addon, which has an atlassian-connect.json.

{
  "modules": {
    "jiraDevOpsComponentProvider": {
      "homeUrl": "https://my-operations-provider.com",
      "logoUrl": "https://my-operations-provider.com/images/logo.svg",
      "documentationUrl":
"https://my-operations-provider.com/docs/jira-integration",
      "actions": {
        "associateEntity": {
            "templateUrl": "/components/associate"
        },
        "disassociateEntity": {
            "templateUrl": "/components/disassociate"
        },
        "onEntityAssociated": {
            "templateUrl": "/components/associate"
        },
        "onEntityDisassociated": {
            "templateUrl": "/components/disassociate"
        }
      },
      "name": {
        "value": "My DevOps Component Provider"
      },
      "key": "devops-component-integration"
    }
  }
}
Copy

Properties

| Property | type | Description

| Required | |------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------| | key | string | A key to identify this module. Must match ^[a-zA-Z0-9-]+$ pattern, with a max length of 100 | Yes | | name | object (i18N) | A human readable name. This object supports internationalization. | Yes | | homeUrl | string | URL to the provider’s homepage

| Yes | | logoUrl | string | Optional URL to the provider’s logo, which will be displayed in the UI | | | documentationUrl | string | Optional URL to documentation about the provider’s Jira integration | | | actions | object | Actions the can be used by Jira to improve the integrated experience | Yes |

Actions object

| Property | type | Description

| Required | |------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| | associateEntity | object | An action defined by the provider to allow Jira to retrieve details about operations workspaces via a post endpoint.

| Yes | | disassociateEntity | object | An action defined by the provider to allow Jira to search using details about operations workspaces via a get endpoint.

| Yes | | onEntityAssociated | object | An action defined by the provider to allow Jira to create a new operations container via a post endpoint.

| | | onEntityDisassociated | object | An action defined by the provider to allow Jira to create a new Post-Incident Review object via a post endpoint.

| |

Apis related to epics

Apis related to integrating Feature Flags with Jira Software. These apis are only available to Atlassian Connect apps. To use these apis you must have the Feature Flag module (see https://developer.atlassian.com/cloud/jira/software/modules/feature-flag/) in your app's descriptor

Apis related to issues

APIs related to integrating Incident and Post-Incident Review (PIR) data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the Operations module in your app's descriptor. Read more about Jira Software modules here.

Module

The Operations module allows third-party providers to add incident and PIR information through a public REST API.

Supplied incident information will be presented in the Incidents page in Jira Software, and as a link to any issues created via the Incidents Page.

This module also provides actions, one which allows Jira to provide a direct link to the operations provider where the user can create a post-incident review and two which allow Jira to search for relevant workspaces and devops components.

Note that the module key and name are not private and therefore should not contain any sensitive or personally identifiable information.

Example Module

An example can also be found at jira-data-provider-sample-addon, which has an atlassian-connect.json.

{
  "modules": {
    "jiraOperationsInfoProvider": {
      "homeUrl": "https://my-operations-provider.com",
      "logoUrl": "https://my-operations-provider.com/images/logo.svg",
      "documentationUrl":
"https://my-operations-provider.com/docs/jira-integration",
      "actions": {
          "fetchWorkspaces": {
              "templateUrl": "/workspaces/list"
          },
          "searchContainers": {
              "templateUrl": "/containers/search"
          },
          "createPostIncidentReview": {
              "url":
"https://my-operations-provider.com/my-workspace/create-post-incident-review?affected-component={component-id}&incident={incident-id}
          }
      },
      "name": {
        "value": "My Operations Provider"
      },
      "key": "operations-integration"
    }
  }
}
Copy

Properties

| Property | type | Description

| Required | |------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------| | key | string | A key to identify this module. Must match ^[a-zA-Z0-9-]+$ pattern, with a max length of 100 | Yes | | name | object (i18N) | A human readable name. This object supports internationalization. | Yes | | homeUrl | string | URL to the provider’s homepage

| Yes | | logoUrl | string | Optional URL to the provider’s logo, which will be displayed in the UI | | | documentationUrl | string | Optional URL to documentation about the provider’s Jira integration | | | actions | object | Actions the can be used by Jira to improve the integrated experience | Yes |

Actions object

| Property | type | Description

| Required | |------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| | fetchWorkspaces | object | An action defined by the provider to allow Jira to retrieve details about operations workspaces via a post endpoint.

| Yes | | searchContainers | object | An action defined by the provider to allow Jira to search using details about devops components via a get endpoint.

| Yes | | createPostIncidentReview | object | An action defined by the provider to allow Jira to create a new Post-Incident Review object via a post endpoint.

| |

APIs related to integrating Remote Links data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the Remote Link module in your app's descriptor. Read more about Jira Software modules here.

Module

The Remote Link module allows third-party providers to add a generic link through a public REST API and associate it with Jira issues or services.

Supplied remote link information will be presented in the right sidebar of the new Jira issue view under Releases.

This module also provides actions, which allows users to perform an action on the remote link.

Note that the module key and name are not private and should therefore not contain any sensitive or personally identifiable information.

Example Module

An example can also be found at jira-data-provider-sample-addon, which has an atlassian-connect.json.

{
  "modules": {
    "jiraRemoteLinkInfoProvider": {
      "homeUrl": "https://my-remotelink-provider.com",
      "logoUrl": "https://my-remotelink-provider.com/images/logo.svg",
      "documentationUrl":
"https://my-remotelink-provider.com/docs/jira-integration",
      "actions": [
        {
          "actionId": "action-1",
          "actionLabel": {
            "value": {
              "value": "Acknowledge"
            }
          },
          "templateUrl": "https://my-remotelink-provider.com/ack/{ack-id}"
        }
      ],
      "name": {
        "value": "My Remote Link Provider"
      },
      "key": "remotelink-integration"
    }
  }
}
Copy

Properties

| Property | type | Description

| Required | |------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------| | key | string | A key to identify this module. Must match ^[a-zA-Z0-9-]+$ pattern, with a max length of 100 | Yes | | name | object (i18N) | A human readable name. This object supports internationalization. | Yes | | homeUrl | string | URL to the provider’s homepage

| Yes | | logoUrl | string | Optional URL to the provider’s logo, which will be displayed in the UI | | | documentationUrl | string | Optional URL to documentation about the provider’s Jira integration | | | actions | object | Optional actions that can be performed by Jira users on the remote link

Actions object

| Property | type | Description

| Required | |-------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| | actionId | string | A key to identify a specific action. Used for associating a specific Remote link to an action of this ID.
The actionId of an action must be unique across all actions. | Yes | | actionLabel | object | The actionLabel of an Action is shown visibly to the User alongside the Remote Link.

| Yes | | templateUrl | string | The templateUrl of an Action is a template where strings can be substituted into the URL for a specific Remote Link.
Strings used in the templateUrl must be passed in via an attribute map when associating an action with a remote link. | Yes |

ActionLabel Object

| Property | type | Description

| Required | |----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------| | value | object (i18n) | The label shown on the UI. This object supports internationalization. | Yes |

Send security information to Jira Software and enable your teams to turn unplanned vulnerabilities into planned and tracked work.

Security is everyone's responsibility, and the security feature in Jira lets you triage and track relevant vulnerabilities as a team. Discuss and prioritise issues, minimise errors and duplication, and plan security work to complete in your sprints.

APIs related to integrating Security information with Jira Software are available to Atlassian Connect apps. To use these APIs you must have the Security module in your app's descriptor. Read more about Jira Software modules here.

Apis related to sprints