Remove API Proxy from Group

Overview

Removes an API Proxy from an API Proxy Group. The API Proxy is no longer a member of the group but remains in the project.

Endpoint

DELETE /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 remove

Request Body

None.

Response

Success Response (200 OK)

{
  "success": true
}

Notes

  • If API Proxy is not a member of the group, operation still succeeds
  • API Proxy is removed from the group if it is 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 DELETE \
  "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 not a member, operation still succeeds
    • No error is thrown if API Proxy is not in the group
  • API Proxy Not Deleted:
    • API Proxy itself is not deleted
    • Only the group association is removed
  • Permissions:
    • Requires ROLE_MANAGE_PROXIES permission
    • Requires ROLE_MANAGE_PROXY_GROUPS permission
    • User must have access to the project