project

add-actor-users

Add actors to project role

Adds actors to a project role for the project.

To replace all actors for the project, use Set actors for project role.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

POST /rest/api/3/project/{projectIdOrKey}/role/{id}

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--id`	string	Yes	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project add-actor-users --id <id> --projectIdOrKey <projectIdOrKey>

assign-permission-scheme

Assign permission scheme

Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.

Permissions required: Administer Jira global permission

PUT /rest/api/3/project/{projectKeyOrId}/permissionscheme

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--expand`	string	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission. | | --projectKeyOrId | string | Yes | The project ID or project key (case sensitive). |

Example:

bash

jr project assign-permission-scheme --projectKeyOrId <projectKeyOrId>

create

Create project

Creates a project based on a project type template, as shown in the following table:

Project Type Key	Project Template Key
`business`	`com.atlassian.jira-core-project-templates:jira-core-simplified-content-management`, `com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval`, `com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking`, `com.atlassian.jira-core-project-templates:jira-core-simplified-process-control`, `com.atlassian.jira-core-project-templates:jira-core-simplified-procurement`, `com.atlassian.jira-core-project-templates:jira-core-simplified-project-management`, `com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment`, `com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking`
`service_desk`	`com.atlassian.servicedesk:simplified-it-service-management`, `com.atlassian.servicedesk:simplified-external-service-desk`, `com.atlassian.servicedesk:simplified-hr-service-desk`, `com.atlassian.servicedesk:simplified-facilities-service-desk`, `com.atlassian.servicedesk:simplified-legal-service-desk`, `com.atlassian.servicedesk:simplified-analytics-service-desk`, `com.atlassian.servicedesk:simplified-marketing-service-desk`, `com.atlassian.servicedesk:simplified-design-service-desk`, `com.atlassian.servicedesk:simplified-sales-service-desk`, `com.atlassian.servicedesk:simplified-finance-service-desk`, `com.atlassian.servicedesk:company-managed-blank-service-project`, `com.atlassian.servicedesk:company-managed-general-service-project`, `com.atlassian.servicedesk:team-managed-general-service-project`, `com.atlassian.servicedesk:next-gen-it-service-desk`, `com.atlassian.servicedesk:next-gen-hr-service-desk`, `com.atlassian.servicedesk:next-gen-legal-service-desk`, `com.atlassian.servicedesk:next-gen-marketing-service-desk`, `com.atlassian.servicedesk:next-gen-facilities-service-desk`, `com.atlassian.servicedesk:next-gen-analytics-service-desk`, `com.atlassian.servicedesk:next-gen-finance-service-desk`, `com.atlassian.servicedesk:next-gen-design-service-desk`, `com.atlassian.servicedesk:next-gen-sales-service-desk`
`software`	`com.pyxis.greenhopper.jira:gh-simplified-agility-kanban`, `com.pyxis.greenhopper.jira:gh-simplified-agility-scrum`, `com.pyxis.greenhopper.jira:gh-simplified-basic`, `com.pyxis.greenhopper.jira:gh-simplified-kanban-classic`, `com.pyxis.greenhopper.jira:gh-simplified-scrum-classic`
The project types are available according to the installed Jira features as follows:

Jira Core, the default, enables business projects.
Jira Service Management enables service_desk projects.
Jira Software enables software projects.

To determine which features are installed, go to Jira settings > Apps > Manage apps and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use Jira settings > Apps > Finding new apps. For more information, see Managing add-ons.

Permissions required: Administer Jira global permission.

POST /rest/api/3/project

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)

Example:

bash

jr project create

create-avatar

Load project avatar

Loads an avatar for a project.

Specify the avatar's local file location in the body of the request. Also, include the following headers:

X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

For example:
curl --request POST

--user email@example.com:<api_token>

--header 'X-Atlassian-Token: no-check'

--header 'Content-Type: image/< image_type>'

--data-binary "<@/path/to/file/with/your/avatar>"

--url 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/avatar2'

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar use Set project avatar to set it as the project's displayed avatar.

Permissions required: Administer projects project permission.

POST /rest/api/3/project/{projectIdOrKey}/avatar2

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--projectIdOrKey`	string	Yes	The ID or (case-sensitive) key of the project.
`--size`	string	No	The length of each side of the crop region.
`--x`	string	No	The X coordinate of the top-left corner of the crop region.
`--y`	string	No	The Y coordinate of the top-left corner of the crop region.

Example:

bash

jr project create-avatar --projectIdOrKey <projectIdOrKey>

delete

Delete project

Deletes a project.

You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/project/{projectIdOrKey}

Flag	Type	Required	Description
`--enableUndo`	string	No	Whether this project is placed in the Jira recycle bin where it will be available for restoration.
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project delete --projectIdOrKey <projectIdOrKey>

delete-actor

Delete actors from project role

Deletes actors from a project role for the project.

To remove default actors from the project role, use Delete default actors from project role.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

DELETE /rest/api/3/project/{projectIdOrKey}/role/{id}

Flag	Type	Required	Description
`--group`	string	No	The name of the group to remove from the project role. This parameter cannot be used with the `groupId` parameter. As a group's name can change, use of `groupId` is recommended.
`--groupId`	string	No	The ID of the group to remove from the project role. This parameter cannot be used with the `group` parameter.
`--id`	string	Yes	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).
`--user`	string	No	The user account ID of the user to remove from the project role.

Example:

bash

jr project delete-actor --id <id> --projectIdOrKey <projectIdOrKey>

delete-asynchronously

Delete project asynchronously

Deletes a project asynchronously.

This operation is:

transactional, that is, if part of the delete fails the project is not deleted.
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.

POST /rest/api/3/project/{projectIdOrKey}/delete

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project delete-asynchronously --projectIdOrKey <projectIdOrKey>

delete-avatar

Delete project avatar

Deletes a custom avatar from a project. Note that system avatars cannot be deleted.

Permissions required: Administer projects project permission.

DELETE /rest/api/3/project/{projectIdOrKey}/avatar/{id}

Flag	Type	Required	Description
`--id`	string	Yes	The ID of the avatar.
`--projectIdOrKey`	string	Yes	The project ID or (case-sensitive) key.

Example:

bash

jr project delete-avatar --id <id> --projectIdOrKey <projectIdOrKey>

delete-property

Delete project property

Deletes the property from a project.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project containing the property.

DELETE /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).
`--propertyKey`	string	Yes	The project property key. Use Get project property keys to get a list of all project property keys.

Example:

bash

jr project delete-property --projectIdOrKey <projectIdOrKey> --propertyKey <propertyKey>

get

Get project

Returns the project details for a project.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project.

GET /rest/api/3/project/{projectIdOrKey}

Flag	Type	Required	Description
`--expand`	string	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:

description The project description.
issueTypes The issue types associated with the project.
lead The project lead.
projectKeys All project keys associated with the project.
issueTypeHierarchy The project issue type hierarchy. | | --projectIdOrKey | string | Yes | The project ID or project key (case sensitive). | | --properties | string | No | A list of project properties to return for the project. This parameter accepts a comma-separated list. |

Example:

bash

jr project get --projectIdOrKey <projectIdOrKey>

get-accessible-project-type-by-key

Get accessible project type by key

Returns a project type if it is accessible to the user.

Permissions required: Permission to access Jira.

GET /rest/api/3/project/type/{projectTypeKey}/accessible

Flag	Type	Required	Description
`--projectTypeKey`	string	Yes	The key of the project type.

Example:

bash

jr project get-accessible-project-type-by-key --projectTypeKey <projectTypeKey>

get-all

Get all projects

Returns all projects visible to the user. Deprecated, use Get projects paginated that supports search and pagination.

This operation can be accessed anonymously.

Permissions required: Projects are returned only where the user has Browse Projects or Administer projects project permission for the project.

GET /rest/api/3/project

Flag	Type	Required	Description
`--expand`	string	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:

description Returns the project description.
issueTypes Returns all issue types associated with the project.
lead Returns information about the project lead.
projectKeys Returns all project keys associated with the project. | | --properties | string | No | A list of project properties to return for the project. This parameter accepts a comma-separated list. | | --recent | string | No | Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session. |

Example:

bash

jr project get-all

get-all-accessible-project-types

Get licensed project types

Returns all project types with a valid license.

GET /rest/api/3/project/type/accessible

Example:

bash

jr project get-all-accessible-project-types

get-all-project-avatars

Get all project avatars

Returns all project avatars, grouped by system and custom avatars.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project.

GET /rest/api/3/project/{projectIdOrKey}/avatars

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The ID or (case-sensitive) key of the project.

Example:

bash

jr project get-all-project-avatars --projectIdOrKey <projectIdOrKey>

get-all-project-types

Get all project types

Returns all project types, whether or not the instance has a valid license for each type.

This operation can be accessed anonymously.

Permissions required: None.

GET /rest/api/3/project/type

Example:

bash

jr project get-all-project-types

get-all-statuses

Get all statuses for project

Returns the valid statuses for a project. The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

GET /rest/api/3/project/{projectIdOrKey}/statuses

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project get-all-statuses --projectIdOrKey <projectIdOrKey>

get-assigned-permission-scheme

Get assigned permission scheme

Gets the permission scheme associated with the project.

Permissions required: Administer Jira global permission or Administer projects project permission.

GET /rest/api/3/project/{projectKeyOrId}/permissionscheme

Flag	Type	Required	Description
`--expand`	string	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission. | | --projectKeyOrId | string | Yes | The project ID or project key (case sensitive). |

Example:

bash

jr project get-assigned-permission-scheme --projectKeyOrId <projectKeyOrId>

get-classification-config

Get the classification configuration for a project

Returns the consolidated classification configuration for a project's admin settings page.

This includes permitted classification levels (with status), the project's default classification level, the organization's default classification level, and the container override setting.

Permissions required:

Browse Projects project permission for the project.
Administer projects project permission for the project.
Administer jira global permission.

GET /rest/api/3/project/{projectIdOrKey}/classification-config

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The project ID or project key (case-sensitive).

Example:

bash

jr project get-classification-config --projectIdOrKey <projectIdOrKey>

get-components

Get project components

Returns all components in a project. See the Get project components paginated resource if you want to get a full list of components with pagination.

If your project uses Compass components, this API will return a paginated list of Compass components that are linked to issues in that project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

GET /rest/api/3/project/{projectIdOrKey}/components

Flag	Type	Required	Description
`--componentSource`	string	No	The source of the components to return. Can be `jira` (default), `compass` or `auto`. When `auto` is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to `jira`.
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project get-components --projectIdOrKey <projectIdOrKey>

get-components-paginated

Get project components paginated

Returns a paginated list of all components in a project. See the Get project components resource if you want to get a full list of versions without pagination.

If your project uses Compass components, this API will return a list of Compass components that are linked to issues in that project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

GET /rest/api/3/project/{projectIdOrKey}/component

Flag	Type	Required	Description
`--componentSource`	string	No	The source of the components to return. Can be `jira` (default), `compass` or `auto`. When `auto` is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to `jira`.
`--maxResults`	string	No	The maximum number of items to return per page.
`--orderBy`	string	No	Order the results by a field:

description Sorts by the component description.
issueCount Sorts by the count of issues associated with the component.
lead Sorts by the user key of the component's project lead.
name Sorts by component name. | | --projectIdOrKey | string | Yes | The project ID or project key (case sensitive). | | --query | string | No | Filter the results using a literal string. Components with a matching name or description are returned (case insensitive). | | --startAt | string | No | The index of the first item to return in a page of results (page offset). |

Example:

bash

jr project get-components-paginated --projectIdOrKey <projectIdOrKey>

get-default-project-classification

Get the default data classification level of a project

Returns the default data classification for a project.

Permissions required:

Browse Projects project permission for the project.
Administer projects project permission for the project.
Administer jira global permission.

GET /rest/api/3/project/{projectIdOrKey}/classification-level/default

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The project ID or project key (case-sensitive).

Example:

bash

jr project get-default-project-classification --projectIdOrKey <projectIdOrKey>

get-email

Get project's sender email

Returns the project's sender email address.

Permissions required: Browse projects project permission for the project.

GET /rest/api/3/project/{projectId}/email

Flag	Type	Required	Description
`--projectId`	string	Yes	The project ID.

Example:

bash

jr project get-email --projectId <projectId>

get-features-for

Get project features

Returns the list of features for a project.

GET /rest/api/3/project/{projectIdOrKey}/features

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The ID or (case-sensitive) key of the project.

Example:

bash

jr project get-features-for --projectIdOrKey <projectIdOrKey>

get-hierarchy

Get project issue type hierarchy

Get the issue type hierarchy for a next-gen project.

The issue type hierarchy for a project consists of:

Epic at level 1 (optional).
One or more issue types at level 0 such as Story, Task, or Bug. Where the issue type Epic is defined, these issue types are used to break down the content of an epic.
Subtask at level -1 (optional). This issue type enables level 0 issue types to be broken down into components. Issues based on a level -1 issue type must have a parent issue.

Permissions required: Browse projects project permission for the project.

GET /rest/api/3/project/{projectId}/hierarchy

Flag	Type	Required	Description
`--projectId`	string	Yes	The ID of the project.

Example:

bash

jr project get-hierarchy --projectId <projectId>

get-issue-security-scheme

Get project issue security scheme

Returns the issue security scheme associated with the project.

Permissions required: Administer Jira global permission or the Administer Projects project permission.

GET /rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme

Flag	Type	Required	Description
`--projectKeyOrId`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project get-issue-security-scheme --projectKeyOrId <projectKeyOrId>

get-notification-scheme-for

Get project notification scheme

Gets a notification scheme associated with the project.

Permissions required: Administer Jira global permission or Administer Projects project permission.

GET /rest/api/3/project/{projectKeyOrId}/notificationscheme

Flag	Type	Required	Description
`--expand`	string	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

all Returns all expandable information
field Returns information about any custom fields assigned to receive an event
group Returns information about any groups assigned to receive an event
notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information
projectRole Returns information about any project roles assigned to receive an event
user Returns information about any users assigned to receive an event | | --projectKeyOrId | string | Yes | The project ID or project key (case sensitive). |

Example:

bash

jr project get-notification-scheme-for --projectKeyOrId <projectKeyOrId>

get-property

Get project property

Returns the value of a project property.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project containing the property.

GET /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).
`--propertyKey`	string	Yes	The project property key. Use Get project property keys to get a list of all project property keys.

Example:

bash

jr project get-property --projectIdOrKey <projectIdOrKey> --propertyKey <propertyKey>

get-property-keys

Get project property keys

Returns all project property keys for the project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

GET /rest/api/3/project/{projectIdOrKey}/properties

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project get-property-keys --projectIdOrKey <projectIdOrKey>

get-recent

Get recent projects

Returns a list of up to 20 projects recently viewed by the user that are still visible to the user.

This operation can be accessed anonymously.

Permissions required: Projects are returned only where the user has one of:

Browse Projects project permission for the project.
Administer Projects project permission for the project.
Administer Jira global permission.

GET /rest/api/3/project/recent

Flag	Type	Required	Description
`--expand`	string	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:

description Returns the project description.
projectKeys Returns all project keys associated with a project.
lead Returns information about the project lead.
issueTypes Returns all issue types associated with the project.
url Returns the URL associated with the project.
permissions Returns the permissions associated with the project.
insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.
* Returns the project with all available expand options. | | --properties | string | No | EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored. |

Example:

bash

jr project get-recent

get-role

Get project role for project

Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.

To check whether a user belongs to a role based on their group memberships, use Get user with the groups expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

GET /rest/api/3/project/{projectIdOrKey}/role/{id}

Flag	Type	Required	Description
`--excludeInactiveUsers`	string	No	Exclude inactive users.
`--id`	string	Yes	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project get-role --id <id> --projectIdOrKey <projectIdOrKey>

get-role-details

Get project role details

Returns all project roles and the details for each role. Note that the list of project roles is common to all projects.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer projects project permission for the project.

GET /rest/api/3/project/{projectIdOrKey}/roledetails

Flag	Type	Required	Description
`--currentMember`	string	No	Whether the roles should be filtered to include only those the user is assigned to.
`--excludeConnectAddons`	string	No
`--excludeOtherServiceRoles`	string	No	Do not return the default JSM company-managed space from CSM spaces, or the default CSM roles from JSM spaces.
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project get-role-details --projectIdOrKey <projectIdOrKey>

get-roles

Get project roles for project

Returns a list of project roles for the project returning the name and self URL for each role.

Note that all project roles are shared with all projects in Jira Cloud. See Get all project roles for more information.

This operation can be accessed anonymously.

Permissions required: Administer Projects project permission for any project on the site or Administer Jira global permission.

GET /rest/api/3/project/{projectIdOrKey}/role

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project get-roles --projectIdOrKey <projectIdOrKey>

get-security-levels-for

Get project issue security levels

Returns all issue security levels for the project that the user has access to.

This operation can be accessed anonymously.

Permissions required: Browse projects global permission for the project, however, issue security levels are only returned for authenticated user with Set Issue Security global permission for the project.

GET /rest/api/3/project/{projectKeyOrId}/securitylevel

Flag	Type	Required	Description
`--projectKeyOrId`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project get-security-levels-for --projectKeyOrId <projectKeyOrId>

get-type-by-key

Get project type by key

Returns a project type.

This operation can be accessed anonymously.

Permissions required: None.

GET /rest/api/3/project/type/{projectTypeKey}

Flag	Type	Required	Description
`--projectTypeKey`	string	Yes	The key of the project type.

Example:

bash

jr project get-type-by-key --projectTypeKey <projectTypeKey>

get-versions

Get project versions

Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

GET /rest/api/3/project/{projectIdOrKey}/versions

Flag	Type	Required	Description
`--expand`	string	No	Use expand to include additional information in the response. This parameter accepts `operations`, which returns actions that can be performed on the version.
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project get-versions --projectIdOrKey <projectIdOrKey>

get-versions-paginated

Get project versions paginated

Returns a paginated list of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

GET /rest/api/3/project/{projectIdOrKey}/version

Flag	Type	Required	Description
`--expand`	string	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

issuesstatus Returns the number of issues in each status category for each version.
operations Returns actions that can be performed on the specified version.
driver Returns the Atlassian account ID of the version driver.
approvers Returns a list containing the approvers for this version. | | --maxResults | string | No | The maximum number of items to return per page. | | --orderBy | string | No | Order the results by a field:
description Sorts by version description.
name Sorts by version name.
releaseDate Sorts by release date, starting with the oldest date. Versions with no release date are listed last.
sequence Sorts by the order of appearance in the user interface.
startDate Sorts by start date, starting with the oldest date. Versions with no start date are listed last. | | --projectIdOrKey | string | Yes | The project ID or project key (case sensitive). | | --query | string | No | Filter the results using a literal string. Versions with matching name or description are returned (case insensitive). | | --startAt | string | No | The index of the first item to return in a page of results (page offset). | | --status | string | No | A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived. |

Example:

bash

jr project get-versions-paginated --projectIdOrKey <projectIdOrKey>

remove-default-project-classification

Remove the default data classification level from a project

Remove the default data classification level for a project.

Permissions required:

Administer projects project permission for the project.
Administer jira global permission.

DELETE /rest/api/3/project/{projectIdOrKey}/classification-level/default

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The project ID or project key (case-sensitive).

Example:

bash

jr project remove-default-project-classification --projectIdOrKey <projectIdOrKey>

restore

Restore deleted or archived project

Restores a project that has been archived or placed in the Jira recycle bin.

Permissions required:

Administer Jira global permissionfor Company managed projects.
Administer Jira global permission or Administer projects project permission for the project for Team managed projects.

POST /rest/api/3/project/{projectIdOrKey}/restore

Flag	Type	Required	Description
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project restore --projectIdOrKey <projectIdOrKey>

search

Get projects paginated

Returns a paginated list of projects visible to the user.

This operation can be accessed anonymously.

Permissions required: Projects are returned only where the user has one of:

Browse Projects project permission for the project.
Administer Projects project permission for the project.
Administer Jira global permission.

GET /rest/api/3/project/search

Flag	Type	Required	Description
`--action`	string	No	Filter results by projects for which the user can:

view the project, meaning that they have one of the following permissions:
- Browse projects project permission for the project.
- Administer projects project permission for the project.
- Administer Jira global permission.
browse the project, meaning that they have the Browse projects project permission for the project.
edit the project, meaning that they have one of the following permissions:
- Administer projects project permission for the project.
- Administer Jira global permission.
create the project, meaning that they have the Create issues project permission for the project in which the issue is created. | | --categoryId | string | No | The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. | | --expand | string | No | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:
description Returns the project description.
projectKeys Returns all project keys associated with a project.
lead Returns information about the project lead.
issueTypes Returns all issue types associated with the project.
url Returns the URL associated with the project.
insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. | | --id | string | No | The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Up to 50 project IDs can be provided. | | --keys | string | No | The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, keys=PA&keys=PB. Up to 50 project keys can be provided. | | --maxResults | string | No | The maximum number of items to return per page. Must be less than or equal to 100. If a value greater than 100 is provided, the maxResults parameter will default to 100. | | --orderBy | string | No | Order the results by a field.
category Sorts by project category. A complete list of category IDs is found using Get all project categories.
issueCount Sorts by the total number of issues in each project.
key Sorts by project key.
lastIssueUpdatedTime Sorts by the last issue update time.
name Sorts by project name.
owner Sorts by project lead.
archivedDate EXPERIMENTAL. Sorts by project archived date.
deletedDate EXPERIMENTAL. Sorts by project deleted date. | | --properties | string | No | EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. | | --propertyQuery | string | No | EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of nested from {"something":{"nested":1,"other":2}} use [thepropertykey].something.nested=1. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that thepropertykey is only returned when included in properties. | | --query | string | No | Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive). | | --startAt | string | No | The index of the first item to return in a page of results (page offset). | | --status | string | No | EXPERIMENTAL. Filter results by project status:
live Search live projects.
archived Search archived projects.
deleted Search deleted projects, those in the recycle bin. | | --typeKey | string | No | Orders results by the project type. This parameter accepts a comma-separated list. Valid values are business, service_desk, and software. |

Example:

bash

jr project search

set-actors

Set actors for project role

Sets the actors for a project role for a project, replacing all existing actors.

To add actors to the project without overwriting the existing list, use Add actors to project role.

Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

PUT /rest/api/3/project/{projectIdOrKey}/role/{id}

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--id`	string	Yes	The ID of the project role. Use Get all project roles to get a list of project role IDs.
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).

Example:

bash

jr project set-actors --id <id> --projectIdOrKey <projectIdOrKey>

set-property

Set project property

Sets the value of the project property. You can use project properties to store custom data against the project.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project in which the property is created.

PUT /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--projectIdOrKey`	string	Yes	The project ID or project key (case sensitive).
`--propertyKey`	string	Yes	The key of the project property. The maximum length is 255 characters.

Example:

bash

jr project set-property --projectIdOrKey <projectIdOrKey> --propertyKey <propertyKey>

toggle-feature-for

Set project feature state

Sets the state of a project feature.

PUT /rest/api/3/project/{projectIdOrKey}/features/{featureKey}

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--featureKey`	string	Yes	The key of the feature.
`--projectIdOrKey`	string	Yes	The ID or (case-sensitive) key of the project.

Example:

bash

jr project toggle-feature-for --featureKey <featureKey> --projectIdOrKey <projectIdOrKey>

update

Update project

Updates the project details of a project.

All parameters are optional in the body of the request. Schemes will only be updated if they are included in the request, any omitted schemes will be left unchanged.

Permissions required: Administer Jira global permission. is only needed when changing the schemes or project key. Otherwise you will only need Administer Projects project permission

PUT /rest/api/3/project/{projectIdOrKey}

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--expand`	string	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:

description The project description.
issueTypes The issue types associated with the project.
lead The project lead.
projectKeys All project keys associated with the project. | | --projectIdOrKey | string | Yes | The project ID or project key (case sensitive). |

Example:

bash

jr project update --projectIdOrKey <projectIdOrKey>

update-avatar

Set project avatar

Sets the avatar displayed for a project.

Use Load project avatar to store avatars against the project, before using this operation to set the displayed avatar.

Permissions required: Administer projects project permission.

PUT /rest/api/3/project/{projectIdOrKey}/avatar

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--projectIdOrKey`	string	Yes	The ID or (case-sensitive) key of the project.

Example:

bash

jr project update-avatar --projectIdOrKey <projectIdOrKey>

update-default-project-classification

Update the default data classification level of a project

Updates the default data classification level for a project.

Permissions required:

Administer projects project permission for the project.
Administer jira global permission.

PUT /rest/api/3/project/{projectIdOrKey}/classification-level/default

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--projectIdOrKey`	string	Yes	The project ID or project key (case-sensitive).

Example:

bash

jr project update-default-project-classification --projectIdOrKey <projectIdOrKey>

update-email

Set project's sender email

Sets the project's sender email address.

If emailAddress is an empty string, the default email address is restored.

Permissions required: Administer Jira global permission or Administer Projects project permission.

PUT /rest/api/3/project/{projectId}/email

Flag	Type	Required	Description
`--body`	string	No	request body (JSON string, @file, or - for stdin)
`--projectId`	string	Yes	The project ID.

Example:

bash

jr project update-email --projectId <projectId>

project ​

add-actor-users ​

archive ​

assign-permission-scheme ​

create ​

create-avatar ​

delete ​

delete-actor ​

delete-asynchronously ​

delete-avatar ​

delete-property ​

get ​

get-accessible-project-type-by-key ​

get-all ​

get-all-accessible-project-types ​

get-all-project-avatars ​

get-all-project-types ​

get-all-statuses ​

get-assigned-permission-scheme ​

get-classification-config ​

get-components ​

get-components-paginated ​

get-default-project-classification ​

get-email ​

get-features-for ​

get-hierarchy ​

get-issue-security-scheme ​

get-notification-scheme-for ​

get-property ​

get-property-keys ​

get-recent ​

get-role ​

get-role-details ​

get-roles ​

get-security-levels-for ​

get-type-by-key ​

get-versions ​

get-versions-paginated ​

remove-default-project-classification ​

restore ​

search ​

set-actors ​

set-property ​

toggle-feature-for ​

update ​

update-avatar ​

update-default-project-classification ​

update-email ​

project

add-actor-users

archive

assign-permission-scheme

create

create-avatar

delete

delete-actor

delete-asynchronously

delete-avatar

delete-property

get

get-accessible-project-type-by-key

get-all

get-all-accessible-project-types

get-all-project-avatars

get-all-project-types

get-all-statuses

get-assigned-permission-scheme

get-classification-config

get-components

get-components-paginated

get-default-project-classification

get-email

get-features-for

get-hierarchy

get-issue-security-scheme

get-notification-scheme-for

get-property

get-property-keys

get-recent

get-role

get-role-details

get-roles

get-security-levels-for

get-type-by-key

get-versions

get-versions-paginated

remove-default-project-classification

restore

search

set-actors

set-property

toggle-feature-for

update

update-avatar

update-default-project-classification

update-email