Skip to content
regfish Docs

Cancel TLS certificate order

POST /tls/certificate/{certificate_id}/cancel

Operation ID: CancelCertificate

Cancel a pending TLS certificate order. Use /tls/certificate/{certificate_id}/order-cancel when an already issued order should be revoked in full.

Path parameters

Section titled “Path parameters”
Name Type Required Description
certificate_id tlsCertificateId yes —

Request body

Section titled “Request body”

tlsCertificateCancelRequest

Field Type Required Description
note string no Optional provider note stored with the cancellation request. If omitted, regfish sends a default note because the CA requires one for pending-order cancellations.

Responses

Section titled “Responses”
Status Type Description
200 tlsCertificateResponse TLS certificate cancellation accepted
400 Error Invalid request
401 Error Unauthorized
404 Error TLS certificate not found
409 Error Only pending TLS certificate orders can be cancelled
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”
Terminal-Fenster
curl -X POST "https://api.regfish.com/tls/certificate/<certificate_id>/cancel" \
  -H "x-api-key: $REGFISH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "string"
  }'

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.