Last updated Sep 19, 2022

Rate this page:

About

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

Authentication and authorization

Authentication: For authenticating directly against the REST API, the Assets 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.

Please note that import APIs might support extra means of authentication, such as OAuth tokens. Read more on the external imports guide.

Using the REST API

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

You can discover your workspace ID through the following endpoint:

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

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

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

Rate limiting: By default all endpoints in this api are rate limited to 1,000 requests per minute per instance with a total limit of 10,000 requests per minute per instance. Any exceptions to this rule will be mentioned in the documentation of that endpoint.

Rate this page: