Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WSO2 Platform Gateways API

The Platform Gateways API from WSO2 — 3 operation(s) for platform gateways.

WSO2 Platform Gateways API is one of 90 APIs that WSO2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Platform Gateways. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version v4.

Requests are made against a single base URL, https://apis.wso2.com/api/am/admin/v4.

5 operations 3 paths 7 schemas 1 DELETE1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v4
Base URL
https://apis.wso2.com
Authentication
OAuth 2.0
Contact
License
Resource Areas
1

Authentication & Security 1

WSO2 Platform Gateways API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the password flow, exposing 41 scopes.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Platform Gateways 5
GET
/gateways
Get all platform gateways
getPlatformGateways → 200404
POST
/gateways
Register a platform gateway
createPlatformGateway body → 201400404409
POST
/gateways/{gatewayId}/regenerate-token
Regenerate registration token for a platform gateway
regeneratePlatformGatewayToken 1 param → 200400404
PUT
/gateways/{gatewayId}
Update a platform gateway
updatePlatformGateway 1 param body → 200400404
DELETE
/gateways/{gatewayId}
Delete a platform gateway
deletePlatformGateway 1 param → 200404409

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PlatformGatewayResponse (10 properties), CreatePlatformGatewayRequest (6 properties), UpdatePlatformGatewayRequest (6 properties), Error (5 properties). Each schema is shown below with its type and property counts.

PlatformGatewayResponse
object
Platform gateway response (without registration token). Used for list and get.
10 properties
ErrorListItem
object
2 properties 2 required
UpdatePlatformGatewayRequest
object
Request body for PUT /gateways/{gatewayId}. Per PUT semantics, send the full resource representation. Name and vhost are immutable (server validates they match…
6 properties 3 required
Error
object
5 properties 2 required
CreatePlatformGatewayRequest
object
Request body for creating a platform gateway (name, displayName, vhost as URL, optional properties). Same property name as platform API; type is URL.
6 properties 3 required
GatewayResponseWithToken
Platform gateway response including the one-time registration token (POST create or regenerate-token).
GatewayList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wso2-platform-gateways-api-openapi.yml Raw ↑

Other APIs WSO2 publishes across the network.

WSO2 Advanced Policy (Collection) API
WSO2 Advanced Policy (Individual) API
WSO2 AIServiceProvider API
WSO2 AIServiceProviders API
WSO2 Alert Subscriptions API
WSO2 Alerts API
WSO2 Api Artifact API
WSO2 API Categories API
WSO2 API Category (Collection) API
WSO2 API Category (Individual) API
WSO2 API Chat API
WSO2 API Documents API