Sign in
PKI Certificates

Search and filter certificates within a project.

post/api/v1/projects/{projectId}/certificates/search

Path parameters

projectIdstring required

Request body

friendlyNamestring

The friendly name of the certificate to filter by.

commonNamestring

The common name of the certificate to filter by.

offsetnumber

The offset to start from. If you enter 10, it will start from the 10th certificate.

limitnumber

The number of certificates to return.

forPkiSyncboolean

Retrieve only certificates available for PKI sync.

searchstring

Search by SAN, CN, certificate ID, or serial number.

statusstring

Comma-separated list of certificate statuses to filter by. Supported values are active, renewed, expired and revoked. A certificate superseded by a renewal matches renewed rather than active until it expires or is revoked.

profileIdsstring[]

Filter by certificate profile IDs.

fromDatestring date-time

Filter certificates created from this date.

toDatestring date-time

Filter certificates created until this date.

extendedKeyUsagestring

Filter by extended key usage. Only certificates containing this EKU will be returned (e.g. 'codeSigning', 'serverAuth').

signatureAlgorithmstring

Filter by signature algorithm (e.g. 'RSA-SHA256', 'ECDSA-SHA256').

keySizesnumber[]

Filter by key sizes in bits (e.g. [2048, 4096]).

caIdsstring[]

Filter by certificate authority IDs.

enrollmentTypesstring[]

Filter by enrollment types (e.g. 'api', 'est', 'acme', 'scep').

notAfterFromstring date-time

Filter certificates expiring on or after this date.

notAfterTostring date-time

Filter certificates expiring on or before this date.

notBeforeFromstring date-time

Filter certificates issued on or after this date.

notBeforeTostring date-time

Filter certificates issued on or before this date.

applicationIdstring uuid

Filter to certificates issued through a specific Application.

applicationIdsstring[]

Filter to certificates issued through any of the supplied Applications.

sortBy'notAfter' | 'notBefore' | 'createdAt' | 'commonName' | 'keyAlgorithm' | 'status'

Column to sort by (e.g. 'notAfter', 'notBefore', 'commonName').

sortOrder'asc' | 'desc'

Sort direction: 'asc' or 'desc'.

Response

Default Response

totalCountnumber required

Changes

Changed in 1 of the 20 revisions of this API.1

  • 5dbb77aad0f51See the full diff
    • ○

      added the optional property certificates/items/subjectDomainComponents to the response with the 200 status

      response-optional-property-added