Skip to content
Start here

Hostnames

Get the Hostname Status for Client Authentication
client.originTLSClientAuth.hostnames.get(stringhostname, HostnameGetParams { zone_id } params, RequestOptionsoptions?): AuthenticatedOriginPull { cert_id, cert_status, cert_updated_at, 11 more }
GET/zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}
Enable or Disable a Hostname for Client Authentication
client.originTLSClientAuth.hostnames.update(HostnameUpdateParams { zone_id, config } params, RequestOptionsoptions?): SinglePage<HostnameUpdateResponse { id, cert_id, certificate, 3 more } >
PUT/zones/{zone_id}/origin_tls_client_auth/hostnames
ModelsExpand Collapse
AuthenticatedOriginPull { cert_id, cert_status, cert_updated_at, 11 more }
cert_id?: string

Identifier.

maxLength32
cert_status?: "initializing" | "pending_deployment" | "pending_deletion" | 4 more

Status of the certificate or the association.

One of the following:
"initializing"
"pending_deployment"
"pending_deletion"
"active"
"deleted"
"deployment_timed_out"
"deletion_timed_out"
cert_updated_at?: string

The time when the certificate was updated.

formatdate-time
cert_uploaded_on?: string

The time when the certificate was uploaded.

formatdate-time
certificate?: string

The hostname certificate.

created_at?: string

The time when the certificate was created.

formatdate-time
enabled?: boolean | null

Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association.

expires_on?: string

The date when the certificate expires.

formatdate-time
hostname?: string

The hostname on the origin for which the client certificate uploaded will be used.

maxLength255
issuer?: string

The certificate authority that issued the certificate.

serial_number?: string

The serial number on the uploaded certificate.

signature?: string

The type of hash used for the certificate.

status?: "initializing" | "pending_deployment" | "pending_deletion" | 4 more

Status of the certificate or the association.

One of the following:
"initializing"
"pending_deployment"
"pending_deletion"
"active"
"deleted"
"deployment_timed_out"
"deletion_timed_out"
updated_at?: string

The time when the certificate was updated.

formatdate-time
HostnameUpdateResponse extends AuthenticatedOriginPull { cert_id, cert_status, cert_updated_at, 11 more } { id, cert_id, certificate, 3 more }
id?: string

Identifier.

maxLength32
cert_id?: string

Identifier.

maxLength32
certificate?: string

The hostname certificate.

enabled?: boolean | null

Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association.

hostname?: string

The hostname on the origin for which the client certificate uploaded will be used.

maxLength255
private_key?: string

The hostname certificate’s private key.