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

The Snippets API from Atlassian — 14 operation(s) for snippets.

Atlassian Snippets 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 Snippets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

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

25 operations 14 paths 14 schemas 4 DELETE14 GET3 POST4 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 Snippets 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 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
/snippets
Atlassian List Snippets
atlassianListSnippets 1 param → 200404
POST
/snippets
Atlassian Create A Snippet
atlassianCreateASnippet body → 201401
GET
/snippets/{workspace}
Atlassian List Snippets In A Workspace
atlassianListSnippetsInAWorkspace 2 params → 200404
POST
/snippets/{workspace}
Atlassian Create A Snippet For A Workspace
atlassianCreateASnippetForAWorkspace 1 param body → 201401403
DELETE
/snippets/{workspace}/{encoded_id}
Atlassian Delete A Snippet
atlassianDeleteASnippet 2 params → 204401403404
GET
/snippets/{workspace}/{encoded_id}
Atlassian Get A Snippet
atlassianGetASnippet 2 params → 200401403404410
PUT
/snippets/{workspace}/{encoded_id}
Atlassian Update A Snippet
atlassianUpdateASnippet 2 params → 200401403404
GET
/snippets/{workspace}/{encoded_id}/comments
Atlassian List Comments On A Snippet
atlassianListCommentsOnASnippet 2 params → 200403404
POST
/snippets/{workspace}/{encoded_id}/comments
Atlassian Create A Comment On A Snippet
atlassianCreateACommentOnASnippet 2 params body → 201403404
DELETE
/snippets/{workspace}/{encoded_id}/comments/{comment_id}
Atlassian Delete A Comment On A Snippet
atlassianDeleteACommentOnASnippet 3 params → 204403404
GET
/snippets/{workspace}/{encoded_id}/comments/{comment_id}
Atlassian Get A Comment On A Snippet
atlassianGetACommentOnASnippet 3 params → 200403404
PUT
/snippets/{workspace}/{encoded_id}/comments/{comment_id}
Atlassian Update A Comment On A Snippet
atlassianUpdateACommentOnASnippet 3 params body → 200403404
GET
/snippets/{workspace}/{encoded_id}/commits
Atlassian List Snippet Changes
atlassianListSnippetChanges 2 params → 200403404
GET
/snippets/{workspace}/{encoded_id}/commits/{revision}
Atlassian Get A Previous Snippet Change
atlassianGetAPreviousSnippetChange 3 params → 200403404
GET
/snippets/{workspace}/{encoded_id}/files/{path}
Atlassian Get A Snippet S Raw File At Head
atlassianGetASnippetSRawFileAtHEAD 3 params → 302403404
DELETE
/snippets/{workspace}/{encoded_id}/watch
Atlassian Stop Watching A Snippet
atlassianStopWatchingASnippet 2 params → 204401404
GET
/snippets/{workspace}/{encoded_id}/watch
Atlassian Check If The Current User Is Watching A Snippet
atlassianCheckIfTheCurrentUserIsWatchingASnippet 2 params → 204404
PUT
/snippets/{workspace}/{encoded_id}/watch
Atlassian Watch A Snippet
atlassianWatchASnippet 2 params → 204401404
GET
/snippets/{workspace}/{encoded_id}/watchersdeprecated
Atlassian List Users Watching A Snippet
atlassianListUsersWatchingASnippet 2 params → 200404
DELETE
/snippets/{workspace}/{encoded_id}/{node_id}
Atlassian Delete A Previous Revision Of A Snippet
atlassianDeleteAPreviousRevisionOfASnippet 3 params → 204401403404405
GET
/snippets/{workspace}/{encoded_id}/{node_id}
Atlassian Get A Previous Revision Of A Snippet
atlassianGetAPreviousRevisionOfASnippet 3 params → 200401403404
PUT
/snippets/{workspace}/{encoded_id}/{node_id}
Atlassian Update A Previous Revision Of A Snippet
atlassianUpdateAPreviousRevisionOfASnippet 3 params → 200401403404405
GET
/snippets/{workspace}/{encoded_id}/{node_id}/files/{path}
Atlassian Get A Snippet S Raw File
atlassianGetASnippetSRawFile 4 params → 200403404
GET
/snippets/{workspace}/{encoded_id}/{revision}/diff
Atlassian Get Snippet Changes Between Versions
atlassianGetSnippetChangesBetweenVersions 4 params → 200403404
GET
/snippets/{workspace}/{encoded_id}/{revision}/patch
Atlassian Get Snippet Patch Between Versions
atlassianGetSnippetPatchBetweenVersions 3 params → 200403404

Schemas 14

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-snippets-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 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.