Add API Proxy to Group

Overview

Adds an API Proxy to an API Proxy Group. The API Proxy becomes a member of the group and can be managed together with other members.

Endpoint

POST /apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/apiProxies/{apiProxyName}/

Authentication

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header Value Required
Authorization Bearer {token} Yes

Path Parameters

Parameter Type Required Description
projectName string Yes Project name
apiProxyGroupName string Yes API Proxy Group name
apiProxyName string Yes API Proxy name to add

Request Body

None.

Response

Success Response (200 OK)

{
  "success": true
}

Notes

  • If API Proxy is already a member of the group, the operation succeeds without error
  • API Proxy is added to the group if not already a member

Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "API Proxy Group (PaymentAPIGroup) is not found or user does not have privilege to access it!"
}

or

{
  "error": "bad_request",
  "error_description": "ApiProxy (MyAPI) is not found or user does not have privilege to access it!"
}

cURL Example

curl -X POST \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxyGroups/PaymentAPIGroup/apiProxies/PaymentAPI/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings

  • Idempotent Operation:
    • If API Proxy is already a member, operation succeeds
    • No error is thrown for duplicate additions
  • Group Must Exist:
    • API Proxy Group must exist
  • API Proxy Must Exist:
    • API Proxy must exist in the project
  • Permissions:
    • Requires ROLE_MANAGE_PROXIES permission
    • Requires ROLE_MANAGE_PROXY_GROUPS permission
    • User must have access to the project