Create a build status for a commit

POST

/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build

Creates a new build status against the specified commit.

If the specified key already exists, the existing status object will be overwritten.

Example:

curl 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 '{
    "key": "MY-BUILD",
    "state": "SUCCESSFUL",
    "description": "42 tests passed",
    "url": "https://www.example.org/my-build-result"
  }'

When creating a new commit status, you can use a URI template for the URL. Templates are URLs that contain variable names that Bitbucket will evaluate at runtime whenever the URL is displayed anywhere similar to parameter substitution in Bitbucket Connect. For example, one could use https://foo.com/builds/{repository.full_name} which Bitbucket will turn into https://foo.com/builds/foo/bar at render time. The context variables available are repository and commit.

To associate a commit status to a pull request, the refname field must be set to the source branch of the pull request.

Example:

curl 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 '{
    "key": "MY-BUILD",
    "state": "SUCCESSFUL",
    "description": "42 tests passed",
    "url": "https://www.example.org/my-build-result",
    "refname": "my-pr-branch"
  }'

Authorizations

• oauth2
  repository
• basic
• api_key

Parameters

Path Parameters

commit

required

string

The commit’s SHA1.

repo_slug

required

string

This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

workspace

required

string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

Request Body

The new commit status object.

Media type application/json

object

type

required

string

links

object

self

Link

A link to a resource related to this object.

object

href

string format: uri

name

string

commit

Link

A link to a resource related to this object.

object

href

string format: uri

name

string

key

required

An identifier for the status that’s unique to its type (current “build” is the only supported type) and the vendor, e.g. BB-DEPLOY

string

refname

The name of the ref that pointed to this commit at the time the status object was created. Note that this the ref may since have moved off of the commit. This optional field can be useful for build systems whose build triggers and configuration are branch-dependent (e.g. a Pipeline build). It is legitimate for this field to not be set, or even apply (e.g. a static linting job).

string

url

A URL linking back to the vendor or build system, for providing more information about whatever process produced this status. Accepts context variables repository and commit that Bitbucket will evaluate at runtime whenever at runtime. For example, one could use https://foo.com/builds/{repository.full_name} which Bitbucket will turn into https://foo.com/builds/foo/bar at render time.

string

state

required

Provides some indication of the status of this commit

string

Allowed values: FAILED INPROGRESS STOPPED SUCCESSFUL

name

An identifier for the build itself, e.g. BB-DEPLOY-1

string

description

A description of the build (e.g. “Unit tests in Bamboo”)

string

created_on

string format: date-time

updated_on

string format: date-time

Responses

201

The newly created build status object.

Media type application/json

object

type

required

string

links

object

self

Link

A link to a resource related to this object.

object

href

string format: uri

name

string

commit

Link

A link to a resource related to this object.

object

href

string format: uri

name

string

key

required

An identifier for the status that’s unique to its type (current “build” is the only supported type) and the vendor, e.g. BB-DEPLOY

string

refname

The name of the ref that pointed to this commit at the time the status object was created. Note that this the ref may since have moved off of the commit. This optional field can be useful for build systems whose build triggers and configuration are branch-dependent (e.g. a Pipeline build). It is legitimate for this field to not be set, or even apply (e.g. a static linting job).

string

url

A URL linking back to the vendor or build system, for providing more information about whatever process produced this status. Accepts context variables repository and commit that Bitbucket will evaluate at runtime whenever at runtime. For example, one could use https://foo.com/builds/{repository.full_name} which Bitbucket will turn into https://foo.com/builds/foo/bar at render time.

string

state

required

Provides some indication of the status of this commit

string

Allowed values: FAILED INPROGRESS STOPPED SUCCESSFUL

name

An identifier for the build itself, e.g. BB-DEPLOY-1

string

description

A description of the build (e.g. “Unit tests in Bamboo”)

string

created_on

string format: date-time

updated_on

string format: date-time

Example

{
  "state": "FAILED"
}

401

If the repository is private and the request was not authenticated.

404

If the repository, commit, or build status key does not exist

Media type application/json

Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object

type

required

string

error

object

message

required

string

detail

string

data

Optional structured data that is endpoint-specific.

object

key

additional properties

any

key

additional properties

any

Example ^generated

{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}