GET Certificates CSV

The GET /Certificates/CSV method is used to create content, in a CSV format, of certificates from Keyfactor Command that match the query criteria provided in the body. The content will display in the response body and can be copied from there for use in a file, as needed. This endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.

Tip:  The following permissions (see Security Overview) are required to use this feature:

Certificates: Global Read Users can query with and without collection ID.

Certificate Collection: Users without Global Read permissions MUST provide a collection ID for which they have Read permissions.1

Table 785: GET Certificates CSV Input Parameters

Name In Description
Sortname Query A string of the fieldname by which the results should be sorted.
SortOrder Query A Boolean to indicate the field sort direction [0=ascending, 1=descending] to apply to the SortName.
query Query A string query, to limit the requested set of certificates, in the form:
"CN –contains \"mycertificate.keyexample.com\""

See Certificate Search Page section of the Keyfactor Command Reference Guide for querying guidelines to build your body query.
CollectionId Query An integer of the certificate collectionClosed The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). ID (used to determine user access to the certificates).

Table 786: GET Certificates CSV Response Body

Description

A comma-separated sting of certificate data as per the criteria supplied. For example:

"Issued DN,Import Date,Effective Date,Expiration Date,Issued CN,Certificate Authority Name,Template Display Name,Principal,Requester,Key Type,Key Size,Certificate State,Thumbprint\r\n\"CN=Root CA,DC=keyexample,DC=com\",\"2022-11-17T19:52:00.8900000Z\",\"2020-04-14T23:39:28.0000000Z\",\"2035-04-14T23:49:28.0000000Z\",\"Root CA\",\"CN=Root CA,DC=keyexample,DC=com\",\"\",\"\",\"KEYEXAMPLE\\SQL241$\",\"RSA\",\"2048\",\"CertificateAuthority\",\"6DEA35B694F008B7DD69AE88B349B2FFD8AFF503\",\r\n\"CN=dc240.keyexample.com\",\"2022-11-17T19:52:01.2230000Z\",\"2020-04-15T03:58:35.0000000Z\",\"2021-04-15T03:58:35.0000000Z\",\"dc240.keyexample.com\",\"CN=Root CA,DC=keyexample,DC=com\",\"DomainController\",\"\",\"KEYEXAMPLE\\DC240$\",\"RSA\",\"2048\",\"Active\",\"2F2407C5329C646AC75834EAACE65DBF70F8FB1B\",\r\n\"CN=sql241.keyexample.com\",\"2022-11-17T19:52:01.2530000Z\",\"2020-04-15T14:50:52.0000000Z\",\"2022-04-15T14:50:52.0000000Z\",\"sql241.keyexample.com\",\"CN=Root CA,DC=keyexample,DC=com\",\"EnterpriseWebServer\",\"\",\"KEYEXAMPLE\\SQL241$\",\"RSA\",\"2048\",\"Active\",\"FEB56E1F076CFD2AEFE6969885F1CD59CBC839DB\",\r\n\"CN=red-apple.keyexample.com\",\"2022-11-17T19:52:01.3000000Z\",\"2020-04-15T16:57:06.0000000Z\",\"2020-05-27T16:57:06.0000000Z\",\"red-apple.keyexample.com\",\"CN=Root CA,DC=keyexample,DC=com\",\"EnterpriseWebServer-ShortLifetime\",\"\",\"KEYEXAMPLE\\sarahd\",\"RSA\",\"2048\",\"Active\",\"D60EC19B68589885DC8BD60BAD7EC7E81BAC256B\",\r\n\"CN=keyfactor243.keyexample.com\",\"2022-11-17T19:52:01.3330000Z\",\"2020-04-15T17:42:51.0000000Z\",\"2022-04-15T17:42:51.0000000Z\",\"keyfactor243.keyexample.com\",\"CN=Root CA,DC=keyexample,DC=com\",\"EnterpriseWebServer\",\"\",\"KEYEXAMPLE\\SRVR243$\",\"RSA\",\"2048\",\"Active\",\"BFA679661A7F40A507F9C518BE2A8CFF6D364AA0\",\r\n\"CN=walrus-apple.keyexample.com,L=Independence,ST=OH,C=US\",\"2022-11-17T19:52:01.3630000Z\",\"2020-09-14T22:07:52.0000000Z\",\"2020-10-26T22:07:52.0000000Z\",\"walrus-apple.keyexample.com\",\"CN=Root CA,DC=keyexample,DC=com\",\"EnterpriseWebServer-ShortLifetime\",\"\",\"BUFFY\\sarahd\",\"RSA\",\"2048\",\"Active\",\"D48DAE96497B4995D27B10EBC4EA571DAE80E6C8\",\r\n\"CN=walrus-apple.keyexample.com,L=Independence,ST=OH,C=US\",\"2022-11-17T19:52:01.3900000Z\",\"2020-09-14T22:23:51.0000000Z\",\"2020-10-26T22:23:51.0000000Z\",\"walrus-apple.keyexample.com\",\"CN=Root CA,DC=keyexample,DC=com\",\"EnterpriseWebServer-ShortLifetime\",\"\",\"BUFFY\\sarahd\",\"RSA\",\"2048\",\"Active\",\"D3E5CC1A4DBEFF0CE14F2ADAF9B811B9B9306A1C\",\r\n\"CN=appsrvr17.keyexample.com,OU=IT,O=Key Example\\, Inc,L=Independence,ST=OH,C=US\",\"2022-11-17T19:52:01.4430000Z\",\"2020-09-18T16:57:37.0000000Z\",\"2022-09-18T16:57:37.0000000Z\",\..."
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.