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

Certificate renew

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

Function

The CertificateRenew task extends the validity period of the existing certificate. If the system successfully accepts the request, a new job is created which extends the rubtime. As a response, the ID of the created job is returned.

When using the DNS validation, the <dns> tag does not have to be sent. If the tag is missing, the record is created. Please be aware that there may be differences in the DNS attribute since the attribute value depends on a timestamp.

Description

Route: PUT /certificate/{id}/_renew
No body has to be sent.

{
}

{
   "stid": "20190627-app2-dev-23276",
   "status": {
      "code": "N400106",
      "text": "Certificate renew was started successfully.",
      "type": "NOTIFY"
   },
   "object": {
      "type": "Certificate",
      "value": "example.com"
   },
   "data": [
      {
         "id": 4297539521
      }
   ]
}

Task number: 400106
Uses Certificate object

<request>
    <auth>
        <user>USER</user>
        <password>PASSWORD</password>
        <context>CONTEXT</context>
    </auth>
    <task>
        <certificate>
            <id>100</id>
            <product>QUICKSSLPREMIUM</product>
            <lifetime>12</lifetime>
            <software>APACHE2</software>
            <csr><![CDATA[-----BEGIN CERTIFICATE REQUEST----- ... -----END CERTIFICATE REQUEST-----]]></csr>
            <name>example.com</name>
            <admin>
                <id>100</id>
            </admin>
            <technical>
                <id>100</id>
            </technical>
            <subject_alternative_name>
                <name>san1.example.com></name>
            </subject_alternative_name>
            <subject_alternative_name>
                <name>san1.example.com</name>
            </subject_alternative_name>
            <subject_alternative_name>
                <name>san1.example.com</name>
            </subject_alternative_name>
            <authentication>
                <method>DNS</method>
                <dns>stvrvkg19vib8j5o1p35is3forhbo7zp.example.com.    300    IN    CNAME    s20170131154625.example.com.</dns>
                <provisioning>1</provisioning>
            </authentication>
        </certificate>
        <ctid>request-100001</ctid>
        <code>400106</code>
    </task>
</request>

<response>
    <result>
        <data>
            <certificate_job>
                <job>
                    <id>4295014838</id>
                    <status>RUNNING</status>
                </job>
            </certificate_job>
        </data>
        <status>
            <code>N400106</code>
            <text>Certificate renew was started successfully.</text>
            <type>notify</type>
            <object>
                <type>certificate</type>
                <value>example.com</value>
            </object>
        </status>
    </result>
    <ctid>request-100001</ctid>
</response>