Platform API v0.9.0¶
This document specifies a RESTful API for WSO2 API Platform - Platform API.
Authentication¶
Most API endpoints require a Bearer JWT token in the Authorization header. Tokens are
validated against a configured Identity Provider (IDP) using JWKS-based signature
verification.
Required claim: organization — UUID of the caller's organization. All operations are
automatically scoped to this organization.
Supported signing algorithms: RS256, RS384, RS512 (RSA) and ES256, ES384, ES512 (ECDSA). Works with any standards-compliant IDP (Keycloak, Azure AD, Okta, Auth0, WSO2 IS, etc.).
Scope-Based Access Control¶
Authorization is enforced via OAuth2 scopes carried in the JWT. Both read (GET) and write
operations require specific scopes declared in the security field of each operation.
Base URLs: * https://localhost:9243/api/v0.9 * https://api.platform.com/api/v0.9
License: Apache 2.0
Table of Contents¶
Authentication¶
- Overview
- Authentication Modes
- Required Claims
- Authorization
- Error Responses
- Troubleshooting
- Scope Reference
Projects¶
- Create a new project
- Get all projects for current user's organization
- Get project by ID
- Update project
- Delete project
Applications¶
- Create a new application
- Get applications for current user's organization
- Get application by handle
- Update application
- Delete application
- List application API key mappings
- Add application API key mappings
- Remove application API key mapping
- List application associations
- Add application associations
- Remove application association
- List application API key mappings for an association
Gateways¶
- Register a new gateway
- List all gateways
- Get gateway by ID
- Update gateway
- Delete gateway
- Get gateway policy manifest
Gateway Tokens¶
Gateway Policies¶
- Get synced custom policies for the current organization
- Sync a custom policy from the gateway manifest
- Get a specific custom policy version
- Delete a specific custom policy version
LLM Providers¶
- Create a new LLM provider
- List all LLM providers
- Get LLM provider by identifier
- Update an existing LLM provider
- Delete an LLM provider
- List LLM proxies by provider
- Create a new API key for an LLM provider
- List API keys for an LLM provider
- Delete an API key for an LLM provider
LLM Proxies¶
- Create a new LLM proxy
- List all LLM proxies
- Get LLM proxy by unique identifier
- Update an existing LLM proxy
- Delete an LLM proxy
- Create a new API key for an LLM proxy
- List API keys for an LLM proxy
- Delete an API key for an LLM proxy
LLM Provider Templates¶
- Create a new LLM provider template family
- List templates, list a family's versions, or get a single version
- Create a new version by copying an existing one
- Get LLM provider template by id
- Update an existing LLM provider template
- Enable or disable a template version
- Delete a template version
LLM Provider Deployments¶
- Create and deploy a new LLM provider deployment
- Get deployments for an LLM provider
- Get LLM provider deployment by ID
- Delete LLM provider deployment
- Undeploy LLM provider deployment from gateway
- Restore a previous LLM provider deployment
LLM Proxy Deployments¶
- Create and deploy a new LLM proxy deployment
- Get deployments for an LLM proxy
- Get LLM proxy deployment by ID
- Delete LLM proxy deployment
- Undeploy LLM proxy deployment from gateway
- Restore a previous LLM proxy deployment
API Keys¶
MCP Proxies¶
- Create a new MCP proxy
- List all MCP proxies
- Get MCP proxy by unique identifier
- Update an existing MCP proxy
- Delete an MCP proxy
- Fetch server info from MCP proxy backend services
MCP Proxy Deployments¶
- Create and deploy a new deployment for MCP proxy
- Get deployments for an MCP proxy
- Get deployment by ID
- Delete deployment
- Undeploy deployment from gateway
- Restore a previous deployment