Home
/
API reference
/
API documentation (JSON/XML)
/
Tasks
/
SSL tasks

Certificate revoke

API reference (XML/JSON) · Updated 2023-09-18

Function

This CertificateRevoke task allows you to revoke an existing certificate with a specific serial number. This is useful when a reissue was initiated and you intend to declare the old serial numbers as invalid. In this case initiate a revoke for the domain and the old serial number.

Description

Route:POST /certificate/{id}/_revoke

POST /certificate/{100}/_revoke

{
   "stid": "20190702-app2-dev-27188",
   "status": {
      "code": "S4001031",
      "text": "The certificate was revoked successfully.",
      "type": "SUCCESS"
   },
   "object": {
      "type": "Certificate",
      "value": "junkdragons.de"
   }
}

Task number: 4001031
Uses Certificate object

request>
    <auth>
        <user>USER</user>
        <password>PASSWORD</password>
        <context>CONTEXT</context>
    </auth>
    <task>
        <certificate>
            <id>100</id>
            <serial_number>7B54CF2C2E672E1E87D72D6C0A80F4B0</serial_number>
        </certificate>
        <code>4001031</code>
    </task>
</request>

<response>
    <result>
        <data />
        <status>
            <code>S4001031</code>
            <text>The certificate was revoked successfully.</text>
            <type>success</type>
            <object>
                <type>certificate</type>
                <value>domain.com</value>
            </object>
        </status>
    </result>
</response>