Last updated Feb 17, 2023

About Assets in Jira Service Management Cloud

Assets in Jira Service Management is a Premium and Enterprise only feature.

Assets in Jira Service Management is a feature within Jira Service Management that allows team to track their assets, configuration items, and resources to understand and visualise the critical relationships between applications, services, their underlying infrastructure, and other key dependencies. Learn more about Assets in Jira Service Management.

We recommend building integrations with JSM Assets using Atlassian Forge. For more information on how to integrate with Assets using Forge, see: Importing Third Party data into Assets using Forge.

What is a REST API?

A REST API is a service that runs on a host system. It allows a user to configure their computer to communicate directly with that host system, so that user can connect their computer to the host and perform actions programatically instead of using the standard graphical user interface.

REST APIs use the standard HTTP protocol found in web browsers, along with an information framework called REST that describes how the information will be formatted and what tasks can be completed.

Information is changed or retrieved using a “call” that passes a command to the host system. The call tells the host system what information to change, and often includes some authentication information to keep the data secure. Learn how security is handled in Assets in Jira Service Management.

Using the REST API with Assets in Jira Service Management Cloud

There are two different ways to use the Assets REST API to get and modify data in Assets in Jira Service Management:

Imports REST API

If you want to import a structure and/or data into Assets, we recommend using the Imports REST API Guide, which is configured to push data and structure into Assets in a fast and powerful way.

For a sample JSON file that can be used to create your structure and mapping, please see the Example object schema and mapping.

The Imports REST API is currently unable to create reference types, users, groups, or statuses. If you want to programmatically create reference types, users, groups, or statuses, you will have to use the Assets REST API exclusively.

Assets REST API

If you want to use the Assets REST API to work directly with Assets, to create reference types, users, groups, or statuses, we recommend using the Standard Assets REST API Guide.

Rate limiting

Most endpoints are rate-limited to 1,000 requests per minute per instance with a total limit of 10,000 requests per minute per instance.

Rate this page: