What URL do I use to POST to my newly created Jira Operations Integration?

[Nathan Given]

I followed 

https://support.atlassian.com/jira-service-management-cloud/docs/set-up-an-api-integration/ and created a new Jira > Operations > Integration.

On the integration settings/details page I see that I have an API Key, but the documentation doesn't give me a URL I should be using.

What URL am I supposed to be using to POST data to my newly created integration?

Thank you,

Nathan

[Connor]

Hi @Nathan Given I believe what you're looking for can be found in this documentation, and this documentation is for the specific actions related to alerts. Specifically the URL format is described as:

URL format

The Jira Service Management operations REST API uses a consistent URL pattern to access different resources. The general format is as follows:

Copy

1 https://api.atlassian.com/jsm/ops/api/{cloudId}/{version}/{domain}

• {cloudId} represents the unique identifier for your cloud instance.
• {version} is the version of the API you want to access. Currently, only version 1 ('v1') is available.
• {domain} is the specific domain of the API you want to access. Examples include 'schedule', 'team', 'alert', 'user', among others. The exact domain will depend on the specific area of the API you wish to access.

An example of a fully constructed URL might look like this: https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/schedules/{scheduleId}. This URL accesses the 'schedule' domain of the API for retrieving a schedule based on its id.

You add the API key to the request header which is how I think JSM knows to send your request to the Default API integration or your custom API integration.

[Yudi Yuswita Sunarto]

where I can see my cloudId? @Connor 

[Connor]

Hey @Yudi Yuswita Sunarto follow the steps found in this guide to get your cloud ID.

[Monty]

Imagine if any of this was referenced on the https://support.atlassian.com/jira-service-management-cloud/docs/set-up-an-api-integration/ page.

@Connoryou've succinctly added all of this information all in one place far better than Atlassian's own documentation.

[Connor]

Hey @Monty yeah having these important details included in the relevant documentation would be great.

When I first started using the APIs, and needed to find my own cloud ID, I was surprised there were no instructions for getting the cloudId of your site. For example, the cloudId is listed here as a requirement for the URL format, but you're not told how to get that.

IIRC when I was researching this for myself, I think I originally found the instructions here in Atlassian's developer documentation. Which isn't the most intuitive location to search in, unless you're already very familiar with Atlassian's ecosystem, specifically their documentation.

[Monty]

I ran into the same exact problem.

It's like giving someone a box of Ikea furniture and the first instruction is to use the BOLTSKÄR tool for the first step without telling you what that is or where to find it.

I have an entire notes section in my personal knowledge management system that just links together their documentation so I can find references to the things that should already exist.