{ "uuid": "0d9b5d22-a624-492c-a70b-0de988ad1a03", "lastMigration": 29, "name": "Bitbucket API", "endpointPrefix": "2.0", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "6b804b88-fc29-4eca-b13f-113775ae5177", "documentation": "Deletes the application for the user.\n\nThis endpoint is intended to be used by Bitbucket Connect apps\nand only supports JWT authentication -- that is how Bitbucket\nidentifies the particular installation of the app. Developers\nwith applications registered in the \"Develop Apps\" section\nof Bitbucket Marketplace need not use this endpoint as\nupdates for those applications can be sent out via the\nUI of that section.\n\n```\n$ curl -X DELETE https://api.bitbucket.org/2.0/addon \\\n -H \"Authorization: JWT \"\n```", "method": "delete", "endpoint": "addon", "responses": [ { "uuid": "2623e8f1-89f8-4434-b71d-6b8fe9a53f26", "body": "", "latency": 0, "statusCode": 204, "label": "Request has succeeded. The application has been deleted for the user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7749bfc5-8cf0-4a86-ba71-4a316aa08d76", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "No authorization.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d9de44b8-8f2f-42d8-81b8-753ab943f193", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Improper authentication.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5fe4b29-9285-4009-a4d4-fd01ffc4c264", "documentation": "Updates the application installation for the user.\n\nThis endpoint is intended to be used by Bitbucket Connect apps\nand only supports JWT authentication -- that is how Bitbucket\nidentifies the particular installation of the app. Developers\nwith applications registered in the \"Develop Apps\" section\nof Bitbucket Marketplace need not use this endpoint as\nupdates for those applications can be sent out via the\nUI of that section.\n\nA new, valid descriptor must be provided in the body of the\nPUT request.\n\n```\n$ curl -X PUT https://api.bitbucket.org/2.0/addon \\\n -H \"Authorization: JWT \" \\\n --header \"Content-Type: application/json\" \\\n --data '{\"descriptor\": $NEW_DESCRIPTOR}'\n```\n\nNote that the scopes of the application cannot be increased\nin the new descriptor nor reduced to none.", "method": "put", "endpoint": "addon", "responses": [ { "uuid": "2a59fbd5-9d90-4630-a951-226447e8e82c", "body": "", "latency": 0, "statusCode": 204, "label": "Request has succeeded. The installation has been updated to the new descriptor.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ff4365de-f7b9-439f-89fb-71a3ee164a8b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Scopes have increased or decreased to none.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c1d0e00a-3d00-4bc2-bb55-6ba3cf6c0115", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "No authorization.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "79e796bb-0444-4919-8cdf-91f5f9934c1b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "Improper authentication.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8301fcc6-eb53-4113-b8cf-18d74d1f5507", "documentation": "Gets a list of all [linkers](/cloud/bitbucket/modules/linker/)\nfor the authenticated application.", "method": "get", "endpoint": "addon/linkers", "responses": [ { "uuid": "04c250d9-0b19-43ff-b2b5-5c19d4ee8d76", "body": "", "latency": 0, "statusCode": 200, "label": "Successful.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5d4b5968-5bec-40c9-92b4-88f9465586d7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Authentication must use app JWT", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7d040a70-6e57-4b51-9a8c-07775071af94", "documentation": "Gets a [linker](/cloud/bitbucket/modules/linker/) specified by `linker_key`\nfor the authenticated application.", "method": "get", "endpoint": "addon/linkers/:linker_key", "responses": [ { "uuid": "b1daac93-b895-4a58-b7e0-ba4b858012bb", "body": "", "latency": 0, "statusCode": 200, "label": "Successful.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7cb7685a-28b2-421a-87c5-29d2fc09323f", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Authentication must use app JWT", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a494d8c0-db89-42f1-88a3-32f4a4751d49", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The linker does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1a7b635c-2c64-44d4-88cd-e3abc30572b7", "documentation": "Delete all [linker](/cloud/bitbucket/modules/linker/) values for the\nspecified linker of the authenticated application.", "method": "delete", "endpoint": "addon/linkers/:linker_key/values", "responses": [ { "uuid": "ba9d76db-3948-407f-8df7-f2b6dd5c7696", "body": "", "latency": 0, "statusCode": 204, "label": "Successfully deleted the linker values.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "54f70de2-2084-4d25-8d3c-7e0c22fcda11", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Authentication must use app JWT", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "de33e542-261b-4f52-9278-11dd0a3d0027", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The linker does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aef7bdff-8fcf-4200-a206-8a844c18f8d9", "documentation": "Gets a list of all [linker](/cloud/bitbucket/modules/linker/) values for the\nspecified linker of the authenticated application.\n\nA linker value lets applications supply values to modify its regular expression.\n\nThe base regular expression must use a Bitbucket-specific match group `(?K)`\nwhich will be translated to `([\\w\\-]+)`. A value must match this pattern.\n\n[Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)", "method": "get", "endpoint": "addon/linkers/:linker_key/values", "responses": [ { "uuid": "a8bd67cd-030d-429b-b348-1e8b89abb045", "body": "", "latency": 0, "statusCode": 200, "label": "Successful.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cde6eac6-c905-4673-8ddb-5c3cab6bd88c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Authentication must use app JWT", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5ec4576a-43b4-487e-b06f-65d01c3922d0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The linker does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "584ad4cb-b627-4854-9d93-37d1309c4a45", "documentation": "Creates a [linker](/cloud/bitbucket/modules/linker/) value for the specified\nlinker of authenticated application.\n\nA linker value lets applications supply values to modify its regular expression.\n\nThe base regular expression must use a Bitbucket-specific match group `(?K)`\nwhich will be translated to `([\\w\\-]+)`. A value must match this pattern.\n\n[Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)", "method": "post", "endpoint": "addon/linkers/:linker_key/values", "responses": [ { "uuid": "dc3242bb-fbcf-4d28-9b66-2d7ae8584b5a", "body": "", "latency": 0, "statusCode": 201, "label": "Successfully created the linker value.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0ee00d20-4a73-4ff0-9760-82efa492b4b3", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Authentication must use app JWT", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3f3861c3-b3c7-414e-ad8d-92ea1155cc10", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The linker does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fc2e0f4e-287e-422c-b806-e16d6071c109", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 409, "label": "The linker already has the value being added.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9a756aa4-576e-4869-9de3-26e809fbc00f", "documentation": "Bulk update [linker](/cloud/bitbucket/modules/linker/) values for the specified\nlinker of the authenticated application.\n\nA linker value lets applications supply values to modify its regular expression.\n\nThe base regular expression must use a Bitbucket-specific match group `(?K)`\nwhich will be translated to `([\\w\\-]+)`. A value must match this pattern.\n\n[Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)", "method": "put", "endpoint": "addon/linkers/:linker_key/values", "responses": [ { "uuid": "0b0e8a17-0960-4ce0-ba41-d5cbf5acb98f", "body": "", "latency": 0, "statusCode": 204, "label": "Successfully updated the linker values.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fa613a6a-4aac-4a2b-abf0-5b6a1473a321", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Invalid input.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "63f3979f-c303-4484-9ebd-7bc4067e450e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Authentication must use app JWT", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "16c3c879-6371-4864-aea6-77f6668fcf04", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The linker does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bb77f97b-1489-4c3d-b48b-a9d5be246557", "documentation": "Delete a single [linker](/cloud/bitbucket/modules/linker/) value\nof the authenticated application.", "method": "delete", "endpoint": "addon/linkers/:linker_key/values/:value_id", "responses": [ { "uuid": "ccadcd68-bc58-4b35-844b-a1a21c153db1", "body": "", "latency": 0, "statusCode": 204, "label": "Successfully deleted the linker value.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1cf3c69a-0061-4d4a-ba8a-a958d1b9cb40", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Authentication must use app JWT", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cdc0802f-18b7-4b28-b420-0f80cdddc584", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The linker value does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "773972b2-6e33-4ff0-b25e-f04505fa99cf", "documentation": "Get a single [linker](/cloud/bitbucket/modules/linker/) value\nof the authenticated application.", "method": "get", "endpoint": "addon/linkers/:linker_key/values/:value_id", "responses": [ { "uuid": "7f35dacc-250a-4272-a186-a53f9909705f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8f7022da-015e-4e20-a031-f19c39676a33", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "Authentication must use app JWT", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5c416567-da26-4987-b23d-fbbdc349ac59", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The linker value does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "209398ff-cee4-443d-9c40-3abfbbd8635e", "documentation": "Returns the webhook resource or subject types on which webhooks can\nbe registered.\n\nEach resource/subject type contains an `events` link that returns the\npaginated list of specific events each individual subject type can\nemit.\n\nThis endpoint is publicly accessible and does not require\nauthentication or scopes.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/hook_events\n\n{\n \"repository\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/repository\"\n }\n }\n },\n \"team\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/team\"\n }\n }\n },\n \"user\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/user\"\n }\n }\n }\n}\n```", "method": "get", "endpoint": "hook_events", "responses": [ { "uuid": "4f890c36-feca-4aec-9998-cad65d8c1017", "body": "{\n \"repository\": {\n \"events\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"team\": {\n \"events\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n },\n \"user\": {\n \"events\": {\n \"href\": \"\",\n \"name\": \"\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "A mapping of resource/subject types pointing to their individual event types.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9cf60cba-d804-46d2-8e93-b55018d4d3d6", "documentation": "Returns a paginated list of all valid webhook events for the\nspecified entity.\n**The team and user webhooks are deprecated, and you should use workspace instead.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**\n\nThis is public data that does not require any scopes or authentication.\n\nExample:\n\nNOTE: The following example is a truncated response object for the `workspace` `subject_type`.\nWe return the same structure for the other `subject_type` objects.\n\n```\n$ curl https://api.bitbucket.org/2.0/hook_events/workspace\n{\n \"page\": 1,\n \"pagelen\": 30,\n \"size\": 21,\n \"values\": [\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository push occurs\",\n \"event\": \"repo:push\",\n \"label\": \"Push\"\n },\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository fork occurs\",\n \"event\": \"repo:fork\",\n \"label\": \"Fork\"\n },\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository import occurs\",\n \"event\": \"repo:imported\",\n \"label\": \"Import\"\n },\n ...\n {\n \"category\":\"Pull Request\",\n \"label\":\"Approved\",\n \"description\":\"When someone has approved a pull request\",\n \"event\":\"pullrequest:approved\"\n },\n ]\n}\n```", "method": "get", "endpoint": "hook_events/:subject_type", "responses": [ { "uuid": "6bca5ba6-510e-46e1-b38b-99f61ed000eb", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"category\": \"\",\n \"description\": \"\",\n \"event\": \"{{oneOf (array 'pullrequest:unapproved' 'issue:comment_created' 'repo:imported' 'repo:created' 'repo:commit_comment_created' 'pullrequest:approved' 'pullrequest:comment_updated' 'issue:updated' 'project:updated' 'repo:deleted' 'pullrequest:changes_request_created' 'pullrequest:comment_created' 'repo:commit_status_updated' 'pullrequest:updated' 'issue:created' 'repo:fork' 'pullrequest:comment_deleted' 'repo:commit_status_created' 'repo:updated' 'pullrequest:rejected' 'pullrequest:fulfilled' 'pullrequest:created' 'pullrequest:changes_request_removed' 'repo:transfer' 'repo:push')}}\",\n \"label\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of webhook types available to subscribe on.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "29731876-2eb0-4616-853c-2a5a5c3d2dd5", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If an invalid `{subject_type}` value was specified.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "be128031-b4d5-4ada-ae68-10de86e34e64", "documentation": "Returns all pull requests authored by the specified user.\n\nBy default only open pull requests are returned. This can be controlled\nusing the `state` query parameter. To retrieve pull requests that are\nin one of multiple states, repeat the `state` parameter for each\nindividual state.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../../../meta/filtering) for more details.", "method": "get", "endpoint": "pullrequests/:selected_user", "responses": [ { "uuid": "fe26a2ff-74b4-42cb-91ec-fd3de975ea1e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "All pull requests authored by the specified user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6e10e722-cf23-40aa-b0b7-53af0c4ff798", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f457d01a-8f0f-4aef-94e6-7bd02d7d40df", "documentation": "Returns a paginated list of all public repositories.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../meta/filtering) for more details.", "method": "get", "endpoint": "repositories", "responses": [ { "uuid": "9d009940-d28a-4a78-9e52-30ddf84b2b3f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "All public repositories.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e8c6ef63-e5bb-4903-a858-637d7877f78c", "documentation": "Returns a paginated list of all repositories owned by the specified\naccount or UUID.\n\nThe result can be narrowed down based on the authenticated user's role.\n\nE.g. with `?role=contributor`, only those repositories that the\nauthenticated user has write access to are returned (this includes any\nrepo the user is an admin on, as that implies write access).\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../meta/filtering) for more details.", "method": "get", "endpoint": "repositories/:workspace", "responses": [ { "uuid": "ff75e6b6-c4de-481b-a02d-9804d50e1f9e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The repositories owned by the specified account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "801a3c4a-aa54-470a-a04e-2a19b9db6686", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified account does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d002e266-706a-4d01-8239-023d6b03dca1", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 410, "label": "If the specified account marked as spam.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "624eaf4b-863b-4bd2-b40c-bdfdd1612534", "documentation": "Deletes the repository. This is an irreversible operation.\n\nThis does not affect its forks.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug", "responses": [ { "uuid": "9d258da8-82c5-4da4-abea-cd666e911523", "body": "", "latency": 0, "statusCode": 204, "label": "Indicates successful deletion.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "53261e37-65df-4091-a382-cf64153af637", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the caller either does not have admin access to the repository, or the repository is set to read-only.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "60750bff-83eb-475b-be81-158cbed558ee", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9b2475ab-149e-4c5b-bdc7-af89602300ce", "documentation": "Returns the object describing this repository.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug", "responses": [ { "uuid": "1eeea11a-1787-4da7-8019-9679e6a8a7d3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The repository object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "292acff0-4273-440f-a907-7b3c4b6f40e8", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the repository is private and the authenticated user does not have access to it.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6f9cc8a3-ac93-454f-ac61-cfe136b99a3e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If no repository exists at this location.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "af0489d2-c88c-4763-86c9-c0493f5d78d6", "documentation": "Creates a new repository.\n\nNote: In order to set the project for the newly created repository,\npass in either the project key or the project UUID as part of the\nrequest body as shown in the examples below:\n\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"MARS\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\n\nor\n\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"{ba516952-992a-4c2d-acbd-17d502922f96}\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\n\nThe project must be assigned for all repositories. If the project is not provided,\nthe repository is automatically assigned to the oldest project in the workspace.\n\nNote: In the examples above, the workspace ID `teamsinspace`,\nand/or the repository name `hablanding` can be replaced by UUIDs.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug", "responses": [ { "uuid": "3b713d4c-83bd-483e-be19-fda5346688cd", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The newly created repository.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a964b361-483c-491e-b74c-701d8b5451bf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "171c4c8e-6988-4fc6-b866-7d22f7d1d0a1", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8eee435a-92e3-4137-8cb2-2ee56f326ba0", "documentation": "Since this endpoint can be used to both update and to create a\nrepository, the request body depends on the intent.\n\n### Creation\n\nSee the POST documentation for the repository endpoint for an example\nof the request body.\n\n### Update\n\nNote: Changing the `name` of the repository will cause the location to\nbe changed. This is because the URL of the repo is derived from the\nname (a process called slugification). In such a scenario, it is\npossible for the request to fail if the newly created slug conflicts\nwith an existing repository's slug. But if there is no conflict,\nthe new location will be returned in the `Location` header of the\nresponse.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug", "responses": [ { "uuid": "45cf08fa-298a-4344-8535-158d9304afaf", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The existing repository has been updated", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "69cbc790-8dd6-411e-8b6b-b2b96b44e3aa", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "A new repository has been created", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "078a1096-89da-4a8f-82f1-15dfdf45cae0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1dae6339-078e-49b8-8536-316ae4918395", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "04c72177-592d-421d-8b69-72e43d4980e6", "documentation": "Returns a paginated list of all branch restrictions on the\nrepository.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/branch-restrictions", "responses": [ { "uuid": "36fba47d-d41a-4193-b94c-c18abed40bfb", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of branch restrictions", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5e37e54c-3b5f-4163-aec0-51e2a350ac9e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "eaeaa601-8ca6-4263-84fb-23166c6efbd5", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have admin access to the repository", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "59cae7cf-24d6-43bb-86a1-97ed570d38fc", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a32a000c-8356-4ac8-b0c0-bba6532c866f", "documentation": "Creates a new branch restriction rule for a repository.\n\n`kind` describes what will be restricted. Allowed values include:\n`push`, `force`, `delete` and `restrict_merges`.\n\nDifferent kinds of branch restrictions have different requirements:\n\n* `push` and `restrict_merges` require `users` and `groups` to be\n specified. Empty lists are allowed, in which case permission is\n denied for everybody.\n\nThe restriction applies to all branches that match. There are\ntwo ways to match a branch. It is configured in `branch_match_kind`:\n\n1. `glob`: Matches a branch against the `pattern`. A `'*'` in\n `pattern` will expand to match zero or more characters, and every\n other character matches itself. For example, `'foo*'` will match\n `'foo'` and `'foobar'`, but not `'barfoo'`. `'*'` will match all\n branches.\n2. `branching_model`: Matches a branch against the repository's\n branching model. The `branch_type` controls the type of branch\n to match. Allowed values include: `production`, `development`,\n `bugfix`, `release`, `feature` and `hotfix`.\n\nThe combination of `kind` and match must be unique. This means that\ntwo `glob` restrictions in a repository cannot have the same `kind` and\n`pattern`. Additionally, two `branching_model` restrictions in a\nrepository cannot have the same `kind` and `branch_type`.\n\n`users` and `groups` are lists of users and groups that are except from\nthe restriction. They can only be configured in `push` and\n`restrict_merges` restrictions. The `push` restriction stops a user\npushing to matching branches unless that user is in `users` or is a\nmember of a group in `groups`. The `restrict_merges` stops a user\nmerging pull requests to matching branches unless that user is in\n`users` or is a member of a group in `groups`. Adding new users or\ngroups to an existing restriction should be done via `PUT`.\n\nNote that branch restrictions with overlapping matchers is allowed,\nbut the resulting behavior may be surprising.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/branch-restrictions", "responses": [ { "uuid": "94cd2cf3-3758-4f7f-ac2a-6072927416b8", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "A paginated list of branch restrictions", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6e7d553b-4dae-46a0-808d-4edd6b72bbd1", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b32b0fca-7521-4d4f-b56d-6d769053c516", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have admin access to the repository", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "21f7b6b9-4dc3-488b-8a57-8be119ec055d", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "312d5559-4008-49a7-87d4-dbe060d3b283", "documentation": "Deletes an existing branch restriction rule.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/branch-restrictions/:id", "responses": [ { "uuid": "4a2f00b3-9448-426b-a204-fb6acfc48dd3", "body": "", "latency": 0, "statusCode": 204, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "da8da226-8b3d-4624-adfd-04e8e13ffe0d", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8a32aa12-6e3f-4973-b594-8f6353c8fde7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have admin access to the repository", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5e26217e-e130-42d9-b820-c7af9d58b9f3", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository or branch restriction id does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9bf7efde-ce0b-4d65-b50c-2668a0386908", "documentation": "Returns a specific branch restriction rule.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/branch-restrictions/:id", "responses": [ { "uuid": "668448cc-7a60-470c-9ba0-5ca8b2a4350f", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The branch restriction rule", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "25c5697e-1192-4fcb-b306-b585ce24f2ea", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "34a93029-bd07-4983-bd01-78866e0b4ba0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have admin access to the repository", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "33e205d6-9883-45de-bb2a-7b77a53996cd", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository or branch restriction id does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7dc8fbf4-d357-4ba6-91cf-174503fd6a05", "documentation": "Updates an existing branch restriction rule.\n\nFields not present in the request body are ignored.\n\nSee [`POST`](../branch-restrictions#post) for details.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/branch-restrictions/:id", "responses": [ { "uuid": "a46c1e2e-94b1-4db2-abaf-40cf277643d7", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The updated branch restriction rule", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "518383db-74ad-4b6c-be58-83a91b5d5587", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f72b471c-142e-46b2-8a64-d9f01d62da63", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have admin access to the repository", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6ef9b824-3fa2-47a1-8e7c-574641ec4faf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository or branch restriction id does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "36247b18-5a8e-4676-9ad5-b1c0c85443cd", "documentation": "Return the branching model as applied to the repository. This view is\nread-only. The branching model settings can be changed using the\n[settings](branching-model/settings#get) API.\n\nThe returned object:\n\n1. Always has a `development` property. `development.branch` contains\n the actual repository branch object that is considered to be the\n `development` branch. `development.branch` will not be present\n if it does not exist.\n2. Might have a `production` property. `production` will not\n be present when `production` is disabled.\n `production.branch` contains the actual branch object that is\n considered to be the `production` branch. `production.branch` will\n not be present if it does not exist.\n3. Always has a `branch_types` array which contains all enabled branch\n types.\n\nExample body:\n\n```\n{\n \"development\": {\n \"name\": \"master\",\n \"branch\": {\n \"type\": \"branch\",\n \"name\": \"master\",\n \"target\": {\n \"hash\": \"16dffcb0de1b22e249db6799532074cf32efe80f\"\n }\n },\n \"use_mainbranch\": true\n },\n \"production\": {\n \"name\": \"production\",\n \"branch\": {\n \"type\": \"branch\",\n \"name\": \"production\",\n \"target\": {\n \"hash\": \"16dffcb0de1b22e249db6799532074cf32efe80f\"\n }\n },\n \"use_mainbranch\": false\n },\n \"branch_types\": [\n {\n \"kind\": \"release\",\n \"prefix\": \"release/\"\n },\n {\n \"kind\": \"hotfix\",\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"feature\",\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"bugfix\",\n \"prefix\": \"bugfix/\"\n }\n ],\n \"type\": \"branching_model\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/.../branching-model\"\n }\n }\n}\n```", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/branching-model", "responses": [ { "uuid": "bd12104f-31ee-4536-8228-0849d858f7e4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The branching model object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f3ba8ede-5c2f-464b-8dc0-049a6f9421ab", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "69239cc4-ba4f-46a1-a7b0-24d153e64b6f", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have read access to the repository", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7629ee8e-a1a7-484d-8261-e99e29083cb7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a2a7f0cb-d8f9-4b25-b228-6dbe08e33559", "documentation": "Return the branching model configuration for a repository. The returned\nobject:\n\n1. Always has a `development` property for the development branch.\n2. Always a `production` property for the production branch. The\n production branch can be disabled.\n3. The `branch_types` contains all the branch types.\n\nThis is the raw configuration for the branching model. A client\nwishing to see the branching model with its actual current branches may\nfind the [active model API](../branching-model#get) more useful.\n\nExample body:\n\n```\n{\n \"development\": {\n \"is_valid\": true,\n \"name\": null,\n \"use_mainbranch\": true\n },\n \"production\": {\n \"is_valid\": true,\n \"name\": \"production\",\n \"use_mainbranch\": false,\n \"enabled\": false\n },\n \"branch_types\": [\n {\n \"kind\": \"release\",\n \"enabled\": true,\n \"prefix\": \"release/\"\n },\n {\n \"kind\": \"hotfix\",\n \"enabled\": true,\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"feature\",\n \"enabled\": true,\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"bugfix\",\n \"enabled\": false,\n \"prefix\": \"bugfix/\"\n }\n ],\n \"type\": \"branching_model_settings\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/.../branching-model/settings\"\n }\n }\n}\n```", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/branching-model/settings", "responses": [ { "uuid": "2530a485-226e-4539-8476-f4cc6e84ac0f", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The branching model configuration", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2fce6f4c-1321-471a-9b54-16a727f07ded", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "71015fb8-4402-4f41-a91d-7007866f0746", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have admin access to the repository", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9243392d-11cf-4e6d-b98f-b7b608237481", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f7ecf5d8-f26a-42e2-a8cf-4d7c3ce468d0", "documentation": "Update the branching model configuration for a repository.\n\nThe `development` branch can be configured to a specific branch or to\ntrack the main branch. When set to a specific branch it must\ncurrently exist. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. A request without a\n`development` property will leave the development branch unchanged.\n\nIt is possible for the `development` branch to be invalid. This\nhappens when it points at a specific branch that has been\ndeleted. This is indicated in the `is_valid` field for the branch. It is\nnot possible to update the settings for `development` if that\nwould leave the branch in an invalid state. Such a request will be\nrejected.\n\nThe `production` branch can be a specific branch, the main\nbranch or disabled. When set to a specific branch it must currently\nexist. The `enabled` property can be used to enable (`true`) or\ndisable (`false`) it. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. A request without a\n`production` property will leave the production branch unchanged.\n\nIt is possible for the `production` branch to be invalid. This\nhappens when it points at a specific branch that has been\ndeleted. This is indicated in the `is_valid` field for the branch. A\nrequest that would leave `production` enabled and invalid will be\nrejected. It is possible to update `production` and make it invalid if\nit would also be left disabled.\n\nThe `branch_types` property contains the branch types to be updated.\nOnly the branch types passed will be updated. All updates will be\nrejected if it would leave the branching model in an invalid state.\nFor branch types this means that:\n\n1. The prefixes for all enabled branch types are valid. For example,\n it is not possible to use '*' inside a Git prefix.\n2. A prefix of an enabled branch type must not be a prefix of another\n enabled branch type. This is to ensure that a branch can be easily\n classified by its prefix unambiguously.\n\nIt is possible to store an invalid prefix if that branch type would be\nleft disabled. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. Each branch type must\nhave a `kind` property to identify it.\n\nExample Body:\n\n```\n {\n \"development\": {\n \"use_mainbranch\": true\n },\n \"production\": {\n \"enabled\": true,\n \"use_mainbranch\": false,\n \"name\": \"production\"\n },\n \"branch_types\": [\n {\n \"kind\": \"bugfix\",\n \"enabled\": true,\n \"prefix\": \"bugfix/\"\n },\n {\n \"kind\": \"feature\",\n \"enabled\": true,\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"hotfix\",\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"release\",\n \"enabled\": false,\n }\n ]\n }\n```", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/branching-model/settings", "responses": [ { "uuid": "b4884efb-ab9b-460f-aa33-e7d083bbc501", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The updated branching model configuration", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f16c2264-8c75-4216-a82b-241a1103bed8", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the request contains invalid branching model configuration", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "91d3a9cd-a2a3-4f00-bf90-57deac0c38bf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "81356b47-8702-4fab-90a4-8c1ce23b3bf8", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have admin access to the repository", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1da831be-bbe6-41fc-8afe-3c14be4c5c69", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a7a46019-fe4b-4255-a720-4c0da49c5208", "documentation": "Returns the specified commit.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a1\n{\n \"rendered\": {\n \"message\": {\n \"raw\": \"Add a GEORDI_OUTPUT_DIR setting\",\n \"markup\": \"markdown\",\n \"html\": \"

Add a GEORDI_OUTPUT_DIR setting

\",\n \"type\": \"rendered\"\n }\n },\n \"hash\": \"f7591a13eda445d9a9167f98eb870319f4b6c2d8\",\n \"repository\": {\n \"name\": \"geordi\",\n \"type\": \"repository\",\n \"full_name\": \"bitbucket/geordi\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bitbucket/geordi\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B85d08b4e-571d-44e9-a507-fa476535aa98%7D?ts=1730260\"\n }\n },\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/patch/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bitbucket/geordi/commits/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/diff/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"Brodie Rao \",\n \"type\": \"author\",\n \"user\": {\n \"display_name\": \"Brodie Rao\",\n \"uuid\": \"{9484702e-c663-4afd-aefb-c93a8cd31c28}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B9484702e-c663-4afd-aefb-c93a8cd31c28%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B9484702e-c663-4afd-aefb-c93a8cd31c28%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:3aae1e05-702a-41e5-81c8-f36f29afb6ca/613070db-28b0-421f-8dba-ae8a87e2a5c7/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"brodie\",\n \"account_id\": \"557058:3aae1e05-702a-41e5-81c8-f36f29afb6ca\"\n }\n },\n \"summary\": {\n \"raw\": \"Add a GEORDI_OUTPUT_DIR setting\",\n \"markup\": \"markdown\",\n \"html\": \"

Add a GEORDI_OUTPUT_DIR setting

\",\n \"type\": \"rendered\"\n },\n \"participants\": [],\n \"parents\": [\n {\n \"type\": \"commit\",\n \"hash\": \"f06941fec4ef6bcb0c2456927a0cf258fa4f899b\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f06941fec4ef6bcb0c2456927a0cf258fa4f899b\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bitbucket/geordi/commits/f06941fec4ef6bcb0c2456927a0cf258fa4f899b\"\n }\n }\n }\n ],\n \"date\": \"2012-07-16T19:37:54+00:00\",\n \"message\": \"Add a GEORDI_OUTPUT_DIR setting\",\n \"type\": \"commit\"\n}\n```", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit", "responses": [ { "uuid": "401422cd-263c-4e6b-83e3-672c6b6b57ff", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The commit object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4e3bb342-d96a-4732-945d-88f8ceda8672", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified commit or repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3f32dc1d-95a4-43ec-8ba0-3133857b2d85", "documentation": "Redact the authenticated user's approval of the specified commit.\n\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/approve", "responses": [ { "uuid": "7776766e-383c-44d8-b303-37e3bf1baecf", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response indicating the authenticated user's approval has been withdrawn.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5efb7750-fc36-444f-9aba-161bb0febde4", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified commit, or the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f951b572-5bde-4b56-b533-35909650ce0a", "documentation": "Approve the specified commit as the authenticated user.\n\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/approve", "responses": [ { "uuid": "8ff365c4-53b3-4f88-8a7d-f45cf3ff696e", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The `participant` object recording that the authenticated user approved the commit.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0d1a9b7e-048b-42c0-ad36-a40d5c796370", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified commit, or the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8a6110de-57de-4abf-8194-2e9d175b9221", "documentation": "Returns the commit's comments.\n\nThis includes both global and inline comments.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/comments", "responses": [ { "uuid": "ab46a6ad-6254-4c75-9a9e-83c80d6e22d0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of commit comments.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1a8ed47c-91d6-47ed-9753-44bc5fe01bcb", "documentation": "Creates new comment on the specified commit.\n\nTo post a reply to an existing comment, include the `parent.id` field:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/commit/db9ba1e031d07a02603eae0e559a7adc010257fc/comments/ \\\n -X POST -u evzijst \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\": {\"raw\": \"One more thing!\"},\n \"parent\": {\"id\": 5728901}}'\n```", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/comments", "responses": [ { "uuid": "29728098-b972-490d-976c-adda0564dd0c", "body": "", "latency": 0, "statusCode": 201, "label": "The newly created comment.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "07a72a08-408c-41cc-af16-a07e7ea407fb", "body": "", "latency": 0, "statusCode": 400, "label": "If the comment was detected as spam, or if the parent comment is not attached to the same node as the new comment", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e521aa4c-1131-4458-99ba-db7e8f843424", "body": "", "latency": 0, "statusCode": 404, "label": "If a parent ID was passed in that cannot be found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "60c07797-f229-4360-b900-bd85efacd8ea", "documentation": "Returns the specified commit comment.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/comments/:comment_id", "responses": [ { "uuid": "d0b4e81b-36a1-4c6b-bf8d-43f38cc95981", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The commit comment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9d4ac18a-4cac-4eb2-9bc8-46f7350bd802", "documentation": "Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a commit.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/properties/:app_key/:property_name", "responses": [ { "uuid": "915e4a6c-f703-43fd-bc10-b2f65d314bae", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "013670b1-3ba9-44cd-a0d4-ef1dea65b8a8", "documentation": "Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a commit.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/properties/:app_key/:property_name", "responses": [ { "uuid": "aa322c9f-d6b6-40a4-a2b1-dc78129b00c2", "body": "", "latency": 0, "statusCode": 200, "label": "The value of the property.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "71d04d76-fe27-4426-bfe6-10ce126ea933", "documentation": "Update an [application property](/cloud/bitbucket/application-properties/) value stored against a commit.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/properties/:app_key/:property_name", "responses": [ { "uuid": "49d7fe31-81de-409c-aa44-004814291205", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4866b032-b8ab-451a-b8c0-af445ae1caf4", "documentation": "Returns a paginated list of all pull requests as part of which this commit was reviewed. Pull Request Commit Links app must be installed first before using this API; installation automatically occurs when 'Go to pull request' is clicked from the web interface for a commit's details.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/pullrequests", "responses": [ { "uuid": "c725ca84-5564-4cbb-8d62-2f98427baa8f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The paginated list of pull requests.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e9f9d80b-0087-406b-8168-aa555c04b355", "body": "\"\"", "latency": 0, "statusCode": 202, "label": "The repository's pull requests are still being indexed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e48953cf-c862-466a-b069-0675181c8101", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Either the repository does not exist, or pull request commit links have not yet been indexed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0ab234a1-98f5-4c66-9bf0-851e4a422462", "documentation": "Returns a paginated list of Reports linked to this commit.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/reports", "responses": [ { "uuid": "3dd48347-1df1-49a9-a520-6bda31b77dc8", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a0788944-c7bc-4b27-9d27-8cde4a7c8423", "documentation": "Deletes a single Report matching the provided ID.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId", "responses": [ { "uuid": "a32157fc-0303-4e71-8248-37d2afb6cb9d", "body": "", "latency": 0, "statusCode": 204, "label": "No content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "57f3ae70-db79-4836-b16e-f3f256b87233", "documentation": "Returns a single Report matching the provided ID.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId", "responses": [ { "uuid": "b0ccb5a7-26c7-4c88-8a0c-9064e25411c5", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c8bd7614-893b-4949-b381-28eb3454c454", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The report with the given ID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba68156b-3966-4ee9-9f57-d3bbeba4f817", "documentation": "Creates or updates a report for the specified commit.\nTo upload a report, make sure to generate an ID that is unique across all reports for that commit. If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-001.\n\n### Sample cURL request:\n```\ncurl --request PUT 'https://api.bitbucket.org/2.0/repositories///commit//reports/mysystem-001' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"title\": \"Security scan report\",\n \"details\": \"This pull request introduces 10 new dependency vulnerabilities.\",\n \"report_type\": \"SECURITY\",\n \"reporter\": \"mySystem\",\n \"link\": \"http://www.mysystem.com/reports/001\",\n \"result\": \"FAILED\",\n \"data\": [\n {\n \"title\": \"Duration (seconds)\",\n \"type\": \"DURATION\",\n \"value\": 14\n },\n {\n \"title\": \"Safe to merge?\",\n \"type\": \"BOOLEAN\",\n \"value\": false\n }\n ]\n}'\n```\n\n### Possible field values:\nreport_type: SECURITY, COVERAGE, TEST, BUG\nresult: PASSED, FAILED, PENDING\ndata.type: BOOLEAN, DATE, DURATION, LINK, NUMBER, PERCENTAGE, TEXT\n\n#### Data field formats\n| Type Field | Value Field Type | Value Field Display |\n|:--------------|:------------------|:--------------------|\n| None/ Omitted | Number, String or Boolean (not an array or object) | Plain text |\n| BOOLEAN\t| Boolean | The value will be read as a JSON boolean and displayed as 'Yes' or 'No'. |\n| DATE | Number | The value will be read as a JSON number in the form of a Unix timestamp (milliseconds) and will be displayed as a relative date if the date is less than one week ago, otherwise it will be displayed as an absolute date. |\n| DURATION | Number | The value will be read as a JSON number in milliseconds and will be displayed in a human readable duration format. |\n| LINK | Object: `{\"text\": \"Link text here\", \"href\": \"https://link.to.annotation/in/external/tool\"}` | The value will be read as a JSON object containing the fields \"text\" and \"href\" and will be displayed as a clickable link on the report. |\n| NUMBER | Number | The value will be read as a JSON number and large numbers will be displayed in a human readable format (e.g. 14.3k). |\n| PERCENTAGE | Number (between 0 and 100) | The value will be read as a JSON number between 0 and 100 and will be displayed with a percentage sign. |\n| TEXT | String | The value will be read as a JSON string and will be displayed as-is |\n\nPlease refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.\n", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId", "responses": [ { "uuid": "1148ba1f-2236-4f6c-ac64-39de08c4a2a7", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "88cd64f5-4791-437e-8b77-128cd8332f0b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "The provided Report object is malformed or incomplete.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "63b8dc12-5eaa-4867-ac30-797c7f0b9b31", "documentation": "Returns a paginated list of Annotations for a specified report.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId/annotations", "responses": [ { "uuid": "185d8abf-217b-448b-90f6-77dbf246232b", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "db1fcd65-1d5a-4c21-b2b8-9adbe3e3cea4", "documentation": "Bulk upload of annotations.\nAnnotations are individual findings that have been identified as part of a report, for example, a line of code that represents a vulnerability. These annotations can be attached to a specific file and even a specific line in that file, however, that is optional. Annotations are not mandatory and a report can contain up to 1000 annotations.\n\nAdd the annotations you want to upload as objects in a JSON array and make sure each annotation has the external_id field set to a unique value. If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-annotation001. The external id can later be used to identify the report as an alternative to the generated [UUID](https://developer.atlassian.com/bitbucket/api/2/reference/meta/uri-uuid#uuid). You can upload up to 100 annotations per POST request.\n\n### Sample cURL request:\n```\ncurl --location 'https://api.bitbucket.org/2.0/repositories///commit//reports/mysystem-001/annotations' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\n \"external_id\": \"mysystem-annotation001\",\n \"title\": \"Security scan report\",\n \"annotation_type\": \"VULNERABILITY\",\n \"summary\": \"This line represents a security threat.\",\n \"severity\": \"HIGH\",\n \"path\": \"my-service/src/main/java/com/myCompany/mysystem/logic/Main.java\",\n \"line\": 42\n },\n {\n \"external_id\": \"mySystem-annotation002\",\n \"title\": \"Bug report\",\n \"annotation_type\": \"BUG\",\n \"result\": \"FAILED\",\n \"summary\": \"This line might introduce a bug.\",\n \"severity\": \"MEDIUM\",\n \"path\": \"my-service/src/main/java/com/myCompany/mysystem/logic/Helper.java\",\n \"line\": 13\n }\n]'\n```\n\n### Possible field values:\nannotation_type: VULNERABILITY, CODE_SMELL, BUG\nresult: PASSED, FAILED, IGNORED, SKIPPED\nseverity: HIGH, MEDIUM, LOW, CRITICAL\n\nPlease refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.\n", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId/annotations", "responses": [ { "uuid": "51a695ce-9306-4642-9ebd-7ca8d9c4631d", "body": "[\n {\n \"type\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b011ea0-3c34-40a2-97ab-30d986120dea", "documentation": "Deletes a single Annotation matching the provided ID.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId/annotations/:annotationId", "responses": [ { "uuid": "d04f8fbc-8039-4774-aedf-356793b5451c", "body": "", "latency": 0, "statusCode": 204, "label": "No content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "20a7cf20-0a1a-4887-8c70-6f7527389864", "documentation": "Returns a single Annotation matching the provided ID.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId/annotations/:annotationId", "responses": [ { "uuid": "37447910-614f-42dd-958a-6259fb3fd7c3", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bed130a8-f88f-4d2a-b65e-19ab0316039b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The annotation with the given ID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e9d258ed-e637-49c6-abbd-0204b3d5e257", "documentation": "Creates or updates an individual annotation for the specified report.\nAnnotations are individual findings that have been identified as part of a report, for example, a line of code that represents a vulnerability. These annotations can be attached to a specific file and even a specific line in that file, however, that is optional. Annotations are not mandatory and a report can contain up to 1000 annotations.\n\nJust as reports, annotation needs to be uploaded with a unique ID that can later be used to identify the report as an alternative to the generated [UUID](https://developer.atlassian.com/bitbucket/api/2/reference/meta/uri-uuid#uuid). If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-annotation001.\n\n### Sample cURL request:\n```\ncurl --request PUT 'https://api.bitbucket.org/2.0/repositories///commit//reports/mySystem-001/annotations/mysystem-annotation001' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"title\": \"Security scan report\",\n \"annotation_type\": \"VULNERABILITY\",\n \"summary\": \"This line represents a security thread.\",\n \"severity\": \"HIGH\",\n \"path\": \"my-service/src/main/java/com/myCompany/mysystem/logic/Main.java\",\n \"line\": 42\n}'\n```\n\n### Possible field values:\nannotation_type: VULNERABILITY, CODE_SMELL, BUG\nresult: PASSED, FAILED, IGNORED, SKIPPED\nseverity: HIGH, MEDIUM, LOW, CRITICAL\n\nPlease refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.\n", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/reports/:reportId/annotations/:annotationId", "responses": [ { "uuid": "9aeebeb5-db6b-4a6d-a03e-b5f27962d8a6", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c7943cb0-d3c7-45c0-adc3-ebd0273e2a70", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "The provided Annotation object is malformed or incomplete.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3a471bf6-cfad-4ca2-8fa3-35d0f804e57c", "documentation": "Returns all statuses (e.g. build results) for a specific commit.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/statuses", "responses": [ { "uuid": "971f98e8-c37d-4ff2-a6ed-83a85d555140", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of all commit statuses for this commit.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d27afbbe-1bdb-4b39-ae44-1686c350c8d8", "body": "", "latency": 0, "statusCode": 401, "label": "If the repository is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "51299d4c-cd26-4941-9d6a-8e48849dcb61", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository or commit does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a0e006ba-11b4-4399-8ad6-9bb8cc62f0b1", "documentation": "Creates a new build status against the specified commit.\n\nIf the specified key already exists, the existing status object will\nbe overwritten.\n\nExample:\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo/commit/e10dae226959c2194f2b07b077c07762d93821cf/statuses/build/ -X POST -u jdoe -H 'Content-Type: application/json' -d '{\n \"key\": \"MY-BUILD\",\n \"state\": \"SUCCESSFUL\",\n \"description\": \"42 tests passed\",\n \"url\": \"https://www.example.org/my-build-result\"\n }'\n```\n\nWhen creating a new commit status, you can use a URI template for the URL.\nTemplates are URLs that contain variable names that Bitbucket will\nevaluate at runtime whenever the URL is displayed anywhere similar to\nparameter substitution in\n[Bitbucket Connect](https://developer.atlassian.com/bitbucket/concepts/context-parameters.html).\nFor example, one could use `https://foo.com/builds/{repository.full_name}`\nwhich Bitbucket will turn into `https://foo.com/builds/foo/bar` at render time.\nThe context variables available are `repository` and `commit`.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/statuses/build", "responses": [ { "uuid": "a15289ae-9305-43ac-89fd-0e3a4db2a610", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The newly created build status object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "785ca084-f96f-4115-aa28-c5d066618aa0", "body": "", "latency": 0, "statusCode": 401, "label": "If the repository is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ffe1dbed-138c-474b-906b-3e36390c6099", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository, commit, or build status key does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "76a7c5d4-1aa4-4edb-b269-ddbd560c93f7", "documentation": "Returns the specified build status for a commit.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/statuses/build/:key", "responses": [ { "uuid": "b2df1e77-713c-45f5-bf4b-113daa73cee7", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The build status object with the specified key.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a7750a6e-09e8-4e85-a76a-9d55d3091cec", "body": "", "latency": 0, "statusCode": 401, "label": "If the repository is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ea097c91-446e-4f35-9c0f-160ffb3b2e06", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository, commit, or build status key does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bc65ed2f-7c12-41ca-b975-3df7ccabbf6f", "documentation": "Used to update the current status of a build status object on the\nspecific commit.\n\nThis operation can also be used to change other properties of the\nbuild status:\n\n* `state`\n* `name`\n* `description`\n* `url`\n* `refname`\n\nThe `key` cannot be changed.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/commit/:commit/statuses/build/:key", "responses": [ { "uuid": "b4c00024-4a92-46a7-b58d-429bc9f1b818", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The updated build status object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "becd0d0c-fe8d-4672-a746-05a80b18c670", "body": "", "latency": 0, "statusCode": 401, "label": "If the repository is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d9f3d8d7-d5f1-455f-8baf-32a469b78868", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository or build does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "81b29184-b64c-496a-9606-b46725eb07ca", "documentation": "These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log`.\nLike these tools, the DAG can be filtered.\n\n## GET /repositories/{workspace}/{repo_slug}/commits/\n\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all`).\n\n## GET /repositories/{workspace}/{repo_slug}/commits/?exclude=master\n\nReturns all commits in the repo that are not on master\n(similar to `git log --all ^master`).\n\n## GET /repositories/{workspace}/{repo_slug}/commits/?include=foo&include=bar&exclude=fu&exclude=fubar\n\nReturns all commits that are on refs `foo` or `bar`, but not on `fu` or\n`fubar` (similar to `git log foo bar ^fu ^fubar`).\n\nAn optional `path` parameter can be specified that will limit the\nresults to commits that affect that path. `path` can either be a file\nor a directory. If a directory is specified, commits are returned that\nhave modified any file in the directory tree rooted by `path`. It is\nimportant to note that if the `path` parameter is specified, the commits\nreturned by this endpoint may no longer be a DAG, parent commits that\ndo not modify the path will be omitted from the response.\n\n## GET /repositories/{workspace}/{repo_slug}/commits/?path=README.md&include=foo&include=bar&exclude=master\n\nReturns all commits that are on refs `foo` or `bar`, but not on `master`\nthat changed the file README.md.\n\n## GET /repositories/{workspace}/{repo_slug}/commits/?path=src/&include=foo&include=bar&exclude=master\n\nReturns all commits that are on refs `foo` or `bar`, but not on `master`\nthat changed to a file in any file in the directory src or its children.\n\nBecause the response could include a very large number of commits, it\nis paginated. Follow the 'next' link in the response to navigate to the\nnext page of commits. As with other paginated resources, do not\nconstruct your own links.\n\nWhen the include and exclude parameters are more than can fit in a\nquery string, clients can use a `x-www-form-urlencoded` POST instead.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commits", "responses": [ { "uuid": "1af9486e-6a8e-4426-9a6d-19a917f7783c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of commits", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "406ee5a2-6f8d-4060-8ea5-9f9d4be04371", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ef73b39a-9fa5-4f6c-811b-4f28cbeb575c", "documentation": "Identical to `GET /repositories/{workspace}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n\n**Note that this resource does NOT support new commit creation.**", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/commits", "responses": [ { "uuid": "268b2a59-1206-4e82-882f-dd7d67050b5f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of commits", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "69bf852c-6a70-487e-b68d-dd2e5c79f091", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "55ea578f-436a-465b-a1e6-d1617eecb4d8", "documentation": "These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log`.\nLike these tools, the DAG can be filtered.\n\n## GET /repositories/{workspace}/{repo_slug}/commits/master\n\nReturns all commits on rev `master` (similar to `git log master`).\n\n## GET /repositories/{workspace}/{repo_slug}/commits/dev?include=foo&exclude=master\n\nReturns all commits on ref `dev` or `foo`, except those that are reachable on\n`master` (similar to `git log dev foo ^master`).\n\nAn optional `path` parameter can be specified that will limit the\nresults to commits that affect that path. `path` can either be a file\nor a directory. If a directory is specified, commits are returned that\nhave modified any file in the directory tree rooted by `path`. It is\nimportant to note that if the `path` parameter is specified, the commits\nreturned by this endpoint may no longer be a DAG, parent commits that\ndo not modify the path will be omitted from the response.\n\n## GET /repositories/{workspace}/{repo_slug}/commits/dev?path=README.md&include=foo&include=bar&exclude=master\n\nReturns all commits that are on refs `dev` or `foo` or `bar`, but not on `master`\nthat changed the file README.md.\n\n## GET /repositories/{workspace}/{repo_slug}/commits/dev?path=src/&include=foo&exclude=master\n\nReturns all commits that are on refs `dev` or `foo`, but not on `master`\nthat changed to a file in any file in the directory src or its children.\n\nBecause the response could include a very large number of commits, it\nis paginated. Follow the 'next' link in the response to navigate to the\nnext page of commits. As with other paginated resources, do not\nconstruct your own links.\n\nWhen the include and exclude parameters are more than can fit in a\nquery string, clients can use a `x-www-form-urlencoded` POST instead.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/commits/:revision", "responses": [ { "uuid": "15266427-3e8e-4eaf-a284-6f73df9cbc06", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of commits", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d89fc6b7-f94d-411f-977a-62f99fbf8ddc", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified revision does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2d4d8e61-9f33-4fc8-85f6-dd8c51527725", "documentation": "Identical to `GET /repositories/{workspace}/{repo_slug}/commits/{revision}`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n\n**Note that this resource does NOT support new commit creation.**", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/commits/:revision", "responses": [ { "uuid": "d85c49eb-7e4d-44be-8a0c-3ecb7647787b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of commits", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "674cd8fd-99ab-4d27-8c1a-b9285c432002", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified revision does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1122815-5b48-4a82-b0ce-2e9f566b3601", "documentation": "Returns the components that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/components", "responses": [ { "uuid": "92c175ec-eabc-4288-9cd4-27adbc81bccc", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The components that have been defined in the issue tracker.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0f9a5961-c7af-4845-982b-c5caccf4b2be", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2957324e-e683-457c-9242-f3dc82eb0b5d", "documentation": "Returns the specified issue tracker component object.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/components/:component_id", "responses": [ { "uuid": "c41f4218-8d20-4c07-b33c-d43b52e00c1d", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The specified component object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "997e82d0-8f46-489e-b103-412ac0d8ad1b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or component does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4cd51326-9cb5-42d0-b379-f0c526a75c2c", "documentation": "Returns the repository's default reviewers.\n\nThese are the users that are automatically added as reviewers on every\nnew pull request that is created.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/default-reviewers", "responses": [ { "uuid": "e90b7933-27d7-4539-8d02-6e78d3d9904c", "body": "", "latency": 0, "statusCode": 200, "label": "The paginated list of default reviewers", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "34b20db8-50ec-4223-a144-6681d3deffc6", "documentation": "Removes a default reviewer from the repository.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/default-reviewers/:target_username", "responses": [ { "uuid": "2c609b51-b3d0-4af7-909a-9cec32d0d3b1", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b0a871fd-f930-4427-850d-4d9c227857b3", "documentation": "Returns the specified reviewer.\n\nThis can be used to test whether a user is among the repository's\ndefault reviewers list. A 404 indicates that that specified user is not\na default reviewer.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/default-reviewers/:target_username", "responses": [ { "uuid": "e22867f6-6471-4683-a72c-e8496052669f", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e28ee7a9-00b6-4b23-971e-eb8e250c6f57", "documentation": "Adds the specified user to the repository's list of default\nreviewers.\n\nThis method is idempotent. Adding a user a second time has no effect.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/default-reviewers/:target_username", "responses": [ { "uuid": "ec469885-c30e-42d8-be8e-35ec2099f8f6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fd7a4259-dc45-4fb0-8c46-88be89619708", "documentation": "Returns all deploy-keys belonging to a repository.\n\nExample:\n```\n$ curl -H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys\n\nOutput:\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"id\": 123,\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"label\": \"mykey\",\n \"type\": \"deploy_key\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"links\":{\n \"self\":{\n \"href\": \"https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/123\"\n }\n }\n \"last_used\": null,\n \"comment\": \"mleu@C02W454JHTD8\"\n }\n ],\n \"page\": 1,\n \"size\": 1\n}\n```", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/deploy-keys", "responses": [ { "uuid": "54ca9569-c928-4bea-a99e-5ae5a9b2017d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Deploy keys matching the repository", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a90cdaab-c82b-47c2-9b28-1d306ff51122", "body": "", "latency": 0, "statusCode": 403, "label": "If the specified user or repository is not accessible to the current user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c544327e-e712-4d02-bb1a-8c9790e8d682", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user or repository does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b195ebfb-0af5-4220-8aa1-40d59a6e45a7", "documentation": "Create a new deploy key in a repository. Note: If authenticating a deploy key\nwith an OAuth consumer, any changes to the OAuth consumer will subsequently\ninvalidate the deploy key.\n\n\nExample:\n```\n$ curl -XPOST \\\n-H \"Authorization \" \\\n-H \"Content-type: application/json\" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys -d \\\n'{\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 mleu@C02W454JHTD8\",\n \"label\": \"mydeploykey\"\n}'\n\nOutput:\n{\n \"id\": 123,\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"label\": \"mydeploykey\",\n \"type\": \"deploy_key\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"links\":{\n \"self\":{\n \"href\": \"https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/123\"\n }\n }\n \"last_used\": null,\n \"comment\": \"mleu@C02W454JHTD8\"\n}\n```", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/deploy-keys", "responses": [ { "uuid": "4805f7a1-d314-46d3-9f33-69ac986a3e0c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The deploy key that was created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0f7dc3c0-3e49-4ced-a5e3-dc80617878cc", "body": "", "latency": 0, "statusCode": 400, "label": "Invalid deploy key inputs", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0c181f36-63b9-4cd7-8d34-3b18983a7f35", "body": "", "latency": 0, "statusCode": 403, "label": "If the specified user or repository is not accessible to the current user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b49462a4-6446-4768-b27a-0809b70aced4", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user or repository does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c7090cbc-cd0a-4b80-927e-5e3d56cd266c", "documentation": "This deletes a deploy key from a repository.\n\nExample:\n```\n$ curl -XDELETE \\\n-H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234\n```", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/deploy-keys/:key_id", "responses": [ { "uuid": "d9306b78-e10a-4f83-b2c8-86f06565b201", "body": "", "latency": 0, "statusCode": 204, "label": "The key has been deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "791a1ee0-5463-4986-9166-5f9f716f72f4", "body": "", "latency": 0, "statusCode": 403, "label": "If the current user does not have permission to delete a key for the specified user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ffd88607-a7e3-42b2-b56a-a75a03de3912", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user, repository, or deploy key does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "85050d03-fe54-4f3e-ae26-bf04fb6a7dc4", "documentation": "Returns the deploy key belonging to a specific key.\n\nExample:\n```\n$ curl -H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-key/1234\n\nOutput:\n{\n \"comment\": \"mleu@C02W454JHTD8\",\n \"last_used\": null,\n \"links\": {\n \"self\": {\n \"href\": https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-key/1234\"\n }\n },\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"label\": \"mykey\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"id\": 1234,\n \"type\": \"deploy_key\"\n}\n```", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/deploy-keys/:key_id", "responses": [ { "uuid": "b34918ce-faef-47b2-a011-b590bd49db0f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Deploy key matching the key ID", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "997719f8-ae5b-46ca-a511-50af19de0cc2", "body": "", "latency": 0, "statusCode": 403, "label": "If the specified user or repository is not accessible to the current user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e6950d7c-3581-4ec7-9132-8c2d85b92dd9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user or repository does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f65fca8d-719e-4136-960e-745c9f448c85", "documentation": "Create a new deploy key in a repository.\n\nThe same key needs to be passed in but the comment and label can change.\n\nExample:\n```\n$ curl -XPUT \\\n-H \"Authorization \" \\\n-H \"Content-type: application/json\" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234 -d \\\n'{\n \"label\": \"newlabel\",\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 newcomment\",\n}'\n\nOutput:\n{\n \"comment\": \"newcomment\",\n \"last_used\": null,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234\"\n }\n },\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"label\": \"newlabel\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"id\": 1234,\n \"type\": \"deploy_key\"\n}\n```", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/deploy-keys/:key_id", "responses": [ { "uuid": "fba39d5e-22cb-4d12-ac02-883b1e7ee9b1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The newly updated deploy key.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9925f27d-1bc7-4749-b08c-a1e7f5a3bbb0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the submitted key or related value is invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b6d86f57-c7f0-4fd7-ba1e-16f88d8be201", "body": "", "latency": 0, "statusCode": 403, "label": "If the current user does not have permission to add a key for the specified user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "266b21fc-e911-49aa-bccf-559c310f12aa", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user, repository, or deploy key does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8e97428c-3668-4429-add8-5ba5fb0c88c7", "documentation": "Find deployments", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/deployments/", "responses": [ { "uuid": "bfb51d29-fe25-4878-867a-e753aeef32d1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The matching deployments.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c8880e68-33bc-4305-8aa3-6833f887e818", "documentation": "Retrieve a deployment", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/deployments/:deployment_uuid", "responses": [ { "uuid": "e214fc56-660d-4e49-93d0-b3db74e26bbd", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The deployment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "de99ff5b-abeb-4d05-acfe-e2a495e8f016", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "No account, repository or deployment with the UUID provided exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f22dc07b-f632-47d6-aac7-ac94e67d4b85", "documentation": "Find deployment environment level variables.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/deployments_config/environments/:environment_uuid/variables", "responses": [ { "uuid": "004acd6c-9619-4aa7-bd68-4d3c6c8c166e", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The retrieved deployment variables.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9631167f-a8f3-47a8-9f5e-73278e33bc23", "documentation": "Create a deployment environment level variable.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/deployments_config/environments/:environment_uuid/variables", "responses": [ { "uuid": "64a212f5-4196-434a-8282-8040163ef3d9", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The variable was created.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "300e72e3-62d2-4579-8b62-cdc404a69cf0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository, environment or variable with the given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b41a8fec-c413-4137-9389-fd6e56c94a5e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 409, "label": "A variable with the provided key already exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3939e6f9-4737-48e1-aac1-ad6765475f39", "documentation": "Delete a deployment environment level variable.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/deployments_config/environments/:environment_uuid/variables/:variable_uuid", "responses": [ { "uuid": "f8e4a0e3-35df-4e8d-b6c8-1d54a79bfd82", "body": "", "latency": 0, "statusCode": 204, "label": "The variable was deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7ca6e4f7-5ff1-480a-8241-8e3d480676f7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository, environment or variable with given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4235b796-825c-462e-b657-33db0c7858b2", "documentation": "Update a deployment environment level variable.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/deployments_config/environments/:environment_uuid/variables/:variable_uuid", "responses": [ { "uuid": "6bc7383b-aaa9-4c81-ba02-5b1d3d91f939", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The deployment variable was updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4f39ae77-ff42-4b80-be25-51b47de079af", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository, environment or variable with the given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3df9903f-be1e-4c66-be8c-687e56183eff", "documentation": "Produces a raw git-style diff.\n\n#### Single commit spec\n\nIf the `spec` argument to this API is a single commit, the diff is\nproduced against the first parent of the specified commit.\n\n#### Two commit spec\n\nTwo commits separated by `..` may be provided as the `spec`, e.g.,\n`3a8b42..9ff173`. When two commits are provided and the `merge` query\nparameter is true or absent, this API produces a 3-way diff, also\nreferred to as a merge diff. This is equivalent to merging the left\nbranch into the right branch and then computing the diff of the merge\ncommit against its first parent (the right branch). These diffs have\nthe same behavior as pull requests that show the 3-way diff, such as\nthe [Bitbucket Cloud Pull\nRequest](https://blog.developer.atlassian.com/a-better-pull-request/).\nFor a simple git-style diff, add `merge=false` to the query.\n\nThe two commits are interpreted as follows:\n\n* First commit: the commit containing the changes we wish to preview\n* Second commit: the commit representing the state to which we want to\n compare the first commit\n* **Note**: This is the opposite of the order used in `git diff`.\n\n#### Comparison to patches\n\nWhile similar to patches, diffs:\n\n* Don't have a commit header (username, commit message, etc)\n* Support the optional `path=foo/bar.py` query param to filter\n the diff to just that one file diff\n\n#### Response\n\nThe raw diff is returned as-is, in whatever encoding the files in the\nrepository use. It is not decoded into unicode. As such, the\ncontent-type is `text/plain`.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/diff/:spec", "responses": [ { "uuid": "31eb1da5-e978-4287-bb24-8f6cd2c03c80", "body": "", "latency": 0, "statusCode": 200, "label": "The raw diff", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "46973985-857a-4fc3-926c-7ff02388cc76", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 555, "label": "If the diff was too large and timed out.\n\nSince this endpoint does not employ any form of pagination, but\ninstead returns the diff as a single document, it can run into\ntrouble on very large diffs. If Bitbucket times out in cases\nlike these, a 555 status code is returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "674b52de-ac5c-4945-a896-c9b06cdea11d", "documentation": "Produces a response in JSON format with a record for every path\nmodified, including information on the type of the change and the\nnumber of lines added and removed.\n\n#### Single commit spec\n\nIf the `spec` argument to this API is a single commit, the diff is\nproduced against the first parent of the specified commit.\n\n#### Two commit spec\n\nTwo commits separated by `..` may be provided as the `spec`, e.g.,\n`3a8b42..9ff173`. When two commits are provided and the `merge` query\nparameter is true or absent, this API produces a 3-way diff, also\nreferred to as a merge diff. This is equivalent to merging the left\nbranch into the right branch and then computing the diff of the merge\ncommit against its first parent (the right branch). These diffs have\nthe same behavior as pull requests that show the 3-way diff, such as\nthe [Bitbucket Cloud Pull\nRequest](https://blog.developer.atlassian.com/a-better-pull-request/).\nFor a simple git-style diff, add `merge=false` to the query.\n\nThe two commits are interpreted as follows:\n\n* First commit: the commit containing the changes we wish to preview\n* Second commit: the commit representing the state to which we want to\n compare the first commit\n* **Note**: This is the opposite of the order used in `git diff`.\n\n#### Sample output\n```\ncurl https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/diffstat/d222fa2..e174964\n{\n \"pagelen\": 500,\n \"values\": [\n {\n \"type\": \"diffstat\",\n \"status\": \"modified\",\n \"lines_removed\": 1,\n \"lines_added\": 2,\n \"old\": {\n \"path\": \"setup.py\",\n \"escaped_path\": \"setup.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/src/e1749643d655d7c7014001a6c0f58abaf42ad850/setup.py\"\n }\n }\n },\n \"new\": {\n \"path\": \"setup.py\",\n \"escaped_path\": \"setup.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/src/d222fa235229c55dad20b190b0b571adf737d5a6/setup.py\"\n }\n }\n }\n }\n ],\n \"page\": 1,\n \"size\": 1\n}\n```", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/diffstat/:spec", "responses": [ { "uuid": "ecc372f2-9928-4aee-aa5d-b3e249f824d2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The diff stats", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c33c7a2c-79c8-4e17-b0ed-c6d0f4103bfa", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 555, "label": "If generating the diffstat timed out.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "771a58c1-2aa4-4035-8894-729599412260", "documentation": "Returns a list of download links associated with the repository.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/downloads", "responses": [ { "uuid": "f8ec24c3-2cb6-4bcd-b34a-7ef17d85279b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "392da920-d463-4082-a5f5-1acae28bea42", "documentation": "Upload new download artifacts.\n\nTo upload files, perform a `multipart/form-data` POST containing one\nor more `files` fields:\n\n $ echo Hello World > hello.txt\n $ curl -s -u evzijst -X POST https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads -F files=@hello.txt\n\nWhen a file is uploaded with the same name as an existing artifact,\nthen the existing file will be replaced.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/downloads", "responses": [ { "uuid": "f7d64762-e2fc-411c-9142-f8bc58d41ffa", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4de5e2a2-becc-450f-a51e-f0eca595291d", "documentation": "Deletes the specified download artifact from the repository.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/downloads/:filename", "responses": [ { "uuid": "134d0628-bed7-4700-916a-e68d1c3abded", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5c8941f8-3f57-46b9-aad5-e9c045a208a5", "documentation": "Return a redirect to the contents of a download artifact.\n\nThis endpoint returns the actual file contents and not the artifact's\nmetadata.\n\n $ curl -s -L https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads/hello.txt\n Hello World", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/downloads/:filename", "responses": [ { "uuid": "86d1c17a-ea47-4c24-97b3-154d8bfca4aa", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "558fdae6-784a-4427-9405-140aa8967b7a", "documentation": "Find environments", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/environments/", "responses": [ { "uuid": "fb3a91d0-7fd3-47c6-8404-b45fe2488147", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The matching environments.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "35273119-7c17-4bdc-a3f2-b74d0cd353cd", "documentation": "Create an environment.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/environments/", "responses": [ { "uuid": "07c0a191-258e-41a2-85a1-93df8f470d64", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The environment was created.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9142307f-85a6-4a72-a599-9aca888caec1", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "032a914d-6e13-4df5-82ab-ae9dae981648", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 409, "label": "An environment host with the provided name already exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8d50b88c-b488-48db-82db-78f95a201182", "documentation": "Delete an environment", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/environments/:environment_uuid", "responses": [ { "uuid": "030dcc0b-40e9-468e-b7bf-698b6815a24c", "body": "", "latency": 0, "statusCode": 204, "label": "The environment was deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "da27d64b-0617-4077-8412-5bc4c3e98813", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "No account or repository with the UUID provided exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bf3ef872-39dc-4dcd-a731-5a28b15df38f", "documentation": "Retrieve an environment", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/environments/:environment_uuid", "responses": [ { "uuid": "e34dc27b-2177-44d1-a9f2-bc56983b9eb3", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The environment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "08eabf93-4321-4589-91b0-6ae09ce9f728", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "No account, repository or environment with the UUID provided exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c245f54c-e163-4f53-8cbf-dfbea2a96256", "documentation": "Update an environment", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/environments/:environment_uuid/changes/", "responses": [ { "uuid": "933ed3b2-638e-4f83-a435-d877346e3acb", "body": "", "latency": 0, "statusCode": 202, "label": "The environment update request was accepted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "aef41397-4d9c-4bda-bd33-ddec1063b16a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "No account, repository or environment with the UUID provided exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5e5064e6-07a2-46cc-a173-1ac1c7a7b1cf", "documentation": "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\n $ hg log --follow \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](../../../../../../meta/filtering) the response to\nonly provide exactly the data you want.\n\nFor example, if you wanted to find commits made before 2011-05-18\nagainst a file named `README.rst`, but you only wanted the path and\ndate, your query would look like this:\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 \"values\": [\n {\n \"commit\": {\n \"date\": \"2011-05-17T07:32:09+00:00\"\n },\n \"path\": \"README.rst\"\n },\n {\n \"commit\": {\n \"date\": \"2011-05-16T06:33:28+00:00\"\n },\n \"path\": \"README.txt\"\n },\n {\n \"commit\": {\n \"date\": \"2011-05-16T06:15:39+00:00\"\n },\n \"path\": \"README.txt\"\n }\n ]\n}\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`.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/filehistory/:commit/:path", "responses": [ { "uuid": "87952408-d360-4d97-87e6-fdef74989bf7", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of commits that modified the specified file", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ff0c2b5e-570b-474a-9e7c-0760961d9fd5", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dccff19e-4d9a-4cc1-9a56-cb37cf9c9147", "documentation": "Returns a paginated list of all the forks of the specified\nrepository.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/forks", "responses": [ { "uuid": "53bcfed5-be1d-48cc-bc7a-209a60651b9e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "All forks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "33ac372a-52f9-401a-b62e-4c32471f137a", "documentation": "Creates a new fork of the specified repository.\n\n## Forking a repository\n\nTo create a fork, specify the workspace explicitly as part of the\nrequest body:\n\n```\n$ curl -X POST -u jdoe https://api.bitbucket.org/2.0/repositories/atlassian/bbql/forks \\\n -H 'Content-Type: application/json' -d '{\n \"name\": \"bbql_fork\",\n \"workspace\": {\n \"slug\": \"atlassian\"\n }\n}'\n```\n\nTo fork a repository into the same workspace, also specify a new `name`.\n\nWhen you specify a value for `name`, it will also affect the `slug`.\nThe `slug` is reflected in the repository URL of the new fork. It is\nderived from `name` by substituting non-ASCII characters, removes\nwhitespace, and changes characters to lower case. For example,\n`My repo` would turn into `my_repo`.\n\nYou need contributor access to create new forks within a workspace.\n\n\n## Change the properties of a new fork\n\nBy default the fork inherits most of its properties from the parent.\nHowever, since the optional POST body document follows the normal\n`repository` JSON schema and you can override the new fork's\nproperties.\n\nProperties that can be overridden include:\n\n* description\n* fork_policy\n* language\n* mainbranch\n* is_private (note that a private repo's fork_policy might prohibit\n the creation of public forks, in which `is_private=False` would fail)\n* has_issues (to initialize or disable the new repo's issue tracker --\n note that the actual contents of the parent repository's issue\n tracker are not copied during forking)\n* has_wiki (to initialize or disable the new repo's wiki --\n note that the actual contents of the parent repository's wiki are not\n copied during forking)\n* project (when forking into a private project, the fork's `is_private`\n must be `true`)\n\nProperties that cannot be modified include:\n\n* scm\n* parent\n* full_name", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/forks", "responses": [ { "uuid": "dd8ad0f6-c2ba-4d9e-85a3-ce3a3776aeb5", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The newly created fork.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4bc6b6db-dd5d-48e2-8071-8c45964602ed", "documentation": "Returns a paginated list of webhooks installed on this repository.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/hooks", "responses": [ { "uuid": "71f3e915-17af-44ed-969b-08bf656ac5b3", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The paginated list of installed webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "890f725a-9448-4b8c-a112-1c6ac026ec31", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to access the webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "69e9e1d5-41d6-482d-a327-508c92f031d9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "64ee6180-cb44-475f-a326-cbc7e47e3d8b", "documentation": "Creates a new webhook on the specified repository.\n\nExample:\n\n```\n$ curl -X POST -u credentials -H 'Content-Type: application/json'\n https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo-slug/hooks\n -d '\n {\n \"description\": \"Webhook Description\",\n \"url\": \"https://example.com/\",\n \"active\": true,\n \"events\": [\n \"repo:push\",\n \"issue:created\",\n \"issue:updated\"\n ]\n }'\n```\n\nNote that this call requires the webhook scope, as well as any scope\nthat applies to the events that the webhook subscribes to. In the\nexample above that means: `webhook`, `repository` and `issue`.\n\nAlso note that the `url` must properly resolve and cannot be an\ninternal, non-routed address.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/hooks", "responses": [ { "uuid": "fec7c8de-9a56-475d-b3ea-117ae9defc12", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "If the webhook was registered successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "33329587-1a10-4bc8-a63d-f53e6a7cf5fb", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to install webhooks on the specified repository.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2c19aa92-0a31-4db8-9188-a61ca00a0c1e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "41cfa58f-4781-4292-8de5-8a993a594696", "documentation": "Deletes the specified webhook subscription from the given\nrepository.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/hooks/:uid", "responses": [ { "uuid": "11ad0485-1b50-4244-8122-0d8012972907", "body": "", "latency": 0, "statusCode": 204, "label": "When the webhook was deleted successfully", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "24fa686d-66b8-407e-ab21-7c0160a926cb", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to delete the webhook.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a8ce08fa-a7bd-4177-869f-72f3d93783cd", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "74b25c8c-2084-478b-80fd-7a4d73fc3342", "documentation": "Returns the webhook with the specified id installed on the specified\nrepository.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/hooks/:uid", "responses": [ { "uuid": "0891b5d5-f0db-43e0-b08b-25fb9a76a88c", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The webhook subscription object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c8e05362-0cca-4332-b42c-41b8377cb6c2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c76b532e-0ab8-4389-bbf3-54e08f376693", "documentation": "Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/hooks/:uid", "responses": [ { "uuid": "b1bb905b-392f-4102-8f6c-06589f5cc853", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The webhook subscription object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ad1b8b96-cd78-403f-9115-f49cf8d55e40", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to update the webhook.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5cf1bc50-f930-4c79-820b-e49ab8258dd6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0df78279-2937-41b7-824d-e1cbb35ff267", "documentation": "Returns the issues in the issue tracker.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues", "responses": [ { "uuid": "fe4acc61-488c-41b4-9a4f-c57e4f22f3ae", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of the issues matching any filter criteria that were provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5eb56e55-4a11-4b78-a516-076cec010dcf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4f32c1ec-5e94-46a7-904d-7e38e96b3925", "documentation": "Creates a new issue.\n\nThis call requires authentication. Private repositories or private\nissue trackers require the caller to authenticate with an account that\nhas appropriate authorization.\n\nThe authenticated user is used for the issue's `reporter` field.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/issues", "responses": [ { "uuid": "5859eb15-9aea-408f-b43e-1af3a0ae6b2c", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The newly created issue.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "99d88f0e-5e2d-4143-ad0c-05c6b36af676", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "When the request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "58f76bd4-10b9-46b0-a5cc-89549f7a5670", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "When the authenticated user isn't authorized to create the issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7db92724-06bf-42de-afe9-db6dde152396", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8298662f-e1d6-43cb-a0d4-f62a2d07a081", "documentation": "A POST request to this endpoint initiates a new background celery task that archives the repo's issues.\n\nFor example, you can run:\n\ncurl -u -X POST http://api.bitbucket.org/2.0/repositories///\nissues/export\n\nWhen the job has been accepted, it will return a 202 (Accepted) along with a unique url to this job in the\n'Location' response header. This url is the endpoint for where the user can obtain their zip files.\"", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/issues/export", "responses": [ { "uuid": "4673b01a-a644-47fc-8df7-c29542cc7e49", "body": "", "latency": 0, "statusCode": 202, "label": "The export job has been accepted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "dd770d76-f318-494a-af11-77437e6c1a2a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated properly", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a2d2a6cf-3db3-4b69-8076-d1eec3c2df58", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "When the authenticated user does not have admin permission on the repo", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "72aaac48-095c-444d-a44b-586787e63ad3", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The repo does not exist or does not have an issue tracker", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "64cdbf0d-f87f-4d4c-b0b3-7694bb7177a7", "documentation": "This endpoint is used to poll for the progress of an issue export\njob and return the zip file after the job is complete.\nAs long as the job is running, this will return a 200 response\nwith in the response body a description of the current status.\n\nAfter the job has been scheduled, but before it starts executing, this\nendpoint's response is:\n\n{\n \"type\": \"issue_job_status\",\n \"status\": \"ACCEPTED\",\n \"phase\": \"Initializing\",\n \"total\": 0,\n \"count\": 0,\n \"pct\": 0\n}\n\n\nThen once it starts running, it becomes:\n\n{\n \"type\": \"issue_job_status\",\n \"status\": \"STARTED\",\n \"phase\": \"Attachments\",\n \"total\": 15,\n \"count\": 11,\n \"pct\": 73\n}\n\nOnce the job has successfully completed, it returns a stream of the zip file.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/export/:repo_name-issues-:task_id.zip", "responses": [ { "uuid": "f7fa1f38-135c-46ba-aa39-674e0d585324", "body": "{\n \"count\": {{faker 'number.int' max=99999}},\n \"pct\": {{faker 'number.int' max=99999}},\n \"phase\": \"\",\n \"status\": \"{{oneOf (array 'ACCEPTED' 'STARTED' 'RUNNING' 'FAILURE')}}\",\n \"total\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n}", "latency": 0, "statusCode": 202, "label": "Export job accepted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b1c5490f-677a-43bc-8978-7874de098287", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated properly", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dbd287d3-f8be-49bd-9195-1094ab57b7e8", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "When the authenticated user does not have admin permission on the repo", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ff519289-d2d4-4851-a5d2-26b48b2ab1a9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "No export job has begun", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d2a18fbf-f4a3-4a8e-8e09-105d78bb78da", "documentation": "When using GET, this endpoint reports the status of the current import task. Request example:\n\n```\n$ curl -u -X GET https://api.bitbucket.org/2.0/repositories///issues/import\n```\n\nAfter the job has been scheduled, but before it starts executing, this endpoint's response is:\n\n```\n< HTTP/1.1 202 Accepted\n{\n \"type\": \"issue_job_status\",\n \"status\": \"PENDING\",\n \"phase\": \"Attachments\",\n \"total\": 15,\n \"count\": 0,\n \"percent\": 0\n}\n```\n\nOnce it starts running, it is a 202 response with status STARTED and progress filled.\n\nAfter it is finished, it becomes a 200 response with status SUCCESS or FAILURE.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/import", "responses": [ { "uuid": "e9560a92-86c3-4ced-9e7c-3fc1fdbce52f", "body": "{\n \"count\": {{faker 'number.int' max=99999}},\n \"pct\": {{faker 'number.int' max=99999}},\n \"phase\": \"\",\n \"status\": \"{{oneOf (array 'ACCEPTED' 'STARTED' 'RUNNING' 'FAILURE')}}\",\n \"total\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Import job complete with either FAILURE or SUCCESS status", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ea3c052c-149a-492b-9cd5-ddb6e7dc0d6e", "body": "{\n \"count\": {{faker 'number.int' max=99999}},\n \"pct\": {{faker 'number.int' max=99999}},\n \"phase\": \"\",\n \"status\": \"{{oneOf (array 'ACCEPTED' 'STARTED' 'RUNNING' 'FAILURE')}}\",\n \"total\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n}", "latency": 0, "statusCode": 202, "label": "Import job started", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5ae08688-7c70-4e29-8b99-8fabc9bafcda", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated properly", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2d0fb703-9234-4880-ae37-00ad1f88e399", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "When the authenticated user does not have admin permission on the repo", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "15105ab8-3bef-4a03-a3e2-4dfb4c48d4d4", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "No export job has begun", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d4a56835-2d1a-4ea4-8d55-4edffbac8992", "documentation": "A POST request to this endpoint will import the zip file given by the archive parameter into the repository. All\nexisting issues will be deleted and replaced by the contents of the imported zip file.\n\nImports are done through a multipart/form-data POST. There is one valid and required form field, with the name\n\"archive,\" which needs to be a file field:\n\n```\n$ curl -u -X POST -F archive=@/path/to/file.zip https://api.bitbucket.org/2.0/repositories///issues/import\n```\n\nWhen the import job is accepted, here is example output:\n\n```\n< HTTP/1.1 202 Accepted\n\n{\n \"type\": \"issue_job_status\",\n \"status\": \"ACCEPTED\",\n \"phase\": \"Attachments\",\n \"total\": 15,\n \"count\": 0,\n \"percent\": 0\n}\n```", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/issues/import", "responses": [ { "uuid": "36964b98-2391-4685-b7b0-9dbe9e07b3c0", "body": "{\n \"count\": {{faker 'number.int' max=99999}},\n \"pct\": {{faker 'number.int' max=99999}},\n \"phase\": \"\",\n \"status\": \"{{oneOf (array 'ACCEPTED' 'STARTED' 'RUNNING' 'FAILURE')}}\",\n \"total\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n}", "latency": 0, "statusCode": 202, "label": "Import job accepted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c926250d-ca6a-40cf-b667-e3f311952a63", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated properly", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e2020254-c853-4ad0-815c-f404de83b8a4", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "When the authenticated user does not have admin permission on the repo", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "523c2c8e-eeb6-4d69-91f2-4eb3e88479d1", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "No export job has begun", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9c98455f-a56e-400a-b3f6-73b2bc22f8c2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 409, "label": "Import already running", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6029f56b-2699-4f71-a3dd-b8b9d599189d", "documentation": "Deletes the specified issue. This requires write access to the\nrepository.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id", "responses": [ { "uuid": "c203a2c9-fa2c-4423-a24b-59e1a8f79616", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The issue object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2e689a39-8201-43f9-8329-a5d26f639051", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "When the authenticated user isn't authorized to delete the issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "20012d2a-f0e9-4963-a6b0-d41fbe8f73e5", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6973256f-44ef-4263-b353-156540d843ed", "documentation": "Returns the specified issue.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id", "responses": [ { "uuid": "cbb88add-8444-49f7-90fd-31fb2aec4407", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The issue object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d38b48d9-e97c-46a2-a8fd-4a1c632ccc59", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "When the authenticated user isn't authorized to access the issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0d55be3e-c8c0-41a8-9f5a-bf3fcea61e16", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fae89488-d1cf-4554-8486-790d997ffc0b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 410, "label": "The specified issue is unavailable.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "84b05477-c328-42c3-827f-6003ec965ee1", "documentation": "Modifies the issue.\n\n```\n$ curl https://api.bitbucket.org/2.0/repostories/evzijst/dogslow/issues/123 \\\n -u evzijst -s -X PUT -H 'Content-Type: application/json' \\\n -d '{\n \"title\": \"Updated title\",\n \"assignee\": {\n \"username\": \"evzijst\"\n },\n \"priority\": \"minor\",\n \"version\": {\n \"name\": \"1.0\"\n },\n \"component\": null\n}'\n```\n\nThis example changes the `title`, `assignee`, `priority` and the\n`version`. It also removes the value of the `component` from the issue\nby setting the field to `null`. Any field not present keeps its existing\nvalue.\n\nEach time an issue is edited in the UI or through the API, an immutable\nchange record is created under the `/issues/123/changes` endpoint. It\nalso has a comment associated with the change.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id", "responses": [ { "uuid": "5542da79-b267-442c-b938-6ccc9bdae3e2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The updated issue object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "912c84b1-1429-4c1b-b52a-10753d0ef754", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "When the authenticated user isn't authorized to access the issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5cf35934-18cf-416b-bb4e-97afad03e9ce", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ef0340f2-f997-4830-8b81-1edc9b59e54a", "documentation": "Returns all attachments for this issue.\n\nThis returns the files' meta data. This does not return the files'\nactual contents.\n\nThe files are always ordered by their upload date.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/attachments", "responses": [ { "uuid": "a633337d-2811-4f7f-a72b-a7ef8bd4dddb", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of all attachments for this issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9c8fe65c-49de-4e97-ab95-98df1dd24644", "body": "", "latency": 0, "statusCode": 401, "label": "If the issue tracker is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9203f699-f5bd-412a-b196-f85cdab2c670", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ac6925ae-b2f6-44f5-a7d4-ccb3b1a6713f", "documentation": "Upload new issue attachments.\n\nTo upload files, perform a `multipart/form-data` POST containing one\nor more file fields.\n\nWhen a file is uploaded with the same name as an existing attachment,\nthen the existing file will be replaced.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/attachments", "responses": [ { "uuid": "31d7c09a-e72d-4491-ae01-50bded38b067", "body": "", "latency": 0, "statusCode": 201, "label": "An empty response document.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cc10eb9f-db28-4c00-b5fd-bd7ed5c80641", "body": "", "latency": 0, "statusCode": 400, "label": "If no files were uploaded, or if the wrong `Content-Type` was used.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aebf96df-515f-41a9-9bd3-e2542adb79c5", "body": "", "latency": 0, "statusCode": 401, "label": "If the issue tracker is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d1fb1ffa-2ade-423e-ab91-f017cdf828ba", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6540d9e9-6e74-4e38-a5b2-84ab96937cd1", "documentation": "Deletes an attachment.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/attachments/:path", "responses": [ { "uuid": "0badf6b6-b709-47fe-88e4-cb42bf01c985", "body": "", "latency": 0, "statusCode": 204, "label": "Indicates that the deletion was successful", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "afe6f16a-4a9e-4e71-9e3b-272c4560f4cd", "body": "", "latency": 0, "statusCode": 401, "label": "If the issue tracker is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6dba6808-8207-4d35-a415-0f618f4d9ba2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "28ccdea8-e415-41a5-b187-fd2f39c3c899", "documentation": "Returns the contents of the specified file attachment.\n\nNote that this endpoint does not return a JSON response, but instead\nreturns a redirect pointing to the actual file that in turn will return\nthe raw contents.\n\nThe redirect URL contains a one-time token that has a limited lifetime.\nAs a result, the link should not be persisted, stored, or shared.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/attachments/:path", "responses": [ { "uuid": "512a768b-1e9e-424d-a4c8-155b8b4dd012", "body": "", "latency": 0, "statusCode": 302, "label": "A redirect to the file's contents", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ec828de0-443a-4af4-85d4-0000d7499ed1", "body": "", "latency": 0, "statusCode": 401, "label": "If the issue tracker is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ad77b642-de56-40f4-9002-ad9d1ead750e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b9a0ab52-adaa-41e5-bfd0-d6d76a07abd0", "documentation": "Returns the list of all changes that have been made to the specified\nissue. Changes are returned in chronological order with the oldest\nchange first.\n\nEach time an issue is edited in the UI or through the API, an immutable\nchange record is created under the `/issues/123/changes` endpoint. It\nalso has a comment associated with the change.\n\nNote that this operation is changing significantly, due to privacy changes.\nSee the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#changes-to-the-issue-changes-api)\nfor details.\n\n```\n$ curl -s https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1/changes - | jq .\n\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"changes\": {\n \"priority\": {\n \"new\": \"trivial\",\n \"old\": \"major\"\n },\n \"assignee\": {\n \"new\": \"\",\n \"old\": \"evzijst\"\n },\n \"assignee_account_id\": {\n \"new\": \"\",\n \"old\": \"557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443\"\n },\n \"kind\": {\n \"new\": \"enhancement\",\n \"old\": \"bug\"\n }\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1/changes/2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst/dogslow/issues/1#comment-2\"\n }\n },\n \"issue\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1\"\n }\n },\n \"type\": \"issue\",\n \"id\": 1,\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst/dogslow\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/evzijst/dogslow/avatar/32/\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"dogslow\",\n \"full_name\": \"evzijst/dogslow\",\n \"uuid\": \"{988b17c6-1a47-4e70-84ee-854d5f012bf6}\"\n },\n \"title\": \"Updated title\"\n },\n \"created_on\": \"2018-03-03T00:35:28.353630+00:00\",\n \"user\": {\n \"username\": \"evzijst\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"evzijst\",\n \"type\": \"user\",\n \"uuid\": \"{aaa7972b-38af-4fb1-802d-6e3854c95778}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst/\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/evzijst/avatar/32/\"\n }\n }\n },\n \"message\": {\n \"raw\": \"Removed assignee, changed kind and priority.\",\n \"markup\": \"markdown\",\n \"html\": \"

Removed assignee, changed kind and priority.

\",\n \"type\": \"rendered\"\n },\n \"type\": \"issue_change\",\n \"id\": 2\n }\n ],\n \"page\": 1\n}\n```\n\nChanges support [filtering and sorting](../../../meta/filtering) that\ncan be used to search for specific changes. For instance, to see\nwhen an issue transitioned to \"resolved\":\n\n```\n$ curl -s https://api.bitbucket.org/2.0/repositories/site/master/issues/1/changes \\\n -G --data-urlencode='q=changes.state.new = \"resolved\"'\n```\n\nThis resource is only available on repositories that have the issue\ntracker enabled.\n\nN.B.\n\nThe `changes.assignee` and `changes.assignee_account_id` fields are not\na `user` object. Instead, they contain the raw `username` and\n`account_id` of the user. This is to protect the integrity of the audit\nlog even after a user account gets deleted.\n\nThe `changes.assignee` field is deprecated will disappear in the\nfuture. Use `changes.assignee_account_id` instead.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/changes", "responses": [ { "uuid": "444b216a-43db-452a-9582-2b076bc8a1cc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Returns all the issue changes that were made on the specified issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9b0b67c0-a322-48dc-aa34-8bdb267bc73a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dc2e2e07-2dba-4622-b4af-0113e13583ae", "documentation": "Makes a change to the specified issue.\n\nFor example, to change an issue's state and assignee, create a new\nchange object that modifies these fields:\n\n```\ncurl https://api.bitbucket.org/2.0/site/master/issues/1234/changes \\\n -s -u evzijst -X POST -H \"Content-Type: application/json\" \\\n -d '{\n \"changes\": {\n \"assignee_account_id\": {\n \"new\": \"557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443\"\n },\n \"state\": {\n \"new\": 'resolved\"\n }\n }\n \"message\": {\n \"raw\": \"This is now resolved.\"\n }\n }'\n```\n\nThe above example also includes a custom comment to go alongside the\nchange. This comment will also be visible on the issue page in the UI.\n\nThe fields of the `changes` object are strings, not objects. This\nallows for immutable change log records, even after user accounts,\nmilestones, or other objects recorded in a change entry, get renamed or\ndeleted.\n\nThe `assignee_account_id` field stores the account id. When POSTing a\nnew change and changing the assignee, the client should therefore use\nthe user's account_id in the `changes.assignee_account_id.new` field.\n\nThis call requires authentication. Private repositories or private\nissue trackers require the caller to authenticate with an account that\nhas appropriate authorization.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/changes", "responses": [ { "uuid": "bc0edd2e-4deb-4a88-8353-e8647ac8c9c9", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The newly created issue change.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a570dae6-94c9-4668-a358-ebe0b0494e6e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "When the request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cd459413-da9d-4b63-bca0-92e15437f762", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "When the authenticated user isn't authorized to modify the issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e59c642a-2673-4d93-943d-df80bf068bc6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3dc89478-1b66-470e-b09a-fcef8d9e96f6", "documentation": "Returns the specified issue change object.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/changes/:change_id", "responses": [ { "uuid": "49bc373b-7a6d-4b49-ad86-f8a396069fa0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The specified issue change object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "31ce63c0-76f3-4dc5-bbaa-041db4e6b949", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue change does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "231b6361-dbd2-41de-848d-25d2959d621a", "documentation": "Returns a paginated list of all comments that were made on the\nspecified issue.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../../../../../meta/filtering) for more details.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/comments", "responses": [ { "uuid": "4f5bf71a-2d89-4832-9e9b-1de40a445ab6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of issue comments.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "50d33052-c2ca-43b2-bc25-e90904258e8e", "documentation": "Creates a new issue comment.\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/ \\\n -X POST -u evzijst \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\": {\"raw\": \"Lorem ipsum.\"}}'\n```", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/comments", "responses": [ { "uuid": "9929cd63-1ac5-49db-a8cd-8423356789b8", "body": "", "latency": 0, "statusCode": 201, "label": "The newly created comment.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1c873449-8d72-4c77-91e1-922633f63dbe", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the input was invalid, or if the comment being created is detected as spam ", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "60f9f01f-d347-47c4-b97d-ea02c8bd87c9", "documentation": "Deletes the specified comment.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/comments/:comment_id", "responses": [ { "uuid": "3a8d9801-c051-48f9-86e2-fd2266c5f634", "body": "", "latency": 0, "statusCode": 204, "label": "Indicates successful deletion.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7af7b7a1-ac15-4941-b308-d791364e50e4", "documentation": "Returns the specified issue comment object.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/comments/:comment_id", "responses": [ { "uuid": "b60b25a1-bc27-47ea-94bf-c40184eac09a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The issue comment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "19e2d7d1-212f-401e-8553-8d9c152e611b", "documentation": "Updates the content of the specified issue comment. Note that only\nthe `content.raw` field can be modified.\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/5728901 \\\n -X PUT -u evzijst \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\": {\"raw\": \"Lorem ipsum.\"}'\n```", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/comments/:comment_id", "responses": [ { "uuid": "5fa489ce-a71c-441b-acdd-299659e84b59", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The updated issue comment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fa21aa36-0b19-4cda-994d-b625629518da", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the input was invalid, or if the update to the comment is detected as spam ", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "08804dcd-e675-4bd3-b5b0-ddcedd5539b2", "documentation": "Retract your vote.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/vote", "responses": [ { "uuid": "7b57516b-c3d2-4a37-b432-6a9c25a8285e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4dc27216-b802-4e34-8e69-800ff09fd3eb", "documentation": "Check whether the authenticated user has voted for this issue.\nA 204 status code indicates that the user has voted, while a 404\nimplies they haven't.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/vote", "responses": [ { "uuid": "a3923353-ab02-43e8-be8c-ef9909e47615", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 204, "label": "If the authenticated user has not voted for this issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8f0f632c-e523-4268-8933-1ba1a43b88e6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "When the request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "99417567-2155-4afb-9d98-d4163c82e3ff", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the authenticated user has not voted for this issue, or when the repo does not exist, or does not have an issue tracker.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5a90e1d6-31a2-4da4-8aa9-2cdb12ed32ef", "documentation": "Vote for this issue.\n\nTo cast your vote, do an empty PUT. The 204 status code indicates that\nthe operation was successful.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/vote", "responses": [ { "uuid": "fe2edce8-6e7b-450c-bb99-3b56211d6ca7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 204, "label": "Indicating the authenticated user has cast their vote successfully.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "67eeef62-e205-4f1a-b78d-db94a5a3cbeb", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "When the request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "641b5633-93c1-4f21-a98a-79da4d20505c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "26765860-fd68-4ab4-95d1-70da324a5b4a", "documentation": "Stop watching this issue.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/watch", "responses": [ { "uuid": "37b96606-ce5b-43da-92dc-4de14592066c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 204, "label": "Indicates that the authenticated user successfully stopped watching this issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "729510e5-9be6-4b69-9f17-541aae2f99e0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "When the request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b0f3fd78-107a-41de-872b-1dad8b8050b3", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or issue does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "91c8f4a1-4d0d-48a8-b433-97f9971f46ec", "documentation": "Indicated whether or not the authenticated user is watching this\nissue.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/watch", "responses": [ { "uuid": "39fcb6f4-8cf1-4bdf-83eb-a9eb6de2bdad", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 204, "label": "If the authenticated user is watching this issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4b6157e7-0505-4f8c-8b77-3e43beb37071", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "When the request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9c80b780-2255-44a3-a0f0-b3d6937eb27c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the authenticated user is not watching this issue, or when the repo does not exist, or does not have an issue tracker.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f922b630-aef6-4d5e-8e53-1d966c1aad5e", "documentation": "Start watching this issue.\n\nTo start watching this issue, do an empty PUT. The 204 status code\nindicates that the operation was successful.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/issues/:issue_id/watch", "responses": [ { "uuid": "e5bc6dae-0d2f-40b6-a910-70aeb8c5a999", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 204, "label": "Indicates that the authenticated user successfully started watching this issue.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e86b9329-880a-4176-b4fd-60b4b8a204ac", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "When the request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "26961099-99e6-4e7c-b7d2-b870076ddb60", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the authenticated user is not watching this issue, or when the repo does not exist, or does not have an issue tracker.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4effe63d-206f-4542-a50b-95c7c197f79a", "documentation": "Returns the best common ancestor between two commits, specified in a revspec\nof 2 commits (e.g. 3a8b42..9ff173).\n\nIf more than one best common ancestor exists, only one will be returned. It is\nunspecified which will be returned.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/merge-base/:revspec", "responses": [ { "uuid": "3aee1442-7174-4128-ae23-bbc91dc4265b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The merge base of the provided spec.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "22c0edec-f1bd-46bf-8e36-e20cdaf820f0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8ff63b0a-7296-4596-9bc1-0121e6612f81", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to any of the repositories specified.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "300675e5-c53d-4627-882d-c09c44f932c2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository or ref in the spec does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "912a0b18-c9a1-45a6-a187-048a471b57cf", "documentation": "Returns the milestones that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/milestones", "responses": [ { "uuid": "60849db7-e7b2-4c79-8351-50ebc9d8ba80", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The milestones that have been defined in the issue tracker.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0a8e587c-e233-4526-b51a-f870921a0a86", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3a7123b4-9fb8-467b-b3d3-ee566b008f29", "documentation": "Returns the specified issue tracker milestone object.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/milestones/:milestone_id", "responses": [ { "uuid": "dbb2b581-4c2f-403e-b900-e648021d958b", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The specified milestone object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ff1125a1-509d-431e-87e9-835a9a3e44dd", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or milestone does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3da3b545-b545-4dc7-babb-9c4a9d5677f4", "documentation": "Produces a raw patch for a single commit (diffed against its first\nparent), or a patch-series for a revspec of 2 commits (e.g.\n`3a8b42..9ff173` where the first commit represents the source and the\nsecond commit the destination).\n\nIn case of the latter (diffing a revspec), a patch series is returned\nfor the commits on the source branch (`3a8b42` and its ancestors in\nour example). For Mercurial, a single patch is returned that combines\nthe changes of all commits on the source branch.\n\nWhile similar to diffs, patches:\n\n* Have a commit header (username, commit message, etc)\n* Do not support the `path=foo/bar.py` query parameter\n\nThe raw patch is returned as-is, in whatever encoding the files in the\nrepository use. It is not decoded into unicode. As such, the\ncontent-type is `text/plain`.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/patch/:spec", "responses": [ { "uuid": "8eb402a4-b66c-469e-b098-c8f0816befd7", "body": "", "latency": 0, "statusCode": 200, "label": "The raw patches", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "daaf000b-8f5f-471a-8192-fb463dd36a70", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 555, "label": "If the diff was too large and timed out.\n\nSince this endpoint does not employ any form of pagination, but\ninstead returns the diff as a single document, it can run into\ntrouble on very large diffs. If Bitbucket times out in cases\nlike these, a 555 status code is returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d16f5447-4954-4618-a41e-66dd155db566", "documentation": "Retrieve the repository pipelines caches.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines-config/caches/", "responses": [ { "uuid": "a505a48f-89b8-47c4-94d1-9808c43b7871", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The list of caches for the given repository.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "90b3ff35-0dd1-48db-aab6-14a4e082e531", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or repository was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5146e5ae-8078-4721-82eb-a437abd4dc3a", "documentation": "Delete a repository cache.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/pipelines-config/caches/:cache_uuid", "responses": [ { "uuid": "8b9ae96a-c0e2-410a-b379-b8caa379b5a4", "body": "", "latency": 0, "statusCode": 204, "label": "The cache was deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d77a45d3-c828-42cc-94fb-3d691678a89f", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The workspace, repository or cache_uuid with given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ea02e100-cd8e-442e-8f9e-766995c9420b", "documentation": "Retrieve the URI of the content of the specified cache.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines-config/caches/:cache_uuid/content-uri", "responses": [ { "uuid": "2bac1c1b-bfe7-4c0a-8b23-9cb71674ffe0", "body": "{\n \"uri\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The cache content uri.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d8b99e36-368a-4c0f-bdd2-67ac73398ce2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The workspace, repository or cache_uuid with given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "14a866a3-1361-4f9a-9882-821257972876", "documentation": "Find pipelines", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines/", "responses": [ { "uuid": "1af30630-a800-4a7a-b485-d8ee4a4c1987", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The matching pipelines.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "be7292b1-f39a-47ea-8882-0917f1cf8ff3", "documentation": "Endpoint to create and initiate a pipeline.\nThere are a couple of different options to initiate a pipeline, where the payload of the request will determine which type of pipeline will be instantiated.\n# Trigger a Pipeline for a branch\nOne way to trigger pipelines is by specifying the branch for which you want to trigger a pipeline.\nThe specified branch will be used to determine which pipeline definition from the `bitbucket-pipelines.yml` file will be applied to initiate the pipeline. The pipeline will then do a clone of the repository and checkout the latest revision of the specified branch.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"ref_type\": \"branch\",\n \"type\": \"pipeline_ref_target\",\n \"ref_name\": \"master\"\n }\n }'\n```\n# Trigger a Pipeline for a commit on a branch or tag\nYou can initiate a pipeline for a specific commit and in the context of a specified reference (e.g. a branch, tag or bookmark).\nThe specified reference will be used to determine which pipeline definition from the bitbucket-pipelines.yml file will be applied to initiate the pipeline. The pipeline will clone the repository and then do a checkout the specified reference.\n\nThe following reference types are supported:\n\n* `branch`\n* `named_branch`\n* `bookmark`\n * `tag`\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"ce5b7431602f7cbba007062eeb55225c6e18e956\"\n },\n \"ref_type\": \"branch\",\n \"type\": \"pipeline_ref_target\",\n \"ref_name\": \"master\"\n }\n }'\n```\n# Trigger a specific pipeline definition for a commit\nYou can trigger a specific pipeline that is defined in your `bitbucket-pipelines.yml` file for a specific commit.\nIn addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition. The resulting pipeline will then clone the repository and checkout the specified revision.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"hash\":\"a3c4e02c9a3755eccdc3764e6ea13facdf30f923\",\n \"type\":\"commit\"\n },\n \"selector\": {\n \"type\":\"custom\",\n \"pattern\":\"Deploy to production\"\n },\n \"type\":\"pipeline_commit_target\"\n }\n }'\n```\n# Trigger a specific pipeline definition for a commit on a branch or tag\nYou can trigger a specific pipeline that is defined in your `bitbucket-pipelines.yml` file for a specific commit in the context of a specified reference.\nIn addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition, as well as the reference information. The resulting pipeline will then clone the repository a checkout the specified reference.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"hash\":\"a3c4e02c9a3755eccdc3764e6ea13facdf30f923\",\n \"type\":\"commit\"\n },\n \"selector\": {\n \"type\": \"custom\",\n \"pattern\": \"Deploy to production\"\n },\n \"type\": \"pipeline_ref_target\",\n \"ref_name\": \"master\",\n \"ref_type\": \"branch\"\n }\n }'\n```\n\n\n# Trigger a custom pipeline with variables\nIn addition to triggering a custom pipeline that is defined in your `bitbucket-pipelines.yml` file as shown in the examples above, you can specify variables that will be available for your build. In the request, provide a list of variables, specifying the following for each variable: key, value, and whether it should be secured or not (this field is optional and defaults to not secured).\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \\\n -d '\n {\n \"target\": {\n \"type\": \"pipeline_ref_target\",\n \"ref_type\": \"branch\",\n \"ref_name\": \"master\",\n \"selector\": {\n \"type\": \"custom\",\n \"pattern\": \"Deploy to production\"\n }\n },\n \"variables\": [\n {\n \"key\": \"var1key\",\n \"value\": \"var1value\",\n \"secured\": true\n },\n {\n \"key\": \"var2key\",\n \"value\": \"var2value\"\n }\n ]\n }'\n```\n\n# Trigger a pull request pipeline\n\nYou can also initiate a pipeline for a specific pull request.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \\\n -d '\n {\n\t\"target\": {\n \"type\": \"pipeline_pullrequest_target\",\n\t \"source\": \"pull-request-branch\",\n \"destination\": \"master\",\n \"destination_commit\": {\n \t \"hash\" : \"9f848b7\"\n },\n \"commit\": {\n \t\"hash\" : \"1a372fc\"\n },\n \"pullrequest\" : {\n \t\"id\" : \"3\"\n },\n\t \"selector\": {\n \"type\": \"pull-requests\",\n \"pattern\": \"**\"\n }\n }\n }'\n```\n", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pipelines/", "responses": [ { "uuid": "7738e890-18ec-42d7-8345-58f39835034d", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The initiated pipeline.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "dee24771-ae40-4f41-b181-f64dae606897", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "The account or repository is not enabled, the yml file does not exist in the repository for the given revision, or the request body contained invalid properties.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "caeabc7d-5f81-44e5-8532-c560b7020195", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or repository was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e6493057-5856-45fd-9527-a16a088b9117", "documentation": "Retrieve a specified pipeline", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines/:pipeline_uuid", "responses": [ { "uuid": "8e2c2cac-ea3c-48b5-90de-222e2b6d7cdf", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The pipeline.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "69cd8678-db99-4a36-9645-a33ea0434059", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "No account, repository or pipeline with the UUID provided exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2b8c0058-d6d4-49ed-82e5-2f6cbc665e67", "documentation": "Find steps for the given pipeline.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines/:pipeline_uuid/steps/", "responses": [ { "uuid": "8d79c23b-7179-4eaa-aabb-4562d1118ed6", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The steps.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a0e9463c-8782-4893-8f5a-dac90442799e", "documentation": "Retrieve a given step of a pipeline.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines/:pipeline_uuid/steps/:step_uuid", "responses": [ { "uuid": "31817724-8b6b-4da4-a580-faec8ee92891", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The step.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c5fab2d0-6f89-441b-9edf-b56df8fcc31d", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "No account, repository, pipeline or step with the UUID provided exists for the pipeline with the UUID provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fe59313c-2e46-4005-bebb-d2017c5a61e6", "documentation": "Retrieve the log file for a given step of a pipeline.\n\nThis endpoint supports (and encourages!) the use of [HTTP Range requests](https://tools.ietf.org/html/rfc7233) to deal with potentially very large log files.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines/:pipeline_uuid/steps/:step_uuid/log", "responses": [ { "uuid": "0721c796-3c30-4981-a93f-b01f10f863b9", "body": "", "latency": 0, "statusCode": 200, "label": "The raw log file for this pipeline step.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "025c5367-99ec-4282-b11f-45773ea36a7e", "body": "", "latency": 0, "statusCode": 304, "label": "The log has the same etag as the provided If-None-Match header.", "headers": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "21ae22f4-8153-4583-ad65-82e4e498e83f", "body": "", "latency": 0, "statusCode": 404, "label": "A pipeline with the given UUID does not exist, a step with the given UUID does not exist in the pipeline or a log file does not exist for the given step.", "headers": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "230ca1ab-1c30-4ca4-8023-c3414ba55084", "body": "", "latency": 0, "statusCode": 416, "label": "The requested range does not exist for requests that specified the [HTTP Range header](https://tools.ietf.org/html/rfc7233#section-3.1).", "headers": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e4ffd47f-4cb7-4df2-bca6-bd04efdc4514", "documentation": "", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines/:pipeline_uuid/steps/:step_uuid/logs/:log_uuid", "responses": [ { "uuid": "124c2dfe-7b6a-4c73-88f5-c911ce70dce9", "body": "", "latency": 0, "statusCode": 200, "label": "Default response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "97374aa7-5b9c-4ea3-9792-cbeb426bed78", "documentation": "", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines/:pipeline_uuid/steps/:step_uuid/test_reports", "responses": [ { "uuid": "4021d7ac-cffa-45ec-bc32-553b00856cca", "body": "", "latency": 0, "statusCode": 200, "label": "Default response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2556f03b-d397-47cd-a498-bfddfed5b674", "documentation": "", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines/:pipeline_uuid/steps/:step_uuid/test_reports/test_cases", "responses": [ { "uuid": "1951b0e9-00a8-47a1-924a-0b4d7584ea16", "body": "", "latency": 0, "statusCode": 200, "label": "Default response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bd53dee5-9239-4441-a54d-80e760588795", "documentation": "", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines/:pipeline_uuid/steps/:step_uuid/test_reports/test_cases/:test_case_uuid/test_case_reasons", "responses": [ { "uuid": "e5c67946-73d6-4709-9251-24a711f414b2", "body": "", "latency": 0, "statusCode": 200, "label": "Default response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "80f06e35-8fee-4859-b5a3-5bdd6b5020d6", "documentation": "Signal the stop of a pipeline and all of its steps that not have completed yet.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pipelines/:pipeline_uuid/stopPipeline", "responses": [ { "uuid": "5e4b208c-dbe3-451c-bf8f-f2b0e58804a4", "body": "", "latency": 0, "statusCode": 204, "label": "The pipeline has been signaled to stop.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f7e6b2ae-e9bf-462b-9464-d274eef8adbc", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "The specified pipeline has already completed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "46b88324-6768-40aa-90ea-d0c8e64f6ecf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Either the account, repository or pipeline with the given UUID does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "415a6f85-163c-4f77-bf96-5c5c4c6e106f", "documentation": "Retrieve the repository pipelines configuration.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config", "responses": [ { "uuid": "efa3a403-a5cd-4e1c-92d0-c653b60e1d1a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The repository pipelines configuration.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b082da29-b06f-4ccb-8715-758c9738b3b7", "documentation": "Update the pipelines configuration for a repository.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config", "responses": [ { "uuid": "b519a635-ea63-46f8-975f-6d94b8eeb949", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The repository pipelines configuration was updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "11fc0415-4218-42ec-8d16-7136ebcacd1b", "documentation": "Update the next build number that should be assigned to a pipeline. The next build number that will be configured has to be strictly higher than the current latest build number for this repository.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/build_number", "responses": [ { "uuid": "081af6f4-dbec-4ccd-93cb-d7b6bf770c71", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The build number has been configured.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "df0081f2-4cd6-4b6b-87d0-7b5f280e0b3a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "The update failed because the next number was invalid (it should be higher than the current number).", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f7dc6af3-b123-433e-a2e3-c396346090a8", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or repository was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "82591a26-e09c-4599-9652-cf8ddd04a6b5", "documentation": "Retrieve the configured schedules for the given repository.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/schedules/", "responses": [ { "uuid": "9aa31cb7-397f-4df0-86d5-d4033d82b524", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The list of schedules.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fd21489f-0abc-4fd3-b51a-aa6ac980f496", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or repository was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2a027942-d82f-41aa-8d59-109db557dfb1", "documentation": "Create a schedule for the given repository.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/schedules/", "responses": [ { "uuid": "f19f0206-edb2-4310-ada9-0ca218a7472a", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The created schedule.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d9efd41a-6914-4212-9ea4-19829c75d255", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "There were errors validating the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3890415b-6feb-433f-9606-213f20a81542", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The maximum limit of schedules for this repository was reached.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "18576707-1670-405b-81a6-c1944c93220b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or repository was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0d3123fa-c581-466c-a67b-99859afa23e0", "documentation": "Delete a schedule.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/schedules/:schedule_uuid", "responses": [ { "uuid": "dce8b834-e3c4-4bfc-91b8-b7b1b047da6b", "body": "", "latency": 0, "statusCode": 204, "label": "The schedule was deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ba31172d-3cf7-4eb3-8178-0c060638ac57", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or schedule was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d129e3dc-868a-4c06-8995-e6ed127403ca", "documentation": "Retrieve a schedule by its UUID.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/schedules/:schedule_uuid", "responses": [ { "uuid": "eefb221c-a2fa-4bb7-8ba7-8169eb211560", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The requested schedule.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1b34ab0a-2bd0-44bd-8364-1eef5ae477bf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or schedule was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "419a1da4-cb35-4300-84ff-22c2cfb8be24", "documentation": "Update a schedule.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/schedules/:schedule_uuid", "responses": [ { "uuid": "17cde4ab-df3b-4d18-add1-f0a19642b5bd", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The schedule is updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bac25a52-2833-49d6-af06-1af54a68ba44", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or schedule was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "88ab2472-f5f6-405b-9806-e854b546390f", "documentation": "Retrieve the executions of a given schedule.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/schedules/:schedule_uuid/executions/", "responses": [ { "uuid": "89483bc3-5d1a-41af-a27b-226b90297d2c", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The list of executions of a schedule.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "64e469fc-caca-4cc8-abb3-f5fb82c62c1c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or repository was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "723d76a9-fe10-4b85-b7c8-62298f57dbad", "documentation": "Delete the repository SSH key pair.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/ssh/key_pair", "responses": [ { "uuid": "fa850944-6b01-48ad-b69d-ca7c4f1236fd", "body": "", "latency": 0, "statusCode": 204, "label": "The SSH key pair was deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "60ed00bd-f2fc-4e1d-92cc-86ba3131a496", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or SSH key pair was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3fccb53c-20c6-4b08-96eb-606a152bc68e", "documentation": "Retrieve the repository SSH key pair excluding the SSH private key. The private key is a write only field and will never be exposed in the logs or the REST API.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/ssh/key_pair", "responses": [ { "uuid": "c65531aa-06b5-4cc1-a050-e5eadbfc3471", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The SSH key pair.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4c56df75-eb96-4583-94d4-b2575f6cd6cf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or SSH key pair was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ef986246-b40f-4a08-a1be-061bd608ff7c", "documentation": "Create or update the repository SSH key pair. The private key will be set as a default SSH identity in your build container.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/ssh/key_pair", "responses": [ { "uuid": "32d25d78-d4bf-4543-b786-f2925f83e857", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The SSH key pair was created or updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d8de0838-4424-4744-97e8-f1344641903d", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or SSH key pair was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cef3876d-407d-4ae0-8cd8-e2ed3c4f92e0", "documentation": "Find repository level known hosts.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/ssh/known_hosts/", "responses": [ { "uuid": "e77a1baf-d279-4af1-b9d4-62b7f187a82d", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The retrieved known hosts.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e9b4fd64-9f0a-476d-a5a5-b54952d17ca6", "documentation": "Create a repository level known host.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/ssh/known_hosts/", "responses": [ { "uuid": "7ec38f35-367b-450a-8460-7e39251a262a", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The known host was created.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5ca27d60-02ba-405c-bc97-4f606b65dccf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d468e253-51c1-461b-9cf2-d01b56949064", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 409, "label": "A known host with the provided hostname already exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e4bca851-55ab-4396-9647-d4ed0efdc2df", "documentation": "Delete a repository level known host.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/ssh/known_hosts/:known_host_uuid", "responses": [ { "uuid": "9016a8d8-e666-4600-8869-d3a9db22fda1", "body": "", "latency": 0, "statusCode": 204, "label": "The known host was deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3bca080a-3e3f-4f48-88bd-88e0c2a0ce40", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or known host with given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7b7405ac-b8e0-44da-a6e4-73f49390ae94", "documentation": "Retrieve a repository level known host.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/ssh/known_hosts/:known_host_uuid", "responses": [ { "uuid": "238b2589-d953-44a0-9192-1007bf627d58", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The known host.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "40ac6147-d7b4-45cf-bec5-c53a7a5f4575", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or known host with the specified UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "88a65b8d-491d-4251-866b-dc19c9576b4f", "documentation": "Update a repository level known host.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/ssh/known_hosts/:known_host_uuid", "responses": [ { "uuid": "9875269b-dac7-46a8-9981-ca26f696d4a0", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The known host was updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "828b5d33-802e-48ff-8422-8abee25bf40b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or known host with the given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "60a1ca38-e919-4eed-8a82-07ce66280699", "documentation": "Find repository level variables.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/variables/", "responses": [ { "uuid": "763f3284-8026-4c67-95b7-cc0766b91161", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The retrieved variables.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9bd4d219-c54f-4875-9906-e68547e357e6", "documentation": "Create a repository level variable.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/variables/", "responses": [ { "uuid": "2a3a2591-0162-4c0d-9a6d-94728ea13578", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The variable was created.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e13a5090-cd79-48ac-9da1-507741a86f0b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fab3f150-122a-46f4-96f3-8ffe35dbccf9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 409, "label": "A variable with the provided key already exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c5498a32-d967-4d3d-8d7a-bcbe42201ce5", "documentation": "Delete a repository level variable.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/variables/:variable_uuid", "responses": [ { "uuid": "41332bde-a590-4cdc-bcac-ced4dd724b8b", "body": "", "latency": 0, "statusCode": 204, "label": "The variable was deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1acfb27e-743d-413a-8537-c6813e5d5999", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or variable with given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6d914a63-fc57-4810-a9cd-7ae1fabb446f", "documentation": "Retrieve a repository level variable.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/variables/:variable_uuid", "responses": [ { "uuid": "b127f55b-17a6-4f48-9ab1-65aa6db42276", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The variable.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ad6d904c-ca0c-4f43-9633-79a1fbe901a1", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or variable with the specified UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5bf3ea6-d768-4a2b-a33e-9dcb607d50a5", "documentation": "Update a repository level variable.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/pipelines_config/variables/:variable_uuid", "responses": [ { "uuid": "cfec1c33-cf6f-416a-b2ab-de040592c187", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The variable was updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "290e2eea-bdb8-4837-8a9c-7f20bdcdc840", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account, repository or variable with the given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "67bfeac2-98b1-460d-a2fe-f85be6db8bbd", "documentation": "Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a repository.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/properties/:app_key/:property_name", "responses": [ { "uuid": "e9d2d0a2-0d1e-4dfc-a63a-1b6492a53731", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "622c9fad-f43c-48c2-9cf9-7deb76e5d1bc", "documentation": "Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a repository.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/properties/:app_key/:property_name", "responses": [ { "uuid": "aa801612-b9fd-4a83-b457-2096ac2e6d1b", "body": "", "latency": 0, "statusCode": 200, "label": "The value of the property.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba668eb2-cdc0-4e06-b5dc-2db74eb885a9", "documentation": "Update an [application property](/cloud/bitbucket/application-properties/) value stored against a repository.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/properties/:app_key/:property_name", "responses": [ { "uuid": "756a6771-53f3-4470-a978-cbf6bfa1568c", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5245b2d9-568e-4d4f-b074-d7ec2e9adc21", "documentation": "Returns all pull requests on the specified repository.\n\nBy default only open pull requests are returned. This can be controlled\nusing the `state` query parameter. To retrieve pull requests that are\nin one of multiple states, repeat the `state` parameter for each\nindividual state.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../../../meta/filtering) for more details.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests", "responses": [ { "uuid": "2b623e3b-134b-41f4-8947-d30baf87d27f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "All pull requests on the specified repository.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6b65eb4b-4924-4a32-b11a-e148f92a62f2", "body": "", "latency": 0, "statusCode": 401, "label": "If the repository is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e5e15009-6272-4d1d-85e2-b752367d6ad0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "59524fe2-1710-4ed0-884f-92b0eefc2b25", "documentation": "Creates a new pull request where the destination repository is\nthis repository and the author is the authenticated user.\n\nThe minimum required fields to create a pull request are `title` and\n`source`, specified by a branch name.\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/my-username/my-repository/pullrequests \\\n -u my-username:my-password \\\n --request POST \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"title\": \"My Title\",\n \"source\": {\n \"branch\": {\n \"name\": \"staging\"\n }\n }\n }'\n```\n\nIf the pull request's `destination` is not specified, it will default\nto the `repository.mainbranch`. To open a pull request to a\ndifferent branch, say from a feature branch to a staging branch,\nspecify a `destination` (same format as the `source`):\n\n```\n{\n \"title\": \"My Title\",\n \"source\": {\n \"branch\": {\n \"name\": \"my-feature-branch\"\n }\n },\n \"destination\": {\n \"branch\": {\n \"name\": \"staging\"\n }\n }\n}\n```\n\nReviewers can be specified by adding an array of user objects as the\n`reviewers` property.\n\n```\n{\n \"title\": \"My Title\",\n \"source\": {\n \"branch\": {\n \"name\": \"my-feature-branch\"\n }\n },\n \"reviewers\": [\n {\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n }\n ]\n}\n```\n\nOther fields:\n\n* `description` - a string\n* `close_source_branch` - boolean that specifies if the source branch should be closed upon merging", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pullrequests", "responses": [ { "uuid": "44adafd6-bcf3-4bc6-9dc6-a5d04294384b", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The newly created pull request.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "41749c79-2857-42ab-a578-c1b6386f8000", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f70ea57e-2e33-44a9-bcf8-620c03ea4dc6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "01f7cd56-583c-4114-a9e4-9684f4dbc263", "documentation": "Returns a paginated list of the pull request's activity log.\n\nThis handler serves both a v20 and internal endpoint. The v20 endpoint\nreturns reviewer comments, updates, approvals and request changes. The internal\nendpoint includes those plus tasks and attachments.\n\nComments created on a file or a line of code have an inline property.\n\nComment example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"comment\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695/comments/118571088\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695/_/diff#comment-118571088\"\n }\n },\n \"deleted\": false,\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"content\": {\n \"raw\": \"inline with to a dn from lines\",\n \"markup\": \"markdown\",\n \"html\": \"

inline with to a dn from lines

\",\n \"type\": \"rendered\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"updated_on\": \"2019-09-27T00:33:46.055384+00:00\",\n \"inline\": {\n \"context_lines\": \"\",\n \"to\": null,\n \"path\": \"\",\n \"outdated\": false,\n \"from\": 211\n },\n \"type\": \"pullrequest_comment\",\n \"id\": 118571088\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nUpdates include a state property of OPEN, MERGED, or DECLINED.\n\nUpdate example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"update\": {\n \"description\": \"\",\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\",\n \"destination\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"6a2c16e4a152\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/commit/6a2c16e4a152\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/6a2c16e4a152\"\n }\n }\n },\n \"branch\": {\n \"name\": \"master\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"reason\": \"\",\n \"source\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"728c8bad1813\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/commit/728c8bad1813\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/728c8bad1813\"\n }\n }\n },\n \"branch\": {\n \"name\": \"username/NONE-add-onClick-prop-for-accessibility\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"state\": \"OPEN\",\n \"author\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"date\": \"2019-05-10T06:48:25.305565+00:00\"\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nApproval example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"approval\": {\n \"date\": \"2019-09-27T00:37:19.849534+00:00\",\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n }\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/activity", "responses": [ { "uuid": "e75e2b01-d493-4270-95a7-2b0a58209ac8", "body": "", "latency": 0, "statusCode": 200, "label": "The pull request activity log", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3e149613-4529-4be2-8711-b6091e2fdd29", "body": "", "latency": 0, "statusCode": 401, "label": "If the repository is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8e47635d-79c9-4bad-a171-40d39216d965", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2ddb1e82-7ac0-42ff-9f80-6cf286b9d833", "documentation": "Returns the specified pull request.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id", "responses": [ { "uuid": "a84c7134-ef73-4158-8270-f7648ffdc99a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The pull request object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d9f29124-56a5-4a0b-9dd4-e1ac250a1c07", "body": "", "latency": 0, "statusCode": 401, "label": "If the repository is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c29e8449-7fb8-4410-9356-a2cd8dc60ed9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository or pull request does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8d491c27-2ce6-4584-855f-d7aff0a75b3e", "documentation": "Mutates the specified pull request.\n\nThis can be used to change the pull request's branches or description.\n\nOnly open pull requests can be mutated.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id", "responses": [ { "uuid": "478475c2-2162-4c15-a014-5ac7b0828a0f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The updated pull request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "577824aa-6f92-465c-95ff-2dd92011a643", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the input document was invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "377906c1-02e9-48b8-bb4c-3523d1112481", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4e02133b-a7b7-43d9-a62b-cbe107c2efa4", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository or pull request id does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "76fc051d-2c09-4fb2-8873-b9f26982cbed", "documentation": "Returns a paginated list of the pull request's activity log.\n\nThis handler serves both a v20 and internal endpoint. The v20 endpoint\nreturns reviewer comments, updates, approvals and request changes. The internal\nendpoint includes those plus tasks and attachments.\n\nComments created on a file or a line of code have an inline property.\n\nComment example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"comment\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695/comments/118571088\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695/_/diff#comment-118571088\"\n }\n },\n \"deleted\": false,\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"content\": {\n \"raw\": \"inline with to a dn from lines\",\n \"markup\": \"markdown\",\n \"html\": \"

inline with to a dn from lines

\",\n \"type\": \"rendered\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"updated_on\": \"2019-09-27T00:33:46.055384+00:00\",\n \"inline\": {\n \"context_lines\": \"\",\n \"to\": null,\n \"path\": \"\",\n \"outdated\": false,\n \"from\": 211\n },\n \"type\": \"pullrequest_comment\",\n \"id\": 118571088\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nUpdates include a state property of OPEN, MERGED, or DECLINED.\n\nUpdate example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"update\": {\n \"description\": \"\",\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\",\n \"destination\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"6a2c16e4a152\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/commit/6a2c16e4a152\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/6a2c16e4a152\"\n }\n }\n },\n \"branch\": {\n \"name\": \"master\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"reason\": \"\",\n \"source\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"728c8bad1813\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/commit/728c8bad1813\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/728c8bad1813\"\n }\n }\n },\n \"branch\": {\n \"name\": \"username/NONE-add-onClick-prop-for-accessibility\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"state\": \"OPEN\",\n \"author\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"date\": \"2019-05-10T06:48:25.305565+00:00\"\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nApproval example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"approval\": {\n \"date\": \"2019-09-27T00:37:19.849534+00:00\",\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n }\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/activity", "responses": [ { "uuid": "5f7d6ec1-2d60-468c-abd1-6b098546feb4", "body": "", "latency": 0, "statusCode": 200, "label": "The pull request activity log", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "391ca65a-741b-4184-bad4-0aac166134ff", "body": "", "latency": 0, "statusCode": 401, "label": "If the repository is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f7ae3794-1c5a-4880-9beb-b5880bfa3018", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e342257b-72fc-4210-9e95-545867ddd759", "documentation": "Redact the authenticated user's approval of the specified pull\nrequest.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/approve", "responses": [ { "uuid": "2c3df6e0-bbb6-4ac0-bd9f-825e80ec63e4", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response indicating the authenticated user's approval has been withdrawn.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6160f450-8636-4634-9678-9df675711e66", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4620f29f-29f7-400f-9f54-04265f52c2d4", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified pull request or the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a44dd480-f42e-487e-8578-8836d336a976", "documentation": "Approve the specified pull request as the authenticated user.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/approve", "responses": [ { "uuid": "7c5536ae-cef3-49c7-a81d-d0a97012e39d", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The `participant` object recording that the authenticated user approved the pull request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "71b04ed4-1e14-4faa-8a75-49d5a9e211b2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f95f425f-74c8-44fa-bc1a-66362b839f62", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified pull request or the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3d87c1e2-a980-4285-b293-56a6283eea8c", "documentation": "Returns a paginated list of the pull request's comments.\n\nThis includes both global, inline comments and replies.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../../../../../meta/filtering) for more\ndetails.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/comments", "responses": [ { "uuid": "2155a124-c094-4b92-9010-7234121ff6ef", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of comments made on the given pull request, in chronological order.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d14d9004-a7bf-495e-8f2f-01a2b08b2290", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the pull request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dd6208a2-1e00-4903-94ca-674565f4bbf9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the pull request does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1e4c5324-960b-46ec-8e63-491e6ce59bc1", "documentation": "Creates a new pull request comment.\n\nReturns the newly created pull request comment.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/comments", "responses": [ { "uuid": "b816fe8a-e30d-406e-a62f-699ab7702f8b", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The newly created comment.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d023de17-671f-4d2d-8324-3887044bcb23", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the pull request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5c9e310b-6c24-404f-aef4-b6a1269c4471", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the pull request does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ef20b92b-cfaa-4796-a3e7-d6c540de9c2c", "documentation": "Deletes a specific pull request comment.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/comments/:comment_id", "responses": [ { "uuid": "539aa7a4-a14f-459a-b09a-ff8c4b956999", "body": "", "latency": 0, "statusCode": 204, "label": "Successful deletion.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "714bff81-c63a-49f6-be77-80dd92a6071c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to delete the comment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b2f46733-c74c-45e0-87af-d8695f97a1a9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the comment does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4a4111f7-69df-46f7-9c04-be20dd24256f", "documentation": "Returns a specific pull request comment.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/comments/:comment_id", "responses": [ { "uuid": "7bb23af7-cacb-42cf-abea-5c57701affaa", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The comment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e9e287df-b831-4428-ada9-8e65eb6fb5cf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the pull request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b217d9dc-af30-4e45-afc0-ceb3b18d38b9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the comment does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9aa5cd6d-4cf4-476e-aa7c-f4ebfa3a880d", "documentation": "Updates a specific pull request comment.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/comments/:comment_id", "responses": [ { "uuid": "36fbae44-2c37-49b2-a00f-9f71b4a856c9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The updated comment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2db7f44e-839e-4082-979c-b4ee33c2b4cf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the comment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "68d3db2f-f742-4f9b-b5bb-66026587dc2e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the comment does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e46b1bc8-32cf-46d8-b042-8800d2b7818f", "documentation": "Returns a paginated list of the pull request's commits.\n\nThese are the commits that are being merged into the destination\nbranch when the pull requests gets accepted.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/commits", "responses": [ { "uuid": "1d44d5bc-d8f3-4a00-a17a-cfeeaad2c7f6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f16cf4aa-18bf-46ac-9d4b-e2b89ef0fbbd", "documentation": "Declines the pull request.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/decline", "responses": [ { "uuid": "d5dc9e80-1f7e-452c-bbf4-5511660f47ac", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The pull request object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "359fbea7-c58b-4f53-9283-1d69ac8fd4e2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 555, "label": "If the decline took too long and timed out.\nIn this case the caller should retry the request later.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eba78943-a40a-4c33-a33f-471387ba0f16", "documentation": "Redirects to the [repository diff](../../diff/%7Bspec%7D)\nwith the revspec that corresponds to the pull request.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/diff", "responses": [ { "uuid": "31dd51aa-e810-4785-ba9d-9a5811707fea", "body": "", "latency": 0, "statusCode": 302, "label": "Redirects to the [repository diff](../../diff/%7Bspec%7D) with the\nrevspec that corresponds to the pull request.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fae89fd7-6678-4f27-96ec-e110f46760de", "documentation": "Redirects to the [repository diffstat](../../diffstat/%7Bspec%7D)\nwith the revspec that corresponds to the pull request.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/diffstat", "responses": [ { "uuid": "aa84e5af-2d89-4aa2-9b27-21503bad3699", "body": "", "latency": 0, "statusCode": 302, "label": "Redirects to the [repository diffstat](../../diffstat/%7Bspec%7D) with\nthe revspec that corresponds to pull request.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f54f56cd-b04c-48f7-9c53-66e7325f5c92", "documentation": "Merges the pull request.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/merge", "responses": [ { "uuid": "b97732d0-c0cf-430f-af15-3b32c9470c29", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The pull request object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6849ce2e-ce8f-43e0-a7ff-4533d6c7ed04", "body": "", "latency": 0, "statusCode": 202, "label": "In the Location header, the URL to poll for the pull request merge status", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "62c2a5e9-0f66-45ac-bee0-c3ecaa966f1a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 555, "label": "If the merge took too long and timed out.\nIn this case the caller should retry the request later", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c581fcd9-cae4-4c33-b859-3f7e3fada028", "documentation": "When merging a pull request takes too long, the client receives a\ntask ID along with a 202 status code. The task ID can be used in a call\nto this endpoint to check the status of a merge task.\n\n```\ncurl -X GET https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/\n```\n\nIf the merge task is not yet finished, a PENDING status will be returned.\n\n```\nHTTP/2 200\n{\n \"task_status\": \"PENDING\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/\"\n }\n }\n}\n```\n\nIf the merge was successful, a SUCCESS status will be returned.\n\n```\nHTTP/2 200\n{\n \"task_status\": \"SUCCESS\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/\"\n }\n },\n \"merge_result\": \n}\n```\n\nIf the merge task failed, an error will be returned.\n\n```\n{\n \"type\": \"error\",\n \"error\": {\n \"message\": \"\"\n }\n}\n```", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/merge/task-status/:task_id", "responses": [ { "uuid": "36a8f797-a718-4134-be34-70696ee1117a", "body": "", "latency": 0, "statusCode": 200, "label": "Returns a task status if the merge is either pending or successful, and if it is successful, a pull request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "14c48f2d-db24-4e6a-807b-685f99fafb9a", "body": "", "latency": 0, "statusCode": 400, "label": "If the provided task ID does not relate to this pull request, or if something went wrong during the merge operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "25b14adf-1ede-4690-b0e9-339ac9296404", "body": "", "latency": 0, "statusCode": 403, "label": "The user making the request does not have permission to the repo and is different from the user who queued the task", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aa3c831b-83b6-4a06-a068-529549cfac7e", "documentation": "Redirects to the [repository patch](../../patch/%7Bspec%7D)\nwith the revspec that corresponds to pull request.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/patch", "responses": [ { "uuid": "faef8970-f2c3-4544-aeab-0ba09c039c45", "body": "", "latency": 0, "statusCode": 302, "label": "Redirects to the [repository patch](../../patch/%7Bspec%7D) with\nthe revspec that corresponds to pull request.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6a95fd8b-4ce8-4ab9-8385-b7264023a9a1", "documentation": "", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/request-changes", "responses": [ { "uuid": "5bf53067-d54e-4ef8-8bbc-7b3c01df97e8", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response indicating the authenticated user's request for change has been withdrawn.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a519bd84-d540-4a80-8add-598ed47136f8", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c9a36bd8-3652-4437-b6d4-2e84b85433b8", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified pull request or the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6cd1651e-502e-4123-bcf6-c865c94f0aba", "documentation": "", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/request-changes", "responses": [ { "uuid": "0328f05b-0dac-49bb-bbbf-72187ae87a1f", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The `participant` object recording that the authenticated user requested changes on the pull request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "050c9708-f855-4759-be2d-690bae70796e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f015ef5b-a28b-46e2-8829-0753b4974039", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified pull request or the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "41c5aa80-a9be-4b90-80fa-49cae3e96819", "documentation": "Returns all statuses (e.g. build results) for the given pull\nrequest.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pull_request_id/statuses", "responses": [ { "uuid": "2e68c5fe-a4f2-4829-9e73-5c5d92410b25", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of all commit statuses for this pull request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4e65e2c2-38f4-45b4-85b1-8a2f04d3467b", "body": "", "latency": 0, "statusCode": 401, "label": "If the repository is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "65a95a06-6653-468c-9f20-76f60616baf1", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified repository or pull request does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eff67878-0f1d-468b-a124-a74047ffdc16", "documentation": "Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a pull request.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pullrequest_id/properties/:app_key/:property_name", "responses": [ { "uuid": "1d008b7d-ec7d-4304-be9d-41766ac9a11a", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d98b6297-a870-45a4-bbaa-a7fd63763bee", "documentation": "Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a pull request.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pullrequest_id/properties/:app_key/:property_name", "responses": [ { "uuid": "acd7b789-d33d-42a3-9ec0-58041d9e90fb", "body": "", "latency": 0, "statusCode": 200, "label": "The value of the property.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "99a75c9e-9d0a-4046-a48e-54cbeed76376", "documentation": "Update an [application property](/cloud/bitbucket/application-properties/) value stored against a pull request.", "method": "put", "endpoint": "repositories/:workspace/:repo_slug/pullrequests/:pullrequest_id/properties/:app_key/:property_name", "responses": [ { "uuid": "6a667dac-1fcb-4866-b364-a4709cf3143e", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "331ba9d0-b0e9-4f6e-bf48-d58e09348d7d", "documentation": "Returns the branches and tags in the repository.\n\nBy default, results will be in the order the underlying source control system returns them and identical to\nthe ordering one sees when running \"$ git show-ref\". Note that this follows simple\nlexical ordering of the ref names.\n\nThis can be undesirable as it does apply any natural sorting semantics, meaning for instance that refs are\nsorted [\"branch1\", \"branch10\", \"branch2\", \"v10\", \"v11\", \"v9\"] instead of [\"branch1\", \"branch2\",\n\"branch10\", \"v9\", \"v10\", \"v11\"].\n\nSorting can be changed using the ?sort= query parameter. When using ?sort=name to explicitly sort on ref name,\nBitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/refs", "responses": [ { "uuid": "69f68fc4-d050-4b73-9010-7ae6d5591fb1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of refs matching any filter criteria that were provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fcc9fe0c-7c32-4dbb-8612-266442f48a6c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the repository is private and the authenticated user does not have\naccess to it.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c7d9c45b-a340-4fc1-9735-1490da10d6f3", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c928e790-ff61-431a-a877-a6da52747262", "documentation": "Returns a list of all open branches within the specified repository.\n Results will be in the order the source control manager returns them.\n\n ```\n $ curl -s https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches?pagelen=1 | jq .\n {\n \"pagelen\": 1,\n \"size\": 187,\n \"values\": [\n {\n \"name\": \"issue-9.3/AUI-5343-assistive-class\",\n \"links\": {\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commits/issue-9.3/AUI-5343-assistive-class\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches/issue-9.3/AUI-5343-assistive-class\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/branch/issue-9.3/AUI-5343-assistive-class\"\n }\n },\n \"default_merge_strategy\": \"squash\",\n \"merge_strategies\": [\n \"merge_commit\",\n \"squash\",\n \"fast_forward\"\n ],\n \"type\": \"branch\",\n \"target\": {\n \"hash\": \"e5d1cde9069fcb9f0af90403a4de2150c125a148\",\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B585074de-7b60-4fd1-81ed-e0bc7fafbda5%7D?ts=86317\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"aui\",\n \"full_name\": \"atlassian/aui\",\n \"uuid\": \"{585074de-7b60-4fd1-81ed-e0bc7fafbda5}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/patch/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/diff/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"Marcin Konopka \",\n \"type\": \"author\",\n \"user\": {\n \"display_name\": \"Marcin Konopka\",\n \"uuid\": \"{47cc24f4-2a05-4420-88fe-0417535a110a}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B47cc24f4-2a05-4420-88fe-0417535a110a%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B47cc24f4-2a05-4420-88fe-0417535a110a%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/MK-1.png\"\n }\n },\n \"nickname\": \"Marcin Konopka\",\n \"type\": \"user\",\n \"account_id\": \"60113d2b47a9540069f4de03\"\n }\n },\n \"parents\": [\n {\n \"hash\": \"87f7fc92b00464ae47b13ef65c91884e4ac9be51\",\n \"type\": \"commit\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/87f7fc92b00464ae47b13ef65c91884e4ac9be51\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/87f7fc92b00464ae47b13ef65c91884e4ac9be51\"\n }\n }\n }\n ],\n \"date\": \"2021-04-13T13:44:49+00:00\",\n \"message\": \"wip\n\",\n \"type\": \"commit\"\n }\n }\n ],\n \"page\": 1,\n \"next\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches?pagelen=1&page=2\"\n }\n ```\n\n Branches support [filtering and sorting](../../../../../meta/filtering)\n that can be used to search for specific branches. For instance, to find\n all branches that have \"stab\" in their name:\n\n ```\n curl -s https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches -G --data-urlencode 'q=name ~ \"stab\"'\n ```\n\n By default, results will be in the order the underlying source control system returns them and identical to\n the ordering one sees when running \"$ hg branches\" or \"$ git branch --list\". Note that this follows simple\n lexical ordering of the ref names.\n\n This can be undesirable as it does apply any natural sorting semantics, meaning for instance that tags are\n sorted [\"v10\", \"v11\", \"v9\"] instead of [\"v9\", \"v10\", \"v11\"].\n\n Sorting can be changed using the ?q= query parameter. When using ?q=name to explicitly sort on ref name,\n Bitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/refs/branches", "responses": [ { "uuid": "386f5d3a-01a8-4425-b38e-4abd0c6902bc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of branches matching any filter criteria that were provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "44660a15-bdc4-4bb4-99d2-1c838e6f9061", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the repository is private and the authenticated user does not have\naccess to it.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e58b3a62-7aa6-4ecb-8353-8d4a956e28eb", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d50f0044-0e10-4b88-b1c7-42f9d20c3559", "documentation": "Creates a new branch in the specified repository.\n\nThe payload of the POST should consist of a JSON document that\ncontains the name of the tag and the target hash.\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/branches \\\n-s -u seanfarley -X POST -H \"Content-Type: application/json\" \\\n-d '{\n \"name\" : \"smf/create-feature\",\n \"target\" : {\n \"hash\" : \"default\",\n }\n}'\n```\n\nThis call requires authentication. Private repositories require the\ncaller to authenticate with an account that has appropriate\nauthorization.\n\nThe branch name should not include any prefixes (e.g.\nrefs/heads). This endpoint does support using short hash prefixes for\nthe commit hash, but it may return a 400 response if the provided\nprefix is ambiguous. Using a full commit hash is the preferred\napproach.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/refs/branches", "responses": [ { "uuid": "5d4171a8-f3c9-4a0b-bc83-afc08c56b686", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The newly created branch object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "46b71fa3-6c09-46cf-a45e-7d656e395573", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the repository is private and the authenticated user does not have\naccess to it.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6c632a5f-ce72-44e1-a7ed-1f3226e15910", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or branch does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "77006422-e4f1-4b13-b2f4-4d0ea7c92c55", "documentation": "Delete a branch in the specified repository.\n\nThe main branch is not allowed to be deleted and will return a 400\nresponse.\n\nThe branch name should not include any prefixes (e.g.\nrefs/heads).", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/refs/branches/:name", "responses": [ { "uuid": "b9f24bd0-55eb-49e8-b6bb-44d18768246d", "body": "", "latency": 0, "statusCode": 204, "label": "Indicates that the specified branch was successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "37afa5e2-5ffd-4762-a89d-ee7acbdee378", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the repository is private and the authenticated user does not have\naccess to it.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "421ae9ed-8545-4f23-8c60-50b4aa482a56", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or branch does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a78f4292-58cc-45df-884c-f282f9151988", "documentation": "Returns a branch object within the specified repository.\n\n ```\n $ curl -s https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches/master | jq .\n {\n \"name\": \"master\",\n \"links\": {\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commits/master\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches/master\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/branch/master\"\n }\n },\n \"default_merge_strategy\": \"squash\",\n \"merge_strategies\": [\n \"merge_commit\",\n \"squash\",\n \"fast_forward\"\n ],\n \"type\": \"branch\",\n \"target\": {\n \"hash\": \"e7d158ff7ed5538c28f94cd97a9ad569680fc94e\",\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B585074de-7b60-4fd1-81ed-e0bc7fafbda5%7D?ts=86317\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"aui\",\n \"full_name\": \"atlassian/aui\",\n \"uuid\": \"{585074de-7b60-4fd1-81ed-e0bc7fafbda5}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/patch/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/diff/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"psre-renovate-bot \",\n \"type\": \"author\",\n \"user\": {\n \"display_name\": \"psre-renovate-bot\",\n \"uuid\": \"{250a442a-3ab3-4fcb-87c3-3c8f3df65ec7}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B250a442a-3ab3-4fcb-87c3-3c8f3df65ec7%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B250a442a-3ab3-4fcb-87c3-3c8f3df65ec7%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://secure.gravatar.com/avatar/6972ee037c9f36360170a86f544071a2?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FP-3.png\"\n }\n },\n \"nickname\": \"Renovate Bot\",\n \"type\": \"user\",\n \"account_id\": \"5d5355e8c6b9320d9ea5b28d\"\n }\n },\n \"parents\": [\n {\n \"hash\": \"eab868a309e75733de80969a7bed1ec6d4651e06\",\n \"type\": \"commit\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/eab868a309e75733de80969a7bed1ec6d4651e06\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/eab868a309e75733de80969a7bed1ec6d4651e06\"\n }\n }\n }\n ],\n \"date\": \"2021-04-12T06:44:38+00:00\",\n \"message\": \"Merged in issue/NONE-renovate-master-babel-monorepo (pull request #2883)\n\nchore(deps): update babel monorepo to v7.13.15 (master)\n\nApproved-by: Chris \"Daz\" Darroch\n\",\n \"type\": \"commit\"\n }\n }\n ```\n\n This call requires authentication. Private repositories require the\n caller to authenticate with an account that has appropriate\n authorization.\n\n For Git, the branch name should not include any prefixes (e.g.\n refs/heads).", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/refs/branches/:name", "responses": [ { "uuid": "9025fb02-161a-492e-89ef-f5c76f17ded4", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The branch object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2599d576-ebbc-4b49-a9c5-dcdee10a0dd4", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the repository is private and the authenticated user does not have\naccess to it.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5b5a2413-c74c-4732-b6a4-f3baba389860", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or branch does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "044529e3-74d2-4b97-9745-d177273438d9", "documentation": "Returns the tags in the repository.\n\nBy default, results will be in the order the underlying source control system returns them and identical to\nthe ordering one sees when running \"$ hg tags\" or \"$ git tag --list\". Note that this follows simple\nlexical ordering of the ref names.\n\nThis can be undesirable as it does apply any natural sorting semantics, meaning for instance that tags are\nsorted [\"v10\", \"v11\", \"v9\"] instead of [\"v9\", \"v10\", \"v11\"].\n\nSorting can be changed using the ?sort= query parameter. When using ?sort=name to explicitly sort on ref name,\nBitbucket will apply natural sorting and interpret numerical values as numbers instead of strings.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/refs/tags", "responses": [ { "uuid": "402cc299-8b67-4963-924e-92e2d5b285ac", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "A paginated list of tags matching any filter criteria that were provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2fe0aafb-139d-4788-b014-7f55e4005693", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the repository is private and the authenticated user does not have\naccess to it.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e616e3a1-f953-4d9f-96e1-8a4536840f7a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e2922d59-aec9-4b08-9c2f-8188662fb2f2", "documentation": "Creates a new tag in the specified repository.\n\nThe payload of the POST should consist of a JSON document that\ncontains the name of the tag and the target hash.\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/jdoe/myrepo/refs/tags \\\n-s -u jdoe -X POST -H \"Content-Type: application/json\" \\\n-d '{\n \"name\" : \"new-tag-name\",\n \"target\" : {\n \"hash\" : \"a1b2c3d4e5f6\",\n }\n}'\n```\n\nThis endpoint does support using short hash prefixes for the commit\nhash, but it may return a 400 response if the provided prefix is\nambiguous. Using a full commit hash is the preferred approach.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/refs/tags", "responses": [ { "uuid": "bca7e504-4b33-463a-a651-ecc6e74675a1", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The newly created tag.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "01ca2e2f-ce3a-4c81-aa2d-96f77038cc2b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the target hash is missing, ambiguous, or invalid, or if the name is not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ff035088-4007-43b1-8936-e93345c5712a", "documentation": "Delete a tag in the specified repository.\n\nFor Git, the tag name should not include any prefixes (e.g. refs/tags).\nFor Mercurial, this adds a commit to the main branch that removes the\nspecified tag.", "method": "delete", "endpoint": "repositories/:workspace/:repo_slug/refs/tags/:name", "responses": [ { "uuid": "c7c7557f-1709-4010-9007-9d76fbc1179f", "body": "", "latency": 0, "statusCode": 204, "label": "Indicates the specified tag was successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "affcf91f-dab5-46f9-bfcb-e3c4cfaef0e6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the repository is private and the authenticated user does not have\naccess to it.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "89d8d3cf-2d92-4b0c-b47c-39d5e10cd42a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or tag does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "022e1989-59fc-40c4-830d-1accda86f67c", "documentation": "Returns the specified tag.\n\n```\n$ curl -s https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/tags/3.8 -G | jq .\n{\n \"name\": \"3.8\",\n \"links\": {\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commits/3.8\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/tags/3.8\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg/commits/tag/3.8\"\n }\n },\n \"tagger\": {\n \"raw\": \"Matt Mackall \",\n \"type\": \"author\",\n \"user\": {\n \"username\": \"mpmselenic\",\n \"nickname\": \"mpmselenic\",\n \"display_name\": \"Matt Mackall\",\n \"type\": \"user\",\n \"uuid\": \"{a4934530-db4c-419c-a478-9ab4964c2ee7}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/mpmselenic\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/mpmselenic/\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/mpmselenic/avatar/32/\"\n }\n }\n }\n },\n \"date\": \"2016-05-01T18:52:25+00:00\",\n \"message\": \"Added tag 3.8 for changeset f85de28eae32\",\n \"type\": \"tag\",\n \"target\": {\n \"hash\": \"f85de28eae32e7d3064b1a1321309071bbaaa069\",\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg/avatar/32/\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"hg\",\n \"full_name\": \"seanfarley/hg\",\n \"uuid\": \"{c75687fb-e99d-4579-9087-190dbd406d30}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/patch/f85de28eae32e7d3064b1a1321309071bbaaa069\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg/commits/f85de28eae32e7d3064b1a1321309071bbaaa069\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/diff/f85de28eae32e7d3064b1a1321309071bbaaa069\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/f85de28eae32e7d3064b1a1321309071bbaaa069/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"Sean Farley \",\n \"type\": \"author\",\n \"user\": {\n \"username\": \"seanfarley\",\n \"nickname\": \"seanfarley\",\n \"display_name\": \"Sean Farley\",\n \"type\": \"user\",\n \"uuid\": \"{a295f8a8-5876-4d43-89b5-3ad8c6c3c51d}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/seanfarley\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/seanfarley/avatar/32/\"\n }\n }\n }\n },\n \"parents\": [\n {\n \"hash\": \"9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2\",\n \"type\": \"commit\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commit/9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg/commits/9a98d0e5b07fc60887f9d3d34d9ac7d536f470d2\"\n }\n }\n }\n ],\n \"date\": \"2016-05-01T04:21:17+00:00\",\n \"message\": \"debian: alphabetize build deps\",\n \"type\": \"commit\"\n }\n}\n```", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/refs/tags/:name", "responses": [ { "uuid": "3f556f32-33a6-4826-b736-478fa7a5379b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The tag object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f1d5e4eb-b4e9-453d-8dff-c2deb0a1de37", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the repository is private and the authenticated user does not have\naccess to it.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "329fd561-9421-42cc-8bcd-491b0972b703", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or tag does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8a665987-f7c5-40a9-be64-56c6fd8cecba", "documentation": "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)", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/src", "responses": [ { "uuid": "585cd15e-985b-4709-a79b-facabfb68361", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "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 paginated\nlist of file and directory entries is returned (if the\n`format=meta` query parameter was provided, then the json document\ncontaining the directory's meta data is returned).\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a2151fb4-5daa-4445-8021-34e8b73b15f0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the path or commit in the URL does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "befa0bde-d7fc-42c3-ac72-e183c209e773", "documentation": "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\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.", "method": "post", "endpoint": "repositories/:workspace/:repo_slug/src", "responses": [ { "uuid": "2398d3d5-46d3-4eec-b1ee-43a4f133ec75", "body": "", "latency": 0, "statusCode": 201, "label": "\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c2938494-0e80-491d-b2c1-aad0264418e2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have write or admin access", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1f99cea5-83f0-4652-8715-d4d10a9ed3f1", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the repository does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c80e8124-0202-420b-b6f1-c695d930926d", "documentation": "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](../../../../../../meta/filtering) for more\ndetails.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/src/:commit/:path", "responses": [ { "uuid": "ef476463-8905-441a-8871-1fafa357077e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "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 of the file in HTML-formated rendered markup is returned.\nIf the path matches a directory, then a paginated\nlist of file and directory entries is returned (if the\n`format=meta` query parameter was provided, then the json document\ncontaining the directory's meta data is returned.)\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "69b3279a-c93d-4437-96a6-6f6e0eafb969", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the path or commit in the URL does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ef93e2cc-2946-47b5-8f95-d89fdb5a8701", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 555, "label": "If the call times out, possibly because the specifiedrecursion depth is too large.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d2e59416-8e99-418d-8740-1cca2e365a2f", "documentation": "Returns the versions that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/versions", "responses": [ { "uuid": "dc14d9a3-222c-42d8-b936-be17682a7de2", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The versions that have been defined in the issue tracker.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f931832f-3bca-4d1c-bccb-b9952cd6a76e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7a904c9d-89b3-496f-82d8-82e88f9d7495", "documentation": "Returns the specified issue tracker version object.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/versions/:version_id", "responses": [ { "uuid": "fb7539ae-e050-452c-a83c-4af8b7ab1d34", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The specified version object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8048e840-ab39-4adf-a303-482862339971", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The specified repository or version does not exist or does not have the issue tracker enabled.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "28df7578-f967-4e98-9169-a619984428b5", "documentation": "Returns a paginated list of all the watchers on the specified\nrepository.", "method": "get", "endpoint": "repositories/:workspace/:repo_slug/watchers", "responses": [ { "uuid": "9736a8b7-d118-4432-bafe-5cbdaadc0b19", "body": "", "latency": 0, "statusCode": 200, "label": "A paginated list of all the watchers on the specified repository.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bd700f12-b8f2-4f1c-aec8-27736017ca15", "documentation": "Returns all snippets. Like pull requests, repositories and workspaces, the\nfull set of snippets is defined by what the current user has access to.\n\nThis includes all snippets owned by any of the workspaces the user is a member of,\nor snippets by other users that the current user is either watching or has collaborated\non (for instance by commenting on it).\n\nTo limit the set of returned snippets, apply the\n`?role=[owner|contributor|member]` query parameter where the roles are\ndefined as follows:\n\n* `owner`: all snippets owned by the current user\n* `contributor`: all snippets owned by, or watched by the current user\n* `member`: created in a workspaces or watched by the current user\n\nWhen no role is specified, all public snippets are returned, as well as all\nprivately owned snippets watched or commented on.\n\nThe returned response is a normal paginated JSON list. This endpoint\nonly supports `application/json` responses and no\n`multipart/form-data` or `multipart/related`. As a result, it is not\npossible to include the file contents.", "method": "get", "endpoint": "snippets", "responses": [ { "uuid": "dd91e3eb-608b-4254-84df-7f63b32bbec9", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of snippets.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "99223e70-d2d7-4383-842c-496235a9d3b5", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0498d58a-767f-4a11-872c-d85b9464c508", "documentation": "Creates a new snippet under the authenticated user's account.\n\nSnippets can contain multiple files. Both text and binary files are\nsupported.\n\nThe simplest way to create a new snippet from a local file:\n\n $ curl -u username:password -X POST https://api.bitbucket.org/2.0/snippets -F file=@image.png\n\nCreating snippets through curl has a few limitations and so let's look\nat a more complicated scenario.\n\nSnippets are created with a multipart POST. Both `multipart/form-data`\nand `multipart/related` are supported. Both allow the creation of\nsnippets with both meta data (title, etc), as well as multiple text\nand binary files.\n\nThe main difference is that `multipart/related` can use rich encoding\nfor the meta data (currently JSON).\n\n\nmultipart/related (RFC-2387)\n----------------------------\n\nThis is the most advanced and efficient way to create a paste.\n\n POST /2.0/snippets/evzijst HTTP/1.1\n Content-Length: 1188\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"title\": \"My snippet\",\n \"is_private\": true,\n \"scm\": \"hg\",\n \"files\": {\n \"foo.txt\": {},\n \"image.png\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n foo\n\n --===============1438169132528273974==\n Content-Type: image/png\n MIME-Version: 1.0\n Content-Transfer-Encoding: base64\n Content-ID: \"image.png\"\n Content-Disposition: attachment; filename=\"image.png\"\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n --===============1438169132528273974==--\n\nThe request contains multiple parts and is structured as follows.\n\nThe first part is the JSON document that describes the snippet's\nproperties or meta data. It either has to be the first part, or the\nrequest's `Content-Type` header must contain the `start` parameter to\npoint to it.\n\nThe remaining parts are the files of which there can be zero or more.\nEach file part should contain the `Content-ID` MIME header through\nwhich the JSON meta data's `files` element addresses it. The value\nshould be the name of the file.\n\n`Content-Disposition` is an optional MIME header. The header's\noptional `filename` parameter can be used to specify the file name\nthat Bitbucket should use when writing the file to disk. When present,\n`filename` takes precedence over the value of `Content-ID`.\n\nWhen the JSON body omits the `files` element, the remaining parts are\nnot ignored. Instead, each file is added to the new snippet as if its\nname was explicitly linked (the use of the `files` elements is\nmandatory for some operations like deleting or renaming files).\n\n\nmultipart/form-data\n-------------------\n\nThe use of JSON for the snippet's meta data is optional. Meta data can\nalso be supplied as regular form fields in a more conventional\n`multipart/form-data` request:\n\n $ curl -X POST -u credentials https://api.bitbucket.org/2.0/snippets -F title=\"My snippet\" -F file=@foo.txt -F file=@image.png\n\n POST /2.0/snippets HTTP/1.1\n Content-Length: 951\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"image.png\"\n Content-Type: application/octet-stream\n\n ?PNG\n\n IHDR?1??I.....\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n\n My snippet\n ------------------------------63a4b224c59f--\n\nHere the meta data properties are included as flat, top-level form\nfields. The file attachments use the `file` field name. To attach\nmultiple files, simply repeat the field.\n\nThe advantage of `multipart/form-data` over `multipart/related` is\nthat it can be easier to build clients.\n\nEssentially all properties are optional, `title` and `files` included.\n\n\nSharing and Visibility\n----------------------\n\nSnippets can be either public (visible to anyone on Bitbucket, as well\nas anonymous users), or private (visible only to members of the workspace).\nThis is controlled through the snippet's `is_private` element:\n\n* **is_private=false** -- everyone, including anonymous users can view\n the snippet\n* **is_private=true** -- only workspace members can view the snippet\n\nTo create the snippet under a workspace, just append the workspace ID\nto the URL. See [`/2.0/snippets/{workspace}`](./snippets/%7Bworkspace%7D#post).", "method": "post", "endpoint": "snippets", "responses": [ { "uuid": "a7840a39-8c86-47e2-be2c-0f5eb33028d0", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The newly created snippet object.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e71851f8-881e-46b3-ae85-3b39a19a0e8e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4dd86fbb-5cb6-4b74-8fea-8d29c861b32c", "documentation": "Identical to [`/snippets`](../snippets), except that the result is further filtered\nby the snippet owner and only those that are owned by `{workspace}` are\nreturned.", "method": "get", "endpoint": "snippets/:workspace", "responses": [ { "uuid": "d0361bfd-13e3-4027-bdcd-fb6be7139cf9", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of snippets.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "208363b9-7006-4e44-ba08-d3f7449c6935", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the user does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "856b97ce-0a80-49c6-860a-811aa2350d91", "documentation": "Identical to [`/snippets`](../snippets#post), except that the new snippet will be\ncreated under the workspace specified in the path parameter\n`{workspace}`.", "method": "post", "endpoint": "snippets/:workspace", "responses": [ { "uuid": "b4d3c45e-8741-4d7f-a547-0f145e18fd80", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The newly created snippet object.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7684c6c0-d5e7-4a5c-ae85-c3d0d603d17e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e702af62-2692-45f0-b381-b462bc48dbfe", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to create snippets in the specified workspace.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "80699e49-6367-4757-95eb-1a4002a06cb5", "documentation": "Deletes a snippet and returns an empty response.", "method": "delete", "endpoint": "snippets/:workspace/:encoded_id", "responses": [ { "uuid": "099677c4-9230-4018-bd83-2f35e0493195", "body": "", "latency": 0, "statusCode": 204, "label": "If the snippet was deleted successfully.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7ca5b1b1-17ac-4c7a-be60-6ec20724c778", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the snippet is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6abaeb0b-5101-4bb8-8c47-4b41e832bcb5", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If authenticated user does not have permission to delete the private snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dc6c98cc-a454-44bf-80c7-31e2f896bd2f", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "38fae0ca-57f4-4897-9048-30c658685aaf", "documentation": "Retrieves a single snippet.\n\nSnippets support multiple content types:\n\n* application/json\n* multipart/related\n* multipart/form-data\n\n\napplication/json\n----------------\n\nThe default content type of the response is `application/json`.\nSince JSON is always `utf-8`, it cannot reliably contain file contents\nfor files that are not text. Therefore, JSON snippet documents only\ncontain the filename and links to the file contents.\n\nThis means that in order to retrieve all parts of a snippet, N+1\nrequests need to be made (where N is the number of files in the\nsnippet).\n\n\nmultipart/related\n-----------------\n\nTo retrieve an entire snippet in a single response, use the\n`Accept: multipart/related` HTTP request header.\n\n $ curl -H \"Accept: multipart/related\" https://api.bitbucket.org/2.0/snippets/evzijst/1\n\nResponse:\n\n HTTP/1.1 200 OK\n Content-Length: 2214\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/comments\"\n },\n \"watchers\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/watchers\"\n },\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/commits\"\n }\n },\n \"id\": kypj,\n \"title\": \"My snippet\",\n \"created_on\": \"2014-12-29T22:22:04.790331+00:00\",\n \"updated_on\": \"2014-12-29T22:22:04.790331+00:00\",\n \"is_private\": false,\n \"files\": {\n \"foo.txt\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/foo.txt\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj#file-foo.txt\"\n }\n }\n },\n \"image.png\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/image.png\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj#file-image.png\"\n }\n }\n }\n ],\n \"owner\": {\n \"username\": \"evzijst\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png\"\n }\n }\n },\n \"creator\": {\n \"username\": \"evzijst\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png\"\n }\n }\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n foo\n\n --===============1438169132528273974==\n Content-Type: image/png\n MIME-Version: 1.0\n Content-Transfer-Encoding: base64\n Content-ID: \"image.png\"\n Content-Disposition: attachment; filename=\"image.png\"\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n --===============1438169132528273974==--\n\nmultipart/form-data\n-------------------\n\nAs with creating new snippets, `multipart/form-data` can be used as an\nalternative to `multipart/related`. However, the inherently flat\nstructure of form-data means that only basic, root-level properties\ncan be returned, while nested elements like `links` are omitted:\n\n $ curl -H \"Accept: multipart/form-data\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj\n\nResponse:\n\n HTTP/1.1 200 OK\n Content-Length: 951\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n Content-Type: text/plain; charset=\"utf-8\"\n\n My snippet\n ------------------------------63a4b224c59f--\n Content-Disposition: attachment; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: attachment; name=\"file\"; filename=\"image.png\"\n Content-Transfer-Encoding: base64\n Content-Type: application/octet-stream\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n ------------------------------5957323a6b76--", "method": "get", "endpoint": "snippets/:workspace/:encoded_id", "responses": [ { "uuid": "2ed4910c-3f22-4324-b740-b6b3404e7105", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The snippet object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "639abe72-6cc4-45f1-94d1-390f649a7e28", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the snippet is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b754084b-2fed-4677-85cd-0608bd8901a2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If authenticated user does not have access to the private snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "55f91c23-3934-49da-b4a8-afa8ee264d41", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6140d125-b27e-43f7-b454-4570b6eda281", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 410, "label": "If the snippet marked as spam.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fb0c31d0-f010-48f3-a1fe-729808ea1a0b", "documentation": "Used to update a snippet. Use this to add and delete files and to\nchange a snippet's title.\n\nTo update a snippet, one can either PUT a full snapshot, or only the\nparts that need to be changed.\n\nThe contract for PUT on this API is that properties missing from the\nrequest remain untouched so that snippets can be efficiently\nmanipulated with differential payloads.\n\nTo delete a property (e.g. the title, or a file), include its name in\nthe request, but omit its value (use `null`).\n\nAs in Git, explicit renaming of files is not supported. Instead, to\nrename a file, delete it and add it again under another name. This can\nbe done atomically in a single request. Rename detection is left to\nthe SCM.\n\nPUT supports three different content types for both request and\nresponse bodies:\n\n* `application/json`\n* `multipart/related`\n* `multipart/form-data`\n\nThe content type used for the request body can be different than that\nused for the response. Content types are specified using standard HTTP\nheaders.\n\nUse the `Content-Type` and `Accept` headers to select the desired\nrequest and response format.\n\n\napplication/json\n----------------\n\nAs with creation and retrieval, the content type determines what\nproperties can be manipulated. `application/json` does not support\nfile contents and is therefore limited to a snippet's meta data.\n\nTo update the title, without changing any of its files:\n\n $ curl -X POST -H \"Content-Type: application/json\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{\"title\": \"Updated title\"}'\n\n\nTo delete the title:\n\n $ curl -X POST -H \"Content-Type: application/json\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{\"title\": null}'\n\nNot all parts of a snippet can be manipulated. The owner and creator\nfor instance are immutable.\n\n\nmultipart/related\n-----------------\n\n`multipart/related` can be used to manipulate all of a snippet's\nproperties. The body is identical to a POST. properties omitted from\nthe request are left unchanged. Since the `start` part contains JSON,\nthe mechanism for manipulating the snippet's meta data is identical\nto `application/json` requests.\n\nTo update one of a snippet's file contents, while also changing its\ntitle:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 288\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"title\": \"My updated snippet\",\n \"files\": {\n \"foo.txt\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n Updated file contents.\n\n --===============1438169132528273974==--\n\nHere only the parts that are changed are included in the body. The\nother files remain untouched.\n\nNote the use of the `files` list in the JSON part. This list contains\nthe files that are being manipulated. This list should have\ncorresponding multiparts in the request that contain the new contents\nof these files.\n\nIf a filename in the `files` list does not have a corresponding part,\nit will be deleted from the snippet, as shown below:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 188\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"files\": {\n \"image.png\": {}\n }\n }\n\n --===============1438169132528273974==--\n\nTo simulate a rename, delete a file and add the same file under\nanother name:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 212\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"files\": {\n \"foo.txt\": {},\n \"bar.txt\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"bar.txt\"\n Content-Disposition: attachment; filename=\"bar.txt\"\n\n foo\n\n --===============1438169132528273974==--\n\n\nmultipart/form-data\n-----------------\n\nAgain, one can also use `multipart/form-data` to manipulate file\ncontents and meta data atomically.\n\n $ curl -X PUT http://localhost:12345/2.0/snippets/evzijst/kypj -F title=\"My updated snippet\" -F file=@foo.txt\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 351\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n\n My updated snippet\n ------------------------------63a4b224c59f\n\nTo delete a file, omit its contents while including its name in the\n`files` field:\n\n $ curl -X PUT https://api.bitbucket.org/2.0/snippets/evzijst/kypj -F files=image.png\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 149\n Content-Type: multipart/form-data; boundary=----------------------------ef8871065a86\n\n ------------------------------ef8871065a86\n Content-Disposition: form-data; name=\"files\"\n\n image.png\n ------------------------------ef8871065a86--\n\nThe explicit use of the `files` element in `multipart/related` and\n`multipart/form-data` is only required when deleting files.\nThe default mode of operation is for file parts to be processed,\nregardless of whether or not they are listed in `files`, as a\nconvenience to the client.", "method": "put", "endpoint": "snippets/:workspace/:encoded_id", "responses": [ { "uuid": "fca5cfea-93b4-47a0-90ab-a0985bd8665c", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The updated snippet object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e6b340ef-74a7-490a-b124-e0c50760acc9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the snippet is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "14e2f53a-b895-47a1-af3e-2bd3378d7ef2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If authenticated user does not have permission to update the private snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e5c4bdef-b056-4010-8576-661bd8f5aaf2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "80d1f5c7-43eb-46e5-99fc-9862e46905d8", "documentation": "Used to retrieve a paginated list of all comments for a specific\nsnippet.\n\nThis resource works identical to commit and pull request comments.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/comments", "responses": [ { "uuid": "c6fb1653-2970-4035-a881-dc156c0fe95b", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of snippet comments, ordered by creation date.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b5157c67-74e4-4e71-a17e-cee2b4d75dcb", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "99f4a8b6-9456-4095-ba6d-aa88f0984433", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "40efbd2e-9242-441b-a15b-f45bd55c1935", "documentation": "Creates a new comment.\n\nThe only required field in the body is `content.raw`.\n\nTo create a threaded reply to an existing comment, include `parent.id`.", "method": "post", "endpoint": "snippets/:workspace/:encoded_id/comments", "responses": [ { "uuid": "267764e9-103b-4cea-9b9c-a3a8af5b056a", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The newly created comment.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3357d6b0-399f-4396-820b-0a0babfcf85e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a3bfe900-7b36-4e49-bcbf-ddfc1ff2b553", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "44563494-eddb-4134-8af0-088bbb59d2c6", "documentation": "Deletes a snippet comment.\n\nComments can only be removed by their author.", "method": "delete", "endpoint": "snippets/:workspace/:encoded_id/comments/:comment_id", "responses": [ { "uuid": "3024a764-0ffd-42d6-9f26-b1ff6c2f1a3d", "body": "", "latency": 0, "statusCode": 204, "label": "Indicates the comment was deleted successfully.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cfeea017-b89a-4da7-9d67-6b8427cfa083", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user is not the author of the comment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5f8afca9-c866-41e8-a335-bcdb0c8d9657", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the comment or the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "24c9fb35-5b70-4804-ac2f-b824a046b9fc", "documentation": "Returns the specific snippet comment.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/comments/:comment_id", "responses": [ { "uuid": "9bb89481-63e7-40b0-b6d7-ac12db301b87", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The specified comment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "68fae99c-f9f8-4901-b60f-d23172d3eaab", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "97319e9f-1333-4921-8413-ff2b706d0d62", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the comment or snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fed93225-fa14-4689-8d9a-3d061ee5d7f3", "documentation": "Updates a comment.\n\nComments can only be updated by their author.", "method": "put", "endpoint": "snippets/:workspace/:encoded_id/comments/:comment_id", "responses": [ { "uuid": "b3e60a4a-6e70-460f-b573-078d8abaab88", "body": "", "latency": 0, "statusCode": 200, "label": "The updated comment object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e39561fe-347b-4f1c-98f2-277e06517c96", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a6f1d8ff-8316-499a-bf9b-070678b4b968", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the comment or snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "43815856-d638-4fef-acdf-202d836177df", "documentation": "Returns the changes (commits) made on this snippet.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/commits", "responses": [ { "uuid": "bbb97582-31a8-4907-827e-9250a4989f4f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The paginated list of snippet commits.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d97d0c77-49f1-4434-8e05-e984a65875b9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3436cd85-b1c8-4600-a823-0aeba369a221", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ec44b451-3423-45e5-ad14-79f723275234", "documentation": "Returns the changes made on this snippet in this commit.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/commits/:revision", "responses": [ { "uuid": "aca69410-00af-4a51-ba49-8f1cd0931074", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The specified snippet commit.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3e34fb36-94b2-4fbd-9e70-14c561c3c984", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "61158d86-ff7f-48ea-81d6-6f21898c93c3", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the commit or the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f6f84ec3-9bd9-47a2-a339-c99d114b9cfe", "documentation": "Convenience resource for getting to a snippet's raw files without the\nneed for first having to retrieve the snippet itself and having to pull\nout the versioned file links.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/files/:path", "responses": [ { "uuid": "cb8b70db-acea-4fae-89e6-b5eda78c4012", "body": "", "latency": 0, "statusCode": 302, "label": "A redirect to the most recent revision of the specified file.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "827f2833-68bf-4fed-951f-879c2558fb82", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "482b9b2d-d986-456d-904f-fa718daa8be0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5d6c54a7-7257-4e6b-a771-0a7e9fab8d65", "documentation": "Used to stop watching a specific snippet. Returns 204 (No Content)\nto indicate success.", "method": "delete", "endpoint": "snippets/:workspace/:encoded_id/watch", "responses": [ { "uuid": "486143cb-5b1f-4d09-b5c7-94b225a11a40", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 204, "label": "Indicates the user stopped watching the snippet successfully.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "75df45e6-c41a-405f-a6d7-7e09f1f01999", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4074f201-29be-48c9-9983-3e14a32b72be", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "398dc8ed-8b6a-49d2-81ce-c9880495c48b", "documentation": "Used to check if the current user is watching a specific snippet.\n\nReturns 204 (No Content) if the user is watching the snippet and 404 if\nnot.\n\nHitting this endpoint anonymously always returns a 404.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/watch", "responses": [ { "uuid": "0a551926-fb01-4594-8640-5b596c4f91df", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 204, "label": "If the authenticated user is watching the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "dcbd2a9a-27a6-4fb2-9b70-a8fd3bc72503", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist, or if the authenticated user is not watching the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0912a445-5178-40c3-9dec-f9bad1acbbb7", "documentation": "Used to start watching a specific snippet. Returns 204 (No Content).", "method": "put", "endpoint": "snippets/:workspace/:encoded_id/watch", "responses": [ { "uuid": "0cd4208f-26b7-43de-8cd6-8db7eaf34739", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 204, "label": "Indicates the authenticated user is now watching the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d2dcf2f0-a865-471c-a983-c187a345a793", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "51e82e55-27bc-4b51-8de6-07c73a32303c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9d91df67-98b9-4a92-aeef-bb1783338f6f", "documentation": "Returns a paginated list of all users watching a specific snippet.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/watchers", "responses": [ { "uuid": "31893e2c-f251-4f35-83e3-91988b1076e8", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "The paginated list of users watching this snippet", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4b96dce0-3219-429c-8368-125ee610f3f5", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6a62c605-c7d5-4244-847a-361c4b901b8b", "documentation": "Deletes the snippet.\n\nNote that this only works for versioned URLs that point to the latest\ncommit of the snippet. Pointing to an older commit results in a 405\nstatus code.\n\nTo delete a snippet, regardless of whether or not concurrent changes\nare being made to it, use `DELETE /snippets/{encoded_id}` instead.", "method": "delete", "endpoint": "snippets/:workspace/:encoded_id/:node_id", "responses": [ { "uuid": "05a5ee15-8b69-4cf4-8663-9fdb62dd60a4", "body": "", "latency": 0, "statusCode": 204, "label": "If the snippet was deleted successfully.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9836c180-037a-4733-bf30-aa26d607e962", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the snippet is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "09e0c485-5ead-4d60-8361-7d641a74b8e7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If authenticated user does not have permission to delete the private snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e42b7f7a-3cf9-4d4f-a7c2-ecda3c106a05", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c1ea9f74-0817-4a77-a14e-a55dc78613c0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 405, "label": "If `{node_id}` is not the latest revision.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a2804eda-a5df-4b3f-a5ff-bec6c05db069", "documentation": "Identical to `GET /snippets/encoded_id`, except that this endpoint\ncan be used to retrieve the contents of the snippet as it was at an\nolder revision, while `/snippets/encoded_id` always returns the\nsnippet's current revision.\n\nNote that only the snippet's file contents are versioned, not its\nmeta data properties like the title.\n\nOther than that, the two endpoints are identical in behavior.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/:node_id", "responses": [ { "uuid": "5d1c1394-8dcb-4764-a0dd-120230895fb3", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The snippet object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0e182e4d-fa85-4c98-ad04-401dc46d1b85", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the snippet is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c2478cb5-8188-4be1-bc88-f76e5a9be6cf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If authenticated user does not have access to the private snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1976a431-9049-4089-a652-04efe87b5708", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet, or the revision does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "59a7c49c-8921-4a64-9b44-63218d603e74", "documentation": "Identical to `UPDATE /snippets/encoded_id`, except that this endpoint\ntakes an explicit commit revision. Only the snippet's \"HEAD\"/\"tip\"\n(most recent) version can be updated and requests on all other,\nolder revisions fail by returning a 405 status.\n\nUsage of this endpoint over the unrestricted `/snippets/encoded_id`\ncould be desired if the caller wants to be sure no concurrent\nmodifications have taken place between the moment of the UPDATE\nrequest and the original GET.\n\nThis can be considered a so-called \"Compare And Swap\", or CAS\noperation.\n\nOther than that, the two endpoints are identical in behavior.", "method": "put", "endpoint": "snippets/:workspace/:encoded_id/:node_id", "responses": [ { "uuid": "0755ac6f-0f35-4b57-aae0-f8ee7759272e", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The updated snippet object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ddb731a4-7166-4ddd-b46a-57e64550a7e0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If the snippet is private and the request was not authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9986d9de-e834-497d-bbfc-b7552844a9b3", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If authenticated user does not have permission to update the private snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "438ed663-78bf-470d-a226-c2160d5ada5d", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet or the revision does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0742b9b1-c46b-4c43-87ea-4d2b4b5c8609", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 405, "label": "If `{node_id}` is not the latest revision.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1a32a7a9-24d0-4a61-a723-d028306c40ca", "documentation": "Retrieves the raw contents of a specific file in the snippet. The\n`Content-Disposition` header will be \"attachment\" to avoid issues with\nmalevolent executable files.\n\nThe file's mime type is derived from its filename and returned in the\n`Content-Type` header.\n\nNote that for text files, no character encoding is included as part of\nthe content type.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/:node_id/files/:path", "responses": [ { "uuid": "7a2d5792-f7fd-4869-a3fc-ad689c416957", "body": "", "latency": 0, "statusCode": 200, "label": "Returns the contents of the specified file.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Disposition", "value": "" }, { "key": "Content-Type", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9e1b3934-5c25-48b6-a969-ba29c9294e33", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e6262565-bd2e-4d5b-844c-2567a4f642ec", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the file or snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "efa8e197-5f4c-40ec-a69d-e3944a63dc82", "documentation": "Returns the diff of the specified commit against its first parent.\n\nNote that this resource is different in functionality from the `patch`\nresource.\n\nThe differences between a diff and a patch are:\n\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to how PRs work), while patch returns a\n response containing separate patches for each commit on the second\n parent's ancestry, up to the oldest common ancestor (identical to\n its reachability).\n\nNote that the character encoding of the contents of the diff is\nunspecified as Git does not track this, making it hard for\nBitbucket to reliably determine this.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/:revision/diff", "responses": [ { "uuid": "2f37ae67-6824-454c-a65d-c42e835bb44a", "body": "", "latency": 0, "statusCode": 200, "label": "The raw diff contents.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b5e6ee2d-cf8d-4ce3-a7fb-ff7d81457dbe", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ef7ab279-81c9-497b-b9fe-4135f367fdf6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2052a79b-e40e-4eb3-a610-dea22d651d63", "documentation": "Returns the patch of the specified commit against its first\nparent.\n\nNote that this resource is different in functionality from the `diff`\nresource.\n\nThe differences between a diff and a patch are:\n\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to how PRs work), while patch returns a\n response containing separate patches for each commit on the second\n parent's ancestry, up to the oldest common ancestor (identical to\n its reachability).\n\nNote that the character encoding of the contents of the patch is\nunspecified as Git does not track this, making it hard for\nBitbucket to reliably determine this.", "method": "get", "endpoint": "snippets/:workspace/:encoded_id/:revision/patch", "responses": [ { "uuid": "ce399d43-8be4-44a3-9201-a1877991b3e2", "body": "", "latency": 0, "statusCode": 200, "label": "The raw patch contents.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "40e37976-34df-48db-99db-3822c923d976", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have access to the snippet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e72f12d2-f2f9-4c07-9b71-78e3f87534db", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the snippet does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e088def9-d7d1-481b-92e5-fc33e8cd1bd1", "documentation": "Returns all the teams that the authenticated user is associated\nwith.\n\n**This endpoint has been deprecated,\nand you should use the [workspaces](./workspaces) endpoint.\nFor more information, see [this post](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "teams", "responses": [ { "uuid": "2994e955-b8f8-461a-81b8-60c38c45009a", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of teams.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "502b0ecb-d957-4543-b4f9-287a8fbf874d", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "When the request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "779a640e-1962-4d39-a65f-8c4249efa2e4", "documentation": "Gets the public information associated with a team.\n\nIf the team's profile is private, `location`, `website` and\n`created_on` elements are omitted.\n\n**This endpoint has been deprecated,\nand you should use the [workspace](../workspaces/%7Bworkspace%7D) endpoint.\nFor more information, see [this post](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "teams/:username", "responses": [ { "uuid": "cdfbc0b0-780f-4918-8a3e-b91cc3dff24b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The team object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "919262c3-c932-4b70-8891-5323573b690b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If no team exists for the specified name or UUID, or if the specified account is a personal account, not a team account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dcf2b980-dc97-4f33-b625-fce3f32499c7", "documentation": "Returns the list of accounts that are following this team.\n\n**This endpoint has been deprecated. There is no workspaces replacement.\nFor more information, see [this post](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "teams/:username/followers", "responses": [ { "uuid": "17879987-73b0-4388-b956-47ea34048752", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of user objects.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2b1f166d-2de4-4145-8df8-3493f67b4e13", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If no team exists for the specified name, or if the specified account is a personal account, not a team account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7a26dbe6-ac52-4099-8070-34bf19ac7536", "documentation": "Returns the list of accounts this team is following.\n\n**This endpoint has been deprecated. There is no workspaces replacement.\nFor more information, see [this post](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "teams/:username/following", "responses": [ { "uuid": "3e3a2527-9d98-409e-b5bd-2a30e797f654", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of user objects.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5e21a85e-0e84-4abd-877e-032e7d641974", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If no team exists for the specified name, or if the specified account is a personal account, not a team account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a0250237-c7b3-482d-8681-36964abcf4c0", "documentation": "Returns a paginated list of webhooks installed on this team.\n\n**This endpoint has been deprecated, and you should\nuse the new [workspace hooks](../../workspaces/%7Bworkspace%7D/hooks#get) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "teams/:username/hooks", "responses": [ { "uuid": "46980e5a-d031-4f14-b185-85d81f9b52af", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The paginated list of installed webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "36f2307b-9535-454d-ae39-16ea42f1abe0", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user is not an admin on the specified team.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ae3df2c3-da53-4b90-8850-aaca652ab4e5", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified team does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e357b69e-045b-4b0f-82ec-b55987139bb9", "documentation": "Creates a new webhook on the specified team.\n\nTeam webhooks are fired for events from all repositories belonging to\nthat team account.\n\nNote that only admins can install webhooks on teams.\n\n**This endpoint has been deprecated, and you should\nuse the new [workspace hooks](../../workspaces/%7Bworkspace%7D/hooks#post) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "post", "endpoint": "teams/:username/hooks", "responses": [ { "uuid": "017e733b-975d-4242-a109-d882f03720bb", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The newly installed webhook.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "33b67a0e-12a1-474a-a334-fd7e74a15f10", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user is not an admin on the specified team.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "db9fe74b-5b1c-4c1a-8e71-7a45c3197bf2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified team does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7d1be112-b54a-4367-81bf-327d3e33322f", "documentation": "Deletes the specified webhook subscription from the given team\naccount.\n\n**This endpoint has been deprecated, and you should\nuse the new [workspace hooks](../../../workspaces/%7Bworkspace%7D/hooks/%7Buid%7D#delete) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "delete", "endpoint": "teams/:username/hooks/:uid", "responses": [ { "uuid": "54402a04-bf29-470a-99b8-09ede8fe44fa", "body": "", "latency": 0, "statusCode": 204, "label": "When the webhook was deleted successfully", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "df114abc-3d48-4d8e-b8d5-af82bc7c7642", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to delete the webhook.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "be5694a4-9cbc-4a70-a972-ec08ef732e25", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or team does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f66e7e75-c570-470c-b914-e27f6d3aaeac", "documentation": "Returns the webhook with the specified id installed on the given\nteam account.\n\n**This endpoint has been deprecated, and you should\nuse the new [workspace hooks](../../../workspaces/%7Bworkspace%7D/hooks/%7Buid%7D#get) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "teams/:username/hooks/:uid", "responses": [ { "uuid": "e2e89f9d-3881-4b3f-a1ad-b3655141ebe4", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The webhook subscription object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fc15db58-a07d-4774-b74a-7233a65269d1", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or team does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "158ebc45-51b9-4a96-ae21-bd8e8a977e04", "documentation": "Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`\n\n**This endpoint has been deprecated, and you should\nuse the new [workspace hooks](../../../workspaces/%7Bworkspace%7D/hooks/%7Buid%7D#put) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "put", "endpoint": "teams/:username/hooks/:uid", "responses": [ { "uuid": "5cada9d1-8c5c-4bfb-841e-c0daeb22667e", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The webhook subscription object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "08cc0646-86bc-4875-9fb7-23809adc3974", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to update the webhook.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7e1666c3-be63-41c4-ac26-03bec60e781e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or team does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8b31063f-8d76-4bc8-a785-c5b8db70d5c7", "documentation": "Returns all members of the specified team. Any member of any of the\nteam's groups is considered a member of the team. This includes users\nin groups that may not actually have access to any of the team's\nrepositories.\n\n**This operation has been deprecated due to privacy changes.\nSee the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/)\nfor details.\nYou should this [workspaces](../../workspaces/%7Bworkspace%7D/members) endpoint as a replacement.**", "method": "get", "endpoint": "teams/:username/members", "responses": [ { "uuid": "00811130-b664-42be-bb3c-27f778ab4789", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "All members", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "22680f26-0733-451e-be39-2dee008badc7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "When the team does not exist, or multiple teams with the same name exist that differ only in casing and the URL did not match the exact casing of a particular one.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "22cdabb1-7850-44b2-a4cb-597bd8119ecf", "documentation": "Returns an object for each team permission a user on the team has.\n\n**This endpoint has been deprecated,\nand you should use the [workspace permissions](../../workspaces/%7Bworkspace%7D/permissions) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**\n\nPermissions returned are effective permissions — if a user is a member of\nmultiple groups with distinct roles, only the highest level is returned.\n\nPermissions can be:\n\n* `admin`\n* `collaborator`\n\nOnly users with admin permission for the team may access this resource.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/teams/atlassian_tutorial/permissions\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"permission\": \"admin\",\n \"type\": \"team_permission\",\n \"user\": {\n \"type\": \"user\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n },\n \"team\": {\n \"display_name\": \"Atlassian Bitbucket\",\n \"uuid\": \"{4cc6108a-a241-4db0-96a5-64347ac04f87}\"\n }\n },\n {\n \"permission\": \"collaborator\",\n \"type\": \"team_permission\",\n \"user\": {\n \"type\": \"user\",\n \"nickname\": \"seanaty\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n },\n \"team\": {\n \"display_name\": \"Atlassian Bitbucket\",\n \"uuid\": \"{4cc6108a-a241-4db0-96a5-64347ac04f87}\"\n }\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```\n\nResults may be further [filtered or sorted](../../../meta/filtering) by\nteam, user, or permission by adding the following query string\nparameters:\n\n* `q=user.uuid=\"{d301aafa-d676-4ee0-88be-962be7417567}\"` or `q=permission=\"admin\"`\n* `sort=team.display_name`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.", "method": "get", "endpoint": "teams/:username/permissions", "responses": [ { "uuid": "40aeca50-e938-4304-a005-2b13d80056a4", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"permission\": \"{{oneOf (array 'admin' 'collaborator' 'member')}}\",\n \"team\": \"\",\n \"type\": \"\",\n \"user\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Repositories owned by a team.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e09abc76-a9e4-4242-b3da-6f512d6ed2de", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't an admin of the team.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "65667bee-8a62-4bef-abc3-6c5d59433178", "documentation": "Returns an object for each repository permission for all of a\nteam’s repositories.\n\n**This endpoint has been deprecated,\nand you should use the [workspace repository permissions](../../../workspaces/%7Bworkspace%7D/permissions/repositories) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**\n\nIf the username URL parameter refers to a user account instead of\na team account, an object containing the repository permissions\nof all the username's repositories will be returned.\n\nPermissions returned are effective permissions — the highest level of\npermission the user has. This does not include public repositories that\nusers are not granted any specific permission in, and does not\ndistinguish between direct and indirect privileges.\n\nOnly users with admin permission for the team may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/teams/atlassian_tutorial/permissions/repositories\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"bitbucket/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"admin\"\n },\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"bitbucket/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"write\"\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```\n\nResults may be further [filtered or sorted](../../../../meta/filtering)\nby repository, user, or permission by adding the following query string\nparameters:\n\n* `q=repository.name=\"geordi\"` or `q=permission>\"read\"`\n* `sort=user.display_name`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.", "method": "get", "endpoint": "teams/:username/permissions/repositories", "responses": [ { "uuid": "7042c4e1-81ec-4a0a-8422-6dbea84d77a6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "List of team's repository permissions.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "74b72cd7-d826-499e-a6f1-8e37ca4cea4a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't an admin of the team.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "311549d8-8ce5-47ef-9b40-7ae81dce9dcc", "documentation": "Returns an object for each repository permission of a given repository.\n\n**This endpoint has been deprecated,\nand you should use the [workspace repository permissions](../../../../workspaces/%7Bworkspace%7D/permissions/repositories/%7Brepo_slug%7D) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**\n\nIf the username URL parameter refers to a user account instead of\na team account, an object containing the repository permissions\nof the username's repository will be returned.\n\nPermissions returned are effective permissions — the highest level of\npermission the user has. This does not include public repositories that\nusers are not granted any specific permission in, and does not\ndistinguish between direct and indirect privileges.\n\nOnly users with admin permission for the repository may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/teams/atlassian_tutorial/permissions/repositories/geordi\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"bitbucket/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"admin\"\n },\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"bitbucket/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"write\"\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```\n\nResults may be further [filtered or sorted](../../../../meta/filtering)\nby user, or permission by adding the following query string parameters:\n\n* `q=permission>\"read\"`\n* `sort=user.display_name`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.", "method": "get", "endpoint": "teams/:username/permissions/repositories/:repo_slug", "responses": [ { "uuid": "eb65a7ba-c888-4bf6-afae-5139c0742e59", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "List of repository's repository permissions.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f1c9513c-a937-4deb-ab18-48092798580a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't an admin of the repository.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5c7445f1-4697-48d8-8e40-d4d36f66c1d8", "documentation": "Find account level variables.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).", "method": "get", "endpoint": "teams/:username/pipelines_config/variables/", "responses": [ { "uuid": "46bf9b4c-5ad5-4e42-84b5-16ba7fc117fe", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The found account level variables.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "08e0d3d2-4f94-41d6-b985-0719f6d790ce", "documentation": "Create an account level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).", "method": "post", "endpoint": "teams/:username/pipelines_config/variables/", "responses": [ { "uuid": "9c2939c8-bce3-4eba-b6f4-7d37fcd7a6cc", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The created variable.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2bbe79da-2072-4e02-93c4-7c0506acee47", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c2026c71-2a4b-43ff-a623-0eb7174fc526", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 409, "label": "A variable with the provided key already exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "20108808-f4a1-4db1-9fe0-aebc3dfb67d8", "documentation": "Delete a team level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).", "method": "delete", "endpoint": "teams/:username/pipelines_config/variables/:variable_uuid", "responses": [ { "uuid": "831bfc46-62fd-4edb-8eeb-b7240bdda0e2", "body": "", "latency": 0, "statusCode": 204, "label": "The variable was deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3bcb430b-a42b-4f65-a5a7-331fbbb4a253", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or the variable with the provided UUID does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "649b0f57-f8a8-40a6-8029-3f9850b0cb05", "documentation": "Retrieve a team level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).", "method": "get", "endpoint": "teams/:username/pipelines_config/variables/:variable_uuid", "responses": [ { "uuid": "2084edbf-20fb-4bd6-b990-c04a9f1ab363", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The variable.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4a5930ab-69f0-4a35-aa22-c8a87f9585a4", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or variable with the given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c773acbd-1d61-43c2-9ce4-5e37572889eb", "documentation": "Update a team level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).", "method": "put", "endpoint": "teams/:username/pipelines_config/variables/:variable_uuid", "responses": [ { "uuid": "0fbdbfd6-b6ec-4376-abe7-baba3312887b", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The variable was updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "359475c7-49e1-4f44-afbb-7b9f33c72d0d", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or the variable was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "936e3cbb-f898-4e2c-9314-81f05b8216bb", "documentation": "**This endpoint has been deprecated,\nand you should use the [workspace projects](../../../workspaces/%7Bworkspace%7D/projects#get) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "teams/:username/projects/", "responses": [ { "uuid": "b35b3d09-ce1e-4ef4-9024-98a92271edc0", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A paginated list of projects that belong to the specified team.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "156b10cc-4850-4cfb-b8b6-030ad6ca06af", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't authorized to read the list of projects for the specified team.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "215995ad-255b-4755-8c49-1f89500c698d", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A team doesn't exist at this location.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7f67af91-6c86-4097-a9de-2714fc8f5153", "documentation": "Creates a new project.\n\n**This endpoint has been deprecated,\nand you should use the [workspace projects](../../../workspaces/%7Bworkspace%7D/projects#post) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**\n\nNote that the avatar has to be embedded as either a data-url\nor a URL to an external image as shown in the examples below:\n\n```\n$ body=$(cat << EOF\n{\n \"name\": \"Mars Project\",\n \"key\": \"MARS\",\n \"description\": \"Software for colonizing mars.\",\n \"links\": {\n \"avatar\": {\n \"href\": \"data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/...\"\n }\n },\n \"is_private\": false\n}\nEOF\n)\n$ curl -H \"Content-Type: application/json\" \\\n -X POST \\\n -d \"$body\" \\\n https://api.bitbucket.org/2.0/teams/teams-in-space/projects/ | jq .\n{\n // Serialized project document\n}\n```\n\nor even:\n\n```\n$ body=$(cat << EOF\n{\n \"name\": \"Mars Project\",\n \"key\": \"MARS\",\n \"description\": \"Software for colonizing mars.\",\n \"links\": {\n \"avatar\": {\n \"href\": \"http://i.imgur.com/72tRx4w.gif\"\n }\n },\n \"is_private\": false\n}\nEOF\n)\n$ curl -H \"Content-Type: application/json\" \\\n -X POST \\\n -d \"$body\" \\\n https://api.bitbucket.org/2.0/teams/teams-in-space/projects/ | jq .\n{\n // Serialized project document\n}\n```", "method": "post", "endpoint": "teams/:username/projects/", "responses": [ { "uuid": "9b4a882a-65eb-4100-b4ae-4ea46ecce6af", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "A new project has been created.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4c7f38db-b7dd-47ea-bb4d-c5b369553abf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't authorized to create the project.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "35606448-534b-4d87-90b3-a680d5664019", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A team doesn't exist at this location.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7c7be944-1f6a-4cfc-8078-dcfd963cee7e", "documentation": "**This endpoint has been deprecated,\nand you should use the [workspace project](../../../workspaces/%7Bworkspace%7D/projects/%7Bproject_key%7D#delete) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "delete", "endpoint": "teams/:username/projects/:project_key", "responses": [ { "uuid": "722bbd07-3d02-498c-bd31-2b1c925427b3", "body": "", "latency": 0, "statusCode": 204, "label": "Successful deletion.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "04ea65dc-0d99-47b2-baef-dea3980bb063", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't authorized to delete the project or the project isn't empty.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e1a192f1-2b63-4e70-926c-c89e49a3bc8a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A project isn't hosted at this location.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "27a490be-15f5-452a-8ae4-c0e639c2d9fe", "documentation": "**This endpoint has been deprecated,\nand you should use the [workspace project](../../../workspaces/%7Bworkspace%7D/projects/%7Bproject_key%7D#get) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "teams/:username/projects/:project_key", "responses": [ { "uuid": "8ffe230a-1cc1-41e6-8eba-efdd14be94a1", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The project object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5bdbc0a1-9c78-4d2a-b672-0767d6545c10", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't authorized to access the project.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3b6b2ee4-ad61-4f6e-9ae8-a143f37d44a4", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A project isn't hosted at this location.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "91acaea9-453b-4cd3-a8e1-7ede5d639adf", "documentation": "Since this endpoint can be used to both update and to create a\nproject, the request body depends on the intent.\n\n**This endpoint has been deprecated,\nand you should use the [workspace project](../../../workspaces/%7Bworkspace%7D/projects/%7Bproject_key%7D#put) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**\n\n### Creation\n\nSee the POST documentation for the project collection for an\nexample of the request body.\n\nNote: The `key` should not be specified in the body of request\n(since it is already present in the URL). The `name` is required,\neverything else is optional.\n\n### Update\n\nSee the POST documentation for the project collection for an\nexample of the request body.\n\nNote: The key is not required in the body (since it is already in\nthe URL). The key may be specified in the body, if the intent is\nto change the key itself. In such a scenario, the location of the\nproject is changed and is returned in the `Location` header of the\nresponse.", "method": "put", "endpoint": "teams/:username/projects/:project_key", "responses": [ { "uuid": "a7f73391-1f39-4264-90f1-bc301abbe6d5", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The existing project is has been updated.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b610c6c2-7ec4-432a-943d-2fac913906c4", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "A new project has been created.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3bea9dc5-bf44-4d84-b69c-4e0295ff874b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't authorized to update or create the project.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "968e26dc-365f-44bf-af8f-0c651bf0d703", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A team doesn't exist at the location. Note that the project's absence from this location doesn't raise a 404, since a PUT at a non-existent location can be used to create a new project.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1039d78c-6e7f-4bb8-9428-3401a98143d3", "documentation": "Search for code in the repositories of the specified team.\n\nSearching across all repositories:\n\n```\ncurl 'https://api.bitbucket.org/2.0/teams/team_name/search/code?search_query=foo'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 2,\n \"content_matches\": [\n {\n \"lines\": [\n {\n \"line\": 2,\n \"segments\": []\n },\n {\n \"line\": 3,\n \"segments\": [\n {\n \"text\": \"def \"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \"():\"\n }\n ]\n },\n {\n \"line\": 4,\n \"segments\": [\n {\n \"text\": \" print(\\\"snek\\\")\"\n }\n ]\n },\n {\n \"line\": 5,\n \"segments\": []\n }\n ]\n }\n ],\n \"path_matches\": [\n {\n \"text\": \"src/\"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \".py\"\n }\n ],\n \"file\": {\n \"path\": \"src/foo.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n }\n }\n }\n ]\n}\n```\n\nNote that searches can match in the file's text (`content_matches`),\nthe path (`path_matches`), or both as in the example above.\n\nYou can use the same syntax for the search query as in the UI, e.g.\nto only search within a specific repository:\n\n```\ncurl 'https://api.bitbucket.org/2.0/teams/team_name/search/code?search_query=foo+repo:demo'\n# results from the \"demo\" repository\n```\n\nSimilar to other APIs, you can request more fields using a\n`fields` query parameter. E.g. to get some more information about\nthe repository of matched files (the `%2B` is a URL-encoded `+`):\n\n```\ncurl 'https://api.bitbucket.org/2.0/teams/team_name/search/code'\\\n '?search_query=foo&fields=%2Bvalues.file.commit.repository'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 1,\n \"content_matches\": [...],\n \"path_matches\": [...],\n \"file\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/commit/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo/commits/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n }\n },\n \"repository\": {\n \"name\": \"demo\",\n \"type\": \"repository\",\n \"full_name\": \"my-workspace/demo\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B850e1749-781a-4115-9316-df39d0600e7a%7D?ts=default\"\n }\n },\n \"uuid\": \"{850e1749-781a-4115-9316-df39d0600e7a}\"\n }\n },\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n },\n \"path\": \"src/foo.py\"\n }\n }\n ]\n}\n```\n\nTry `fields=%2Bvalues.*.*.*.*` to get an idea what's possible.\n", "method": "get", "endpoint": "teams/:username/search/code", "responses": [ { "uuid": "5bb3e4cb-ba14-4060-bf18-eca3e96311df", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful search", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a879b1c9-04cd-47e8-9bbf-d78eec2a7cfb", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the search request was invalid due to one of the\nfollowing reasons:\n\n* the specified type of target account doesn''t match the actual\naccount type;\n\n* malformed pagination properties;\n\n* missing or malformed search query, in the latter case an error\nkey will be returned in `error.data.key` property.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "66ac0bef-ab5b-47d5-9d70-aa6fdec3994c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Search is not enabled for the requested team, navigate to [https://bitbucket.org/search](https://bitbucket.org/search) to turn it on", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aa74bba9-e93e-46d4-878c-a053671bd6aa", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 429, "label": "Too many requests, try again later", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "81007440-fc15-4d89-af35-5df2e1257782", "documentation": "All repositories in the given workspace. This includes any private\nrepositories the calling user has access to.\n\n**This endpoint has been deprecated,\nand you should use the [repository list](../../repositories/%7Bworkspace%7D) endpoint.\nFor more information, see the [deprecation announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "teams/:workspace/repositories", "responses": [ { "uuid": "68deff1d-5665-4f51-9e12-def6b756a3fd", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f0a0a51f-a792-4d3f-b6c5-739ab5dbd399", "documentation": "Returns the currently logged in user.", "method": "get", "endpoint": "user", "responses": [ { "uuid": "fdcdf5fc-4a35-4fb2-9de0-886e449c1719", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The current user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "edf0f8cf-2dc5-41e6-9cf5-2ae28c89271e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "When the request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "47f1be91-f21a-4cc7-82cf-23054f728b1d", "documentation": "Returns all the authenticated user's email addresses. Both\nconfirmed and unconfirmed.", "method": "get", "endpoint": "user/emails", "responses": [ { "uuid": "ed37e98c-6134-469a-906d-0df19480af4c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "51d6c8b4-4064-4366-9ea8-f59c39406fa1", "documentation": "Returns details about a specific one of the authenticated user's\nemail addresses.\n\nDetails describe whether the address has been confirmed by the user and\nwhether it is the user's primary address or not.", "method": "get", "endpoint": "user/emails/:email", "responses": [ { "uuid": "a9488cdd-c9a1-4c2b-8bdb-bf049505137c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "45b3de1e-3f89-4274-88eb-50be5d64c299", "documentation": "Returns an object for each repository the caller has explicit access\nto and their effective permission — the highest level of permission the\ncaller has. This does not return public repositories that the user was\nnot granted any specific permission in, and does not distinguish between\ndirect and indirect privileges.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/user/permissions/repositories\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"bitbucket/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"admin\"\n }\n ],\n \"page\": 1,\n \"size\": 1\n}\n```\n\nResults may be further [filtered or sorted](../../../meta/filtering) by\nrepository or permission by adding the following query string\nparameters:\n\n* `q=repository.name=\"geordi\"` or `q=permission>\"read\"`\n* `sort=repository.name`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.", "method": "get", "endpoint": "user/permissions/repositories", "responses": [ { "uuid": "2b881d04-323b-4830-ac91-76064fd2a166", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Repository permissions for the repositories a caller has explicit access to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "87e08cdf-c2e0-4c53-a0cb-46ed889e78f7", "documentation": "Returns an object for each team the caller is a member of, and their\neffective role — the highest level of privilege the caller has. If a\nuser is a member of multiple groups with distinct roles, only the\nhighest level is returned.\n\n**This endpoint has been deprecated,\nand you should use the [workspace permissions](./workspaces) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**\n\nPermissions can be:\n\n* `admin`\n* `collaborator`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/user/permissions/teams\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"permission\": \"admin\",\n \"type\": \"team_permission\",\n \"user\": {\n \"type\": \"user\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n },\n \"team\": {\n \"display_name\": \"Atlassian Bitbucket\",\n \"uuid\": \"{4cc6108a-a241-4db0-96a5-64347ac04f87}\"\n }\n }\n ],\n \"page\": 1,\n \"size\": 1\n}\n```\n\nResults may be further [filtered or sorted](../../../meta/filtering) by\nteam or permission by adding the following query string parameters:\n\n* `q=team.uuid=\"{4cc6108a-a241-4db0-96a5-64347ac04f87}\"` or `q=permission=\"admin\"`\n* `sort=team.display_name`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.", "method": "get", "endpoint": "user/permissions/teams", "responses": [ { "uuid": "9546d50f-6082-4f35-87c5-b072a19db8d8", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"permission\": \"{{oneOf (array 'admin' 'collaborator' 'member')}}\",\n \"team\": \"\",\n \"type\": \"\",\n \"user\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Team permissions for the teams a caller is a member of.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "54b91fb1-bbf4-43a2-9614-d8b1e90a9623", "documentation": "Returns an object for each workspace the caller is a member of, and\ntheir effective role - the highest level of privilege the caller has.\nIf a user is a member of multiple groups with distinct roles, only the\nhighest level is returned.\n\nPermissions can be:\n\n* `owner`\n* `collaborator`\n* `member`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/user/permissions/workspaces\n\n{\n \"pagelen\": 10,\n \"page\": 1,\n \"size\": 1,\n \"values\": [\n {\n \"type\": \"workspace_membership\",\n \"permission\": \"owner\",\n \"last_accessed\": \"2019-03-07T12:35:02.900024+00:00\",\n \"added_on\": \"2018-10-11T17:42:02.961424+00:00\",\n \"user\": {\n \"type\": \"user\",\n \"uuid\": \"{470c176d-3574-44ea-bb41-89e8638bcca4}\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n },\n \"workspace\": {\n \"type\": \"workspace\",\n \"uuid\": \"{a15fb181-db1f-48f7-b41f-e1eff06929d6}\",\n \"slug\": \"bbworkspace1\",\n \"name\": \"Atlassian Bitbucket\",\n }\n }\n ]\n}\n```\n\nResults may be further [filtered or sorted](../../../meta/filtering) by\nworkspace or permission by adding the following query string parameters:\n\n* `q=workspace.slug=\"bbworkspace1\"` or `q=permission=\"owner\"`\n* `sort=workspace.slug`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.", "method": "get", "endpoint": "user/permissions/workspaces", "responses": [ { "uuid": "bca31ae8-b42c-4588-bc22-b1f3ff2133fe", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "All of the workspace memberships for the authenticated user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "84e45bc4-fc13-4814-a28b-5abb149fde4a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f3f9a1ae-47ea-48ae-9474-25d3c3b6902d", "documentation": "Gets the public information associated with a user account.\n\nIf the user's profile is private, `location`, `website` and\n`created_on` elements are omitted.\n\nNote that the user object returned by this operation is changing significantly, due to privacy changes.\nSee the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#changes-to-bitbucket-user-objects) for details.", "method": "get", "endpoint": "users/:selected_user", "responses": [ { "uuid": "bb58bf91-1bec-4569-9652-ed8aa4642dbc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The user object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1b0d8a11-c573-4ca5-accb-061090992f69", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If no user exists for the specified UUID, or if the specified account is a team account, not a personal account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c3f64ad-8565-41f0-a8e8-9d3700d839ca", "documentation": "Returns a paginated list of webhooks installed on this user account.\n\nNote that the username path parameter has been deprecated due to\n[privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).\nUse the account's UUID or account_id instead.\n\n**This endpoint has been deprecated, and you should\nuse the new [workspace hooks](../../workspaces/%7Bworkspace%7D/hooks#get) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "users/:selected_user/hooks", "responses": [ { "uuid": "69d2a1c0-8446-4ae2-ac2a-979571c3d1e1", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The paginated list of installed webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "05907132-7980-44d8-8734-93a0f54f5809", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user is accessing an account other than their own.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4300eeb5-4752-4d84-bd2e-351bba9d7b0e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified account does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f2a059ee-1d22-4089-beb5-3232cd39604b", "documentation": "Creates a new webhook on the specified user account.\n\nAccount-level webhooks are fired for events from all repositories\nbelonging to that account.\n\nNote that one can only register webhooks on one's own account, not that\nof others.\n\nAlso, note that the username path parameter has been deprecated due to\n[privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).\nUse the account's UUID or account_id instead.\n\n**This endpoint has been deprecated, and you should\nuse the new [workspace hooks](../../workspaces/%7Bworkspace%7D/hooks#post) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "post", "endpoint": "users/:selected_user/hooks", "responses": [ { "uuid": "30e7c0a3-5519-48ad-82aa-390c65fc516d", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The newly installed webhook.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "396081d9-16e8-492b-afe9-6eca2a04930e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user is accessing an account other than their own.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7b7ff27c-5468-4df6-9eef-dcf6b9641d7e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified account does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c409aa01-c5db-4589-b1d4-e612bc3c6852", "documentation": "Deletes the specified webhook subscription from the given user\naccount.\n\nNote that the username path parameter has been deprecated due to\n[privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).\nUse the account's UUID or account_id instead.\n\n**This endpoint has been deprecated, and you should\nuse the new [workspace hooks](../../../workspaces/%7Bworkspace%7D/hooks/%7Buid%7D#delete) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "delete", "endpoint": "users/:selected_user/hooks/:uid", "responses": [ { "uuid": "3fa560cb-4444-4df7-89de-d827a5b8004d", "body": "", "latency": 0, "statusCode": 204, "label": "When the webhook was deleted successfully", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a4285b60-1a87-44db-8f25-b9938a39c9c8", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to delete the webhook.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d3a92307-42d1-416f-9331-579e39391fde", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or user does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b134262-08ca-4ca1-a9d0-872477a06122", "documentation": "Returns the webhook with the specified id installed on the given\nuser account.\n\nNote that the username path parameter has been deprecated due to\n[privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).\nUse the account's UUID or account_id instead.\n\n**This endpoint has been deprecated, and you should\nuse the new [workspace hook details](../../../workspaces/%7Bworkspace%7D/hooks/%7Buid%7D#get) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "users/:selected_user/hooks/:uid", "responses": [ { "uuid": "99ecab9f-8e4a-467f-8180-b2487880e563", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The webhook subscription object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a4bc2a1f-4f1b-4942-b74a-efdd5178f9f6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or user does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "794fbf86-fce9-46e9-a511-456eb7dbd709", "documentation": "Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`\n\nNote that the username path parameter has been deprecated due to\n[privacy changes](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#removal-of-usernames-from-user-referencing-apis).\nUse the account's UUID or account_id instead.\n\n**This endpoint has been deprecated, and you should\nuse the new [workspace hook details](../../../workspaces/%7Bworkspace%7D/hooks/%7Buid%7D#put) endpoint.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "put", "endpoint": "users/:selected_user/hooks/:uid", "responses": [ { "uuid": "b6add037-0b51-49bb-af9a-b09838fcc01c", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The webhook subscription object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fb6141b3-3b0f-4834-8f79-ddaf0c1884d2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to update the webhook.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "81dd14a4-0f84-4f49-942a-fca1a2645e46", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or user does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5fba987a-1df3-4978-932e-c35d2cb6f018", "documentation": "Find user level variables.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).", "method": "get", "endpoint": "users/:selected_user/pipelines_config/variables/", "responses": [ { "uuid": "9c3722e4-a09f-4459-9228-4ed79a267343", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The found user level variables.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5b15aa51-3b26-48c1-8b3e-7267647d7f66", "documentation": "Create a user level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).", "method": "post", "endpoint": "users/:selected_user/pipelines_config/variables/", "responses": [ { "uuid": "765c7e5e-a9b0-4076-9d02-e9c9a5d5ecf1", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The created variable.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "06cd4062-cc22-4cdd-81f6-99f256b4b34c", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "97e78cb5-b0d7-4c67-9d5a-f203c44dcb68", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 409, "label": "A variable with the provided key already exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7368731a-7301-4707-88d0-411b4a354de3", "documentation": "Delete an account level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).", "method": "delete", "endpoint": "users/:selected_user/pipelines_config/variables/:variable_uuid", "responses": [ { "uuid": "25a13e4a-fad9-4015-954c-3baeb5a3920d", "body": "", "latency": 0, "statusCode": 204, "label": "The variable was deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "80948dd0-97d1-4005-a321-c810f3b75b59", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or the variable with the provided UUID does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e1af3607-0be9-4dbf-9eec-689742dc6bf2", "documentation": "Retrieve a user level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).", "method": "get", "endpoint": "users/:selected_user/pipelines_config/variables/:variable_uuid", "responses": [ { "uuid": "4e64ff9f-0e1c-4137-b37d-4fc27b48d9bc", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The variable.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5d9496c5-3517-43ee-9a15-e2c13d176788", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or variable with the given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9bf57353-7984-4483-815f-06110547a5c3", "documentation": "Update a user level variable.\nThis endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).", "method": "put", "endpoint": "users/:selected_user/pipelines_config/variables/:variable_uuid", "responses": [ { "uuid": "83833ce3-0a87-47c1-95cf-db2705d682ad", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The variable was updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1f74456f-4f97-4836-8b58-c2f675c4e627", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The account or the variable was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6a267a00-210c-4c7b-974e-6d7ef2c05609", "documentation": "Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a user.", "method": "delete", "endpoint": "users/:selected_user/properties/:app_key/:property_name", "responses": [ { "uuid": "ab176d16-220e-4027-a12c-78f6ec3ebfcf", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f5bc4f71-5ac6-4f59-b63b-c134b92d1b0d", "documentation": "Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a user.", "method": "get", "endpoint": "users/:selected_user/properties/:app_key/:property_name", "responses": [ { "uuid": "db84af9d-3e63-4003-8f00-792a8c6fecd8", "body": "", "latency": 0, "statusCode": 200, "label": "The value of the property.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "610747fa-dbe7-4ba1-bb79-5c72a091171a", "documentation": "Update an [application property](/cloud/bitbucket/application-properties/) value stored against a user.", "method": "put", "endpoint": "users/:selected_user/properties/:app_key/:property_name", "responses": [ { "uuid": "f7c308e7-b4a3-43e0-a25c-ab9a49403c0c", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "361e98bb-c03a-47d1-8313-80f2f2eab695", "documentation": "Search for code in the repositories of the specified user.\n\nSearching across all repositories:\n\n```\ncurl 'https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/search/code?search_query=foo'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 2,\n \"content_matches\": [\n {\n \"lines\": [\n {\n \"line\": 2,\n \"segments\": []\n },\n {\n \"line\": 3,\n \"segments\": [\n {\n \"text\": \"def \"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \"():\"\n }\n ]\n },\n {\n \"line\": 4,\n \"segments\": [\n {\n \"text\": \" print(\\\"snek\\\")\"\n }\n ]\n },\n {\n \"line\": 5,\n \"segments\": []\n }\n ]\n }\n ],\n \"path_matches\": [\n {\n \"text\": \"src/\"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \".py\"\n }\n ],\n \"file\": {\n \"path\": \"src/foo.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n }\n }\n }\n ]\n}\n```\n\nNote that searches can match in the file's text (`content_matches`),\nthe path (`path_matches`), or both as in the example above.\n\nYou can use the same syntax for the search query as in the UI, e.g.\nto only search within a specific repository:\n\n```\ncurl 'https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/search/code?search_query=foo+repo:demo'\n# results from the \"demo\" repository\n```\n\nSimilar to other APIs, you can request more fields using a\n`fields` query parameter. E.g. to get some more information about\nthe repository of matched files (the `%2B` is a URL-encoded `+`):\n\n```\ncurl 'https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/search/code'\\\n '?search_query=foo&fields=%2Bvalues.file.commit.repository'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 1,\n \"content_matches\": [...],\n \"path_matches\": [...],\n \"file\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/commit/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo/commits/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n }\n },\n \"repository\": {\n \"name\": \"demo\",\n \"type\": \"repository\",\n \"full_name\": \"my-workspace/demo\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B850e1749-781a-4115-9316-df39d0600e7a%7D?ts=default\"\n }\n },\n \"uuid\": \"{850e1749-781a-4115-9316-df39d0600e7a}\"\n }\n },\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n },\n \"path\": \"src/foo.py\"\n }\n }\n ]\n}\n```\n\nTry `fields=%2Bvalues.*.*.*.*` to get an idea what's possible.\n", "method": "get", "endpoint": "users/:selected_user/search/code", "responses": [ { "uuid": "1dd00e57-f051-4061-b8ef-f63d8172faf1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful search", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "50f3dbfa-f25a-4d45-abcc-f09134331922", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the search request was invalid due to one of the\nfollowing reasons:\n\n* the specified type of target account doesn''t match the actual\naccount type;\n\n* malformed pagination properties;\n\n* missing or malformed search query, in the latter case an error\nkey will be returned in `error.data.key` property.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8c93c27a-9ab1-4f36-a75c-b160d9444bfd", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Search is not enabled for the requested user, navigate to [https://bitbucket.org/search](https://bitbucket.org/search) to turn it on", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "819b364a-2379-4b76-a305-a84533c52070", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 429, "label": "Too many requests, try again later", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a4b29f99-fc67-45d0-ab17-43ef9ec56b8b", "documentation": "Returns a paginated list of the user's SSH public keys.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys\n{\n \"page\": 1,\n \"pagelen\": 10,\n \"size\": 1,\n \"values\": [\n {\n \"comment\": \"user@myhost\",\n \"created_on\": \"2018-03-14T13:17:05.196003+00:00\",\n \"key\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY\",\n \"label\": \"\",\n \"last_used\": \"2018-03-20T13:18:05.196003+00:00\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a\"\n }\n },\n \"owner\": {\n \"display_name\": \"Mark Adams\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/markadams-atl/avatar/32/\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/markadams-atl/\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}\"\n }\n },\n \"type\": \"user\",\n \"username\": \"markadams-atl\",\n \"nickname\": \"markadams-atl\",\n \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\"\n },\n \"type\": \"ssh_key\",\n \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\"\n }\n ]\n}\n```", "method": "get", "endpoint": "users/:selected_user/ssh-keys", "responses": [ { "uuid": "821a80b2-c391-409a-92c3-74361fea503e", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "A list of the SSH keys associated with the account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d4b10764-b620-4ff5-9af8-882543107f6b", "body": "", "latency": 0, "statusCode": 403, "label": "If the specified user's keys are not accessible to the current user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8f6bc70b-6b7e-4c6a-be5d-576190d25160", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "76fecb6d-e28a-449f-bc50-b771ce725f71", "documentation": "Adds a new SSH public key to the specified user account and returns the resulting key.\n\nExample:\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\"key\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY user@myhost\"}' https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys\n\n{\n \"comment\": \"user@myhost\",\n \"created_on\": \"2018-03-14T13:17:05.196003+00:00\",\n \"key\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY\",\n \"label\": \"\",\n \"last_used\": \"2018-03-20T13:18:05.196003+00:00\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a\"\n }\n },\n \"owner\": {\n \"display_name\": \"Mark Adams\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/markadams-atl/avatar/32/\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/markadams-atl/\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}\"\n }\n },\n \"type\": \"user\",\n \"username\": \"markadams-atl\",\n \"nickname\": \"markadams-atl\",\n \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\"\n },\n \"type\": \"ssh_key\",\n \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\"\n}\n```", "method": "post", "endpoint": "users/:selected_user/ssh-keys", "responses": [ { "uuid": "2342dd3c-a8c4-4be4-8edb-965974d3bde8", "body": "\"\"", "latency": 0, "statusCode": 201, "label": "The newly created SSH key.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "404d56b4-4ea7-41dd-a87f-9875529082bf", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the submitted key or related value is invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9e8c6d8b-abcc-497e-bda0-a0d6ed7914df", "body": "", "latency": 0, "statusCode": 403, "label": "If the current user does not have permission to add a key for the specified user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4bcda828-9599-4802-a7b3-6cdaec30db92", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4e66824f-9b29-4772-8b66-c2341dace79e", "documentation": "Deletes a specific SSH public key from a user's account\n\nExample:\n```\n$ curl -X DELETE https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/{b15b6026-9c02-4626-b4ad-b905f99f763a}\n```", "method": "delete", "endpoint": "users/:selected_user/ssh-keys/:key_id", "responses": [ { "uuid": "11535ca7-d557-44b5-96e3-8d14f23db6be", "body": "", "latency": 0, "statusCode": 204, "label": "The key has been deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cdb2678d-896c-4eb9-a7d6-617a21bf650b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the submitted key or related value is invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cd9125e8-c3c4-4540-9a70-517658523873", "body": "", "latency": 0, "statusCode": 403, "label": "If the current user does not have permission to add a key for the specified user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fa2578cd-0e01-4c3f-bb54-e79228fe154d", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "05f9ad0f-346b-4647-8e2e-e0f99af44560", "documentation": "Returns a specific SSH public key belonging to a user.\n\nExample:\n```\n$ curl https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/{fbe4bbab-f6f7-4dde-956b-5c58323c54b3}\n\n{\n \"comment\": \"user@myhost\",\n \"created_on\": \"2018-03-14T13:17:05.196003+00:00\",\n \"key\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY\",\n \"label\": \"\",\n \"last_used\": \"2018-03-20T13:18:05.196003+00:00\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a\"\n }\n },\n \"owner\": {\n \"display_name\": \"Mark Adams\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/markadams-atl/avatar/32/\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/markadams-atl/\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}\"\n }\n },\n \"type\": \"user\",\n \"username\": \"markadams-atl\",\n \"nickname\": \"markadams-atl\",\n \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\"\n },\n \"type\": \"ssh_key\",\n \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\"\n}\n```", "method": "get", "endpoint": "users/:selected_user/ssh-keys/:key_id", "responses": [ { "uuid": "9e790262-5a90-4fb9-b9cf-3258dbdb2672", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The specific SSH key matching the user and UUID", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7312373b-1325-4f11-b8f2-689b8183b893", "body": "", "latency": 0, "statusCode": 403, "label": "If the specified user or key is not accessible to the current user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "25adc0e3-2221-4f09-88d4-3818e942e090", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user or key does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "026e4009-02ca-4a4d-99ec-f9ab1d13a36e", "documentation": "Updates a specific SSH public key on a user's account\n\nNote: Only the 'comment' field can be updated using this API. To modify the key or comment values, you must delete and add the key again.\n\nExample:\n```\n$ curl -X PUT -H \"Content-Type: application/json\" -d '{\"label\": \"Work key\"}' https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/{b15b6026-9c02-4626-b4ad-b905f99f763a}\n\n{\n \"comment\": \"\",\n \"created_on\": \"2018-03-14T13:17:05.196003+00:00\",\n \"key\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY\",\n \"label\": \"Work key\",\n \"last_used\": \"2018-03-20T13:18:05.196003+00:00\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a\"\n }\n },\n \"owner\": {\n \"display_name\": \"Mark Adams\",\n \"links\": {\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/markadams-atl/avatar/32/\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/markadams-atl/\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}\"\n }\n },\n \"type\": \"user\",\n \"username\": \"markadams-atl\",\n \"nickname\": \"markadams-atl\",\n \"uuid\": \"{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}\"\n },\n \"type\": \"ssh_key\",\n \"uuid\": \"{b15b6026-9c02-4626-b4ad-b905f99f763a}\"\n}\n```", "method": "put", "endpoint": "users/:selected_user/ssh-keys/:key_id", "responses": [ { "uuid": "773b5aa5-9b79-4835-91bd-5edd8f28ebbc", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The newly updated SSH key.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "026a4826-6f8e-483b-8d90-1c662795ffb7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the submitted key or related value is invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9f579255-225b-4983-b37c-0b48c075f3f0", "body": "", "latency": 0, "statusCode": 403, "label": "If the current user does not have permission to add a key for the specified user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3e52c2d3-5c46-47f6-bf84-6eba9e95f6f7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified user does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2ae5e616-aa1d-4313-bc68-69d4db85609a", "documentation": "**This endpoint has been deprecated,\nand you should use the [workspaces](../../workspaces/%7Bworkspace%7D/members) endpoint.\nFor more information, see [this post](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "users/:username/members", "responses": [ { "uuid": "0e577c13-448b-4105-b200-ea9f4061eaa2", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "All members", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7dfb5932-ca87-486e-b754-193939aa54d2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "When the team does not exist, or multiple teams with the same name exist that differ only in casing and the URL did not match the exact casing of a particular one.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "69d8313a-5cbc-40c0-8ed6-e23b15f2c26a", "documentation": "All repositories in the given workspace. This includes any private\nrepositories the calling user has access to.\n\n**This endpoint has been deprecated,\nand you should use the [repository list](../../repositories/%7Bworkspace%7D) endpoint.\nFor more information, see the [deprecation announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**", "method": "get", "endpoint": "users/:workspace/repositories", "responses": [ { "uuid": "d283ab58-e806-4097-bddd-96f0b1de9f1b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1d86e911-ab52-4399-9497-f750e64ed9a4", "documentation": "Returns a list of workspaces accessible by the authenticated user.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/workspaces\n\n{\n \"pagelen\": 10,\n \"page\": 1,\n \"size\": 1,\n \"values\": [\n {\n \"uuid\": \"{a15fb181-db1f-48f7-b41f-e1eff06929d6}\",\n \"links\": {\n \"owners\": {\n \"href\": \"https://api.bitbucket.org/2.0/workspaces/bbworkspace1/members?q=permission%3D%22owner%22\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/workspaces/bbworkspace1\"\n },\n \"repositories\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bbworkspace1\"\n },\n \"snippets\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/bbworkspace1\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bbworkspace1/\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/workspaces/bbworkspace1/avatar/?ts=1543465801\"\n },\n \"members\": {\n \"href\": \"https://api.bitbucket.org/2.0/workspaces/bbworkspace1/members\"\n },\n \"projects\": {\n \"href\": \"https://api.bitbucket.org/2.0/workspaces/bbworkspace1/projects\"\n }\n },\n \"created_on\": \"2018-11-14T19:15:05.058566+00:00\",\n \"type\": \"workspace\",\n \"slug\": \"bbworkspace1\",\n \"is_private\": true,\n \"name\": \"Atlassian Bitbucket\"\n }\n ]\n}\n```\n\nResults may be further [filtered or sorted](../meta/filtering) by\nworkspace or permission by adding the following query string parameters:\n\n* `q=slug=\"bbworkspace1\"` or `q=is_private=true`\n* `sort=created_on`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.", "method": "get", "endpoint": "workspaces", "responses": [ { "uuid": "c35a43f8-cd76-4846-944d-508afd76d106", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The list of workspaces accessible by the authenticated user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "aa312728-1d5b-42ee-a707-036ab98ef44a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "04d28d02-0641-4e56-bd76-d3157cfd3376", "documentation": "Returns the requested workspace.", "method": "get", "endpoint": "workspaces/:workspace", "responses": [ { "uuid": "af1c5c0b-2cce-4209-baec-8ad380201a73", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The workspace.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0ba43767-e947-4963-86cf-3a445a38be87", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If no workspace exists for the specified name or UUID.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "34015754-c0fc-45af-96cf-1a151477b351", "documentation": "Returns a paginated list of webhooks installed on this workspace.", "method": "get", "endpoint": "workspaces/:workspace/hooks", "responses": [ { "uuid": "085688b5-4d93-4be5-bf7e-fb90c45fe828", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The paginated list of installed webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0ab09776-95ed-4aa6-85d6-7e5061debbeb", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user is not an owner on the specified workspace.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5fdb7f4e-a97d-4ccc-9dd4-ae20788c95f9", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified workspace does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bba34dc8-0d22-4387-abc8-2140e28d781c", "documentation": "Creates a new webhook on the specified workspace.\n\nWorkspace webhooks are fired for events from all repositories contained\nby that workspace.\n\nNote that only owners can install webhooks on workspaces.", "method": "post", "endpoint": "workspaces/:workspace/hooks", "responses": [ { "uuid": "3d0b1e45-006d-4593-9218-b6097d076798", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The newly installed webhook.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c28feb37-343b-45c5-9de6-36db376aae85", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user is not an owner on the specified workspace.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "62a0e156-b663-4d75-b8c2-a3d95968147f", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the specified workspace does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "71fde8aa-9f07-40d5-99b4-e70ae252a004", "documentation": "Deletes the specified webhook subscription from the given workspace.", "method": "delete", "endpoint": "workspaces/:workspace/hooks/:uid", "responses": [ { "uuid": "afc259a7-85c7-4115-85aa-0e708eab3cbc", "body": "", "latency": 0, "statusCode": 204, "label": "When the webhook was deleted successfully", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "063c043e-b89f-4f6e-ab47-54085040eb54", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to delete the webhook.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8b646be1-937b-4548-87b4-2495063227a7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or workspace does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cce3a0d5-39c4-49bf-b555-aaf23756acec", "documentation": "Returns the webhook with the specified id installed on the given\nworkspace.", "method": "get", "endpoint": "workspaces/:workspace/hooks/:uid", "responses": [ { "uuid": "f7417964-6776-4767-a053-cbb9f126b48c", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The webhook subscription object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1ae5e111-986c-4a80-aecd-930891635986", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or workspace does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "93e1bb70-6351-4618-b68c-d3e0c00b4557", "documentation": "Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`", "method": "put", "endpoint": "workspaces/:workspace/hooks/:uid", "responses": [ { "uuid": "cd7527ae-c6b9-4185-8826-28419fa3febb", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The webhook subscription object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "37dfb147-0e7c-4b57-8d70-ca48d6a09b39", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If the authenticated user does not have permission to update the webhook.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d628e329-ba91-4c4e-9863-a58625bf996a", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the webhook or workspace does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "939c8151-d922-44fd-98f6-41685630aace", "documentation": "Returns all members of the requested workspace.", "method": "get", "endpoint": "workspaces/:workspace/members", "responses": [ { "uuid": "e8d280c9-9842-4999-ab09-0fb2210d41ac", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The list of users that are part of a workspace.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e0bf86fb-cd67-44b8-9bf3-58c0206ef2d6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7cabccaf-3eef-4c5a-ac9c-3ce78bb9b6c7", "documentation": "Returns the workspace membership, which includes\na `User` object for the member and a `Workspace` object\nfor the requested workspace.", "method": "get", "endpoint": "workspaces/:workspace/members/:member", "responses": [ { "uuid": "7d4757be-1e9e-470e-af6f-4c537df92427", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The user that is part of a workspace.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "829e1c0a-31b7-458d-a565-ea46481460ca", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "128b1ded-84a9-4d99-9b22-9e2a7cf6e24e", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A workspace cannot be found, or a user cannot be found, or the user is not a a member of the workspace.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d7fb5cbb-85fc-4d25-81b1-dbfd44978af7", "documentation": "Returns the list of members in a workspace\nand their permission levels.\nPermission can be:\n* `owner`\n* `collaborator`\n* `member`\n\nExample:\n\n```\n$ curl -X https://api.bitbucket.org/2.0/workspaces/bbworkspace1/permissions\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"permission\": \"owner\",\n \"type\": \"workspace_membership\",\n \"user\": {\n \"type\": \"user\",\n \"uuid\": \"{470c176d-3574-44ea-bb41-89e8638bcca4}\",\n \"display_name\": \"Erik van Zijst\",\n },\n \"workspace\": {\n \"type\": \"workspace\",\n \"uuid\": \"{a15fb181-db1f-48f7-b41f-e1eff06929d6}\",\n \"slug\": \"bbworkspace1\",\n \"name\": \"Atlassian Bitbucket\",\n }\n },\n {\n \"permission\": \"member\",\n \"type\": \"workspace_membership\",\n \"user\": {\n \"type\": \"user\",\n \"nickname\": \"seanaty\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n },\n \"workspace\": {\n \"type\": \"workspace\",\n \"uuid\": \"{a15fb181-db1f-48f7-b41f-e1eff06929d6}\",\n \"slug\": \"bbworkspace1\",\n \"name\": \"Atlassian Bitbucket\",\n }\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```\n\nResults may be further [filtered](../../../meta/filtering) by\npermission by adding the following query string parameters:\n\n* `q=permission=\"owner\"`", "method": "get", "endpoint": "workspaces/:workspace/permissions", "responses": [ { "uuid": "0b0a9c93-a5d3-4790-bfa1-dbcf7ff5e90a", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The list of users that are part of a workspace, along with their permission.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d4835c9d-ef6e-4a51-a9c5-aef53909c6b7", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1ce8c7aa-d6b7-454b-95b5-08012eb2d5fb", "documentation": "Returns an object for each repository permission for all of a\nworkspace's repositories.\n\nPermissions returned are effective permissions: the highest level of\npermission the user has. This does not distinguish between direct and\nindirect (group) privileges.\n\nOnly users with admin permission for the team may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/workspaces/atlassian_tutorial/permissions/repositories\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"admin\"\n },\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"write\"\n },\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Jeff Zeng\",\n \"uuid\": \"{47f92a9a-c3a3-4d0b-bc4e-782a969c5c72}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"whee\",\n \"full_name\": \"atlassian_tutorial/whee\",\n \"uuid\": \"{30ba25e9-51ff-4555-8dd0-fc7ee2fa0895}\"\n },\n \"permission\": \"admin\"\n }\n ],\n \"page\": 1,\n \"size\": 3\n}\n```\n\nResults may be further [filtered or sorted](../../../../meta/filtering)\nby repository, user, or permission by adding the following query string\nparameters:\n\n* `q=repository.name=\"geordi\"` or `q=permission>\"read\"`\n* `sort=user.display_name`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.", "method": "get", "endpoint": "workspaces/:workspace/permissions/repositories", "responses": [ { "uuid": "0b8d86a9-3502-4b1b-b5aa-829d666b6348", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "List of workspace's repository permissions.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "67f2c458-2295-400e-8c9f-cf3350a51013", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't an admin of the workspace.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "80ce47f7-106f-4b03-b072-cddc4d80a85c", "documentation": "Returns an object for the repository permission of each user in the\nrequested repository.\n\nPermissions returned are effective permissions: the highest level of\npermission the user has. This does not distinguish between direct and\nindirect (group) privileges.\n\nOnly users with admin permission for the repository may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/workspaces/atlassian_tutorial/permissions/repositories/geordi\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"admin\"\n },\n {\n \"type\": \"repository_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"write\"\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```\n\nResults may be further [filtered or sorted](../../../../meta/filtering)\nby user, or permission by adding the following query string parameters:\n\n* `q=permission>\"read\"`\n* `sort=user.display_name`\n\nNote that the query parameter values need to be URL escaped so that `=`\nwould become `%3D`.", "method": "get", "endpoint": "workspaces/:workspace/permissions/repositories/:repo_slug", "responses": [ { "uuid": "54799890-0895-4dac-936c-4f8424b86c3f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The respository permission for all users in this repository.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "50106cc9-8bcc-4feb-8716-3bf11772c885", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't an admin of the repository.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "db58acb4-15bc-4816-ac7b-00e0999ac95e", "documentation": "", "method": "get", "endpoint": "workspaces/:workspace/pipelines-config/identity/oidc/.well-known/openid-configuration", "responses": [ { "uuid": "9abff950-60b1-4c8b-a858-8f7ecae3932c", "body": "", "latency": 0, "statusCode": 200, "label": "Default response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "502b87b1-b6ea-44d2-abda-f983b6f1cf9f", "documentation": "", "method": "get", "endpoint": "workspaces/:workspace/pipelines-config/identity/oidc/keys.json", "responses": [ { "uuid": "ba6de8a4-54fa-4826-9039-73825d02f660", "body": "", "latency": 0, "statusCode": 200, "label": "Default response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a9b54a52-943a-4d7b-8035-adfedbfc32d1", "documentation": "Find workspace level variables.", "method": "get", "endpoint": "workspaces/:workspace/pipelines-config/variables", "responses": [ { "uuid": "489b2117-b8e7-4cf2-8b52-fca9c8bd4b7f", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The found workspace level variables.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "416d11d5-c65a-4396-9191-25aec3d39eb5", "documentation": "Create a workspace level variable.", "method": "post", "endpoint": "workspaces/:workspace/pipelines-config/variables", "responses": [ { "uuid": "6acb18f9-c7b7-41bb-8d04-51d4dfcf4cf3", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "The created variable.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "35e8bd26-a610-48a8-b434-823a56567c80", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The workspace does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "08efe4b5-3cf4-4693-8114-17123180bc96", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 409, "label": "A variable with the provided key already exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "24b770b6-4cb2-4cfb-97d8-6646d5f03e00", "documentation": "Delete a workspace level variable.", "method": "delete", "endpoint": "workspaces/:workspace/pipelines-config/variables/:variable_uuid", "responses": [ { "uuid": "995ddb13-7b8f-4e2a-9d91-9d442c60b557", "body": "", "latency": 0, "statusCode": 204, "label": "The variable was deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "914b79f9-d113-44f3-8717-01fe4d116600", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The workspace or the variable with the provided UUID does not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b6827ca8-ac6c-463a-ad3b-918a98486bad", "documentation": "Retrieve a workspace level variable.", "method": "get", "endpoint": "workspaces/:workspace/pipelines-config/variables/:variable_uuid", "responses": [ { "uuid": "df7a7ca3-00dc-42ff-bc9b-6aa4de45c946", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The variable.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "724f41eb-f760-4a43-84ec-9ca9a4fde877", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The workspace or variable with the given UUID was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a90b88ed-15b0-4fcf-9a15-269dd72ad84f", "documentation": "Update a workspace level variable.", "method": "put", "endpoint": "workspaces/:workspace/pipelines-config/variables/:variable_uuid", "responses": [ { "uuid": "eb9fd2fa-d3b0-42a6-84fb-ba6e3edde2af", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The variable was updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5f3ef167-5434-475b-b0da-56282917e387", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "The workspace or the variable was not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "34899cf7-0d75-4a38-b08a-5d691e26a5d4", "documentation": "Returns the list of projects in this workspace.", "method": "get", "endpoint": "workspaces/:workspace/projects", "responses": [ { "uuid": "35e3e7ad-33a2-4caa-9ccf-8dc953b6df21", "body": "{\n \"next\": \"\",\n \"page\": {{faker 'number.int' max=99999}},\n \"pagelen\": {{faker 'number.int' max=99999}},\n \"previous\": \"\",\n \"size\": {{faker 'number.int' max=99999}},\n \"values\": [\n {\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "The list of projects in this workspace.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b3b0dd7a-25c0-4ed3-87f1-bdcb4469ad70", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A workspace doesn't exist at this location.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5e1f854e-918c-414a-9108-8b1808b54abf", "documentation": "Creates a new project.\n\nNote that the avatar has to be embedded as either a data-url\nor a URL to an external image as shown in the examples below:\n\n```\n$ body=$(cat << EOF\n{\n \"name\": \"Mars Project\",\n \"key\": \"MARS\",\n \"description\": \"Software for colonizing mars.\",\n \"links\": {\n \"avatar\": {\n \"href\": \"data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/...\"\n }\n },\n \"is_private\": false\n}\nEOF\n)\n$ curl -H \"Content-Type: application/json\" \\\n -X POST \\\n -d \"$body\" \\\n https://api.bitbucket.org/2.0/teams/teams-in-space/projects/ | jq .\n{\n // Serialized project document\n}\n```\n\nor even:\n\n```\n$ body=$(cat << EOF\n{\n \"name\": \"Mars Project\",\n \"key\": \"MARS\",\n \"description\": \"Software for colonizing mars.\",\n \"links\": {\n \"avatar\": {\n \"href\": \"http://i.imgur.com/72tRx4w.gif\"\n }\n },\n \"is_private\": false\n}\nEOF\n)\n$ curl -H \"Content-Type: application/json\" \\\n -X POST \\\n -d \"$body\" \\\n https://api.bitbucket.org/2.0/teams/teams-in-space/projects/ | jq .\n{\n // Serialized project document\n}\n```", "method": "post", "endpoint": "workspaces/:workspace/projects", "responses": [ { "uuid": "3ad07858-5adc-43e0-a7c4-7b6c1ff1379c", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "A new project has been created.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "66b28bf7-d91c-4fca-9b01-39da0b12e355", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't authorized to create the project.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a3c412c2-fa58-4b12-95ac-fe9d44c3c829", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A workspace doesn't exist at this location.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1f6195f9-2dba-4abb-a0e3-4a2dc66a1b8c", "documentation": "Deletes this project. This is an irreversible operation.\n\nYou cannot delete a project that still contains repositories.\nTo delete the project, [delete](../../../repositories/%7Bworkspace%7D/%7Brepo_slug%7D#delete)\nor transfer the repositories first.\n\nExample:\n```\n$ curl -X DELETE https://api.bitbucket.org/2.0/bbworkspace1/PROJ\n```", "method": "delete", "endpoint": "workspaces/:workspace/projects/:project_key", "responses": [ { "uuid": "9c9426ac-34d3-40b7-9d3b-52fc46b6d55b", "body": "", "latency": 0, "statusCode": 204, "label": "Successful deletion.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7314d08b-f7ea-42fc-8c57-95f54d5ac2c2", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't authorized to delete the project or the project isn't empty.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5bb4becf-f6e6-45e0-bc04-fd864805f5e6", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A project isn't hosted at this location.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3001b001-d5fa-4cb6-aec9-2bf6e4b9b4a0", "documentation": "Returns the requested project.", "method": "get", "endpoint": "workspaces/:workspace/projects/:project_key", "responses": [ { "uuid": "6292a902-5a73-4be1-a7a3-6985cdccb682", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The project that is part of a workspace.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2cdb5e3f-8ca5-4383-856e-fc7cb0a1527b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request wasn't authenticated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9455fa2b-3f79-41fb-a5b7-c35bc679d7e4", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't authorized to access the project.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7efc6895-42e1-4dee-ac82-bbddd78fd3dd", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A project isn't hosted at this location.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "93cb5423-7377-4d72-b13a-0cd5fba16f62", "documentation": "Since this endpoint can be used to both update and to create a\nproject, the request body depends on the intent.\n\n### Creation\n\nSee the POST documentation for the project collection for an\nexample of the request body.\n\nNote: The `key` should not be specified in the body of request\n(since it is already present in the URL). The `name` is required,\neverything else is optional.\n\n### Update\n\nSee the POST documentation for the project collection for an\nexample of the request body.\n\nNote: The key is not required in the body (since it is already in\nthe URL). The key may be specified in the body, if the intent is\nto change the key itself. In such a scenario, the location of the\nproject is changed and is returned in the `Location` header of the\nresponse.", "method": "put", "endpoint": "workspaces/:workspace/projects/:project_key", "responses": [ { "uuid": "f9e0f2d3-327f-4aca-94ef-c21847e748cb", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The existing project is has been updated.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8189d2b5-ec28-4a73-9f49-b9ad4f0b64fe", "body": "{\n \"type\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "A new project has been created.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "442d3359-6eb0-4ed4-8454-d0b46ae97bcc", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The requesting user isn't authorized to update or create the project.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1d473a91-033e-42eb-a145-e84e4b39796f", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "A workspace doesn't exist at the location. Note that the project's absence from this location doesn't raise a 404, since a PUT at a non-existent location can be used to create a new project.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bdf594b8-d086-4d7c-b01a-d939a3f8d61c", "documentation": "Search for code in the repositories of the specified workspace.\n\nSearching across all repositories:\n\n```\ncurl 'https://api.bitbucket.org/2.0/workspaces/workspace_slug_or_uuid/search/code?search_query=foo'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 2,\n \"content_matches\": [\n {\n \"lines\": [\n {\n \"line\": 2,\n \"segments\": []\n },\n {\n \"line\": 3,\n \"segments\": [\n {\n \"text\": \"def \"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \"():\"\n }\n ]\n },\n {\n \"line\": 4,\n \"segments\": [\n {\n \"text\": \" print(\\\"snek\\\")\"\n }\n ]\n },\n {\n \"line\": 5,\n \"segments\": []\n }\n ]\n }\n ],\n \"path_matches\": [\n {\n \"text\": \"src/\"\n },\n {\n \"text\": \"foo\",\n \"match\": true\n },\n {\n \"text\": \".py\"\n }\n ],\n \"file\": {\n \"path\": \"src/foo.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n }\n }\n }\n ]\n}\n```\n\nNote that searches can match in the file's text (`content_matches`),\nthe path (`path_matches`), or both as in the example above.\n\nYou can use the same syntax for the search query as in the UI, e.g.\nto only search within a specific repository:\n\n```\ncurl 'https://api.bitbucket.org/2.0/workspaces/my-workspace/search/code?search_query=foo+repo:demo'\n# results from the \"demo\" repository\n```\n\nSimilar to other APIs, you can request more fields using a\n`fields` query parameter. E.g. to get some more information about\nthe repository of matched files (the `%2B` is a URL-encoded `+`):\n\n```\ncurl 'https://api.bitbucket.org/2.0/workspaces/my-workspace/search/code'\\\n '?search_query=foo&fields=%2Bvalues.file.commit.repository'\n{\n \"size\": 1,\n \"page\": 1,\n \"pagelen\": 10,\n \"query_substituted\": false,\n \"values\": [\n {\n \"type\": \"code_search_result\",\n \"content_match_count\": 1,\n \"content_matches\": [...],\n \"path_matches\": [...],\n \"file\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/commit/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo/commits/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b\"\n }\n },\n \"repository\": {\n \"name\": \"demo\",\n \"type\": \"repository\",\n \"full_name\": \"my-workspace/demo\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/my-workspace/demo\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B850e1749-781a-4115-9316-df39d0600e7a%7D?ts=default\"\n }\n },\n \"uuid\": \"{850e1749-781a-4115-9316-df39d0600e7a}\"\n }\n },\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py\"\n }\n },\n \"path\": \"src/foo.py\"\n }\n }\n ]\n}\n```\n\nTry `fields=%2Bvalues.*.*.*.*` to get an idea what's possible.\n", "method": "get", "endpoint": "workspaces/:workspace/search/code", "responses": [ { "uuid": "356fc877-1810-4dfd-b391-83530593ec99", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful search", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4c65c4c5-5084-4b3a-bdda-9bf4f4cb434b", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the search request was invalid due to one of the\nfollowing reasons:\n\n* the specified type of target account doesn''t match the actual\naccount type;\n\n* malformed pagination properties;\n\n* missing or malformed search query, in the latter case an error\nkey will be returned in `error.data.key` property.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bf59a6ff-2b6b-4f40-94a6-9214c3f1db59", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Search is not enabled for the requested workspace, navigate to [https://bitbucket.org/search](https://bitbucket.org/search) to turn it on", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "66245775-dd7e-4339-ad99-78d63ebdaf06", "body": "{\n \"error\": {\n \"data\": {},\n \"detail\": \"\",\n \"message\": \"\"\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 429, "label": "Too many requests, try again later", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "6b804b88-fc29-4eca-b13f-113775ae5177" }, { "type": "route", "uuid": "d5fe4b29-9285-4009-a4d4-fd01ffc4c264" }, { "type": "route", "uuid": "8301fcc6-eb53-4113-b8cf-18d74d1f5507" }, { "type": "route", "uuid": "7d040a70-6e57-4b51-9a8c-07775071af94" }, { "type": "route", "uuid": "1a7b635c-2c64-44d4-88cd-e3abc30572b7" }, { "type": "route", "uuid": "aef7bdff-8fcf-4200-a206-8a844c18f8d9" }, { "type": "route", "uuid": "584ad4cb-b627-4854-9d93-37d1309c4a45" }, { "type": "route", "uuid": "9a756aa4-576e-4869-9de3-26e809fbc00f" }, { "type": "route", "uuid": "bb77f97b-1489-4c3d-b48b-a9d5be246557" }, { "type": "route", "uuid": "773972b2-6e33-4ff0-b25e-f04505fa99cf" }, { "type": "route", "uuid": "209398ff-cee4-443d-9c40-3abfbbd8635e" }, { "type": "route", "uuid": "9cf60cba-d804-46d2-8e93-b55018d4d3d6" }, { "type": "route", "uuid": "be128031-b4d5-4ada-ae68-10de86e34e64" }, { "type": "route", "uuid": "f457d01a-8f0f-4aef-94e6-7bd02d7d40df" }, { "type": "route", "uuid": "e8c6ef63-e5bb-4903-a858-637d7877f78c" }, { "type": "route", "uuid": "624eaf4b-863b-4bd2-b40c-bdfdd1612534" }, { "type": "route", "uuid": "9b2475ab-149e-4c5b-bdc7-af89602300ce" }, { "type": "route", "uuid": "af0489d2-c88c-4763-86c9-c0493f5d78d6" }, { "type": "route", "uuid": "8eee435a-92e3-4137-8cb2-2ee56f326ba0" }, { "type": "route", "uuid": "04c72177-592d-421d-8b69-72e43d4980e6" }, { "type": "route", "uuid": "a32a000c-8356-4ac8-b0c0-bba6532c866f" }, { "type": "route", "uuid": "312d5559-4008-49a7-87d4-dbe060d3b283" }, { "type": "route", "uuid": "9bf7efde-ce0b-4d65-b50c-2668a0386908" }, { "type": "route", "uuid": "7dc8fbf4-d357-4ba6-91cf-174503fd6a05" }, { "type": "route", "uuid": "36247b18-5a8e-4676-9ad5-b1c0c85443cd" }, { "type": "route", "uuid": "a2a7f0cb-d8f9-4b25-b228-6dbe08e33559" }, { "type": "route", "uuid": "f7ecf5d8-f26a-42e2-a8cf-4d7c3ce468d0" }, { "type": "route", "uuid": "a7a46019-fe4b-4255-a720-4c0da49c5208" }, { "type": "route", "uuid": "3f32dc1d-95a4-43ec-8ba0-3133857b2d85" }, { "type": "route", "uuid": "f951b572-5bde-4b56-b533-35909650ce0a" }, { "type": "route", "uuid": "8a6110de-57de-4abf-8194-2e9d175b9221" }, { "type": "route", "uuid": "1a8ed47c-91d6-47ed-9753-44bc5fe01bcb" }, { "type": "route", "uuid": "60c07797-f229-4360-b900-bd85efacd8ea" }, { "type": "route", "uuid": "9d4ac18a-4cac-4eb2-9bc8-46f7350bd802" }, { "type": "route", "uuid": "013670b1-3ba9-44cd-a0d4-ef1dea65b8a8" }, { "type": "route", "uuid": "71d04d76-fe27-4426-bfe6-10ce126ea933" }, { "type": "route", "uuid": "4866b032-b8ab-451a-b8c0-af445ae1caf4" }, { "type": "route", "uuid": "0ab234a1-98f5-4c66-9bf0-851e4a422462" }, { "type": "route", "uuid": "a0788944-c7bc-4b27-9d27-8cde4a7c8423" }, { "type": "route", "uuid": "57f3ae70-db79-4836-b16e-f3f256b87233" }, { "type": "route", "uuid": "ba68156b-3966-4ee9-9f57-d3bbeba4f817" }, { "type": "route", "uuid": "63b8dc12-5eaa-4867-ac30-797c7f0b9b31" }, { "type": "route", "uuid": "db1fcd65-1d5a-4c21-b2b8-9adbe3e3cea4" }, { "type": "route", "uuid": "0b011ea0-3c34-40a2-97ab-30d986120dea" }, { "type": "route", "uuid": "20a7cf20-0a1a-4887-8c70-6f7527389864" }, { "type": "route", "uuid": "e9d258ed-e637-49c6-abbd-0204b3d5e257" }, { "type": "route", "uuid": "3a471bf6-cfad-4ca2-8fa3-35d0f804e57c" }, { "type": "route", "uuid": "a0e006ba-11b4-4399-8ad6-9bb8cc62f0b1" }, { "type": "route", "uuid": "76a7c5d4-1aa4-4edb-b269-ddbd560c93f7" }, { "type": "route", "uuid": "bc65ed2f-7c12-41ca-b975-3df7ccabbf6f" }, { "type": "route", "uuid": "81b29184-b64c-496a-9606-b46725eb07ca" }, { "type": "route", "uuid": "ef73b39a-9fa5-4f6c-811b-4f28cbeb575c" }, { "type": "route", "uuid": "55ea578f-436a-465b-a1e6-d1617eecb4d8" }, { "type": "route", "uuid": "2d4d8e61-9f33-4fc8-85f6-dd8c51527725" }, { "type": "route", "uuid": "d1122815-5b48-4a82-b0ce-2e9f566b3601" }, { "type": "route", "uuid": "2957324e-e683-457c-9242-f3dc82eb0b5d" }, { "type": "route", "uuid": "4cd51326-9cb5-42d0-b379-f0c526a75c2c" }, { "type": "route", "uuid": "34b20db8-50ec-4223-a144-6681d3deffc6" }, { "type": "route", "uuid": "b0a871fd-f930-4427-850d-4d9c227857b3" }, { "type": "route", "uuid": "e28ee7a9-00b6-4b23-971e-eb8e250c6f57" }, { "type": "route", "uuid": "fd7a4259-dc45-4fb0-8c46-88be89619708" }, { "type": "route", "uuid": "b195ebfb-0af5-4220-8aa1-40d59a6e45a7" }, { "type": "route", "uuid": "c7090cbc-cd0a-4b80-927e-5e3d56cd266c" }, { "type": "route", "uuid": "85050d03-fe54-4f3e-ae26-bf04fb6a7dc4" }, { "type": "route", "uuid": "f65fca8d-719e-4136-960e-745c9f448c85" }, { "type": "route", "uuid": "8e97428c-3668-4429-add8-5ba5fb0c88c7" }, { "type": "route", "uuid": "c8880e68-33bc-4305-8aa3-6833f887e818" }, { "type": "route", "uuid": "f22dc07b-f632-47d6-aac7-ac94e67d4b85" }, { "type": "route", "uuid": "9631167f-a8f3-47a8-9f5e-73278e33bc23" }, { "type": "route", "uuid": "3939e6f9-4737-48e1-aac1-ad6765475f39" }, { "type": "route", "uuid": "4235b796-825c-462e-b657-33db0c7858b2" }, { "type": "route", "uuid": "3df9903f-be1e-4c66-be8c-687e56183eff" }, { "type": "route", "uuid": "674b52de-ac5c-4945-a896-c9b06cdea11d" }, { "type": "route", "uuid": "771a58c1-2aa4-4035-8894-729599412260" }, { "type": "route", "uuid": "392da920-d463-4082-a5f5-1acae28bea42" }, { "type": "route", "uuid": "4de5e2a2-becc-450f-a51e-f0eca595291d" }, { "type": "route", "uuid": "5c8941f8-3f57-46b9-aad5-e9c045a208a5" }, { "type": "route", "uuid": "558fdae6-784a-4427-9405-140aa8967b7a" }, { "type": "route", "uuid": "35273119-7c17-4bdc-a3f2-b74d0cd353cd" }, { "type": "route", "uuid": "8d50b88c-b488-48db-82db-78f95a201182" }, { "type": "route", "uuid": "bf3ef872-39dc-4dcd-a731-5a28b15df38f" }, { "type": "route", "uuid": "c245f54c-e163-4f53-8cbf-dfbea2a96256" }, { "type": "route", "uuid": "5e5064e6-07a2-46cc-a173-1ac1c7a7b1cf" }, { "type": "route", "uuid": "dccff19e-4d9a-4cc1-9a56-cb37cf9c9147" }, { "type": "route", "uuid": "33ac372a-52f9-401a-b62e-4c32471f137a" }, { "type": "route", "uuid": "4bc6b6db-dd5d-48e2-8071-8c45964602ed" }, { "type": "route", "uuid": "64ee6180-cb44-475f-a326-cbc7e47e3d8b" }, { "type": "route", "uuid": "41cfa58f-4781-4292-8de5-8a993a594696" }, { "type": "route", "uuid": "74b25c8c-2084-478b-80fd-7a4d73fc3342" }, { "type": "route", "uuid": "c76b532e-0ab8-4389-bbf3-54e08f376693" }, { "type": "route", "uuid": "0df78279-2937-41b7-824d-e1cbb35ff267" }, { "type": "route", "uuid": "4f32c1ec-5e94-46a7-904d-7e38e96b3925" }, { "type": "route", "uuid": "8298662f-e1d6-43cb-a0d4-f62a2d07a081" }, { "type": "route", "uuid": "64cdbf0d-f87f-4d4c-b0b3-7694bb7177a7" }, { "type": "route", "uuid": "d2a18fbf-f4a3-4a8e-8e09-105d78bb78da" }, { "type": "route", "uuid": "d4a56835-2d1a-4ea4-8d55-4edffbac8992" }, { "type": "route", "uuid": "6029f56b-2699-4f71-a3dd-b8b9d599189d" }, { "type": "route", "uuid": "6973256f-44ef-4263-b353-156540d843ed" }, { "type": "route", "uuid": "84b05477-c328-42c3-827f-6003ec965ee1" }, { "type": "route", "uuid": "ef0340f2-f997-4830-8b81-1edc9b59e54a" }, { "type": "route", "uuid": "ac6925ae-b2f6-44f5-a7d4-ccb3b1a6713f" }, { "type": "route", "uuid": "6540d9e9-6e74-4e38-a5b2-84ab96937cd1" }, { "type": "route", "uuid": "28ccdea8-e415-41a5-b187-fd2f39c3c899" }, { "type": "route", "uuid": "b9a0ab52-adaa-41e5-bfd0-d6d76a07abd0" }, { "type": "route", "uuid": "dc2e2e07-2dba-4622-b4af-0113e13583ae" }, { "type": "route", "uuid": "3dc89478-1b66-470e-b09a-fcef8d9e96f6" }, { "type": "route", "uuid": "231b6361-dbd2-41de-848d-25d2959d621a" }, { "type": "route", "uuid": "50d33052-c2ca-43b2-bc25-e90904258e8e" }, { "type": "route", "uuid": "60f9f01f-d347-47c4-b97d-ea02c8bd87c9" }, { "type": "route", "uuid": "7af7b7a1-ac15-4941-b308-d791364e50e4" }, { "type": "route", "uuid": "19e2d7d1-212f-401e-8553-8d9c152e611b" }, { "type": "route", "uuid": "08804dcd-e675-4bd3-b5b0-ddcedd5539b2" }, { "type": "route", "uuid": "4dc27216-b802-4e34-8e69-800ff09fd3eb" }, { "type": "route", "uuid": "5a90e1d6-31a2-4da4-8aa9-2cdb12ed32ef" }, { "type": "route", "uuid": "26765860-fd68-4ab4-95d1-70da324a5b4a" }, { "type": "route", "uuid": "91c8f4a1-4d0d-48a8-b433-97f9971f46ec" }, { "type": "route", "uuid": "f922b630-aef6-4d5e-8e53-1d966c1aad5e" }, { "type": "route", "uuid": "4effe63d-206f-4542-a50b-95c7c197f79a" }, { "type": "route", "uuid": "912a0b18-c9a1-45a6-a187-048a471b57cf" }, { "type": "route", "uuid": "3a7123b4-9fb8-467b-b3d3-ee566b008f29" }, { "type": "route", "uuid": "3da3b545-b545-4dc7-babb-9c4a9d5677f4" }, { "type": "route", "uuid": "d16f5447-4954-4618-a41e-66dd155db566" }, { "type": "route", "uuid": "5146e5ae-8078-4721-82eb-a437abd4dc3a" }, { "type": "route", "uuid": "ea02e100-cd8e-442e-8f9e-766995c9420b" }, { "type": "route", "uuid": "14a866a3-1361-4f9a-9882-821257972876" }, { "type": "route", "uuid": "be7292b1-f39a-47ea-8882-0917f1cf8ff3" }, { "type": "route", "uuid": "e6493057-5856-45fd-9527-a16a088b9117" }, { "type": "route", "uuid": "2b8c0058-d6d4-49ed-82e5-2f6cbc665e67" }, { "type": "route", "uuid": "a0e9463c-8782-4893-8f5a-dac90442799e" }, { "type": "route", "uuid": "fe59313c-2e46-4005-bebb-d2017c5a61e6" }, { "type": "route", "uuid": "e4ffd47f-4cb7-4df2-bca6-bd04efdc4514" }, { "type": "route", "uuid": "97374aa7-5b9c-4ea3-9792-cbeb426bed78" }, { "type": "route", "uuid": "2556f03b-d397-47cd-a498-bfddfed5b674" }, { "type": "route", "uuid": "bd53dee5-9239-4441-a54d-80e760588795" }, { "type": "route", "uuid": "80f06e35-8fee-4859-b5a3-5bdd6b5020d6" }, { "type": "route", "uuid": "415a6f85-163c-4f77-bf96-5c5c4c6e106f" }, { "type": "route", "uuid": "b082da29-b06f-4ccb-8715-758c9738b3b7" }, { "type": "route", "uuid": "11fc0415-4218-42ec-8d16-7136ebcacd1b" }, { "type": "route", "uuid": "82591a26-e09c-4599-9652-cf8ddd04a6b5" }, { "type": "route", "uuid": "2a027942-d82f-41aa-8d59-109db557dfb1" }, { "type": "route", "uuid": "0d3123fa-c581-466c-a67b-99859afa23e0" }, { "type": "route", "uuid": "d129e3dc-868a-4c06-8995-e6ed127403ca" }, { "type": "route", "uuid": "419a1da4-cb35-4300-84ff-22c2cfb8be24" }, { "type": "route", "uuid": "88ab2472-f5f6-405b-9806-e854b546390f" }, { "type": "route", "uuid": "723d76a9-fe10-4b85-b7c8-62298f57dbad" }, { "type": "route", "uuid": "3fccb53c-20c6-4b08-96eb-606a152bc68e" }, { "type": "route", "uuid": "ef986246-b40f-4a08-a1be-061bd608ff7c" }, { "type": "route", "uuid": "cef3876d-407d-4ae0-8cd8-e2ed3c4f92e0" }, { "type": "route", "uuid": "e9b4fd64-9f0a-476d-a5a5-b54952d17ca6" }, { "type": "route", "uuid": "e4bca851-55ab-4396-9647-d4ed0efdc2df" }, { "type": "route", "uuid": "7b7405ac-b8e0-44da-a6e4-73f49390ae94" }, { "type": "route", "uuid": "88a65b8d-491d-4251-866b-dc19c9576b4f" }, { "type": "route", "uuid": "60a1ca38-e919-4eed-8a82-07ce66280699" }, { "type": "route", "uuid": "9bd4d219-c54f-4875-9906-e68547e357e6" }, { "type": "route", "uuid": "c5498a32-d967-4d3d-8d7a-bcbe42201ce5" }, { "type": "route", "uuid": "6d914a63-fc57-4810-a9cd-7ae1fabb446f" }, { "type": "route", "uuid": "d5bf3ea6-d768-4a2b-a33e-9dcb607d50a5" }, { "type": "route", "uuid": "67bfeac2-98b1-460d-a2fe-f85be6db8bbd" }, { "type": "route", "uuid": "622c9fad-f43c-48c2-9cf9-7deb76e5d1bc" }, { "type": "route", "uuid": "ba668eb2-cdc0-4e06-b5dc-2db74eb885a9" }, { "type": "route", "uuid": "5245b2d9-568e-4d4f-b074-d7ec2e9adc21" }, { "type": "route", "uuid": "59524fe2-1710-4ed0-884f-92b0eefc2b25" }, { "type": "route", "uuid": "01f7cd56-583c-4114-a9e4-9684f4dbc263" }, { "type": "route", "uuid": "2ddb1e82-7ac0-42ff-9f80-6cf286b9d833" }, { "type": "route", "uuid": "8d491c27-2ce6-4584-855f-d7aff0a75b3e" }, { "type": "route", "uuid": "76fc051d-2c09-4fb2-8873-b9f26982cbed" }, { "type": "route", "uuid": "e342257b-72fc-4210-9e95-545867ddd759" }, { "type": "route", "uuid": "a44dd480-f42e-487e-8578-8836d336a976" }, { "type": "route", "uuid": "3d87c1e2-a980-4285-b293-56a6283eea8c" }, { "type": "route", "uuid": "1e4c5324-960b-46ec-8e63-491e6ce59bc1" }, { "type": "route", "uuid": "ef20b92b-cfaa-4796-a3e7-d6c540de9c2c" }, { "type": "route", "uuid": "4a4111f7-69df-46f7-9c04-be20dd24256f" }, { "type": "route", "uuid": "9aa5cd6d-4cf4-476e-aa7c-f4ebfa3a880d" }, { "type": "route", "uuid": "e46b1bc8-32cf-46d8-b042-8800d2b7818f" }, { "type": "route", "uuid": "f16cf4aa-18bf-46ac-9d4b-e2b89ef0fbbd" }, { "type": "route", "uuid": "eba78943-a40a-4c33-a33f-471387ba0f16" }, { "type": "route", "uuid": "fae89fd7-6678-4f27-96ec-e110f46760de" }, { "type": "route", "uuid": "f54f56cd-b04c-48f7-9c53-66e7325f5c92" }, { "type": "route", "uuid": "c581fcd9-cae4-4c33-b859-3f7e3fada028" }, { "type": "route", "uuid": "aa3c831b-83b6-4a06-a068-529549cfac7e" }, { "type": "route", "uuid": "6a95fd8b-4ce8-4ab9-8385-b7264023a9a1" }, { "type": "route", "uuid": "6cd1651e-502e-4123-bcf6-c865c94f0aba" }, { "type": "route", "uuid": "41c5aa80-a9be-4b90-80fa-49cae3e96819" }, { "type": "route", "uuid": "eff67878-0f1d-468b-a124-a74047ffdc16" }, { "type": "route", "uuid": "d98b6297-a870-45a4-bbaa-a7fd63763bee" }, { "type": "route", "uuid": "99a75c9e-9d0a-4046-a48e-54cbeed76376" }, { "type": "route", "uuid": "331ba9d0-b0e9-4f6e-bf48-d58e09348d7d" }, { "type": "route", "uuid": "c928e790-ff61-431a-a877-a6da52747262" }, { "type": "route", "uuid": "d50f0044-0e10-4b88-b1c7-42f9d20c3559" }, { "type": "route", "uuid": "77006422-e4f1-4b13-b2f4-4d0ea7c92c55" }, { "type": "route", "uuid": "a78f4292-58cc-45df-884c-f282f9151988" }, { "type": "route", "uuid": "044529e3-74d2-4b97-9745-d177273438d9" }, { "type": "route", "uuid": "e2922d59-aec9-4b08-9c2f-8188662fb2f2" }, { "type": "route", "uuid": "ff035088-4007-43b1-8936-e93345c5712a" }, { "type": "route", "uuid": "022e1989-59fc-40c4-830d-1accda86f67c" }, { "type": "route", "uuid": "8a665987-f7c5-40a9-be64-56c6fd8cecba" }, { "type": "route", "uuid": "befa0bde-d7fc-42c3-ac72-e183c209e773" }, { "type": "route", "uuid": "c80e8124-0202-420b-b6f1-c695d930926d" }, { "type": "route", "uuid": "d2e59416-8e99-418d-8740-1cca2e365a2f" }, { "type": "route", "uuid": "7a904c9d-89b3-496f-82d8-82e88f9d7495" }, { "type": "route", "uuid": "28df7578-f967-4e98-9169-a619984428b5" }, { "type": "route", "uuid": "bd700f12-b8f2-4f1c-aec8-27736017ca15" }, { "type": "route", "uuid": "0498d58a-767f-4a11-872c-d85b9464c508" }, { "type": "route", "uuid": "4dd86fbb-5cb6-4b74-8fea-8d29c861b32c" }, { "type": "route", "uuid": "856b97ce-0a80-49c6-860a-811aa2350d91" }, { "type": "route", "uuid": "80699e49-6367-4757-95eb-1a4002a06cb5" }, { "type": "route", "uuid": "38fae0ca-57f4-4897-9048-30c658685aaf" }, { "type": "route", "uuid": "fb0c31d0-f010-48f3-a1fe-729808ea1a0b" }, { "type": "route", "uuid": "80d1f5c7-43eb-46e5-99fc-9862e46905d8" }, { "type": "route", "uuid": "40efbd2e-9242-441b-a15b-f45bd55c1935" }, { "type": "route", "uuid": "44563494-eddb-4134-8af0-088bbb59d2c6" }, { "type": "route", "uuid": "24c9fb35-5b70-4804-ac2f-b824a046b9fc" }, { "type": "route", "uuid": "fed93225-fa14-4689-8d9a-3d061ee5d7f3" }, { "type": "route", "uuid": "43815856-d638-4fef-acdf-202d836177df" }, { "type": "route", "uuid": "ec44b451-3423-45e5-ad14-79f723275234" }, { "type": "route", "uuid": "f6f84ec3-9bd9-47a2-a339-c99d114b9cfe" }, { "type": "route", "uuid": "5d6c54a7-7257-4e6b-a771-0a7e9fab8d65" }, { "type": "route", "uuid": "398dc8ed-8b6a-49d2-81ce-c9880495c48b" }, { "type": "route", "uuid": "0912a445-5178-40c3-9dec-f9bad1acbbb7" }, { "type": "route", "uuid": "9d91df67-98b9-4a92-aeef-bb1783338f6f" }, { "type": "route", "uuid": "6a62c605-c7d5-4244-847a-361c4b901b8b" }, { "type": "route", "uuid": "a2804eda-a5df-4b3f-a5ff-bec6c05db069" }, { "type": "route", "uuid": "59a7c49c-8921-4a64-9b44-63218d603e74" }, { "type": "route", "uuid": "1a32a7a9-24d0-4a61-a723-d028306c40ca" }, { "type": "route", "uuid": "efa8e197-5f4c-40ec-a69d-e3944a63dc82" }, { "type": "route", "uuid": "2052a79b-e40e-4eb3-a610-dea22d651d63" }, { "type": "route", "uuid": "e088def9-d7d1-481b-92e5-fc33e8cd1bd1" }, { "type": "route", "uuid": "779a640e-1962-4d39-a65f-8c4249efa2e4" }, { "type": "route", "uuid": "dcf2b980-dc97-4f33-b625-fce3f32499c7" }, { "type": "route", "uuid": "7a26dbe6-ac52-4099-8070-34bf19ac7536" }, { "type": "route", "uuid": "a0250237-c7b3-482d-8681-36964abcf4c0" }, { "type": "route", "uuid": "e357b69e-045b-4b0f-82ec-b55987139bb9" }, { "type": "route", "uuid": "7d1be112-b54a-4367-81bf-327d3e33322f" }, { "type": "route", "uuid": "f66e7e75-c570-470c-b914-e27f6d3aaeac" }, { "type": "route", "uuid": "158ebc45-51b9-4a96-ae21-bd8e8a977e04" }, { "type": "route", "uuid": "8b31063f-8d76-4bc8-a785-c5b8db70d5c7" }, { "type": "route", "uuid": "22cdabb1-7850-44b2-a4cb-597bd8119ecf" }, { "type": "route", "uuid": "65667bee-8a62-4bef-abc3-6c5d59433178" }, { "type": "route", "uuid": "311549d8-8ce5-47ef-9b40-7ae81dce9dcc" }, { "type": "route", "uuid": "5c7445f1-4697-48d8-8e40-d4d36f66c1d8" }, { "type": "route", "uuid": "08e0d3d2-4f94-41d6-b985-0719f6d790ce" }, { "type": "route", "uuid": "20108808-f4a1-4db1-9fe0-aebc3dfb67d8" }, { "type": "route", "uuid": "649b0f57-f8a8-40a6-8029-3f9850b0cb05" }, { "type": "route", "uuid": "c773acbd-1d61-43c2-9ce4-5e37572889eb" }, { "type": "route", "uuid": "936e3cbb-f898-4e2c-9314-81f05b8216bb" }, { "type": "route", "uuid": "7f67af91-6c86-4097-a9de-2714fc8f5153" }, { "type": "route", "uuid": "7c7be944-1f6a-4cfc-8078-dcfd963cee7e" }, { "type": "route", "uuid": "27a490be-15f5-452a-8ae4-c0e639c2d9fe" }, { "type": "route", "uuid": "91acaea9-453b-4cd3-a8e1-7ede5d639adf" }, { "type": "route", "uuid": "1039d78c-6e7f-4bb8-9428-3401a98143d3" }, { "type": "route", "uuid": "81007440-fc15-4d89-af35-5df2e1257782" }, { "type": "route", "uuid": "f0a0a51f-a792-4d3f-b6c5-739ab5dbd399" }, { "type": "route", "uuid": "47f1be91-f21a-4cc7-82cf-23054f728b1d" }, { "type": "route", "uuid": "51d6c8b4-4064-4366-9ea8-f59c39406fa1" }, { "type": "route", "uuid": "45b3de1e-3f89-4274-88eb-50be5d64c299" }, { "type": "route", "uuid": "87e08cdf-c2e0-4c53-a0cb-46ed889e78f7" }, { "type": "route", "uuid": "54b91fb1-bbf4-43a2-9614-d8b1e90a9623" }, { "type": "route", "uuid": "f3f9a1ae-47ea-48ae-9474-25d3c3b6902d" }, { "type": "route", "uuid": "3c3f64ad-8565-41f0-a8e8-9d3700d839ca" }, { "type": "route", "uuid": "f2a059ee-1d22-4089-beb5-3232cd39604b" }, { "type": "route", "uuid": "c409aa01-c5db-4589-b1d4-e612bc3c6852" }, { "type": "route", "uuid": "0b134262-08ca-4ca1-a9d0-872477a06122" }, { "type": "route", "uuid": "794fbf86-fce9-46e9-a511-456eb7dbd709" }, { "type": "route", "uuid": "5fba987a-1df3-4978-932e-c35d2cb6f018" }, { "type": "route", "uuid": "5b15aa51-3b26-48c1-8b3e-7267647d7f66" }, { "type": "route", "uuid": "7368731a-7301-4707-88d0-411b4a354de3" }, { "type": "route", "uuid": "e1af3607-0be9-4dbf-9eec-689742dc6bf2" }, { "type": "route", "uuid": "9bf57353-7984-4483-815f-06110547a5c3" }, { "type": "route", "uuid": "6a267a00-210c-4c7b-974e-6d7ef2c05609" }, { "type": "route", "uuid": "f5bc4f71-5ac6-4f59-b63b-c134b92d1b0d" }, { "type": "route", "uuid": "610747fa-dbe7-4ba1-bb79-5c72a091171a" }, { "type": "route", "uuid": "361e98bb-c03a-47d1-8313-80f2f2eab695" }, { "type": "route", "uuid": "a4b29f99-fc67-45d0-ab17-43ef9ec56b8b" }, { "type": "route", "uuid": "76fecb6d-e28a-449f-bc50-b771ce725f71" }, { "type": "route", "uuid": "4e66824f-9b29-4772-8b66-c2341dace79e" }, { "type": "route", "uuid": "05f9ad0f-346b-4647-8e2e-e0f99af44560" }, { "type": "route", "uuid": "026e4009-02ca-4a4d-99ec-f9ab1d13a36e" }, { "type": "route", "uuid": "2ae5e616-aa1d-4313-bc68-69d4db85609a" }, { "type": "route", "uuid": "69d8313a-5cbc-40c0-8ed6-e23b15f2c26a" }, { "type": "route", "uuid": "1d86e911-ab52-4399-9497-f750e64ed9a4" }, { "type": "route", "uuid": "04d28d02-0641-4e56-bd76-d3157cfd3376" }, { "type": "route", "uuid": "34015754-c0fc-45af-96cf-1a151477b351" }, { "type": "route", "uuid": "bba34dc8-0d22-4387-abc8-2140e28d781c" }, { "type": "route", "uuid": "71fde8aa-9f07-40d5-99b4-e70ae252a004" }, { "type": "route", "uuid": "cce3a0d5-39c4-49bf-b555-aaf23756acec" }, { "type": "route", "uuid": "93e1bb70-6351-4618-b68c-d3e0c00b4557" }, { "type": "route", "uuid": "939c8151-d922-44fd-98f6-41685630aace" }, { "type": "route", "uuid": "7cabccaf-3eef-4c5a-ac9c-3ce78bb9b6c7" }, { "type": "route", "uuid": "d7fb5cbb-85fc-4d25-81b1-dbfd44978af7" }, { "type": "route", "uuid": "1ce8c7aa-d6b7-454b-95b5-08012eb2d5fb" }, { "type": "route", "uuid": "80ce47f7-106f-4b03-b072-cddc4d80a85c" }, { "type": "route", "uuid": "db58acb4-15bc-4816-ac7b-00e0999ac95e" }, { "type": "route", "uuid": "502b87b1-b6ea-44d2-abda-f983b6f1cf9f" }, { "type": "route", "uuid": "a9b54a52-943a-4d7b-8035-adfedbfc32d1" }, { "type": "route", "uuid": "416d11d5-c65a-4396-9191-25aec3d39eb5" }, { "type": "route", "uuid": "24b770b6-4cb2-4cfb-97d8-6646d5f03e00" }, { "type": "route", "uuid": "b6827ca8-ac6c-463a-ad3b-918a98486bad" }, { "type": "route", "uuid": "a90b88ed-15b0-4fcf-9a15-269dd72ad84f" }, { "type": "route", "uuid": "34899cf7-0d75-4a38-b08a-5d691e26a5d4" }, { "type": "route", "uuid": "5e1f854e-918c-414a-9108-8b1808b54abf" }, { "type": "route", "uuid": "1f6195f9-2dba-4abb-a0e3-4a2dc66a1b8c" }, { "type": "route", "uuid": "3001b001-d5fa-4cb6-aec9-2bf6e4b9b4a0" }, { "type": "route", "uuid": "93cb5423-7377-4d72-b13a-0cd5fba16f62" }, { "type": "route", "uuid": "bdf594b8-d086-4d7c-b01a-d939a3f8d61c" } ] }