Base URL

Base URL refers to a BigPicture instance - it is a prefix added to all public API endpoints.

How to determine the base URL (Jira Server, Jira Data Center)

To determine the base URL for the public API:

  1. Navigate to Jira Administration > System > General configuration.
  2. Under the General Settings section, find the base URL, for example, https://yourcompanyname.com.

Use the following format for the base URL in the public API (replace {Jira base URL} with your base URL):

{Jira base URL}/rest/softwareplant-bigpicture/1.0

Example:

https://yourcompanyname.com/rest/softwareplant-bigpicture/1.0

How to determine the base URL (Cloud)

To determine the base URL of BigPicture service, you have to call service registry endpoint with a token to the public API:

curl --url https://cloud.softwareplant.com/cloudmanager/bigpicture/where-am-i --header 'Authorization: APIToken paste_your_api_token_here'

In response, you should get the location of BigPicture, for example:

{
  "location": "https://cloud.softwareplant.com/bigpicture/jiracloud/101"
}

Use the following format for the base URL in the public API:

{base URL}/rest

What happens when BigPicture is moved to another server

BigPicture may be migrated to a different address for the following reasons: stability, performance, and GDPR.
When BigPicture changes location to another server, then a call to the public API of the old server returns a 401 error. After that, it is necessary to call service registry endpoint again to determine the BigPicture location using the where-am-i endpoint.