Skip to content

Get CA certificates

Request

Retrieve the CA certificates stored on the system as a paginated JSON report. Requires a token with administrator privileges.

Filtering parameters are modeled as query parameters (the documentation lists them as "in the request body", but for HTTP GET they are typically passed as query parameters).

Security
AuthToken
Query
pageinteger, >= 1

Page number (pagination)

where_subjectstring

Filter by any string in the certificate Subject

where_issuerstring

Filter by any string in the certificate Issuer

where_cert_idstring

Filter by any string in the Certificate ID

where_serial_numberstring

Filter by any string in the Certificate SerialNumber

where_not_beforestring

Minimum validity date (ISO 8601)

Example:where_not_before=2013-06-05T17:35:47.000Z
where_not_afterstring

Maximum validity date (ISO 8601)

Example:where_not_after=2043-06-05T17:35:47.000Z
where_tagsstring

Filter by tags associated with the certificate

curl -i -X GET \
  'https://example.com/api/admin/certificates/?page=1&where_subject=string&where_issuer=string&where_cert_id=string&where_serial_number=string&where_not_before=2013-06-05T17%3A35%3A47.000Z&where_not_after=2043-06-05T17%3A35%3A47.000Z&where_tags=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Paginated list of CA certificates

Bodyapplication/json
paginationobject
metaobject
dataArray of objects(CaCertificateItem)
<property name>anyadditional property
Response
{ "pagination": { "count": 0, "next": "string", "page": 0, "pages": 0, "previus": "string" }, "meta": { "status": "200 OK" }, "data": [ { … } ] }