Ana içeriğe atla

​
Endpoint

DELETE /apiops/projects/{projectName}/keys/{keyName}/

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer {token}Yes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
keyNamestringYesName of the key to delete

​
Query Parameters

ParameterTypeRequiredDescription
jwkDeleteActionstringNoAction to take on referenced JWKs: NULLIFY (clear references) or DELETE (delete JWKs completely). Defaults to NULLIFY if not provided.

​
Response

​
Success Response (200 OK)

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

​
cURL Example

​
Example 1: Delete Key (Default: Clear JWK References)

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

​
Example 2: Delete Key and Clear JWK References

curl -X DELETE \
  "https://demo.apinizer.com/apiops/projects/MyProject/keys/my-key/?jwkDeleteAction=NULLIFY" \
  -H "Authorization: Bearer YOUR_TOKEN"

curl -X DELETE \
  "https://demo.apinizer.com/apiops/projects/MyProject/keys/my-key/?jwkDeleteAction=DELETE" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Notes and Warnings

  • Permanent Deletion:
    • Key is permanently deleted
    • This action cannot be undone
  • Automatic Undeployment:
    • Key is automatically undeployed from all environments
    • Undeployment results are returned in the response
  • Referenced JWKs:
    • If jwkDeleteAction=NULLIFY or not provided (default), JWK references will be cleared
    • If jwkDeleteAction=DELETE, all JWKs created from this key will be permanently deleted
    • Default behavior (NULLIFY) preserves JWKs but removes their reference to the deleted key

​
Permissions

User must have SECRETS + MANAGE permission in the project. For undeployment operations (when undeploying keys from environments), user must also have SECRETS + DEPLOY_UNDEPLOY permission.