Date: Thu, 28 Mar 2024 16:45:59 +0100 (CET) Message-ID: <2078275389.3711.1711640759022@de.help.internetx.com> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_3710_774525692.1711640759018" ------=_Part_3710_774525692.1711640759018 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The API allows you to view and manage running and completed orders.
All important information for the use of the JSON and XML API you can fi= nd in the General API Basic= s and the XML API Basics<= /a> and JSON API Basics= . The specific SSL obje= cts are documented here, the SSL tasks here.
With a list inquire re= quest you can use the JSON and XML API to query all running and completed o= rders.
POST /job/_search=20 POST /job/history/_search { =09"view": { =09=09"limit": 10, "offset": 0 } }
{ "stid": "20180926-stid", "status": { "code": "S300115", "text": "Request data has been inquired successfully.", "type": "SUCCESS" }, "object": { "type": "ObjectJob", "summary": 1 }, "data": [ { "job": { "created": "2019-10-23T16:12:33.000+0200", "updated": "2019-10-23T17:26:01.000+0200", "owner": { "context": 9, "user": "user" }, "updater": { "context": 9, "user": "user" }, "status": "DEFFERED", "subStatus": "WF_EMAIL_AUTH", "execution": "2019-10-23T17:25:58.000+0200", "subType": "RAPID_SSL", "action": "create", "id": 12345 }, "object": { "type": "Certificate", "value": "domain.de" } } ] }
<task> =09<code>400115</code><!-- History 400135-->=20 =09<view> =09=09<limit>10</limit> =09=09<offset>0</offset> =09</view> </task>
<response> =09<result> =09=09<data> =09=09=09<summary>1</summary> =09=09=09<certificate_job> =09=09=09=09<job> =09=09=09=09=09<id>12345</id> =09=09=09=09=09<owner> =09=09=09=09=09=09<user>user</user> =09=09=09=09=09=09<context>9</context> =09=09=09=09=09</owner> =09=09=09=09=09<updater> =09=09=09=09=09=09<user>user</user> =09=09=09=09=09=09<context>9</context> =09=09=09=09=09</updater> =09=09=09=09=09<object>domain.de</object> =09=09=09=09=09<status>DEFFERED</status> =09=09=09=09=09<sub_status>WF_EMAIL_AUTH</sub_status> =09=09=09=09=09<created>2019-10-23 16:12:33</created> =09=09=09=09=09<updated>2019-10-23 17:26:01</updated> =09=09=09=09=09<type>ssl</type> =09=09=09=09=09<sub_type>RAPID_SSL</sub_type> =09=09=09=09=09<action>create</action> =09=09=09=09=09<execution>2019-10-23 17:25:58</execution> =09=09=09=09</job> =09=09=09</certificate_job> =09=09</data> =09=09<status> =09=09=09<code>S400115</code> =09=09=09<text>Certificate orders were inquired successfully.</tex= t> =09=09=09<type>success</type> =09=09</status> =09</result> =09<stid>20200228-stid</stid> </response>
The API offers the possibility to display details for a running or compl= eted order. This includes, for example:
GET /job/{id} GET /job/history/{id
{ "stid": "20200228-stid", "status": { "code": "S300114", "text": "The workflow order was inquired succesfully.", "type": "SUCCESS" }, "object": { "type": "ObjectJob", "value": "12345" }, "data": [ { "job": { "created": "2019-10-23T16:12:33.000+0200", "updated": "2019-10-23T17:26:01.000+0200", "owner": { "context": 9, "user": "user" }, "updater": { "context": 9, "user": "user" }, "status": "DEFFERED", "subStatus": "WF_EMAIL_AUTH", "execution": "2019-10-23T17:25:58.000+0200", "subType": "RAPID_SSL", "action": "create", "id": 12345 }, "object": { "type": "Certificate", "value": "domain.de", "data": { "created": "2019-10-23T00:00:00.000+0200", "partnerOrderId": "IX-CC-12345", "orderId": "9202720", "adminContact": { "fname": "Jon", "lname": "Doe", "phone": "+49-0-0", "fax": "+49-0-0", "email": "jon.doe@domain.de", "title": "Herr", "organization": "Muster GmbH", "address": [ "Musterstrasse 6" ], "pcode": "12345", "city": "Musterstadt", "country": "DE", "state": "Bayern", "id": 1 }, "technicalContact": { "fname": "Jon", "lname": "Doe", "phone": "+49-0-0", "fax": "+49-0-0", "email": "jon.doe@domain.de", "title": "Herr", "organization": "Muster GmbH", "address": [ "Musterstrasse 6" ], "pcode": "12345", "city": "Musterstadt", "country": "DE", "state": "Bayern", "id": 1 }, "name": "domain.de", "lifetime": { "unit": "MONTH", "period": 12 }, "software": "APACHE2", "csr": "-----BEGIN CERTIFICATE REQUEST-----\n ... \n-----END CERT= IFICATE REQUEST-----", "product": "RAPID_SSL", "signatureHashAlgorithm": "SHA2_FULL_CHAIN", "expire": "2020-10-23T00:00:00.000+0200", "certificationAuthority": [], "authentication": { "method": "EMAIL", "approverEmails": [ "admin@domain.de" ] }, "certificateTransparencyPrivacy": "PUBLIC" } } } ] }
<request> =09<auth> =09=09<user>USER</user> =09=09<context>CONTEXT</context> =09=09<password>PASSWORD</password> =09</auth> =09<task> =09=09<code>400114</code><!-- History 400134--> =09=09<certificate_job> =09=09=09<job> =09=09=09=09<id>12345</id> =09=09=09</job> =09=09</certificate_job> =09</task> </request>
<response> =09<result> =09=09<data> =09=09=09<certificate_job> =09=09=09=09<certificate> =09=09=09=09=09<partner_order_id>IX-CC-12345</partner_order_id> =09=09=09=09=09<order_id>9202720</order_id> =09=09=09=09=09<admin> =09=09=09=09=09=09<first>Jon</first> =09=09=09=09=09=09<last>Doe</last> =09=09=09=09=09=09<phone>+49-0-0</phone> =09=09=09=09=09=09<fax>+49-0-0</fax> =09=09=09=09=09=09<email>jon.doe@domain.de</email> =09=09=09=09=09=09<title>Herr</title> =09=09=09=09=09=09<organization>Muster GmbH</organization> =09=09=09=09=09=09<address>Musterstrasse 6</address> =09=09=09=09=09=09<postal_code>12345</postal_code> =09=09=09=09=09=09<city>Musterstadt</city> =09=09=09=09=09=09<country>DE</country> =09=09=09=09=09=09<state>Bayern</state> =09=09=09=09=09=09<id>1</id> =09=09=09=09=09</admin> =09=09=09=09=09<technical> =09=09=09=09=09=09<first>Jon</first> =09=09=09=09=09=09<last>Doe</last> =09=09=09=09=09=09<phone>+49-0-0</phone> =09=09=09=09=09=09<fax>+49-0-0</fax> =09=09=09=09=09=09<email>jon.doe@domain.de</email> =09=09=09=09=09=09<title>Herr</title> =09=09=09=09=09=09<organization>Muster GmbH</organization> =09=09=09=09=09=09<address>Musterstrasse 6</address> =09=09=09=09=09=09<postal_code>12345</postal_code> =09=09=09=09=09=09<city>Musterstadt</city> =09=09=09=09=09=09<country>DE</country> =09=09=09=09=09=09<state>Bayern</state> =09=09=09=09=09=09<id>1</id> =09=09=09=09=09</technical> =09=09=09=09=09<name>domain.de</name> =09=09=09=09=09<approver_email>admin@domain.de</approver_email> =09=09=09=09=09<lifetime>12</lifetime> =09=09=09=09=09<software>APACHE2</software> =09=09=09=09=09<csr><![CDATA[-----BEGIN CERTIFICATE REQUEST----- .= .. -----END CERTIFICATE REQUEST-----]]></csr> =09=09=09=09=09<product>RAPID_SSL</product> =09=09=09=09=09<sha>SHA2_FULL_CHAIN</sha> =09=09=09=09=09<expire>2020-10-23 00:00:00</expire> =09=09=09=09=09<extension/> =09=09=09=09=09<authentication> =09=09=09=09=09=09<method>EMAIL</method> =09=09=09=09=09=09<approver_email>admin@domain.de</approver_email&= gt; =09=09=09=09=09</authentication> =09=09=09=09=09<certificate_transparency_privacy>PUBLIC</certifica= te_transparency_privacy> =09=09=09=09=09<created>2019-10-23 00:00:00</created> =09=09=09=09</certificate> =09=09=09=09<job> =09=09=09=09=09<id>12345</id> =09=09=09=09=09<owner> =09=09=09=09=09=09<user>user</user> =09=09=09=09=09=09<context>9</context> =09=09=09=09=09</owner> =09=09=09=09=09<updater> =09=09=09=09=09=09<user>user</user> =09=09=09=09=09=09<context4>9</context> =09=09=09=09=09</updater> =09=09=09=09=09<object>domain.de</object> =09=09=09=09=09<status>DEFFERED</status> =09=09=09=09=09<sub_status>WF_EMAIL_AUTH</sub_status> =09=09=09=09=09<created>2019-10-23 16:12:33</created> =09=09=09=09=09<updated>2019-10-23 17:26:01</updated> =09=09=09=09=09<type>ssl</type> =09=09=09=09=09<sub_type>RAPID_SSL</sub_type> =09=09=09=09=09<action>create</action> =09=09=09=09=09<execution>2019-10-23 17:25:58</execution> =09=09=09=09</job> =09=09=09</certificate_job> =09=09</data> =09=09<status> =09=09=09<code>S400114</code> =09=09=09<text>Certificate order was inquired successfully.</text&= gt; =09=09=09<type>success</type> =09=09=09<object> =09=09=09=09<type>certificate_job</type> =09=09=09=09<value>4297755796</value> =09=09=09</object> =09=09</status> =09</result> =09<stid>20200228-stid</stid> </response>
Running jobs can be terminated via the API as long as they have not yet = reached the status SUCCESS or FAILED. Note that the termination of a runnin= g request does not take effect until it has been terminated at the CA. Befo= re this, the status CANCELED is displayed for the request.
PUT /job/{id}/_cancel
{ "stid": "20200228-stid", "status": { "code": "S300121", "text": "The workflow request was canceled successfully.", "type": "SUCCESS" }, "object": { "type": "ObjectJob", "value": "12345" } }
<request> =09<auth> =09=09<user>USER</user> =09=09<context>CONTEXT</context> =09=09<password>PASSWORD</password> =09</auth> =09<task> =09=09<code>400113</code> =09=09<certificate_job> =09=09=09<job> =09=09=09=09<id>12345</id> =09=09=09</job> =09=09</certificate_job> =09</task> </request>
<response> =09<result> =09=09<data/> =09=09<status> =09=09=09<code>S400113</code> =09=09=09<text>The request was canceled successfully.</text> =09=09=09<type>success</type> =09=09=09<object> =09=09=09=09<type>certificate_job</type> =09=09=09=09<value>4297782230</value> =09=09=09</object> =09=09</status> =09</result> =09<stid>20200228-stid</stid> </response>
The validation email can be resent using the route POST /job/{id= }/_resendApproverEmail or the XML task code 400118.
POST /job/{id}/_resendApproverEmail
{ "stid": "20200228-stid", "status": { "code": "S400118", "text": "The order for resending was successfully submitted to the CA."= , "type": "SUCCESS" }, "object": { "type": "Certificate_job", "value": "12345" } }
<request> =09<auth> =09=09<user>USER</user> =09=09<context>CONTEXT</context> =09=09<password>PASSWORD</password> =09</auth> =09<task> =09=09<code>400118</code> =09=09<certificate_job> =09=09=09<job> =09=09=09=09<id>12345</id> =09=09=09</job> =09=09</certificate_job> =09</task> </request>
<response> =09<result> =09=09<data/> =09=09<status> =09=09=09<code>S400118</code> =09=09=09<text>The order for resending was successfully submitted to = the CA.</text> =09=09=09<type>success</type> =09=09=09<object> =09=09=09=09<type>certificate_job</type> =09=09=09=09<value>12345</value> =09=09=09</object> =09=09</status> =09</result> =09<stid>20200228-stid</stid> </response>