Insight REST API

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 Insight. The REST-APIs are for developers who want to integrate Insight with other standalone or web applications, and administrators who want to script interactions with Insight 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 more information, see REST API documentation.

Structure of the REST URIs

Insight 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 Insight REST API uses JSON as its communication format, and the standard HTTP methods like GET, PUT, POST and DELETE. URIs for Insight REST API resource 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 Insight REST API.

Content type

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

Last modified on Sep 8, 2021

Was this helpful?

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