API Reference

Origin TLS Client Auth

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Hostnames

Get the Hostname Status for Client Authentication

client.OriginTLSClientAuth.Hostnames.Get(ctx, hostname, query) (*AuthenticatedOriginPull, error)

GET/zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}

Enable or Disable a Hostname for Client Authentication

client.OriginTLSClientAuth.Hostnames.Update(ctx, params) (*SinglePage[HostnameUpdateResponse], error)

PUT/zones/{zone_id}/origin_tls_client_auth/hostnames

ModelsExpand Collapse

type AuthenticatedOriginPull struct{…}

CERTID stringoptional

Identifier.

maxLength32

CERTStatus AuthenticatedOriginPullCERTStatusoptional

Status of the certificate or the association.

One of the following:

const AuthenticatedOriginPullCERTStatusInitializing AuthenticatedOriginPullCERTStatus = "initializing"

const AuthenticatedOriginPullCERTStatusPendingDeployment AuthenticatedOriginPullCERTStatus = "pending_deployment"

const AuthenticatedOriginPullCERTStatusPendingDeletion AuthenticatedOriginPullCERTStatus = "pending_deletion"

const AuthenticatedOriginPullCERTStatusActive AuthenticatedOriginPullCERTStatus = "active"

const AuthenticatedOriginPullCERTStatusDeleted AuthenticatedOriginPullCERTStatus = "deleted"

const AuthenticatedOriginPullCERTStatusDeploymentTimedOut AuthenticatedOriginPullCERTStatus = "deployment_timed_out"

const AuthenticatedOriginPullCERTStatusDeletionTimedOut AuthenticatedOriginPullCERTStatus = "deletion_timed_out"

CERTUpdatedAt Timeoptional

The time when the certificate was updated.

formatdate-time

CERTUploadedOn Timeoptional

The time when the certificate was uploaded.

formatdate-time

Certificate stringoptional

The hostname certificate.

CreatedAt Timeoptional

The time when the certificate was created.

formatdate-time

Enabled booloptional

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

ExpiresOn Timeoptional

The date when the certificate expires.

formatdate-time

Hostname stringoptional

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

maxLength255

Issuer stringoptional

The certificate authority that issued the certificate.

SerialNumber stringoptional

The serial number on the uploaded certificate.

Signature stringoptional

The type of hash used for the certificate.

Status AuthenticatedOriginPullStatusoptional

Status of the certificate or the association.

One of the following:

const AuthenticatedOriginPullStatusInitializing AuthenticatedOriginPullStatus = "initializing"

const AuthenticatedOriginPullStatusPendingDeployment AuthenticatedOriginPullStatus = "pending_deployment"

const AuthenticatedOriginPullStatusPendingDeletion AuthenticatedOriginPullStatus = "pending_deletion"

const AuthenticatedOriginPullStatusActive AuthenticatedOriginPullStatus = "active"

const AuthenticatedOriginPullStatusDeleted AuthenticatedOriginPullStatus = "deleted"

const AuthenticatedOriginPullStatusDeploymentTimedOut AuthenticatedOriginPullStatus = "deployment_timed_out"

const AuthenticatedOriginPullStatusDeletionTimedOut AuthenticatedOriginPullStatus = "deletion_timed_out"

UpdatedAt Timeoptional

The time when the certificate was updated.

formatdate-time