Sign in

v1

latestOpenAPI 3.0.02026-07-13103151174.7 KB
Variables

Create a Variable

post/v1/projects/{project}/variables

Path parameters

projectstring required

A Project key or ID

Request body

namestring

Variable name

descriptionstring

A description of the Variable

keystring required

Unique Variable identifier, can be used in the SDK / API to reference by key rather then ID. Must only contain lower-case characters and _, - or ..

_featurestring

The ID of the Feature this Variable belongs to

type'String' | 'Boolean' | 'Number' | 'JSON' required

The type of Variable. Must be one of [String | Boolean | Number | JSON]

tagsstring[]

Feature tags.

Example request

{
  "name": "Show New Dashboard",
  "description": "A boolean variable that will toggle the new dashboard feature",
  "key": "show-new-dashboard",
  "_feature": "61450f3daec96f5cf4a49947",
  "type": "Boolean",
  "tags": [
    "new",
    "dashboard"
  ]
}

Response

namestring

Variable name

descriptionstring

A description of the Variable

keystring required

Unique Variable identifier, can be used in the SDK / API to reference by key rather then ID. Must only contain lower-case characters and _, - or ..

_idstring required

A unique Variable ID

_projectstring required

The ID of the Project this Variable belongs to

_featurestring

The ID of the Feature this Variable belongs to

type'String' | 'Boolean' | 'Number' | 'JSON' required

The type of Variable. Must be one of [String | Boolean | Number | JSON]

status'active' | 'archived' required

The status of a Variable. Must be one of [active | archived]

source'api' | 'dashboard' | 'importer' | 'github.code_usages' | 'github.pr_insights' | 'gitlab.code_usages' | 'gitlab.pr_insights' | 'bitbucket.code_usages' | 'bitbucket.pr_insights' | 'terraform' | 'cli' | 'slack' | 'mcp' required

The system that was used for the creation of the Variable.

_createdBystring

ID of the User who created the Variable.

createdAtstring date-time required

The date the Variable was created

updatedAtstring date-time required

The date the Variable was last updated

persistentboolean

Boolean indicating if the variable is intended to be long-lived within a feature

tagsstring[]

Tags to organize Variables on the dashboard

Example response

{
  "name": "Show New Dashboard",
  "description": "A boolean variable that will toggle the new dashboard feature",
  "key": "show-new-dashboard",
  "_id": "61450f3daec96f5cf4a49946",
  "_feature": "61450f3daec96f5cf4a49947",
  "type": "Boolean",
  "status": "active",
  "source": "api",
  "tags": [
    "Dashboard",
    "QA"
  ]
}