CHchecklyhq
Client certificates

Creates a new client certificate.

Changed on

Creates a new client certificate. Be sure to extract the certificate and private key from your PEM files so the string retains any line break, i.e. "\n" characters.

post/v1/client-certificates

Request

Headers

x-checkly-accountstring

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

Request body

hoststring required

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

pathstring nullable

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.

certstring 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...

castring nullable

An optional CA certificate in PEM format as a string.

keystring

The private key in PEM format as a string.

passphrasestring nullable

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

Example request

{
  "host": "www.acme.com",
  "path": "/partner/api"
}

Response

Created

hoststring required

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

certstring 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...

castring nullable

An optional CA certificate in PEM format as a string.

idstring required
pathstring nullable

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.

created_atstring date-time

Example response

{
  "host": "www.acme.com",
  "path": "/partner/api"
}

Changes