Skip to content

priority

create

Create priority

Creates an issue priority.

Deprecation applies to iconUrl param in request body which will be sunset on 16th Mar 2025. For more details refer to changelog.

Permissions required: Administer Jira global permission.

POST /rest/api/3/priority

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)

Example:

bash
jr priority create

delete

Delete priority

Deletes an issue priority.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/priority/{id}

FlagTypeRequiredDescription
--idstringYesThe ID of the issue priority.

Example:

bash
jr priority delete --id <id>

get-priorities

Get priorities

Returns the list of all issue priorities.

Permissions required: Permission to access Jira.

GET /rest/api/3/priority

Example:

bash
jr priority get-priorities

get-priority

Get priority

Returns an issue priority.

Permissions required: Permission to access Jira.

GET /rest/api/3/priority/{id}

FlagTypeRequiredDescription
--idstringYesThe ID of the issue priority.

Example:

bash
jr priority get-priority --id <id>

move

Move priorities

Changes the order of issue priorities.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/priority/move

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)

Example:

bash
jr priority move

Search priorities

Returns a paginated list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria:

  • a list of priority IDs. Any invalid priority IDs are ignored.
  • a list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project IDs are ignored.
  • whether the field configuration is a default. This returns priorities from company-managed (classic) projects only, as there is no concept of default priorities in team-managed projects.

Permissions required: Permission to access Jira.

GET /rest/api/3/priority/search

FlagTypeRequiredDescription
--expandstringNoUse schemes to return the associated priority schemes for each priority. Limited to returning first 15 priority schemes per priority.
--idstringNoThe list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=2&id=3.
--maxResultsstringNoThe maximum number of items to return per page.
--onlyDefaultstringNoWhether only the default priority is returned.
--priorityNamestringNoThe name of priority to search for.
--projectIdstringNoThe list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, projectId=10010&projectId=10111.
--startAtstringNoThe index of the first item to return in a page of results (page offset).

Example:

bash
jr priority search

set-default

Set default priority

Sets default issue priority.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/priority/default

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)

Example:

bash
jr priority set-default

update

Update priority

Updates an issue priority.

At least one request body parameter must be defined.

Deprecation applies to iconUrl param in request body which will be sunset on 16th Mar 2025. For more details refer to changelog.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/priority/{id}

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)
--idstringYesThe ID of the issue priority.

Example:

bash
jr priority update --id <id>