{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Create API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Create", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Create Pull Request", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pullrequests", "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" } ], "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 pull request in a specified Bitbucket repository within a given workspace. By sending a POST request to the endpoint with the workspace identifier and repository slug as path parameters, users can programmatically initiate a pull request that proposes merging changes from a source branch into a destination branch. The request typically requires a JSON payload containing essential details such as the title, description, source branch, destination branch, and optio" }, { "info": { "name": "Atlassian Create Comment on Pull Request", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/comments", "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": "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": "The Create Comment On Pull Request operation allows developers to add new comments to a specific pull request in a Bitbucket repository by sending a POST request to the endpoint /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments. This API call requires authentication and takes three path parameters: the workspace identifier, the repository slug, and the pull request ID. The request body must include the comment content, and optionally can specify properties like inline" }, { "info": { "name": "Atlassian Create Task on Pull Request", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/tasks", "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": "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 endpoint allows you to create a new task on a specific pull request within a Bitbucket repository. By sending a POST request to /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks, you can add actionable items or to-do items that need to be completed as part of the pull request review process. You must specify the workspace (team or user account), repository slug, and pull request ID in the URL path, along with task details in the request body such as the task des" }, { "info": { "name": "Atlassian Create Repository", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug", "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" } ], "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 repository within a specified workspace in Atlassian Bitbucket. By sending a POST request to the endpoint with the workspace identifier and desired repository slug as path parameters, users can programmatically initialize a new repository with configurable settings such as project assignment, description, privacy settings (public or private), and other repository-specific properties passed in the request body. The operation returns the newly created repository ob" }, { "info": { "name": "Atlassian Create Branch Restriction Rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/branch-restrictions", "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" } ], "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 branch restriction rule for a specific repository in Bitbucket Cloud, allowing workspace administrators to enforce policies on branches within a given repository. By sending a POST request to the endpoint with the workspace ID and repository slug as path parameters, users can define restrictions such as preventing force pushes, requiring pull request approvals, limiting who can merge or push to specific branches, or enforcing other branch protection policies. The" }, { "info": { "name": "Atlassian Create Comment for Commit", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/commit/:commit/comments", "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 API operation allows you to create a new comment on a specific commit within a Bitbucket repository. By sending a POST request to the endpoint with the workspace ID, repository slug, and commit hash, along with the comment content in the request body, you can add feedback, notes, or discussion points directly associated with that particular commit. This is useful for code review processes, documenting changes, or collaborating with team members on specific code modifications. The operation " }, { "info": { "name": "Atlassian Create or Update Report", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "commit", "value": "", "type": "path", "description": "The commit the report belongs to." }, { "name": "reportId", "value": "", "type": "path", "description": "Either the uuid or external-id of the report." } ], "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 PUT operation creates or updates a report for a specific commit in a Bitbucket repository, identified by the workspace, repository slug, commit SHA, and report ID. Reports are typically used to provide additional build, test, or code quality information about a commit, such as code coverage, security scans, or custom analysis results. The operation requires authentication and appropriate permissions to the repository, and accepts a JSON payload containing the report details including its ti" }, { "info": { "name": "Atlassian Bulk Create or Update Annotations", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId/annotations", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "commit", "value": "", "type": "path", "description": "The commit for which to retrieve reports." }, { "name": "reportId", "value": "", "type": "path", "description": "Uuid or external-if of the report for which to get annotations for." } ], "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": "Creates or updates individual annotation objects within a specified commit report in a Bitbucket repository, allowing developers to programmatically add code analysis findings, linting errors, test results, or other automated feedback directly to a specific commit. The operation requires the workspace ID, repository slug, commit hash, and report ID as path parameters, and accepts an array of annotation objects in the request body, each containing details such as line number, severity, annotation" }, { "info": { "name": "Atlassian Create or Update an Annotation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId/annotations/:annotationId", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "commit", "value": "", "type": "path", "description": "The commit the report belongs to." }, { "name": "reportId", "value": "", "type": "path", "description": "Either the uuid or external-id of the report." }, { "name": "annotationId", "value": "", "type": "path", "description": "Either the uuid or external-id of the annotation." } ], "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 PUT operation allows users to create or update a specific annotation for a code report associated with a particular commit in a Bitbucket repository. By providing the workspace identifier, repository slug, commit hash, report ID, and annotation ID in the URL path, developers can add detailed feedback or metadata about specific lines or sections of code within that commit's report. Annotations are typically used in CI/CD pipelines or code analysis tools to highlight issues, warnings, or sugg" }, { "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 Create Variable for an Environment", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/deployments_config/environments/:environment_uuid/variables", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." }, { "name": "environment_uuid", "value": "", "type": "path", "description": "The environment." } ], "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": "Creates a new deployment variable for a specific environment within a Bitbucket repository's deployment configuration. This operation requires specifying the workspace, repository slug, and environment UUID in the path, allowing teams to define environment-specific variables such as API keys, connection strings, or configuration values that will be available during the deployment process. The variable details including the key name, value, and optionally whether it should be secured or hidden ar" }, { "info": { "name": "Atlassian Create an Environment", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/environments", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." } ], "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": "The Create an Environment operation in the Atlassian Bitbucket Repositories API allows users to create a new deployment environment within a specific repository by sending a POST request to the /repositories/{workspace}/{repo_slug}/environments endpoint. This operation requires specifying both the workspace identifier and repository slug in the URL path, and enables teams to define distinct deployment targets such as development, staging, or production environments for their code. The created en" }, { "info": { "name": "Atlassian Create Webhook for Repository", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/hooks", "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 creates a new webhook for a specific Bitbucket repository within a workspace. When invoked via POST request to the endpoint /repositories/{workspace}/{repo_slug}/hooks, it allows you to configure automated notifications that trigger HTTP callbacks to a specified URL whenever certain events occur in the repository, such as push events, pull request updates, or issue changes. The workspace parameter identifies the Bitbucket workspace (formerly team), while repo_slug specifies th" }, { "info": { "name": "Atlassian Create an Issue", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues", "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" } ], "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": "Creates a new issue in the specified Bitbucket repository within a workspace. This POST endpoint allows users to submit issue details such as title, description, priority, and other metadata to track bugs, tasks, or feature requests. The operation requires authentication and appropriate repository permissions, with the workspace and repository slug specified in the URL path to identify the target repository where the issue will be created." }, { "info": { "name": "Atlassian Create Comment on an Issue", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/comments", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "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": "Creates a new comment on the specified issue in a Bitbucket repository. This POST endpoint requires authentication and targets a specific issue within a repository by providing the workspace identifier, repository slug, and issue ID in the URL path. The request body should contain the comment content and any additional metadata according to Bitbucket's comment schema. Upon successful execution, the API returns the newly created comment object including its unique identifier, author information, " }, { "info": { "name": "Atlassian Create Schedule", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pipelines_config/schedules", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." } ], "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": "Creates a new pipeline schedule for the specified repository in Bitbucket, allowing you to automate pipeline executions at defined intervals or specific times. This endpoint requires you to provide the workspace identifier and repository slug in the path, along with schedule configuration details in the request body such as the cron expression, target branch or tag, and whether the schedule is enabled. The schedule determines when pipelines will automatically trigger without manual intervention," }, { "info": { "name": "Atlassian Create Known Host", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pipelines_config/ssh/known_hosts", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." } ], "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": "Creates a new known host entry in the Bitbucket Pipelines SSH configuration for a specified repository, allowing the pipeline to establish secure SSH connections to external servers by adding their public key fingerprints to the trusted known hosts list. This endpoint requires authentication and accepts the workspace identifier and repository slug as path parameters, along with the host details in the request body, which typically includes the hostname and its corresponding SSH public key. Once " }, { "info": { "name": "Atlassian Create Variable for Repository", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pipelines_config/variables", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." }, { "name": "repo_slug", "value": "", "type": "path", "description": "The repository." } ], "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 pipeline variable for a specific Bitbucket repository within a workspace. By sending a POST request to the endpoint with the workspace ID and repository slug, users can define custom variables that will be available during pipeline executions. These variables are commonly used to store configuration values, credentials, or environment-specific settings that pipelines need to access during build, test, or deployment processes. The operation requires appropriate au" }, { "info": { "name": "Atlassian Create Branch", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/refs/branches", "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": "The Create Branch operation in the Atlassian Bitbucket Repositories API allows developers to programmatically create a new branch within a specified repository by sending a POST request to the /repositories/{workspace}/{repo_slug}/refs/branches endpoint. This operation requires authentication and takes the workspace identifier and repository slug as path parameters, along with a request body that typically includes the new branch name and the source commit or existing branch from which to create" }, { "info": { "name": "Atlassian Create Tag", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/refs/tags", "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" } ], "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": "The Create Tag operation in the Atlassian Bitbucket Repositories API allows users to create a new tag in a specified repository by sending a POST request to the /repositories/{workspace}/{repo_slug}/refs/tags endpoint. This operation requires the workspace identifier and repository slug as path parameters to target the specific repository where the tag should be created. The request typically includes details such as the tag name, the target commit hash or reference to which the tag should point" }, { "info": { "name": "Atlassian Create Commit by Uploading File", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/src", "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" }, { "name": "message", "value": "", "type": "query", "description": "The commit message. When omitted, Bitbucket uses a canned string." }, { "name": "author", "value": "", "type": "query", "description": "\nThe raw string to be used as the new Commits author.\nThis string follows the format\n`Erik van Zijst `.\n\nWhen omitted, Bitbucket uses the authenticated user's\nfull/display name and primary email address. Commits cannot\nbe created anonymously." }, { "name": "parents", "value": "", "type": "query", "description": "\nA comma-separated list of SHA1s of the commits that should\nbe the parents of the newly created commit.\n\nWhen omitted, the new commit will inherit from and become\na child of the main branch's tip/HEAD commit.\n\nWhen more than one SHA1 is provided, the first SHA1\nidentifies the commit from which the content will be\ninherited.\"." }, { "name": "files", "value": "", "type": "query", "description": "\nOptional field that declares the files that the request is\nmanipulating. When adding a new file to a repo, or when\noverwriting an existing file, the client can just upload\nthe full contents of the file in a normal form field and\nthe use of this `files` meta data field is redundant.\nHowever, when the `files` field contains a file path that\ndoes not have a corresponding, identically-named form\nfield, then Bitbucket interprets that as the client wanting\nto replace the named file with the null set and the file is\ndeleted instead.\n\nPaths in the repo that are referenced in neither files nor\nan individual file field, remain unchanged and carry over\nfrom the parent to the new commit.\n\nThis API does not support renaming as an explicit feature.\nTo rename a file, simply delete it and recreate it under\nthe new name in the same commit.\n" }, { "name": "branch", "value": "", "type": "query", "description": "\nThe name of the branch that the new commit should be\ncreated on. When omitted, the commit will be created on top\nof the main branch and will become the main branch's new\nhead.\n\nWhen a branch name is provided that already exists in the\nrepo, then the commit will be created on top of that\nbranch. In this case, *if* a parent SHA1 was also provided,\nthen it is asserted that the parent is the branch's\ntip/HEAD at the time the request is made. When this is not\nthe case, a 409 is returned.\n\nWhen a new branch name is specified (that does not already\nexist in the repo), and no parent SHA1s are provided, then\nthe new commit will inherit from the current main branch's\ntip/HEAD commit, but not advance the main branch. The new\ncommit will be the new branch. When the request *also*\nspecifies a parent SHA1, then the new commit and branch\nare created directly on top of the parent commit,\nregardless of the state of the main branch.\n\nWhen a branch name is not specified, but a parent SHA1 is\nprovided, then Bitbucket asserts that it represents the\nmain branch's current HEAD/tip, or a 409 is returned.\n\nWhen a branch name is not specified and the repo is empty,\nthe new commit will become the repo's root commit and will\nbe on the main branch.\n\nWhen a branch name is specified and the repo is empty, the\nnew commit will become the repo's root commit and also\ndefine the repo's main branch going forward.\n\nThis API cannot be used to create additional root commits\nin non-empty repos.\n\nThe branch field cannot be repeated.\n\nAs a side effect, this API can be used to create a new\nbranch without modifying any files, by specifying a new\nbranch name in this field, together with `parents`, but\nomitting the `files` fields, while not sending any files.\nThis will create a new commit and branch with the same\ncontents as the first parent. The diff of this commit\nagainst its first parent will be empty.\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 operation allows you to create a new commit in a Bitbucket repository by uploading one or more files directly through the API. You specify the target workspace and repository via the path parameters, then provide the file content along with commit metadata such as the commit message, branch name, author information, and optional parent commit references in the request body. The files are uploaded as multipart form data, where each file can be specified with its path in the repository and it" }, { "info": { "name": "Atlassian Create Snippet for Workspace", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/snippets/:workspace", "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 code snippet within a specified Atlassian Bitbucket workspace by sending a POST request to the /snippets/{workspace} endpoint, where {workspace} is replaced with the unique identifier or name of the target workspace. The operation allows authenticated users to programmatically submit code snippets, which can include multiple files, descriptions, and metadata, to be stored and shared within the designated workspace, making it useful for developers who want to save" }, { "info": { "name": "Atlassian Create Comment on Snippet", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/snippets/:workspace/:encoded_id/comments", "params": [ { "name": "encoded_id", "value": "", "type": "path", "description": "The snippet id." }, { "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": "The Atlassian Bitbucket Snippets API POST operation to /snippets/{workspace}/{encoded_id}/comments allows authenticated users to create a new comment on a specific code snippet within a designated workspace. This endpoint requires two path parameters: the workspace identifier and the encoded snippet ID, enabling precise targeting of the snippet to be commented on. When invoked, it accepts comment content in the request body and creates a new comment thread or adds to an existing discussion on th" }, { "info": { "name": "Atlassian Create Variable for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/teams/:username/pipelines_config/variables", "params": [ { "name": "username", "value": "", "type": "path", "description": "The account." } ], "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 pipeline configuration variable for a specific Bitbucket team identified by the username parameter in the path. It allows administrators to define custom variables that can be used across pipeline configurations for the team, enabling centralized management of configuration values such as credentials, API keys, or environment-specific settings. The operation requires a POST request to the endpoint with the Teams username and the variable details in the request bo" }, { "info": { "name": "Atlassian Create Variable for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/users/:selected_user/pipelines_config/variables", "params": [ { "name": "selected_user", "value": "", "type": "path", "description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID." } ], "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 pipeline configuration variable for a specified Bitbucket user account. By sending a POST request to the endpoint with the target Users identifier, administrators can define custom variables that will be available across all pipelines associated with that Users repositories. The variables typically include key-value pairs used for storing configuration settings, credentials, or other data needed during pipeline execution, and can be marked as secured to protect s" }, { "info": { "name": "Atlassian Create a Webhook for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/workspaces/:workspace/hooks", "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 creates a new webhook for a specified Bitbucket workspace by sending a POST request to the /workspaces/{workspace}/hooks endpoint. Webhooks allow workspaces to receive real-time HTTP callbacks when specific events occur within the workspace, such as repository pushes, pull requests, or issue updates. The workspace is identified by the {workspace} path parameter, which represents the workspace ID or slug. The request typically requires authentication and a JSON payload containi" }, { "info": { "name": "Atlassian Create a Variable for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/workspaces/:workspace/pipelines-config/variables", "params": [ { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`." } ], "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": "The POST operation on the /workspaces/{workspace}/pipelines-config/variables endpoint allows you to create a new pipeline variable within a specific Bitbucket workspace, enabling you to define configuration values that can be used across multiple pipelines in that workspace. This endpoint requires you to specify the workspace slug in the path parameter and provide the variable details in the request body, typically including the variable's key (name), value, and whether it should be secured/encr" }, { "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 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 Create Attachment", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/child/attachment", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to add the attachment to." }, { "name": "status", "value": "", "type": "query", "description": "The status of the content that the attachment is being added to." } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "comment", "type": "text", "value": "" }, { "name": "minorEdit", "type": "text", "value": "" } ] } }, "docs": "This POST operation allows you to create and upload new attachments to a specific Confluence page or blog post by providing the content ID in the URL path. The endpoint accepts multipart/form-data requests containing the file to be uploaded along with optional metadata such as comments or attachment properties. Upon successful execution, it returns details about the newly created attachment including its ID, title, download URL, media type, file size, and version information. The authenticated u" }, { "info": { "name": "Atlassian Create or Update Attachment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/child/attachment", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to add the attachment to." }, { "name": "status", "value": "", "type": "query", "description": "The status of the content that the attachment is being added to.\nThis should always be set to 'current'." } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "comment", "type": "text", "value": "" }, { "name": "minorEdit", "type": "text", "value": "" } ] } }, "docs": "This API operation allows you to create a new attachment or update an existing attachment for a specific Confluence page or blog post identified by its content ID. When uploading a file, you must use multipart/form-data encoding and include the file in the request body along with optional metadata such as comments or minor edit flags. If an attachment with the same filename already exists, this operation will create a new version of that attachment rather than replacing it entirely, maintaining " }, { "info": { "name": "Atlassian Create Content Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to add the property to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new content property for an existing Confluence content item identified by its ID. Content properties are custom key-value pairs that allow you to store additional metadata or configuration data associated with a specific piece of content such as a page, blog post, or attachment. The property must include a unique key within the scope of that content item and a value, which can be a simple string or a complex JSON object. This operation requires appropriate permissions to modify the sp" }, { "info": { "name": "Atlassian Create Content Property for Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to add the property to." }, { "name": "key", "value": "", "type": "path", "description": "The key of the content property. Required." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new content property for the specified content ID and property key in Confluence. This endpoint allows you to store custom metadata or additional information associated with a specific piece of content by posting a JSON payload containing the property value. The property is identified by a unique key and is scoped to the individual content item, making it useful for storing application-specific data, custom attributes, or extended metadata that needs to be associated with pages, blog p" } ] } ], "bundled": true }