Skip to content
forgit api docs

List variables for a workspace

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

Find workspace level variables.

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}.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The found workspace level variables.

Media type application/json
Paginated Pipeline Variables

A paged list of variables.

object
page

Page number of the current results. This is an optional element that is not provided in all responses.

integer
values

The values of the current page.

Array
0
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
size

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

integer
pagelen

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

integer
next

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
previous

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
Example generated 
{
  "page": 1,
  "values": [
    {
      "type": "example",
      "uuid": "example",
      "key": "example",
      "value": "example",
      "secured": true
    }
  ],
  "size": 1,
  "pagelen": 1,
  "next": "https://example.com",
  "previous": "https://example.com"
}