TLS certificates
v1.6.2
Cancel or revoke TLS certificate order
Cancel a not-yet-issued order before issuance, or revoke the complete issued order within the first 7 days after ordering. A full revocation invalidates all certificate versions on that order and prevents further reissue.
POST
/tls/certificate/{certificate_id}/order-cancel
TLSCertificatesByID
Authentication
Parameters
Name
Type
Format
Required
Description
certificate_id
string
-
Required
Public TLS certificate ID
Request body
Optional order cancellation payload
tlsCertificateOrderCancelRequesttlsCertificateOrderCancelRequest
{
"comment": "example",
"revocation_reason": "unspecified"
}Fields
Name
Type
Format
Required
Description
comment
string
-
Optional
Optional provider comment for the full order cancellation request. If the request resolves to a pending-order cancellation, regfish sends a default provider note when this field is omitted.
revocation_reason
string
-
Optional
Revocation reason.
Request example
POST
curl --request POST \
--url 'https://api.regfish.com/tls/certificate/7K9QW3M2ZT8HJ/order-cancel' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'content-type: application/json' \
--data '{
"comment": "example",
"revocation_reason": "unspecified"
}'Responses
200
TLS certificate order cancellation accepted
Response example 200
{
"success": true,
"code": 0,
"response": {
"id": "7K9QW3M2ZT8HJ",
"status": "pending",
"common_name": "example",
"product": "example",
"provider": "digicert",
"dns_names": [
"example"
],
"action_required": false,
"pending_reason": "validation_pending",
"pending_message": "The TLS certificate order is waiting for domain validation.",
"completion_url": "",
"organization_id": null,
"certificate_pem_available": false
}
}400
Invalid request or revocation reason
Response example 400
{
"success": false,
"message": "Invalid request or revocation reason",
"error": "Invalid request or revocation reason"
}401
Unauthorized
Response example 401
{
"success": false,
"message": "Unauthorized",
"error": "Unauthorized"
}404
TLS certificate not found
Response example 404
{
"success": false,
"message": "TLS certificate not found",
"error": "TLS certificate not found"
}409
The TLS certificate order cannot be cancelled or revoked in its current state
Response example 409
{
"success": false,
"message": "The TLS certificate order cannot be cancelled or revoked in its current state",
"error": "The TLS certificate order cannot be cancelled or revoked in its current state"
}500
Unexpected error
Response example 500
{
"success": false,
"message": "Unexpected error",
"error": "Unexpected error"
}502
Upstream TLS provider error
Response example 502
{
"success": false,
"message": "Upstream TLS provider error",
"error": "Upstream TLS provider error"
}Community
Become part of the community
The regfish DNS API is a great solution for developers who want to automate domains and DNS zones. Become part of the community and benefit from DNS automation. The DNS API is available free of charge to every regfish customer.