ATatlassian
Syncs

Get sync

Returns the sync.

get/api/{cloudId}/v1/syncs/{id}

Request

  • Base URL
    https://api.atlassian.com/jsm/ops
  • URL
    https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/syncs/{id}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.stg.atlassian.com/authorize
      Token URL: https://auth.stg.atlassian.com/oauth/token scopes: read:ops-config:jira-service-management

Path parameters

idstring required

Id of the sync.

Response

Returned if the request is successful

idstring

Id of the sync.

namestring

Name of the sync.

typestring

Type of the sync. (For instance, "jira-software-cloud" for Jira Software Cloud Sync.)

enabledboolean

This parameter is for specifying whether the sync will be enabled or not. Defaults to false

teamIdstring

Owner team of the sync, consisting id of the owner team.

propertiesobject

Properties of the sync.

Changes

No recorded changes to this operation across all 5 revisions of this API.