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

Certificate delete

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

Function

The CertificateDelete task allows you to initiate the deletion process for a certificate. If the request is successfully accepted by the system, a new job is created which initiates the deletion of the certificate. As an answer, the ID of the created job is returned.

In contrast to the CertificateRevoke task, CertificateDelete completely deletes the certificate and does not just delete specific serial numbers.

Description

Route: DELETE /certificate/{id}
There is no need to send a body.

{
}

{
   "stid": "20190628-app3-dev-11494",
   "status": {
      "code": "N400103",
      "text": "Certificate cancelation could be started successfully.",
      "type": "NOTIFY"
   },
   "object": {
      "type": "Certificate",
      "value": "example.com"
   },
   "data": [
      {
         "id": 4297540441
      }
   ]
}

Task number: 400103
Uses Certificate object

<request>
    <auth>
        <user>USER</user>
        <password>PASSWORD</password>
        <context>CONTEXT</context>
    </auth>
    <task>
        <code>400103</code>
        <certificate>
            <id>100</id>
        </certificate>
    </task>
</request>

<response>
    <result>
        <data>
            <certificate_job>
                <job>
                    <id>8927477</id>
                    <status>RUNNING</status>
                </job>
            </certificate_job>
        </data>
        <status>
            <code>N400103</code>
            <text>Certificate cancelation could be started successfully.</text>
            <type>notify</type>
            <object>
                <type>certificate</type>
                <value>example.com</value>
            </object>
        </status>
    </result>
</response>