Cloud
Jira Service Management ops / Reference / REST API

Integrations

Postman Collection
OpenAPI

This resource represents Integrations in Jira Service Management. Use it to get, list, create, update, or delete integrations.

Operations
GET/v1/integrationsPOST/v1/integrationsGET/v1/integrations/{id}DEL/v1/integrations/{id}PATCH/v1/integrations/{id}
GET

List integrationsExperimental

Returns all integrations that user can view.

Permissions required: Permission to access Jira Service Management; however, the list contains an integration if:

  • the user has read-only administrative right.
  • the integration's assigned team is one of the teams that the user belongs to.
OAuth 2.0 scopes required:
read:ops-config:jira-service-management

Request

Query parameters

type

string

teamId

string

name

string

offset

integer

size

integer

Responses

Returned if the request is successful.

application/json

Integrations
GET/v1/integrations
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 { "links": { "next": "/v1/integrations?offset=8&size=2", "previous": "/v1/integrations?offset=4&size=2" }, "values": [ { "id": "22334455-1288-414d-b0cc-e725ba3331f7", "name": "amazon rds integration - Team B", "type": "AmazonRds", "enabled": true, "teamId": "8ae8a0a2-1122-5566-8899-11b82bbd85c9" }, { "id": "12fa0a15-1288-414d-b0cc-e725ba3331f7", "name": "solarwinds integration - team A", "type": "SolarwindsMSPNCentral", "enabled": false, "teamId": "005564cf-1122-5566-8899-fa8ed200bdf6" } ] }
POST

Create integrationExperimental

Creates an integration. It can be team or global integration by using teamId in the payload.

Permissions required: Permission to create an integration:

  • the user has edit configuration right.
  • the user is the admin of the team that the integration belongs to.


Slack and Microsoft Teams types of integration are not supported for this operation.

OAuth 2.0 scopes required:
read:ops-config:jira-service-management
,
write:ops-config:jira-service-management

Request

Request bodyapplication/json

name

string

Required
type

string

Required
description

string

enabled

boolean

teamId

string

typeSpecificProperties

object

Responses

Returned if the request is successful.

application/json

Integration
POST/v1/integrations
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "Email Integration A", "type": "Email", "description": "A Sample of Email Integration", "enabled": true, "teamId": "8ae8a0a2-1122-5566-8899-11b82bbd85c9", "typeSpecificProperties": { "emailUsername": "email-integration-test1", "suppressNotifications": false } }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "id": "72719124-9933-5566-8899-33b829756765", "name": "Email Integration A", "type": "Email", "description": "A Sample of Email Integration", "enabled": true, "teamId": "8ae8a0a2-1122-5566-8899-11b82bbd85c9", "typeSpecificProperties": { "emailUsername": "email-integration-test1", "suppressNotifications": false } }
GET

Get integrationExperimental

Returns the integration details.

Permissions required: Permission to access to the integration:

  • the user has read-only administrative right.
  • the integration's assigned team is one of the teams that the user belongs to.
OAuth 2.0 scopes required:
read:ops-config:jira-service-management

Request

Path parameters

id

string

Required

Responses

Returned if the request is successful.

application/json

IntegrationResponse
GET/v1/integrations/{id}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "id": "33224455-1122-5566-8899-11b82bbd85c9", "type": "Webhook", "name": "emelk webhook Sample", "enabled": false, "teamId": "8ae8a0a2-1122-5566-8899-11b82bbd85c9", "advanced": true, "maintenanceSources": [], "directions": [ "outgoing" ], "domains": [ "alert" ], "typeSpecificProperties": { "addAlertDetails": false, "headers": {}, "addAlertDescription": false, "outgoingSettingsEnabled": false, "forwardingActionGroupEnabled": true, "url": "" } }
DEL

Delete integrationExperimental

Deletes an integration.

Permissions required: Permission to delete the integration:

  • the user has read-only administrative right.
  • the user is the admin of the team that the integration belongs to.
OAuth 2.0 scopes required:
read:ops-config:jira-service-management
,
delete:ops-config:jira-service-management

Request

Path parameters

id

string

Required

Responses

Returned if the request is successful.

DEL/v1/integrations/{id}
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations/{id}' \ --user 'email@example.com:<api_token>'
PATCH

Update integrationExperimental

Updates an integration.

Permissions required: Permission to update the integration:

  • the user has read-only administrative right.
  • the user is the admin of the team that the integration belongs to.
OAuth 2.0 scopes required:
read:ops-config:jira-service-management
,
write:ops-config:jira-service-management

Request

Path parameters

id

string

Required

Request bodyapplication/json

name

string

enabled

boolean

description

string

teamId

string

typeSpecificProperties

object

Responses

Returned if the request is successful.

application/json

Integration
PATCH/v1/integrations/{id}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "Webhook Integration A", "enabled": true, "description": "A Sample of Webhook Integration", "teamId": "8ae8a0a2-1122-5566-8899-11b82bbd85c9", "typeSpecificProperties": { "addAlertDetails": false, "headers": {}, "addAlertDescription": false, "outgoingSettingsEnabled": false, "forwardingActionGroupEnabled": true, "url": "http://asd.com" } }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "id": "33224455-1122-5566-8899-11b82bbd85c9", "type": "Webhook", "name": "emelk webhook Sample", "enabled": false, "teamId": "8ae8a0a2-1122-5566-8899-11b82bbd85c9", "typeSpecificProperties": { "addAlertDetails": false, "headers": {}, "addAlertDescription": false, "outgoingSettingsEnabled": false, "forwardingActionGroupEnabled": true, "url": "http://asd.com" } }

Rate this page: