WSO2 · Schema

Platform Gateway Response

Platform gateway response (without registration token). Used for list and get.

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name	Type	Description
id	string	Gateway UUID
name	string
displayName	string
description	string
properties	object	Custom key-value properties
vhost	string	Gateway URL (e.g. https://host or https://host:9443). Same name as platform API; type is URL.
isActive	boolean	Indicates if the gateway is currently connected to the control plane via WebSocket
permissions	object	Gateway visibility permissions configuration
createdAt	string
updatedAt	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/admin-api-platform-gateway-response-schema.json",
  "title": "Platform Gateway Response",
  "description": "Platform gateway response (without registration token). Used for list and get.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "Gateway UUID"
    },
    "name": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "properties": {
      "type": "object",
      "additionalProperties": true,
      "description": "Custom key-value properties"
    },
    "vhost": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "Gateway URL (e.g. https://host or https://host:9443). Same name as platform API; type is URL."
    },
    "isActive": {
      "type": "boolean",
      "readOnly": true,
      "description": "Indicates if the gateway is currently connected to the control plane via WebSocket"
    },
    "permissions": {
      "type": "object",
      "description": "Gateway visibility permissions configuration",
      "properties": {
        "permissionType": {
          "type": "string",
          "enum": [
            "PUBLIC",
            "ALLOW",
            "DENY"
          ],
          "default": "PUBLIC",
          "description": "Permission type for gateway visibility:\n- PUBLIC: Gateway is visible to all users\n- ALLOW: Gateway is visible only to specified roles\n- DENY: Gateway is hidden from specified roles\n"
        },
        "roles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of roles for ALLOW/DENY permission types"
        }
      }
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  }
}