Global Variable

Information about the global variable.

APIs.ioEngineeringPlatform

Properties

Name Type Description
key string The variable's name.
type string The [type](https://learning.postman.com/docs/sending-requests/variables/#variable-types) of variable.
value string The variable's value.
enabled boolean If true, the variable is enabled.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-globalvariable-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/globalVariable",
  "title": "Global Variable",
  "type": "object",
  "description": "Information about the global variable.",
  "properties": {
    "key": {
      "type": "string",
      "description": "The variable's name.",
      "example": "variableName"
    },
    "type": {
      "type": "string",
      "description": "The [type](https://learning.postman.com/docs/sending-requests/variables/#variable-types) of variable.",
      "enum": [
        "default",
        "secret"
      ],
      "example": "default"
    },
    "value": {
      "type": "string",
      "description": "The variable's value.",
      "example": "variableValue"
    },
    "enabled": {
      "type": "boolean",
      "description": "If true, the variable is enabled.",
      "example": true
    }
  }
}