ATatlassian
Integrations

Get integration

Returns the integration details. <br> <br> 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.
get/api/{cloudId}/v1/integrations/{id}

Request

  • Base URL
    https://api.atlassian.com/jsm/ops
  • URL
    https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations/{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 integration.

Response

Returned if the request is successful.

idstring

ID of the integration.

namestring

Name of the integration.

typestring

Type of the integration.

enabledboolean

Indicates whether the integration is enabled or not.

teamIdstring

ID of the team that integration belongs to.

advancedboolean

Indicates whether the integration is configured as different than the default version.

directionsstring[]

Direction of the action. It can be incoming or outgoing

domainsstring[]

Domain of the action. It can be alert

typeSpecificPropertiesobject

Action specific properties.

Changes

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