ssl

package
v2.1.0 Latest Latest
Warning

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

Go to latest
Published: Apr 24, 2024 License: Apache-2.0 Imports: 16 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 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.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN added in v2.1.0

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0

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 AnalyzeNewResponseEnvelope

type AnalyzeNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo   `json:"errors,required"`
	Messages []shared.ResponseInfo   `json:"messages,required"`
	Result   AnalyzeNewResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success AnalyzeNewResponseEnvelopeSuccess `json:"success,required"`
	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

type AnalyzeNewResponseUnion

type AnalyzeNewResponseUnion interface {
	ImplementsSSLAnalyzeNewResponseUnion()
}

Union satisfied by ssl.AnalyzeNewResponseUnknown or shared.UnionString.

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

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 CertificatePackDeleteParams

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

func (CertificatePackDeleteParams) MarshalJSON

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

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"`
	Result   CertificatePackDeleteResponse `json:"result,required"`
	// Whether the API call was successful
	Success CertificatePackDeleteResponseEnvelopeSuccess `json:"success,required"`
	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

type CertificatePackEditParams

type CertificatePackEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	Body   interface{}         `json:"body,required"`
}

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
	// sni.cloudflaressl.com as the Common Name if set 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 CertificatePackEditResponseStatus `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"
)

func (CertificatePackEditResponseCertificateAuthority) IsKnown

type CertificatePackEditResponseEnvelope

type CertificatePackEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo       `json:"errors,required"`
	Messages []shared.ResponseInfo       `json:"messages,required"`
	Result   CertificatePackEditResponse `json:"result,required"`
	// Whether the API call was successful
	Success CertificatePackEditResponseEnvelopeSuccess `json:"success,required"`
	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

type CertificatePackEditResponseStatus

type CertificatePackEditResponseStatus string

Status of certificate pack.

const (
	CertificatePackEditResponseStatusInitializing         CertificatePackEditResponseStatus = "initializing"
	CertificatePackEditResponseStatusPendingValidation    CertificatePackEditResponseStatus = "pending_validation"
	CertificatePackEditResponseStatusDeleted              CertificatePackEditResponseStatus = "deleted"
	CertificatePackEditResponseStatusPendingIssuance      CertificatePackEditResponseStatus = "pending_issuance"
	CertificatePackEditResponseStatusPendingDeployment    CertificatePackEditResponseStatus = "pending_deployment"
	CertificatePackEditResponseStatusPendingDeletion      CertificatePackEditResponseStatus = "pending_deletion"
	CertificatePackEditResponseStatusPendingExpiration    CertificatePackEditResponseStatus = "pending_expiration"
	CertificatePackEditResponseStatusExpired              CertificatePackEditResponseStatus = "expired"
	CertificatePackEditResponseStatusActive               CertificatePackEditResponseStatus = "active"
	CertificatePackEditResponseStatusInitializingTimedOut CertificatePackEditResponseStatus = "initializing_timed_out"
	CertificatePackEditResponseStatusValidationTimedOut   CertificatePackEditResponseStatus = "validation_timed_out"
	CertificatePackEditResponseStatusIssuanceTimedOut     CertificatePackEditResponseStatus = "issuance_timed_out"
	CertificatePackEditResponseStatusDeploymentTimedOut   CertificatePackEditResponseStatus = "deployment_timed_out"
	CertificatePackEditResponseStatusDeletionTimedOut     CertificatePackEditResponseStatus = "deletion_timed_out"
	CertificatePackEditResponseStatusPendingCleanup       CertificatePackEditResponseStatus = "pending_cleanup"
	CertificatePackEditResponseStatusStagingDeployment    CertificatePackEditResponseStatus = "staging_deployment"
	CertificatePackEditResponseStatusStagingActive        CertificatePackEditResponseStatus = "staging_active"
	CertificatePackEditResponseStatusDeactivating         CertificatePackEditResponseStatus = "deactivating"
	CertificatePackEditResponseStatusInactive             CertificatePackEditResponseStatus = "inactive"
	CertificatePackEditResponseStatusBackupIssued         CertificatePackEditResponseStatus = "backup_issued"
	CertificatePackEditResponseStatusHoldingDeployment    CertificatePackEditResponseStatus = "holding_deployment"
)

func (CertificatePackEditResponseStatus) IsKnown

type CertificatePackEditResponseType

type CertificatePackEditResponseType string

Type of certificate pack.

const (
	CertificatePackEditResponseTypeAdvanced CertificatePackEditResponseType = "advanced"
)

func (CertificatePackEditResponseType) IsKnown

type CertificatePackEditResponseValidationMethod

type CertificatePackEditResponseValidationMethod string

Validation Method selected for the order.

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

func (CertificatePackEditResponseValidationMethod) IsKnown

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

type CertificatePackGetParams

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

type CertificatePackGetResponseEnvelope

type CertificatePackGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo           `json:"errors,required"`
	Messages []shared.ResponseInfo           `json:"messages,required"`
	Result   CertificatePackGetResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success CertificatePackGetResponseEnvelopeSuccess `json:"success,required"`
	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

type CertificatePackGetResponseUnion

type CertificatePackGetResponseUnion interface {
	ImplementsSSLCertificatePackGetResponseUnion()
}

Union satisfied by ssl.CertificatePackGetResponseUnknown or shared.UnionString.

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

type CertificatePackListResponse

type CertificatePackListResponse = interface{}

type CertificatePackOrderNewParams

type CertificatePackOrderNewParams 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[CertificatePackOrderNewParamsCertificateAuthority] `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[CertificatePackOrderNewParamsType] `json:"type,required"`
	// Validation Method selected for the order.
	ValidationMethod param.Field[CertificatePackOrderNewParamsValidationMethod] `json:"validation_method,required"`
	// Validity Days selected for the order.
	ValidityDays param.Field[CertificatePackOrderNewParamsValidityDays] `json:"validity_days,required"`
	// Whether or not to add Cloudflare Branding for the order. This will add
	// sni.cloudflaressl.com as the Common Name if set true.
	CloudflareBranding param.Field[bool] `json:"cloudflare_branding"`
}

func (CertificatePackOrderNewParams) MarshalJSON

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

type CertificatePackOrderNewParamsCertificateAuthority

type CertificatePackOrderNewParamsCertificateAuthority 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 (
	CertificatePackOrderNewParamsCertificateAuthorityGoogle      CertificatePackOrderNewParamsCertificateAuthority = "google"
	CertificatePackOrderNewParamsCertificateAuthorityLetsEncrypt CertificatePackOrderNewParamsCertificateAuthority = "lets_encrypt"
)

func (CertificatePackOrderNewParamsCertificateAuthority) IsKnown

type CertificatePackOrderNewParamsType

type CertificatePackOrderNewParamsType string

Type of certificate pack.

const (
	CertificatePackOrderNewParamsTypeAdvanced CertificatePackOrderNewParamsType = "advanced"
)

func (CertificatePackOrderNewParamsType) IsKnown

type CertificatePackOrderNewParamsValidationMethod

type CertificatePackOrderNewParamsValidationMethod string

Validation Method selected for the order.

const (
	CertificatePackOrderNewParamsValidationMethodTXT   CertificatePackOrderNewParamsValidationMethod = "txt"
	CertificatePackOrderNewParamsValidationMethodHTTP  CertificatePackOrderNewParamsValidationMethod = "http"
	CertificatePackOrderNewParamsValidationMethodEmail CertificatePackOrderNewParamsValidationMethod = "email"
)

func (CertificatePackOrderNewParamsValidationMethod) IsKnown

type CertificatePackOrderNewParamsValidityDays

type CertificatePackOrderNewParamsValidityDays int64

Validity Days selected for the order.

const (
	CertificatePackOrderNewParamsValidityDays14  CertificatePackOrderNewParamsValidityDays = 14
	CertificatePackOrderNewParamsValidityDays30  CertificatePackOrderNewParamsValidityDays = 30
	CertificatePackOrderNewParamsValidityDays90  CertificatePackOrderNewParamsValidityDays = 90
	CertificatePackOrderNewParamsValidityDays365 CertificatePackOrderNewParamsValidityDays = 365
)

func (CertificatePackOrderNewParamsValidityDays) IsKnown

type CertificatePackOrderNewResponse

type CertificatePackOrderNewResponse 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 CertificatePackOrderNewResponseCertificateAuthority `json:"certificate_authority"`
	// Whether or not to add Cloudflare Branding for the order. This will add
	// sni.cloudflaressl.com as the Common Name if set 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 CertificatePackOrderNewResponseStatus `json:"status"`
	// Type of certificate pack.
	Type CertificatePackOrderNewResponseType `json:"type"`
	// Validation Method selected for the order.
	ValidationMethod CertificatePackOrderNewResponseValidationMethod `json:"validation_method"`
	// Validity Days selected for the order.
	ValidityDays CertificatePackOrderNewResponseValidityDays `json:"validity_days"`
	JSON         certificatePackOrderNewResponseJSON         `json:"-"`
}

func (*CertificatePackOrderNewResponse) UnmarshalJSON

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

type CertificatePackOrderNewResponseCertificateAuthority

type CertificatePackOrderNewResponseCertificateAuthority 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 (
	CertificatePackOrderNewResponseCertificateAuthorityGoogle      CertificatePackOrderNewResponseCertificateAuthority = "google"
	CertificatePackOrderNewResponseCertificateAuthorityLetsEncrypt CertificatePackOrderNewResponseCertificateAuthority = "lets_encrypt"
)

func (CertificatePackOrderNewResponseCertificateAuthority) IsKnown

type CertificatePackOrderNewResponseEnvelope

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

func (*CertificatePackOrderNewResponseEnvelope) UnmarshalJSON

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

type CertificatePackOrderNewResponseEnvelopeSuccess

type CertificatePackOrderNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	CertificatePackOrderNewResponseEnvelopeSuccessTrue CertificatePackOrderNewResponseEnvelopeSuccess = true
)

func (CertificatePackOrderNewResponseEnvelopeSuccess) IsKnown

type CertificatePackOrderNewResponseStatus

type CertificatePackOrderNewResponseStatus string

Status of certificate pack.

const (
	CertificatePackOrderNewResponseStatusInitializing         CertificatePackOrderNewResponseStatus = "initializing"
	CertificatePackOrderNewResponseStatusPendingValidation    CertificatePackOrderNewResponseStatus = "pending_validation"
	CertificatePackOrderNewResponseStatusDeleted              CertificatePackOrderNewResponseStatus = "deleted"
	CertificatePackOrderNewResponseStatusPendingIssuance      CertificatePackOrderNewResponseStatus = "pending_issuance"
	CertificatePackOrderNewResponseStatusPendingDeployment    CertificatePackOrderNewResponseStatus = "pending_deployment"
	CertificatePackOrderNewResponseStatusPendingDeletion      CertificatePackOrderNewResponseStatus = "pending_deletion"
	CertificatePackOrderNewResponseStatusPendingExpiration    CertificatePackOrderNewResponseStatus = "pending_expiration"
	CertificatePackOrderNewResponseStatusExpired              CertificatePackOrderNewResponseStatus = "expired"
	CertificatePackOrderNewResponseStatusActive               CertificatePackOrderNewResponseStatus = "active"
	CertificatePackOrderNewResponseStatusInitializingTimedOut CertificatePackOrderNewResponseStatus = "initializing_timed_out"
	CertificatePackOrderNewResponseStatusValidationTimedOut   CertificatePackOrderNewResponseStatus = "validation_timed_out"
	CertificatePackOrderNewResponseStatusIssuanceTimedOut     CertificatePackOrderNewResponseStatus = "issuance_timed_out"
	CertificatePackOrderNewResponseStatusDeploymentTimedOut   CertificatePackOrderNewResponseStatus = "deployment_timed_out"
	CertificatePackOrderNewResponseStatusDeletionTimedOut     CertificatePackOrderNewResponseStatus = "deletion_timed_out"
	CertificatePackOrderNewResponseStatusPendingCleanup       CertificatePackOrderNewResponseStatus = "pending_cleanup"
	CertificatePackOrderNewResponseStatusStagingDeployment    CertificatePackOrderNewResponseStatus = "staging_deployment"
	CertificatePackOrderNewResponseStatusStagingActive        CertificatePackOrderNewResponseStatus = "staging_active"
	CertificatePackOrderNewResponseStatusDeactivating         CertificatePackOrderNewResponseStatus = "deactivating"
	CertificatePackOrderNewResponseStatusInactive             CertificatePackOrderNewResponseStatus = "inactive"
	CertificatePackOrderNewResponseStatusBackupIssued         CertificatePackOrderNewResponseStatus = "backup_issued"
	CertificatePackOrderNewResponseStatusHoldingDeployment    CertificatePackOrderNewResponseStatus = "holding_deployment"
)

func (CertificatePackOrderNewResponseStatus) IsKnown

type CertificatePackOrderNewResponseType

type CertificatePackOrderNewResponseType string

Type of certificate pack.

const (
	CertificatePackOrderNewResponseTypeAdvanced CertificatePackOrderNewResponseType = "advanced"
)

func (CertificatePackOrderNewResponseType) IsKnown

type CertificatePackOrderNewResponseValidationMethod

type CertificatePackOrderNewResponseValidationMethod string

Validation Method selected for the order.

const (
	CertificatePackOrderNewResponseValidationMethodTXT   CertificatePackOrderNewResponseValidationMethod = "txt"
	CertificatePackOrderNewResponseValidationMethodHTTP  CertificatePackOrderNewResponseValidationMethod = "http"
	CertificatePackOrderNewResponseValidationMethodEmail CertificatePackOrderNewResponseValidationMethod = "email"
)

func (CertificatePackOrderNewResponseValidationMethod) IsKnown

type CertificatePackOrderNewResponseValidityDays

type CertificatePackOrderNewResponseValidityDays int64

Validity Days selected for the order.

const (
	CertificatePackOrderNewResponseValidityDays14  CertificatePackOrderNewResponseValidityDays = 14
	CertificatePackOrderNewResponseValidityDays30  CertificatePackOrderNewResponseValidityDays = 30
	CertificatePackOrderNewResponseValidityDays90  CertificatePackOrderNewResponseValidityDays = 90
	CertificatePackOrderNewResponseValidityDays365 CertificatePackOrderNewResponseValidityDays = 365
)

func (CertificatePackOrderNewResponseValidityDays) IsKnown

type CertificatePackOrderService

type CertificatePackOrderService struct {
	Options []option.RequestOption
}

CertificatePackOrderService 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 NewCertificatePackOrderService method instead.

func NewCertificatePackOrderService

func NewCertificatePackOrderService(opts ...option.RequestOption) (r *CertificatePackOrderService)

NewCertificatePackOrderService 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 (*CertificatePackOrderService) New

For a given zone, order an advanced certificate pack.

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"`
	Result   CertificatePackQuotaGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success CertificatePackQuotaGetResponseEnvelopeSuccess `json:"success,required"`
	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

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

For a given zone, list certificate pack quotas.

type CertificatePackService

type CertificatePackService struct {
	Options []option.RequestOption
	Order   *CertificatePackOrderService
	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

For a given zone, delete an advanced certificate pack.

func (*CertificatePackService) Edit

For a given zone, restart validation for an advanced certificate pack. This is only a validation operation for a Certificate Pack in a validation_timed_out status.

func (*CertificatePackService) Get

For a given zone, get a certificate pack.

func (*CertificatePackService) List

For a given zone, list all active certificate packs.

func (*CertificatePackService) ListAutoPaging

For a given zone, list all active certificate packs.

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 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 added in v2.1.0

type Member = shared.Member

This is an alias to an internal type.

type MemberParam added in v2.1.0

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRole added in v2.1.0

type MemberRole = shared.MemberRole

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissions added in v2.1.0

type MemberRolesPermissions = shared.MemberRolesPermissions

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberUser added in v2.1.0

type MemberUser = shared.MemberUser

This is an alias to an internal type.

type MemberUserParam added in v2.1.0

type MemberUserParam = shared.MemberUserParam

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

type RecommendationGetResponseValue

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

func (RecommendationGetResponseValue) IsKnown

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 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 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 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"`
	Result   UniversalSSLSettings  `json:"result,required"`
	// Whether the API call was successful
	Success UniversalSettingEditResponseEnvelopeSuccess `json:"success,required"`
	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

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"`
	Result   UniversalSSLSettings  `json:"result,required"`
	// Whether the API call was successful
	Success UniversalSettingGetResponseEnvelopeSuccess `json:"success,required"`
	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

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

Patch Universal SSL Settings for a Zone.

func (*UniversalSettingService) Get

Get Universal SSL Settings for a Zone.

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 VerificationValidationMethod `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

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"`
	Result   VerificationEditResponse `json:"result,required"`
	// Whether the API call was successful
	Success VerificationEditResponseEnvelopeSuccess `json:"success,required"`
	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

type VerificationEditResponseValidationMethod

type VerificationEditResponseValidationMethod string

Desired validation method.

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

func (VerificationEditResponseValidationMethod) IsKnown

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

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 VerificationValidationMethod

type VerificationValidationMethod string

Validation method in use for a certificate pack order.

const (
	VerificationValidationMethodHTTP  VerificationValidationMethod = "http"
	VerificationValidationMethodCNAME VerificationValidationMethod = "cname"
	VerificationValidationMethodTXT   VerificationValidationMethod = "txt"
)

func (VerificationValidationMethod) IsKnown

func (r VerificationValidationMethod) 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

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

type VerificationVerificationType

type VerificationVerificationType string

Method of verification.

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

func (VerificationVerificationType) IsKnown

func (r VerificationVerificationType) IsKnown() bool

Jump to

Keyboard shortcuts

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