• Addon
  • Branch restrictions
  • Branching model
  • Commit statuses
  • Commits
  • Deployments
  • Downloads
  • Issue tracker
  • Pipelines
  • Projects
  • Pullrequests
  • Refs
  • Reports
  • Repositories
  • Snippets
  • Source
  • Ssh
  • Users
  • Webhooks
  • Workspaces
  • Other operations
Cloud
Bitbucket Cloud / Reference / REST APIs

Snippets

Postman Collection
OpenAPI

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 is defined by what the current user has access to. This includes all snippets owned by any of the workspaces the user is a member of, or snippets by other users that the current user is either watching or has collaborated on (for instance by commenting on it).

GET

List snippets

Returns all snippets. Like pull requests, repositories and workspaces, the full set of snippets is defined by what the current user has access to.

This includes all snippets owned by any of the workspaces the user is a member of, or snippets by other users that the current user is either watching or has collaborated on (for instance by commenting on it).

To limit the set of returned snippets, apply the ?role=[owner|contributor|member] query parameter where the roles are defined as follows:

  • owner: all snippets owned by the current user
  • contributor: all snippets owned by, or watched by the current user
  • member: created in a workspaces or watched by the current user

When no role is specified, all public snippets are returned, as well as all privately owned snippets watched or commented on.

The returned response is a normal paginated JSON list. This endpoint only supports application/json responses and no multipart/form-data or multipart/related. As a result, it is not possible to include the file contents.

snippet

Request

Query parameters

role

string

Responses

A paginated list of snippets.

application/json

Paginated Snippets

A paginated list of snippets.

GET/snippets
1 2 3 4 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "size": 142, "page": 102, "pagelen": 159, "next": "<string>", "previous": "<string>", "values": [ { "type": "<string>", "id": 2154, "title": "<string>", "scm": "git", "created_on": "<string>", "updated_on": "<string>", "owner": { "type": "<string>" }, "creator": { "type": "<string>" }, "is_private": true } ] }
POST

Create a snippet

Creates a new snippet under the authenticated user's account.

Snippets can contain multiple files. Both text and binary files are supported.

The simplest way to create a new snippet from a local file:

1 $ curl -u username:password -X POST https://api.bitbucket.org/2.0/snippets -F file=@image.png

Creating snippets through curl has a few limitations and so let's look at a more complicated scenario.

Snippets are created with a multipart POST. Both multipart/form-data and multipart/related are supported. Both allow the creation of snippets with both meta data (title, etc), as well as multiple text and binary files.

The main difference is that multipart/related can use rich encoding for the meta data (currently JSON).

This is the most advanced and efficient way to create a paste.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 POST /2.0/snippets/evzijst HTTP/1.1 Content-Length: 1188 Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974==" MIME-Version: 1.0 --===============1438169132528273974== Content-Type: application/json; charset="utf-8" MIME-Version: 1.0 Content-ID: snippet { "title": "My snippet", "is_private": true, "scm": "git", "files": { "foo.txt": {}, "image.png": {} } } --===============1438169132528273974== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-ID: "foo.txt" Content-Disposition: attachment; filename="foo.txt" foo --===============1438169132528273974== Content-Type: image/png MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-ID: "image.png" Content-Disposition: attachment; filename="image.png" iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5 EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg== --===============1438169132528273974==--

The request contains multiple parts and is structured as follows.

The first part is the JSON document that describes the snippet's properties or meta data. It either has to be the first part, or the request's Content-Type header must contain the start parameter to point to it.

The remaining parts are the files of which there can be zero or more. Each file part should contain the Content-ID MIME header through which the JSON meta data's files element addresses it. The value should be the name of the file.

Content-Disposition is an optional MIME header. The header's optional filename parameter can be used to specify the file name that Bitbucket should use when writing the file to disk. When present, filename takes precedence over the value of Content-ID.

When the JSON body omits the files element, the remaining parts are not ignored. Instead, each file is added to the new snippet as if its name was explicitly linked (the use of the files elements is mandatory for some operations like deleting or renaming files).

multipart/form-data

The use of JSON for the snippet's meta data is optional. Meta data can also be supplied as regular form fields in a more conventional multipart/form-data request:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 $ curl -X POST -u credentials https://api.bitbucket.org/2.0/snippets -F title="My snippet" -F file=@foo.txt -F file=@image.png POST /2.0/snippets HTTP/1.1 Content-Length: 951 Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f ------------------------------63a4b224c59f Content-Disposition: form-data; name="file"; filename="foo.txt" Content-Type: text/plain foo ------------------------------63a4b224c59f Content-Disposition: form-data; name="file"; filename="image.png" Content-Type: application/octet-stream ?PNG IHDR?1??I..... ------------------------------63a4b224c59f Content-Disposition: form-data; name="title" My snippet ------------------------------63a4b224c59f--

Here the meta data properties are included as flat, top-level form fields. The file attachments use the file field name. To attach multiple files, simply repeat the field.

The advantage of multipart/form-data over multipart/related is that it can be easier to build clients.

Essentially all properties are optional, title and files included.

Sharing and Visibility

Snippets can be either public (visible to anyone on Bitbucket, as well as anonymous users), or private (visible only to members of the workspace). This is controlled through the snippet's is_private element:

  • is_private=false -- everyone, including anonymous users can view the snippet
  • is_private=true -- only workspace members can view the snippet

To create the snippet under a workspace, just append the workspace ID to the URL. See /2.0/snippets/{workspace}.

snippet:write

Request

Request bodyapplication/json

The new snippet object.

allOf [object, Snippet]

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 discriminator.

Snippet

A snippet object.

Responses

The newly created snippet object.

Headers

Location

string

application/json

allOf [object, Snippet]

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 discriminator.

Snippet

A snippet object.

POST/snippets
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 curl --request POST \ --url 'https://api.bitbucket.org/2.0/snippets' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "type": "<string>", "id": 2154, "title": "<string>", "scm": "git", "created_on": "<string>", "updated_on": "<string>", "owner": { "type": "<string>" }, "creator": { "type": "<string>" }, "is_private": true }'
201Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "type": "<string>", "id": 2154, "title": "<string>", "scm": "git", "created_on": "<string>", "updated_on": "<string>", "owner": { "type": "<string>" }, "creator": { "type": "<string>" }, "is_private": true }
GET

List snippets in a workspace

Identical to /snippets, except that the result is further filtered by the snippet owner and only those that are owned by {workspace} are returned.

snippet

Request

Path parameters

workspace

string

Required

Query parameters

role

string

Responses

A paginated list of snippets.

application/json

Paginated Snippets

A paginated list of snippets.

GET/snippets/{workspace}
1 2 3 4 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "size": 142, "page": 102, "pagelen": 159, "next": "<string>", "previous": "<string>", "values": [ { "type": "<string>", "id": 2154, "title": "<string>", "scm": "git", "created_on": "<string>", "updated_on": "<string>", "owner": { "type": "<string>" }, "creator": { "type": "<string>" }, "is_private": true } ] }
POST

Create a snippet for a workspace

Identical to /snippets, except that the new snippet will be created under the workspace specified in the path parameter {workspace}.

snippet:write

Request

Path parameters

workspace

string

Required

Request bodyapplication/json

The new snippet object.

allOf [object, Snippet]

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 discriminator.

Snippet

A snippet object.

Responses

The newly created snippet object.

Headers

Location

string

application/json

allOf [object, Snippet]

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 discriminator.

Snippet

A snippet object.

POST/snippets/{workspace}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 curl --request POST \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "type": "<string>", "id": 2154, "title": "<string>", "scm": "git", "created_on": "<string>", "updated_on": "<string>", "owner": { "type": "<string>" }, "creator": { "type": "<string>" }, "is_private": true }'
201Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "type": "<string>", "id": 2154, "title": "<string>", "scm": "git", "created_on": "<string>", "updated_on": "<string>", "owner": { "type": "<string>" }, "creator": { "type": "<string>" }, "is_private": true }
GET

Get a snippet

Retrieves a single snippet.

Snippets support multiple content types:

  • application/json
  • multipart/related
  • multipart/form-data

application/json

The default content type of the response is application/json. Since JSON is always utf-8, it cannot reliably contain file contents for files that are not text. Therefore, JSON snippet documents only contain the filename and links to the file contents.

This means that in order to retrieve all parts of a snippet, N+1 requests need to be made (where N is the number of files in the snippet).

To retrieve an entire snippet in a single response, use the Accept: multipart/related HTTP request header.

1 $ curl -H "Accept: multipart/related" https://api.bitbucket.org/2.0/snippets/evzijst/1

Response:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 HTTP/1.1 200 OK Content-Length: 2214 Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974==" MIME-Version: 1.0 --===============1438169132528273974== Content-Type: application/json; charset="utf-8" MIME-Version: 1.0 Content-ID: snippet { "links": { "self": { "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj" }, "html": { "href": "https://bitbucket.org/snippets/evzijst/kypj" }, "comments": { "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/comments" }, "watchers": { "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/watchers" }, "commits": { "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/commits" } }, "id": kypj, "title": "My snippet", "created_on": "2014-12-29T22:22:04.790331+00:00", "updated_on": "2014-12-29T22:22:04.790331+00:00", "is_private": false, "files": { "foo.txt": { "links": { "self": { "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/foo.txt" }, "html": { "href": "https://bitbucket.org/snippets/evzijst/kypj#file-foo.txt" } } }, "image.png": { "links": { "self": { "href": "https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/image.png" }, "html": { "href": "https://bitbucket.org/snippets/evzijst/kypj#file-image.png" } } } ], "owner": { "username": "evzijst", "nickname": "evzijst", "display_name": "Erik van Zijst", "uuid": "{d301aafa-d676-4ee0-88be-962be7417567}", "links": { "self": { "href": "https://api.bitbucket.org/2.0/users/evzijst" }, "html": { "href": "https://bitbucket.org/evzijst" }, "avatar": { "href": "https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png" } } }, "creator": { "username": "evzijst", "nickname": "evzijst", "display_name": "Erik van Zijst", "uuid": "{d301aafa-d676-4ee0-88be-962be7417567}", "links": { "self": { "href": "https://api.bitbucket.org/2.0/users/evzijst" }, "html": { "href": "https://bitbucket.org/evzijst" }, "avatar": { "href": "https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png" } } } } --===============1438169132528273974== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-ID: "foo.txt" Content-Disposition: attachment; filename="foo.txt" foo --===============1438169132528273974== Content-Type: image/png MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-ID: "image.png" Content-Disposition: attachment; filename="image.png" iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5 EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg== --===============1438169132528273974==--

multipart/form-data

As with creating new snippets, multipart/form-data can be used as an alternative to multipart/related. However, the inherently flat structure of form-data means that only basic, root-level properties can be returned, while nested elements like links are omitted:

1 $ curl -H "Accept: multipart/form-data" https://api.bitbucket.org/2.0/snippets/evzijst/kypj

Response:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 HTTP/1.1 200 OK Content-Length: 951 Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f ------------------------------63a4b224c59f Content-Disposition: form-data; name="title" Content-Type: text/plain; charset="utf-8" My snippet ------------------------------63a4b224c59f-- Content-Disposition: attachment; name="file"; filename="foo.txt" Content-Type: text/plain foo ------------------------------63a4b224c59f Content-Disposition: attachment; name="file"; filename="image.png" Content-Transfer-Encoding: base64 Content-Type: application/octet-stream iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5 EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg== ------------------------------5957323a6b76--
snippet

Request

Path parameters

encoded_id

string

Required
workspace

string

Required

Responses

The snippet object.

application/json multipart/related multipart/form-data

allOf [object, Snippet]

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 discriminator.

Snippet

A snippet object.

GET/snippets/{workspace}/{encoded_id}
1 2 3 4 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "type": "<string>", "id": 2154, "title": "<string>", "scm": "git", "created_on": "<string>", "updated_on": "<string>", "owner": { "type": "<string>" }, "creator": { "type": "<string>" }, "is_private": true }
PUT

Update a snippet

Used to update a snippet. Use this to add and delete files and to change a snippet's title.

To update a snippet, one can either PUT a full snapshot, or only the parts that need to be changed.

The contract for PUT on this API is that properties missing from the request remain untouched so that snippets can be efficiently manipulated with differential payloads.

To delete a property (e.g. the title, or a file), include its name in the request, but omit its value (use null).

As in Git, explicit renaming of files is not supported. Instead, to rename a file, delete it and add it again under another name. This can be done atomically in a single request. Rename detection is left to the SCM.

PUT supports three different content types for both request and response bodies:

  • application/json
  • multipart/related
  • multipart/form-data

The content type used for the request body can be different than that used for the response. Content types are specified using standard HTTP headers.

Use the Content-Type and Accept headers to select the desired request and response format.

application/json

As with creation and retrieval, the content type determines what properties can be manipulated. application/json does not support file contents and is therefore limited to a snippet's meta data.

To update the title, without changing any of its files:

1 $ curl -X POST -H "Content-Type: application/json" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{"title": "Updated title"}'

To delete the title:

1 $ curl -X POST -H "Content-Type: application/json" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{"title": null}'

Not all parts of a snippet can be manipulated. The owner and creator for instance are immutable.

multipart/related can be used to manipulate all of a snippet's properties. The body is identical to a POST. properties omitted from the request are left unchanged. Since the start part contains JSON, the mechanism for manipulating the snippet's meta data is identical to application/json requests.

To update one of a snippet's file contents, while also changing its title:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 PUT /2.0/snippets/evzijst/kypj HTTP/1.1 Content-Length: 288 Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974==" MIME-Version: 1.0 --===============1438169132528273974== Content-Type: application/json; charset="utf-8" MIME-Version: 1.0 Content-ID: snippet { "title": "My updated snippet", "files": { "foo.txt": {} } } --===============1438169132528273974== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-ID: "foo.txt" Content-Disposition: attachment; filename="foo.txt" Updated file contents. --===============1438169132528273974==--

Here only the parts that are changed are included in the body. The other files remain untouched.

Note the use of the files list in the JSON part. This list contains the files that are being manipulated. This list should have corresponding multiparts in the request that contain the new contents of these files.

If a filename in the files list does not have a corresponding part, it will be deleted from the snippet, as shown below:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 PUT /2.0/snippets/evzijst/kypj HTTP/1.1 Content-Length: 188 Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974==" MIME-Version: 1.0 --===============1438169132528273974== Content-Type: application/json; charset="utf-8" MIME-Version: 1.0 Content-ID: snippet { "files": { "image.png": {} } } --===============1438169132528273974==--

To simulate a rename, delete a file and add the same file under another name:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 PUT /2.0/snippets/evzijst/kypj HTTP/1.1 Content-Length: 212 Content-Type: multipart/related; start="snippet"; boundary="===============1438169132528273974==" MIME-Version: 1.0 --===============1438169132528273974== Content-Type: application/json; charset="utf-8" MIME-Version: 1.0 Content-ID: snippet { "files": { "foo.txt": {}, "bar.txt": {} } } --===============1438169132528273974== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-ID: "bar.txt" Content-Disposition: attachment; filename="bar.txt" foo --===============1438169132528273974==--

multipart/form-data

Again, one can also use multipart/form-data to manipulate file contents and meta data atomically.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 $ curl -X PUT http://localhost:12345/2.0/snippets/evzijst/kypj -F title="My updated snippet" -F file=@foo.txt PUT /2.0/snippets/evzijst/kypj HTTP/1.1 Content-Length: 351 Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f ------------------------------63a4b224c59f Content-Disposition: form-data; name="file"; filename="foo.txt" Content-Type: text/plain foo ------------------------------63a4b224c59f Content-Disposition: form-data; name="title" My updated snippet ------------------------------63a4b224c59f

To delete a file, omit its contents while including its name in the files field:

1 2 3 4 5 6 7 8 9 10 11 $ curl -X PUT https://api.bitbucket.org/2.0/snippets/evzijst/kypj -F files=image.png PUT /2.0/snippets/evzijst/kypj HTTP/1.1 Content-Length: 149 Content-Type: multipart/form-data; boundary=----------------------------ef8871065a86 ------------------------------ef8871065a86 Content-Disposition: form-data; name="files" image.png ------------------------------ef8871065a86--

The explicit use of the files element in multipart/related and multipart/form-data is only required when deleting files. The default mode of operation is for file parts to be processed, regardless of whether or not they are listed in files, as a convenience to the client.

snippet:write

Request

Path parameters

encoded_id

string

Required
workspace

string

Required

Responses

The updated snippet object.

application/json multipart/related multipart/form-data

allOf [object, Snippet]

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 discriminator.

Snippet

A snippet object.

PUT/snippets/{workspace}/{encoded_id}
1 2 3 4 curl --request PUT \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "type": "<string>", "id": 2154, "title": "<string>", "scm": "git", "created_on": "<string>", "updated_on": "<string>", "owner": { "type": "<string>" }, "creator": { "type": "<string>" }, "is_private": true }
DEL

Delete a snippet

Deletes a snippet and returns an empty response.

snippet:write

Request

Path parameters

encoded_id

string

Required
workspace

string

Required

Responses

If the snippet was deleted successfully.

DEL/snippets/{workspace}/{encoded_id}
1 2 3 curl --request DELETE \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}' \ --header 'Authorization: Bearer <access_token>'
GET

List comments on a snippet

Used to retrieve a paginated list of all comments for a specific snippet.

This resource works identical to commit and pull request comments.

The default sorting is oldest to newest and can be overridden with the sort query parameter.

snippet

Request

Path parameters

encoded_id

string

Required
workspace

string

Required

Responses

A paginated list of snippet comments, ordered by creation date.

application/json

Paginated Snippet Comments

A paginated list of snippet comments.

GET/snippets/{workspace}/{encoded_id}/comments
1 2 3 4 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/comments' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "size": 142, "page": 102, "pagelen": 159, "next": "<string>", "previous": "<string>", "values": [ { "type": "<string>", "links": { "self": { "href": "<string>", "name": "<string>" }, "html": { "href": "<string>", "name": "<string>" } }, "snippet": { "type": "<string>" } } ] }
POST

Create a comment on a snippet

Creates a new comment.

The only required field in the body is content.raw.

To create a threaded reply to an existing comment, include parent.id.

snippet

Request

Path parameters

encoded_id

string

Required
workspace

string

Required

Request bodyapplication/json

The contents of the new comment.

allOf [object, Snippet Comment]

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 discriminator.

Snippet Comment

A comment on a snippet.

Responses

The newly created comment.

Headers

Location

string

application/json

allOf [object, Snippet Comment]

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 discriminator.

Snippet Comment

A comment on a snippet.

POST/snippets/{workspace}/{encoded_id}/comments
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 curl --request POST \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/comments' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "type": "<string>", "links": { "self": { "href": "<string>", "name": "<string>" }, "html": { "href": "<string>", "name": "<string>" } }, "snippet": { "type": "<string>" } }'
201Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "type": "<string>", "links": { "self": { "href": "<string>", "name": "<string>" }, "html": { "href": "<string>", "name": "<string>" } }, "snippet": { "type": "<string>" } }
GET

Get a comment on a snippet

Returns the specific snippet comment.

snippet

Request

Path parameters

comment_id

integer

Required
encoded_id

string

Required
workspace

string

Required

Responses

The specified comment.

application/json

allOf [object, Snippet Comment]

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 discriminator.

Snippet Comment

A comment on a snippet.

GET/snippets/{workspace}/{encoded_id}/comments/{comment_id}
1 2 3 4 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/comments/{comment_id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "type": "<string>", "links": { "self": { "href": "<string>", "name": "<string>" }, "html": { "href": "<string>", "name": "<string>" } }, "snippet": { "type": "<string>" } }
PUT

Update a comment on a snippet

Updates a comment.

The only required field in the body is content.raw.

Comments can only be updated by their author.

snippet

Request

Path parameters

comment_id

integer

Required
encoded_id

string

Required
workspace

string

Required

Request bodyapplication/json

The contents to update the comment to.

allOf [object, Snippet Comment]

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 discriminator.

Snippet Comment

A comment on a snippet.

Responses

The updated comment object.

application/json

allOf [object, Snippet Comment]

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 discriminator.

Snippet Comment

A comment on a snippet.

PUT/snippets/{workspace}/{encoded_id}/comments/{comment_id}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 curl --request PUT \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/comments/{comment_id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "type": "<string>", "links": { "self": { "href": "<string>", "name": "<string>" }, "html": { "href": "<string>", "name": "<string>" } }, "snippet": { "type": "<string>" } }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "type": "<string>", "links": { "self": { "href": "<string>", "name": "<string>" }, "html": { "href": "<string>", "name": "<string>" } }, "snippet": { "type": "<string>" } }
DEL

Delete a comment on a snippet

Deletes a snippet comment. Comments can only be removed by the comment author, snippet creator, or workspace admin.

snippet

Request

Path parameters

comment_id

integer

Required
encoded_id

string

Required
workspace

string

Required

Responses

Indicates the comment was deleted successfully.

DEL/snippets/{workspace}/{encoded_id}/comments/{comment_id}
1 2 3 curl --request DELETE \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/comments/{comment_id}' \ --header 'Authorization: Bearer <access_token>'
GET

List snippet changes

Returns the changes (commits) made on this snippet.

snippet

Request

Path parameters

encoded_id

string

Required
workspace

string

Required

Responses

The paginated list of snippet commits.

application/json

Paginated Snippet Commits

A paginated list of snippet commits.

GET/snippets/{workspace}/{encoded_id}/commits
1 2 3 4 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/commits' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 { "size": 142, "page": 102, "pagelen": 159, "next": "<string>", "previous": "<string>", "values": [ { "type": "<string>", "links": { "self": { "href": "<string>", "name": "<string>" }, "html": { "href": "<string>", "name": "<string>" }, "diff": { "href": "<string>", "name": "<string>" } }, "snippet": { "type": "<string>" } } ] }
GET

Get a previous snippet change

Returns the changes made on this snippet in this commit.

snippet

Request

Path parameters

encoded_id

string

Required
revision

string

Required
workspace

string

Required

Responses

The specified snippet commit.

application/json

allOf [allOf [object, Base Commit], Snippet Commit]

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 discriminator.

Base Commit

The common base type for both repository and snippet commits.

Snippet Commit
GET/snippets/{workspace}/{encoded_id}/commits/{revision}
1 2 3 4 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/commits/{revision}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 { "type": "<string>", "hash": "<string>", "date": "<string>", "author": { "type": "<string>" }, "message": "<string>", "summary": { "raw": "<string>", "markup": "markdown", "html": "<string>" }, "parents": [], "links": { "self": { "href": "<string>", "name": "<string>" }, "html": { "href": "<string>", "name": "<string>" }, "diff": { "href": "<string>", "name": "<string>" } }, "snippet": { "type": "<string>" } }
GET

Get a snippet's raw file at HEAD

Convenience resource for getting to a snippet's raw files without the need for first having to retrieve the snippet itself and having to pull out the versioned file links.

snippet

Request

Path parameters

encoded_id

string

Required
path

string

Required
workspace

string

Required

Responses

A redirect to the most recent revision of the specified file.

Headers

Location

string

GET/snippets/{workspace}/{encoded_id}/files/{path}
1 2 3 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/files/{path}' \ --header 'Authorization: Bearer <access_token>'
GET

Check if the current user is watching a snippet

Used to check if the current user is watching a specific snippet.

Returns 204 (No Content) if the user is watching the snippet and 404 if not.

Hitting this endpoint anonymously always returns a 404.

snippet

Request

Path parameters

encoded_id

string

Required
workspace

string

Required

Responses

If the authenticated user is watching the snippet.

GET/snippets/{workspace}/{encoded_id}/watch
1 2 3 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/watch' \ --header 'Authorization: Bearer <access_token>'
PUT

Watch a snippet

Used to start watching a specific snippet. Returns 204 (No Content).

snippet:write

Request

Path parameters

encoded_id

string

Required
workspace

string

Required

Responses

Indicates the authenticated user is now watching the snippet.

PUT/snippets/{workspace}/{encoded_id}/watch
1 2 3 curl --request PUT \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/watch' \ --header 'Authorization: Bearer <access_token>'
DEL

Stop watching a snippet

Used to stop watching a specific snippet. Returns 204 (No Content) to indicate success.

snippet:write

Request

Path parameters

encoded_id

string

Required
workspace

string

Required

Responses

Indicates the user stopped watching the snippet successfully.

DEL/snippets/{workspace}/{encoded_id}/watch
1 2 3 curl --request DELETE \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/watch' \ --header 'Authorization: Bearer <access_token>'
GET

List users watching a snippetDeprecated

Returns a paginated list of all users watching a specific snippet.

snippet

Request

Path parameters

encoded_id

string

Required
workspace

string

Required

Responses

The paginated list of users watching this snippet

application/json

Paginated Accounts

A paginated list of accounts.

GET/snippets/{workspace}/{encoded_id}/watchers
1 2 3 4 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/watchers' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "size": 142, "page": 102, "pagelen": 159, "next": "<string>", "previous": "<string>", "values": [ { "type": "<string>", "links": {}, "created_on": "<string>", "display_name": "<string>", "username": "<string>", "uuid": "<string>" } ] }
GET

Get a previous revision of a snippet

Identical to GET /snippets/encoded_id, except that this endpoint can be used to retrieve the contents of the snippet as it was at an older revision, while /snippets/encoded_id always returns the snippet's current revision.

Note that only the snippet's file contents are versioned, not its meta data properties like the title.

Other than that, the two endpoints are identical in behavior.

snippet

Request

Path parameters

encoded_id

string

Required
node_id

string

Required
workspace

string

Required

Responses

The snippet object.

application/json multipart/related multipart/form-data

allOf [object, Snippet]

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 discriminator.

Snippet

A snippet object.

GET/snippets/{workspace}/{encoded_id}/{node_id}
1 2 3 4 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/{node_id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "type": "<string>", "id": 2154, "title": "<string>", "scm": "git", "created_on": "<string>", "updated_on": "<string>", "owner": { "type": "<string>" }, "creator": { "type": "<string>" }, "is_private": true }
PUT

Update a previous revision of a snippet

Identical to UPDATE /snippets/encoded_id, except that this endpoint takes an explicit commit revision. Only the snippet's "HEAD"/"tip" (most recent) version can be updated and requests on all other, older revisions fail by returning a 405 status.

Usage of this endpoint over the unrestricted /snippets/encoded_id could be desired if the caller wants to be sure no concurrent modifications have taken place between the moment of the UPDATE request and the original GET.

This can be considered a so-called "Compare And Swap", or CAS operation.

Other than that, the two endpoints are identical in behavior.

snippet:write

Request

Path parameters

encoded_id

string

Required
node_id

string

Required
workspace

string

Required

Responses

The updated snippet object.

application/json multipart/related multipart/form-data

allOf [object, Snippet]

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 discriminator.

Snippet

A snippet object.

PUT/snippets/{workspace}/{encoded_id}/{node_id}
1 2 3 4 curl --request PUT \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/{node_id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "type": "<string>", "id": 2154, "title": "<string>", "scm": "git", "created_on": "<string>", "updated_on": "<string>", "owner": { "type": "<string>" }, "creator": { "type": "<string>" }, "is_private": true }
DEL

Delete a previous revision of a snippet

Deletes the snippet.

Note that this only works for versioned URLs that point to the latest commit of the snippet. Pointing to an older commit results in a 405 status code.

To delete a snippet, regardless of whether or not concurrent changes are being made to it, use DELETE /snippets/{encoded_id} instead.

snippet:write

Request

Path parameters

encoded_id

string

Required
node_id

string

Required
workspace

string

Required

Responses

If the snippet was deleted successfully.

DEL/snippets/{workspace}/{encoded_id}/{node_id}
1 2 3 curl --request DELETE \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/{node_id}' \ --header 'Authorization: Bearer <access_token>'
GET

Get a snippet's raw file

Retrieves the raw contents of a specific file in the snippet. The Content-Disposition header will be "attachment" to avoid issues with malevolent executable files.

The file's mime type is derived from its filename and returned in the Content-Type header.

Note that for text files, no character encoding is included as part of the content type.

snippet

Request

Path parameters

encoded_id

string

Required
node_id

string

Required
path

string

Required
workspace

string

Required

Responses

Returns the contents of the specified file.

Headers

Content-Type

string

Content-Disposition

string

GET/snippets/{workspace}/{encoded_id}/{node_id}/files/{path}
1 2 3 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/{node_id}/files/{path}' \ --header 'Authorization: Bearer <access_token>'
GET

Get snippet changes between versions

Returns the diff of the specified commit against its first parent.

Note that this resource is different in functionality from the patch resource.

The differences between a diff and a patch are:

  • patches have a commit header with the username, message, etc
  • diffs support the optional path=foo/bar.py query param to filter the diff to just that one file diff (not supported for patches)
  • for a merge, the diff will show the diff between the merge commit and its first parent (identical to how PRs work), while patch returns a response containing separate patches for each commit on the second parent's ancestry, up to the oldest common ancestor (identical to its reachability).

Note that the character encoding of the contents of the diff is unspecified as Git does not track this, making it hard for Bitbucket to reliably determine this.

snippet

Request

Path parameters

encoded_id

string

Required
revision

string

Required
workspace

string

Required

Query parameters

path

string

Responses

The raw diff contents.

GET/snippets/{workspace}/{encoded_id}/{revision}/diff
1 2 3 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/{revision}/diff' \ --header 'Authorization: Bearer <access_token>'
GET

Get snippet patch between versions

Returns the patch of the specified commit against its first parent.

Note that this resource is different in functionality from the diff resource.

The differences between a diff and a patch are:

  • patches have a commit header with the username, message, etc
  • diffs support the optional path=foo/bar.py query param to filter the diff to just that one file diff (not supported for patches)
  • for a merge, the diff will show the diff between the merge commit and its first parent (identical to how PRs work), while patch returns a response containing separate patches for each commit on the second parent's ancestry, up to the oldest common ancestor (identical to its reachability).

Note that the character encoding of the contents of the patch is unspecified as Git does not track this, making it hard for Bitbucket to reliably determine this.

snippet

Request

Path parameters

encoded_id

string

Required
revision

string

Required
workspace

string

Required

Responses

The raw patch contents.

GET/snippets/{workspace}/{encoded_id}/{revision}/patch
1 2 3 curl --request GET \ --url 'https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/{revision}/patch' \ --header 'Authorization: Bearer <access_token>'

Rate this page: