Retrieve a list of variables associated with the cluster

GET 
/v1/spectroclusters/:uid/variables

Retrieve a list of variables associated with the cluster

Request

Path Parameters

uid stringrequired

Cluster uid for which variables need to be retrieved

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

(empty)

application/json

Schema

Schema

variables

object[]

List of unique variable fields with schema constraints

Array [

defaultValuestring

The default value of the variable

descriptionstring

Variable description

displayNamestring

Unique display name of the variable

formatstring

Possible values: [string, number, boolean, ipv4, ipv4cidr, ipv6, version]

Default value: string

Format type of the variable value

hiddenboolean

If true, then variable will be hidden for overriding the value. By default the hidden flag will be set to false

immutableboolean

If true, then variable value can't be editable. By default the immutable flag will be set to false

isSensitiveboolean

If true, then default value will be masked. By default the isSensitive flag will be set to false

namestringrequired

Variable name

regexstring

Regular expression pattern which the variable value must match

requiredboolean

Flag to specify if the variable is optional or mandatory. If it is mandatory then default value must be provided

]

Example (from schema)

{
  "variables": [
    {
      "defaultValue": "string",
      "description": "string",
      "displayName": "string",
      "format": "string",
      "hidden": true,
      "immutable": true,
      "isSensitive": true,
      "name": "string",
      "regex": "string",
      "required": true
    }
  ]
}

Loading...