ssl

package
v2.0.0-beta.9 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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[AnalyzeNewParamsBundleMethod] `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 AnalyzeNewParamsBundleMethod 

type AnalyzeNewParamsBundleMethod string

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. 

const (
	AnalyzeNewParamsBundleMethodUbiquitous AnalyzeNewParamsBundleMethod = "ubiquitous"
	AnalyzeNewParamsBundleMethodOptimal    AnalyzeNewParamsBundleMethod = "optimal"
	AnalyzeNewParamsBundleMethodForce      AnalyzeNewParamsBundleMethod = "force"
)

type AnalyzeNewResponse 

type AnalyzeNewResponse interface {
	ImplementsSSLAnalyzeNewResponse()
}

Union satisfied by ssl.AnalyzeNewResponseUnknown or shared.UnionString.

type AnalyzeNewResponseEnvelope 

type AnalyzeNewResponseEnvelope struct {
	Errors   []AnalyzeNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AnalyzeNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AnalyzeNewResponse                   `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 AnalyzeNewResponseEnvelopeErrors 

type AnalyzeNewResponseEnvelopeErrors struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    analyzeNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AnalyzeNewResponseEnvelopeErrors) UnmarshalJSON 

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

type AnalyzeNewResponseEnvelopeMessages 

type AnalyzeNewResponseEnvelopeMessages struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    analyzeNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AnalyzeNewResponseEnvelopeMessages) UnmarshalJSON 

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

type AnalyzeNewResponseEnvelopeSuccess 

type AnalyzeNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AnalyzeNewResponseEnvelopeSuccessTrue AnalyzeNewResponseEnvelopeSuccess = true
)

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 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   []CertificatePackDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CertificatePackDeleteResponseEnvelopeMessages `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 CertificatePackDeleteResponseEnvelopeErrors 

type CertificatePackDeleteResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    certificatePackDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CertificatePackDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type CertificatePackDeleteResponseEnvelopeMessages 

type CertificatePackDeleteResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    certificatePackDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CertificatePackDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type CertificatePackDeleteResponseEnvelopeSuccess 

type CertificatePackDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackDeleteResponseEnvelopeSuccessTrue CertificatePackDeleteResponseEnvelopeSuccess = true
)

type CertificatePackEditParams 

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

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 []string `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"
)

type CertificatePackEditResponseEnvelope 

type CertificatePackEditResponseEnvelope struct {
	Errors   []CertificatePackEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CertificatePackEditResponseEnvelopeMessages `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 CertificatePackEditResponseEnvelopeErrors 

type CertificatePackEditResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    certificatePackEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CertificatePackEditResponseEnvelopeErrors) UnmarshalJSON 

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

type CertificatePackEditResponseEnvelopeMessages 

type CertificatePackEditResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    certificatePackEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CertificatePackEditResponseEnvelopeMessages) UnmarshalJSON 

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

type CertificatePackEditResponseEnvelopeSuccess 

type CertificatePackEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackEditResponseEnvelopeSuccessTrue CertificatePackEditResponseEnvelopeSuccess = true
)

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

type CertificatePackEditResponseType 

type CertificatePackEditResponseType string

Type of certificate pack. 

const (
	CertificatePackEditResponseTypeAdvanced CertificatePackEditResponseType = "advanced"
)

type CertificatePackEditResponseValidationMethod 

type CertificatePackEditResponseValidationMethod string

Validation Method selected for the order. 

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

type CertificatePackEditResponseValidityDays 

type CertificatePackEditResponseValidityDays int64

Validity Days selected for the order. 

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

type CertificatePackGetParams 

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

type CertificatePackGetResponse 

type CertificatePackGetResponse interface {
	ImplementsSSLCertificatePackGetResponse()
}

Union satisfied by ssl.CertificatePackGetResponseUnknown or shared.UnionString.

type CertificatePackGetResponseEnvelope 

type CertificatePackGetResponseEnvelope struct {
	Errors   []CertificatePackGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CertificatePackGetResponseEnvelopeMessages `json:"messages,required"`
	Result   CertificatePackGetResponse                   `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 CertificatePackGetResponseEnvelopeErrors 

type CertificatePackGetResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    certificatePackGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CertificatePackGetResponseEnvelopeErrors) UnmarshalJSON 

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

type CertificatePackGetResponseEnvelopeMessages 

type CertificatePackGetResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    certificatePackGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CertificatePackGetResponseEnvelopeMessages) UnmarshalJSON 

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

type CertificatePackGetResponseEnvelopeSuccess 

type CertificatePackGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackGetResponseEnvelopeSuccessTrue CertificatePackGetResponseEnvelopeSuccess = true
)

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

type CertificatePackListResponse 

type CertificatePackListResponse = interface{}

type CertificatePackListResponseEnvelope 

type CertificatePackListResponseEnvelope struct {
	Errors   []CertificatePackListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CertificatePackListResponseEnvelopeMessages `json:"messages,required"`
	Result   []CertificatePackListResponse                 `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    CertificatePackListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo CertificatePackListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       certificatePackListResponseEnvelopeJSON       `json:"-"`
}

func (*CertificatePackListResponseEnvelope) UnmarshalJSON 

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

type CertificatePackListResponseEnvelopeErrors 

type CertificatePackListResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    certificatePackListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CertificatePackListResponseEnvelopeErrors) UnmarshalJSON 

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

type CertificatePackListResponseEnvelopeMessages 

type CertificatePackListResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    certificatePackListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CertificatePackListResponseEnvelopeMessages) UnmarshalJSON 

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

type CertificatePackListResponseEnvelopeResultInfo 

type CertificatePackListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                           `json:"total_count"`
	JSON       certificatePackListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*CertificatePackListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type CertificatePackListResponseEnvelopeSuccess 

type CertificatePackListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackListResponseEnvelopeSuccessTrue CertificatePackListResponseEnvelopeSuccess = true
)

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[[]string] `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"
)

type CertificatePackOrderNewParamsType 

type CertificatePackOrderNewParamsType string

Type of certificate pack. 

const (
	CertificatePackOrderNewParamsTypeAdvanced CertificatePackOrderNewParamsType = "advanced"
)

type CertificatePackOrderNewParamsValidationMethod 

type CertificatePackOrderNewParamsValidationMethod string

Validation Method selected for the order. 

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

type CertificatePackOrderNewParamsValidityDays 

type CertificatePackOrderNewParamsValidityDays int64

Validity Days selected for the order. 

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

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 []string `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"
)

type CertificatePackOrderNewResponseEnvelope 

type CertificatePackOrderNewResponseEnvelope struct {
	Errors   []CertificatePackOrderNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CertificatePackOrderNewResponseEnvelopeMessages `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 CertificatePackOrderNewResponseEnvelopeErrors 

type CertificatePackOrderNewResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    certificatePackOrderNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CertificatePackOrderNewResponseEnvelopeErrors) UnmarshalJSON 

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

type CertificatePackOrderNewResponseEnvelopeMessages 

type CertificatePackOrderNewResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    certificatePackOrderNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CertificatePackOrderNewResponseEnvelopeMessages) UnmarshalJSON 

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

type CertificatePackOrderNewResponseEnvelopeSuccess 

type CertificatePackOrderNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackOrderNewResponseEnvelopeSuccessTrue CertificatePackOrderNewResponseEnvelopeSuccess = true
)

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

type CertificatePackOrderNewResponseType 

type CertificatePackOrderNewResponseType string

Type of certificate pack. 

const (
	CertificatePackOrderNewResponseTypeAdvanced CertificatePackOrderNewResponseType = "advanced"
)

type CertificatePackOrderNewResponseValidationMethod 

type CertificatePackOrderNewResponseValidationMethod string

Validation Method selected for the order. 

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

type CertificatePackOrderNewResponseValidityDays 

type CertificatePackOrderNewResponseValidityDays int64

Validity Days selected for the order. 

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

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 

func (r *CertificatePackOrderService) New(ctx context.Context, params CertificatePackOrderNewParams, opts ...option.RequestOption) (res *CertificatePackOrderNewResponse, err error)

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   []CertificatePackQuotaGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CertificatePackQuotaGetResponseEnvelopeMessages `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 CertificatePackQuotaGetResponseEnvelopeErrors 

type CertificatePackQuotaGetResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    certificatePackQuotaGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CertificatePackQuotaGetResponseEnvelopeErrors) UnmarshalJSON 

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

type CertificatePackQuotaGetResponseEnvelopeMessages 

type CertificatePackQuotaGetResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    certificatePackQuotaGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CertificatePackQuotaGetResponseEnvelopeMessages) UnmarshalJSON 

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

type CertificatePackQuotaGetResponseEnvelopeSuccess 

type CertificatePackQuotaGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackQuotaGetResponseEnvelopeSuccessTrue CertificatePackQuotaGetResponseEnvelopeSuccess = true
)

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

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, body CertificatePackEditParams, opts ...option.RequestOption) (res *CertificatePackEditResponse, err error)

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 

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 *[]CertificatePackListResponse, err error)

For a given zone, list all active certificate packs.

type Error 

type Error = apierror.Error

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   []RecommendationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RecommendationGetResponseEnvelopeMessages `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 RecommendationGetResponseEnvelopeErrors 

type RecommendationGetResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    recommendationGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RecommendationGetResponseEnvelopeErrors) UnmarshalJSON 

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

type RecommendationGetResponseEnvelopeMessages 

type RecommendationGetResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    recommendationGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RecommendationGetResponseEnvelopeMessages) UnmarshalJSON 

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

type RecommendationGetResponseEnvelopeSuccess 

type RecommendationGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RecommendationGetResponseEnvelopeSuccessTrue RecommendationGetResponseEnvelopeSuccess = true
)

type RecommendationGetResponseValue 

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

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

type TLSCertificatesAndHostnamesUniversal 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    tlsCertificatesAndHostnamesUniversalJSON `json:"-"`
}

func (*TLSCertificatesAndHostnamesUniversal) UnmarshalJSON 

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

type TLSCertificatesAndHostnamesVerification 

type TLSCertificatesAndHostnamesVerification struct {
	// Current status of certificate.
	CertificateStatus TLSCertificatesAndHostnamesVerificationCertificateStatus `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 TLSCertificatesAndHostnamesVerificationSignature `json:"signature"`
	// Validation method in use for a certificate pack order.
	ValidationMethod TLSCertificatesAndHostnamesVerificationValidationMethod `json:"validation_method"`
	// Certificate's required verification information.
	VerificationInfo TLSCertificatesAndHostnamesVerificationVerificationInfo `json:"verification_info"`
	// Status of the required verification information, omitted if verification status
	// is unknown.
	VerificationStatus bool `json:"verification_status"`
	// Method of verification.
	VerificationType TLSCertificatesAndHostnamesVerificationVerificationType `json:"verification_type"`
	JSON             tlsCertificatesAndHostnamesVerificationJSON             `json:"-"`
}

func (*TLSCertificatesAndHostnamesVerification) UnmarshalJSON 

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

type TLSCertificatesAndHostnamesVerificationCertificateStatus 

type TLSCertificatesAndHostnamesVerificationCertificateStatus string

Current status of certificate. 

const (
	TLSCertificatesAndHostnamesVerificationCertificateStatusInitializing      TLSCertificatesAndHostnamesVerificationCertificateStatus = "initializing"
	TLSCertificatesAndHostnamesVerificationCertificateStatusAuthorizing       TLSCertificatesAndHostnamesVerificationCertificateStatus = "authorizing"
	TLSCertificatesAndHostnamesVerificationCertificateStatusActive            TLSCertificatesAndHostnamesVerificationCertificateStatus = "active"
	TLSCertificatesAndHostnamesVerificationCertificateStatusExpired           TLSCertificatesAndHostnamesVerificationCertificateStatus = "expired"
	TLSCertificatesAndHostnamesVerificationCertificateStatusIssuing           TLSCertificatesAndHostnamesVerificationCertificateStatus = "issuing"
	TLSCertificatesAndHostnamesVerificationCertificateStatusTimingOut         TLSCertificatesAndHostnamesVerificationCertificateStatus = "timing_out"
	TLSCertificatesAndHostnamesVerificationCertificateStatusPendingDeployment TLSCertificatesAndHostnamesVerificationCertificateStatus = "pending_deployment"
)

type TLSCertificatesAndHostnamesVerificationSignature 

type TLSCertificatesAndHostnamesVerificationSignature string

Certificate's signature algorithm. 

const (
	TLSCertificatesAndHostnamesVerificationSignatureEcdsaWithSha256 TLSCertificatesAndHostnamesVerificationSignature = "ECDSAWithSHA256"
	TLSCertificatesAndHostnamesVerificationSignatureSha1WithRsa     TLSCertificatesAndHostnamesVerificationSignature = "SHA1WithRSA"
	TLSCertificatesAndHostnamesVerificationSignatureSha256WithRsa   TLSCertificatesAndHostnamesVerificationSignature = "SHA256WithRSA"
)

type TLSCertificatesAndHostnamesVerificationValidationMethod 

type TLSCertificatesAndHostnamesVerificationValidationMethod string

Validation method in use for a certificate pack order. 

const (
	TLSCertificatesAndHostnamesVerificationValidationMethodHTTP  TLSCertificatesAndHostnamesVerificationValidationMethod = "http"
	TLSCertificatesAndHostnamesVerificationValidationMethodCNAME TLSCertificatesAndHostnamesVerificationValidationMethod = "cname"
	TLSCertificatesAndHostnamesVerificationValidationMethodTXT   TLSCertificatesAndHostnamesVerificationValidationMethod = "txt"
)

type TLSCertificatesAndHostnamesVerificationVerificationInfo 

type TLSCertificatesAndHostnamesVerificationVerificationInfo struct {
	// Name of CNAME record.
	RecordName TLSCertificatesAndHostnamesVerificationVerificationInfoRecordName `json:"record_name"`
	// Target of CNAME record.
	RecordTarget TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTarget `json:"record_target"`
	JSON         tlsCertificatesAndHostnamesVerificationVerificationInfoJSON         `json:"-"`
}

Certificate's required verification information.

func (*TLSCertificatesAndHostnamesVerificationVerificationInfo) UnmarshalJSON 

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

type TLSCertificatesAndHostnamesVerificationVerificationInfoRecordName 

type TLSCertificatesAndHostnamesVerificationVerificationInfoRecordName string

Name of CNAME record. 

const (
	TLSCertificatesAndHostnamesVerificationVerificationInfoRecordNameRecordName TLSCertificatesAndHostnamesVerificationVerificationInfoRecordName = "record_name"
	TLSCertificatesAndHostnamesVerificationVerificationInfoRecordNameHTTPURL    TLSCertificatesAndHostnamesVerificationVerificationInfoRecordName = "http_url"
	TLSCertificatesAndHostnamesVerificationVerificationInfoRecordNameCNAME      TLSCertificatesAndHostnamesVerificationVerificationInfoRecordName = "cname"
	TLSCertificatesAndHostnamesVerificationVerificationInfoRecordNameTXTName    TLSCertificatesAndHostnamesVerificationVerificationInfoRecordName = "txt_name"
)

type TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTarget 

type TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTarget string

Target of CNAME record. 

const (
	TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTargetRecordValue TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTarget = "record_value"
	TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTargetHTTPBody    TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTarget = "http_body"
	TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTargetCNAMETarget TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTarget = "cname_target"
	TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTargetTXTValue    TLSCertificatesAndHostnamesVerificationVerificationInfoRecordTarget = "txt_value"
)

type TLSCertificatesAndHostnamesVerificationVerificationType 

type TLSCertificatesAndHostnamesVerificationVerificationType string

Method of verification. 

const (
	TLSCertificatesAndHostnamesVerificationVerificationTypeCNAME   TLSCertificatesAndHostnamesVerificationVerificationType = "cname"
	TLSCertificatesAndHostnamesVerificationVerificationTypeMetaTag TLSCertificatesAndHostnamesVerificationVerificationType = "meta tag"
)

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"`
	// 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 (UniversalSettingEditParams) MarshalJSON 

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

type UniversalSettingEditResponseEnvelope 

type UniversalSettingEditResponseEnvelope struct {
	Errors   []UniversalSettingEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []UniversalSettingEditResponseEnvelopeMessages `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesUniversal           `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 UniversalSettingEditResponseEnvelopeErrors 

type UniversalSettingEditResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    universalSettingEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*UniversalSettingEditResponseEnvelopeErrors) UnmarshalJSON 

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

type UniversalSettingEditResponseEnvelopeMessages 

type UniversalSettingEditResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    universalSettingEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*UniversalSettingEditResponseEnvelopeMessages) UnmarshalJSON 

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

type UniversalSettingEditResponseEnvelopeSuccess 

type UniversalSettingEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	UniversalSettingEditResponseEnvelopeSuccessTrue UniversalSettingEditResponseEnvelopeSuccess = true
)

type UniversalSettingGetParams 

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

type UniversalSettingGetResponseEnvelope 

type UniversalSettingGetResponseEnvelope struct {
	Errors   []UniversalSettingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []UniversalSettingGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesUniversal          `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 UniversalSettingGetResponseEnvelopeErrors 

type UniversalSettingGetResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    universalSettingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*UniversalSettingGetResponseEnvelopeErrors) UnmarshalJSON 

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

type UniversalSettingGetResponseEnvelopeMessages 

type UniversalSettingGetResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    universalSettingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*UniversalSettingGetResponseEnvelopeMessages) UnmarshalJSON 

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

type UniversalSettingGetResponseEnvelopeSuccess 

type UniversalSettingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	UniversalSettingGetResponseEnvelopeSuccessTrue UniversalSettingGetResponseEnvelopeSuccess = true
)

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 *TLSCertificatesAndHostnamesUniversal, 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 *TLSCertificatesAndHostnamesUniversal, err error)

Get Universal SSL Settings for a Zone.

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

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   []VerificationEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []VerificationEditResponseEnvelopeMessages `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 VerificationEditResponseEnvelopeErrors 

type VerificationEditResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    verificationEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*VerificationEditResponseEnvelopeErrors) UnmarshalJSON 

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

type VerificationEditResponseEnvelopeMessages 

type VerificationEditResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    verificationEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*VerificationEditResponseEnvelopeMessages) UnmarshalJSON 

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

type VerificationEditResponseEnvelopeSuccess 

type VerificationEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	VerificationEditResponseEnvelopeSuccessTrue VerificationEditResponseEnvelopeSuccess = true
)

type VerificationEditResponseValidationMethod 

type VerificationEditResponseValidationMethod string

Desired validation method. 

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

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
)

type VerificationGetResponseEnvelope 

type VerificationGetResponseEnvelope struct {
	Result []TLSCertificatesAndHostnamesVerification `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 *[]TLSCertificatesAndHostnamesVerification, err error)

Get SSL Verification Info for a Zone.

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.