Undeploy API Proxy Group

Endpoint

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

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

Query Parameters

None.

Request Body

Optional JSON body. When omitted, defaults are applied.

Field	Type	Required	Description
description	string	No	Description/notes for the undeploy history record. Defaults to "Undeployed by APIOPS Api" if not provided.
persistent	boolean	No	If true, this undeploy history record will not be auto-deleted when the retention limit is reached. Defaults to false.

Example

{
  "description": "Rollback undeploy",
  "persistent": true
}

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "deploymentResult": {
    "success": true,
    "responseTime": 120,
    "detailList": [
      {
        "envName": "production",
        "podName": "worker-abc123",
        "podIp": "10.0.0.1",
        "success": true,
        "responseTime": 120
      }
    ]
  }
}

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": "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"

With Description and Persistent Flag

curl -X DELETE \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxyGroups/PaymentAPIGroup/environments/production/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description": "Rollback undeploy", "persistent": true}'

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

• User must have API_MANAGEMENT + MANAGE and API_MANAGEMENT + DEPLOY_UNDEPLOY permissions in the project

Related Documentation

• Deploy API Proxy Group - Deploy group to environment
• List Environments - List environments for group