API Proxy Groups API

Overview

The API Proxy Groups API provides endpoints for managing API Proxy Groups in Apinizer. API Proxy Groups allow you to group multiple API Proxies together and manage them as a single unit, including shared client routes, CORS settings, cache settings, and deployment.

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

• ROLE_MANAGE_PROXY_GROUPS - Required for all API Proxy Group operations
• ROLE_MANAGE_PROXIES - Required for adding/removing API Proxies
• ROLE_DEPLOY_UNDEPLOY_PROXIES - Required for deployment operations

Related Documentation

• Authentication Guide - How to obtain and use API tokens
• Error Handling - Error response formats
• API Proxies API - API Proxy management