Add API Proxy to Group

Endpoint

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

Authentication

Requires a Personal API Access Token.

Header

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)

{
  "status": "SUCCESS"
}

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)

{
  "status": "FAILURE",
  "resultMessage": "API Proxy Group (PaymentAPIGroup) is not found or user does not have privilege to access it!"
}

or

{
  "status": "FAILURE",
  "resultMessage": "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

• User must have API_MANAGEMENT + MANAGE permission in the project

Related Documentation

• Remove API Proxy from Group - Remove an API Proxy from group
• List API Proxy Groups - List all API Proxy Groups