Skip to main content

Update specific variables defined for a cluster profile

PATCH 
/v1/clusterprofiles/:uid/variables

Update specific variables defined for a cluster profile

Request​

Path Parameters

    uid stringrequired

    Cluster profile uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    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

  • ]

Responses​

The resource was updated successfully

Loading...