TLS certificates
v1.6.2
Cancel TLS certificate order
Cancel a pending TLS certificate order. Use
/tls/certificate/{certificate_id}/order-cancel when an already issued order should be revoked in full.POST
/tls/certificate/{certificate_id}/cancel
TLSCertificatesByID
Authentication
Parameters
Name
Type
Format
Required
Description
certificate_id
string
-
Required
Public TLS certificate ID
Request body
Optional cancellation note
tlsCertificateCancelRequesttlsCertificateCancelRequest
{
"note": "example"
}Fields
Name
Type
Format
Required
Description
note
string
-
Optional
Optional provider note stored with the cancellation request. If omitted, regfish sends a default note because the CA requires one for pending-order cancellations.
Request example
POST
curl --request POST \
--url 'https://api.regfish.com/tls/certificate/7K9QW3M2ZT8HJ/cancel' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'content-type: application/json' \
--data '{
"note": "example"
}'Responses
200
TLS certificate 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
Response example 400
{
"success": false,
"message": "Invalid request",
"error": "Invalid request"
}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
Only pending TLS certificate orders can be cancelled
Response example 409
{
"success": false,
"message": "Only pending TLS certificate orders can be cancelled",
"error": "Only pending TLS certificate orders can be cancelled"
}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.