Create a variable for a user

Deprecated

POST

/users/{selected_user}/pipelines_config/variables

Create a user level variable. This endpoint has been deprecated, and you should use the new workspaces endpoint. For more information, see the announcement.

Authorizations

• oauth2
  pipeline:variable
• basic
• api_key

Parameters

Path Parameters

selected_user

required

string

Either the UUID of the account surrounded by curly-braces, for example {account UUID}, OR an Atlassian Account ID.

Request Body

The variable to create.

Media type application/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

201

The created variable.

Media type application/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
}

Headers

Location

string

The URL of the newly created pipeline variable.

404

The account 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": {}
  }
}

409

A variable with the provided key already exists.

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