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

Certificate create

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

Function

The CertificateCreate task initiates the order of a certificate. If the request is successfully accepted by the system, a new job is created which initiates the order of the certificate. As an answer, 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: POST /certificate

{
   "adminContact": {
      "id": 100
   },
   "technicalContact": {
      "id": 100
   },
   "name": "example.de",
   "lifetime": {
      "unit": "MONTH",
      "period": 12
   },
   "software": "APACHESSL",
   "csr": "-----BEGIN CERTIFICATE REQUEST-----MIICujCCAaICAQAwdTELMAkGA1UEBhMCREUxDzANBgNVBAgMBmJhdmFyaTETMBEGA1UEBwwKcmVnZW5zYnVyZzERMA8GA1UECgwIc3VwZXJkZXYxFDASBgNVBAsMC2RldmVsb3BtZW50MRcwFQYDVQQDDA5qdW5rZHJhZ29ucy5kZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMSMhi30bENDqWeXp7SfHhi2epocJeuI6bBeqGYyQCM5yuoUyAC6wuQ5xudC+hJ6dnDp8p8l8ObkcLrU8/vZJCVmfHxkQpOy6oIsz8uvNA7VcLqOQfxINxe0lqAD0SAWYUaB2W+4CVqyFxaKIn/1c2Isg+8d8Y/3l/t0lI0CF7Y4Q/EmIh1Rl2cr1ONQd4P+3mx2V0ExYN69zPRIsEHt1bV9Mo3l7QpMybHKANMK4BHVL+F5oL8vyGElLCScm3ryrl4W+C0N5V1SSGLNTfNiDxkPx9dwCc5iBy/X8FfhZ7z3+JdjluWo513wvdwZH+jbWhvQ7wsmnV0lGQoe4jHwF+UCAwEAAaAAMA0GCSqGSIb3DQEBCwUAA4IBAQCzQXKkBJWdaGtHLdI9/pqJ/zVCISGsH8lXo8tMBUyZk9cCYdH0hvsVduqNJRpBzNi07ivK/T3+Ru3SUYl0DKlsfHm5IEjf2lYJgJORXS5SRMkr7sYfYSAeGsoUIXc1GC4hBnSFmKN6NoLLbHaAItNDo9AWKVr/1ZqPy9v5vaJpTSzYidrTcZth4lF+i4QqcchorIPq4hSMKWkhZs5tzd/+hAR0XV2hcH1RGcuHTWOJmAvk0Nw2eVxUgNJSmiU0OneyRO4qQoWC/1khDFI0/xt0apn0OeYpcu8rA3aXsHCbcCqpjLUSBZ45szn60KL5sW9/S4y2oUjUbUQb3NW4TFgw-----END CERTIFICATE REQUEST-----",
   "product": "QUICKSSLPREMIUM",
   "authentication": {
      "method": "EMAIL",
      "approverEmails": [
         "admin@example.de",
         "administrator@example.de",
         "hostmaster@example.de",
         "webmaster@example.de",
         "postmaster@example.de"
      ]
   }
}

{
   "stid": "20190702-app3-dev-10171",
   "status": {
      "code": "N400101",
      "text": "Certificate order was started successfully.",
      "type": "NOTIFY"
   },
   "object": {
      "type": "Certificate",
      "value": "example.de"
   },
   "data": [
      {
         "id": 4297543967
      }
   ]
}

Task number: 400101
Uses Certificate object

<request>
    <auth>
        <user>USER</user>
        <password>PASSWORD</password>
        <context>CONTEXT</context>
    </auth>
  <task>
    <certificate>
      <product>QUICKSSLPREMIUM</product>
      <lifetime>12</lifetime>
      <software>APACHE2</software>
      <sha>SHA2_FULL_CHAIN</sha>
      <certificate_transparency_privacy>PUBLIC</certificate_transparency_privacy>
      <csr><![CDATA[-----BEGIN CERTIFICATE REQUEST----- ... -----END CERTIFICATE REQUEST-----]]></csr>
      <name>domain.com</name>
      <subject_alternative_name>
        <name>san1.domain.com</name>
      </subject_alternative_name>
      <subject_alternative_name>
        <name>san2.domain.com</name>
      </subject_alternative_name>
      <subject_alternative_name>
        <name>san3.domain.com</name>
      </subject_alternative_name>
      <admin>
        <id>100</id>
      </admin>
      <technical>
        <id>100</id>
      </technical>
      <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>400101</code>
  </task>
</request>

<response>
  <result>
    <data>
      <certificate_job>
        <job>
          <id>4295014837</id>
          <status>RUNNING</status>
        </job>
      </certificate_job>
    </data>
    <status>
      <code>N400101</code>
      <text>Certificate order was started successfully.</text>
      <type>notify</type>
      <object>
        <type>certificate</type>
        <value>domain.com</value>
      </object>
    </status>
  </result>
  <ctid>request-100001</ctid>
</response>