POST /repositories/{workspace}/{repo_slug}/refs/tags

Creates a new tag in the specified repository.

The payload of the POST should consist of a JSON document that contains the name of the tag and the target hash.

curl https://api.bitbucket.org/2.0/repositories/jdoe/myrepo/refs/tags \
-s -u jdoe -X POST -H "Content-Type: application/json" \
-d '{
    "name" : "new-tag-name",
    "target" : {
        "hash" : "a1b2c3d4e5f6",
    }
}'

This endpoint does support using short hash prefixes for the commit hash, but it may return a 400 response if the provided prefix is ambiguous. Using a full commit hash is the preferred approach.

Servers

https://api.bitbucket.org/2.0

Path parameters

Name	Type	Required	Description
`repo_slug`	String	Yes	This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`.
`workspace`	String	Yes	This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`name`	String	No	The name of the ref.
`message`	String	No	The message associated with the tag, if available.
`type`	String	Yes
`links`	Object	No
`links.html`	Object	No	A link to a resource related to this object.
`links.html.href`	String	No
`links.html.name`	String	No
`links.self`	Object	No	A link to a resource related to this object.
`links.self.href`	String	No
`links.self.name`	String	No
`links.commits`	Object	No	A link to a resource related to this object.
`links.commits.href`	String	No
`links.commits.name`	String	No
`date`	String	No	The date that the tag was created, if available

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.