Update variable for a workspace

PUT

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

Update a workspace level variable.

Authorizations

• oauth2
  pipeline:variable
• basic
• api_key

Parameters

Path Parameters

workspace

required

string

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

variable_uuid

required

string

The UUID of the variable.

Request Body^required

The updated variable.

Media typeapplication/json

object

type

required

string

uuid

The UUID identifying the variable.

string

key

The unique name of the variable.

string

value

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

string

secured

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

boolean

Example^generated

{
  "type": "example",
  "uuid": "example",
  "key": "example",
  "value": "example",
  "secured": true
}

Responses

200

The variable was updated.

Media typeapplication/json

object

type

required

string

uuid

The UUID identifying the variable.

string

key

The unique name of the variable.

string

value

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

string

secured

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

boolean

Example^generated

{
  "type": "example",
  "uuid": "example",
  "key": "example",
  "value": "example",
  "secured": true
}

404

The workspace or the variable was not found.

Media typeapplication/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": {}
  }
}