contentstack · Schema

CreateVariableRequest

Parameters for creating a project variable.

Properties

Name Type Description
name string Display name for the variable.
key string Machine-readable key for the variable.
value string Value to store in the variable.
is_secret boolean Set to true to mark the variable as a secret.
View JSON Schema on GitHub

JSON Schema

contentstack-createvariablerequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateVariableRequest",
  "title": "CreateVariableRequest",
  "type": "object",
  "description": "Parameters for creating a project variable.",
  "required": [
    "name",
    "key",
    "value"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the variable."
    },
    "key": {
      "type": "string",
      "description": "Machine-readable key for the variable."
    },
    "value": {
      "type": "string",
      "description": "Value to store in the variable."
    },
    "is_secret": {
      "type": "boolean",
      "description": "Set to true to mark the variable as a secret.",
      "default": false
    }
  }
}