acm

Documentation

Index

• type ACMService
  • func NewACMService(opts ...option.RequestOption) (r *ACMService)
• type Error
• type TotalTLSGetParams
• type TotalTLSGetResponse
  • func (r *TotalTLSGetResponse) UnmarshalJSON(data []byte) (err error)
• type TotalTLSGetResponseCertificateAuthority
• type TotalTLSGetResponseEnvelope
  • func (r *TotalTLSGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type TotalTLSGetResponseEnvelopeErrors
  • func (r *TotalTLSGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
• type TotalTLSGetResponseEnvelopeMessages
  • func (r *TotalTLSGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
• type TotalTLSGetResponseEnvelopeSuccess
• type TotalTLSGetResponseValidityDays
• type TotalTLSNewParams
  • func (r TotalTLSNewParams) MarshalJSON() (data []byte, err error)
• type TotalTLSNewParamsCertificateAuthority
• type TotalTLSNewResponse
  • func (r *TotalTLSNewResponse) UnmarshalJSON(data []byte) (err error)
• type TotalTLSNewResponseCertificateAuthority
• type TotalTLSNewResponseEnvelope
  • func (r *TotalTLSNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type TotalTLSNewResponseEnvelopeErrors
  • func (r *TotalTLSNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
• type TotalTLSNewResponseEnvelopeMessages
  • func (r *TotalTLSNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
• type TotalTLSNewResponseEnvelopeSuccess
• type TotalTLSNewResponseValidityDays
• type TotalTLSService
  • func NewTotalTLSService(opts ...option.RequestOption) (r *TotalTLSService)
  • func (r *TotalTLSService) Get(ctx context.Context, query TotalTLSGetParams, opts ...option.RequestOption) (res *TotalTLSGetResponse, err error)
  • func (r *TotalTLSService) New(ctx context.Context, params TotalTLSNewParams, opts ...option.RequestOption) (res *TotalTLSNewResponse, err error)

Types

type ACMService

type ACMService struct {
	Options  []option.RequestOption
	TotalTLS *TotalTLSService
}

ACMService 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 NewACMService method instead.

func NewACMService

func NewACMService(opts ...option.RequestOption) (r *ACMService)

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

type Error = apierror.Error

type TotalTLSGetParams

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

type TotalTLSGetResponse

type TotalTLSGetResponse struct {
	// The Certificate Authority that Total TLS certificates will be issued through.
	CertificateAuthority TotalTLSGetResponseCertificateAuthority `json:"certificate_authority"`
	// If enabled, Total TLS will order a hostname specific TLS certificate for any
	// proxied A, AAAA, or CNAME record in your zone.
	Enabled bool `json:"enabled"`
	// The validity period in days for the certificates ordered via Total TLS.
	ValidityDays TotalTLSGetResponseValidityDays `json:"validity_days"`
	JSON         totalTLSGetResponseJSON         `json:"-"`
}

func (*TotalTLSGetResponse) UnmarshalJSON

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

type TotalTLSGetResponseCertificateAuthority

type TotalTLSGetResponseCertificateAuthority string

The Certificate Authority that Total TLS certificates will be issued through.

const (
	TotalTLSGetResponseCertificateAuthorityGoogle      TotalTLSGetResponseCertificateAuthority = "google"
	TotalTLSGetResponseCertificateAuthorityLetsEncrypt TotalTLSGetResponseCertificateAuthority = "lets_encrypt"
)

type TotalTLSGetResponseEnvelope

type TotalTLSGetResponseEnvelope struct {
	Errors   []TotalTLSGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TotalTLSGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TotalTLSGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success TotalTLSGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    totalTLSGetResponseEnvelopeJSON    `json:"-"`
}

func (*TotalTLSGetResponseEnvelope) UnmarshalJSON

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

type TotalTLSGetResponseEnvelopeErrors

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

func (*TotalTLSGetResponseEnvelopeErrors) UnmarshalJSON

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

type TotalTLSGetResponseEnvelopeMessages

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

func (*TotalTLSGetResponseEnvelopeMessages) UnmarshalJSON

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

type TotalTLSGetResponseEnvelopeSuccess

type TotalTLSGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	TotalTLSGetResponseEnvelopeSuccessTrue TotalTLSGetResponseEnvelopeSuccess = true
)

type TotalTLSGetResponseValidityDays

type TotalTLSGetResponseValidityDays int64

The validity period in days for the certificates ordered via Total TLS.

const (
	TotalTLSGetResponseValidityDays90 TotalTLSGetResponseValidityDays = 90
)

type TotalTLSNewParams

type TotalTLSNewParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// If enabled, Total TLS will order a hostname specific TLS certificate for any
	// proxied A, AAAA, or CNAME record in your zone.
	Enabled param.Field[bool] `json:"enabled,required"`
	// The Certificate Authority that Total TLS certificates will be issued through.
	CertificateAuthority param.Field[TotalTLSNewParamsCertificateAuthority] `json:"certificate_authority"`
}

func (TotalTLSNewParams) MarshalJSON

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

type TotalTLSNewParamsCertificateAuthority

type TotalTLSNewParamsCertificateAuthority string

The Certificate Authority that Total TLS certificates will be issued through.

const (
	TotalTLSNewParamsCertificateAuthorityGoogle      TotalTLSNewParamsCertificateAuthority = "google"
	TotalTLSNewParamsCertificateAuthorityLetsEncrypt TotalTLSNewParamsCertificateAuthority = "lets_encrypt"
)

type TotalTLSNewResponse

type TotalTLSNewResponse struct {
	// The Certificate Authority that Total TLS certificates will be issued through.
	CertificateAuthority TotalTLSNewResponseCertificateAuthority `json:"certificate_authority"`
	// If enabled, Total TLS will order a hostname specific TLS certificate for any
	// proxied A, AAAA, or CNAME record in your zone.
	Enabled bool `json:"enabled"`
	// The validity period in days for the certificates ordered via Total TLS.
	ValidityDays TotalTLSNewResponseValidityDays `json:"validity_days"`
	JSON         totalTLSNewResponseJSON         `json:"-"`
}

func (*TotalTLSNewResponse) UnmarshalJSON

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

type TotalTLSNewResponseCertificateAuthority

type TotalTLSNewResponseCertificateAuthority string

The Certificate Authority that Total TLS certificates will be issued through.

const (
	TotalTLSNewResponseCertificateAuthorityGoogle      TotalTLSNewResponseCertificateAuthority = "google"
	TotalTLSNewResponseCertificateAuthorityLetsEncrypt TotalTLSNewResponseCertificateAuthority = "lets_encrypt"
)

type TotalTLSNewResponseEnvelope

type TotalTLSNewResponseEnvelope struct {
	Errors   []TotalTLSNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TotalTLSNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TotalTLSNewResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success TotalTLSNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    totalTLSNewResponseEnvelopeJSON    `json:"-"`
}

func (*TotalTLSNewResponseEnvelope) UnmarshalJSON

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

type TotalTLSNewResponseEnvelopeErrors

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

func (*TotalTLSNewResponseEnvelopeErrors) UnmarshalJSON

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

type TotalTLSNewResponseEnvelopeMessages

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

func (*TotalTLSNewResponseEnvelopeMessages) UnmarshalJSON

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

type TotalTLSNewResponseEnvelopeSuccess

type TotalTLSNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	TotalTLSNewResponseEnvelopeSuccessTrue TotalTLSNewResponseEnvelopeSuccess = true
)

type TotalTLSNewResponseValidityDays

type TotalTLSNewResponseValidityDays int64

The validity period in days for the certificates ordered via Total TLS.

const (
	TotalTLSNewResponseValidityDays90 TotalTLSNewResponseValidityDays = 90
)

type TotalTLSService

type TotalTLSService struct {
	Options []option.RequestOption
}

TotalTLSService 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 NewTotalTLSService method instead.

func NewTotalTLSService

func NewTotalTLSService(opts ...option.RequestOption) (r *TotalTLSService)

NewTotalTLSService 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 (*TotalTLSService) Get

func (r *TotalTLSService) Get(ctx context.Context, query TotalTLSGetParams, opts ...option.RequestOption) (res *TotalTLSGetResponse, err error)

Get Total TLS Settings for a Zone.

func (*TotalTLSService) New

func (r *TotalTLSService) New(ctx context.Context, params TotalTLSNewParams, opts ...option.RequestOption) (res *TotalTLSNewResponse, err error)

Set Total TLS Settings or disable the feature for a Zone.