Skip to main content
POST
/
api
/
v1
/
projects
/
{projectId}
/
certificates
/
search
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/projects/{projectId}/certificates/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "friendlyName": "<string>",
  "commonName": "<string>",
  "offset": 0,
  "limit": 25,
  "forPkiSync": false,
  "search": "<string>",
  "status": "<string>",
  "profileIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "fromDate": "2023-11-07T05:31:56Z",
  "toDate": "2023-11-07T05:31:56Z",
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "certificates": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "serialNumber": "<string>",
      "friendlyName": "<string>",
      "commonName": "<string>",
      "notBefore": "2023-11-07T05:31:56Z",
      "notAfter": "2023-11-07T05:31:56Z",
      "projectId": "<string>",
      "hasPrivateKey": true,
      "caId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revokedAt": "2023-11-07T05:31:56Z",
      "revocationReason": 123,
      "altNames": "<string>",
      "caCertId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "certificateTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "keyUsages": [
        "<string>"
      ],
      "extendedKeyUsages": [
        "<string>"
      ],
      "pkiSubscriberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "renewBeforeDays": 123,
      "renewedFromCertificateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "renewedByCertificateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "renewalError": "<string>",
      "keyAlgorithm": "<string>",
      "signatureAlgorithm": "<string>",
      "subjectOrganization": "<string>",
      "subjectOrganizationalUnit": "<string>",
      "subjectCountry": "<string>",
      "subjectState": "<string>",
      "subjectLocality": "<string>",
      "fingerprintSha256": "<string>",
      "fingerprintSha1": "<string>",
      "isCA": true,
      "pathLength": 123,
      "source": "<string>",
      "discoveryMetadata": null
    }
  ],
  "totalCount": 123
}

Path Parameters

projectId
string
required

Body

application/json
friendlyName
string

The friendly name of the certificate to filter by.

commonName
string

The common name of the certificate to filter by.

offset
number
default:0

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

Required range: x >= 0
limit
number
default:25

The number of certificates to return.

Required range: 1 <= x <= 100
forPkiSync
boolean
default:false

Retrieve only certificates available for PKI sync.

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

status
string

Filter by certificate status.

profileIds
string<uuid>[]

Filter by certificate profile IDs.

fromDate
string<date-time>

Filter certificates created from this date.

toDate
string<date-time>

Filter certificates created until this date.

metadata
object[]

Filter by metadata key-value pairs. Each entry should have a key (required) and optionally a value to match against.

Response

Default Response

certificates
object[]
required
totalCount
number
required