Endpoints
- List API Proxies - Get all API proxies for a project
- Get API Proxy - Get API proxy details
- Create API Proxy from URL - Create API proxy from OpenAPI/Swagger/WSDL URL
- Create API Proxy from File - Create API proxy from uploaded file
- Update API Proxy - Update API proxy
- Delete API Proxy - Delete API proxy
Import Export
- Import API Proxy - Import an API proxy
- Import API Proxy and Override - Import API proxy with override options
- Export API Proxy - Export an API proxy
Deployment
- Deploy API Proxy - Deploy API proxy to environments
- Undeploy API Proxy - Undeploy API proxy from environments
Endpoints Management
- List Endpoints - List all endpoints
- Get Endpoint - Get endpoint details
- Create Endpoint - Create new endpoint
- Update Endpoint - Update endpoint
- Delete Endpoint - Delete endpoint
- Update Endpoint Status - Enable/disable endpoint
- Update Endpoint WSA - Update SOAP WSA settings
- Update Endpoint Cache - Update endpoint cache settings
Settings
- CORS Settings - Configure CORS
- Cache Settings - Configure caching
- Routing Addresses - Configure routing addresses
- Routing Status - Configure routing status
- Connection Settings - Configure connection settings
- Circuit Breaker Settings - Configure circuit breaker
- mTLS Settings - Configure mTLS
- NTLM Settings - Configure NTLM
- Proxy Server Settings - Configure proxy server
- Traffic Log Settings - Configure traffic logging
- JSON Error Template - Configure JSON error template
- XML Error Template - Configure XML error template
- Forwarded IP Header - Configure forwarded IP header
- Hide API Definition - Hide API definition file
- Client Route - Configure client route metadata
- API Keys - Configure API keys
- Metadata - Update metadata (name, description, category, sharing)
Authentication
All endpoints require authentication using a Personal API Access Token.Permissions
GET Operations (List/Get API Proxy)
- User must have
API_MANAGEMENT+VIEWpermission in the project - If the asset category does not exist, user must have at least one permission in the project
POST/PUT/DELETE Operations (Create/Update/Delete API Proxy)
- User must have
API_MANAGEMENT+MANAGEpermission in the project - For deployment operations, user must also have
API_MANAGEMENT+DEPLOY_UNDEPLOYpermission
Permission Requirements
| Operation | Required Permission |
|---|---|
| List/Get API Proxy | API_MANAGEMENT + VIEW (or any permission if category doesn’t exist) |
| Create/Update/Delete API Proxy | API_MANAGEMENT + MANAGE |
| Deploy/Undeploy API Proxy | API_MANAGEMENT + DEPLOY_UNDEPLOY |
| Export/Import API Proxy | API_MANAGEMENT + EXPORT_IMPORT (or project admin) |
Related Documentation
- Authentication Guide - How to obtain and use API tokens
- Error Handling - Error response formats
- Policies API - Policy management
- Connections API - Connection management