API Proxy Groups API
Endpoints
CRUD Operations
- List API Proxy Groups - Get all API Proxy Groups for a project
- Create API Proxy Group - Create a new API Proxy Group
- Update API Proxy Group - Update an existing API Proxy Group
- Delete API Proxy Group - Delete an API Proxy Group
API Proxy Management
- Add API Proxy to Group - Add an API Proxy to a group
- Remove API Proxy from Group - Remove an API Proxy from a group
Deployment
- List Environments - Get all environments of an API Proxy Group
- Deploy API Proxy Group - Deploy an API Proxy Group to an environment
- Undeploy API Proxy Group - Undeploy an API Proxy Group from an environment
Authentication
All endpoints require authentication using a Personal API Access Token.
Permissions
GET Operations (List API Proxy Groups, List Environments)
- 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 Group, Add/Remove API Proxies)
- 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 API Proxy Groups, List Environments | API_MANAGEMENT + VIEW (or any permission if category doesn't exist) |
| Create/Update/Delete API Proxy Group | API_MANAGEMENT + MANAGE |
| Add/Remove API Proxy to/from Group | API_MANAGEMENT + MANAGE |
| Deploy/Undeploy API Proxy Group | API_MANAGEMENT + DEPLOY_UNDEPLOY |
Related Documentation
- Authentication Guide - How to obtain and use API tokens
- Error Handling - Error response formats
- API Proxies API - API Proxy management