atlassian-connect

addon-properties-resource.delete-addon-property_delete

Delete app property

Deletes an app's property.

Permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties (stored against the same app.connect.key).

DELETE /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

Flag	Type	Required	Description
--addonKey	string	Yes	The key of the app, as defined in its descriptor.
--propertyKey	string	Yes	The key of the property.

Example:

jr atlassian-connect addon-properties-resource.delete-addon-property_delete --addonKey <addonKey> --propertyKey <propertyKey>

addon-properties-resource.get-addon-properties_get

Get app properties

Gets all the properties of an app.

Permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties (stored against the same app.connect.key).

GET /rest/atlassian-connect/1/addons/{addonKey}/properties

Flag	Type	Required	Description
--addonKey	string	Yes	The key of the app, as defined in its descriptor.

Example:

jr atlassian-connect addon-properties-resource.get-addon-properties_get --addonKey <addonKey>

addon-properties-resource.get-addon-property_get

Get app property

Returns the key and value of an app's property.

Permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties (stored against the same app.connect.key).

GET /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

Flag	Type	Required	Description
--addonKey	string	Yes	The key of the app, as defined in its descriptor.
--propertyKey	string	Yes	The key of the property.

Example:

jr atlassian-connect addon-properties-resource.get-addon-property_get --addonKey <addonKey> --propertyKey <propertyKey>

addon-properties-resource.put-addon-property_put

Set app property

Sets the value of an app's property. Use this resource to store custom data for your app.

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

Permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties (stored against the same app.connect.key).

PUT /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

Flag	Type	Required	Description
--addonKey	string	Yes	The key of the app, as defined in its descriptor.
--body	string	No	request body (JSON string, @file, or - for stdin)
--propertyKey	string	Yes	The key of the property.

Example:

jr atlassian-connect addon-properties-resource.put-addon-property_put --addonKey <addonKey> --propertyKey <propertyKey>

app-issue-field-value-update-resource.update-issue-fields_put

Bulk update custom field value

Updates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom fields can be updated.

Permissions required: Only Connect apps can make this request

PUT /rest/atlassian-connect/1/migration/field

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

Example:

jr atlassian-connect app-issue-field-value-update-resource.update-issue-fields_put

connect-to-forge-migration-fetch-task-resource.fetch-migration-task_get

Get Connect issue field migration task

Returns the details of a Connect issue field's migration to Forge.

When migrating a Connect app to Forge, Issue Field modules must be converted to Custom field. When the Forge version of the app is installed, Forge creates a background task to track the migration of field data across. This endpoint returns the status and other details of that background task.

For more details, see Jira modules > Jira Custom Fields.

Permissions required: Only Connect and Forge apps can make this request.

GET /rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/task

Flag	Type	Required	Description
--connectKey	string	Yes	The key of the Connect app that contains the Jira issue field being migrated.
--jiraIssueFieldsKey	string	Yes	The module key of the Connect issue field being migrated.

Example:

jr atlassian-connect connect-to-forge-migration-fetch-task-resource.fetch-migration-task_get --connectKey <connectKey> --jiraIssueFieldsKey <jiraIssueFieldsKey>

connect-to-forge-migration-task-submission-resource.submit-task_post

Submit Connect issue field migration task

Submits a request to trigger migration of connect issue field to its Forge custom field counterpart.

When migrating a Connect app to Forge, Issue Field modules must be converted to Custom field modules. This endpoint triggers the background migration of field data. Use the GET endpoint to retrieve the status and progress of the task.

For more details, see Jira modules > Jira Custom Fields.

Permissions required: Only Connect and Forge apps can make this request.

POST /rest/atlassian-connect/1/migration/{connectKey}/{jiraIssueFieldsKey}/task

Flag	Type	Required	Description
--connectKey	string	Yes	The key of the Connect app that contains the Jira issue field being migrated.
--jiraIssueFieldsKey	string	Yes	The module key of the Connect issue field being migrated.

Example:

jr atlassian-connect connect-to-forge-migration-task-submission-resource.submit-task_post --connectKey <connectKey> --jiraIssueFieldsKey <jiraIssueFieldsKey>

dynamic-modules-resource.get-modules_get

Get modules

Returns all modules registered dynamically by the calling app.

Permissions required: Only Connect apps can make this request.

GET /rest/atlassian-connect/1/app/module/dynamic

Example:

jr atlassian-connect dynamic-modules-resource.get-modules_get

dynamic-modules-resource.register-modules_post

Register modules

Registers a list of modules.

Permissions required: Only Connect apps can make this request.

POST /rest/atlassian-connect/1/app/module/dynamic

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

Example:

jr atlassian-connect dynamic-modules-resource.register-modules_post

dynamic-modules-resource.remove-modules_delete

Remove modules

Remove all or a list of modules registered by the calling app.

Permissions required: Only Connect apps can make this request.

DELETE /rest/atlassian-connect/1/app/module/dynamic

Flag	Type	Required	Description
--moduleKey	string	No	The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter.
For example, moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field.
Nonexistent keys are ignored.

Example:

jr atlassian-connect dynamic-modules-resource.remove-modules_delete

migration-resource.update-entity-properties-value_put

Bulk update entity properties

Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for use by Connect apps during app migration.

PUT /rest/atlassian-connect/1/migration/properties/{entityType}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--entityType	string	Yes	The type indicating the object that contains the entity properties.

Example:

jr atlassian-connect migration-resource.update-entity-properties-value_put --entityType <entityType>

migration-resource.workflow-rule-search_post

Get workflow transition rule configurations

Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.

POST /rest/atlassian-connect/1/migration/workflow/rule/search

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

Example:

jr atlassian-connect migration-resource.workflow-rule-search_post

service-registry-resource.services_get

Retrieve the attributes of service registries

Retrieve the attributes of given service registries.

Permissions required: Only Connect apps can make this request and the servicesIds belong to the tenant you are requesting

GET /rest/atlassian-connect/1/service-registry

Flag	Type	Required	Description
--serviceIds	string	No	The ID of the services (the strings starting with "b:" need to be decoded in Base64).

Example:

jr atlassian-connect service-registry-resource.services_get