WSO2 · JSON Structure

Publisher Api Environment Structure

Environment schema from WSO2 API Manager

Type: object Properties: 13 Required: 5

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Environment is a JSON Structure definition published by WSO2, describing 13 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name displayName type gatewayType mode serverUrl provider showInApiConsole vhosts endpointURIs additionalProperties permissions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/publisher-api-environment-structure.json",
  "name": "Environment",
  "description": "Environment schema from WSO2 API Manager",
  "required": [
    "id",
    "name",
    "serverUrl",
    "showInApiConsole",
    "type"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "example": "default"
    },
    "displayName": {
      "type": "string",
      "example": "Default"
    },
    "type": {
      "type": "string",
      "default": "hybrid",
      "example": "hybrid"
    },
    "gatewayType": {
      "type": "string",
      "example": "Regular",
      "default": "Regular"
    },
    "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"
    },
    "serverUrl": {
      "type": "string",
      "example": "https://localhost:9443/services/"
    },
    "provider": {
      "type": "string",
      "example": "wso2"
    },
    "showInApiConsole": {
      "type": "boolean",
      "example": true
    },
    "vhosts": {
      "type": "array",
      "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"
          }
        }
      }
    }
  }
}