forge
bulk-pin-unpin-projects-async
Bulk pin or unpin issue panel to projects
Bulk pin or unpin an issue panel (added by a Forge app) to or from multiple projects.
The operation runs asynchronously. The response includes a task ID - use the Get task endpoint to check progress.
Permissions required: Administer Jira global permission.
POST /rest/api/3/forge/panel/action/bulk/async
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
Example:
jr forge bulk-pin-unpin-projects-asyncdelete-app-property
Delete app property (Forge)
Deletes a Forge app's property.
Permissions required: Only Forge apps can make this request. This API can only be accessed using asApp() requests from Forge.
The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
DELETE /rest/forge/1/app/properties/{propertyKey}
| Flag | Type | Required | Description |
|---|---|---|---|
--propertyKey | string | Yes | The key of the property. |
Example:
jr forge delete-app-property --propertyKey <propertyKey>get-app-property
Get app property (Forge)
Returns the value of a Forge app's property.
Permissions required: Only Forge apps can make this request. This API can only be accessed using asApp() requests from Forge.
GET /rest/forge/1/app/properties/{propertyKey}
| Flag | Type | Required | Description |
|---|---|---|---|
--propertyKey | string | Yes | The key of the property. |
Example:
jr forge get-app-property --propertyKey <propertyKey>get-app-property-keys
Get app property keys (Forge)
Returns all property keys for the Forge app.
Permissions required: Only Forge apps can make this request. This API can only be accessed using asApp() requests from Forge.
GET /rest/forge/1/app/properties
Example:
jr forge get-app-property-keysput-app-property
Set app property (Forge)
Sets the value of a Forge app's property. These values can be retrieved in Jira expressions through the app context variable. They are also available in entity property display conditions.
For other use cases, use the Storage API.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
Permissions required: Only Forge apps can make this request. This API can only be accessed using asApp() requests from Forge.
The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
PUT /rest/forge/1/app/properties/{propertyKey}
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--propertyKey | string | Yes | The key of the property. |
Example:
jr forge put-app-property --propertyKey <propertyKey>