acm

Documentation

Index

• Constants
• type ACMService
  • func NewACMService(opts ...option.RequestOption) (r *ACMService)
• type ASN
• type ASNParam
• type AuditLog
• type AuditLogAction
• type AuditLogActor
• type AuditLogActorType
• type AuditLogOwner
• type AuditLogResource
• type CloudflareTunnel
• type CloudflareTunnelConnection
• type CloudflareTunnelTunType
• type Error
• type ErrorData
• type Member
• type MemberParam
• type MemberRole
• type MemberRoleParam
• type MemberRolesPermissions
• type MemberRolesPermissionsParam
• type MemberUser
• type MemberUserParam
• type Permission
• type PermissionGrant
• type PermissionGrantParam
• type ResponseInfo
• type Role
• type TotalTLSGetParams
• type TotalTLSGetResponse
  • func (r *TotalTLSGetResponse) UnmarshalJSON(data []byte) (err error)
• type TotalTLSGetResponseCertificateAuthority
  • func (r TotalTLSGetResponseCertificateAuthority) IsKnown() bool
• type TotalTLSGetResponseEnvelope
  • func (r *TotalTLSGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type TotalTLSGetResponseEnvelopeSuccess
  • func (r TotalTLSGetResponseEnvelopeSuccess) IsKnown() bool
• type TotalTLSGetResponseValidityDays
  • func (r TotalTLSGetResponseValidityDays) IsKnown() bool
• type TotalTLSNewParams
  • func (r TotalTLSNewParams) MarshalJSON() (data []byte, err error)
• type TotalTLSNewParamsCertificateAuthority
  • func (r TotalTLSNewParamsCertificateAuthority) IsKnown() bool
• type TotalTLSNewResponse
  • func (r *TotalTLSNewResponse) UnmarshalJSON(data []byte) (err error)
• type TotalTLSNewResponseCertificateAuthority
  • func (r TotalTLSNewResponseCertificateAuthority) IsKnown() bool
• type TotalTLSNewResponseEnvelope
  • func (r *TotalTLSNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type TotalTLSNewResponseEnvelopeSuccess
  • func (r TotalTLSNewResponseEnvelopeSuccess) IsKnown() bool
• type TotalTLSNewResponseValidityDays
  • func (r TotalTLSNewResponseValidityDays) IsKnown() bool
• 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)

Constants

const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

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 ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

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

type Member = shared.Member

This is an alias to an internal type.

type MemberParam

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRole

type MemberRole = shared.MemberRole

This is an alias to an internal type.

type MemberRoleParam

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissions

type MemberRolesPermissions = shared.MemberRolesPermissions

This is an alias to an internal type.

type MemberRolesPermissionsParam

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

This is an alias to an internal type.

type MemberUserParam

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

func (TotalTLSGetResponseCertificateAuthority) IsKnown

func (r TotalTLSGetResponseCertificateAuthority) IsKnown() bool

type TotalTLSGetResponseEnvelope

type TotalTLSGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `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 TotalTLSGetResponseEnvelopeSuccess

type TotalTLSGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	TotalTLSGetResponseEnvelopeSuccessTrue TotalTLSGetResponseEnvelopeSuccess = true
)

func (TotalTLSGetResponseEnvelopeSuccess) IsKnown

func (r TotalTLSGetResponseEnvelopeSuccess) IsKnown() bool

type TotalTLSGetResponseValidityDays

type TotalTLSGetResponseValidityDays int64

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

const (
	TotalTLSGetResponseValidityDays90 TotalTLSGetResponseValidityDays = 90
)

func (TotalTLSGetResponseValidityDays) IsKnown

func (r TotalTLSGetResponseValidityDays) IsKnown() bool

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

func (TotalTLSNewParamsCertificateAuthority) IsKnown

func (r TotalTLSNewParamsCertificateAuthority) IsKnown() bool

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

func (TotalTLSNewResponseCertificateAuthority) IsKnown

func (r TotalTLSNewResponseCertificateAuthority) IsKnown() bool

type TotalTLSNewResponseEnvelope

type TotalTLSNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `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 TotalTLSNewResponseEnvelopeSuccess

type TotalTLSNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	TotalTLSNewResponseEnvelopeSuccessTrue TotalTLSNewResponseEnvelopeSuccess = true
)

func (TotalTLSNewResponseEnvelopeSuccess) IsKnown

func (r TotalTLSNewResponseEnvelopeSuccess) IsKnown() bool

type TotalTLSNewResponseValidityDays

type TotalTLSNewResponseValidityDays int64

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

const (
	TotalTLSNewResponseValidityDays90 TotalTLSNewResponseValidityDays = 90
)

func (TotalTLSNewResponseValidityDays) IsKnown

func (r TotalTLSNewResponseValidityDays) IsKnown() bool

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.