Undeploy API Proxy Group

Overview

Undeploys an API Proxy Group from a specific environment. All API Proxies in the group are undeployed together.

Endpoint

DELETE /apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/environments/{environmentName}/

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
environmentName string Yes Environment name to undeploy from

Request Body

None.

Response

Success Response (200 OK)

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "message": "Undeployment completed successfully",
    "environmentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Undeployed successfully"
      }
    ]
  }
}

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": "Environment (production) 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/environments/production/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings

  • Group Undeployment:
    • All API Proxies in the group are undeployed together
    • Group-level settings are also removed
  • Environment Must Exist:
    • Environment must exist and be accessible
  • Permissions:
    • Requires ROLE_MANAGE_PROXY_GROUPS permission
    • Requires ROLE_DEPLOY_UNDEPLOY_PROXIES permission
    • User must have access to the project and environment