Ana içeriğe atla

Endpoint

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

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
environmentNamestringYesEnvironment 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

  • User must have API_MANAGEMENT + DEPLOY_UNDEPLOY permission in the project