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 Snippets API

Snippets allow you share code segments or files with yourself, members ofyour workspace, or the world.Like pull requests, repositories and workspaces, the full set of snippetsis defined by what the current user has access to. This includes allsnippets owned by any of the workspaces the user is a member of, orsnippets by other users that the current user is either watching or has collaborated on (for instance by commenting on it).

Bitbucket Snippets API is one of 23 APIs that Bitbucket publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Snippets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an AsyncAPI specification, and 8 JSON Schemas.

This API exposes 25 operations across 14 paths, and defines 15 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.

25 operations 14 paths 15 schemas 4 DELETE14 GET3 POST4 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 Snippets 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 25

Across 14 paths, the API surfaces 25 operations — 4 DELETE, 14 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Snippets 25

Snippets allow you share code segments or files with yourself, members of your workspace, or the world. Like pull requests, repositories and workspaces, the full set of snippets i…

GET
/snippetsdeprecated
List snippets
1 param → 200404
POST
/snippets
Create a snippet
1 param → 201401
GET
/snippets/{workspace}
List snippets in a workspace
2 params → 200404
POST
/snippets/{workspace}
Create a snippet for a workspace
2 params → 201401403
DELETE
/snippets/{workspace}/{encoded_id}
Delete a snippet
2 params → 204401403404
GET
/snippets/{workspace}/{encoded_id}
Get a snippet
2 params → 200401403404410
PUT
/snippets/{workspace}/{encoded_id}
Update a snippet
2 params → 200401403404
GET
/snippets/{workspace}/{encoded_id}/comments
List comments on a snippet
2 params → 200403404
POST
/snippets/{workspace}/{encoded_id}/comments
Create a comment on a snippet
3 params → 201403404
DELETE
/snippets/{workspace}/{encoded_id}/comments/{comment_id}
Delete a comment on a snippet
3 params → 204403404
GET
/snippets/{workspace}/{encoded_id}/comments/{comment_id}
Get a comment on a snippet
3 params → 200403404
PUT
/snippets/{workspace}/{encoded_id}/comments/{comment_id}
Update a comment on a snippet
4 params → 200403404
GET
/snippets/{workspace}/{encoded_id}/commits
List snippet changes
2 params → 200403404
GET
/snippets/{workspace}/{encoded_id}/commits/{revision}
Get a previous snippet change
3 params → 200403404
GET
/snippets/{workspace}/{encoded_id}/files/{path}
Get a snippet's raw file at HEAD
3 params → 302403404
DELETE
/snippets/{workspace}/{encoded_id}/watch
Stop watching a snippet
2 params → 204401404
GET
/snippets/{workspace}/{encoded_id}/watch
Check if the current user is watching a snippet
2 params → 204404
PUT
/snippets/{workspace}/{encoded_id}/watch
Watch a snippet
2 params → 204401404
GET
/snippets/{workspace}/{encoded_id}/watchersdeprecated
List users watching a snippet
2 params → 200404
DELETE
/snippets/{workspace}/{encoded_id}/{node_id}
Delete a previous revision of a snippet
3 params → 204401403404405
GET
/snippets/{workspace}/{encoded_id}/{node_id}
Get a previous revision of a snippet
3 params → 200401403404
PUT
/snippets/{workspace}/{encoded_id}/{node_id}
Update a previous revision of a snippet
3 params → 200401403404405
GET
/snippets/{workspace}/{encoded_id}/{node_id}/files/{path}
Get a snippet's raw file
4 params → 200403404
GET
/snippets/{workspace}/{encoded_id}/{revision}/diff
Get snippet changes between versions
4 params → 200403404
GET
/snippets/{workspace}/{encoded_id}/{revision}/patch
Get snippet patch between versions
3 params → 200403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are paginated_snippets (6 properties), paginated_accounts (6 properties), paginated_snippet_comments (6 properties), paginated_snippet_commit (6 properties). Each schema is shown below with its type and property counts.

base_commit
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
link
object
A link to a resource related to this object.
2 properties
snippet_commit
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
paginated_snippet_comments
object
A paginated list of snippet comments.
6 properties
snippet_comment
paginated_snippet_commit
object
A paginated list of snippet commits.
6 properties
committer
snippet
author
account
paginated_accounts
object
A paginated list of accounts.
6 properties
paginated_snippets
object
A paginated list of snippets.
6 properties
account_links
object
Links related to an Account.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitbucket-snippets-api-openapi.yml Raw ↑

Other APIs Bitbucket publishes across the network.

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

This is an independent, third-party profile of Bitbucket Snippets 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.