WSO2 · Schema
Update Platform Gateway Request
Request body for PUT /gateways/{gatewayId}. Per PUT semantics, send the full resource representation. Name and vhost are immutable (server validates they match the existing gateway).
API ManagementGatewaysOpen-SourceAPI LifecycleGraphQLSOAPREST
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Gateway identifier (immutable; must match existing). Required for PUT full representation. |
| vhost | string | Gateway URL (immutable; must match existing). Same name as platform API; type is URL. Example https://mg.wso2.com |
| displayName | string | Human-readable gateway name |
| description | string | Optional description |
| properties | object | Custom key-value properties for the gateway |
| permissions | object | Gateway visibility permissions (on-prem extension) |
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-update-platform-gateway-request-schema.json",
"title": "Update Platform Gateway Request",
"description": "Request body for PUT /gateways/{gatewayId}. Per PUT semantics, send the full resource\nrepresentation. Name and vhost are immutable (server validates they match the existing gateway).\n",
"required": [
"name",
"displayName",
"vhost"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z0-9-]+$",
"minLength": 3,
"maxLength": 64,
"description": "Gateway identifier (immutable; must match existing). Required for PUT full representation."
},
"vhost": {
"type": "string",
"format": "uri",
"description": "Gateway URL (immutable; must match existing). Same name as platform API; type is URL. Example https://mg.wso2.com",
"example": "https://mg.wso2.com"
},
"displayName": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "Human-readable gateway name",
"example": "Production Gateway 01"
},
"description": {
"type": "string",
"maxLength": 1023,
"description": "Optional description"
},
"properties": {
"type": "object",
"additionalProperties": true,
"description": "Custom key-value properties for the gateway",
"example": {
"region": "us-west",
"tier": "premium"
}
},
"permissions": {
"type": "object",
"description": "Gateway visibility permissions (on-prem extension)",
"properties": {
"permissionType": {
"type": "string",
"enum": [
"PUBLIC",
"ALLOW",
"DENY"
],
"default": "PUBLIC"
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of roles for ALLOW/DENY permission types"
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/admin-api-update-platform-gateway-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.