Streamdata.io API Gallery - Atlassian (Report Issue)

Organization(s):

Atlassian Get application property

Returns an application property.

Atlassian Get advanced settings

Returns the properties that are displayed on the General Configuration Advanced Settings page.

Atlassian Set application property

Modify an application property via PUT. The "value" field present in the PUT will override the existing value.

Atlassian Get all application roles

Returns all ApplicationRoles in the system. Will also return an ETag header containing a version hash of the collection of ApplicationRoles.

Atlassian Get application role

Returns the ApplicationRole with passed key if it exists.

Atlassian Delete attachment

Deletes an attachment from an issue. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Any of the following permissions in the project that the issue is in: * _Delete own attachments_ [project permission](https://confl...

Atlassian Get attachment metadata

Returns the metadata for an attachment. Note that the attachment itself is not returned. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** None, however the calling user must have permission to view the issue that the att...

Atlassian Get all metadata for an expanded attachment

Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ...

Atlassian Get contents metadata for an expanded attachment

Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported. Us...

Atlassian Get global attachment settings

Returns the global attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed. Note that there are also [project permissions](https://confluence.atlassian.com/x/yodKLg) that restrict whether users ca...

Atlassian Get audit records

Returns auditing records filtered using provided parameters

Atlassian Get all system avatars

Returns all system avatars of the given type.

Atlassian Get comment property keys

Returns the keys of all properties for the comment identified by the key or by the id.

Atlassian Delete comment property

Removes the property from the comment identified by the key or by the id. Ths user removing the property is required to have permissions to administer the comment.

Atlassian Get comment property

Returns the value of the property with a given key from the comment identified by the key or by the id. The user who retrieves the property is required to have permissions to read the comment.

Atlassian Set comment property

Sets the value of the specified comment's property. You can use this resource to store a custom data against the comment identified by the key or by the id. The user who stores the data is required to have permissions to administer the comment.

Atlassian Get comments by ids

Returns comments for given comments ids. Only comments to which the user has permissions, will be included in the result. The returned set of comments is limited to 1000 elements.

Atlassian Create component

Creates a component. Use components to provide containers for issues within a project. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: Any of the following: * _Administer Jira_ [global permission](https://confluence.atlassian...

Atlassian Delete component

Deletes a component. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: Any of the following: * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). * _Administer projects_ [project permission](htt...

Atlassian Get component

Returns a component. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg).

Atlassian Update component

Modifies a component. Any fields included in the request are overwritten. If `leadUserName` is an empty string ("") the component lead is removed. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: Any of the following: * _Admin...

Atlassian Get component issues count

Returns the counts of issues assigned to the component. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira.

Atlassian Get global settings

Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) in Jira. These settings determine whether optional features (for example, sub-tasks, time tracking, and others) are enabled. If time tracking is enabled, this method also retu...

Atlassian Disable time tracking

Disables time tracking. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** Jira administration (that is, member of the _administrators_ [group](https://confluence.atlassian.com/x/24xjL)).

Atlassian Get selected time tracking provider

Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) re...

Atlassian Select time tracking provider

Selects a time tracking provider. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** Jira administration (that is, member of the _administrators_ [group](https://confluence.atlassian.com/x/24xjL)).

Atlassian Get all time tracking providers

Returns all time tracking providers. By default, Jira only has one time tracking provider: _JIRA provided time tracking_. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time ...

Atlassian Get time tracking settings

Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM). **[Permissions](https://develo...

Atlassian Set time tracking settings

Sets the time tracking settings. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** Jira administration (that is, member of the _administrators_ [group](https://confluence.atlassian.com/x/24xjL)).

Atlassian Get custom field option

Returns a custom field option. For example, an option in a cascading select list. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** None.

Atlassian Get all dashboards

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira.

Atlassian Get dashboard item property keys

Returns the keys of all properties for a dashboard item. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira. However, to get the property keys the user must be the owner of the dashboard or be sha...

Atlassian Delete dashboard item property

Deletes a dashboard item property. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira. However, to delete a dashboard item property the user must be the owner of the dashboard. Note, users with th...

Atlassian Get dashboard item property

Returns the key and value of a dashboard item property. A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more inf...

Atlassian Set dashboard item property

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item. A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users a...

Atlassian Get dashboard

Returns a dashboard. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira. However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the _Admi...

Atlassian Evaluate Jira expression

Evaluates a Jira expression and returns its value. Jira expressions is the name of a domain-specific language for Jira that can be used to evaluate expressions in the context of Jira entities.

Atlassian Get fields

Returns all issue fields in Jira, both system and custom fields. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** None, however the following rules apply: * Fields that cannot be added to the issue navigator are always re...

Atlassian Create custom field

Creates a custom field. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission.

Atlassian Get all issue field options

Returns all options defined for a select list issue field. A select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that allows a user to select an value from a list of options....

Atlassian Create issue field option

Creates an option for a select list issue field. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission. Jira permissions are not required for the app providing the field.

Atlassian Delete issue field option

Deletes an option from a select list issue field. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission. Jira permissions are not required for the app providing the field.

Atlassian Get issue field option

Returns an option from a select list issue field. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission. Jira permissions are not required for the app providing the field.

Atlassian Update issue field option

Updates an option for a select list issue field. If the option does not exist, a new option is created. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission. Jira permissions are not required ...

Atlassian Replace issue field option

Deselects a select list issue field option in all issues that it has been selected in. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query. This is an...

Atlassian Get selectable issue field options

Returns options defined for a select list issue field that can be viewed and selected by the currently logged in user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira.

Atlassian Get visible issue field options

Returns options defined for a select list issue field that can be viewed by the currently logged in user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira.

Atlassian Get filters

Returns all filters. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** None, however only the following filters are returned: * Filters owned by the user. * Filters shared with a group that the user is a member of. * Fi...

Atlassian Create filter

Creates a new filter. The new filter is not shared and not selected as a favorite. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira.

Atlassian Get default share scope

Returns the default sharing settings for new filters and dashboards for a user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (i.e., member of the _users_ [group](https://confluence.atlassian.c...

Atlassian Set default share scope

Sets the default sharing for new filters and dashboards for a user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (i.e., member of the _users_ [group](https://confluence.atlassian.com/x/24xjL)).

Atlassian Get favourite filters

Returns the favorite filters of the calling user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (i.e., member of the _users_ [group](https://confluence.atlassian.com/x/24xjL)).

Atlassian Delete filter

Delete a filter. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira, however the following rules govern what a user can delete: * Private filters (i.e., not shared) can only be deleted by the cre...

Atlassian Get filter

Returns a filter. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** None, however the calling user must have permission view the filter.

Atlassian Update filter

Updates an existing filter. Use this method to update a filter's name, description, JQL, or sharing. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira, however the following rules govern what a use...

Atlassian Reset columns

Reset the user's column configuration for the filter to the default. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (i.e., member of the _users_ [group](https://confluence.atlassian.com/x/24xjL)...

Atlassian Get columns

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in _List View_ with the _Columns_ set to _Filter_. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** None, howe...

Atlassian Set columns

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](https://developer.atlassian.com/cloud/jira/platform/rest#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `tr...

Atlassian Remove filter as favorite

Removes a filter as a favorite for the calling user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (i.e., member of the _users_ [group](https://confluence.atlassian.com/x/24xjL)) and permission...

Atlassian Add filter as favorite

Add a filter as a favorite for the calling user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (i.e., member of the _users_ [group](https://confluence.atlassian.com/x/24xjL)) and permission to ...

Atlassian Get share permissions

Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission. **[Permissions](https://confluence....

Atlassian Add share permission

Add a share permissions to a filter. If you add a global share permission (i.e., all logged-in users or the public) it will overwrite all share permissions for the filter. Be aware that this method uses different objects for updating share permi...

Atlassian Delete share permission

Deletes a share permission from a filter. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (i.e., member of the _users_ [group](https://confluence.atlassian.com/x/24xjL)) and the calling user must...

Atlassian Get share permission

Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission. **[Permissions](https://confluence.atl...

Atlassian Get my filters

Returns the filters owned by the calling user. If `includeFavourites` is `true`, the user's favorite filters are also returned. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (i.e., member of th...

Atlassian Search for filters

Search for filters. This method is similar to [Get filters](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-filter-get) except that you can refine the results to include filters that have specific attributes. For example, filte...

Atlassian Remove group

Deletes a group. **[Permissions required](https://confluence.atlassian.com/x/FQiiLQ):** _Administer Jira_ [global permission](https://confluence.atlassian.com/adminjiracloud/managing-global-permissions-776636359.html).

Atlassian Get group

This resource is deprecated, use [`group/member`](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-group-member-get). Returns all users in a group. **[Permissions required](https://confluence.atlassian.com/x/FQiiLQ):** _Admini...

Atlassian Create group

Creates a group. **[Permissions required](https://confluence.atlassian.com/x/FQiiLQ):** _Administer Jira_ [global permission](https://confluence.atlassian.com/adminjiracloud/managing-global-permissions-776636359.html).

Atlassian Get users from group

Returns all users in a group. Users are ordered by username. **[Permissions required](https://confluence.atlassian.com/x/FQiiLQ):** _Administer Jira_ [global permission](https://confluence.atlassian.com/adminjiracloud/managing-global-permissions-...

Atlassian Find groups

Returns groups with substrings matching a given query. This is mainly for use with the group picker, so the returned groups contain html to be used as picker suggestions. The groups are also wrapped in a single response object that also contains a...

Atlassian Remove user from group

Removes a user from a group. **[Permissions required](https://confluence.atlassian.com/x/FQiiLQ):** _Administer Jira_ [global permission](https://confluence.atlassian.com/adminjiracloud/managing-global-permissions-776636359.html).

Atlassian Add user to group

Adds a user to a group. **[Permissions required](https://confluence.atlassian.com/x/FQiiLQ):** _Administer Jira_ [global permission](https://confluence.atlassian.com/adminjiracloud/managing-global-permissions-776636359.html).

Atlassian Find users and groups

Returns a list of users and groups matching query with highlighting. This resource cannot be accessed anonymously.

Atlassian Create issue

Creates an issue or a sub-task from a JSON representation. You can provide two parameters in request's body: `update` or `fields`. The fields, that can be set on an issue create operation, can be determined using the **/rest/api/2/issue/createmet...

Atlassian Create issues

Creates multiple issues or sub-tasks from a JSON representation, in a single bulk operation. Creating a sub-task is similar to creating an issue - check Create issue section for details: {@link IssueResource#createIssue(boolean, IssueUpdateBean)}}

Atlassian Get create issue meta

Returns the metadata for creating issues. This includes the available projects, issue types, fields (with information whether those fields are required) and field types. Projects, in which the user does not have permission to create issues, will n...

Atlassian Delete issue

Deletes an individual issue. If the issue has sub-tasks you must set the `deleteSubtasks=true` parameter to delete the issue. You cannot delete an issue without deleting its sub-tasks.

Atlassian Get issue

Returns a full representation of the issue for the given issue key. The issue JSON consists of the issue key and a collection of fields. Additional information like links to workflow transition sub-resources, or HTML rendered values of the fields...

Atlassian Edit issue

Edits the issue from a JSON representation. The fields available for update can be determined using the **/rest/api/2/issue/{issueIdOrKey}/editmeta** resource. If a field is hidden from the Edit screen then it will not be returned by the editme...

Atlassian Assign issue

Assigns the issue to the user. Use this resource to assign issues for the users having "Assign Issue" permission, and not having the "Edit Issue" permission. If `name` body parameter is set to "-1" then automatic issue assignee is used. A `name` s...

Atlassian Add attachment

Add one or more attachments to an issue. This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java th...

Atlassian Get change logs

Returns a [paginated](#pagination) list of all updates of an issue, sorted by date, starting from the oldest.

Atlassian Get comments

Returns all comments for an issue. Results can be ordered by the "created" field which means the date a comment was added.

Atlassian Add comment

Adds a new comment to an issue.

Atlassian Delete comment

Deletes an existing comment .

Atlassian Get comment

Returns a single comment.

Atlassian Update comment

Updates an existing comment using its JSON representation.

Atlassian Get edit issue meta

Returns the metadata for editing an issue. The fields returned by editmeta resource are the ones shown on the issue's Edit screen. Fields hidden from the screen will not be returned unless `overrideScreenSecurity` parameter is set to true. If an...

Atlassian Notify

Sends an email notification to the list of users defined in the request body parameters.

Atlassian Get issue property keys

Returns the keys of all properties for the issue identified by the key or by the id.

Atlassian Delete issue property

Removes the property from the issue identified by the key or by the id. Ths user removing the property is required to have permissions to edit the issue.

Atlassian Get issue property

Returns the value of the property with a given key from the issue identified by the key or by the id. The user who retrieves the property is required to have permissions to read the issue.

Atlassian Set issue property

Sets the value of the specified issue's property. You can use this resource to store a custom data against the issue identified by the key or by the id. The user who stores the data is required to have permissions to edit the issue.

Atlassian Delete remote issue link by global id

Deletes the issue's remote link with the given global ID.

Atlassian Get remote issue links

Returns the remote issue links for the issue. This may be links to other Jira instances, web applications or web pages.

Atlassian Create or update remote issue link

Creates or updates a remote issue link from a JSON representation. If a `globalId` is provided and a remote issue link exists with that globalId, the remote issue link is updated. Otherwise, the remote issue link is created.

Atlassian Delete remote issue link by id

Deletes the issue's remote link with the given ID.

Atlassian Get remote issue link by id

Returns the remote issue link by the given ID.

Atlassian Update remote issue link

Updates a remote issue link from a JSON representation. Sets all fields without values provided to null.

Atlassian Get transitions

Returns a list of transitions available for this issue for the current user. Specify `expand=transitions.fields` parameter to retrieve the fields required for a transition together with their types. Fields metadata corresponds to the fields avai...

Atlassian Do transition

Performs the issue transition. While performing the transition you can modify other issue fields. The fields that can be set on transition, in either `fields` or `update` parameter can be determined using the **/rest/api/2/issue/{issueIdOrKey}/tr...

Atlassian Remove vote

Removes a current user's vote from an issue (aka "unvote").

Atlassian Get votes

Returns voting data for an issue - whether the issue was voted for, total number of votes and users who voted for the issue.

Atlassian Add vote

Adds a vote on the issue for a current user.

Atlassian Remove watcher

Removes the user from the issue's watcher list.

Atlassian Get issue watchers

Returns the list of watchers for the issue with the given key.

Atlassian Add watcher

Adds the user to the issue's watcher list.

Atlassian Get issue worklog

Returns all work logs for an issue. The response is [paginated](#pagination) **Note:** Work logs won't be returned if the Log work field is hidden for the project.

Atlassian Add worklog

Adds a new worklog entry to an issue.

Atlassian Delete worklog

Deletes an existing worklog entry.

Atlassian Get worklog

Returns a specific worklog. **Note:** The work log won't be returned if the Log work field is hidden for the project.

Atlassian Update worklog

Updates an existing worklog entry. Note that: * Fields possible for editing are: comment, visibility, started, timeSpent and timeSpentSeconds. * Either timeSpent or timeSpentSeconds can be set. * Fields which are not set will not be update...

Atlassian Get worklog property keys

Returns the keys of all properties for the worklog identified by the key or by the id.

Atlassian Delete worklog property

Removes the property from the worklog identified by the key or by the id. Ths user removing the property is required to have permissions to administer the worklog.

Atlassian Get worklog property

Returns the value of the property with a given key from the worklog identified by the key or by the id. The user who retrieves the property is required to have permissions to read the worklog.

Atlassian Set worklog property

Sets the value of the specified worklog's property. You can use this resource to store a custom data against the worklog identified by the key or by the id. The user who stores the data is required to have permissions to administer the worklog.

Atlassian Link issues

Creates an issue link between two issues. The user requires the link issue permission for the issue which will be linked to another issue. The specified link type in the request is used to create the link and will create a link from the first issu...

Atlassian Delete issue link

Deletes an issue link with the specified id. To be able to delete an issue link you must be able to view both issues and must have the link issue permission for at least one of the issues.

Atlassian Get issue link

Returns an issue link with the specified id.

Atlassian Get issue link types

Returns a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link relationship.

Atlassian Create issue link type

Create a new issue link type.

Atlassian Delete issue link type

Delete the specified issue link type.

Atlassian Get issue link type

Returns for a given issue link type id all information about this issue link type.

Atlassian Update issue link type

Update the specified issue link type.

Atlassian Get issue picker resource

Returns a list of suggested issues matching the auto-completion query for the user executing this request. This REST method checks the user's history and browsing context to return issue suggestions.

Atlassian Bulk delete issue property

Allows to delete a property from all issues identified by a given filter. Only entities the user has permissions to edit will be updated. See the [issue property bulk set endpoint documentation](#api-api-2-issue-properties-propertyKey-put) for mor...

Atlassian Bulk set issue property

Allows to set a property for all issues identified by a given filter. Only entities the user has permissions to edit will be updated. Currently the following filters are available: * **entityIds** \- A list of issues to update. Only issues wit...

Atlassian Get issue security schemes

Returns all issue security schemes that are defined.

Atlassian Get issue security scheme

Returns the issue security scheme along with that are defined.

Atlassian Get all issue types for user

Returns all issue types. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira, however, only issue types that are visible to the user are returned.

Atlassian Create issue type

Creates an issue type and adds it to the default issue type scheme. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](href=).

Atlassian Delete issue type

Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (`alternativeIssueTypeId`). A list of alternative issue types can be obtained from the [Get alternative issue types](https://developer.atlass...

Atlassian Get issue type

Returns an issue type. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: * _Administer Jira_ [global permission](href=) to get the details of any issue type. * _Browse projects_ project permission to get the details of any is...

Atlassian Update issue type

Updates the issue type. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](href=).

Atlassian Get alternative issue types

Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme. **[Permissions](https://confluence.atlassian.com/x...

Atlassian Create issue type avatar

Creates an avatar for the issue type. Specify the avatar's local file location as binary data in the body of the request. Also, include the following headers: * `X-Atlassian-Token: no-check` * `Content-Type: image/_image type_` Valid image ty...

Atlassian Get issue type property keys

Returns all the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys of the issue type. **[Permissions](https://confluence.atlassian.c...

Atlassian Delete issue type property

Deletes the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _A...

Atlassian Get issue type property

Returns the key and value of the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). [Permissions](https://confluence.atlassian.com/x/FQi...

Atlassian Set issue type property

Creates or updates the value of the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). Use this resource to store and update data agains...

Atlassian Get auto complete

Returns the auto complete data required for JQL searches.

Atlassian Get field auto complete for query string

Returns auto complete suggestions for JQL search.

Atlassian Validate license

Validates a Jira license. Typically used by the setup phase of the Jira application. Returns an object with a list of errors as key, value pairs if the license is not valid.

Atlassian Get my permissions

Checks whether the current user has the given permissions. You can optionally provide a specific context to get permissions for (`projectKey` OR `projectId` OR `issueKey` OR `issueId`) If there is no context provided, then the project related per...

Atlassian Remove preference

Removes preference of the currently logged in user. Preference key must be provided as input parameters (key).

Atlassian Get preference

Returns preference of the currently logged in user. Preference key must be provided as input parameter (key). The value is returned exactly as it is.

Atlassian Set preference

Sets preference of the currently logged in user. Preference key must be provided as input parameters (key). Value must be provided as POST body.

Atlassian Delete locale

Deletes the set locale of the currently logged in user, resetting it to default.

Atlassian Get locale

Returns the locale of the currently logged in user. If the user has no language preference explicitly set (the default setting), or is anonymous, this will be the browser locale detected by Jira. If browser detection is in effect, the "Accept-Lang...

Atlassian Set locale

Sets the locale of the currently logged in user. Locale JSON must be provided as PUT body.

Atlassian Get current user

Returns currently logged user. This resource cannot be accessed anonymously. The resource accepts the `expand` param that is used to include, hidden by default, parts of response. This can be used to include: * `groups` \- all groups, includin...

Atlassian Get notification schemes paginated

Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name. ### About notification schemes A notification scheme ...

Atlassian Get notification scheme

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** No...

Atlassian Get all permissions

Returns all permissions that are present in the Jira instance - Global, Project and the global ones added by plugins

Atlassian Get all permission schemes

Returns all permission schemes. ### About permission schemes and grants A permission scheme is a collection of permission grants. A permission grant consists of a `holder` and a `permission`. #### Holder The `holder` object contains informatio...

Atlassian Create permission scheme

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission.

Atlassian Delete permission scheme

Deletes a permission scheme. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission.

Atlassian Get permission scheme

Returns a permission scheme. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira.

Atlassian Update permission scheme

Updates a permission scheme. Below are some important things to note when using this resource: * If a permissions list is present in the request, then it will be set in the permission scheme, overwriting _all existing_ grants. * If you want t...

Atlassian Get permission scheme grants

Returns all permission grants for a permission scheme. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira.

Atlassian Create permission grant

Creates a new permission grant in the given permission scheme. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission.

Atlassian Delete permission scheme entity

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](https://developer.atlassian.com/cloud/jira/platform/rest/#about-permission-schemes) for more details. **[Permissions](https://confluence.atlassian.com/x...

Atlassian Get permission scheme grant

Returns a permission grant. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira.

Atlassian Get permitted projects

Returns all projects where currently logged in user was granted ALL requested project permissions.

Atlassian Get priorities

Returns a list of all issue priorities.

Atlassian Get priority

Returns an issue priority.

Atlassian Get all projects

Returns all projects visible to the currently logged in user. For projects to be visible, the authenticated user must be granted either _Browse projects_ or _Administer projects_ permissions. If no user is logged in, it returns all projects that a...

Atlassian Create project

Creates a new project. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission.

Atlassian Get all project categories

Returns all project categories

Atlassian Create project category

Create a project category via POST.

Atlassian Remove project category

Delete a project category.

Atlassian Get project category by id

Contains a representation of a project category in JSON format.

Atlassian Update project category

Modify a project category via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.

Atlassian Delete project

Deletes an existing project. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission.

Atlassian Get project

Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for the specified project. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Browse Projects_ project permission.

Atlassian Update project

Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of an existing project. All parameters are optional in the body of the request. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ glo...

Atlassian Create project avatar

Creates an avatar for a single project. Use it to upload an image to be be set as a project's avatar. The uploaded image will be cropped according to the crop parameters defined in the request. If no crop parameters are specified, the image will b...

Atlassian Delete project avatar

Deletes an avatar of a single project. It is only possible to delete custom avatars.

Atlassian Get all project avatars

Returns all project avatars visible for the currently logged in user. The avatars are grouped into system avatars and custom avatars.

Atlassian Get project components paginated

Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/#pagination) representation of all components existing in a single project. See the [Get project components](https://developer.atlassian.com/cloud/jira/platform/rest/#a...

Atlassian Get project components

Returns all components existing in a single project. See the [Get project components paginated](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-project-projectIdOrKey-component-get) resource if you want to get a full list of co...

Atlassian Get project property keys

Returns all [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys for the project. **[Permissions](https://confluence.atlassian.com/x/FQi...

Atlassian Delete project property

Removes the [property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) from the project. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) require...

Atlassian Get project property

Returns the value of the [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) req...

Atlassian Set project property

Sets the value of the [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). You can use project properties to store custom data against the pr...

Atlassian Get project roles for project

Returns a list of [project roles](https://confluence.atlassian.com/x/3odKLg) for the project. Note that all project roles are shared with all projects in Jira Cloud. See the [Get all project roles](https://developer.atlassian.com/cloud/jira/platf...

Atlassian Get project role details

Returns all [project roles](https://confluence.atlassian.com/x/3odKLg) and the details for each role. Note that the list of project roles is common to all projects.

Atlassian Delete actors from project role

Deletes actors from a project role for the project. If you want to remove default actors from the project role, see the [Delete default actors from project role](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-role-id-actors-d...

Atlassian Get project role for project

Returns the project role's details and actors associated with the project. The list of actors is sorted by display name. If you would like to check to see whether a user belongs to a role based on their group memberships, use the [Get user](https...

Atlassian Add actors to project role

Adds additional actors to a project role for the project. If you want to replace all actors for the project, then use [Set actors for project role](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-project-projectIdOrKey-role-id...

Atlassian Set actors for project role

Associates actors with the project role for the project, replacing all existing actors. If you want to add actors to the project without overwriting the existing list, then use [Add actors to project role](https://developer.atlassian.com/cloud/ji...

Atlassian Get all statuses

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. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:...

Atlassian Update project type

Updates the [project type](https://confluence.atlassian.com/x/GwiiLQ). **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission.

Atlassian Get project versions paginated

Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/#pagination) representation of all versions existing in a single project. See the [Get project versions](https://developer.atlassian.com/cloud/jira/platform/rest/#api-a...

Atlassian Get project versions

Returns all versions existing in a single project. The response is not paginated. Use [Get project versions paginated](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-project-projectIdOrKey-version-get) if you want to get the v...

Atlassian Get project issue security scheme

Returns the [issue security scheme](https://confluence.atlassian.com/x/J4lKLg) associated with the project. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](https://confluence.atlassian....

Atlassian Get project notification scheme

Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. See the [Get notification scheme](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-notificationscheme-id-get) resource for more...

Atlassian Get assigned permission scheme

Gets the [permission scheme](https://confluence.atlassian.com/x/yodKLg) associated with the project. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x...

Atlassian Assign permission scheme

Associates a permission scheme with a particular project. See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) requ...

Atlassian Get project issue security levels

Returns all [issue security](https://confluence.atlassian.com/x/J4lKLg) levels for the project that the currently authenticated user has access to. If the user does not have permission to see an issue security level, then that level is not returne...

Atlassian search

Returns all projects visible to the currently logged in user, i.e. all projects the user has permission defined by the {@code action} parameter. If no user is logged in, all projects visible to anonymous users are returned.

Atlassian Get all project types

Returns all [project types](https://confluence.atlassian.com/x/Var1Nw), whether or not the instance has a valid license for each type. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (that is, m...

Atlassian Get project type by key

Returns a [project type](https://confluence.atlassian.com/x/Var1Nw). **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (that is, member of the _users_ [group](https://confluence.atlassian.com/x/24...

Atlassian Get accessible project type by key

Returns a [project type](https://confluence.atlassian.com/x/Var1Nw) if it is accessible to the logged in user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (that is, member of the _users_ [gr...

Atlassian Validate project key

Validates a project key.

Atlassian Get valid project key

Validates the project key and generated a valid project key if the supplied key is invalid.

Atlassian Get valid project name

Validates a project name. If the name is invalid, an attempt is made to produce a valid name based on the supplied one. If no such valid name can be found, an empty string is returned.

Atlassian Get resolutions

Returns a list of all resolutions.

Atlassian Get resolution

Returns a resolution.

Atlassian Get all project roles

Gets a list of all project roles, complete with project role details and default actors. ### About project roles [Project roles](https://confluence.atlassian.com/x/3odKLg) are a flexible way to to associate users and groups with projects. In Jir...

Atlassian Create project role

Creates a new project role with no [default actors](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-resolution-get). You can use the [Add default actors to project role](https://developer.atlassian.com/cloud/jira/platform/rest/...

Atlassian Delete project role

Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](https://confluen...

Atlassian Get project role by ID

Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](http...

Atlassian Partial update project role

Update either the project role's name or its description. You cannot update both the name and description at the same time using this method. If you send a request with both a name and a description, then only the name will be updated, regardless...

Atlassian Fully update project role

Update the project role's name and description. You must include both a name and a description in the request. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](https://confluence.atlassi...

Atlassian Delete default actors from project role

Removes [default actors](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-resolution-get) from the project role. You may remove either a group or user, but you cannot remove a group and a user in the same request. Changing a pr...

Atlassian Get default actors for project role

Returns the [default actors](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-resolution-get) for the project role. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](ht...

Atlassian Add default actors to project role

Adds [default actors](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-resolution-get) to the given role. You may add either groups or users, but you cannot add groups and users in the same request. Changing a project role's de...

Atlassian Get all screens

Returns a [paginated](#pagination) list of all screens.

Atlassian Add field to default screen

Adds field or custom field to the default tab

Atlassian Get available screen fields

Gets available fields for screen. i.e ones that haven't already been added.

Atlassian Get all screen tabs

Returns a list of all tabs for the given screen

Atlassian Add screen tab

Creates tab for given screen

Atlassian Delete screen tab

Deletes tab to give screen

Atlassian Rename screen tab

Renames tab on given screen

Atlassian Get all screen tab fields

Gets all fields for a given tab

Atlassian Add screen tab field

Adds field to the given tab.

Atlassian Remove screen tab field

Removes field from given tab

Atlassian Move screen tab field

Moves field on the given tab

Atlassian Move screen tab

Moves tab position

Atlassian Search for issues using JQL (GET)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira. If the JQL query expression is too large to be encoded as a query parame...

Atlassian Search for issues using JQL (POST)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira. There is a [GET](https://developer.atlassian.com/cloud/jira/platform/res...

Atlassian Get issue security level

Returns a full representation of the security level that has the given id.

Atlassian Get server info

Returns general information about the current Jira server.

Atlassian Set base url

Sets the base URL that is configured for this Jira instance.

Atlassian Get issue navigator default columns

Returns the default system columns for issue navigator. Admin permission will be required.

Atlassian Set issue navigator default columns

Sets the default system columns for issue navigator. Admin permission will be required.

Atlassian Get statuses

Returns a list of all statuses

Atlassian Get status categories

Returns a list of all status categories

Atlassian Get status category

Returns a full representation of the StatusCategory having the given id or key

Atlassian Get status

Returns a full representation of the Status having the given id or name. If there are two statuses with the same name, only the first found status will be returned. Therefore searching by id is encouraged.

Atlassian Get task

This endpoint is used to check the status of a [long-running asynchronous task](#async). When the task is finished, it will contain a **result**. The result may be arbitrary JSON, its shape different for each task type. Consult the documentation ...

Atlassian Cancel task

Requests that the task that corresponds to the given task id is cancelled. To cancel a task, you need to be its creator or a Jira admin. Otherwise a 403 response will be returned.

Atlassian Store avatar

Creates an avatar for a given entity, for the given entity ID and type of entity. For example, you can create an avatar for an issue type, given the issue type Id. Uploading an avatar is supported for different types of entities across the Jira pr...

Atlassian Delete avatar

Deletes avatar

Atlassian Delete user

Deletes a user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Site administration (i.e., member of the site-admin [group](https://confluence.atlassian.com/display/Cloud/Manage+groups)).

Atlassian Get user

Returns a user. **[Permissions required](https://confluence.atlassian.com/x/FQiiLQ):** None.

Atlassian Create user

Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated. The option is provided to set or generate a password for the user. When using the option to g...

Atlassian Find users assignable to projects

Returns a list of users who fulfill both of these criteria: * their user attributes match a string. * they can be assigned issues in one or more projects. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** None.

Atlassian Find users assignable to issues

Returns a list of users that can be assigned to an issue. Use this method to find the list of users who can be assigned to: * a new issue, by providing the `projectKeyOrId`. * an updated issue, by providing the `issueKey`. * to an issue dur...

Atlassian Bulk get users

Returns details of users specified in a list of usernames or keys. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](href=). Users with permission to access Jira can call this method, but ...

Atlassian Reset user default columns

Resets the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system default. If a username is not passed, the calling user's default columns are reset. **[Permissions](https://confluence.atlassian.com/x/F...

Atlassian Get user default columns

Returns the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If a username is not passed in the request, the calling user's details are returned. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) requ...

Atlassian Set user default columns

Sets the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If a username is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed. The param...

Atlassian Get user groups

Returns the groups to which a user belongs. **[Permissions required](https://confluence.atlassian.com/x/FQiiLQ):** _Browse users and groups_ [global permission](https://confluence.atlassian.com/adminjiracloud/managing-global-permissions-776636359....

Atlassian Find users with permissions

Returns a list of users who fulfill both of these criteria: * their user attributes match a search string. * they have a set of permissions for a project or issue. If no search string is provided, a list of all users with the permissions is ...

Atlassian Find users for picker

Returns a list of users whose attributes match the query term. The returned object includes the `html` field where the matched query term is highlighted with the HTML strong tag. A list of usernames can be provided to exclude users from the result...

Atlassian Get user property keys

Returns all property keys on a user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** * To access the property keys on any user: _Administer Jira_ [global permission](https://confluence.atlassian.com/adminjiracloud/managin...

Atlassian Delete user property

Deletes a property from a user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** * To delete a property from any user: _Administer Jira_ [global permission](https://confluence.atlassian.com/adminjiracloud/managing-global-p...

Atlassian Get user property

Returns the value of a user's property. If no property key is provided [Get user property keys](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-user-properties-get) is called. **[Permissions](https://confluence.atlassian.com/x/...

Atlassian Set user property

Sets the value of a user's property. Use this resource to store custom data against a user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** * To set a property on any user: _Administer Jira_ [global permission](https://co...

Atlassian Find users

Returns a list of users that match the search string and property. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Browse users and groups_ [global permission](href=). Users with permission to access Jira can call this meth...

Atlassian Find users by query

Finds users using a structured query and returns user details. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Browse users and groups_ [global permission](href=). The available queries statements are: `is assignee of PROJ...

Atlassian Find user keys by query

Finds users using a structured query and returns a list of user keys. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Browse users and groups_ [global permission](href=). The available query statements are: * `is assigne...

Atlassian Find users with browse permission

Returns a list of users who fulfill both of these criteria: * their user attributes match a search string. * they have permission to browse issues. Use this resource to find users who can browse: * an issue, by providing the `issueKey`. *...

Atlassian Create version

Creates a project version. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project permission](https://confluence.atl...

Atlassian Delete version

Deletes a project version. Deprecated, use [Delete and replace version](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-version-id-removeAndSwap-post) that supports swapping version values in custom fields, in addition to the s...

Atlassian Get version

Returns a project version. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: _Browse projects_ project permission

Atlassian Update version

Modifies a project version. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project permission](https://confluence.at...

Atlassian Merge versions

Merges two project versions. The merge is completed by deleting the version specified in `id` and replacing any occurrences of its ID in `fixVersion` with the version ID specified in `moveIssuesTo`. Consider using [Delete and replace version](http...

Atlassian Move version

Modifies the version's sequence within the project, which affects the display order of the versions in Jira. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](https://confluence.atlassian....

Atlassian Get version's related issues count

Returns the following counts for a version: * Number of issues where the `fixVersion` is set to the version. * Number of issues where the `affectedVersion` is set to the version. * Number of issues where a version custom field is set to the...

Atlassian Delete and replace version

Deletes a project version. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project permission](https://confluence.atl...

Atlassian Get version's unresolved issues count

Returns counts of the issues and unresolved issues for the project version. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: _Browse projects_ project permission

Atlassian Get remote version links

Returns the remote version links for a given global ID.

Atlassian Delete remote version links by version id

Delete all remote version links for a given version ID.

Atlassian Get remote version links by version id

Returns the remote version links associated with the given version ID.

Atlassian Create or update remote version link

Create a remote version link via POST. The link's global ID will be taken from the JSON payload if provided; otherwise, it will be generated.

Atlassian Delete remote version link

Delete a specific remote version link with the given version ID and global ID.

Atlassian Get remote version link

A REST sub-resource representing a remote version link

Atlassian Create or update remote version link with global id

Create a remote version link via POST using the provided global ID.

Atlassian Get all workflows

Returns all workflows in Jira or a single workflow. If the `workflowName` parameter is specified, a workflow will be returned as an object (not in an array). Otherwise, an array of workflow objects will be returned. **[Permissions](https://confl...

Atlassian Create workflow scheme

Create a new workflow scheme. The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.

Atlassian Delete workflow scheme

Delete the passed workflow scheme.

Atlassian Get workflow scheme

Returns the requested workflow scheme to the caller.

Atlassian Update workflow scheme

Update the passed workflow scheme. The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to tru...

Atlassian Create workflow scheme draft from parent

Create a draft for the passed scheme. The draft will be a copy of the state of the parent.

Atlassian Delete default workflow

Remove the default workflow from the passed workflow scheme.

Atlassian Get default workflow

Return the default workflow from the passed workflow scheme.

Atlassian Update default workflow

Set the default workflow for the passed workflow scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Atlassian Delete workflow scheme draft

Delete the passed draft workflow scheme.

Atlassian Get workflow scheme draft

Returns the requested draft workflow scheme to the caller.

Atlassian Update workflow scheme draft

Update a draft workflow scheme. The draft will created if necessary. The body is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.

Atlassian Delete draft default workflow

Remove the default workflow from the passed draft workflow scheme.

Atlassian Get draft default workflow

Return the default workflow from the passed draft workflow scheme to the caller.

Atlassian Update draft default workflow

Set the default workflow for the passed draft workflow scheme.

Atlassian Delete workflow scheme draft issue type

Remove the specified issue type mapping from the draft scheme.

Atlassian Get workflow scheme draft issue type

Returns the issue type mapping for the passed draft workflow scheme.

Atlassian Set workflow scheme draft issue type

Set the issue type mapping for the passed draft scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Atlassian Delete draft workflow mapping

Delete the passed workflow from the draft workflow scheme.

Atlassian Get draft workflow

Returns the draft workflow mappings or requested mapping to the caller.

Atlassian Update draft workflow mapping

Update the draft scheme to include the passed mapping. The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field.

Atlassian Delete workflow scheme issue type

Remove the specified issue type mapping from the scheme.

Atlassian Get workflow scheme issue type

Returns the issue type mapping for the passed workflow scheme.

Atlassian Set workflow scheme issue type

Set the issue type mapping for the passed scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Atlassian Delete workflow mapping

Delete the passed workflow from the workflow scheme.

Atlassian Get workflow

Returns the workflow mappings or requested mapping to the caller for the passed scheme.

Atlassian Update workflow mapping

Update the scheme to include the passed mapping. The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to tru...

Atlassian Delete workflow transition property

Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transit...

Atlassian Get workflow transition properties

Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-trans...

Atlassian Create workflow transition property

Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionpr...

Atlassian Update workflow transition property

Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more ...

Atlassian Get IDs of deleted worklogs

Returns a list of IDs and delete timestamps for worklogs deleted after a date and time. This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date r...

Atlassian Get worklogs

Returns worklog details for a list of worklog IDs. Worklogs can be set as viewable by: * all users * members of a project role or group For a worklog to be returned, it must be set as _Viewable by All Users_ or the calling user must be ...

Atlassian Get IDs of updated worklogs

Returns a list of IDs and update timestamps for worklogs updated after a date and time. This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date r...

Atlassian Get audit records

Returns all records in the audit log, optionally for a certain date range. This contains information about events like space exports, group membership changes, app installations, etc. For more information, see [Audit log](https://confluence.atl...

Atlassian Create audit record

Creates a record in the audit log. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.

Atlassian Export audit records

Exports audit records as a CSV file or ZIP file. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.

Atlassian Get retention period

Returns the retention period for records in the audit log. The retention period is how long an audit record is kept for, from creation date until it is deleted. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence...

Atlassian Set retention period

Sets the retention period for records in the audit log. The retention period can be set to a maximum of 20 years. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission.

Atlassian Get audit records for time period

Returns records from the audit log, for a time period back from the current date. For example, you can use this method to get the last 3 months of records. This contains information about events like space exports, group membership changes, app...

Atlassian Delete session

This resource is deprecated and will be removed December 1, 2018. For more information, see [Deprecation notice - Basic authentication with passwords and cookie-based authentication](https://developer.atlassian.com/cloud/jira/platform/deprecation-...

Atlassian Get session

This resource is deprecated and will be removed December 1, 2018. For more information, see [Deprecation notice - Basic authentication with passwords and cookie-based authentication](https://developer.atlassian.com/cloud/jira/platform/deprecation-...

Atlassian Create session

This resource is deprecated and will be removed December 1, 2018. For more information, see [Deprecation notice - Basic authentication with passwords and cookie-based authentication](https://developer.atlassian.com/cloud/jira/platform/deprecation-...

Atlassian Get content

Returns all content in a Confluence instance. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only content that the user has permission to view will ...

Atlassian Create content

Creates a new piece of content or publishes an existing draft. To publish a draft, add the `id` and `status` properties to the body of the request. Set the `id` to the ID of the draft and set the `status` to 'current'. When the request is sent...

Atlassian Publish legacy draft

Publishes a legacy draft of a page created from a blueprint. Legacy drafts will eventually be removed in favour of shared drafts. For now, this method works the same as [Publish shared draft](#api-content-blueprint-instance-draftId-put). **[Per...

Atlassian Publish shared draft

Publishes a shared draft of a page created from a blueprint. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the draft and 'Add' permission for the space that the content will be created in.

Atlassian Convert content body

Converts a content body from one format to another format. Supported conversions: - storage: view, export_view, styled_view, editor - editor: storage - view: none - export_view: none - styled_view: none **[Permissions](https://confluence.atlass...

Atlassian Delete content

Moves a piece of content to the space's trash or purges it from the trash, depending on the content's type and status: - If the content's type is `page` or `blogpost` and its status is `current`, it will be trashed. - If the content's type is `...

Atlassian Get content by ID

Returns a single piece of content, like a page or a blog post. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the content is a blog post, 'View' permission for the space is required.

Atlassian Update content

Updates a piece of content. Use this method to update the title or body of a piece of content, change the status, change the parent page, and more. Note, updating draft content is currently not supported. **[Permissions](https://confluence.atla...

Atlassian Get content children

Returns a map of the direct children of a piece of content. A piece of content has different types of child content, depending on its type. These are the default parent-child content type relationships: - `page`: child content is `page`, `comme...

Atlassian Get attachments

Returns the attachments for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the content is a blog post, 'View' permission for the space is required.

Atlassian Create attachment

Adds an attachment to a piece of content. This method only adds a new attachment. If you want to update an existing attachment, use [Create or update attachments](#api-content-id-child-attachment-put). Note, you must set a `X-Atlassian-Token: n...

Atlassian Create or update attachment

Adds an attachment to a piece of content. If the attachment already exists for the content, then the attachment is updated (i.e. a new version of the attachment is created). Note, you must set a `X-Atlassian-Token: nocheck` header on the reques...

Atlassian Update attachment properties

Updates the attachment properties, i.e. the non-binary data of an attachment like the filename, media-type, comment, and parent container. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.

Atlassian Update attachment data

Updates the binary data of an attachment, given the attachment ID, and optionally the comment and the minor edit field. This method is essentially the same as [Create or update attachments](#api-content-id-child-attachment-put), except that it ...

Atlassian Get content comments

Returns the comments on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if it is a page.

Atlassian Get content children by type

Returns all children of a given type, for a piece of content. A piece of content has different types of child content, depending on its type: - `page`: child content is `page`, `comment`, `attachment` - `blogpost`: child content is `comment`, `a...

Atlassian Get content descendants

Returns a map of the descendants of a piece of content. This is similar to [Get content children](#api-content-id-child-get), except that this method returns child pages at all levels, rather than just the direct child pages. A piece of conten...

Atlassian Get content descendants by type

Returns all descendants of a given type, for a piece of content. This is similar to [Get content children by type](#api-content-id-child-type-get), except that this method returns child pages at all levels, rather than just the direct child pag...

Atlassian Get history for content

Returns the most recent update for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.

Atlassian Get macro body by macro ID

Returns the body of a macro in storage format, for the given macro ID. This includes information like the name of the macro, the body of the macro, and any macro parameters. This method is mainly used by Cloud apps. About the macro ID: When a m...

Atlassian Remove label from content using query parameter

Removes a label from a piece of content. This is similar to [Remove label from content](#api-content-id-label-label-delete) except that the label name is specified via a query parameter. Use this method if the label name has "/" characters, as...

Atlassian Get labels for content

Returns the labels on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space and permission to view the content if it is a page.

Atlassian Add labels to content

Adds labels to a piece of content. Does not modify the existing labels. Notes: - Labels can also be added when creating content ([Create content](#api-content-post)). - Labels can be updated when updating content ([Update content](#api-content-i...

Atlassian Remove label from content

Removes a label from a piece of content. This is similar to [Remove label from content using query parameter](#api-content-id-label-delete) except that the label name is specified via a path parameter. Use this method if the label name does no...

Atlassian Get watches for page

Returns the watches for a page. A user that watches a page will receive receive notifications when the page is updated. If you want to manage watches for a page, use the following `user` methods: - [Get content watch status for user](#api-user-...

Atlassian Get watches for space

Returns all space watches for the space that the content is in. A user that watches a space will receive receive notifications when any content in the space is updated. If you want to manage watches for a space, use the following `user` methods...

Atlassian Copy page hierarchy

Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments. The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is def...

Atlassian Get content properties

Returns the properties for a piece of content. For more information about content properties, see [Content properties in the REST API](https://developer.atlassian.com/cloud/confluence/content-properties/). **[Permissions](https://confluence.atla...

Atlassian Create content property

Creates a property for an existing piece of content. For more information about content properties, see [Content properties in the REST API](https://developer.atlassian.com/cloud/confluence/content-properties/). This is the same as [Create conte...

Atlassian Delete content property

Deletes a content property. For more information about content properties, see [Content properties in the REST API](https://developer.atlassian.com/cloud/confluence/content-properties/). **[Permissions](https://confluence.atlassian.com/x/_AozKw)...

Atlassian Get content property

Returns a content property for a piece of content. For more information, see [Content properties in the REST API](https://developer.atlassian.com/cloud/confluence/content-properties/). **[Permissions](https://confluence.atlassian.com/x/_AozKw) r...

Atlassian Create content property for key

Creates a property for an existing piece of content. For more information about content properties, see [Content properties in the REST API](https://developer.atlassian.com/cloud/confluence/content-properties/). This is the same as [Create conte...

Atlassian Update content property

Updates an existing content property. This method will also create a new property for a piece of content, if the property key does not exist and the property version is 1. For more information about content properties, see [Content properties i...

Atlassian Delete restrictions

Removes all restrictions (read and update) on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.

Atlassian Get restrictions

Returns the restrictions on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.

Atlassian Add restrictions

Adds restrictions to a piece of content. Note, this does not change any existing restrictions on the content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.

Atlassian Update restrictions

Updates restrictions for a piece of content. This removes the existing restrictions and replaces them with the restrictions in the request. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.

Atlassian Get restrictions by operation

Returns restrictions on a piece of content by operation. This method is similar to [Get restrictions](#api-content-id-restriction-get) except that the operations are properties of the return object, rather than items in a results array. **[Pe...

Atlassian Get restrictions for operation

Returns the restictions on a piece of content for a given operation (read or update). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.

Atlassian Remove group from content restriction

Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.

Atlassian Get content restriction status for group

Returns whether the specified content restriction applies to a group. For example, if the 'admins' group has permission to read a page with an ID of 123, then the following request will return true: `https://your-domain.atlassian.net/wiki/rest/...

Atlassian Add group to content restriction

Adds a group to a content restriction. That is, grant read or update permission to the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.

Atlassian Remove user from content restriction

Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.

Atlassian Get content restriction status for user

Returns whether the specified content restriction applies to a user. For example, if the user 'admin' has permission to read a page with an ID of 123, then the following request will return true: `https://your-domain.atlassian.net/wiki/rest/api...

Atlassian Add user to content restriction

Adds a user to a content restriction. That is, grant read or update permission to the user for a piece of content. One of `key`, `username`, or `accountId` must be specified as a query parameter to identify the user. **[Permissions](https://co...

Atlassian Get content versions

Returns the versions for a piece of content in descending order. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the content is a blog post, 'View' permission for the space is required.

Atlassian Restore content version

Restores a historical version to be the latest version. That is, a new version is created with the content of the historical version. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.

Atlassian Delete content version

Delete a historical version. This does not delete the changes made to the content in that version, rather the changes for the deleted version are rolled up into the next version. Note, you cannot delete the current version. **[Permissions](http...

Atlassian Get content version

Returns a version for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the content is a blog post, 'View' permission for the space is required.

Atlassian Search content by CQL

Returns the list of content that matches a Confluence Query Language (CQL) query. For information on CQL, see: [Advanced searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/). **[Permissions](https...

Atlassian Get groups

Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Atlassian Get group

Returns a user group for a given group name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Atlassian Get group members

Returns the users that are members of a group. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Atlassian Get long-running tasks

Returns information about all active long-running tasks (e.g. space export), such as how long each task has been running and the percentage of each task that has completed. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: ...

Atlassian Get long-running task

Returns information about an active long-running task (e.g. space export), such as how long it has been running and the percentage of the task that has completed. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission...

Atlassian Find target entities related to a source entity

Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way. For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET https://you...

Atlassian Delete

Deletes a relationship between two entities (user, space, content). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). For favourite relationships, the ...

Atlassian Find relationship from source to target

Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships are one way. For example, you can use this method to find whether the current user has selected a particular page as a favorite (...

Atlassian Create relationship

Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by default, but you can use this method to create any type of relationship between two entities. For example, the following method cre...

Atlassian Find target entities related to a source entity

Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way. For example, the following method finds all users that have a 'collaborator' relationship to a piece of content with an ID of...

Atlassian Search

Searches for content using the [Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/) **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the entit...

Atlassian Get look and feel settings

Returns the look and feel settings for the site or a single space. This includes attributes such as the color scheme, padding, and border radius. The look and feel settings for a space can be inherited from the global look and feel settings or ...

Atlassian Reset look and feel settings

Resets the custom look and feel settings for the site or a single space. This changes the values of the custom settings to be the same as the default settings. It does not change which settings (default or custom) are selected. Note, the default...

Atlassian Update look and feel settings

Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated. If no custom settings exist, then a set of custom settings is created. Note, if a theme is selected for a space, the space look an...

Atlassian Set look and feel settings

Sets the look and feel settings to either the default settings or the custom settings, for the site or a single space. Note, the default space settings are inherited from the current global settings. **[Permissions](https://confluence.atlassian....

Atlassian Get system info

Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Atlassian Get themes

Returns all themes, not including the default theme. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None

Atlassian Get global theme

Returns the globally assigned theme. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None

Atlassian Get theme

Returns a theme. This includes information about the theme name, description, and icon. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Unarchive conversation

Authentication required, with scope manage:conversation

Atlassian Get spaces

Returns all spaces. The returned spaces are ordered alphabetically in ascending order by space key. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Not...

Atlassian Create space

Creates a new space. Note, currently you cannot set space labels when creating a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Create Space(s)' global permission.

Atlassian Create private space

Creates a new space that is only visible to the creator. This method is the same as the [Create space](#api-space-post) method with permissions set to the current user only. Note, currently you cannot set space labels when creating a space. **[Pe...

Atlassian Delete space

Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status link that is returned in the response until the task completes. **[...

Atlassian Get space

Returns a space. This includes information like the name, description, and permissions, but not the content in the space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.

Atlassian Update space

Updates the name, description, or homepage of a space. - For security reasons, permissions cannot be updated via the API and must be changed via the user interface instead. - Currently you cannot set space labels when updating a space. **[Pe...

Atlassian Get content for space

Returns all content in a space. The returned content is grouped by type (pages then blogposts), then ordered by content ID in ascending order. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space....

Atlassian Get content by type for space

Returns all content of a given type, in a space. The returned content is ordered by content ID in ascending order. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the returned list wil...

Atlassian Get space properties

Returns all properties for the given space. Space properties are a key-value storage associated with a space. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.

Atlassian Create space property

Creates a new space property. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.

Atlassian Delete space property

Deletes a space property. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.

Atlassian Get space property

Returns a space property. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.

Atlassian Create space property for key

Creates a new space property. This is the same as `POST /space/{spaceKey}/property` but the key for the property is passed as a path parameter, rather than in the request body. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**...

Atlassian Update space property

Updates a space property. Note, you cannot update the key of a space property, only the value. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.

Atlassian Get space settings

Returns the settings of a space. Currently only the `routeOverrideEnabled` setting can be returned. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.

Atlassian Update space settings

Updates the settings for a space. Currently only the `routeOverrideEnabled` setting can be updated. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.

Atlassian Reset space theme

Resets the space theme. This means that the space will inherit the global look and feel settings **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.

Atlassian Get space theme

Returns the theme selected for a space, if one is set. If no space theme is set, this means that the space is inheriting the global look and feel settings. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission...

Atlassian Set space theme

Sets the theme for a space. Note, if you want to reset the space theme to the default Confluence theme, use the 'Reset space theme' method instead of this method. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' pe...

Atlassian Create content template

Creates a new content template. Note, blueprint templates cannot be created via the REST API. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to create a space template or 'Confluence Admin...

Atlassian Update content template

Updates a content template. Note, blueprint templates cannot be updated via the REST API. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to create a space template or 'Confluence Administr...

Atlassian Get blueprint templates

Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all blueprint templates in a space. Note, all global blueprints are inherited by each space. Space blueprints can be customised without ...

Atlassian Remove template

Deletes a template. This results in different actions depending on the type of template: - If the template is a content template, it is deleted. - If the template is a modified space-level blueprint template, it reverts to the template inherite...

Atlassian Get content template

Returns a content template. This includes information about template, like the name, the space or blueprint that the template is in, the body of the template, and more. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Ad...

Atlassian Get content templates

Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to view space te...

Atlassian Get user

Returns a user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more. The `username`, `key`, or `accountId` parameter must be specified, in order to identify the user. **[Permissions](h...

Atlassian Get anonymous user

Returns information about how anonymous users are represented, like the profile picture and display name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Atlassian Get current user

Returns the currently logged-in user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access th...

Atlassian Get group memberships for user

Returns the groups that a user is a member of. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Atlassian Remove content watcher

Removes a user as a watcher from a piece of content. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the `username`, `key`, or `accountId` to identify the user. The user making the request must be a Co...

Atlassian Get content watch status

Returns whether a user is watching a piece of content. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the `username`, `key`, or `accountId` to identify the user. The user making the request must be a ...

Atlassian Add content watcher

Adds a user as a watcher to a piece of content. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the `username`, `key`, or `accountId` to identify the user. The user making the request must be a Conflue...

Atlassian Remove label watcher

Removes a user as a watcher from a label. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the `username`, `key`, or `accountId` to identify the user. The user making the request must be a Confluence ad...

Atlassian Get label watch status

Returns whether a user is watching a label. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the `username`, `key`, or `accountId` to identify the user. The user making the request must be a Confluence ...

Atlassian Add label watcher

Adds a user as a watcher to a label. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the `username`, `key`, or `accountId` to identify the user. The user making the request must be a Confluence adminis...

Atlassian Remove space watch

Removes a user as a watcher from a space. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the `username`, `key`, or `accountId` to identify the user. The user making the request must be a Confluence ad...

Atlassian Get space watch status

Returns whether a user is watching