Skip to main content
POST
Creates a new client certificate.

Authorizations

Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

x-checkly-account
string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Body

application/json
host
string
required

The host domain for the certificate without https://. You can use wildcards to match domains, e.g. "*.acme.com"

Example:

"www.acme.com"

cert
string
required

The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this "-----BEGIN CERTIFICATE-----\nMIIEnTCCAoWgAwIBAgIJAL+WugL...

path
string | null

Optional URL path prefix that limits the certificate to requests under that path. Matching is on whole path segments: "/partner" applies to "/partner" and "/partner/orders" but not to "/partnership". API checks and Multistep checks match on path; gRPC, SSL (automatic mode) and TCP monitors only use certificates without a path. Omit it or send null to apply the certificate to every path on the host.

Example:

"/partner/api"

ca
string | null

An optional CA certificate in PEM format as a string.

key
string

The private key in PEM format as a string.

passphrase
string | null

An optional passphrase for the private key. Your passphrase is stored encrypted at rest.

Response

Created

host
string
required

The host domain for the certificate without https://. You can use wildcards to match domains, e.g. "*.acme.com"

Example:

"www.acme.com"

cert
string
required

The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this "-----BEGIN CERTIFICATE-----\nMIIEnTCCAoWgAwIBAgIJAL+WugL...

id
string
required
ca
string | null

An optional CA certificate in PEM format as a string.

path
string | null

Optional URL path prefix that limits the certificate to requests under that path. Matching is on whole path segments: "/partner" applies to "/partner" and "/partner/orders" but not to "/partnership". API checks and Multistep checks match on path; gRPC, SSL (automatic mode) and TCP monitors only use certificates without a path. Omit it or send null to apply the certificate to every path on the host.

Example:

"/partner/api"

created_at
string<date-time>