List Certificates.

Return list of certificates. If you send the mode query parameter with the value detailed the certificates returned will have more information (Will contains all certs basic details). To retrieve a list with complete certificate details use this endpoint. If the mode query parameter is omitted or is empty this endpoint will only return the certificates IDs. The list of certificates returned is paginated.

GET /api/certs

Try it

List Certificates.

cURL

curl --request GET \
  --url https://{tenant}/api/certs \
  --header 'Authorization: Bearer <token>'

200

{
  "cert_basics": [
    {
      "dns_names": [
        "<string>"
      ],
      "has_private": true,
      "id": "<string>",
      "is_ca": true,
      "issuer_cn": "<string>",
      "not_after": "2023-11-07T05:31:56Z",
      "not_before": "2023-11-07T05:31:56Z",
      "subject_cn": "<string>"
    }
  ],
  "pages": 123
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Query Parameters

p · integer

Use p query parameter to say which page you want returned. Send number less than 0 to return all items.

mode · enum<string>

Set to detailed to get certificates that are more with more details (Will contains certs basic details). To retrieve a list of certificates with all the certificate details use this endpoint.

Available options: detailed

filter · enum<string> · default: omit

Defines the filtering strategy applied to certificate keys. This query param works only in combination with detailed mode (mode=detailed). omit – Includes all certificates; this is the default behavior. with_pk – Returns only certificates that are associated with a private key. without_pk – Returns only certificates that do not include a private key.

Available options: omit, with_pk, without_pk

Response

200

application/json

OK

Option 1

Option 2

cert_basics · object[] | null

Show child attributes

cert_basics. dns_names · string[] | null

cert_basics. has_private · boolean

cert_basics. id · string

cert_basics. is_ca · boolean

cert_basics. issuer_cn · string

cert_basics. not_after · string<date-time>

cert_basics. not_before · string<date-time>

cert_basics. subject_cn · string

pages · integer