Delete Environment Variable

Overview

Deletes an environment variable specified by name. The variable is automatically undeployed from all environments.

Endpoint

DELETE /apiops/projects/{projectName}/environmentVariables/{name}/

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 (can be “admin” for admin project)
name string Yes Environment variable name

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": "Environment variable (name: API_BASE_URL) was not found!"
}

cURL Example

curl -X DELETE \
  "https://demo.apinizer.com/apiops/projects/MyProject/environmentVariables/API_BASE_URL/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings

  • Permanent Deletion:
    • Environment variable is permanently deleted
    • This action cannot be undone
  • Automatic Undeployment:
    • Variable is automatically undeployed from all environments
    • Undeployment results are returned in the response