Ana içeriğe atla

​
Endpoint

DELETE /apiops/projects/{projectName}/apiProxies/{apiProxyName}/environments/{environmentName}/

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
apiProxyNamestringYesAPI Proxy name (must exist)
environmentNamestringYesEnvironment name (must exist)

​
Query Parameters

None

​
Request Body

This endpoint does not require a request body.

​
Response

​
Success Response (200 OK)

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Undeployment successful"
      }
    ]
  }
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
deploymentResultobjectUndeployment result
deploymentResult.successbooleanOverall undeployment success
deploymentResult.deploymentResultsarrayIndividual environment undeployment results
deploymentResult.deploymentResults[].environmentNamestringEnvironment name
deploymentResult.deploymentResults[].successbooleanUndeployment success for this environment
deploymentResult.deploymentResults[].messagestringUndeployment message

​
Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "ApiProxy with name (petstore-api) can not be deployed to Environment(production) because it is not exist!"
}

​
Common Causes

  • API Proxy name does not exist
  • Environment name does not exist
  • User does not have access to the environment
  • API proxy is not deployed to the environment
  • Undeployment failed (check deploymentResult for details)

​
Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

​
Error Response (404 Not Found)

{
  "error": "not_found",
  "error_description": "Project (MyProject) is not found or user does not have privilege to access it!"
}

​
cURL Example

curl -X DELETE \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/petstore-api/environments/production/" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Full JSON Body Example

This endpoint does not require a request body.

​
Notes and Warnings

  • API Proxy Must Exist: The API proxy must exist before undeployment
  • Environment Access: User must have access to the target environment

​
Permissions

User must have API_MANAGEMENT + DEPLOY_UNDEPLOY permission in the project.
  • Undeployment Status: Check the deploymentResult in the response to verify undeployment success
  • Deployment History: Undeployment history is automatically recorded
  • Redeploy Required Flag: After undeployment, the redeployRequired flag is set to false