Cancel or revoke TLS certificate order
POST /tls/certificate/{certificate_id}/order-cancelOperation ID: CancelIssuedCertificateOrder
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.
Path parameters
Section titled “Path parameters”| Name | Type | Required | Description |
|---|---|---|---|
certificate_id |
tlsCertificateId | yes | — |
Request body
Section titled “Request body”tlsCertificateOrderCancelRequest
| Field | Type | Required | Description |
|---|---|---|---|
comment |
string |
no | 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 |
tlsCertificateRevocationReason |
no | Optional revocation reason. Defaults to unspecified. |
Responses
Section titled “Responses”| Status | Type | Description |
|---|---|---|
200 |
tlsCertificateResponse |
TLS certificate order cancellation accepted |
400 |
Error |
Invalid request or revocation reason |
401 |
Error |
Unauthorized |
404 |
Error |
TLS certificate not found |
409 |
Error |
The TLS certificate order cannot be cancelled or revoked in its current state |
500 |
Error |
Unexpected error |
502 |
Error |
Upstream TLS provider error |
Response body
Section titled “Response body”| Field | Type | Required | Description |
|---|---|---|---|
success |
boolean |
yes | Success indicator |
code |
integer |
no | Response/Error Code |
response |
tlsCertificateResponse | no | — |
Example
Section titled “Example”curl -X POST "https://api.regfish.com/tls/certificate/<certificate_id>/order-cancel" \ -H "x-api-key: $REGFISH_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "comment": "string", "revocation_reason": "unspecified" }'Build a request
Section titled “Build a request”Fill in values — the call below updates as you type. Nothing is sent: the API does not currently allow browser requests from this domain (CORS). The API key is not stored.