Cancel or revoke TLS certificate order

POST

/tls/certificate/{certificate_id}/order-cancel

TLSCertificatesByID

Authentifizierung

x-api-keyapplication/json

SchnellstartAuthentifizierung Regfish ConsoleAPI-Key im Regfish-Interface anlegen und testen

Parameter

Name

Typ

Format

Pflicht

Description

certificate_id

path

string

—

Pflicht

Public TLS certificate ID

Request Body

application/jsonOptional

Optional order cancellation payload

tlsCertificateOrderCancelRequest

{
  "comment": "example",
  "revocation_reason": "unspecified"
}

Felder

Name

Typ

Format

Pflicht

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

unspecified, keyCompromise, affiliationChanged, superseded, cessationOfOperation

string

—

Optional

Revocation reason.

Request-Beispiel

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

application/jsontlsCertificateResponse

Response-Beispiel 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

application/jsonError

Response-Beispiel 400

{
  "success": false,
  "message": "Invalid request or revocation reason",
  "error": "Invalid request or revocation reason"
}

401

Unauthorized

application/jsonError

Response-Beispiel 401

{
  "success": false,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

404

TLS certificate not found

application/jsonError

Response-Beispiel 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

application/jsonError

Response-Beispiel 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

application/jsonError

Response-Beispiel 500

{
  "success": false,
  "message": "Unexpected error",
  "error": "Unexpected error"
}

502

Upstream TLS provider error

application/jsonError

Response-Beispiel 502

{
  "success": false,
  "message": "Upstream TLS provider error",
  "error": "Upstream TLS provider error"
}

Verwandte Modelle

baseResult

Error

fqdn

Fully Qualified Domain Name (FQDN, ending with a period).

tlsCertificateDcvMethod

tlsCertificateId

Public TLS certificate ID

tlsCertificateOrderCancelRequest

tlsCertificateOrderCancellationMode

tlsCertificateOrganization

tlsCertificateProvider

tlsCertificateReissueResponse

tlsCertificateReissueStatus

tlsCertificateResponse

tlsCertificateRevocationReason

Revocation reason.

tlsCertificateRevocationScope

tlsCertificateStatus

tlsOrganizationId

Public TLS organization ID

tlsOrganizationStatus

tlsValidation

tlsValidationDnsRecord

Authentifizierung

Parameter

Request Body

Felder

Request-Beispiel

Responses

Werde ein Teil der Community