the-jira-cloud-platform-rest-api — quality + safety report

---
name: the-jira-cloud-platform-rest-api
description: "The Jira Cloud platform REST API skill. Use when working with The Jira Cloud platform REST for rest. Covers 617 endpoints."
version: 1.0.0
generator: lapsh
---

# The Jira Cloud platform REST API
API version: 1001.0.0-SNAPSHOT-edac94e3f522fa4c9e667d33b17f99eed00f7d56

## Auth
OAuth2 | Bearer basic

## Base URL
https://your-domain.atlassian.net

## Setup
1. Set Authorization header with your Bearer token
2. GET /rest/api/3/announcementBanner -- verify access
3. POST /rest/api/3/app/field/context/configuration/list -- create first list

## Endpoints

617 endpoints across 1 groups. See references/api-spec.lap for full details.

### rest
| Method | Path | Description |
|--------|------|-------------|
| GET | /rest/api/3/announcementBanner | Get announcement banner configuration |
| PUT | /rest/api/3/announcementBanner | Update announcement banner configuration |
| POST | /rest/api/3/app/field/context/configuration/list | Bulk get custom field configurations |
| POST | /rest/api/3/app/field/value | Update custom fields |
| GET | /rest/api/3/app/field/{fieldIdOrKey}/context/configuration | Get custom field configurations |
| PUT | /rest/api/3/app/field/{fieldIdOrKey}/context/configuration | Update custom field configurations |
| PUT | /rest/api/3/app/field/{fieldIdOrKey}/value | Update custom field value |
| GET | /rest/api/3/application-properties | Get application property |
| GET | /rest/api/3/application-properties/advanced-settings | Get advanced settings |
| PUT | /rest/api/3/application-properties/{id} | Set application property |
| GET | /rest/api/3/applicationrole | Get all application roles |
| GET | /rest/api/3/applicationrole/{key} | Get application role |
| GET | /rest/api/3/attachment/content/{id} | Get attachment content |
| GET | /rest/api/3/attachment/meta | Get Jira attachment settings |
| GET | /rest/api/3/attachment/thumbnail/{id} | Get attachment thumbnail |
| DELETE | /rest/api/3/attachment/{id} | Delete attachment |
| GET | /rest/api/3/attachment/{id} | Get attachment metadata |
| GET | /rest/api/3/attachment/{id}/expand/human | Get all metadata for an expanded attachment |
| GET | /rest/api/3/attachment/{id}/expand/raw | Get contents metadata for an expanded attachment |
| GET | /rest/api/3/auditing/record | Get audit records |
| GET | /rest/api/3/avatar/{type}/system | Get system avatars by type |
| POST | /rest/api/3/bulk/issues/delete | Bulk delete issues |
| GET | /rest/api/3/bulk/issues/fields | Get bulk editable fields |
| POST | /rest/api/3/bulk/issues/fields | Bulk edit issues |
| POST | /rest/api/3/bulk/issues/move | Bulk move issues |
| GET | /rest/api/3/bulk/issues/transition | Get available transitions |
| POST | /rest/api/3/bulk/issues/transition | Bulk transition issue statuses |
| POST | /rest/api/3/bulk/issues/unwatch | Bulk unwatch issues |
| POST | /rest/api/3/bulk/issues/watch | Bulk watch issues |
| GET | /rest/api/3/bulk/queue/{taskId} | Get bulk issue operation progress |
| POST | /rest/api/3/changelog/bulkfetch | Bulk fetch changelogs |
| GET | /rest/api/3/classification-levels | Get all classification levels |
| POST | /rest/api/3/comment/list | Get comments by IDs |
| GET | /rest/api/3/comment/{commentId}/properties | Get comment property keys |
| DELETE | /rest/api/3/comment/{commentId}/properties/{propertyKey} | Delete comment property |
| GET | /rest/api/3/comment/{commentId}/properties/{propertyKey} | Get comment property |
| PUT | /rest/api/3/comment/{commentId}/properties/{propertyKey} | Set comment property |
| GET | /rest/api/3/component | Find components for projects |
| POST | /rest/api/3/component | Create component |
| DELETE | /rest/api/3/component/{id} | Delete component |
| GET | /rest/api/3/component/{id} | Get component |
| PUT | /rest/api/3/component/{id} | Update component |
| GET | /rest/api/3/component/{id}/relatedIssueCounts | Get component issues count |
| GET | /rest/api/3/config/fieldschemes | Get field schemes |
| POST | /rest/api/3/config/fieldschemes | Create field scheme |
| DELETE | /rest/api/3/config/fieldschemes/fields | Remove fields associated with field schemes |
| PUT | /rest/api/3/config/fieldschemes/fields | Update fields associated with field schemes |
| DELETE | /rest/api/3/config/fieldschemes/fields/parameters | Remove field parameters |
| PUT | /rest/api/3/config/fieldschemes/fields/parameters | Update field parameters |
| GET | /rest/api/3/config/fieldschemes/projects | Get projects with field schemes |
| PUT | /rest/api/3/config/fieldschemes/projects | Associate projects to field schemes |
| DELETE | /rest/api/3/config/fieldschemes/{id} | Delete a field scheme |
| GET | /rest/api/3/config/fieldschemes/{id} | Get field scheme |
| PUT | /rest/api/3/config/fieldschemes/{id} | Update field scheme |
| POST | /rest/api/3/config/fieldschemes/{id}/clone | Clone field scheme |
| GET | /rest/api/3/config/fieldschemes/{id}/fields | Search field scheme fields |
| GET | /rest/api/3/config/fieldschemes/{id}/fields/{fieldId}/parameters | Get field parameters |
| GET | /rest/api/3/config/fieldschemes/{id}/projects | Search field scheme projects |
| GET | /rest/api/3/configuration | Get global settings |
| GET | /rest/api/3/configuration/timetracking | Get selected time tracking provider |
| PUT | /rest/api/3/configuration/timetracking | Select time tracking provider |
| GET | /rest/api/3/configuration/timetracking/list | Get all time tracking providers |
| GET | /rest/api/3/configuration/timetracking/options | Get time tracking settings |
| PUT | /rest/api/3/configuration/timetracking/options | Set time tracking settings |
| GET | /rest/api/3/customFieldOption/{id} | Get custom field option |
| GET | /rest/api/3/dashboard | Get all dashboards |
| POST | /rest/api/3/dashboard | Create dashboard |
| PUT | /rest/api/3/dashboard/bulk/edit | Bulk edit dashboards |
| GET | /rest/api/3/dashboard/gadgets | Get available gadgets |
| GET | /rest/api/3/dashboard/search | Search for dashboards |
| GET | /rest/api/3/dashboard/{dashboardId}/gadget | Get gadgets |
| POST | /rest/api/3/dashboard/{dashboardId}/gadget | Add gadget to dashboard |
| DELETE | /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId} | Remove gadget from dashboard |
| PUT | /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId} | Update gadget on dashboard |
| GET | /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties | Get dashboard item property keys |
| DELETE | /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} | Delete dashboard item property |
| GET | /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} | Get dashboard item property |
| PUT | /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} | Set dashboard item property |
| DELETE | /rest/api/3/dashboard/{id} | Delete dashboard |
| GET | /rest/api/3/dashboard/{id} | Get dashboard |
| PUT | /rest/api/3/dashboard/{id} | Update dashboard |
| POST | /rest/api/3/dashboard/{id}/copy | Copy dashboard |
| GET | /rest/api/3/data-policy | Get data policy for the workspace |
| GET | /rest/api/3/data-policy/project | Get data policy for projects |
| GET | /rest/api/3/events | Get events |
| POST | /rest/api/3/expression/analyse | Analyse Jira expression |
| POST | /rest/api/3/expression/eval | Currently being removed. Evaluate Jira expression |
| POST | /rest/api/3/expression/evaluate | Evaluate Jira expression using enhanced search API |
| GET | /rest/api/3/field | Get fields |
| POST | /rest/api/3/field | Create custom field |
| DELETE | /rest/api/3/field/association | Remove associations |
| PUT | /rest/api/3/field/association | Create associations |
| GET | /rest/api/3/field/search | Get fields paginated |
| GET | /rest/api/3/field/search/trashed | Get fields in trash paginated |
| PUT | /rest/api/3/field/{fieldId} | Update custom field |
| GET | /rest/api/3/field/{fieldId}/context | Get custom field contexts |
| POST | /rest/api/3/field/{fieldId}/context | Create custom field context |
| GET | /rest/api/3/field/{fieldId}/context/defaultValue | Get custom field contexts default values |
| PUT | /rest/api/3/field/{fieldId}/context/defaultValue | Set custom field contexts default values |
| GET | /rest/api/3/field/{fieldId}/context/issuetypemapping | Get issue types for custom field context |
| POST | /rest/api/3/field/{fieldId}/context/mapping | Get custom field contexts for projects and issue types |
| GET | /rest/api/3/field/{fieldId}/context/projectmapping | Get project mappings for custom field context |
| DELETE | /rest/api/3/field/{fieldId}/context/{contextId} | Delete custom field context |
| PUT | /rest/api/3/field/{fieldId}/context/{contextId} | Update custom field context |
| PUT | /rest/api/3/field/{fieldId}/context/{contextId}/issuetype | Add issue types to context |
| POST | /rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove | Remove issue types from context |
| GET | /rest/api/3/field/{fieldId}/context/{contextId}/option | Get custom field options (context) |
| POST | /rest/api/3/field/{fieldId}/context/{contextId}/option | Create custom field options (context) |
| PUT | /rest/api/3/field/{fieldId}/context/{contextId}/option | Update custom field options (context) |
| PUT | /rest/api/3/field/{fieldId}/context/{contextId}/option/move | Reorder custom field options (context) |
| DELETE | /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId} | Delete custom field options (context) |
| DELETE | /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}/issue | Replace custom field options |
| PUT | /rest/api/3/field/{fieldId}/context/{contextId}/project | Assign custom field context to projects |
| POST | /rest/api/3/field/{fieldId}/context/{contextId}/project/remove | Remove custom field context from projects |
| GET | /rest/api/3/field/{fieldId}/contexts | Get contexts for a field |
| GET | /rest/api/3/field/{fieldId}/screens | Get screens for a field |
| GET | /rest/api/3/field/{fieldKey}/option | Get all issue field options |
| POST | /rest/api/3/field/{fieldKey}/option | Create issue field option |
| GET | /rest/api/3/field/{fieldKey}/option/suggestions/edit | Get selectable issue field options |
| GET | /rest/api/3/field/{fieldKey}/option/suggestions/search | Get visible issue field options |
| DELETE | /rest/api/3/field/{fieldKey}/option/{optionId} | Delete issue field option |
| GET | /rest/api/3/field/{fieldKey}/option/{optionId} | Get issue field option |
| PUT | /rest/api/3/field/{fieldKey}/option/{optionId} | Update issue field option |
| DELETE | /rest/api/3/field/{fieldKey}/option/{optionId}/issue | Replace issue field option |
| DELETE | /rest/api/3/field/{id} | Delete custom field |
| POST | /rest/api/3/field/{id}/restore | Restore custom field from trash |
| POST | /rest/api/3/field/{id}/trash | Move custom field to trash |
| GET | /rest/api/3/fieldconfiguration | Get all field configurations |
| POST | /rest/api/3/fieldconfiguration | Create field configuration |
| DELETE | /rest/api/3/fieldconfiguration/{id} | Delete field configuration |
| PUT | /rest/api/3/fieldconfiguration/{id} | Update field configuration |
| GET | /rest/api/3/fieldconfiguration/{id}/fields | Get field configuration items |
| PUT | /rest/api/3/fieldconfiguration/{id}/fields | Update field configuration items |
| GET | /rest/api/3/fieldconfigurationscheme | Get all field configuration schemes |
| POST | /rest/api/3/fieldconfigurationscheme | Create field configuration scheme |
| GET | /rest/api/3/fieldconfigurationscheme/mapping | Get field configuration issue type items |
| GET | /rest/api/3/fieldconfigurationscheme/project | Get field configuration schemes for projects |
| PUT | /rest/api/3/fieldconfigurationscheme/project | Assign field configuration scheme to project |
| DELETE | /rest/api/3/fieldconfigurationscheme/{id} | Delete field configuration scheme |
| PUT | /rest/api/3/fieldconfigurationscheme/{id} | Update field

… (truncated)