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

Atlassian Branch Restrictions API

The Branch Restrictions API from Atlassian — 2 operation(s) for branch restrictions.

Atlassian Branch Restrictions API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Branch restrictions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

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

Requests are made against a single base URL, https://api.bitbucket.org/2.0.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://api.bitbucket.org/2.0
Authentication
HTTP Basic, OAuth 2.0, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Atlassian Branch Restrictions API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basic). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 24 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 5

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

Branch Restrictions 5
GET
/repositories/{workspace}/{repo_slug}/branch-restrictions
Atlassian List Branch Restrictions
atlassianListBranchRestrictions 4 params → 200401403404
POST
/repositories/{workspace}/{repo_slug}/branch-restrictions
Atlassian Create A Branch Restriction Rule
atlassianCreateABranchRestrictionRule 2 params body → 201401403404
DELETE
/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}
Atlassian Delete A Branch Restriction Rule
atlassianDeleteABranchRestrictionRule 3 params → 204401403404
GET
/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}
Atlassian Get A Branch Restriction Rule
atlassianGetABranchRestrictionRule 3 params → 200401403404
PUT
/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}
Atlassian Update A Branch Restriction Rule
atlassianUpdateABranchRestrictionRule 3 params body → 200401403404

Schemas 9

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

group
account_links
object
Links related to an Account.
1 property
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
workspace
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
paginated_branchrestrictions
object
A paginated list of branch restriction rules.
6 properties
link
object
A link to a resource related to this object.
2 properties
branchrestriction
account

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-branch-restrictions-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian Branch Restrictions 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.