Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Syncs

Create sync

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

  • The user should have sync creation permission.
post/api/{cloudId}/v1/syncs

Request body

namestring required

Name of the sync. Name must be unique for each sync.

descriptionstring

Description of the sync.

enabledboolean

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

teamIdstring

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

typestring required

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

propertiesobject

Sync specific properties may be provided to this object. For instance, this map should consist

  • projectKey

Example request

{
  "properties": {
    "projectKey": "JE"
  }
}

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.