Cloud
Jira Service Management ops / Reference / REST API

Syncs

Postman Collection
OpenAPI

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

GET

List syncsExperimental

Lists syncs according to the provided filters.

  • The user should have view permission for syncs.

Request

Query parameters

type

string

teamId

string

offset

string

size

string

Responses

Returned if the request is successful

application/json

Syncs
GET/v1/syncs
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs' \ --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/syncs?offset=8&size=2", "previous": "/v1/syncs?offset=4&size=2" }, "values": [ { "id": "22334455-1288-414d-b0cc-e725ba3331f7", "name": "Jira Exmaple", "type": "jira-software-cloud", "enabled": true, "teamId": "8ae8a0a2-1122-5566-8899-11b82bbd85c9" }, { "id": "12fa0a15-1288-414d-b0cc-e725ba3331f7", "name": "JSM Example", "type": "jira-service-management-cloud", "enabled": false, "teamId": "005564cf-1122-5566-8899-fa8ed200bdf6" } ] }
POST

Create syncExperimental

Creates a sync for syncing alerts created and issues in a selected project.

  • The user should have sync creation permission.

Request

Request bodyapplication/json

name

string

Required
description

string

enabled

boolean

teamId

string

type

string

properties

object

Responses

Returned if the request is successful

application/json

SyncMetadata

List of syncs.

POST/v1/syncs
1 2 3 4 5 6 7 8 9 10 11 12 13 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "description": "<string>", "enabled": true, "teamId": "<string>", "type": "<string>", "properties": {} }'
200Response
1 2 3 4 5 6 7 { "id": "12fa0a15-1288-414d-b0cc-e725ba3331f7", "name": "JSM Example", "type": "jira-service-management-cloud", "enabled": true, "teamId": "005564cf-1122-5566-8899-fa8ed200bdf6" }
GET

Get syncExperimental

Returns the sync.

Request

Path parameters

id

string

Required

Responses

Returned if the request is successful

application/json

Sync
GET/v1/syncs/{id}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{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 { "id": "12fa0a15-1288-414d-b0cc-e725ba3331f7", "name": "JSM Example", "type": "jira-service-management-cloud", "description": "A Sample of JSM Sync", "enabled": true, "typeSpecificProperties": { "connectionId": "dfd0441e-c86b-4011-bd54-7b6717f45b61", "projectKey": "JE", "forwardingActionGroupEnabled": false, "updatingActionGroupEnabled": true, "suppressNotifications": false } }
DEL

Delete syncExperimental

Deletes a sync.

  • The user should have delete permission for sync.

Request

Path parameters

id

string

Required

Responses

Returned if the request is successful

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

Update syncExperimental

Updates a sync.

  • The user should have edit permission for sync.

Request

Path parameters

id

string

Required

Request bodyapplication/json

name

string

description

string

enabled

boolean

teamId

string

properties

object

Responses

Returned if the request is successful

application/json

SyncMetadata

List of syncs.

PATCH/v1/syncs/{id}
1 2 3 4 5 6 7 8 9 10 11 12 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "description": "<string>", "enabled": true, "teamId": "<string>", "properties": {} }'
200Response
1 2 3 4 5 6 7 { "id": "12fa0a15-1288-414d-b0cc-e725ba3331f7", "name": "JSM Example", "type": "jira-service-management-cloud", "enabled": true, "teamId": "005564cf-1122-5566-8899-fa8ed200bdf6" }