I'm building a tool that uses the Jira Cloud Platform REST API to access data, e.g. issues, projects, etc.. I want to be able to support Jira Data Center installations too but I'm confused as to which docs to use as reference.
In point (3) above, which of the 2 documentation should I use for reference? What are the difference between them?
Thanks for helping me clarify this.
Good question — the two pages are different generations of the same Server-platform API, so use the second one, 'The Jira Data Center REST API'. The 'JIRA 7.6.1' page is the archived reference for Jira Server 7.6.1, a release from 2018. It is frozen at that version and will be missing everything added since. The Data Center REST API reference is the maintained one: pick your target Data Center version from the version selector at the top of the page and use that as your reference, since endpoints and fields do change between releases. Two practical differences from the Cloud API you are already using: 1. Endpoints: Data Center uses the Server platform API, so the familiar paths sit under /rest/api/2 on your own instance, and the agile endpoints for boards and sprints live under /rest/agile/1.0. The Cloud v3 endpoints, and some Cloud-only fields and features, do not exist on Data Center, so do not build against the Cloud docs for the Data Center path. 2. Authentication: Data Center uses basic authentication or personal access tokens issued on the instance, rather than the Atlassian Cloud API token and OAuth flow you use for Cloud. So for your tool: keep the Cloud v2/v3 docs for the Cloud path, use the versioned Data Center REST API reference for the Data Center path, and build and test against the lowest Data Center version you intend to support.
Hi @G~,
Just to add to the answer above, you can also check out the Atlassian Developer Community. 🙂
It's a great place to ask technical questions, discuss REST API differences between Cloud and Data Center, and get guidance from other developers and Atlassian staff, especially if you're building custom integrations or applications.
Cheers, Tobi
One practical addition for the tool you're building: keep the Jira product version separate from the REST API version. The 2 in /rest/api/2 does not mean Jira 2, and v11002 in the documentation URL is not a path you should append to the instance URL.
2
/rest/api/2
v11002
For a Data Center connection, start with GET <Jira base URL>/rest/api/2/serverInfo, then use the reference matching that installation's Jira version. Keep any context path in the base URL (for example, /jira). I'd include that server information in diagnostic output so a reported integration failure can be tied to a specific Jira release.
GET <Jira base URL>/rest/api/2/serverInfo
/jira
Atlassian's serverInfo reference: https://developer.atlassian.com/server/jira/platform/rest/v10000/api-group-serverinfo/
Hi,
Adding two Cloud vs Data Center differences that tend to bite when one tool supports both:
Smaller things in the same category: rich text fields like description and comments are ADF (JSON) in Cloud v3 but wiki markup in DC v2, and some newer Cloud-only fields simply don't exist on DC.
Hope this helps!
Hi, Use the developer.atlassian.com one. That is the current Jira Data Center reference (v11002 = Jira 11.x): https://developer.atlassian.com/server/jira/platform/rest/v11002/intro/ The docs.atlassian.com 7.6.1 page is the old Jira Server 7.6 reference, so I would only use it if you have to support very old instances. Things to plan for when you port from Cloud: 1. DC has only REST v2 (/rest/api/2). There is no /rest/api/3, so no ADF: descriptions and comments are plain wiki markup strings. 2. Jira Software endpoints (boards, sprints, epics, backlog) are /rest/agile/1.0 and are in the same DC reference. 3. Users are referenced by username/key on DC, not by accountId like on Cloud. 4. Auth: basic auth, or personal access tokens sent as a Bearer token. Cloud API tokens do not apply. 5. Pick the reference version that matches your customers' DC version. The OpenAPI spec is downloadable, which makes it easy to diff against the Cloud spec. Hope this helps!
It looks like you're new here. Sign in or register to get started.