origin_tls_client_auth

package
v6.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 10, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type AuthenticatedOriginPull

type AuthenticatedOriginPull struct {
	// Identifier.
	CERTID string `json:"cert_id"`
	// Status of the certificate or the association.
	CERTStatus AuthenticatedOriginPullCERTStatus `json:"cert_status"`
	// The time when the certificate was updated.
	CERTUpdatedAt time.Time `json:"cert_updated_at" format:"date-time"`
	// The time when the certificate was uploaded.
	CERTUploadedOn time.Time `json:"cert_uploaded_on" format:"date-time"`
	// The hostname certificate.
	Certificate string `json:"certificate"`
	// The time when the certificate was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Indicates whether hostname-level authenticated origin pulls is enabled. A null
	// value voids the association.
	Enabled bool `json:"enabled,nullable"`
	// The date when the certificate expires.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// The hostname on the origin for which the client certificate uploaded will be
	// used.
	Hostname string `json:"hostname"`
	// The certificate authority that issued the certificate.
	Issuer string `json:"issuer"`
	// The serial number on the uploaded certificate.
	SerialNumber string `json:"serial_number"`
	// The type of hash used for the certificate.
	Signature string `json:"signature"`
	// Status of the certificate or the association.
	Status AuthenticatedOriginPullStatus `json:"status"`
	// The time when the certificate was updated.
	UpdatedAt time.Time                   `json:"updated_at" format:"date-time"`
	JSON      authenticatedOriginPullJSON `json:"-"`
}

func (*AuthenticatedOriginPull) UnmarshalJSON

func (r *AuthenticatedOriginPull) UnmarshalJSON(data []byte) (err error)

type AuthenticatedOriginPullCERTStatus

type AuthenticatedOriginPullCERTStatus string

Status of the certificate or the association.

const (
	AuthenticatedOriginPullCERTStatusInitializing       AuthenticatedOriginPullCERTStatus = "initializing"
	AuthenticatedOriginPullCERTStatusPendingDeployment  AuthenticatedOriginPullCERTStatus = "pending_deployment"
	AuthenticatedOriginPullCERTStatusPendingDeletion    AuthenticatedOriginPullCERTStatus = "pending_deletion"
	AuthenticatedOriginPullCERTStatusActive             AuthenticatedOriginPullCERTStatus = "active"
	AuthenticatedOriginPullCERTStatusDeleted            AuthenticatedOriginPullCERTStatus = "deleted"
	AuthenticatedOriginPullCERTStatusDeploymentTimedOut AuthenticatedOriginPullCERTStatus = "deployment_timed_out"
	AuthenticatedOriginPullCERTStatusDeletionTimedOut   AuthenticatedOriginPullCERTStatus = "deletion_timed_out"
)

func (AuthenticatedOriginPullCERTStatus) IsKnown

type AuthenticatedOriginPullStatus

type AuthenticatedOriginPullStatus string

Status of the certificate or the association.

const (
	AuthenticatedOriginPullStatusInitializing       AuthenticatedOriginPullStatus = "initializing"
	AuthenticatedOriginPullStatusPendingDeployment  AuthenticatedOriginPullStatus = "pending_deployment"
	AuthenticatedOriginPullStatusPendingDeletion    AuthenticatedOriginPullStatus = "pending_deletion"
	AuthenticatedOriginPullStatusActive             AuthenticatedOriginPullStatus = "active"
	AuthenticatedOriginPullStatusDeleted            AuthenticatedOriginPullStatus = "deleted"
	AuthenticatedOriginPullStatusDeploymentTimedOut AuthenticatedOriginPullStatus = "deployment_timed_out"
	AuthenticatedOriginPullStatusDeletionTimedOut   AuthenticatedOriginPullStatus = "deletion_timed_out"
)

func (AuthenticatedOriginPullStatus) IsKnown

func (r AuthenticatedOriginPullStatus) IsKnown() bool

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConfigSrc

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type HostnameCertificateDeleteParams

type HostnameCertificateDeleteParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameCertificateDeleteResponse

type HostnameCertificateDeleteResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The hostname certificate.
	Certificate string `json:"certificate"`
	// The date when the certificate expires.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// The certificate authority that issued the certificate.
	Issuer string `json:"issuer"`
	// The serial number on the uploaded certificate.
	SerialNumber string `json:"serial_number"`
	// The type of hash used for the certificate.
	Signature string `json:"signature"`
	// Status of the certificate or the association.
	Status HostnameCertificateDeleteResponseStatus `json:"status"`
	// The time when the certificate was uploaded.
	UploadedOn time.Time                             `json:"uploaded_on" format:"date-time"`
	JSON       hostnameCertificateDeleteResponseJSON `json:"-"`
}

func (*HostnameCertificateDeleteResponse) UnmarshalJSON

func (r *HostnameCertificateDeleteResponse) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateDeleteResponseEnvelope

type HostnameCertificateDeleteResponseEnvelope struct {
	Errors   []HostnameCertificateDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HostnameCertificateDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success HostnameCertificateDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  HostnameCertificateDeleteResponse                `json:"result"`
	JSON    hostnameCertificateDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameCertificateDeleteResponseEnvelope) UnmarshalJSON

func (r *HostnameCertificateDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateDeleteResponseEnvelopeErrors

type HostnameCertificateDeleteResponseEnvelopeErrors struct {
	Code             int64                                                 `json:"code,required"`
	Message          string                                                `json:"message,required"`
	DocumentationURL string                                                `json:"documentation_url"`
	Source           HostnameCertificateDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             hostnameCertificateDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*HostnameCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON

func (r *HostnameCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateDeleteResponseEnvelopeErrorsSource

type HostnameCertificateDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                    `json:"pointer"`
	JSON    hostnameCertificateDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*HostnameCertificateDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *HostnameCertificateDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateDeleteResponseEnvelopeMessages

type HostnameCertificateDeleteResponseEnvelopeMessages struct {
	Code             int64                                                   `json:"code,required"`
	Message          string                                                  `json:"message,required"`
	DocumentationURL string                                                  `json:"documentation_url"`
	Source           HostnameCertificateDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             hostnameCertificateDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*HostnameCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON

func (r *HostnameCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateDeleteResponseEnvelopeMessagesSource

type HostnameCertificateDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                      `json:"pointer"`
	JSON    hostnameCertificateDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*HostnameCertificateDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

type HostnameCertificateDeleteResponseEnvelopeSuccess

type HostnameCertificateDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	HostnameCertificateDeleteResponseEnvelopeSuccessTrue HostnameCertificateDeleteResponseEnvelopeSuccess = true
)

func (HostnameCertificateDeleteResponseEnvelopeSuccess) IsKnown

type HostnameCertificateDeleteResponseStatus

type HostnameCertificateDeleteResponseStatus string

Status of the certificate or the association.

const (
	HostnameCertificateDeleteResponseStatusInitializing       HostnameCertificateDeleteResponseStatus = "initializing"
	HostnameCertificateDeleteResponseStatusPendingDeployment  HostnameCertificateDeleteResponseStatus = "pending_deployment"
	HostnameCertificateDeleteResponseStatusPendingDeletion    HostnameCertificateDeleteResponseStatus = "pending_deletion"
	HostnameCertificateDeleteResponseStatusActive             HostnameCertificateDeleteResponseStatus = "active"
	HostnameCertificateDeleteResponseStatusDeleted            HostnameCertificateDeleteResponseStatus = "deleted"
	HostnameCertificateDeleteResponseStatusDeploymentTimedOut HostnameCertificateDeleteResponseStatus = "deployment_timed_out"
	HostnameCertificateDeleteResponseStatusDeletionTimedOut   HostnameCertificateDeleteResponseStatus = "deletion_timed_out"
)

func (HostnameCertificateDeleteResponseStatus) IsKnown

type HostnameCertificateGetParams

type HostnameCertificateGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameCertificateGetResponse

type HostnameCertificateGetResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The hostname certificate.
	Certificate string `json:"certificate"`
	// The date when the certificate expires.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// The certificate authority that issued the certificate.
	Issuer string `json:"issuer"`
	// The serial number on the uploaded certificate.
	SerialNumber string `json:"serial_number"`
	// The type of hash used for the certificate.
	Signature string `json:"signature"`
	// Status of the certificate or the association.
	Status HostnameCertificateGetResponseStatus `json:"status"`
	// The time when the certificate was uploaded.
	UploadedOn time.Time                          `json:"uploaded_on" format:"date-time"`
	JSON       hostnameCertificateGetResponseJSON `json:"-"`
}

func (*HostnameCertificateGetResponse) UnmarshalJSON

func (r *HostnameCertificateGetResponse) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateGetResponseEnvelope

type HostnameCertificateGetResponseEnvelope struct {
	Errors   []HostnameCertificateGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HostnameCertificateGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success HostnameCertificateGetResponseEnvelopeSuccess `json:"success,required"`
	Result  HostnameCertificateGetResponse                `json:"result"`
	JSON    hostnameCertificateGetResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameCertificateGetResponseEnvelope) UnmarshalJSON

func (r *HostnameCertificateGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateGetResponseEnvelopeErrors

type HostnameCertificateGetResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           HostnameCertificateGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             hostnameCertificateGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*HostnameCertificateGetResponseEnvelopeErrors) UnmarshalJSON

func (r *HostnameCertificateGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateGetResponseEnvelopeErrorsSource

type HostnameCertificateGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    hostnameCertificateGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*HostnameCertificateGetResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *HostnameCertificateGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateGetResponseEnvelopeMessages

type HostnameCertificateGetResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code,required"`
	Message          string                                               `json:"message,required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           HostnameCertificateGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             hostnameCertificateGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*HostnameCertificateGetResponseEnvelopeMessages) UnmarshalJSON

func (r *HostnameCertificateGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateGetResponseEnvelopeMessagesSource

type HostnameCertificateGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    hostnameCertificateGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*HostnameCertificateGetResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *HostnameCertificateGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateGetResponseEnvelopeSuccess

type HostnameCertificateGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	HostnameCertificateGetResponseEnvelopeSuccessTrue HostnameCertificateGetResponseEnvelopeSuccess = true
)

func (HostnameCertificateGetResponseEnvelopeSuccess) IsKnown

type HostnameCertificateGetResponseStatus

type HostnameCertificateGetResponseStatus string

Status of the certificate or the association.

const (
	HostnameCertificateGetResponseStatusInitializing       HostnameCertificateGetResponseStatus = "initializing"
	HostnameCertificateGetResponseStatusPendingDeployment  HostnameCertificateGetResponseStatus = "pending_deployment"
	HostnameCertificateGetResponseStatusPendingDeletion    HostnameCertificateGetResponseStatus = "pending_deletion"
	HostnameCertificateGetResponseStatusActive             HostnameCertificateGetResponseStatus = "active"
	HostnameCertificateGetResponseStatusDeleted            HostnameCertificateGetResponseStatus = "deleted"
	HostnameCertificateGetResponseStatusDeploymentTimedOut HostnameCertificateGetResponseStatus = "deployment_timed_out"
	HostnameCertificateGetResponseStatusDeletionTimedOut   HostnameCertificateGetResponseStatus = "deletion_timed_out"
)

func (HostnameCertificateGetResponseStatus) IsKnown

type HostnameCertificateListParams

type HostnameCertificateListParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameCertificateListResponse

type HostnameCertificateListResponse struct {
	// Identifier.
	ID string `json:"id"`
	// Identifier.
	CERTID string `json:"cert_id"`
	// The hostname certificate.
	Certificate string `json:"certificate"`
	// Indicates whether hostname-level authenticated origin pulls is enabled. A null
	// value voids the association.
	Enabled bool `json:"enabled,nullable"`
	// The hostname on the origin for which the client certificate uploaded will be
	// used.
	Hostname string `json:"hostname"`
	// The hostname certificate's private key.
	PrivateKey string                              `json:"private_key"`
	JSON       hostnameCertificateListResponseJSON `json:"-"`
	AuthenticatedOriginPull
}

func (*HostnameCertificateListResponse) UnmarshalJSON

func (r *HostnameCertificateListResponse) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateNewParams

type HostnameCertificateNewParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The hostname certificate.
	Certificate param.Field[string] `json:"certificate,required"`
	// The hostname certificate's private key.
	PrivateKey param.Field[string] `json:"private_key,required"`
}

func (HostnameCertificateNewParams) MarshalJSON

func (r HostnameCertificateNewParams) MarshalJSON() (data []byte, err error)

type HostnameCertificateNewResponse

type HostnameCertificateNewResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The hostname certificate.
	Certificate string `json:"certificate"`
	// The date when the certificate expires.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// The certificate authority that issued the certificate.
	Issuer string `json:"issuer"`
	// The serial number on the uploaded certificate.
	SerialNumber string `json:"serial_number"`
	// The type of hash used for the certificate.
	Signature string `json:"signature"`
	// Status of the certificate or the association.
	Status HostnameCertificateNewResponseStatus `json:"status"`
	// The time when the certificate was uploaded.
	UploadedOn time.Time                          `json:"uploaded_on" format:"date-time"`
	JSON       hostnameCertificateNewResponseJSON `json:"-"`
}

func (*HostnameCertificateNewResponse) UnmarshalJSON

func (r *HostnameCertificateNewResponse) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateNewResponseEnvelope

type HostnameCertificateNewResponseEnvelope struct {
	Errors   []HostnameCertificateNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HostnameCertificateNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success HostnameCertificateNewResponseEnvelopeSuccess `json:"success,required"`
	Result  HostnameCertificateNewResponse                `json:"result"`
	JSON    hostnameCertificateNewResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameCertificateNewResponseEnvelope) UnmarshalJSON

func (r *HostnameCertificateNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateNewResponseEnvelopeErrors

type HostnameCertificateNewResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           HostnameCertificateNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             hostnameCertificateNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*HostnameCertificateNewResponseEnvelopeErrors) UnmarshalJSON

func (r *HostnameCertificateNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateNewResponseEnvelopeErrorsSource

type HostnameCertificateNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    hostnameCertificateNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*HostnameCertificateNewResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *HostnameCertificateNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateNewResponseEnvelopeMessages

type HostnameCertificateNewResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code,required"`
	Message          string                                               `json:"message,required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           HostnameCertificateNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             hostnameCertificateNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*HostnameCertificateNewResponseEnvelopeMessages) UnmarshalJSON

func (r *HostnameCertificateNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateNewResponseEnvelopeMessagesSource

type HostnameCertificateNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    hostnameCertificateNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*HostnameCertificateNewResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *HostnameCertificateNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type HostnameCertificateNewResponseEnvelopeSuccess

type HostnameCertificateNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	HostnameCertificateNewResponseEnvelopeSuccessTrue HostnameCertificateNewResponseEnvelopeSuccess = true
)

func (HostnameCertificateNewResponseEnvelopeSuccess) IsKnown

type HostnameCertificateNewResponseStatus

type HostnameCertificateNewResponseStatus string

Status of the certificate or the association.

const (
	HostnameCertificateNewResponseStatusInitializing       HostnameCertificateNewResponseStatus = "initializing"
	HostnameCertificateNewResponseStatusPendingDeployment  HostnameCertificateNewResponseStatus = "pending_deployment"
	HostnameCertificateNewResponseStatusPendingDeletion    HostnameCertificateNewResponseStatus = "pending_deletion"
	HostnameCertificateNewResponseStatusActive             HostnameCertificateNewResponseStatus = "active"
	HostnameCertificateNewResponseStatusDeleted            HostnameCertificateNewResponseStatus = "deleted"
	HostnameCertificateNewResponseStatusDeploymentTimedOut HostnameCertificateNewResponseStatus = "deployment_timed_out"
	HostnameCertificateNewResponseStatusDeletionTimedOut   HostnameCertificateNewResponseStatus = "deletion_timed_out"
)

func (HostnameCertificateNewResponseStatus) IsKnown

type HostnameCertificateService

type HostnameCertificateService struct {
	Options []option.RequestOption
}

HostnameCertificateService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHostnameCertificateService method instead.

func NewHostnameCertificateService

func NewHostnameCertificateService(opts ...option.RequestOption) (r *HostnameCertificateService)

NewHostnameCertificateService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HostnameCertificateService) Delete

Delete Hostname Client Certificate

func (*HostnameCertificateService) Get

Get the certificate by ID to be used for client authentication on a hostname.

func (*HostnameCertificateService) List

List Certificates

func (*HostnameCertificateService) ListAutoPaging

List Certificates

func (*HostnameCertificateService) New

Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.

type HostnameGetParams

type HostnameGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameGetResponseEnvelope

type HostnameGetResponseEnvelope struct {
	Errors   []HostnameGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HostnameGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success HostnameGetResponseEnvelopeSuccess `json:"success,required"`
	Result  AuthenticatedOriginPull            `json:"result"`
	JSON    hostnameGetResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameGetResponseEnvelope) UnmarshalJSON

func (r *HostnameGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HostnameGetResponseEnvelopeErrors

type HostnameGetResponseEnvelopeErrors struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           HostnameGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             hostnameGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*HostnameGetResponseEnvelopeErrors) UnmarshalJSON

func (r *HostnameGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type HostnameGetResponseEnvelopeErrorsSource

type HostnameGetResponseEnvelopeErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    hostnameGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*HostnameGetResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *HostnameGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type HostnameGetResponseEnvelopeMessages

type HostnameGetResponseEnvelopeMessages struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           HostnameGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             hostnameGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*HostnameGetResponseEnvelopeMessages) UnmarshalJSON

func (r *HostnameGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type HostnameGetResponseEnvelopeMessagesSource

type HostnameGetResponseEnvelopeMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    hostnameGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*HostnameGetResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *HostnameGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type HostnameGetResponseEnvelopeSuccess

type HostnameGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	HostnameGetResponseEnvelopeSuccessTrue HostnameGetResponseEnvelopeSuccess = true
)

func (HostnameGetResponseEnvelopeSuccess) IsKnown

type HostnameService

type HostnameService struct {
	Options []option.RequestOption
}

HostnameService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHostnameService method instead.

func NewHostnameService

func NewHostnameService(opts ...option.RequestOption) (r *HostnameService)

NewHostnameService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HostnameService) Get

func (r *HostnameService) Get(ctx context.Context, hostname string, query HostnameGetParams, opts ...option.RequestOption) (res *AuthenticatedOriginPull, err error)

Get the Hostname Status for Client Authentication

func (*HostnameService) Update

Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter _enabled_ to invalidate the association.

func (*HostnameService) UpdateAutoPaging

Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter _enabled_ to invalidate the association.

type HostnameUpdateParams

type HostnameUpdateParams struct {
	// Identifier.
	ZoneID param.Field[string]                       `path:"zone_id,required"`
	Config param.Field[[]HostnameUpdateParamsConfig] `json:"config,required"`
}

func (HostnameUpdateParams) MarshalJSON

func (r HostnameUpdateParams) MarshalJSON() (data []byte, err error)

type HostnameUpdateParamsConfig

type HostnameUpdateParamsConfig struct {
	// Certificate identifier tag.
	CERTID param.Field[string] `json:"cert_id"`
	// Indicates whether hostname-level authenticated origin pulls is enabled. A null
	// value voids the association.
	Enabled param.Field[bool] `json:"enabled"`
	// The hostname on the origin for which the client certificate uploaded will be
	// used.
	Hostname param.Field[string] `json:"hostname"`
}

func (HostnameUpdateParamsConfig) MarshalJSON

func (r HostnameUpdateParamsConfig) MarshalJSON() (data []byte, err error)

type HostnameUpdateResponse

type HostnameUpdateResponse struct {
	// Identifier.
	ID string `json:"id"`
	// Identifier.
	CERTID string `json:"cert_id"`
	// The hostname certificate.
	Certificate string `json:"certificate"`
	// Indicates whether hostname-level authenticated origin pulls is enabled. A null
	// value voids the association.
	Enabled bool `json:"enabled,nullable"`
	// The hostname on the origin for which the client certificate uploaded will be
	// used.
	Hostname string `json:"hostname"`
	// The hostname certificate's private key.
	PrivateKey string                     `json:"private_key"`
	JSON       hostnameUpdateResponseJSON `json:"-"`
	AuthenticatedOriginPull
}

func (*HostnameUpdateResponse) UnmarshalJSON

func (r *HostnameUpdateResponse) UnmarshalJSON(data []byte) (err error)

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type OriginTLSClientAuthDeleteParams

type OriginTLSClientAuthDeleteParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type OriginTLSClientAuthDeleteResponse

type OriginTLSClientAuthDeleteResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The zone's leaf certificate.
	Certificate string `json:"certificate"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool `json:"enabled"`
	// The zone's private key.
	PrivateKey string                                `json:"private_key"`
	JSON       originTLSClientAuthDeleteResponseJSON `json:"-"`
	ZoneAuthenticatedOriginPull
}

func (*OriginTLSClientAuthDeleteResponse) UnmarshalJSON

func (r *OriginTLSClientAuthDeleteResponse) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthDeleteResponseEnvelope

type OriginTLSClientAuthDeleteResponseEnvelope struct {
	Errors   []OriginTLSClientAuthDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OriginTLSClientAuthDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success OriginTLSClientAuthDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  OriginTLSClientAuthDeleteResponse                `json:"result"`
	JSON    originTLSClientAuthDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*OriginTLSClientAuthDeleteResponseEnvelope) UnmarshalJSON

func (r *OriginTLSClientAuthDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthDeleteResponseEnvelopeErrors

type OriginTLSClientAuthDeleteResponseEnvelopeErrors struct {
	Code             int64                                                 `json:"code,required"`
	Message          string                                                `json:"message,required"`
	DocumentationURL string                                                `json:"documentation_url"`
	Source           OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             originTLSClientAuthDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*OriginTLSClientAuthDeleteResponseEnvelopeErrors) UnmarshalJSON

func (r *OriginTLSClientAuthDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource

type OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                    `json:"pointer"`
	JSON    originTLSClientAuthDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthDeleteResponseEnvelopeMessages

type OriginTLSClientAuthDeleteResponseEnvelopeMessages struct {
	Code             int64                                                   `json:"code,required"`
	Message          string                                                  `json:"message,required"`
	DocumentationURL string                                                  `json:"documentation_url"`
	Source           OriginTLSClientAuthDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             originTLSClientAuthDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*OriginTLSClientAuthDeleteResponseEnvelopeMessages) UnmarshalJSON

func (r *OriginTLSClientAuthDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthDeleteResponseEnvelopeMessagesSource

type OriginTLSClientAuthDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                      `json:"pointer"`
	JSON    originTLSClientAuthDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*OriginTLSClientAuthDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

type OriginTLSClientAuthDeleteResponseEnvelopeSuccess

type OriginTLSClientAuthDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	OriginTLSClientAuthDeleteResponseEnvelopeSuccessTrue OriginTLSClientAuthDeleteResponseEnvelopeSuccess = true
)

func (OriginTLSClientAuthDeleteResponseEnvelopeSuccess) IsKnown

type OriginTLSClientAuthGetParams

type OriginTLSClientAuthGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type OriginTLSClientAuthGetResponse

type OriginTLSClientAuthGetResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The zone's leaf certificate.
	Certificate string `json:"certificate"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool `json:"enabled"`
	// The zone's private key.
	PrivateKey string                             `json:"private_key"`
	JSON       originTLSClientAuthGetResponseJSON `json:"-"`
	ZoneAuthenticatedOriginPull
}

func (*OriginTLSClientAuthGetResponse) UnmarshalJSON

func (r *OriginTLSClientAuthGetResponse) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthGetResponseEnvelope

type OriginTLSClientAuthGetResponseEnvelope struct {
	Errors   []OriginTLSClientAuthGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OriginTLSClientAuthGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success OriginTLSClientAuthGetResponseEnvelopeSuccess `json:"success,required"`
	Result  OriginTLSClientAuthGetResponse                `json:"result"`
	JSON    originTLSClientAuthGetResponseEnvelopeJSON    `json:"-"`
}

func (*OriginTLSClientAuthGetResponseEnvelope) UnmarshalJSON

func (r *OriginTLSClientAuthGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthGetResponseEnvelopeErrors

type OriginTLSClientAuthGetResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           OriginTLSClientAuthGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             originTLSClientAuthGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*OriginTLSClientAuthGetResponseEnvelopeErrors) UnmarshalJSON

func (r *OriginTLSClientAuthGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthGetResponseEnvelopeErrorsSource

type OriginTLSClientAuthGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    originTLSClientAuthGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*OriginTLSClientAuthGetResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *OriginTLSClientAuthGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthGetResponseEnvelopeMessages

type OriginTLSClientAuthGetResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code,required"`
	Message          string                                               `json:"message,required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           OriginTLSClientAuthGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             originTLSClientAuthGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*OriginTLSClientAuthGetResponseEnvelopeMessages) UnmarshalJSON

func (r *OriginTLSClientAuthGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthGetResponseEnvelopeMessagesSource

type OriginTLSClientAuthGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    originTLSClientAuthGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*OriginTLSClientAuthGetResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *OriginTLSClientAuthGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthGetResponseEnvelopeSuccess

type OriginTLSClientAuthGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	OriginTLSClientAuthGetResponseEnvelopeSuccessTrue OriginTLSClientAuthGetResponseEnvelopeSuccess = true
)

func (OriginTLSClientAuthGetResponseEnvelopeSuccess) IsKnown

type OriginTLSClientAuthListParams

type OriginTLSClientAuthListParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type OriginTLSClientAuthListResponse

type OriginTLSClientAuthListResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The zone's leaf certificate.
	Certificate string `json:"certificate"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool `json:"enabled"`
	// The zone's private key.
	PrivateKey string                              `json:"private_key"`
	JSON       originTLSClientAuthListResponseJSON `json:"-"`
	ZoneAuthenticatedOriginPull
}

func (*OriginTLSClientAuthListResponse) UnmarshalJSON

func (r *OriginTLSClientAuthListResponse) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthNewParams

type OriginTLSClientAuthNewParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The zone's leaf certificate.
	Certificate param.Field[string] `json:"certificate,required"`
	// The zone's private key.
	PrivateKey param.Field[string] `json:"private_key,required"`
}

func (OriginTLSClientAuthNewParams) MarshalJSON

func (r OriginTLSClientAuthNewParams) MarshalJSON() (data []byte, err error)

type OriginTLSClientAuthNewResponse

type OriginTLSClientAuthNewResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The zone's leaf certificate.
	Certificate string `json:"certificate"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool `json:"enabled"`
	// The zone's private key.
	PrivateKey string                             `json:"private_key"`
	JSON       originTLSClientAuthNewResponseJSON `json:"-"`
	ZoneAuthenticatedOriginPull
}

func (*OriginTLSClientAuthNewResponse) UnmarshalJSON

func (r *OriginTLSClientAuthNewResponse) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthNewResponseEnvelope

type OriginTLSClientAuthNewResponseEnvelope struct {
	Errors   []OriginTLSClientAuthNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OriginTLSClientAuthNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success OriginTLSClientAuthNewResponseEnvelopeSuccess `json:"success,required"`
	Result  OriginTLSClientAuthNewResponse                `json:"result"`
	JSON    originTLSClientAuthNewResponseEnvelopeJSON    `json:"-"`
}

func (*OriginTLSClientAuthNewResponseEnvelope) UnmarshalJSON

func (r *OriginTLSClientAuthNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthNewResponseEnvelopeErrors

type OriginTLSClientAuthNewResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           OriginTLSClientAuthNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             originTLSClientAuthNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*OriginTLSClientAuthNewResponseEnvelopeErrors) UnmarshalJSON

func (r *OriginTLSClientAuthNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthNewResponseEnvelopeErrorsSource

type OriginTLSClientAuthNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    originTLSClientAuthNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*OriginTLSClientAuthNewResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *OriginTLSClientAuthNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthNewResponseEnvelopeMessages

type OriginTLSClientAuthNewResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code,required"`
	Message          string                                               `json:"message,required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           OriginTLSClientAuthNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             originTLSClientAuthNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*OriginTLSClientAuthNewResponseEnvelopeMessages) UnmarshalJSON

func (r *OriginTLSClientAuthNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthNewResponseEnvelopeMessagesSource

type OriginTLSClientAuthNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    originTLSClientAuthNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*OriginTLSClientAuthNewResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *OriginTLSClientAuthNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type OriginTLSClientAuthNewResponseEnvelopeSuccess

type OriginTLSClientAuthNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	OriginTLSClientAuthNewResponseEnvelopeSuccessTrue OriginTLSClientAuthNewResponseEnvelopeSuccess = true
)

func (OriginTLSClientAuthNewResponseEnvelopeSuccess) IsKnown

type OriginTLSClientAuthService

type OriginTLSClientAuthService struct {
	Options              []option.RequestOption
	ZoneCertificates     *ZoneCertificateService
	Hostnames            *HostnameService
	HostnameCertificates *HostnameCertificateService
	Settings             *SettingService
}

OriginTLSClientAuthService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOriginTLSClientAuthService method instead.

func NewOriginTLSClientAuthService

func NewOriginTLSClientAuthService(opts ...option.RequestOption) (r *OriginTLSClientAuthService)

NewOriginTLSClientAuthService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OriginTLSClientAuthService) Delete deprecated

Delete Certificate

Deprecated: Use zone_certificates.delete for zone-level certificates. This method will be removed in a future major version.

func (*OriginTLSClientAuthService) Get deprecated

Get Certificate Details

Deprecated: Use zone_certificates.get for zone-level certificates. This method will be removed in a future major version.

func (*OriginTLSClientAuthService) List deprecated

List Certificates

Deprecated: Use zone_certificates.list for zone-level certificates. This method will be removed in a future major version.

func (*OriginTLSClientAuthService) ListAutoPaging deprecated

List Certificates

Deprecated: Use zone_certificates.list for zone-level certificates. This method will be removed in a future major version.

func (*OriginTLSClientAuthService) New deprecated

Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.

Deprecated: Use zone_certificates.create for zone-level certificates. This method will be removed in a future major version.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SettingGetParams

type SettingGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type SettingGetResponse

type SettingGetResponse struct {
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool                   `json:"enabled"`
	JSON    settingGetResponseJSON `json:"-"`
}

func (*SettingGetResponse) UnmarshalJSON

func (r *SettingGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingGetResponseEnvelope

type SettingGetResponseEnvelope struct {
	Errors   []SettingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success SettingGetResponseEnvelopeSuccess `json:"success,required"`
	Result  SettingGetResponse                `json:"result"`
	JSON    settingGetResponseEnvelopeJSON    `json:"-"`
}

func (*SettingGetResponseEnvelope) UnmarshalJSON

func (r *SettingGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingGetResponseEnvelopeErrors

type SettingGetResponseEnvelopeErrors struct {
	Code             int64                                  `json:"code,required"`
	Message          string                                 `json:"message,required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           SettingGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingGetResponseEnvelopeErrors) UnmarshalJSON

func (r *SettingGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingGetResponseEnvelopeErrorsSource

type SettingGetResponseEnvelopeErrorsSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    settingGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingGetResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *SettingGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingGetResponseEnvelopeMessages

type SettingGetResponseEnvelopeMessages struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           SettingGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingGetResponseEnvelopeMessages) UnmarshalJSON

func (r *SettingGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingGetResponseEnvelopeMessagesSource

type SettingGetResponseEnvelopeMessagesSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    settingGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingGetResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *SettingGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingGetResponseEnvelopeSuccess

type SettingGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SettingGetResponseEnvelopeSuccessTrue SettingGetResponseEnvelopeSuccess = true
)

func (SettingGetResponseEnvelopeSuccess) IsKnown

type SettingService

type SettingService struct {
	Options []option.RequestOption
}

SettingService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingService method instead.

func NewSettingService

func NewSettingService(opts ...option.RequestOption) (r *SettingService)

NewSettingService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingService) Get

Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.

func (*SettingService) Update

Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.

type SettingUpdateParams

type SettingUpdateParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled param.Field[bool] `json:"enabled,required"`
}

func (SettingUpdateParams) MarshalJSON

func (r SettingUpdateParams) MarshalJSON() (data []byte, err error)

type SettingUpdateResponse

type SettingUpdateResponse struct {
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool                      `json:"enabled"`
	JSON    settingUpdateResponseJSON `json:"-"`
}

func (*SettingUpdateResponse) UnmarshalJSON

func (r *SettingUpdateResponse) UnmarshalJSON(data []byte) (err error)

type SettingUpdateResponseEnvelope

type SettingUpdateResponseEnvelope struct {
	Errors   []SettingUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success SettingUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  SettingUpdateResponse                `json:"result"`
	JSON    settingUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*SettingUpdateResponseEnvelope) UnmarshalJSON

func (r *SettingUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingUpdateResponseEnvelopeErrors

type SettingUpdateResponseEnvelopeErrors struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           SettingUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingUpdateResponseEnvelopeErrors) UnmarshalJSON

func (r *SettingUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingUpdateResponseEnvelopeErrorsSource

type SettingUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    settingUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingUpdateResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *SettingUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingUpdateResponseEnvelopeMessages

type SettingUpdateResponseEnvelopeMessages struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           SettingUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingUpdateResponseEnvelopeMessages) UnmarshalJSON

func (r *SettingUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingUpdateResponseEnvelopeMessagesSource

type SettingUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    settingUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingUpdateResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *SettingUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingUpdateResponseEnvelopeSuccess

type SettingUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SettingUpdateResponseEnvelopeSuccessTrue SettingUpdateResponseEnvelopeSuccess = true
)

func (SettingUpdateResponseEnvelopeSuccess) IsKnown

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

type ZoneAuthenticatedOriginPull

type ZoneAuthenticatedOriginPull struct {
	// Identifier.
	ID string `json:"id"`
	// The zone's leaf certificate.
	Certificate string `json:"certificate"`
	// When the certificate from the authority expires.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// The certificate authority that issued the certificate.
	Issuer string `json:"issuer"`
	// The type of hash used for the certificate.
	Signature string `json:"signature"`
	// Status of the certificate activation.
	Status ZoneAuthenticatedOriginPullStatus `json:"status"`
	// This is the time the certificate was uploaded.
	UploadedOn time.Time                       `json:"uploaded_on" format:"date-time"`
	JSON       zoneAuthenticatedOriginPullJSON `json:"-"`
}

func (*ZoneAuthenticatedOriginPull) UnmarshalJSON

func (r *ZoneAuthenticatedOriginPull) UnmarshalJSON(data []byte) (err error)

type ZoneAuthenticatedOriginPullStatus

type ZoneAuthenticatedOriginPullStatus string

Status of the certificate activation.

const (
	ZoneAuthenticatedOriginPullStatusInitializing       ZoneAuthenticatedOriginPullStatus = "initializing"
	ZoneAuthenticatedOriginPullStatusPendingDeployment  ZoneAuthenticatedOriginPullStatus = "pending_deployment"
	ZoneAuthenticatedOriginPullStatusPendingDeletion    ZoneAuthenticatedOriginPullStatus = "pending_deletion"
	ZoneAuthenticatedOriginPullStatusActive             ZoneAuthenticatedOriginPullStatus = "active"
	ZoneAuthenticatedOriginPullStatusDeleted            ZoneAuthenticatedOriginPullStatus = "deleted"
	ZoneAuthenticatedOriginPullStatusDeploymentTimedOut ZoneAuthenticatedOriginPullStatus = "deployment_timed_out"
	ZoneAuthenticatedOriginPullStatusDeletionTimedOut   ZoneAuthenticatedOriginPullStatus = "deletion_timed_out"
)

func (ZoneAuthenticatedOriginPullStatus) IsKnown

type ZoneCertificateDeleteParams added in v6.7.0

type ZoneCertificateDeleteParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ZoneCertificateDeleteResponse added in v6.7.0

type ZoneCertificateDeleteResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The zone's leaf certificate.
	Certificate string `json:"certificate"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool `json:"enabled"`
	// The zone's private key.
	PrivateKey string                            `json:"private_key"`
	JSON       zoneCertificateDeleteResponseJSON `json:"-"`
	ZoneAuthenticatedOriginPull
}

func (*ZoneCertificateDeleteResponse) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateDeleteResponse) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateDeleteResponseEnvelope added in v6.7.0

type ZoneCertificateDeleteResponseEnvelope struct {
	Errors   []ZoneCertificateDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ZoneCertificateDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ZoneCertificateDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  ZoneCertificateDeleteResponse                `json:"result"`
	JSON    zoneCertificateDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ZoneCertificateDeleteResponseEnvelope) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateDeleteResponseEnvelopeErrors added in v6.7.0

type ZoneCertificateDeleteResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ZoneCertificateDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             zoneCertificateDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ZoneCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateDeleteResponseEnvelopeErrorsSource added in v6.7.0

type ZoneCertificateDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    zoneCertificateDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ZoneCertificateDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateDeleteResponseEnvelopeMessages added in v6.7.0

type ZoneCertificateDeleteResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code,required"`
	Message          string                                              `json:"message,required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           ZoneCertificateDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             zoneCertificateDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ZoneCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateDeleteResponseEnvelopeMessagesSource added in v6.7.0

type ZoneCertificateDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    zoneCertificateDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ZoneCertificateDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateDeleteResponseEnvelopeSuccess added in v6.7.0

type ZoneCertificateDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ZoneCertificateDeleteResponseEnvelopeSuccessTrue ZoneCertificateDeleteResponseEnvelopeSuccess = true
)

func (ZoneCertificateDeleteResponseEnvelopeSuccess) IsKnown added in v6.7.0

type ZoneCertificateGetParams added in v6.7.0

type ZoneCertificateGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ZoneCertificateGetResponse added in v6.7.0

type ZoneCertificateGetResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The zone's leaf certificate.
	Certificate string `json:"certificate"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool `json:"enabled"`
	// The zone's private key.
	PrivateKey string                         `json:"private_key"`
	JSON       zoneCertificateGetResponseJSON `json:"-"`
	ZoneAuthenticatedOriginPull
}

func (*ZoneCertificateGetResponse) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateGetResponse) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateGetResponseEnvelope added in v6.7.0

type ZoneCertificateGetResponseEnvelope struct {
	Errors   []ZoneCertificateGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ZoneCertificateGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ZoneCertificateGetResponseEnvelopeSuccess `json:"success,required"`
	Result  ZoneCertificateGetResponse                `json:"result"`
	JSON    zoneCertificateGetResponseEnvelopeJSON    `json:"-"`
}

func (*ZoneCertificateGetResponseEnvelope) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateGetResponseEnvelopeErrors added in v6.7.0

type ZoneCertificateGetResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ZoneCertificateGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             zoneCertificateGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ZoneCertificateGetResponseEnvelopeErrors) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateGetResponseEnvelopeErrorsSource added in v6.7.0

type ZoneCertificateGetResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    zoneCertificateGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ZoneCertificateGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateGetResponseEnvelopeMessages added in v6.7.0

type ZoneCertificateGetResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           ZoneCertificateGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             zoneCertificateGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ZoneCertificateGetResponseEnvelopeMessages) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateGetResponseEnvelopeMessagesSource added in v6.7.0

type ZoneCertificateGetResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    zoneCertificateGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ZoneCertificateGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateGetResponseEnvelopeSuccess added in v6.7.0

type ZoneCertificateGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ZoneCertificateGetResponseEnvelopeSuccessTrue ZoneCertificateGetResponseEnvelopeSuccess = true
)

func (ZoneCertificateGetResponseEnvelopeSuccess) IsKnown added in v6.7.0

type ZoneCertificateListParams added in v6.7.0

type ZoneCertificateListParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ZoneCertificateListResponse added in v6.7.0

type ZoneCertificateListResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The zone's leaf certificate.
	Certificate string `json:"certificate"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool `json:"enabled"`
	// The zone's private key.
	PrivateKey string                          `json:"private_key"`
	JSON       zoneCertificateListResponseJSON `json:"-"`
	ZoneAuthenticatedOriginPull
}

func (*ZoneCertificateListResponse) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateListResponse) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateNewParams added in v6.7.0

type ZoneCertificateNewParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The zone's leaf certificate.
	Certificate param.Field[string] `json:"certificate,required"`
	// The zone's private key.
	PrivateKey param.Field[string] `json:"private_key,required"`
}

func (ZoneCertificateNewParams) MarshalJSON added in v6.7.0

func (r ZoneCertificateNewParams) MarshalJSON() (data []byte, err error)

type ZoneCertificateNewResponse added in v6.7.0

type ZoneCertificateNewResponse struct {
	// Identifier.
	ID string `json:"id"`
	// The zone's leaf certificate.
	Certificate string `json:"certificate"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool `json:"enabled"`
	// The zone's private key.
	PrivateKey string                         `json:"private_key"`
	JSON       zoneCertificateNewResponseJSON `json:"-"`
	ZoneAuthenticatedOriginPull
}

func (*ZoneCertificateNewResponse) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateNewResponse) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateNewResponseEnvelope added in v6.7.0

type ZoneCertificateNewResponseEnvelope struct {
	Errors   []ZoneCertificateNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ZoneCertificateNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ZoneCertificateNewResponseEnvelopeSuccess `json:"success,required"`
	Result  ZoneCertificateNewResponse                `json:"result"`
	JSON    zoneCertificateNewResponseEnvelopeJSON    `json:"-"`
}

func (*ZoneCertificateNewResponseEnvelope) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateNewResponseEnvelopeErrors added in v6.7.0

type ZoneCertificateNewResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ZoneCertificateNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             zoneCertificateNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ZoneCertificateNewResponseEnvelopeErrors) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateNewResponseEnvelopeErrorsSource added in v6.7.0

type ZoneCertificateNewResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    zoneCertificateNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ZoneCertificateNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateNewResponseEnvelopeMessages added in v6.7.0

type ZoneCertificateNewResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           ZoneCertificateNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             zoneCertificateNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ZoneCertificateNewResponseEnvelopeMessages) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateNewResponseEnvelopeMessagesSource added in v6.7.0

type ZoneCertificateNewResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    zoneCertificateNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ZoneCertificateNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.7.0

func (r *ZoneCertificateNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type ZoneCertificateNewResponseEnvelopeSuccess added in v6.7.0

type ZoneCertificateNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ZoneCertificateNewResponseEnvelopeSuccessTrue ZoneCertificateNewResponseEnvelopeSuccess = true
)

func (ZoneCertificateNewResponseEnvelopeSuccess) IsKnown added in v6.7.0

type ZoneCertificateService added in v6.7.0

type ZoneCertificateService struct {
	Options []option.RequestOption
}

ZoneCertificateService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewZoneCertificateService method instead.

func NewZoneCertificateService added in v6.7.0

func NewZoneCertificateService(opts ...option.RequestOption) (r *ZoneCertificateService)

NewZoneCertificateService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ZoneCertificateService) Delete added in v6.7.0

Delete Certificate

func (*ZoneCertificateService) Get added in v6.7.0

Get Certificate Details

func (*ZoneCertificateService) List added in v6.7.0

List Certificates

func (*ZoneCertificateService) ListAutoPaging added in v6.7.0

List Certificates

func (*ZoneCertificateService) New added in v6.7.0

Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL