Pipelines

Create a variable for a workspace

Create a workspace level variable.

post/workspaces/{workspace}/pipelines-config/variables

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • URL
    https://api.bitbucket.org/2.0/workspaces/{workspace}/pipelines-config/variables
  • Auth
    • OAuth 2
      Authorization code: https://bitbucket.org/site/oauth2/authorize
      Token URL: https://bitbucket.org/site/oauth2/access_token scopes: pipeline:variable
    • or HTTP basic
    • or API key in header Authorization

Path parameters

workspacestring required

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

Request body

typestring required
uuidstring

The UUID identifying the variable.

keystring

The unique name of the variable.

valuestring

The value of the variable. If the variable is secured, this will be empty.

securedboolean

If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.

Response

The created variable.

typestring required
uuidstring

The UUID identifying the variable.

keystring

The unique name of the variable.

valuestring

The value of the variable. If the variable is secured, this will be empty.

securedboolean

If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.

Changes

No recorded changes to this operation across all 15 revisions of this API.