- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- SSL tasks
Certificate list
Function
The CertificateList task allows you to display the information contained in one or more certificates.
You can find more information about list queries here.
Description
Route: POST /certificate/_search
Query parameters
The data of the following keywords can be queried with the query parameter ?keys[]=:
- admin
- authentication
- comment
- created
- domain
- expire
- id
- name
- orderId
- product
- technical
- type
- updated
{
"view": {
"limit": 3,
"offset": 0,
"from": "2018-01-01T12:00:00.0000000Z",
"to": "2019-06-25T09:00:00.0000000Z"
}
}{
"stid": "20190627-app2-dev-22705",
"status": {
"code": "S400105",
"text": "Certificates were inquired successfully.",
"type": "SUCCESS"
},
"object": {
"type": "Certificate",
"summary": 21618
},
"data": [
{
"created": "2018-02-19T11:04:02.000+0100",
"updated": "2019-02-18T13:13:52.000+0100",
"owner": {
"context": 9,
"user": "exampleuser"
},
"id": 2159,
"orderId": "PC20180219009874",
"adminContact": {
"id": 100
},
"name": "joe@example.com",
"product": "GLOBALSIGN_PERSONALSIGN_1",
"expire": "2019-02-19T11:04:02.000+0100",
"domain": "example.com"
},
{
"created": "2018-02-20T00:00:00.000+0100",
"updated": "2018-06-11T09:52:01.000+0200",
"owner": {
"context": 9,
"user": "exampleuser"
},
"id": 2175,
"orderId": "2575868",
"adminContact": {
"id": 100
},
"technicalContact": {
"id": 100
},
"name": "example2.de",
"product": "SSL123",
"expire": "2018-02-27T12:00:00.000+0100",
"authentication": {
"method": "EMAIL"
},
"domain": "example2.de"
},
{
"created": "2018-02-21T00:00:00.000+0100",
"updated": "2018-02-27T13:04:33.000+0100",
"owner": {
"context": 9,
"user": "exampleuser"
},
"id": 2182,
"orderId": "2576486",
"adminContact": {
"id": 100
},
"technicalContact": {
"id": 100
},
"name": "example-domain.de",
"product": "QUICKSSLPREMIUM",
"expire": "2018-02-28T12:00:00.000+0100",
"authentication": {
"method": "EMAIL"
},
"domain": "example-domain.de"
}
]
}
Task number: 400105
Uses Certificate object
Uses Certificate object
The following keywords will return additional information when using the list inquire:
- authentication.method
- authentication.scope
- certificate_transparency_privacy
- context
- created
- expire
- extension
- id
- multiyear
- name
- order_id
- owner.context
- owner.user
- owner
- payable
- product
- software
- technical.id
- updated
<request>
<auth>
<user>USER</user>
<password>PASSWORD</password>
<context>CONTEXT</context>
</auth>
<task>
<code>400105</code>
<view>
<limit>10</limit>
<offset>0</offset>
</view>
<where>
<key>name</key>
<operator>eq</operator>
<value>domain.com</value>
</where>
</task>
</request><response>
<result>
<data>
<summary>2</summary>
<certificate>
<id>100</id>
<order_id>123456789</order_id>
<admin>
<id>14</id>
</admin>
<technical>
<id>14</id>
</technical>
<name>example.com</name>
<product>SECURESITEEV</product>
<expire>2018-01-02 23:59:59</expire>
<created>2017-01-02 09:00:00</created>
<updated>2018-01-02 09:00:01</updated>
<owner>
<user>customer</user>
<context>CONTEXT</context>
</owner>
</certificate>
<certificate>
<id>100</id>
<order_id>987654321</order_id>
<admin>
<id>14</id>
</admin>
<technical>
<id>14</id>
</technical>
<name>example.com</name>
<product>SECURESITEEV</product>
<expire>2019-01-02 23:59:59</expire>
<created>2017-01-02 09:00:00</created>
<updated>2018-01-02 09:00:01</updated>
<owner>
<user>customer</user>
<context>CONTEXT</context>
</owner>
</certificate>
</data>
<status>
<code>S400105</code>
<text>Certificates were inquired successfully.</text>
<type>success</type>
</status>
</result>
</response>