certificate_authorities

Documentation

Index

• type CertificateAuthorityService
  • func NewCertificateAuthorityService(opts ...option.RequestOption) (r *CertificateAuthorityService)
• type Error
• type HostnameAssociationGetParams
  • func (r HostnameAssociationGetParams) URLQuery() (v url.Values)
• type HostnameAssociationGetResponseEnvelope
  • func (r *HostnameAssociationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type HostnameAssociationGetResponseEnvelopeErrors
  • func (r *HostnameAssociationGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
• type HostnameAssociationGetResponseEnvelopeMessages
  • func (r *HostnameAssociationGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
• type HostnameAssociationGetResponseEnvelopeSuccess
  • func (r HostnameAssociationGetResponseEnvelopeSuccess) IsKnown() bool
• type HostnameAssociationService
  • func NewHostnameAssociationService(opts ...option.RequestOption) (r *HostnameAssociationService)
  • func (r *HostnameAssociationService) Get(ctx context.Context, params HostnameAssociationGetParams, ...) (res *TLSCertificatesAndHostnamesHostnameAssociation, err error)
  • func (r *HostnameAssociationService) Update(ctx context.Context, params HostnameAssociationUpdateParams, ...) (res *TLSCertificatesAndHostnamesHostnameAssociation, err error)
• type HostnameAssociationUpdateParams
  • func (r HostnameAssociationUpdateParams) MarshalJSON() (data []byte, err error)
• type HostnameAssociationUpdateResponseEnvelope
  • func (r *HostnameAssociationUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type HostnameAssociationUpdateResponseEnvelopeErrors
  • func (r *HostnameAssociationUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
• type HostnameAssociationUpdateResponseEnvelopeMessages
  • func (r *HostnameAssociationUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
• type HostnameAssociationUpdateResponseEnvelopeSuccess
  • func (r HostnameAssociationUpdateResponseEnvelopeSuccess) IsKnown() bool
• type TLSCertificatesAndHostnamesHostnameAssociation
  • func (r *TLSCertificatesAndHostnamesHostnameAssociation) UnmarshalJSON(data []byte) (err error)

Types

type CertificateAuthorityService

type CertificateAuthorityService struct {
	Options              []option.RequestOption
	HostnameAssociations *HostnameAssociationService
}

CertificateAuthorityService 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 NewCertificateAuthorityService method instead.

func NewCertificateAuthorityService

func NewCertificateAuthorityService(opts ...option.RequestOption) (r *CertificateAuthorityService)

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

type HostnameAssociationGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The UUID to match against for a certificate that was uploaded to the mTLS
	// Certificate Management endpoint. If no mtls_certificate_id is given, the results
	// will be the hostnames associated to your active Cloudflare Managed CA.
	MTLSCertificateID param.Field[string] `query:"mtls_certificate_id"`
}

func (HostnameAssociationGetParams) URLQuery

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

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

type HostnameAssociationGetResponseEnvelope

type HostnameAssociationGetResponseEnvelope struct {
	Errors   []HostnameAssociationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HostnameAssociationGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesHostnameAssociation   `json:"result,required"`
	// Whether the API call was successful
	Success HostnameAssociationGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    hostnameAssociationGetResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameAssociationGetResponseEnvelope) UnmarshalJSON

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

type HostnameAssociationGetResponseEnvelopeErrors

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

func (*HostnameAssociationGetResponseEnvelopeErrors) UnmarshalJSON

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

type HostnameAssociationGetResponseEnvelopeMessages

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

func (*HostnameAssociationGetResponseEnvelopeMessages) UnmarshalJSON

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

type HostnameAssociationGetResponseEnvelopeSuccess

type HostnameAssociationGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	HostnameAssociationGetResponseEnvelopeSuccessTrue HostnameAssociationGetResponseEnvelopeSuccess = true
)

func (HostnameAssociationGetResponseEnvelopeSuccess) IsKnown

func (r HostnameAssociationGetResponseEnvelopeSuccess) IsKnown() bool

type HostnameAssociationService

type HostnameAssociationService struct {
	Options []option.RequestOption
}

HostnameAssociationService 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 NewHostnameAssociationService method instead.

func NewHostnameAssociationService

func NewHostnameAssociationService(opts ...option.RequestOption) (r *HostnameAssociationService)

NewHostnameAssociationService 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 (*HostnameAssociationService) Get

func (r *HostnameAssociationService) Get(ctx context.Context, params HostnameAssociationGetParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesHostnameAssociation, err error)

List Hostname Associations

func (*HostnameAssociationService) Update

func (r *HostnameAssociationService) Update(ctx context.Context, params HostnameAssociationUpdateParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesHostnameAssociation, err error)

Replace Hostname Associations

type HostnameAssociationUpdateParams

type HostnameAssociationUpdateParams struct {
	// Identifier
	ZoneID    param.Field[string]   `path:"zone_id,required"`
	Hostnames param.Field[[]string] `json:"hostnames"`
	// The UUID for a certificate that was uploaded to the mTLS Certificate Management
	// endpoint. If no mtls_certificate_id is given, the hostnames will be associated
	// to your active Cloudflare Managed CA.
	MTLSCertificateID param.Field[string] `json:"mtls_certificate_id"`
}

func (HostnameAssociationUpdateParams) MarshalJSON

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

type HostnameAssociationUpdateResponseEnvelope

type HostnameAssociationUpdateResponseEnvelope struct {
	Errors   []HostnameAssociationUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HostnameAssociationUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesHostnameAssociation      `json:"result,required"`
	// Whether the API call was successful
	Success HostnameAssociationUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    hostnameAssociationUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameAssociationUpdateResponseEnvelope) UnmarshalJSON

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

type HostnameAssociationUpdateResponseEnvelopeErrors

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

func (*HostnameAssociationUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type HostnameAssociationUpdateResponseEnvelopeMessages

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

func (*HostnameAssociationUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type HostnameAssociationUpdateResponseEnvelopeSuccess

type HostnameAssociationUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	HostnameAssociationUpdateResponseEnvelopeSuccessTrue HostnameAssociationUpdateResponseEnvelopeSuccess = true
)

func (HostnameAssociationUpdateResponseEnvelopeSuccess) IsKnown

func (r HostnameAssociationUpdateResponseEnvelopeSuccess) IsKnown() bool

type TLSCertificatesAndHostnamesHostnameAssociation

type TLSCertificatesAndHostnamesHostnameAssociation struct {
	Hostnames []string `json:"hostnames"`
	// The UUID for a certificate that was uploaded to the mTLS Certificate Management
	// endpoint. If no mtls_certificate_id is given, the hostnames will be associated
	// to your active Cloudflare Managed CA.
	MTLSCertificateID string                                             `json:"mtls_certificate_id"`
	JSON              tlsCertificatesAndHostnamesHostnameAssociationJSON `json:"-"`
}

func (*TLSCertificatesAndHostnamesHostnameAssociation) UnmarshalJSON

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