{ "info": { "_postman_id": "7ce230cc-aebb-4f6f-a0fd-604ab1f671c5", "name": "Bitbucket Addon Source API", "description": "Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.\n\nContact Support:\n Name: Bitbucket Support\n Email: support@bitbucket.org", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:14:45.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "lastUpdatedBy": "35240", "uid": "35240-7ce230cc-aebb-4f6f-a0fd-604ab1f671c5" }, "item": [ { "name": "repositories", "item": [ { "name": "{workspace}", "item": [ { "name": "{repo_slug}", "item": [ { "name": "filehistory", "item": [ { "name": "{commit}", "item": [ { "name": "{path}", "item": [ { "name": "List commits that modified a file", "id": "31a23dd4-2628-4592-a944-c0487cbacb09", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "repository repository:write repository:admin repository:delete project project:admin email account account:write team team:write pipeline pipeline:write pipeline:variable runner runner:write test test:write pullrequest pullrequest:write webhook issue issue:write snippet snippet:write wiki", "type": "string" }, { "key": "accessTokenUrl", "value": "https://bitbucket.org/site/oauth2/access_token", "type": "string" }, { "key": "authUrl", "value": "https://bitbucket.org/site/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/filehistory/:commit/:path?renames=&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "filehistory", ":commit", ":path" ], "query": [ { "description": "\nWhen `true`, Bitbucket will follow the history of the file across\nrenames (this is the default behavior). This can be turned off by\nspecifying `false`.", "key": "renames", "value": "" }, { "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).", "key": "q", "value": "" }, { "description": "\nName of a response property sort the result by as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).\n", "key": "sort", "value": "" } ], "variable": [ { "id": "c5891cec-b656-4a44-9b6c-7fcb94b4db75", "key": "workspace", "value": "", "description": "(Required) This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "id": "40a8d6fb-a6de-42c7-af40-115a1e950f0e", "key": "repo_slug", "value": "", "description": "(Required) This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "id": "55451382-d276-42dc-a06a-eca564399dd0", "key": "commit", "value": "", "description": "(Required) The commit's SHA1." }, { "id": "061986dc-be7f-4a44-a9db-9185a9781f26", "key": "path", "value": "", "description": "(Required) Path to the file." } ] }, "description": "Returns a paginated list of commits that modified the specified file.\n\nCommits are returned in reverse chronological order. This is roughly\nequivalent to the following commands:\n\n $ git log --follow --date-order \n\nBy default, Bitbucket will follow renames and the path name in the\nreturned entries reflects that. This can be turned off using the\n`?renames=false` query parameter.\n\nResults are returned in descending chronological order by default, and\nlike most endpoints you can\n[filter and sort](/cloud/bitbucket/rest/intro/#filtering) the response to\nonly provide exactly the data you want.\n\nThe example response returns commits made before 2011-05-18 against a file\nnamed `README.rst`. The results are filtered to only return the path and\ndate. This request can be made using:\n\n```\n$ curl 'https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/filehistory/master/README.rst'\\\n '?fields=values.next,values.path,values.commit.date&q=commit.date<=2011-05-18'\n```\n\nIn the response you can see that the file was renamed to `README.rst`\nby the commit made on 2011-05-16, and was previously named `README.txt`." }, "response": [ { "id": "ab3abd5e-3769-4b67-ba60-677229073cd8", "name": "A paginated list of commits that modified the specified file", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/filehistory/:commit/:path?renames=&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "filehistory", ":commit", ":path" ], "query": [ { "description": "\nWhen `true`, Bitbucket will follow the history of the file across\nrenames (this is the default behavior). This can be turned off by\nspecifying `false`.", "key": "renames", "value": "" }, { "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).", "key": "q", "value": "" }, { "description": "\nName of a response property sort the result by as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).\n", "key": "sort", "value": "" } ], "variable": [ { "key": "workspace" }, { "key": "repo_slug" }, { "key": "commit" }, { "key": "path" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"size\": \"\",\n \"page\": \"\",\n \"pagelen\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"values\": [\n {\n \"type\": \"\",\n \"path\": \"\",\n \"commit\": {\n \"type\": \"\",\n \"hash\": \"\",\n \"date\": \"\",\n \"author\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"exercitation_b\": 97297833.90821147\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"committer\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"message\": \"\",\n \"summary\": {\n \"raw\": \"\",\n \"markup\": \"markdown\",\n \"html\": \"\"\n },\n \"parents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"repository\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"pullrequests\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"forks\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"watchers\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"downloads\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"clone\": [\n {\n \"href\": \"\",\n \"name\": \"\"\n },\n {\n \"href\": \"\",\n \"name\": \"\"\n }\n ],\n \"hooks\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"full_name\": \"\",\n \"is_private\": \"\",\n \"parent\": {\n \"value\": \"\"\n },\n \"scm\": \"git\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"size\": \"\",\n \"language\": \"\",\n \"has_issues\": \"\",\n \"has_wiki\": \"\",\n \"fork_policy\": \"no_forks\",\n \"project\": {\n \"type\": \"\",\n \"links\": {\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"key\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"members\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"projects\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"repositories\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"is_private\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"has_publicly_visible_repos\": \"\"\n },\n \"mainbranch\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"name\": \"\",\n \"target\": {\n \"value\": \"\"\n },\n \"merge_strategies\": [\n \"rebase_merge\",\n \"merge_commit\"\n ],\n \"default_merge_strategy\": \"\"\n }\n },\n \"participants\": [\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"anim_7\": -65289244.68924671\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"undefined\",\n \"participated_on\": \"\"\n },\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"REVIEWER\",\n \"approved\": \"\",\n \"state\": \"undefined\",\n \"participated_on\": \"\"\n }\n ]\n },\n \"attributes\": \"binary\",\n \"escaped_path\": \"\"\n },\n {\n \"type\": \"\",\n \"path\": \"\",\n \"commit\": {\n \"type\": \"\",\n \"hash\": \"\",\n \"date\": \"\",\n \"author\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"sed_2\": 78738912.28888747\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"committer\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"nostrud_b\": 18202376.74136229,\n \"Ut0\": -40788565,\n \"ex_494\": 21931719\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"message\": \"\",\n \"summary\": {\n \"raw\": \"\",\n \"markup\": \"plaintext\",\n \"html\": \"\"\n },\n \"parents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"repository\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"pullrequests\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"forks\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"watchers\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"downloads\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"clone\": [\n {\n \"href\": \"\",\n \"name\": \"\"\n },\n {\n \"href\": \"\",\n \"name\": \"\"\n }\n ],\n \"hooks\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"full_name\": \"\",\n \"is_private\": \"\",\n \"parent\": {\n \"value\": \"\"\n },\n \"scm\": \"git\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"size\": \"\",\n \"language\": \"\",\n \"has_issues\": \"\",\n \"has_wiki\": \"\",\n \"fork_policy\": \"allow_forks\",\n \"project\": {\n \"type\": \"\",\n \"links\": {\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"key\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"members\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"projects\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"repositories\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"laborum807\": \"officia\"\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"is_private\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"has_publicly_visible_repos\": \"\"\n },\n \"mainbranch\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"name\": \"\",\n \"target\": {\n \"value\": \"\"\n },\n \"merge_strategies\": [\n \"fast_forward\",\n \"rebase_fast_forward\"\n ],\n \"default_merge_strategy\": \"\"\n }\n },\n \"participants\": [\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"id_7\": \"Lorem\"\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"changes_requested\",\n \"participated_on\": \"\"\n },\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"consecteturbe\": 43473169.75531292\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"undefined\",\n \"participated_on\": \"\"\n }\n ]\n },\n \"attributes\": \"subrepository\",\n \"escaped_path\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-ab3abd5e-3769-4b67-ba60-677229073cd8" }, { "id": "30b12c80-1055-415a-8cc5-25438ad96473", "name": "If the repository does not exist.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/filehistory/:commit/:path?renames=&q=&sort=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "filehistory", ":commit", ":path" ], "query": [ { "description": "\nWhen `true`, Bitbucket will follow the history of the file across\nrenames (this is the default behavior). This can be turned off by\nspecifying `false`.", "key": "renames", "value": "" }, { "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).", "key": "q", "value": "" }, { "description": "\nName of a response property sort the result by as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).\n", "key": "sort", "value": "" } ], "variable": [ { "key": "workspace" }, { "key": "repo_slug" }, { "key": "commit" }, { "key": "path" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"error\": {\n \"message\": \"\",\n \"detail\": \"\",\n \"data\": {\n \"irure_4b\": 28307284\n }\n }\n}", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-30b12c80-1055-415a-8cc5-25438ad96473" } ], "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-31a23dd4-2628-4592-a944-c0487cbacb09" } ], "id": "5c7395da-eab2-4a74-a503-a8419f22a8e2", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-5c7395da-eab2-4a74-a503-a8419f22a8e2" } ], "id": "97f8cc25-6a1c-493e-a4f5-95e2086fe640", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-97f8cc25-6a1c-493e-a4f5-95e2086fe640" } ], "id": "41e26882-5fb9-46f5-9f54-a5926ed3c824", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-41e26882-5fb9-46f5-9f54-a5926ed3c824" }, { "name": "src", "item": [ { "name": "{commit}", "item": [ { "name": "{path}", "item": [ { "name": "Get file or directory contents", "id": "c258ae72-750c-4f7d-8d68-d343bca481bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "repository repository:write repository:admin repository:delete project project:admin email account account:write team team:write pipeline pipeline:write pipeline:variable runner runner:write test test:write pullrequest pullrequest:write webhook issue issue:write snippet snippet:write wiki", "type": "string" }, { "key": "accessTokenUrl", "value": "https://bitbucket.org/site/oauth2/access_token", "type": "string" }, { "key": "authUrl", "value": "https://bitbucket.org/site/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src/:commit/:path?format=meta&q=&sort=&max_depth=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src", ":commit", ":path" ], "query": [ { "description": "If 'meta' is provided, returns the (json) meta data for the contents of the file. If 'rendered' is provided, returns the contents of a non-binary file in HTML-formatted rendered markup. The 'rendered' option only supports these filetypes: `.md`, `.markdown`, `.mkd`, `.mkdn`, `.mdown`, `.text`, `.rst`, and `.textile`. Since Git does not generally track what text encoding scheme is used, this endpoint attempts to detect the most appropriate character encoding. While usually correct, determining the character encoding can be ambiguous which in exceptional cases can lead to misinterpretation of the characters. As such, the raw element in the response object should not be treated as equivalent to the file's actual contents.", "key": "format", "value": "meta" }, { "description": "Optional filter expression as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).", "key": "q", "value": "" }, { "description": "Optional sorting parameter as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).", "key": "sort", "value": "" }, { "description": "If provided, returns the contents of the repository and its subdirectories recursively until the specified max_depth of nested directories. When omitted, this defaults to 1.", "key": "max_depth", "value": "" } ], "variable": [ { "id": "7c3c735d-9bef-44b5-a618-1d876ffc186e", "key": "workspace", "value": "", "description": "(Required) This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "id": "f4082093-13fe-4961-ad63-71b8976fafb9", "key": "repo_slug", "value": "", "description": "(Required) This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "id": "e54cee96-de5b-4561-9fcf-7a7f70710ffa", "key": "commit", "value": "", "description": "(Required) The commit's SHA1." }, { "id": "dc5093b0-4f77-4f87-9088-3a8d67871ade", "key": "path", "value": "", "description": "(Required) Path to the file." } ] }, "description": "This endpoints is used to retrieve the contents of a single file,\nor the contents of a directory at a specified revision.\n\n#### Raw file contents\n\nWhen `path` points to a file, this endpoint returns the raw contents.\nThe response's Content-Type is derived from the filename\nextension (not from the contents). The file contents are not processed\nand no character encoding/recoding is performed and as a result no\ncharacter encoding is included as part of the Content-Type.\n\nThe `Content-Disposition` header will be \"attachment\" to prevent\nbrowsers from running executable files.\n\nIf the file is managed by LFS, then a 301 redirect pointing to\nAtlassian's media services platform is returned.\n\nThe response includes an ETag that is based on the contents of the file\nand its attributes. This means that an empty `__init__.py` always\nreturns the same ETag, regardless on the directory it lives in, or the\ncommit it is on.\n\n#### File meta data\n\nWhen the request for a file path includes the query parameter\n`?format=meta`, instead of returning the file's raw contents, Bitbucket\ninstead returns the JSON object describing the file's properties:\n\n```javascript\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef/tests/__init__.py?format=meta\n{\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py\"\n },\n \"meta\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py?format=meta\"\n }\n },\n \"path\": \"tests/__init__.py\",\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"eefd5ef5d3df01aed629f650959d6706d54cd335\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n }\n }\n },\n \"attributes\": [],\n \"type\": \"commit_file\",\n \"size\": 0\n}\n```\n\nFile objects contain an `attributes` element that contains a list of\npossible modifiers. Currently defined values are:\n\n* `link` -- indicates that the entry is a symbolic link. The contents\n of the file represent the path the link points to.\n* `executable` -- indicates that the file has the executable bit set.\n* `subrepository` -- indicates that the entry points to a submodule or\n subrepo. The contents of the file is the SHA1 of the repository\n pointed to.\n* `binary` -- indicates whether Bitbucket thinks the file is binary.\n\nThis endpoint can provide an alternative to how a HEAD request can be\nused to check for the existence of a file, or a file's size without\nincurring the overhead of receiving its full contents.\n\n\n#### Directory listings\n\nWhen `path` points to a directory instead of a file, the response is a\npaginated list of directory and file objects in the same order as the\nunderlying SCM system would return them.\n\nFor example:\n\n```javascript\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef/tests\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"path\": \"tests/test_project\",\n \"type\": \"commit_directory\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/\"\n },\n \"meta\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/?format=meta\"\n }\n },\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"eefd5ef5d3df01aed629f650959d6706d54cd335\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n }\n }\n }\n },\n {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py\"\n },\n \"meta\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/__init__.py?format=meta\"\n }\n },\n \"path\": \"tests/__init__.py\",\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"eefd5ef5d3df01aed629f650959d6706d54cd335\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/commit/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/bbql/commits/eefd5ef5d3df01aed629f650959d6706d54cd335\"\n }\n }\n },\n \"attributes\": [],\n \"type\": \"commit_file\",\n \"size\": 0\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```\n\nWhen listing the contents of the repo's root directory, the use of a\ntrailing slash at the end of the URL is required.\n\nThe response by default is not recursive, meaning that only the direct contents of\na path are returned. The response does not recurse down into\nsubdirectories. In order to \"walk\" the entire directory tree, the\nclient can either parse each response and follow the `self` links of each\n`commit_directory` object, or can specify a `max_depth` to recurse to.\n\nThe max_depth parameter will do a breadth-first search to return the contents of the subdirectories\nup to the depth specified. Breadth-first search was chosen as it leads to the least amount of\nfile system operations for git. If the `max_depth` parameter is specified to be too\nlarge, the call will time out and return a 555.\n\nEach returned object is either a `commit_file`, or a `commit_directory`,\nboth of which contain a `path` element. This path is the absolute path\nfrom the root of the repository. Each object also contains a `commit`\nobject which embeds the commit the file is on. Note that this is merely\nthe commit that was used in the URL. It is *not* the commit that last\nmodified the file.\n\nDirectory objects have 2 representations. Their `self` link returns the\npaginated contents of the directory. The `meta` link on the other hand\nreturns the actual `directory` object itself, e.g.:\n\n```javascript\n{\n \"path\": \"tests/test_project\",\n \"type\": \"commit_directory\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/\"\n },\n \"meta\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src/eefd5ef5d3df01aed629f650959d6706d54cd335/tests/test_project/?format=meta\"\n }\n },\n \"commit\": { ... }\n}\n```\n\n#### Querying, filtering and sorting\n\nLike most API endpoints, this API supports the Bitbucket\nquerying/filtering syntax and so you could filter a directory listing\nto only include entries that match certain criteria. For instance, to\nlist all binary files over 1kb use the expression:\n\n`size > 1024 and attributes = \"binary\"`\n\nwhich after urlencoding yields the query string:\n\n`?q=size%3E1024+and+attributes%3D%22binary%22`\n\nTo change the ordering of the response, use the `?sort` parameter:\n\n`.../src/eefd5ef/?sort=-size`\n\nSee [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more\ndetails." }, "response": [ { "id": "3b005945-8c20-48f1-8148-3b653454e3be", "name": "If the path matches a file, then the raw contents of the file are\nreturned. If the `format=meta` query parameter is provided,\na json document containing the file's meta data is\nreturned. If the `format=rendered` query parameter is provided,\nthe contents", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src/:commit/:path?format=meta&q=&sort=&max_depth=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src", ":commit", ":path" ], "query": [ { "description": "If 'meta' is provided, returns the (json) meta data for the contents of the file. If 'rendered' is provided, returns the contents of a non-binary file in HTML-formatted rendered markup. The 'rendered' option only supports these filetypes: `.md`, `.markdown`, `.mkd`, `.mkdn`, `.mdown`, `.text`, `.rst`, and `.textile`. Since Git does not generally track what text encoding scheme is used, this endpoint attempts to detect the most appropriate character encoding. While usually correct, determining the character encoding can be ambiguous which in exceptional cases can lead to misinterpretation of the characters. As such, the raw element in the response object should not be treated as equivalent to the file's actual contents.", "key": "format", "value": "meta" }, { "description": "Optional filter expression as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).", "key": "q", "value": "" }, { "description": "Optional sorting parameter as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).", "key": "sort", "value": "" }, { "description": "If provided, returns the contents of the repository and its subdirectories recursively until the specified max_depth of nested directories. When omitted, this defaults to 1.", "key": "max_depth", "value": "" } ], "variable": [ { "key": "workspace" }, { "key": "repo_slug" }, { "key": "commit" }, { "key": "path" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"size\": \"\",\n \"page\": \"\",\n \"pagelen\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"values\": [\n {\n \"type\": \"\",\n \"path\": \"\",\n \"commit\": {\n \"type\": \"\",\n \"hash\": \"1f64e1a\",\n \"date\": \"\",\n \"author\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"nulla_27\": 32606588.35747376,\n \"ipsum_d1\": 72277788\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"committer\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"doloreb\": false\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"message\": \"\",\n \"summary\": {\n \"raw\": \"\",\n \"markup\": \"markdown\",\n \"html\": \"\"\n },\n \"parents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"repository\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"pullrequests\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"forks\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"watchers\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"downloads\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"clone\": [\n {\n \"href\": \"\",\n \"name\": \"\"\n },\n {\n \"href\": \"\",\n \"name\": \"\"\n }\n ],\n \"hooks\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"full_name\": \"\",\n \"is_private\": \"\",\n \"parent\": {\n \"value\": \"\"\n },\n \"scm\": \"git\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"size\": \"\",\n \"language\": \"\",\n \"has_issues\": \"\",\n \"has_wiki\": \"\",\n \"fork_policy\": \"allow_forks\",\n \"project\": {\n \"type\": \"\",\n \"links\": {\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"key\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"members\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"projects\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"repositories\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"Lorem_062\": 83741336.70962429,\n \"in_d\": -11872974\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"is_private\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"has_publicly_visible_repos\": \"\"\n },\n \"mainbranch\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"name\": \"\",\n \"target\": {\n \"value\": \"\"\n },\n \"merge_strategies\": [\n \"squash\",\n \"rebase_fast_forward\"\n ],\n \"default_merge_strategy\": \"\"\n }\n },\n \"participants\": [\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"Lorem222\": 75238944,\n \"ullamco_87\": true,\n \"nisi0fb\": \"sed\"\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"changes_requested\",\n \"participated_on\": \"\"\n },\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"ex_9b0\": -44660405.020535655\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"approved\",\n \"participated_on\": \"\"\n }\n ]\n }\n },\n {\n \"type\": \"\",\n \"path\": \"\",\n \"commit\": {\n \"type\": \"\",\n \"hash\": \"d6c627d0b3\",\n \"date\": \"\",\n \"author\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"aliqua3\": true,\n \"occaecat_\": true\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"committer\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"message\": \"\",\n \"summary\": {\n \"raw\": \"\",\n \"markup\": \"creole\",\n \"html\": \"\"\n },\n \"parents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"repository\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"pullrequests\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"forks\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"watchers\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"downloads\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"clone\": [\n {\n \"href\": \"\",\n \"name\": \"\"\n },\n {\n \"href\": \"\",\n \"name\": \"\"\n }\n ],\n \"hooks\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"full_name\": \"\",\n \"is_private\": \"\",\n \"parent\": {\n \"value\": \"\"\n },\n \"scm\": \"git\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"pariaturf\": -74117703.82544525,\n \"dolor_d7\": \"commodo aliquip Lorem dolor\"\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"size\": \"\",\n \"language\": \"\",\n \"has_issues\": \"\",\n \"has_wiki\": \"\",\n \"fork_policy\": \"no_forks\",\n \"project\": {\n \"type\": \"\",\n \"links\": {\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"key\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"members\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"projects\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"repositories\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"is_private\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"has_publicly_visible_repos\": \"\"\n },\n \"mainbranch\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"name\": \"\",\n \"target\": {\n \"value\": \"\"\n },\n \"merge_strategies\": [\n \"squash\",\n \"squash\"\n ],\n \"default_merge_strategy\": \"\"\n }\n },\n \"participants\": [\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"exercitationdb\": -98684929\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"approved\",\n \"participated_on\": \"\"\n },\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"dolored_\": -42382830\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"changes_requested\",\n \"participated_on\": \"\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-3b005945-8c20-48f1-8148-3b653454e3be" }, { "id": "bd392aba-5889-4d2a-b289-6b95cc517eaf", "name": "If the path or commit in the URL does not exist.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src/:commit/:path?format=meta&q=&sort=&max_depth=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src", ":commit", ":path" ], "query": [ { "description": "If 'meta' is provided, returns the (json) meta data for the contents of the file. If 'rendered' is provided, returns the contents of a non-binary file in HTML-formatted rendered markup. The 'rendered' option only supports these filetypes: `.md`, `.markdown`, `.mkd`, `.mkdn`, `.mdown`, `.text`, `.rst`, and `.textile`. Since Git does not generally track what text encoding scheme is used, this endpoint attempts to detect the most appropriate character encoding. While usually correct, determining the character encoding can be ambiguous which in exceptional cases can lead to misinterpretation of the characters. As such, the raw element in the response object should not be treated as equivalent to the file's actual contents.", "key": "format", "value": "meta" }, { "description": "Optional filter expression as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).", "key": "q", "value": "" }, { "description": "Optional sorting parameter as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).", "key": "sort", "value": "" }, { "description": "If provided, returns the contents of the repository and its subdirectories recursively until the specified max_depth of nested directories. When omitted, this defaults to 1.", "key": "max_depth", "value": "" } ], "variable": [ { "key": "workspace" }, { "key": "repo_slug" }, { "key": "commit" }, { "key": "path" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"error\": {\n \"message\": \"\",\n \"detail\": \"\",\n \"data\": {\n \"irure_4b\": 28307284\n }\n }\n}", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-bd392aba-5889-4d2a-b289-6b95cc517eaf" }, { "id": "0cfd2388-0945-4dc4-957e-071114402735", "name": "If the call times out, possibly because the specified recursion depth is too large.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src/:commit/:path?format=meta&q=&sort=&max_depth=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src", ":commit", ":path" ], "query": [ { "description": "If 'meta' is provided, returns the (json) meta data for the contents of the file. If 'rendered' is provided, returns the contents of a non-binary file in HTML-formatted rendered markup. The 'rendered' option only supports these filetypes: `.md`, `.markdown`, `.mkd`, `.mkdn`, `.mdown`, `.text`, `.rst`, and `.textile`. Since Git does not generally track what text encoding scheme is used, this endpoint attempts to detect the most appropriate character encoding. While usually correct, determining the character encoding can be ambiguous which in exceptional cases can lead to misinterpretation of the characters. As such, the raw element in the response object should not be treated as equivalent to the file's actual contents.", "key": "format", "value": "meta" }, { "description": "Optional filter expression as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).", "key": "q", "value": "" }, { "description": "Optional sorting parameter as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).", "key": "sort", "value": "" }, { "description": "If provided, returns the contents of the repository and its subdirectories recursively until the specified max_depth of nested directories. When omitted, this defaults to 1.", "key": "max_depth", "value": "" } ], "variable": [ { "key": "workspace" }, { "key": "repo_slug" }, { "key": "commit" }, { "key": "path" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"error\": {\n \"message\": \"\",\n \"detail\": \"\",\n \"data\": {\n \"irure_4b\": 28307284\n }\n }\n}", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-0cfd2388-0945-4dc4-957e-071114402735" } ], "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-c258ae72-750c-4f7d-8d68-d343bca481bf" } ], "id": "68e0a85d-0f50-4fdf-8058-137ddbc53bd2", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-68e0a85d-0f50-4fdf-8058-137ddbc53bd2" } ], "id": "a18556b2-0268-4a2d-acdb-1393b05c8a4f", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-a18556b2-0268-4a2d-acdb-1393b05c8a4f" }, { "name": "Get the root directory of the main branch", "id": "b71b39ef-9c57-491e-8bd3-b21e5ea452d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "repository repository:write repository:admin repository:delete project project:admin email account account:write team team:write pipeline pipeline:write pipeline:variable runner runner:write test test:write pullrequest pullrequest:write webhook issue issue:write snippet snippet:write wiki", "type": "string" }, { "key": "accessTokenUrl", "value": "https://bitbucket.org/site/oauth2/access_token", "type": "string" }, { "key": "authUrl", "value": "https://bitbucket.org/site/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src?format=meta", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src" ], "query": [ { "description": "Instead of returning the file's contents, return the (json) meta data for it.", "key": "format", "value": "meta" } ], "variable": [ { "id": "c27af628-a806-432a-aa22-d8295b9c780a", "key": "workspace", "value": "", "description": "(Required) This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "id": "650b2384-0cc9-42ba-beaa-9209576cab6b", "key": "repo_slug", "value": "", "description": "(Required) This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" } ] }, "description": "This endpoint redirects the client to the directory listing of the\nroot directory on the main branch.\n\nThis is equivalent to directly hitting\n[/2.0/repositories/{username}/{repo_slug}/src/{commit}/{path}](src/%7Bcommit%7D/%7Bpath%7D)\nwithout having to know the name or SHA1 of the repo's main branch.\n\nTo create new commits, [POST to this endpoint](#post)" }, "response": [ { "id": "91d1a367-586f-4d12-8471-4e5d78d378bd", "name": "If the path matches a file, then the raw contents of the file are\nreturned (unless the `format=meta` query parameter was provided,\nin which case a json document containing the file's meta data is\nreturned). If the path matches a directory, then a paginate", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src?format=meta", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src" ], "query": [ { "description": "Instead of returning the file's contents, return the (json) meta data for it.", "key": "format", "value": "meta" } ], "variable": [ { "key": "workspace" }, { "key": "repo_slug" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"size\": \"\",\n \"page\": \"\",\n \"pagelen\": \"\",\n \"next\": \"\",\n \"previous\": \"\",\n \"values\": [\n {\n \"type\": \"\",\n \"path\": \"\",\n \"commit\": {\n \"type\": \"\",\n \"hash\": \"1f64e1a\",\n \"date\": \"\",\n \"author\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"nulla_27\": 32606588.35747376,\n \"ipsum_d1\": 72277788\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"committer\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"doloreb\": false\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"message\": \"\",\n \"summary\": {\n \"raw\": \"\",\n \"markup\": \"markdown\",\n \"html\": \"\"\n },\n \"parents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"repository\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"pullrequests\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"forks\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"watchers\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"downloads\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"clone\": [\n {\n \"href\": \"\",\n \"name\": \"\"\n },\n {\n \"href\": \"\",\n \"name\": \"\"\n }\n ],\n \"hooks\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"full_name\": \"\",\n \"is_private\": \"\",\n \"parent\": {\n \"value\": \"\"\n },\n \"scm\": \"git\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"size\": \"\",\n \"language\": \"\",\n \"has_issues\": \"\",\n \"has_wiki\": \"\",\n \"fork_policy\": \"allow_forks\",\n \"project\": {\n \"type\": \"\",\n \"links\": {\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"key\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"members\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"projects\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"repositories\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"Lorem_062\": 83741336.70962429,\n \"in_d\": -11872974\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"is_private\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"has_publicly_visible_repos\": \"\"\n },\n \"mainbranch\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"name\": \"\",\n \"target\": {\n \"value\": \"\"\n },\n \"merge_strategies\": [\n \"squash\",\n \"rebase_fast_forward\"\n ],\n \"default_merge_strategy\": \"\"\n }\n },\n \"participants\": [\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"Lorem222\": 75238944,\n \"ullamco_87\": true,\n \"nisi0fb\": \"sed\"\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"changes_requested\",\n \"participated_on\": \"\"\n },\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"ex_9b0\": -44660405.020535655\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"approved\",\n \"participated_on\": \"\"\n }\n ]\n }\n },\n {\n \"type\": \"\",\n \"path\": \"\",\n \"commit\": {\n \"type\": \"\",\n \"hash\": \"d6c627d0b3\",\n \"date\": \"\",\n \"author\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"aliqua3\": true,\n \"occaecat_\": true\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"committer\": {\n \"type\": \"\",\n \"raw\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n }\n },\n \"message\": \"\",\n \"summary\": {\n \"raw\": \"\",\n \"markup\": \"creole\",\n \"html\": \"\"\n },\n \"parents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"repository\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"pullrequests\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"forks\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"watchers\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"downloads\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"clone\": [\n {\n \"href\": \"\",\n \"name\": \"\"\n },\n {\n \"href\": \"\",\n \"name\": \"\"\n }\n ],\n \"hooks\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"full_name\": \"\",\n \"is_private\": \"\",\n \"parent\": {\n \"value\": \"\"\n },\n \"scm\": \"git\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"pariaturf\": -74117703.82544525,\n \"dolor_d7\": \"commodo aliquip Lorem dolor\"\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"size\": \"\",\n \"language\": \"\",\n \"has_issues\": \"\",\n \"has_wiki\": \"\",\n \"fork_policy\": \"no_forks\",\n \"project\": {\n \"type\": \"\",\n \"links\": {\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"uuid\": \"\",\n \"key\": \"\",\n \"owner\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"members\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"projects\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"repositories\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"is_private\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"has_publicly_visible_repos\": \"\"\n },\n \"mainbranch\": {\n \"type\": \"\",\n \"links\": {\n \"self\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"commits\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"html\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"name\": \"\",\n \"target\": {\n \"value\": \"\"\n },\n \"merge_strategies\": [\n \"squash\",\n \"squash\"\n ],\n \"default_merge_strategy\": \"\"\n }\n },\n \"participants\": [\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"exercitationdb\": -98684929\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"approved\",\n \"participated_on\": \"\"\n },\n {\n \"type\": \"\",\n \"user\": {\n \"type\": \"\",\n \"links\": {\n \"avatar\": {\n \"href\": \"\",\n \"name\": \"\"\n },\n \"dolored_\": -42382830\n },\n \"created_on\": \"\",\n \"display_name\": \"\",\n \"uuid\": \"\"\n },\n \"role\": \"PARTICIPANT\",\n \"approved\": \"\",\n \"state\": \"changes_requested\",\n \"participated_on\": \"\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-91d1a367-586f-4d12-8471-4e5d78d378bd" }, { "id": "d690f056-6418-486e-b117-4f2134af88ab", "name": "If the path or commit in the URL does not exist.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src?format=meta", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src" ], "query": [ { "description": "Instead of returning the file's contents, return the (json) meta data for it.", "key": "format", "value": "meta" } ], "variable": [ { "key": "workspace" }, { "key": "repo_slug" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"error\": {\n \"message\": \"\",\n \"detail\": \"\",\n \"data\": {\n \"irure_4b\": 28307284\n }\n }\n}", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-d690f056-6418-486e-b117-4f2134af88ab" } ], "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-b71b39ef-9c57-491e-8bd3-b21e5ea452d9" }, { "name": "Create a commit by uploading a file", "id": "4ef3a9f1-55eb-42bc-8deb-98843f2f3bd8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "repository repository:write repository:admin repository:delete project project:admin email account account:write team team:write pipeline pipeline:write pipeline:variable runner runner:write test test:write pullrequest pullrequest:write webhook issue issue:write snippet snippet:write wiki", "type": "string" }, { "key": "accessTokenUrl", "value": "https://bitbucket.org/site/oauth2/access_token", "type": "string" }, { "key": "authUrl", "value": "https://bitbucket.org/site/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src?message=&author=&parents=&files=&branch=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src" ], "query": [ { "description": "The commit message. When omitted, Bitbucket uses a canned string.", "key": "message", "value": "" }, { "description": "\nThe raw string to be used as the new commit's author.\nThis string follows the format\n`Erik van Zijst `.\n\nWhen omitted, Bitbucket uses the authenticated user's\nfull/display name and primary email address. Commits cannot\nbe created anonymously.", "key": "author", "value": "" }, { "description": "\n#### Deprecation Notice:\nSupport for specifying multiple parent\ncommits is deprecated and will be removed in a future release.\nOnly a single SHA1 is accepted.\n\nA SHA1 of the commit that should be the parent of the newly created\ncommit. When omitted, the new commit will inherit from and\nbecome a child of the main branch's tip/HEAD commit.", "key": "parents", "value": "" }, { "description": "\nOptional field that declares the files that the request is\nmanipulating. When adding a new file to a repo, or when\noverwriting an existing file, the client can just upload\nthe full contents of the file in a normal form field and\nthe use of this `files` meta data field is redundant.\nHowever, when the `files` field contains a file path that\ndoes not have a corresponding, identically-named form\nfield, then Bitbucket interprets that as the client wanting\nto replace the named file with the null set and the file is\ndeleted instead.\n\nPaths in the repo that are referenced in neither files nor\nan individual file field, remain unchanged and carry over\nfrom the parent to the new commit.\n\nThis API does not support renaming as an explicit feature.\nTo rename a file, simply delete it and recreate it under\nthe new name in the same commit.\n", "key": "files", "value": "" }, { "description": "\nThe name of the branch that the new commit should be\ncreated on. When omitted, the commit will be created on top\nof the main branch and will become the main branch's new\nhead.\n\nWhen a branch name is provided that already exists in the\nrepo, then the commit will be created on top of that\nbranch. In this case, *if* a parent SHA1 was also provided,\nthen it is asserted that the parent is the branch's\ntip/HEAD at the time the request is made. When this is not\nthe case, a 409 is returned.\n\nWhen a new branch name is specified (that does not already\nexist in the repo), and no parent SHA1s are provided, then\nthe new commit will inherit from the current main branch's\ntip/HEAD commit, but not advance the main branch. The new\ncommit will be the new branch. When the request *also*\nspecifies a parent SHA1, then the new commit and branch\nare created directly on top of the parent commit,\nregardless of the state of the main branch.\n\nWhen a branch name is not specified, but a parent SHA1 is\nprovided, then Bitbucket asserts that it represents the\nmain branch's current HEAD/tip, or a 409 is returned.\n\nWhen a branch name is not specified and the repo is empty,\nthe new commit will become the repo's root commit and will\nbe on the main branch.\n\nWhen a branch name is specified and the repo is empty, the\nnew commit will become the repo's root commit and also\ndefine the repo's main branch going forward.\n\nThis API cannot be used to create additional root commits\nin non-empty repos.\n\nThe branch field cannot be repeated.\n\nAs a side effect, this API can be used to create a new\nbranch without modifying any files, by specifying a new\nbranch name in this field, together with `parents`, but\nomitting the `files` fields, while not sending any files.\nThis will create a new commit and branch with the same\ncontents as the first parent. The diff of this commit\nagainst its first parent will be empty.\n", "key": "branch", "value": "" } ], "variable": [ { "id": "e393b074-2ff5-4f72-a48d-12d8bc9303db", "key": "workspace", "value": "", "description": "(Required) This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "id": "6ea366e2-c29f-48b5-b80c-10e157312ad1", "key": "repo_slug", "value": "", "description": "(Required) This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" } ] }, "description": "This endpoint is used to create new commits in the repository by\nuploading files.\n\nTo add a new file to a repository:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/username/slug/src \\\n -F /repo/path/to/image.png=@image.png\n```\n\nThis will create a new commit on top of the main branch, inheriting the\ncontents of the main branch, but adding (or overwriting) the\n`image.png` file to the repository in the `/repo/path/to` directory.\n\nTo create a commit that deletes files, use the `files` parameter:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/username/slug/src \\\n -F files=/file/to/delete/1.txt \\\n -F files=/file/to/delete/2.txt\n```\n\nYou can add/modify/delete multiple files in a request. Rename/move a\nfile by deleting the old path and adding the content at the new path.\n\nThis endpoint accepts `multipart/form-data` (as in the examples above),\nas well as `application/x-www-form-urlencoded`.\n\nNote: `multipart/form-data` is currently not supported by Forge apps\nfor this API.\n\n#### multipart/form-data\n\nA `multipart/form-data` post contains a series of \"form fields\" that\nidentify both the individual files that are being uploaded, as well as\nadditional, optional meta data.\n\nFiles are uploaded in file form fields (those that have a\n`Content-Disposition` parameter) whose field names point to the remote\npath in the repository where the file should be stored. Path field\nnames are always interpreted to be absolute from the root of the\nrepository, regardless whether the client uses a leading slash (as the\nabove `curl` example did).\n\nFile contents are treated as bytes and are not decoded as text.\n\nThe commit message, as well as other non-file meta data for the\nrequest, is sent along as normal form field elements. Meta data fields\nshare the same namespace as the file objects. For `multipart/form-data`\nbodies that should not lead to any ambiguity, as the\n`Content-Disposition` header will contain the `filename` parameter to\ndistinguish between a file named \"message\" and the commit message field.\n\n#### application/x-www-form-urlencoded\n\nIt is also possible to upload new files using a simple\n`application/x-www-form-urlencoded` POST. This can be convenient when\nuploading pure text files:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/bbql/src \\\n --data-urlencode \"/path/to/me.txt=Lorem ipsum.\" \\\n --data-urlencode \"message=Initial commit\" \\\n --data-urlencode \"author=Erik van Zijst \"\n```\n\nThere could be a field name clash if a client were to upload a file\nnamed \"message\", as this filename clashes with the meta data property\nfor the commit message. To avoid this and to upload files whose names\nclash with the meta data properties, use a leading slash for the files,\ne.g. `curl --data-urlencode \"/message=file contents\"`.\n\nWhen an explicit slash is omitted for a file whose path matches that of\na meta data parameter, then it is interpreted as meta data, not as a\nfile.\n\n#### Executables and links\n\nWhile this API aims to facilitate the most common use cases, it is\npossible to perform some more advanced operations like creating a new\nsymlink in the repository, or creating an executable file.\n\nFiles can be supplied with a `x-attributes` value in the\n`Content-Disposition` header. For example, to upload an executable\nfile, as well as create a symlink from `README.txt` to `README`:\n\n```\n--===============1438169132528273974==\nContent-Type: text/plain; charset=\"us-ascii\"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nContent-ID: \"bin/shutdown.sh\"\nContent-Disposition: attachment; filename=\"shutdown.sh\"; x-attributes:\"executable\"\n\n#!/bin/sh\nhalt\n\n--===============1438169132528273974==\nContent-Type: text/plain; charset=\"us-ascii\"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nContent-ID: \"/README.txt\"\nContent-Disposition: attachment; filename=\"README.txt\"; x-attributes:\"link\"\n\nREADME\n--===============1438169132528273974==--\n```\n\nLinks are files that contain the target path and have\n`x-attributes:\"link\"` set.\n\nWhen overwriting links with files, or vice versa, the newly uploaded\nfile determines both the new contents, as well as the attributes. That\nmeans uploading a file without specifying `x-attributes=\"link\"` will\ncreate a regular file, even if the parent commit hosted a symlink at\nthe same path.\n\nThe same applies to executables. When modifying an existing executable\nfile, the form-data file element must include\n`x-attributes=\"executable\"` in order to preserve the executable status\nof the file.\n\nNote that this API does not support the creation or manipulation of\nsubrepos / submodules." }, "response": [ { "id": "3e3b98f5-052f-4056-8946-6bcf34da5542", "name": "\n", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src?message=&author=&parents=&files=&branch=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src" ], "query": [ { "description": "The commit message. When omitted, Bitbucket uses a canned string.", "key": "message", "value": "" }, { "description": "\nThe raw string to be used as the new commit's author.\nThis string follows the format\n`Erik van Zijst `.\n\nWhen omitted, Bitbucket uses the authenticated user's\nfull/display name and primary email address. Commits cannot\nbe created anonymously.", "key": "author", "value": "" }, { "description": "\n#### Deprecation Notice:\nSupport for specifying multiple parent\ncommits is deprecated and will be removed in a future release.\nOnly a single SHA1 is accepted.\n\nA SHA1 of the commit that should be the parent of the newly created\ncommit. When omitted, the new commit will inherit from and\nbecome a child of the main branch's tip/HEAD commit.", "key": "parents", "value": "" }, { "description": "\nOptional field that declares the files that the request is\nmanipulating. When adding a new file to a repo, or when\noverwriting an existing file, the client can just upload\nthe full contents of the file in a normal form field and\nthe use of this `files` meta data field is redundant.\nHowever, when the `files` field contains a file path that\ndoes not have a corresponding, identically-named form\nfield, then Bitbucket interprets that as the client wanting\nto replace the named file with the null set and the file is\ndeleted instead.\n\nPaths in the repo that are referenced in neither files nor\nan individual file field, remain unchanged and carry over\nfrom the parent to the new commit.\n\nThis API does not support renaming as an explicit feature.\nTo rename a file, simply delete it and recreate it under\nthe new name in the same commit.\n", "key": "files", "value": "" }, { "description": "\nThe name of the branch that the new commit should be\ncreated on. When omitted, the commit will be created on top\nof the main branch and will become the main branch's new\nhead.\n\nWhen a branch name is provided that already exists in the\nrepo, then the commit will be created on top of that\nbranch. In this case, *if* a parent SHA1 was also provided,\nthen it is asserted that the parent is the branch's\ntip/HEAD at the time the request is made. When this is not\nthe case, a 409 is returned.\n\nWhen a new branch name is specified (that does not already\nexist in the repo), and no parent SHA1s are provided, then\nthe new commit will inherit from the current main branch's\ntip/HEAD commit, but not advance the main branch. The new\ncommit will be the new branch. When the request *also*\nspecifies a parent SHA1, then the new commit and branch\nare created directly on top of the parent commit,\nregardless of the state of the main branch.\n\nWhen a branch name is not specified, but a parent SHA1 is\nprovided, then Bitbucket asserts that it represents the\nmain branch's current HEAD/tip, or a 409 is returned.\n\nWhen a branch name is not specified and the repo is empty,\nthe new commit will become the repo's root commit and will\nbe on the main branch.\n\nWhen a branch name is specified and the repo is empty, the\nnew commit will become the repo's root commit and also\ndefine the repo's main branch going forward.\n\nThis API cannot be used to create additional root commits\nin non-empty repos.\n\nThe branch field cannot be repeated.\n\nAs a side effect, this API can be used to create a new\nbranch without modifying any files, by specifying a new\nbranch name in this field, together with `parents`, but\nomitting the `files` fields, while not sending any files.\nThis will create a new commit and branch with the same\ncontents as the first parent. The diff of this commit\nagainst its first parent will be empty.\n", "key": "branch", "value": "" } ], "variable": [ { "key": "workspace" }, { "key": "repo_slug" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-3e3b98f5-052f-4056-8946-6bcf34da5542" }, { "id": "4f3ac918-0177-4516-aaf0-a899f98f1a40", "name": "If the authenticated user does not have write or admin access", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src?message=&author=&parents=&files=&branch=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src" ], "query": [ { "description": "The commit message. When omitted, Bitbucket uses a canned string.", "key": "message", "value": "" }, { "description": "\nThe raw string to be used as the new commit's author.\nThis string follows the format\n`Erik van Zijst `.\n\nWhen omitted, Bitbucket uses the authenticated user's\nfull/display name and primary email address. Commits cannot\nbe created anonymously.", "key": "author", "value": "" }, { "description": "\n#### Deprecation Notice:\nSupport for specifying multiple parent\ncommits is deprecated and will be removed in a future release.\nOnly a single SHA1 is accepted.\n\nA SHA1 of the commit that should be the parent of the newly created\ncommit. When omitted, the new commit will inherit from and\nbecome a child of the main branch's tip/HEAD commit.", "key": "parents", "value": "" }, { "description": "\nOptional field that declares the files that the request is\nmanipulating. When adding a new file to a repo, or when\noverwriting an existing file, the client can just upload\nthe full contents of the file in a normal form field and\nthe use of this `files` meta data field is redundant.\nHowever, when the `files` field contains a file path that\ndoes not have a corresponding, identically-named form\nfield, then Bitbucket interprets that as the client wanting\nto replace the named file with the null set and the file is\ndeleted instead.\n\nPaths in the repo that are referenced in neither files nor\nan individual file field, remain unchanged and carry over\nfrom the parent to the new commit.\n\nThis API does not support renaming as an explicit feature.\nTo rename a file, simply delete it and recreate it under\nthe new name in the same commit.\n", "key": "files", "value": "" }, { "description": "\nThe name of the branch that the new commit should be\ncreated on. When omitted, the commit will be created on top\nof the main branch and will become the main branch's new\nhead.\n\nWhen a branch name is provided that already exists in the\nrepo, then the commit will be created on top of that\nbranch. In this case, *if* a parent SHA1 was also provided,\nthen it is asserted that the parent is the branch's\ntip/HEAD at the time the request is made. When this is not\nthe case, a 409 is returned.\n\nWhen a new branch name is specified (that does not already\nexist in the repo), and no parent SHA1s are provided, then\nthe new commit will inherit from the current main branch's\ntip/HEAD commit, but not advance the main branch. The new\ncommit will be the new branch. When the request *also*\nspecifies a parent SHA1, then the new commit and branch\nare created directly on top of the parent commit,\nregardless of the state of the main branch.\n\nWhen a branch name is not specified, but a parent SHA1 is\nprovided, then Bitbucket asserts that it represents the\nmain branch's current HEAD/tip, or a 409 is returned.\n\nWhen a branch name is not specified and the repo is empty,\nthe new commit will become the repo's root commit and will\nbe on the main branch.\n\nWhen a branch name is specified and the repo is empty, the\nnew commit will become the repo's root commit and also\ndefine the repo's main branch going forward.\n\nThis API cannot be used to create additional root commits\nin non-empty repos.\n\nThe branch field cannot be repeated.\n\nAs a side effect, this API can be used to create a new\nbranch without modifying any files, by specifying a new\nbranch name in this field, together with `parents`, but\nomitting the `files` fields, while not sending any files.\nThis will create a new commit and branch with the same\ncontents as the first parent. The diff of this commit\nagainst its first parent will be empty.\n", "key": "branch", "value": "" } ], "variable": [ { "key": "workspace" }, { "key": "repo_slug" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"error\": {\n \"message\": \"\",\n \"detail\": \"\",\n \"data\": {\n \"irure_4b\": 28307284\n }\n }\n}", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-4f3ac918-0177-4516-aaf0-a899f98f1a40" }, { "id": "b4b03da1-e710-46be-84c1-5cdfc8f6d46a", "name": "If the repository does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/repositories/:workspace/:repo_slug/src?message=&author=&parents=&files=&branch=", "host": [ "{{baseUrl}}" ], "path": [ "repositories", ":workspace", ":repo_slug", "src" ], "query": [ { "description": "The commit message. When omitted, Bitbucket uses a canned string.", "key": "message", "value": "" }, { "description": "\nThe raw string to be used as the new commit's author.\nThis string follows the format\n`Erik van Zijst `.\n\nWhen omitted, Bitbucket uses the authenticated user's\nfull/display name and primary email address. Commits cannot\nbe created anonymously.", "key": "author", "value": "" }, { "description": "\n#### Deprecation Notice:\nSupport for specifying multiple parent\ncommits is deprecated and will be removed in a future release.\nOnly a single SHA1 is accepted.\n\nA SHA1 of the commit that should be the parent of the newly created\ncommit. When omitted, the new commit will inherit from and\nbecome a child of the main branch's tip/HEAD commit.", "key": "parents", "value": "" }, { "description": "\nOptional field that declares the files that the request is\nmanipulating. When adding a new file to a repo, or when\noverwriting an existing file, the client can just upload\nthe full contents of the file in a normal form field and\nthe use of this `files` meta data field is redundant.\nHowever, when the `files` field contains a file path that\ndoes not have a corresponding, identically-named form\nfield, then Bitbucket interprets that as the client wanting\nto replace the named file with the null set and the file is\ndeleted instead.\n\nPaths in the repo that are referenced in neither files nor\nan individual file field, remain unchanged and carry over\nfrom the parent to the new commit.\n\nThis API does not support renaming as an explicit feature.\nTo rename a file, simply delete it and recreate it under\nthe new name in the same commit.\n", "key": "files", "value": "" }, { "description": "\nThe name of the branch that the new commit should be\ncreated on. When omitted, the commit will be created on top\nof the main branch and will become the main branch's new\nhead.\n\nWhen a branch name is provided that already exists in the\nrepo, then the commit will be created on top of that\nbranch. In this case, *if* a parent SHA1 was also provided,\nthen it is asserted that the parent is the branch's\ntip/HEAD at the time the request is made. When this is not\nthe case, a 409 is returned.\n\nWhen a new branch name is specified (that does not already\nexist in the repo), and no parent SHA1s are provided, then\nthe new commit will inherit from the current main branch's\ntip/HEAD commit, but not advance the main branch. The new\ncommit will be the new branch. When the request *also*\nspecifies a parent SHA1, then the new commit and branch\nare created directly on top of the parent commit,\nregardless of the state of the main branch.\n\nWhen a branch name is not specified, but a parent SHA1 is\nprovided, then Bitbucket asserts that it represents the\nmain branch's current HEAD/tip, or a 409 is returned.\n\nWhen a branch name is not specified and the repo is empty,\nthe new commit will become the repo's root commit and will\nbe on the main branch.\n\nWhen a branch name is specified and the repo is empty, the\nnew commit will become the repo's root commit and also\ndefine the repo's main branch going forward.\n\nThis API cannot be used to create additional root commits\nin non-empty repos.\n\nThe branch field cannot be repeated.\n\nAs a side effect, this API can be used to create a new\nbranch without modifying any files, by specifying a new\nbranch name in this field, together with `parents`, but\nomitting the `files` fields, while not sending any files.\nThis will create a new commit and branch with the same\ncontents as the first parent. The diff of this commit\nagainst its first parent will be empty.\n", "key": "branch", "value": "" } ], "variable": [ { "key": "workspace" }, { "key": "repo_slug" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"error\": {\n \"message\": \"\",\n \"detail\": \"\",\n \"data\": {\n \"irure_4b\": 28307284\n }\n }\n}", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-b4b03da1-e710-46be-84c1-5cdfc8f6d46a" } ], "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-4ef3a9f1-55eb-42bc-8deb-98843f2f3bd8" } ], "id": "9a4d2188-08f7-4a48-8ea0-bba7090dfb51", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-9a4d2188-08f7-4a48-8ea0-bba7090dfb51" } ], "id": "4a4e696e-7fe5-408f-9a92-727dad25c2d1", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-4a4e696e-7fe5-408f-9a92-727dad25c2d1" } ], "id": "60fefe2f-4027-4807-bdf3-6351f77d5d39", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-60fefe2f-4027-4807-bdf3-6351f77d5d39" } ], "id": "9c98a180-98e6-47bb-a8c3-d9fb36b8abbc", "createdAt": "2026-07-28T01:14:46.000Z", "updatedAt": "2026-07-28T01:14:46.000Z", "uid": "35240-9c98a180-98e6-47bb-a8c3-d9fb36b8abbc" } ], "variable": [ { "key": "baseUrl", "value": "https://api.bitbucket.org/2.0" } ] }