{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Projects API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Projects",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian List Explicit User Permissions for Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/users",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual key assigned to the project.\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 operation retrieves a list of explicit user permissions that have been granted for a specific project within a Bitbucket workspace. By providing the workspace identifier and project key as path parameters, the endpoint returns details about individual users who have been explicitly assigned permissions to the project, including their access levels and roles. This allows administrators to audit and review which users have direct access to a particular project, separate from any permissio"
},
{
"info": {
"name": "Atlassian Get an Explicit User Permission for Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/users/:selected_user_id",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual key assigned to the project.\n"
},
{
"name": "selected_user_id",
"value": "",
"type": "path",
"description": "This can either be the username, the Users UUID surrounded by curly-braces,\nfor example: {account UUID}, or the Users Atlassian ID.\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 the explicit permission details for a specific user within a designated project in a Bitbucket workspace. This endpoint requires three path parameters: the workspace slug identifying the Bitbucket workspace, the project key for the specific project, and the selected user ID representing the user whose permissions are being queried. When called, it returns the permission level that has been directly assigned to the specified user for that project, excluding any inherited permissions fro"
},
{
"info": {
"name": "Atlassian Update an Explicit User Permission for Project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/users/:selected_user_id",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual key assigned to the project.\n"
},
{
"name": "selected_user_id",
"value": "",
"type": "path",
"description": "This can either be the username, the Users UUID surrounded by curly-braces,\nfor example: {account UUID}, or the Users Atlassian ID.\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": "Updates the explicit permission level for a specific user within a Bitbucket project workspace. This PUT operation requires the workspace slug, project key, and the selected user's ID as path parameters, allowing administrators to modify individual user access rights at the project level. The endpoint is used to grant, revoke, or change permission levels (such as read, write, or admin) for a particular user, overriding any inherited permissions from groups or workspace-level settings. This provi"
},
{
"info": {
"name": "Atlassian Delete an Explicit User Permission for Project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/users/:selected_user_id",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual key assigned to the project.\n"
},
{
"name": "selected_user_id",
"value": "",
"type": "path",
"description": "This can either be the username, the Users UUID surrounded by curly-braces,\nfor example: {account UUID}, or the Users Atlassian ID.\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 operation removes an explicitly assigned permission for a specific user within a Bitbucket project by making a DELETE request to the specified endpoint. It requires the workspace slug, project key, and the selected user's ID as path parameters to identify and revoke the user's direct access rights to the project. This operation is useful for project administrators who need to manage team access by removing individual user permissions, though it only affects explicit permissions and does"
},
{
"info": {
"name": "Atlassian List Projects in a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects",
"params": [
{
"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 operation retrieves a paginated list of all projects within a specified Bitbucket workspace, where the workspace is identified by its slug in the URL path. It returns project information including project keys, names, descriptions, and other metadata associated with each project that the authenticated user has permission to view. The response follows Bitbucket's standard pagination format, allowing clients to navigate through large result sets using page parameters, making it useful for"
},
{
"info": {
"name": "Atlassian Create a Project in a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/workspaces/:workspace/projects",
"params": [
{
"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 creates a new project within a specified Bitbucket workspace by sending a POST request to the /workspaces/{workspace}/projects endpoint, where {workspace} is replaced with the unique identifier or slug of the target workspace. The operation allows workspace administrators to programmatically establish new projects that serve as containers for organizing related repositories, enabling better code management and team collaboration. When invoked, the endpoint accepts project deta"
},
{
"info": {
"name": "Atlassian Get a Project for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\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": "The Get A Project For A Workspace operation in the Atlassian Bitbucket Workspaces API retrieves detailed information about a specific project within a designated workspace by making a GET request to the endpoint /workspaces/{workspace}/projects/{project_key}. This operation requires two path parameters: the workspace identifier (which can be the workspace's UUID, ID, or slug) and the project_key (a unique identifier for the project within that workspace). When successfully invoked, it returns co"
},
{
"info": {
"name": "Atlassian Update a Project for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\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 allows you to update an existing project within a specified Bitbucket workspace by making a PUT request to the endpoint with the workspace slug and project key as path parameters. You can modify various project properties such as the project name, description, avatar, and other configurable settings. The request requires appropriate authentication and permissions to modify projects within the workspace, typically requiring admin or write access. Upon successful execution, the "
},
{
"info": {
"name": "Atlassian Delete a Project for a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\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": "The delete operation on the `/workspaces/{workspace}/projects/{project_key}` endpoint in the Atlassian Bitbucket Workspaces API permanently removes a specified project from a workspace. This operation requires authentication and appropriate permissions to delete projects within the designated workspace. When executed, it takes two path parameters: the workspace identifier and the project key that uniquely identifies the project to be deleted. Upon successful deletion, the project and its associa"
},
{
"info": {
"name": "Atlassian Get the Branching Model for a Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/branching-model",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\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 operation retrieves the branching model configuration for a specific project within a Bitbucket workspace, allowing you to understand how branches are organized and managed within that project. By providing the workspace identifier and project key as path parameters, the GET request returns details about the project's branching strategy, which may include information about development branches, production branches, branch prefixes, and the overall workflow structure that defines how cod"
},
{
"info": {
"name": "Atlassian Get the Branching Model Config for a Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/branching-model/settings",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\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 retrieves the branching model configuration settings for a specific project within a designated workspace in Atlassian Bitbucket. By making a GET request to this endpoint with the appropriate workspace identifier and project key, users can access the project's branching strategy configuration, which typically includes details about branch types, naming conventions, and workflow patterns such as Git Flow or similar branching models. This information helps teams understand and ma"
},
{
"info": {
"name": "Atlassian Update the Branching Model Config for a Project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/branching-model/settings",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\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 operation updates the branching model configuration settings for a specific project within a Bitbucket workspace. It uses a PUT request to the endpoint /workspaces/{workspace}/projects/{project_key}/branching-model/settings, where you specify the workspace slug and project key as path parameters. The branching model defines the workflow for how branches are organized and managed in a project, including settings for development branches, production branches, and branch prefixes for featu"
},
{
"info": {
"name": "Atlassian List the Default Reviewers in a Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/default-reviewers",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\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 retrieves the list of default reviewers configured for a specific project within a Bitbucket workspace. When accessed via a GET request to `/workspaces/{workspace}/projects/{project_key}/default-reviewers`, it returns information about users who are automatically added as reviewers to new pull requests in the specified project. The endpoint requires both the workspace slug and project key as path parameters to identify the target project. Default reviewers help streamline the c"
},
{
"info": {
"name": "Atlassian Get A Default Reviewer",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/default-reviewers/:selected_user",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This can either be the actual `key` assigned\nto the project or the `UUID` (surrounded by curly-braces (`{}`)).\n"
},
{
"name": "selected_user",
"value": "",
"type": "path",
"description": "This can either be the username or the UUID of the default reviewer,\nsurrounded by curly-braces, for example: `{account 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": "Returns the specified default reviewer."
},
{
"info": {
"name": "Atlassian Add the Specific User as a Default Reviewer for the Project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/default-reviewers/:selected_user",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This can either be the actual `key` assigned\nto the project or the `UUID` (surrounded by curly-braces (`{}`)).\n"
},
{
"name": "selected_user",
"value": "",
"type": "path",
"description": "This can either be the username or the UUID of the default reviewer,\nsurrounded by curly-braces, for example: `{account 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 PUT operation adds a specified user as a default reviewer for a particular project within a Bitbucket workspace. By targeting the endpoint with the workspace slug, project key, and the selected user's identifier, it configures that user to be automatically added as a reviewer on all new pull requests created in the project. This helps streamline the code review process by ensuring designated team members are consistently included in pull request reviews without manual assignment, making it "
},
{
"info": {
"name": "Atlassian Remove the Specific User From the Project S Default Reviewers",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/default-reviewers/:selected_user",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This can either be the actual `key` assigned\nto the project or the `UUID` (surrounded by curly-braces (`{}`)).\n"
},
{
"name": "selected_user",
"value": "",
"type": "path",
"description": "This can either be the username or the UUID of the default reviewer,\nsurrounded by curly-braces, for example: `{account 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 operation removes a specific user from the default reviewers list for a given project within a Bitbucket workspace. When invoked, it performs a DELETE request to the endpoint /workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}, where the workspace parameter identifies the workspace containing the project, project_key specifies the particular project, and selected_user indicates the user to be removed from the default reviewers. Once executed, the specified u"
},
{
"info": {
"name": "Atlassian List Project Deploy Keys",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/deploy-keys",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\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 GET operation retrieves a paginated list of all deploy keys configured for a specific project within a Bitbucket workspace. Deploy keys are SSH keys that grant read-only or read-write access to project repositories, commonly used for automated deployments and CI/CD pipelines. The endpoint requires both the workspace slug and project key as path parameters to identify the target project, and returns an array of deploy key objects containing details such as the key ID, label, public key value"
},
{
"info": {
"name": "Atlassian Create a Project Deploy Key",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/deploy-keys",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\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 operation creates a new deploy key for a specific project within a Bitbucket workspace, allowing secure, read-only SSH access to repositories within that project. By making a POST request to the endpoint with the workspace slug and project key as path parameters, users can generate an SSH key that can be used for automated deployments or CI/CD pipelines without requiring personal credentials. The deploy key is scoped to the project level, meaning it can access all repositories within th"
},
{
"info": {
"name": "Atlassian Get a Project Deploy Key",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/deploy-keys/:key_id",
"params": [
{
"name": "key_id",
"value": "",
"type": "path",
"description": "The key ID matching the project deploy key."
},
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\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 operation retrieves detailed information about a specific deploy key that has been added to a project within a Bitbucket workspace. By providing the workspace identifier, project key, and the unique key ID, you can fetch the deploy key's properties including its public SSH key content, label, creation date, and associated permissions. Deploy keys are SSH keys that grant read-only or read-write access to repositories within a project, commonly used for automated deployments and CI/CD pip"
},
{
"info": {
"name": "Atlassian List Explicit Group Permissions for a Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/groups",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual key assigned to the project.\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 retrieves a paginated list of explicit group permissions that have been directly granted to groups for a specific project within a Bitbucket workspace. By making a GET request to this endpoint with the workspace identifier and project key as path parameters, you can view all groups that have been explicitly assigned permissions to the project, along with their corresponding permission levels. This is useful for auditing access control, understanding who has what level of access"
},
{
"info": {
"name": "Atlassian Get an Explicit Group Permission for a Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/groups/:group_slug",
"params": [
{
"name": "group_slug",
"value": "",
"type": "path",
"description": "Slug of the requested group."
},
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual key assigned to the project.\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 operation retrieves the explicit permission settings assigned to a specific group for a particular project within a Bitbucket workspace. By providing the workspace identifier, project key, and group slug as path parameters, the endpoint returns detailed information about what access level and permissions have been directly granted to that group for the specified project. This is useful for auditing group-level permissions, understanding access control configurations, and managing team-b"
},
{
"info": {
"name": "Atlassian Update an Explicit Group Permission for a Project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/groups/:group_slug",
"params": [
{
"name": "group_slug",
"value": "",
"type": "path",
"description": "Slug of the requested group."
},
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual key assigned to the project.\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 explicit permissions assigned to a specific group within a Bitbucket project. By making a PUT request to the endpoint with the workspace identifier, project key, and group slug, administrators can modify the access level granted to that group for the specified project. This allows for fine-grained control over project permissions by adjusting what actions members of a particular group can perform, such as read, write, or admin privileges. The operation requires pro"
},
{
"info": {
"name": "Atlassian Delete an Explicit Group Permission for a Project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/permissions-config/groups/:group_slug",
"params": [
{
"name": "group_slug",
"value": "",
"type": "path",
"description": "Slug of the requested group."
},
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual key assigned to the project.\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 operation removes an explicitly granted group permission from a specific project within a Bitbucket workspace by sending a DELETE request to the designated endpoint, which requires the workspace identifier, project key, and group slug as path parameters to target the exact permission configuration that needs to be revoked, effectively revoking that group's direct access rights to the project while potentially leaving inherited or other permission types intact, allowing workspace adminis"
},
{
"info": {
"name": "Atlassian Get Recent Projects",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/project/recent",
"params": [
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:\n\n * `description` Returns the project description.\n * `projectKeys` Returns all project keys associated with a project.\n * `lead` Returns information about the project lead.\n * `issueTypes` Returns all issue types associated with the project.\n * `url` Returns the URL associated with the project.\n * `permissions` Returns the permissions associated with the project.\n * `insight` EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.\n * `*` Returns the project with all available expand options."
},
{
"name": "properties",
"value": "",
"type": "query",
"description": "EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored."
}
]
},
"docs": "Returns a list of up to 20 projects recently viewed by the user that are still visible to the user.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** Projects are returned only where the user has one of:
* *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* *Administer Jira* ["
},
{
"info": {
"name": "Atlassian Get Projects Paginated",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/project/search",
"params": [
{
"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": "orderBy",
"value": "",
"type": "query",
"description": "[Order](#ordering) the results by a field.\n\n * `category` Sorts by project category. A complete list of category IDs is found using [Get all project categories](#api-rest-api-3-projectCategory-get).\n * `issueCount` Sorts by the total number of issues in each project.\n * `key` Sorts by project key.\n * `lastIssueUpdatedTime` Sorts by the last issue update time.\n * `name` Sorts by project name.\n * `owner` Sorts by project lead.\n * `archivedDate` EXPERIMENTAL. Sorts by project archived date.\n * `deletedDate` EXPERIMENTAL. Sorts by project deleted date."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. Up to 50 project IDs can be provided."
},
{
"name": "keys",
"value": "",
"type": "query",
"description": "The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, `keys=PA&keys=PB`. Up to 50 project keys can be provided."
},
{
"name": "query",
"value": "",
"type": "query",
"description": "Filter the results using a literal string. Projects with a matching `key` or `name` are returned (case insensitive)."
},
{
"name": "typeKey",
"value": "",
"type": "query",
"description": "Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts a comma-separated list. Valid values are `business`, `service_desk`, and `software`."
},
{
"name": "categoryId",
"value": "",
"type": "query",
"description": "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation."
},
{
"name": "action",
"value": "",
"type": "query",
"description": "Filter results by projects for which the user can:\n\n * `view` the project, meaning that they have one of the following permissions:\n \n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n * `browse` the project, meaning that they have the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n * `edit` the project, meaning that they have one of the following permissions:\n \n * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n * `create` the project, meaning that they have the *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue is created."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:\n\n * `description` Returns the project description.\n * `projectKeys` Returns all project keys associated with a project.\n * `lead` Returns information about the project lead.\n * `issueTypes` Returns all issue types associated with the project.\n * `url` Returns the URL associated with the project.\n * `insight` EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "EXPERIMENTAL. Filter results by project status:\n\n * `live` Search live projects.\n * `archived` Search archived projects.\n * `deleted` Search deleted projects, those in the recycle bin."
},
{
"name": "properties",
"value": "",
"type": "query",
"description": "EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list."
},
{
"name": "propertyQuery",
"value": "",
"type": "query",
"description": "EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `[thepropertykey].something.nested=1`. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that `thepropertykey` is only returned when included in `properties`."
}
]
},
"docs": "Returns a [paginated](#pagination) list of projects visible to the user.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** Projects are returned only where the user has one of:
* *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* *Administer Jira* [global permission](https://"
},
{
"info": {
"name": "Atlassian Get Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey",
"params": [
{
"name": "projectIdOrKey",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:\n\n * `description` The project description.\n * `issueTypes` The issue types associated with the project.\n * `lead` The project lead.\n * `projectKeys` All project keys associated with the project.\n * `issueTypeHierarchy` The project issue type hierarchy."
},
{
"name": "properties",
"value": "",
"type": "query",
"description": "A list of project properties to return for the project. This parameter accepts a comma-separated list."
}
]
},
"docs": "Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a project.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project."
},
{
"info": {
"name": "Atlassian Update Project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey",
"params": [
{
"name": "projectIdOrKey",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:\n\n * `description` The project description.\n * `issueTypes` The issue types associated with the project.\n * `lead` The project lead.\n * `projectKeys` All project keys associated with the project."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a project.
All parameters are optional in the body of the request. Schemes will only be updated if they are included in the request, any omitted schemes will be left unchanged.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). is only needed when changing the schemes or project key. Otherwise you will only need *Administer Projects* ["
},
{
"info": {
"name": "Atlassian Delete Project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey",
"params": [
{
"name": "projectIdOrKey",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
},
{
"name": "enableUndo",
"value": "",
"type": "query",
"description": "Whether this project is placed in the Jira recycle bin where it will be available for restoration."
}
]
},
"docs": "Deletes a project.
You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Archive Project",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/archive",
"params": [
{
"name": "projectIdOrKey",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
}
]
},
"docs": "Archives a project. You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Delete Project Asynchronously",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/delete",
"params": [
{
"name": "projectIdOrKey",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
}
]
},
"docs": "Deletes a project asynchronously.
This operation is:
* transactional, that is, if part of the delete fails the project is not deleted.
* [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Restore Deleted Or Archived Project",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/restore",
"params": [
{
"name": "projectIdOrKey",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
}
]
},
"docs": "Restores a project that has been archived or placed in the Jira recycle bin.
**[Permissions](#permissions) required:**
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)for Company managed projects.
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project for Team managed projects."
},
{
"info": {
"name": "Atlassian Get All Statuses For Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/statuses",
"params": [
{
"name": "projectIdOrKey",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
}
]
},
"docs": "Returns the valid statuses for a project. The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project."
},
{
"info": {
"name": "Atlassian Get Project Issue Type Hierarchy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/project/:projectId/hierarchy",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The ID of the project."
}
]
},
"docs": "Get the issue type hierarchy for a next-gen project.
The issue type hierarchy for a project consists of:
* *Epic* at level 1 (optional).
* One or more issue types at level 0 such as *Story*, *Task*, or *Bug*. Where the issue type *Epic* is defined, these issue types are used to break down the content of an epic.
* *Subtask* at level -1 (optional). This issue type enables level 0 issue types to be broken down into components. Issues based on a level -1 issue type must ha"
},
{
"info": {
"name": "Atlassian Get Project Notification Scheme",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/project/:projectKeyOrId/notificationscheme",
"params": [
{
"name": "projectKeyOrId",
"value": "",
"type": "path",
"description": "The project ID or project key (case sensitive)."
},
{
"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 * `all` Returns all expandable information\n * `field` Returns information about any custom fields assigned to receive an event\n * `group` Returns information about any groups assigned to receive an event\n * `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information\n * `projectRole` Returns information about any project roles assigned to receive an event\n * `user` Returns information about any users assigned to receive an event"
}
]
},
"docs": "Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg)."
},
{
"info": {
"name": "Atlassian Get All Projects",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/project",
"params": [
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:\n\n * `description` Returns the project description.\n * `issueTypes` Returns all issue types associated with the project.\n * `lead` Returns information about the project lead.\n * `projectKeys` Returns all project keys associated with the project."
},
{
"name": "recent",
"value": "",
"type": "query",
"description": "Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session."
},
{
"name": "properties",
"value": "",
"type": "query",
"description": "A list of project properties to return for the project. This parameter accepts a comma-separated list."
}
]
},
"docs": "Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-rest-api-3-project-search-get) that supports search and pagination.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** Projects are returned only where the user has *Browse Projects* or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project."
},
{
"info": {
"name": "Atlassian Create Project",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/project",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a project based on a project type template, as shown in the following table:
| Project Type Key | Project Template Key |
|--|--|
| `business` | `com.atlassian.jira-core-project-templates:jira-core-simplified-content-management`, `com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval`, `com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking`, `com.atlassian.jira-core-project-templates:jira-core-simplified-process-control`, "
}
]
}
],
"bundled": true
}