How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitbucket Pipelines Branching model API

The branching model resource is used to modify the branching modelfor a repository.You can use the branching model to define a branch based workflowfor your repositories. When you map your workflow to branch types,you can ensure that branches are named consistently by configuringwhich branch types to make available.

Bitbucket Pipelines Branching model API is one of 23 APIs that Bitbucket Pipelines publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Branching model. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 7 operations across 5 paths, and defines 20 schemas. It is described by OpenAPI 2.0, at version 2.0.

Requests are made against the base URL https://api.bitbucket.org/2.0.

7 operations 5 paths 20 schemas 5 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.0
Base URL
https://api.bitbucket.org/2.0
Authentication
basic, OAuth 2.0, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Bitbucket Pipelines Branching model API declares 3 security schemes for authenticating requests. It defines a basic scheme (basic). It supports OAuth 2.0 (oauth2) using the accessCode flow, exposing 26 scopes. An API key is passed in the header as Authorization (api_key).

  • basic — Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth is available only with username a…
  • oauth2 — OAuth 2 as per [RFC-6749](https://tools.ietf.org/html/rfc6749).
  • api_key — API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only availa…

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 5 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Branching model 7

The branching model resource is used to modify the branching model for a repository. You can use the branching model to define a branch based workflow for your repositories. When…

GET
/repositories/{workspace}/{repo_slug}/branching-model
Get the branching model for a repository
2 params → 200401403404
GET
/repositories/{workspace}/{repo_slug}/branching-model/settings
Get the branching model config for a repository
2 params → 200401403404
PUT
/repositories/{workspace}/{repo_slug}/branching-model/settings
Update the branching model config for a repository
2 params → 200400401403404
GET
/repositories/{workspace}/{repo_slug}/effective-branching-model
Get the effective, or currently applied, branching model for a repository
2 params → 200401403404
GET
/workspaces/{workspace}/projects/{project_key}/branching-model
Get the branching model for a project
2 params → 200401403404
GET
/workspaces/{workspace}/projects/{project_key}/branching-model/settings
Get the branching model config for a project
2 params → 200401403404
PUT
/workspaces/{workspace}/projects/{project_key}/branching-model/settings
Update the branching model config for a project
2 params → 200400401403404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ref (4 properties), link (2 properties), error (2 properties), account_links (1 property). Each schema is shown below with its type and property counts.

project
branching_model_settings
base_commit
account
branch
project_branching_model
participant
team_links
ref
object
A ref object, representing a branch or tag in a repository.
4 properties 1 required
branching_model
author
error
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
2 properties 1 required
committer
effective_repo_branching_model
account_links
object
Links related to an Account.
1 property
commit
repository
link
object
A link to a resource related to this object.
2 properties
team
object
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitbucket-pipelines-branching-model-api-openapi.yml Raw ↑

Other APIs Bitbucket Pipelines publishes across the network.

Bitbucket Pipelines Addon API
Bitbucket Pipelines Branch restrictions API
Bitbucket Pipelines Commit statuses API
Bitbucket Pipelines Commits API
Bitbucket Pipelines Deployments API
Bitbucket Pipelines Downloads API
Bitbucket Pipelines GPG API
Bitbucket Pipelines Issue tracker API
Bitbucket Pipelines Pipelines API
Bitbucket Pipelines Projects API
Bitbucket Pipelines properties API
Bitbucket Pipelines Pullrequests API
Where this information came from

This is an independent, third-party profile of Bitbucket Pipelines Branching model API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.