Ana içeriğe atla

Endpoint

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

Authentication

Requires a Personal API Access Token.
Authorization: Bearer YOUR_TOKEN

Request

Headers

HeaderValueRequired
AuthorizationBearer Yes

Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
apiProxyGroupNamestringYesAPI Proxy Group name
apiProxyNamestringYesAPI 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

  • User must have API_MANAGEMENT + MANAGE permission in the project