Jira Software Cloud primarily uses a REST API. The REST API uses JSON as its communication format and standard HTTP methods like GET, PUT, POST and DELETE.
There is also an Atlassian platform GraphQL API that can be used to access Jira data, among other Atlassian products. However, the GraphQL API support for Jira appears to be limited and still in development. As of March 2022, Jira was not fully available in the GraphQL API, with only Confluence and the early stage product Compass having full support. The Jira team was starting to produce GraphQL APIs, but they were in @Beta status and only available for web session calls, not for 3rd party OAuth or Connect app calls. The GraphQL API was slowly being adopted by the Jira Front End team to power issue experiences.
The documentation for the GraphQL API includes examples for querying Jira objects, and Jira types are included in the schema as per the API explorer. However, this may be misleading as full Jira support was not yet available.
As of June 2024, there were still questions about the availability and documentation of the GraphQL API for Jira.
In summary, while Jira Software Cloud does have a GraphQL API, it appears to be in a limited beta state with incomplete documentation. The primary and fully supported API for Jira Software Cloud remains the REST API. Developers looking to integrate with Jira Software Cloud should primarily focus on using the REST API unless they have specific needs that can only be met by the GraphQL API.
Yes, the official Jira Software Cloud API does support webhooks. Here are the key points about webhooks in Jira Cloud:
Jira Cloud provides webhooks as a way to notify external applications when certain events occur in Jira.
Webhooks allow you to send push notifications from Jira to remote applications without requiring polling.
You can subscribe to a wide variety of events via Jira Cloud webhooks, including:
Webhooks can be configured via the Jira administration console or the REST API.
When registering a webhook, you need to specify:
You can secure webhooks by using a secret token to validate payloads.
In summary, Jira Cloud provides a robust webhook system that allows you to subscribe to a wide variety of events and receive real-time notifications when those events occur in your Jira instance. This enables powerful integrations with external systems and applications.
Here are the key points about API rate limits for the Jira Software Cloud API:
Rate limiting is implemented by tracking the cost of processing requests against various cost budgets [1].
Requests are associated with different user-based budgets depending on the authentication type:
The exact rate limits are not published because the computation logic is evolving continuously [1].
Apps can detect rate limiting by checking for HTTP 429 status codes [1].
429 responses may be accompanied by headers like:
Apps should implement backoff and retry logic to handle rate limiting [1].
Rate limits are per tenant (customer site) per endpoint, not per individual app [5].
There are no published specific limits, but Atlassian recommends:
Rate limiting protects customer instances and keeps them usable [5].
Developers should implement client-side rate limiting as a best practice [5].
Be prepared to handle 429 errors and implement retry logic with backoff [1][5].
In summary, while exact limits are not published, Jira Cloud does implement API rate limiting to protect customer instances. Developers should implement proper error handling and retry logic to work within these limits.
Based on the search results provided, here is the answer to the question about the most recent version of the Jira Software Cloud API:
The most recent version of the Jira Software Cloud API is v2.
Key points to consider:
The Jira Cloud platform REST API documentation refers to "REST API v2" [1].
The search results do not explicitly mention a more recent version than v2 for the cloud API.
It's important to note that there are different APIs for Jira Software Cloud and Jira Data Center/Server versions. The search results contain information about both cloud and server/data center versions, but the question specifically asks about the cloud API.
Best practices:
Always check the official Atlassian developer documentation for the most up-to-date information on API versions and changes.
When developing integrations or apps for Jira Software Cloud, ensure you are using the latest supported API version to take advantage of new features and improvements.
Keep in mind that Atlassian may introduce new API versions or make changes to existing ones, so it's important to stay informed about any updates or deprecations.
[1] https://developer.atlassian.com/cloud/jira/platform/rest/v2/
Based on the search results provided, here is a list of data models you can interact with using the Jira Software Cloud API, along with what is possible for each:
This list covers the main data models and operations available through the Jira Software Cloud API. Each of these models allows for various CRUD (Create, Read, Update, Delete) operations and specific functionalities related to Jira's project and issue management features.
