Assets REST API

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

This is the reference document for the REST API and resources provided by Assets. The REST APIs are for developers who want to integrate Assets with other standalone or web applications, and administrators who want to script interactions with Assets on the Jira server. Because the REST API is based on open standards, you can use any web development language to access the API.

REST API documentation

For Jira Service Management 5.7, refer to Assets 10.7.0 REST API documentation.

For Jira Service Management 5.4, refer to Assets 10.4.4 REST API documentation.

For Jira Service Management 4.20, refer to Assets 9.1.16 REST API documentation.

Structure of the REST URIs

Assets REST API provides access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The Assets REST API uses JSON as its communication format, and standard HTTP methods like GET, PUT, POST and DELETE.

URIs for Assets REST API have the following structure:

http://host:port/{context-path}/rest/assets/{api-version}/{resource-name}


URIs previously used for Insight REST API resources still work. However, starting from Jira Service Management 5.3 and Assets 8.10.12, these URIs are deprecated. Insight URIs have the following structure:

http://host:port/context/rest/insight/api-version/resource-name


The API version is 1.0

Authentication

Any authentication that works against Jira will work against the Assets REST API.

Content type

Don't forget to use "Content-Type: application/json" in the http header when sending data to the Assets REST APIs.

Last modified on Mar 21, 2023

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.