WSO2 · Schema

Gateway Response With Token

Platform gateway response including the one-time registration token (POST create or regenerate-token).

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST
View JSON Schema on GitHub

JSON Schema

admin-api-gateway-response-with-token-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/admin-api-gateway-response-with-token-schema.json",
  "title": "Gateway Response With Token",
  "description": "Platform gateway response including the one-time registration token (POST create or regenerate-token).",
  "allOf": [
    {
      "$ref": "#/components/schemas/PlatformGatewayResponse"
    },
    {
      "type": "object",
      "properties": {
        "registrationToken": {
          "type": "string",
          "description": "Registration token (returned only once on create or regenerate). Use as api-key when connecting\nthe gateway to the control plane WebSocket. Store e.g. as GATEWAY_REGISTRATION_TOKEN.\n"
        }
      }
    }
  ]
}