Jira Cloud platform REST API documentation
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://your-domain.atlassian.net
auth: b a s i c ,
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Jira Cloud platform REST API documentation
| method | path | what the vendor says it does |
|---|---|---|
GET | /rest/api/3/announcementBanner | Get announcement banner configuration Returns the current announcement banner configuration. **[Permissions]( |
PUT | /rest/api/3/announcementBanner | Update announcement banner configuration Updates the announcement banner configuration. **[Permissions](#perm |
POST | /rest/api/3/app/field/value | Update custom fields Updates the value of one or more custom fields on one or more issues. Combinations of cus |
GET | /rest/api/3/app/field/{fieldIdOrKey}/context/configuration | Get custom field configurations Returns a [paginated](#pagination) list of configurations for a custom field c |
PUT | /rest/api/3/app/field/{fieldIdOrKey}/context/configuration | Update custom field configurations Update the configuration for contexts of a custom field created by a [Forge |
PUT | /rest/api/3/app/field/{fieldIdOrKey}/value | Update custom field value Updates the value of a custom field on one or more issues. Custom fields can only be |
GET | /rest/api/3/application-properties | Get application property Returns all application properties or an application property. If you specify a valu |
GET | /rest/api/3/application-properties/advanced-settings | Get advanced settings Returns the application properties that are accessible on the *Advanced Settings* page. |
PUT | /rest/api/3/application-properties/{id} | Set application property Changes the value of an application property. For example, you can change the value o |
GET | /rest/api/3/applicationrole | Get all application roles Returns all application roles. In Jira, application roles are managed using the [App |
GET | /rest/api/3/applicationrole/{key} | Get application role Returns an application role. **[Permissions](#permissions) required:** *Administer Jira* |
GET | /rest/api/3/attachment/content/{id} | Get attachment content Returns the contents of an attachment. A `Range` header can be set to define a range of |
GET | /rest/api/3/attachment/meta | Get Jira attachment settings Returns the attachment settings, that is, whether attachments are enabled and the |
GET | /rest/api/3/attachment/thumbnail/{id} | Get attachment thumbnail Returns the thumbnail of an attachment. To return the attachment contents, use [Get |
GET | /rest/api/3/attachment/{id} | Get attachment metadata Returns the metadata for an attachment. Note that the attachment itself is not returne |
DELETE | /rest/api/3/attachment/{id} | Delete attachment Deletes an attachment from an issue. This operation can be accessed anonymously. **[Permis |
GET | /rest/api/3/attachment/{id}/expand/human | Get all metadata for an expanded attachment Returns the metadata for the contents of an attachment, if it is a |
GET | /rest/api/3/attachment/{id}/expand/raw | Get contents metadata for an expanded attachment Returns the metadata for the contents of an attachment, if it |
GET | /rest/api/3/auditing/record | Get audit records Returns a list of audit records. The list can be filtered to include items: * where each |
GET | /rest/api/3/avatar/{type}/system | Get system avatars by type Returns a list of system avatar details by owner type, where the owner types are is |
POST | /rest/api/3/comment/list | Get comments by IDs Returns a [paginated](#pagination) list of comments specified by a list of comment IDs. T |
GET | /rest/api/3/comment/{commentId}/properties | Get comment property keys Returns the keys of all the properties of a comment. This operation can be accessed |
GET | /rest/api/3/comment/{commentId}/properties/{propertyKey} | Get comment property Returns the value of a comment property. This operation can be accessed anonymously. ** |
PUT | /rest/api/3/comment/{commentId}/properties/{propertyKey} | Set comment property Creates or updates the value of a property for a comment. Use this resource to store cust |
DELETE | /rest/api/3/comment/{commentId}/properties/{propertyKey} | Delete comment property Deletes a comment property. **[Permissions](#permissions) required:** either of: * |
POST | /rest/api/3/component | Create component Creates a component. Use components to provide containers for issues within a project. This |
GET | /rest/api/3/component/{id} | Get component Returns a component. This operation can be accessed anonymously. **[Permissions](#permissions) |
PUT | /rest/api/3/component/{id} | Update component Updates a component. Any fields included in the request are overwritten. If `leadAccountId` i |
DELETE | /rest/api/3/component/{id} | Delete component Deletes a component. This operation can be accessed anonymously. **[Permissions](#permissio |
GET | /rest/api/3/component/{id}/relatedIssueCounts | Get component issues count Returns the counts of issues assigned to the component. This operation can be acce |
GET | /rest/api/3/configuration | Get global settings Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) in Jira. These set |
GET | /rest/api/3/configuration/timetracking | Get selected time tracking provider Returns the time tracking provider that is currently selected. Note that i |
PUT | /rest/api/3/configuration/timetracking | Select time tracking provider Selects a time tracking provider. **[Permissions](#permissions) required:** *Ad |
GET | /rest/api/3/configuration/timetracking/list | Get all time tracking providers Returns all time tracking providers. By default, Jira only has one time tracki |
GET | /rest/api/3/configuration/timetracking/options | Get time tracking settings Returns the time tracking settings. This includes settings such as the time format, |
PUT | /rest/api/3/configuration/timetracking/options | Set time tracking settings Sets the time tracking settings. **[Permissions](#permissions) required:** *Admini |
GET | /rest/api/3/customFieldOption/{id} | Get custom field option Returns a custom field option. For example, an option in a select list. Note that thi |
GET | /rest/api/3/dashboard | Get all dashboards Returns a list of dashboards owned by or shared with the user. The list may be filtered to |
POST | /rest/api/3/dashboard | Create dashboard Creates a dashboard. **[Permissions](#permissions) required:** None. Dashboards |
GET | /rest/api/3/dashboard/gadgets | Get available gadgets Gets a list of all available gadgets that can be added to all dashboards. **[Permission |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.