Ana içeriğe geç

Delete Certificate

Endpoint​

DELETE /apiops/projects/{projectName}/certificates/{certificateName}/

Authentication​

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request​

Headers​

HeaderValueRequired
AuthorizationBearer {token}Yes

Path Parameters​

ParameterTypeRequiredDescription
projectNamestringYesProject name
certificateNamestringYesCertificate name

Query Parameters​

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

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)​

{
"status": "FAILURE",
"resultMessage": "Certificate (name: my-certificate) is not found!"
}

cURL Example​

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

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

Example 2: Delete Certificate and Clear JWK References​

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

Permissions​

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

Notes and Warnings​

  • Permanent Deletion:

    • Certificate is permanently deleted
    • This action cannot be undone
  • Automatic Undeployment:

    • Certificate 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 certificate will be permanently deleted
    • Default behavior (NULLIFY) preserves JWKs but removes their reference to the deleted certificate