{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Status API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Status", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get the Merge Task Status for Pull Request", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/merge/task-status/:task_id", "params": [ { "name": "pull_request_id", "value": "", "type": "path", "description": "The id of the pull request." }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "task_id", "value": "", "type": "path", "description": "ID of the merge task" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET endpoint retrieves the current status of a merge task for a specific pull request in a Bitbucket repository. By providing the workspace identifier, repository slug, pull request ID, and task ID in the URL path, users can poll this endpoint to monitor the progress of an asynchronous merge operation. The response typically includes information about whether the merge task is pending, in progress, completed successfully, or has failed, along with any relevant error messages or completion d" }, { "info": { "name": "Atlassian Create Build Status for Commit", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/commit/:commit/statuses/build", "params": [ { "name": "commit", "value": "", "type": "path", "description": "The Commits SHA1." }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This POST endpoint creates a build status for a specific commit in a Bitbucket repository, allowing external CI/CD systems and build tools to report the status of automated builds back to Bitbucket. The endpoint requires the workspace ID, repository slug, and commit hash as path parameters, and accepts a JSON payload containing build status information such as state (successful, failed, in progress), key, name, URL, and description. When invoked, it associates the provided build status with the " }, { "info": { "name": "Atlassian Get Build Status for Commit", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/commit/:commit/statuses/build/:key", "params": [ { "name": "commit", "value": "", "type": "path", "description": "The Commits SHA1." }, { "name": "key", "value": "", "type": "path", "description": "The build status' unique key" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a specific build status object associated with a commit in a Bitbucket repository, identified by a unique key. This endpoint allows you to query the detailed status information of a particular build or CI/CD pipeline execution that was reported for a given commit. You must provide the workspace identifier, repository slug, commit hash, and the unique key of the build status you want to retrieve. The response includes comprehensive details about the build execution such as its state (su" }, { "info": { "name": "Atlassian Update Build Status for Commit", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/commit/:commit/statuses/build/:key", "params": [ { "name": "commit", "value": "", "type": "path", "description": "The Commits SHA1." }, { "name": "key", "value": "", "type": "path", "description": "The build status' unique key" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation updates the build status for a specific commit in a Bitbucket repository by making a PUT request to the endpoint that identifies a unique build status entry through the workspace name, repository slug, commit hash, and a unique key identifier. It allows developers and CI/CD systems to modify the state of an existing build status record associated with a particular commit, enabling them to update information such as whether the build is in progress, successful, failed, or stopp" }, { "info": { "name": "Atlassian Check Issue Export Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/export/:repo_name-issues-:task_id.zip", "params": [ { "name": "repo_name", "value": "", "type": "path", "description": "The name of the repo" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "task_id", "value": "", "type": "path", "description": "The ID of the export task" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET operation checks the status of a previously initiated issue export request for a specific Bitbucket repository by polling the export endpoint using the provided task ID. When called, it queries the export job identified by the workspace, repository slug, repository name, and unique task identifier to determine whether the export process is still running, has completed successfully, or has failed. If the export is complete, the endpoint returns the ZIP file containing the exported issues" }, { "info": { "name": "Atlassian Check Issue Import Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/import", "params": [ { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API endpoint allows you to check the status of a bulk issue import operation for a specific Bitbucket repository. By making a GET request to `/repositories/{workspace}/{repo_slug}/issues/import`, you can retrieve information about a previously initiated issue import process, including whether it's still in progress, completed successfully, or encountered any errors. The endpoint requires you to specify both the workspace identifier and the repository slug in the URL path, and it returns det" }, { "info": { "name": "Atlassian Get Content Restriction Status for Group", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/group/:groupName", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the restriction applies to." }, { "name": "operationKey", "value": "", "type": "path", "description": "The operation that the restriction applies to." }, { "name": "groupName", "value": "", "type": "path", "description": "The name of the group to be queried for whether the content restriction\napplies to it." } ] }, "docs": "The Atlassian Confluence Content API endpoint `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}` using the GET method retrieves the restriction status for a specific group on a particular piece of content. This operation allows administrators and authorized users to check whether a designated group has restrictions applied for a specific operation (such as read or update) on content identified by its unique ID. The endpoint requires three path parameters: the " }, { "info": { "name": "Atlassian Get Content Restriction Status for Group", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/byGroupId/:groupId", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the restriction applies to." }, { "name": "operationKey", "value": "", "type": "path", "description": "The operation that the restriction applies to." }, { "name": "groupId", "value": "", "type": "path", "description": "The id of the group to be queried for whether the content restriction\napplies to it." } ] }, "docs": "This API endpoint retrieves the restriction status for a specific group on a piece of Confluence content. It requires three path parameters: the content ID, an operation key (typically 'read' or 'update'), and a group ID. When called, it returns information about whether the specified group has restrictions applied for the given operation on that content, helping administrators and developers understand access control configurations. This is useful for auditing permissions, validating security p" }, { "info": { "name": "Atlassian Get Content Restriction Status for User", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the restriction applies to." }, { "name": "operationKey", "value": "", "type": "path", "description": "The operation that is restricted." }, { "name": "key", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "username", "value": "", "type": "query", "description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "name": "accountId", "value": "", "type": "query", "description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`." } ] }, "docs": "Retrieves the restriction status for a specific user on a piece of Confluence content based on a given operation key. This endpoint allows you to check whether a particular user has access to perform a specific operation (such as read, update, or delete) on content identified by its ID. The operation key parameter specifies which type of operation restriction to check, while the request targets a specific user to determine if content restrictions apply to them. This is useful for administrators " }, { "info": { "name": "Atlassian Get Asynchronously Converted Content Body From the Id or the Current Status of the Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/contentbody/convert/async/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The asyncId of the macro task to get the converted body." } ] }, "docs": "This API endpoint retrieves the result of an asynchronous content body conversion operation in Atlassian Confluence using a unique task identifier. When content conversion is initiated asynchronously (such as converting between different markup formats like storage format, view format, or editor format), this GET operation allows you to check the current status of the conversion task and fetch the converted content once the operation is complete. The endpoint accepts the task ID as a path parame" }, { "info": { "name": "Atlassian Search Statuses Paginated", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/statuses/search", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `usages` Returns the project and issue types that use the status in their workflow.\n * `workflowUsages` Returns the workflows that use the status." }, { "name": "projectId", "value": "", "type": "query", "description": "The project the status is part of or null for global statuses." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "searchString", "value": "", "type": "query", "description": "Term to match status names against or null to search for all statuses in the search scope." }, { "name": "statusCategory", "value": "", "type": "query", "description": "Category of the status to filter by. The supported values are: `TODO`, `IN_PROGRESS`, and `DONE`." } ] }, "docs": "Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of statuses that match a search on name or project.

**[Permissions](#permissions) required:**

* *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg)
* *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)" }, { "info": { "name": "Atlassian Bulk Get Statuses", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/statuses", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `usages` Returns the project and issue types that use the status in their workflow.\n * `workflowUsages` Returns the workflows that use the status." }, { "name": "id", "value": "", "type": "query", "description": "The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.\n\nMin items `1`, Max items `50`" } ] }, "docs": "Returns a list of the statuses specified by one or more status IDs.

**[Permissions](#permissions) required:**

* *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg)
* *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)" }, { "info": { "name": "Atlassian Bulk Create Statuses", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/statuses", "body": { "type": "json", "data": "{}" } }, "docs": "Creates statuses for a global or project scope.

**[Permissions](#permissions) required:**

* *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg)
* *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)" }, { "info": { "name": "Atlassian Bulk Update Statuses", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/statuses", "body": { "type": "json", "data": "{}" } }, "docs": "Updates statuses by ID.

**[Permissions](#permissions) required:**

* *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg)
* *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)" }, { "info": { "name": "Atlassian Bulk Delete Statuses", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/statuses", "params": [ { "name": "id", "value": "", "type": "query", "description": "The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.\n\nMin items `1`, Max items `50`" } ] }, "docs": "Deletes statuses by ID.

**[Permissions](#permissions) required:**

* *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg)
* *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)" } ] } ], "bundled": true }