Environment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/admin-api-environment-schema.json",
  "title": "Environment",
  "description": "Environment schema from WSO2 API Manager",
  "required": [
    "name",
    "vhosts"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "example": "ece92bdc-e1e6-325c-b6f4-656208a041e9"
    },
    "name": {
      "maxLength": 255,
      "minLength": 1,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "type": "string",
      "example": "us-region"
    },
    "displayName": {
      "maxLength": 255,
      "minLength": 1,
      "type": "string",
      "example": "US Region"
    },
    "provider": {
      "type": "string",
      "example": "wso2"
    },
    "type": {
      "type": "string",
      "default": "hybrid",
      "example": "hybrid"
    },
    "gatewayType": {
      "type": "string",
      "example": "Regular",
      "default": "Regular"
    },
    "description": {
      "maxLength": 1023,
      "type": "string",
      "example": "Gateway environment in US Region"
    },
    "isReadOnly": {
      "type": "boolean",
      "example": false,
      "default": false,
      "deprecated": true
    },
    "mode": {
      "type": "string",
      "enum": [
        "READ_ONLY",
        "READ_WRITE",
        "WRITE_ONLY"
      ],
      "example": "READ_WRITE",
      "default": "WRITE_ONLY",
      "description": "The mode of the environment. This indicates whether the environment is in read-only or read-write mode.\n**READ_ONLY:** The environment is in read-only mode. API cannot be deployed, only discovery is possible.\n**READ_WRITE:** The environment is in read-write mode. APIs can be deployed and discovered.\n**WRITE_ONLY:** The environment is in write-only mode/ APIs only can be deployed.\n"
    },
    "apiDiscoveryScheduledWindow": {
      "type": "integer",
      "description": "The time window in minutes to schedule the API discovery task.\nThis is used to discover APIs from the API Gateway and update the API list in the environment.\n",
      "default": 60
    },
    "vhosts": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/VHost"
      }
    },
    "endpointURIs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GatewayEnvironmentProtocolURI"
      }
    },
    "additionalProperties": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AdditionalProperty"
      }
    },
    "permissions": {
      "type": "object",
      "properties": {
        "permissionType": {
          "type": "string",
          "example": "ALLOW",
          "default": "PUBLIC",
          "enum": [
            "PUBLIC",
            "ALLOW",
            "DENY"
          ]
        },
        "roles": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "Internal/everyone"
          }
        }
      }
    },
    "status": {
      "type": "string",
      "readOnly": true,
      "description": "For platform gateway environments (gatewayType APIPlatform), connection status to the control plane (Active or Inactive).",
      "example": "Active",
      "default": "Active",
      "enum": [
        "Active",
        "Inactive"
      ]
    },
    "vhost": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "For platform gateway environments, the gateway URL (e.g. https://host:9443). Same as Platform Gateways API; only set when this environment represents a platform gateway.",
      "example": "https://mg.wso2.com"
    },
    "platformGatewayVersions": {
      "type": "array",
      "readOnly": true,
      "description": "API Platform Gateway versions from config. Set for deploy targets so UI can show version choices in the quick-start guide.",
      "items": {
        "type": "string",
        "example": "1.0.0"
      }
    }
  }
}