Create Client Certificate

POST /zones/{zone_id}/client_certificates

Copy endpoint

https://api.cloudflare.com/client/v4

Create a new API Shield mTLS Client Certificate

Parameters

path Path Parameters

Name	Type
`zone_id` required	type TlsCertificatesAndHostnamesIdentifier = string

Request Body

application/json required

{ csr:

TlsCertificatesAndHostnamesSchemasCsr

The Certificate Signing Request (CSR). Must be newline-encoded.

type TlsCertificatesAndHostnamesSchemasCsr = string

;validity_days:

TlsCertificatesAndHostnamesSchemasValidityDays

The number of days the Client Certificate will be valid after the issued_on date

type TlsCertificatesAndHostnamesSchemasValidityDays = number

; }

Responses

200 application/json

Create Client Certificate Response

type TlsCertificatesAndHostnamesClientCertificateResponseSingle = type TlsCertificatesAndHostnamesApiResponseSingle = interface TlsCertificatesAndHostnamesApiResponseCommon {
errors:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
success: true;
} & {} & { result?:

TlsCertificatesAndHostnamesClientCertificate

interface TlsCertificatesAndHostnamesClientCertificate {
certificate?: TlsCertificatesAndHostnamesClientCertificatesComponentsSchemasCertificate;
certificate_authority?: TlsCertificatesAndHostnamesClientCertificatesComponentsSchemasCertificateAuthority;
common_name?: TlsCertificatesAndHostnamesCommonName;
country?: TlsCertificatesAndHostnamesCountry;
csr?: TlsCertificatesAndHostnamesSchemasCsr;
expires_on?: TlsCertificatesAndHostnamesExpiredOn;
fingerprint_sha256?: TlsCertificatesAndHostnamesFingerprintSha256;
id?: TlsCertificatesAndHostnamesIdentifier;
issued_on?: TlsCertificatesAndHostnamesIssuedOn;
location?: TlsCertificatesAndHostnamesLocation;
organization?: TlsCertificatesAndHostnamesOrganization;
organizational_unit?: TlsCertificatesAndHostnamesOrganizationalUnit;
serial_number?: TlsCertificatesAndHostnamesComponentsSchemasSerialNumber;
signature?: TlsCertificatesAndHostnamesComponentsSchemasSignature;
ski?: TlsCertificatesAndHostnamesSki;
state?: TlsCertificatesAndHostnamesState;
status?: TlsCertificatesAndHostnamesClientCertificatesComponentsSchemasStatus;
validity_days?: TlsCertificatesAndHostnamesSchemasValidityDays;
}

; }

Client Errors

4XX application/json

Create Client Certificate Response Failure

type TlsCertificatesAndHostnamesClientCertificateResponseSingle = type TlsCertificatesAndHostnamesApiResponseSingle = interface TlsCertificatesAndHostnamesApiResponseCommon {
errors:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
success: true;
} & {} & { result?:

TlsCertificatesAndHostnamesClientCertificate

; } & interface TlsCertificatesAndHostnamesApiResponseCommonFailure {
errors:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
result: null;
success: false;
}