ssl

package
v0.0.0-...-c5310a0 Latest Latest
Warning

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

 Go to latest Published: Feb 7, 2025 License: Apache-2.0 Imports: 15 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 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 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 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 AnalyzeNewParams 

type AnalyzeNewParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// A ubiquitous bundle has the highest probability of being verified everywhere,
	// even by clients using outdated or unusual trust stores. An optimal bundle uses
	// the shortest chain and newest intermediates. And the force bundle verifies the
	// chain, but does not otherwise modify it.
	BundleMethod param.Field[custom_hostnames.BundleMethod] `json:"bundle_method"`
	// The zone's SSL certificate or certificate and the intermediate(s).
	Certificate param.Field[string] `json:"certificate"`
}

func (AnalyzeNewParams) MarshalJSON 

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

type AnalyzeNewResponse 

type AnalyzeNewResponse = interface{}

type AnalyzeNewResponseEnvelope 

type AnalyzeNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success AnalyzeNewResponseEnvelopeSuccess `json:"success,required"`
	Result  AnalyzeNewResponse                `json:"result"`
	JSON    analyzeNewResponseEnvelopeJSON    `json:"-"`
}

func (*AnalyzeNewResponseEnvelope) UnmarshalJSON 

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

type AnalyzeNewResponseEnvelopeSuccess 

type AnalyzeNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AnalyzeNewResponseEnvelopeSuccessTrue AnalyzeNewResponseEnvelopeSuccess = true
)

func (AnalyzeNewResponseEnvelopeSuccess) IsKnown 

func (r AnalyzeNewResponseEnvelopeSuccess) IsKnown() bool

type AnalyzeService 

type AnalyzeService struct {
	Options []option.RequestOption
}

AnalyzeService 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 NewAnalyzeService method instead.

func NewAnalyzeService 

func NewAnalyzeService(opts ...option.RequestOption) (r *AnalyzeService)

NewAnalyzeService 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 (*AnalyzeService) New 

func (r *AnalyzeService) New(ctx context.Context, params AnalyzeNewParams, opts ...option.RequestOption) (res *AnalyzeNewResponse, err error)

Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate.

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 CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificatePackDeleteParams 

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

type CertificatePackDeleteResponse 

type CertificatePackDeleteResponse struct {
	// Identifier
	ID   string                            `json:"id"`
	JSON certificatePackDeleteResponseJSON `json:"-"`
}

func (*CertificatePackDeleteResponse) UnmarshalJSON 

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

type CertificatePackDeleteResponseEnvelope 

type CertificatePackDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success CertificatePackDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  CertificatePackDeleteResponse                `json:"result"`
	JSON    certificatePackDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*CertificatePackDeleteResponseEnvelope) UnmarshalJSON 

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

type CertificatePackDeleteResponseEnvelopeSuccess 

type CertificatePackDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackDeleteResponseEnvelopeSuccessTrue CertificatePackDeleteResponseEnvelopeSuccess = true
)

func (CertificatePackDeleteResponseEnvelopeSuccess) IsKnown 

func (r CertificatePackDeleteResponseEnvelopeSuccess) IsKnown() bool

type CertificatePackEditParams 

type CertificatePackEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Whether or not to add Cloudflare Branding for the order. This will add a
	// subdomain of sni.cloudflaressl.com as the Common Name if set to true.
	CloudflareBranding param.Field[bool] `json:"cloudflare_branding"`
}

func (CertificatePackEditParams) MarshalJSON 

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

type CertificatePackEditResponse 

type CertificatePackEditResponse struct {
	// Identifier
	ID string `json:"id"`
	// Certificate Authority selected for the order. For information on any certificate
	// authority specific details or restrictions
	// [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)
	CertificateAuthority CertificatePackEditResponseCertificateAuthority `json:"certificate_authority"`
	// Whether or not to add Cloudflare Branding for the order. This will add a
	// subdomain of sni.cloudflaressl.com as the Common Name if set to true.
	CloudflareBranding bool `json:"cloudflare_branding"`
	// Comma separated list of valid host names for the certificate packs. Must contain
	// the zone apex, may not contain more than 50 hosts, and may not be empty.
	Hosts []Host `json:"hosts"`
	// Status of certificate pack.
	Status Status `json:"status"`
	// Type of certificate pack.
	Type CertificatePackEditResponseType `json:"type"`
	// Validation Method selected for the order.
	ValidationMethod CertificatePackEditResponseValidationMethod `json:"validation_method"`
	// Validity Days selected for the order.
	ValidityDays CertificatePackEditResponseValidityDays `json:"validity_days"`
	JSON         certificatePackEditResponseJSON         `json:"-"`
}

func (*CertificatePackEditResponse) UnmarshalJSON 

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

type CertificatePackEditResponseCertificateAuthority 

type CertificatePackEditResponseCertificateAuthority string

Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities) 

const (
	CertificatePackEditResponseCertificateAuthorityGoogle      CertificatePackEditResponseCertificateAuthority = "google"
	CertificatePackEditResponseCertificateAuthorityLetsEncrypt CertificatePackEditResponseCertificateAuthority = "lets_encrypt"
	CertificatePackEditResponseCertificateAuthoritySSLCom      CertificatePackEditResponseCertificateAuthority = "ssl_com"
)

func (CertificatePackEditResponseCertificateAuthority) IsKnown 

func (r CertificatePackEditResponseCertificateAuthority) IsKnown() bool

type CertificatePackEditResponseEnvelope 

type CertificatePackEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success CertificatePackEditResponseEnvelopeSuccess `json:"success,required"`
	Result  CertificatePackEditResponse                `json:"result"`
	JSON    certificatePackEditResponseEnvelopeJSON    `json:"-"`
}

func (*CertificatePackEditResponseEnvelope) UnmarshalJSON 

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

type CertificatePackEditResponseEnvelopeSuccess 

type CertificatePackEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackEditResponseEnvelopeSuccessTrue CertificatePackEditResponseEnvelopeSuccess = true
)

func (CertificatePackEditResponseEnvelopeSuccess) IsKnown 

func (r CertificatePackEditResponseEnvelopeSuccess) IsKnown() bool

type CertificatePackEditResponseType 

type CertificatePackEditResponseType string

Type of certificate pack. 

const (
	CertificatePackEditResponseTypeAdvanced CertificatePackEditResponseType = "advanced"
)

func (CertificatePackEditResponseType) IsKnown 

func (r CertificatePackEditResponseType) IsKnown() bool

type CertificatePackEditResponseValidationMethod 

type CertificatePackEditResponseValidationMethod string

Validation Method selected for the order. 

const (
	CertificatePackEditResponseValidationMethodTXT   CertificatePackEditResponseValidationMethod = "txt"
	CertificatePackEditResponseValidationMethodHTTP  CertificatePackEditResponseValidationMethod = "http"
	CertificatePackEditResponseValidationMethodEmail CertificatePackEditResponseValidationMethod = "email"
)

func (CertificatePackEditResponseValidationMethod) IsKnown 

func (r CertificatePackEditResponseValidationMethod) IsKnown() bool

type CertificatePackEditResponseValidityDays 

type CertificatePackEditResponseValidityDays int64

Validity Days selected for the order. 

const (
	CertificatePackEditResponseValidityDays14  CertificatePackEditResponseValidityDays = 14
	CertificatePackEditResponseValidityDays30  CertificatePackEditResponseValidityDays = 30
	CertificatePackEditResponseValidityDays90  CertificatePackEditResponseValidityDays = 90
	CertificatePackEditResponseValidityDays365 CertificatePackEditResponseValidityDays = 365
)

func (CertificatePackEditResponseValidityDays) IsKnown 

func (r CertificatePackEditResponseValidityDays) IsKnown() bool

type CertificatePackGetParams 

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

type CertificatePackGetResponse 

type CertificatePackGetResponse = interface{}

type CertificatePackGetResponseEnvelope 

type CertificatePackGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success CertificatePackGetResponseEnvelopeSuccess `json:"success,required"`
	Result  CertificatePackGetResponse                `json:"result"`
	JSON    certificatePackGetResponseEnvelopeJSON    `json:"-"`
}

func (*CertificatePackGetResponseEnvelope) UnmarshalJSON 

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

type CertificatePackGetResponseEnvelopeSuccess 

type CertificatePackGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackGetResponseEnvelopeSuccessTrue CertificatePackGetResponseEnvelopeSuccess = true
)

func (CertificatePackGetResponseEnvelopeSuccess) IsKnown 

func (r CertificatePackGetResponseEnvelopeSuccess) IsKnown() bool

type CertificatePackListParams 

type CertificatePackListParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Include Certificate Packs of all statuses, not just active ones.
	Status param.Field[CertificatePackListParamsStatus] `query:"status"`
}

func (CertificatePackListParams) URLQuery 

func (r CertificatePackListParams) URLQuery() (v url.Values)

URLQuery serializes CertificatePackListParams's query parameters as `url.Values`.

type CertificatePackListParamsStatus 

type CertificatePackListParamsStatus string

Include Certificate Packs of all statuses, not just active ones. 

const (
	CertificatePackListParamsStatusAll CertificatePackListParamsStatus = "all"
)

func (CertificatePackListParamsStatus) IsKnown 

func (r CertificatePackListParamsStatus) IsKnown() bool

type CertificatePackListResponse 

type CertificatePackListResponse = interface{}

type CertificatePackNewParams 

type CertificatePackNewParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Certificate Authority selected for the order. For information on any certificate
	// authority specific details or restrictions
	// [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)
	CertificateAuthority param.Field[CertificatePackNewParamsCertificateAuthority] `json:"certificate_authority,required"`
	// Comma separated list of valid host names for the certificate packs. Must contain
	// the zone apex, may not contain more than 50 hosts, and may not be empty.
	Hosts param.Field[[]HostParam] `json:"hosts,required"`
	// Type of certificate pack.
	Type param.Field[CertificatePackNewParamsType] `json:"type,required"`
	// Validation Method selected for the order.
	ValidationMethod param.Field[CertificatePackNewParamsValidationMethod] `json:"validation_method,required"`
	// Validity Days selected for the order.
	ValidityDays param.Field[CertificatePackNewParamsValidityDays] `json:"validity_days,required"`
	// Whether or not to add Cloudflare Branding for the order. This will add a
	// subdomain of sni.cloudflaressl.com as the Common Name if set to true.
	CloudflareBranding param.Field[bool] `json:"cloudflare_branding"`
}

func (CertificatePackNewParams) MarshalJSON 

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

type CertificatePackNewParamsCertificateAuthority 

type CertificatePackNewParamsCertificateAuthority string

Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities) 

const (
	CertificatePackNewParamsCertificateAuthorityGoogle      CertificatePackNewParamsCertificateAuthority = "google"
	CertificatePackNewParamsCertificateAuthorityLetsEncrypt CertificatePackNewParamsCertificateAuthority = "lets_encrypt"
	CertificatePackNewParamsCertificateAuthoritySSLCom      CertificatePackNewParamsCertificateAuthority = "ssl_com"
)

func (CertificatePackNewParamsCertificateAuthority) IsKnown 

func (r CertificatePackNewParamsCertificateAuthority) IsKnown() bool

type CertificatePackNewParamsType 

type CertificatePackNewParamsType string

Type of certificate pack. 

const (
	CertificatePackNewParamsTypeAdvanced CertificatePackNewParamsType = "advanced"
)

func (CertificatePackNewParamsType) IsKnown 

func (r CertificatePackNewParamsType) IsKnown() bool

type CertificatePackNewParamsValidationMethod 

type CertificatePackNewParamsValidationMethod string

Validation Method selected for the order. 

const (
	CertificatePackNewParamsValidationMethodTXT   CertificatePackNewParamsValidationMethod = "txt"
	CertificatePackNewParamsValidationMethodHTTP  CertificatePackNewParamsValidationMethod = "http"
	CertificatePackNewParamsValidationMethodEmail CertificatePackNewParamsValidationMethod = "email"
)

func (CertificatePackNewParamsValidationMethod) IsKnown 

func (r CertificatePackNewParamsValidationMethod) IsKnown() bool

type CertificatePackNewParamsValidityDays 

type CertificatePackNewParamsValidityDays int64

Validity Days selected for the order. 

const (
	CertificatePackNewParamsValidityDays14  CertificatePackNewParamsValidityDays = 14
	CertificatePackNewParamsValidityDays30  CertificatePackNewParamsValidityDays = 30
	CertificatePackNewParamsValidityDays90  CertificatePackNewParamsValidityDays = 90
	CertificatePackNewParamsValidityDays365 CertificatePackNewParamsValidityDays = 365
)

func (CertificatePackNewParamsValidityDays) IsKnown 

func (r CertificatePackNewParamsValidityDays) IsKnown() bool

type CertificatePackNewResponse 

type CertificatePackNewResponse struct {
	// Identifier
	ID string `json:"id"`
	// Certificate Authority selected for the order. For information on any certificate
	// authority specific details or restrictions
	// [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)
	CertificateAuthority CertificatePackNewResponseCertificateAuthority `json:"certificate_authority"`
	// Whether or not to add Cloudflare Branding for the order. This will add a
	// subdomain of sni.cloudflaressl.com as the Common Name if set to true.
	CloudflareBranding bool `json:"cloudflare_branding"`
	// Comma separated list of valid host names for the certificate packs. Must contain
	// the zone apex, may not contain more than 50 hosts, and may not be empty.
	Hosts []Host `json:"hosts"`
	// Status of certificate pack.
	Status Status `json:"status"`
	// Type of certificate pack.
	Type CertificatePackNewResponseType `json:"type"`
	// Validation Method selected for the order.
	ValidationMethod CertificatePackNewResponseValidationMethod `json:"validation_method"`
	// Validity Days selected for the order.
	ValidityDays CertificatePackNewResponseValidityDays `json:"validity_days"`
	JSON         certificatePackNewResponseJSON         `json:"-"`
}

func (*CertificatePackNewResponse) UnmarshalJSON 

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

type CertificatePackNewResponseCertificateAuthority 

type CertificatePackNewResponseCertificateAuthority string

Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities) 

const (
	CertificatePackNewResponseCertificateAuthorityGoogle      CertificatePackNewResponseCertificateAuthority = "google"
	CertificatePackNewResponseCertificateAuthorityLetsEncrypt CertificatePackNewResponseCertificateAuthority = "lets_encrypt"
	CertificatePackNewResponseCertificateAuthoritySSLCom      CertificatePackNewResponseCertificateAuthority = "ssl_com"
)

func (CertificatePackNewResponseCertificateAuthority) IsKnown 

func (r CertificatePackNewResponseCertificateAuthority) IsKnown() bool

type CertificatePackNewResponseEnvelope 

type CertificatePackNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success CertificatePackNewResponseEnvelopeSuccess `json:"success,required"`
	Result  CertificatePackNewResponse                `json:"result"`
	JSON    certificatePackNewResponseEnvelopeJSON    `json:"-"`
}

func (*CertificatePackNewResponseEnvelope) UnmarshalJSON 

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

type CertificatePackNewResponseEnvelopeSuccess 

type CertificatePackNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackNewResponseEnvelopeSuccessTrue CertificatePackNewResponseEnvelopeSuccess = true
)

func (CertificatePackNewResponseEnvelopeSuccess) IsKnown 

func (r CertificatePackNewResponseEnvelopeSuccess) IsKnown() bool

type CertificatePackNewResponseType 

type CertificatePackNewResponseType string

Type of certificate pack. 

const (
	CertificatePackNewResponseTypeAdvanced CertificatePackNewResponseType = "advanced"
)

func (CertificatePackNewResponseType) IsKnown 

func (r CertificatePackNewResponseType) IsKnown() bool

type CertificatePackNewResponseValidationMethod 

type CertificatePackNewResponseValidationMethod string

Validation Method selected for the order. 

const (
	CertificatePackNewResponseValidationMethodTXT   CertificatePackNewResponseValidationMethod = "txt"
	CertificatePackNewResponseValidationMethodHTTP  CertificatePackNewResponseValidationMethod = "http"
	CertificatePackNewResponseValidationMethodEmail CertificatePackNewResponseValidationMethod = "email"
)

func (CertificatePackNewResponseValidationMethod) IsKnown 

func (r CertificatePackNewResponseValidationMethod) IsKnown() bool

type CertificatePackNewResponseValidityDays 

type CertificatePackNewResponseValidityDays int64

Validity Days selected for the order. 

const (
	CertificatePackNewResponseValidityDays14  CertificatePackNewResponseValidityDays = 14
	CertificatePackNewResponseValidityDays30  CertificatePackNewResponseValidityDays = 30
	CertificatePackNewResponseValidityDays90  CertificatePackNewResponseValidityDays = 90
	CertificatePackNewResponseValidityDays365 CertificatePackNewResponseValidityDays = 365
)

func (CertificatePackNewResponseValidityDays) IsKnown 

func (r CertificatePackNewResponseValidityDays) IsKnown() bool

type CertificatePackQuotaGetParams 

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

type CertificatePackQuotaGetResponse 

type CertificatePackQuotaGetResponse struct {
	Advanced CertificatePackQuotaGetResponseAdvanced `json:"advanced"`
	JSON     certificatePackQuotaGetResponseJSON     `json:"-"`
}

func (*CertificatePackQuotaGetResponse) UnmarshalJSON 

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

type CertificatePackQuotaGetResponseAdvanced 

type CertificatePackQuotaGetResponseAdvanced struct {
	// Quantity Allocated.
	Allocated int64 `json:"allocated"`
	// Quantity Used.
	Used int64                                       `json:"used"`
	JSON certificatePackQuotaGetResponseAdvancedJSON `json:"-"`
}

func (*CertificatePackQuotaGetResponseAdvanced) UnmarshalJSON 

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

type CertificatePackQuotaGetResponseEnvelope 

type CertificatePackQuotaGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success CertificatePackQuotaGetResponseEnvelopeSuccess `json:"success,required"`
	Result  CertificatePackQuotaGetResponse                `json:"result"`
	JSON    certificatePackQuotaGetResponseEnvelopeJSON    `json:"-"`
}

func (*CertificatePackQuotaGetResponseEnvelope) UnmarshalJSON 

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

type CertificatePackQuotaGetResponseEnvelopeSuccess 

type CertificatePackQuotaGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackQuotaGetResponseEnvelopeSuccessTrue CertificatePackQuotaGetResponseEnvelopeSuccess = true
)

func (CertificatePackQuotaGetResponseEnvelopeSuccess) IsKnown 

func (r CertificatePackQuotaGetResponseEnvelopeSuccess) IsKnown() bool

type CertificatePackQuotaService 

type CertificatePackQuotaService struct {
	Options []option.RequestOption
}

CertificatePackQuotaService 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 NewCertificatePackQuotaService method instead.

func NewCertificatePackQuotaService 

func NewCertificatePackQuotaService(opts ...option.RequestOption) (r *CertificatePackQuotaService)

NewCertificatePackQuotaService 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 (*CertificatePackQuotaService) Get 

func (r *CertificatePackQuotaService) Get(ctx context.Context, query CertificatePackQuotaGetParams, opts ...option.RequestOption) (res *CertificatePackQuotaGetResponse, err error)

For a given zone, list certificate pack quotas.

type CertificatePackService 

type CertificatePackService struct {
	Options []option.RequestOption
	Quota   *CertificatePackQuotaService
}

CertificatePackService 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 NewCertificatePackService method instead.

func NewCertificatePackService 

func NewCertificatePackService(opts ...option.RequestOption) (r *CertificatePackService)

NewCertificatePackService 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 (*CertificatePackService) Delete 

func (r *CertificatePackService) Delete(ctx context.Context, certificatePackID string, body CertificatePackDeleteParams, opts ...option.RequestOption) (res *CertificatePackDeleteResponse, err error)

For a given zone, delete an advanced certificate pack.

func (*CertificatePackService) Edit 

func (r *CertificatePackService) Edit(ctx context.Context, certificatePackID string, params CertificatePackEditParams, opts ...option.RequestOption) (res *CertificatePackEditResponse, err error)

For a given zone, restart validation or add cloudflare branding for an advanced certificate pack. The former is only a validation operation for a Certificate Pack in a validation_timed_out status.

func (*CertificatePackService) Get 

func (r *CertificatePackService) Get(ctx context.Context, certificatePackID string, query CertificatePackGetParams, opts ...option.RequestOption) (res *CertificatePackGetResponse, err error)

For a given zone, get a certificate pack.

func (*CertificatePackService) List 

func (r *CertificatePackService) List(ctx context.Context, params CertificatePackListParams, opts ...option.RequestOption) (res *pagination.SinglePage[CertificatePackListResponse], err error)

For a given zone, list all active certificate packs.

func (*CertificatePackService) ListAutoPaging 

func (r *CertificatePackService) ListAutoPaging(ctx context.Context, params CertificatePackListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[CertificatePackListResponse]

For a given zone, list all active certificate packs.

func (*CertificatePackService) New 

func (r *CertificatePackService) New(ctx context.Context, params CertificatePackNewParams, opts ...option.RequestOption) (res *CertificatePackNewResponse, err error)

For a given zone, order an advanced certificate pack.

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 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 Host 

type Host = string

type HostParam 

type HostParam = string

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 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 RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type RecommendationGetResponse 

type RecommendationGetResponse struct {
	// Identifier of a recommedation result.
	ID         string                         `json:"id"`
	ModifiedOn time.Time                      `json:"modified_on" format:"date-time"`
	Value      RecommendationGetResponseValue `json:"value"`
	JSON       recommendationGetResponseJSON  `json:"-"`
}

func (*RecommendationGetResponse) UnmarshalJSON 

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

type RecommendationGetResponseEnvelope 

type RecommendationGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo     `json:"errors,required"`
	Messages []shared.ResponseInfo     `json:"messages,required"`
	Result   RecommendationGetResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success RecommendationGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    recommendationGetResponseEnvelopeJSON    `json:"-"`
}

func (*RecommendationGetResponseEnvelope) UnmarshalJSON 

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

type RecommendationGetResponseEnvelopeSuccess 

type RecommendationGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RecommendationGetResponseEnvelopeSuccessTrue RecommendationGetResponseEnvelopeSuccess = true
)

func (RecommendationGetResponseEnvelopeSuccess) IsKnown 

func (r RecommendationGetResponseEnvelopeSuccess) IsKnown() bool

type RecommendationGetResponseValue 

type RecommendationGetResponseValue string
const (
	RecommendationGetResponseValueFlexible RecommendationGetResponseValue = "flexible"
	RecommendationGetResponseValueFull     RecommendationGetResponseValue = "full"
	RecommendationGetResponseValueStrict   RecommendationGetResponseValue = "strict"
)

func (RecommendationGetResponseValue) IsKnown 

func (r RecommendationGetResponseValue) IsKnown() bool

type RecommendationService 

type RecommendationService struct {
	Options []option.RequestOption
}

RecommendationService 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 NewRecommendationService method instead.

func NewRecommendationService 

func NewRecommendationService(opts ...option.RequestOption) (r *RecommendationService)

NewRecommendationService 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 (*RecommendationService) Get 

func (r *RecommendationService) Get(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *RecommendationGetResponse, err error)

Retrieve the SSL/TLS Recommender's recommendation for a zone.

type RequestValidity 

type RequestValidity float64

The number of days for which the certificate should be valid. 

const (
	RequestValidity7    RequestValidity = 7
	RequestValidity30   RequestValidity = 30
	RequestValidity90   RequestValidity = 90
	RequestValidity365  RequestValidity = 365
	RequestValidity730  RequestValidity = 730
	RequestValidity1095 RequestValidity = 1095
	RequestValidity5475 RequestValidity = 5475
)

func (RequestValidity) IsKnown 

func (r RequestValidity) IsKnown() bool

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

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 SSLService 

type SSLService struct {
	Options          []option.RequestOption
	Analyze          *AnalyzeService
	CertificatePacks *CertificatePackService
	Recommendations  *RecommendationService
	Universal        *UniversalService
	Verification     *VerificationService
}

SSLService 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 NewSSLService method instead.

func NewSSLService 

func NewSSLService(opts ...option.RequestOption) (r *SSLService)

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

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Status 

type Status string

Status of certificate pack. 

const (
	StatusInitializing         Status = "initializing"
	StatusPendingValidation    Status = "pending_validation"
	StatusDeleted              Status = "deleted"
	StatusPendingIssuance      Status = "pending_issuance"
	StatusPendingDeployment    Status = "pending_deployment"
	StatusPendingDeletion      Status = "pending_deletion"
	StatusPendingExpiration    Status = "pending_expiration"
	StatusExpired              Status = "expired"
	StatusActive               Status = "active"
	StatusInitializingTimedOut Status = "initializing_timed_out"
	StatusValidationTimedOut   Status = "validation_timed_out"
	StatusIssuanceTimedOut     Status = "issuance_timed_out"
	StatusDeploymentTimedOut   Status = "deployment_timed_out"
	StatusDeletionTimedOut     Status = "deletion_timed_out"
	StatusPendingCleanup       Status = "pending_cleanup"
	StatusStagingDeployment    Status = "staging_deployment"
	StatusStagingActive        Status = "staging_active"
	StatusDeactivating         Status = "deactivating"
	StatusInactive             Status = "inactive"
	StatusBackupIssued         Status = "backup_issued"
	StatusHoldingDeployment    Status = "holding_deployment"
)

func (Status) IsKnown 

func (r Status) IsKnown() bool

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 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 UniversalSSLSettings 

type UniversalSSLSettings struct {
	// Disabling Universal SSL removes any currently active Universal SSL certificates
	// for your zone from the edge and prevents any future Universal SSL certificates
	// from being ordered. If there are no advanced certificates or custom certificates
	// uploaded for the domain, visitors will be unable to access the domain over
	// HTTPS.
	//
	// By disabling Universal SSL, you understand that the following Cloudflare
	// settings and preferences will result in visitors being unable to visit your
	// domain unless you have uploaded a custom certificate or purchased an advanced
	// certificate.
	//
	// - HSTS
	// - Always Use HTTPS
	// - Opportunistic Encryption
	// - Onion Routing
	// - Any Page Rules redirecting traffic to HTTPS
	//
	// Similarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy
	// is enabled will result in users being unable to visit your site without a valid
	// certificate at Cloudflare's edge.
	//
	// If you do not have a valid custom or advanced certificate at Cloudflare's edge
	// and are unsure if any of the above Cloudflare settings are enabled, or if any
	// HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for
	// your domain.
	Enabled bool                     `json:"enabled"`
	JSON    universalSSLSettingsJSON `json:"-"`
}

func (*UniversalSSLSettings) UnmarshalJSON 

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

type UniversalSSLSettingsParam 

type UniversalSSLSettingsParam struct {
	// Disabling Universal SSL removes any currently active Universal SSL certificates
	// for your zone from the edge and prevents any future Universal SSL certificates
	// from being ordered. If there are no advanced certificates or custom certificates
	// uploaded for the domain, visitors will be unable to access the domain over
	// HTTPS.
	//
	// By disabling Universal SSL, you understand that the following Cloudflare
	// settings and preferences will result in visitors being unable to visit your
	// domain unless you have uploaded a custom certificate or purchased an advanced
	// certificate.
	//
	// - HSTS
	// - Always Use HTTPS
	// - Opportunistic Encryption
	// - Onion Routing
	// - Any Page Rules redirecting traffic to HTTPS
	//
	// Similarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy
	// is enabled will result in users being unable to visit your site without a valid
	// certificate at Cloudflare's edge.
	//
	// If you do not have a valid custom or advanced certificate at Cloudflare's edge
	// and are unsure if any of the above Cloudflare settings are enabled, or if any
	// HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for
	// your domain.
	Enabled param.Field[bool] `json:"enabled"`
}

func (UniversalSSLSettingsParam) MarshalJSON 

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

type UniversalService 

type UniversalService struct {
	Options  []option.RequestOption
	Settings *UniversalSettingService
}

UniversalService 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 NewUniversalService method instead.

func NewUniversalService 

func NewUniversalService(opts ...option.RequestOption) (r *UniversalService)

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

type UniversalSettingEditParams 

type UniversalSettingEditParams struct {
	// Identifier
	ZoneID               param.Field[string]       `path:"zone_id,required"`
	UniversalSSLSettings UniversalSSLSettingsParam `json:"universal_ssl_settings,required"`
}

func (UniversalSettingEditParams) MarshalJSON 

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

type UniversalSettingEditResponseEnvelope 

type UniversalSettingEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success UniversalSettingEditResponseEnvelopeSuccess `json:"success,required"`
	Result  UniversalSSLSettings                        `json:"result"`
	JSON    universalSettingEditResponseEnvelopeJSON    `json:"-"`
}

func (*UniversalSettingEditResponseEnvelope) UnmarshalJSON 

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

type UniversalSettingEditResponseEnvelopeSuccess 

type UniversalSettingEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	UniversalSettingEditResponseEnvelopeSuccessTrue UniversalSettingEditResponseEnvelopeSuccess = true
)

func (UniversalSettingEditResponseEnvelopeSuccess) IsKnown 

func (r UniversalSettingEditResponseEnvelopeSuccess) IsKnown() bool

type UniversalSettingGetParams 

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

type UniversalSettingGetResponseEnvelope 

type UniversalSettingGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success UniversalSettingGetResponseEnvelopeSuccess `json:"success,required"`
	Result  UniversalSSLSettings                       `json:"result"`
	JSON    universalSettingGetResponseEnvelopeJSON    `json:"-"`
}

func (*UniversalSettingGetResponseEnvelope) UnmarshalJSON 

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

type UniversalSettingGetResponseEnvelopeSuccess 

type UniversalSettingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	UniversalSettingGetResponseEnvelopeSuccessTrue UniversalSettingGetResponseEnvelopeSuccess = true
)

func (UniversalSettingGetResponseEnvelopeSuccess) IsKnown 

func (r UniversalSettingGetResponseEnvelopeSuccess) IsKnown() bool

type UniversalSettingService 

type UniversalSettingService struct {
	Options []option.RequestOption
}

UniversalSettingService 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 NewUniversalSettingService method instead.

func NewUniversalSettingService 

func NewUniversalSettingService(opts ...option.RequestOption) (r *UniversalSettingService)

NewUniversalSettingService 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 (*UniversalSettingService) Edit 

func (r *UniversalSettingService) Edit(ctx context.Context, params UniversalSettingEditParams, opts ...option.RequestOption) (res *UniversalSSLSettings, err error)

Patch Universal SSL Settings for a Zone.

func (*UniversalSettingService) Get 

func (r *UniversalSettingService) Get(ctx context.Context, query UniversalSettingGetParams, opts ...option.RequestOption) (res *UniversalSSLSettings, err error)

Get Universal SSL Settings for a Zone.

type ValidationMethod 

type ValidationMethod string

Validation method in use for a certificate pack order. 

const (
	ValidationMethodHTTP  ValidationMethod = "http"
	ValidationMethodCNAME ValidationMethod = "cname"
	ValidationMethodTXT   ValidationMethod = "txt"
)

func (ValidationMethod) IsKnown 

func (r ValidationMethod) IsKnown() bool

type Verification 

type Verification struct {
	// Current status of certificate.
	CertificateStatus VerificationCertificateStatus `json:"certificate_status,required"`
	// Certificate Authority is manually reviewing the order.
	BrandCheck bool `json:"brand_check"`
	// Certificate Pack UUID.
	CERTPackUUID string `json:"cert_pack_uuid"`
	// Certificate's signature algorithm.
	Signature VerificationSignature `json:"signature"`
	// Validation method in use for a certificate pack order.
	ValidationMethod ValidationMethod `json:"validation_method"`
	// Certificate's required verification information.
	VerificationInfo VerificationVerificationInfo `json:"verification_info"`
	// Status of the required verification information, omitted if verification status
	// is unknown.
	VerificationStatus bool `json:"verification_status"`
	// Method of verification.
	VerificationType VerificationVerificationType `json:"verification_type"`
	JSON             verificationJSON             `json:"-"`
}

func (*Verification) UnmarshalJSON 

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

type VerificationCertificateStatus 

type VerificationCertificateStatus string

Current status of certificate. 

const (
	VerificationCertificateStatusInitializing      VerificationCertificateStatus = "initializing"
	VerificationCertificateStatusAuthorizing       VerificationCertificateStatus = "authorizing"
	VerificationCertificateStatusActive            VerificationCertificateStatus = "active"
	VerificationCertificateStatusExpired           VerificationCertificateStatus = "expired"
	VerificationCertificateStatusIssuing           VerificationCertificateStatus = "issuing"
	VerificationCertificateStatusTimingOut         VerificationCertificateStatus = "timing_out"
	VerificationCertificateStatusPendingDeployment VerificationCertificateStatus = "pending_deployment"
)

func (VerificationCertificateStatus) IsKnown 

func (r VerificationCertificateStatus) IsKnown() bool

type VerificationEditParams 

type VerificationEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Desired validation method.
	ValidationMethod param.Field[VerificationEditParamsValidationMethod] `json:"validation_method,required"`
}

func (VerificationEditParams) MarshalJSON 

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

type VerificationEditParamsValidationMethod 

type VerificationEditParamsValidationMethod string

Desired validation method. 

const (
	VerificationEditParamsValidationMethodHTTP  VerificationEditParamsValidationMethod = "http"
	VerificationEditParamsValidationMethodCNAME VerificationEditParamsValidationMethod = "cname"
	VerificationEditParamsValidationMethodTXT   VerificationEditParamsValidationMethod = "txt"
	VerificationEditParamsValidationMethodEmail VerificationEditParamsValidationMethod = "email"
)

func (VerificationEditParamsValidationMethod) IsKnown 

func (r VerificationEditParamsValidationMethod) IsKnown() bool

type VerificationEditResponse 

type VerificationEditResponse struct {
	// Result status.
	Status string `json:"status"`
	// Desired validation method.
	ValidationMethod VerificationEditResponseValidationMethod `json:"validation_method"`
	JSON             verificationEditResponseJSON             `json:"-"`
}

func (*VerificationEditResponse) UnmarshalJSON 

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

type VerificationEditResponseEnvelope 

type VerificationEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success VerificationEditResponseEnvelopeSuccess `json:"success,required"`
	Result  VerificationEditResponse                `json:"result"`
	JSON    verificationEditResponseEnvelopeJSON    `json:"-"`
}

func (*VerificationEditResponseEnvelope) UnmarshalJSON 

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

type VerificationEditResponseEnvelopeSuccess 

type VerificationEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	VerificationEditResponseEnvelopeSuccessTrue VerificationEditResponseEnvelopeSuccess = true
)

func (VerificationEditResponseEnvelopeSuccess) IsKnown 

func (r VerificationEditResponseEnvelopeSuccess) IsKnown() bool

type VerificationEditResponseValidationMethod 

type VerificationEditResponseValidationMethod string

Desired validation method. 

const (
	VerificationEditResponseValidationMethodHTTP  VerificationEditResponseValidationMethod = "http"
	VerificationEditResponseValidationMethodCNAME VerificationEditResponseValidationMethod = "cname"
	VerificationEditResponseValidationMethodTXT   VerificationEditResponseValidationMethod = "txt"
	VerificationEditResponseValidationMethodEmail VerificationEditResponseValidationMethod = "email"
)

func (VerificationEditResponseValidationMethod) IsKnown 

func (r VerificationEditResponseValidationMethod) IsKnown() bool

type VerificationGetParams 

type VerificationGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Immediately retry SSL Verification.
	Retry param.Field[VerificationGetParamsRetry] `query:"retry"`
}

func (VerificationGetParams) URLQuery 

func (r VerificationGetParams) URLQuery() (v url.Values)

URLQuery serializes VerificationGetParams's query parameters as `url.Values`.

type VerificationGetParamsRetry 

type VerificationGetParamsRetry bool

Immediately retry SSL Verification. 

const (
	VerificationGetParamsRetryTrue VerificationGetParamsRetry = true
)

func (VerificationGetParamsRetry) IsKnown 

func (r VerificationGetParamsRetry) IsKnown() bool

type VerificationGetResponseEnvelope 

type VerificationGetResponseEnvelope struct {
	Result []Verification                      `json:"result"`
	JSON   verificationGetResponseEnvelopeJSON `json:"-"`
}

func (*VerificationGetResponseEnvelope) UnmarshalJSON 

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

type VerificationService 

type VerificationService struct {
	Options []option.RequestOption
}

VerificationService 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 NewVerificationService method instead.

func NewVerificationService 

func NewVerificationService(opts ...option.RequestOption) (r *VerificationService)

NewVerificationService 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 (*VerificationService) Edit 

func (r *VerificationService) Edit(ctx context.Context, certificatePackID string, params VerificationEditParams, opts ...option.RequestOption) (res *VerificationEditResponse, err error)

Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method.

func (*VerificationService) Get 

func (r *VerificationService) Get(ctx context.Context, params VerificationGetParams, opts ...option.RequestOption) (res *[]Verification, err error)

Get SSL Verification Info for a Zone.

type VerificationSignature 

type VerificationSignature string

Certificate's signature algorithm. 

const (
	VerificationSignatureEcdsaWithSha256 VerificationSignature = "ECDSAWithSHA256"
	VerificationSignatureSha1WithRSA     VerificationSignature = "SHA1WithRSA"
	VerificationSignatureSha256WithRSA   VerificationSignature = "SHA256WithRSA"
)

func (VerificationSignature) IsKnown 

func (r VerificationSignature) IsKnown() bool

type VerificationVerificationInfo 

type VerificationVerificationInfo struct {
	// Name of CNAME record.
	RecordName VerificationVerificationInfoRecordName `json:"record_name"`
	// Target of CNAME record.
	RecordTarget VerificationVerificationInfoRecordTarget `json:"record_target"`
	JSON         verificationVerificationInfoJSON         `json:"-"`
}

Certificate's required verification information.

func (*VerificationVerificationInfo) UnmarshalJSON 

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

type VerificationVerificationInfoRecordName 

type VerificationVerificationInfoRecordName string

Name of CNAME record. 

const (
	VerificationVerificationInfoRecordNameRecordName VerificationVerificationInfoRecordName = "record_name"
	VerificationVerificationInfoRecordNameHTTPURL    VerificationVerificationInfoRecordName = "http_url"
	VerificationVerificationInfoRecordNameCNAME      VerificationVerificationInfoRecordName = "cname"
	VerificationVerificationInfoRecordNameTXTName    VerificationVerificationInfoRecordName = "txt_name"
)

func (VerificationVerificationInfoRecordName) IsKnown 

func (r VerificationVerificationInfoRecordName) IsKnown() bool

type VerificationVerificationInfoRecordTarget 

type VerificationVerificationInfoRecordTarget string

Target of CNAME record. 

const (
	VerificationVerificationInfoRecordTargetRecordValue VerificationVerificationInfoRecordTarget = "record_value"
	VerificationVerificationInfoRecordTargetHTTPBody    VerificationVerificationInfoRecordTarget = "http_body"
	VerificationVerificationInfoRecordTargetCNAMETarget VerificationVerificationInfoRecordTarget = "cname_target"
	VerificationVerificationInfoRecordTargetTXTValue    VerificationVerificationInfoRecordTarget = "txt_value"
)

func (VerificationVerificationInfoRecordTarget) IsKnown 

func (r VerificationVerificationInfoRecordTarget) IsKnown() bool

type VerificationVerificationType 

type VerificationVerificationType string

Method of verification. 

const (
	VerificationVerificationTypeCNAME   VerificationVerificationType = "cname"
	VerificationVerificationTypeMetaTag VerificationVerificationType = "meta tag"
)

func (VerificationVerificationType) IsKnown 

func (r VerificationVerificationType) IsKnown() bool

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.