Skip to content
forgit api docs

Create a variable for a workspace

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

Create a workspace level variable.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ 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}.

Request Body

Section titled “ 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

Section titled “ Responses ”

201

Section titled “ 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

Section titled “ Headers ”
Location
string

The URL of the newly created pipeline variable.

404

Section titled “ 404 ”

The workspace 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

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