{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Deploy API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Deploy", "type": "folder" }, "items": [ { "info": { "name": "Atlassian List Repository Deploy Keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/deploy-keys", "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 operation retrieves a paginated list of all deploy keys that have been configured for a specific Bitbucket repository within a workspace. Deploy keys are SSH keys that grant read-only or read-write access to a single repository, commonly used for automated deployment processes or CI/CD pipelines. By sending a GET request to this endpoint with the appropriate workspace identifier and repository slug, authenticated users can view all deploy keys associated with that repository, including " }, { "info": { "name": "Atlassian Add Repository Deploy Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/deploy-keys", "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 operation allows you to add a new deploy key to a specific Bitbucket repository within a workspace. Deploy keys are SSH keys that grant read-only or read-write access to a repository, typically used for automated deployment processes or CI/CD pipelines. By making a POST request to this endpoint with the workspace identifier and repository slug, along with the required key details in the request body (such as the SSH public key and an optional label), you can programmatically register a " }, { "info": { "name": "Atlassian Get Repository Deploy Key", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/deploy-keys/:key_id", "params": [ { "name": "key_id", "value": "", "type": "path", "description": "The key ID matching the deploy 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": "This API operation retrieves detailed information about a specific deploy key that has been added to a Bitbucket repository. By providing the workspace identifier, repository slug, and the unique key ID, you can fetch the complete configuration and metadata associated with that particular SSH deploy key, including its label, the actual public key content, creation timestamp, and access permissions. Deploy keys are typically used to grant read-only or read-write access to repositories for automat" }, { "info": { "name": "Atlassian Update Repository Deploy Key", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/deploy-keys/:key_id", "params": [ { "name": "key_id", "value": "", "type": "path", "description": "The key ID matching the deploy 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": "This API operation updates an existing deploy key for a specific repository in Bitbucket by making a PUT request to the endpoint with the workspace ID, repository slug, and deploy key ID as path parameters. Deploy keys are SSH keys that provide read-only or read-write access to a single repository, commonly used for automated deployment processes or CI/CD pipelines. The operation allows you to modify properties of an existing deploy key such as its label, the actual key value, or access permissi" }, { "info": { "name": "Atlassian Delete Repository Deploy Key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/deploy-keys/:key_id", "params": [ { "name": "key_id", "value": "", "type": "path", "description": "The key ID matching the deploy 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": "This API operation removes a specific deploy key from a Bitbucket repository by sending a DELETE request to the endpoint with the workspace identifier, repository slug, and deploy key ID as path parameters. Deploy keys are SSH keys that grant read-only or read-write access to a repository, typically used for automated deployment processes or CI/CD pipelines. When this operation is executed successfully, it permanently deletes the specified deploy key from the repository, revoking any access that" }, { "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" } ] } ], "bundled": true }