Last updated May 14, 2021

Rate this page:

About

This is the reference for the Insight in Jira Service Management REST API. This API is the primary way to get and modify data in Insight in Jira Service Management. Use it to interact with Insight entities such as object schemas, objects, object types, attributes, references, and more.

Authentication and authorization

Authentication: For authenticating directly against the REST API, the Insight in Jira Service Management REST API supports basic auth (see Basic auth for REST APIs).

Authorization: For making calls directly against the REST API, authorization is based on the user used in the authentication process.

See Security overview for more details on authentication and authorization.

Using the REST API

Workspace ID: The Jira Service Management REST API uses the workspaceId to identify your individual instance of Insight. You must include the workspaceId when making any calls to the REST API.

You can discover your workspace ID through the following endpoint:

1
https://<JSM Premium Site Name>.atlassian.net/rest/servicedeskapi/insight/workspace

The workspace ID should be included in any requests, as follows:

1
https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/object/{id}

Rate this page: