origin_tls_client_auth

package
v2.0.0-beta.5 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Error 

type Error = apierror.Error

type HostnameCertificateDeleteParams 

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

type HostnameCertificateDeleteResponseEnvelope 

type HostnameCertificateDeleteResponseEnvelope struct {
	Errors   []HostnameCertificateDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HostnameCertificateDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesSchemasCertificateObject `json:"result,required"`
	// Whether the API call was successful
	Success HostnameCertificateDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    hostnameCertificateDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameCertificateDeleteResponseEnvelope) UnmarshalJSON 

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

type HostnameCertificateDeleteResponseEnvelopeErrors 

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

func (*HostnameCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type HostnameCertificateDeleteResponseEnvelopeMessages 

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

func (*HostnameCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type HostnameCertificateDeleteResponseEnvelopeSuccess 

type HostnameCertificateDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	HostnameCertificateDeleteResponseEnvelopeSuccessTrue HostnameCertificateDeleteResponseEnvelopeSuccess = true
)

type HostnameCertificateGetParams 

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

type HostnameCertificateGetResponseEnvelope 

type HostnameCertificateGetResponseEnvelope struct {
	Errors   []HostnameCertificateGetResponseEnvelopeErrors      `json:"errors,required"`
	Messages []HostnameCertificateGetResponseEnvelopeMessages    `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesSchemasCertificateObject `json:"result,required"`
	// Whether the API call was successful
	Success HostnameCertificateGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    hostnameCertificateGetResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameCertificateGetResponseEnvelope) UnmarshalJSON 

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

type HostnameCertificateGetResponseEnvelopeErrors 

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

func (*HostnameCertificateGetResponseEnvelopeErrors) UnmarshalJSON 

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

type HostnameCertificateGetResponseEnvelopeMessages 

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

func (*HostnameCertificateGetResponseEnvelopeMessages) UnmarshalJSON 

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

type HostnameCertificateGetResponseEnvelopeSuccess 

type HostnameCertificateGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	HostnameCertificateGetResponseEnvelopeSuccessTrue HostnameCertificateGetResponseEnvelopeSuccess = true
)

type HostnameCertificateListParams 

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

type HostnameCertificateListResponseEnvelope 

type HostnameCertificateListResponseEnvelope struct {
	Errors   []HostnameCertificateListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HostnameCertificateListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TLSCertificatesAndHostnamesHostnameCertidObject `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    HostnameCertificateListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo HostnameCertificateListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       hostnameCertificateListResponseEnvelopeJSON       `json:"-"`
}

func (*HostnameCertificateListResponseEnvelope) UnmarshalJSON 

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

type HostnameCertificateListResponseEnvelopeErrors 

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

func (*HostnameCertificateListResponseEnvelopeErrors) UnmarshalJSON 

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

type HostnameCertificateListResponseEnvelopeMessages 

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

func (*HostnameCertificateListResponseEnvelopeMessages) UnmarshalJSON 

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

type HostnameCertificateListResponseEnvelopeResultInfo 

type HostnameCertificateListResponseEnvelopeResultInfo 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       hostnameCertificateListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*HostnameCertificateListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type HostnameCertificateListResponseEnvelopeSuccess 

type HostnameCertificateListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	HostnameCertificateListResponseEnvelopeSuccessTrue HostnameCertificateListResponseEnvelopeSuccess = true
)

type HostnameCertificateNewParams 

type HostnameCertificateNewParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The hostname certificate.
	Certificate param.Field[string] `json:"certificate,required"`
	// The hostname certificate's private key.
	PrivateKey param.Field[string] `json:"private_key,required"`
}

func (HostnameCertificateNewParams) MarshalJSON 

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

type HostnameCertificateNewResponseEnvelope 

type HostnameCertificateNewResponseEnvelope struct {
	Errors   []HostnameCertificateNewResponseEnvelopeErrors      `json:"errors,required"`
	Messages []HostnameCertificateNewResponseEnvelopeMessages    `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesSchemasCertificateObject `json:"result,required"`
	// Whether the API call was successful
	Success HostnameCertificateNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    hostnameCertificateNewResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameCertificateNewResponseEnvelope) UnmarshalJSON 

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

type HostnameCertificateNewResponseEnvelopeErrors 

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

func (*HostnameCertificateNewResponseEnvelopeErrors) UnmarshalJSON 

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

type HostnameCertificateNewResponseEnvelopeMessages 

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

func (*HostnameCertificateNewResponseEnvelopeMessages) UnmarshalJSON 

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

type HostnameCertificateNewResponseEnvelopeSuccess 

type HostnameCertificateNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	HostnameCertificateNewResponseEnvelopeSuccessTrue HostnameCertificateNewResponseEnvelopeSuccess = true
)

type HostnameCertificateService 

type HostnameCertificateService struct {
	Options []option.RequestOption
}

HostnameCertificateService 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 NewHostnameCertificateService method instead.

func NewHostnameCertificateService 

func NewHostnameCertificateService(opts ...option.RequestOption) (r *HostnameCertificateService)

NewHostnameCertificateService 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 (*HostnameCertificateService) Delete 

func (r *HostnameCertificateService) Delete(ctx context.Context, certificateID string, body HostnameCertificateDeleteParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesSchemasCertificateObject, err error)

Delete Hostname Client Certificate

func (*HostnameCertificateService) Get 

func (r *HostnameCertificateService) Get(ctx context.Context, certificateID string, query HostnameCertificateGetParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesSchemasCertificateObject, err error)

Get the certificate by ID to be used for client authentication on a hostname.

func (*HostnameCertificateService) List 

func (r *HostnameCertificateService) List(ctx context.Context, query HostnameCertificateListParams, opts ...option.RequestOption) (res *[]TLSCertificatesAndHostnamesHostnameCertidObject, err error)

List Certificates

func (*HostnameCertificateService) New 

func (r *HostnameCertificateService) New(ctx context.Context, params HostnameCertificateNewParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesSchemasCertificateObject, err error)

Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.

type HostnameGetParams 

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

type HostnameGetResponseEnvelope 

type HostnameGetResponseEnvelope struct {
	Errors   []HostnameGetResponseEnvelopeErrors             `json:"errors,required"`
	Messages []HostnameGetResponseEnvelopeMessages           `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesHostnameCertidObject `json:"result,required"`
	// Whether the API call was successful
	Success HostnameGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    hostnameGetResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameGetResponseEnvelope) UnmarshalJSON 

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

type HostnameGetResponseEnvelopeErrors 

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

func (*HostnameGetResponseEnvelopeErrors) UnmarshalJSON 

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

type HostnameGetResponseEnvelopeMessages 

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

func (*HostnameGetResponseEnvelopeMessages) UnmarshalJSON 

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

type HostnameGetResponseEnvelopeSuccess 

type HostnameGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	HostnameGetResponseEnvelopeSuccessTrue HostnameGetResponseEnvelopeSuccess = true
)

type HostnameService 

type HostnameService struct {
	Options      []option.RequestOption
	Certificates *HostnameCertificateService
}

HostnameService 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 NewHostnameService method instead.

func NewHostnameService 

func NewHostnameService(opts ...option.RequestOption) (r *HostnameService)

NewHostnameService 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 (*HostnameService) Get 

func (r *HostnameService) Get(ctx context.Context, hostname string, query HostnameGetParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesHostnameCertidObject, err error)

Get the Hostname Status for Client Authentication

func (*HostnameService) Update 

func (r *HostnameService) Update(ctx context.Context, params HostnameUpdateParams, opts ...option.RequestOption) (res *[]TLSCertificatesAndHostnamesHostnameCertidObject, err error)

Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter _enabled_ to invalidate the association.

type HostnameUpdateParams 

type HostnameUpdateParams struct {
	// Identifier
	ZoneID param.Field[string]                       `path:"zone_id,required"`
	Config param.Field[[]HostnameUpdateParamsConfig] `json:"config,required"`
}

func (HostnameUpdateParams) MarshalJSON 

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

type HostnameUpdateParamsConfig 

type HostnameUpdateParamsConfig struct {
	// Certificate identifier tag.
	CertID param.Field[string] `json:"cert_id"`
	// Indicates whether hostname-level authenticated origin pulls is enabled. A null
	// value voids the association.
	Enabled param.Field[bool] `json:"enabled"`
	// The hostname on the origin for which the client certificate uploaded will be
	// used.
	Hostname param.Field[string] `json:"hostname"`
}

func (HostnameUpdateParamsConfig) MarshalJSON 

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

type HostnameUpdateResponseEnvelope 

type HostnameUpdateResponseEnvelope struct {
	Errors   []HostnameUpdateResponseEnvelopeErrors            `json:"errors,required"`
	Messages []HostnameUpdateResponseEnvelopeMessages          `json:"messages,required"`
	Result   []TLSCertificatesAndHostnamesHostnameCertidObject `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    HostnameUpdateResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo HostnameUpdateResponseEnvelopeResultInfo `json:"result_info"`
	JSON       hostnameUpdateResponseEnvelopeJSON       `json:"-"`
}

func (*HostnameUpdateResponseEnvelope) UnmarshalJSON 

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

type HostnameUpdateResponseEnvelopeErrors 

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

func (*HostnameUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type HostnameUpdateResponseEnvelopeMessages 

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

func (*HostnameUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type HostnameUpdateResponseEnvelopeResultInfo 

type HostnameUpdateResponseEnvelopeResultInfo 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       hostnameUpdateResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*HostnameUpdateResponseEnvelopeResultInfo) UnmarshalJSON 

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

type HostnameUpdateResponseEnvelopeSuccess 

type HostnameUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	HostnameUpdateResponseEnvelopeSuccessTrue HostnameUpdateResponseEnvelopeSuccess = true
)

type OriginTLSClientAuthDeleteParams 

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

type OriginTLSClientAuthDeleteResponse 

type OriginTLSClientAuthDeleteResponse interface {
	ImplementsOriginTLSClientAuthOriginTLSClientAuthDeleteResponse()
}

Union satisfied by origin_tls_client_auth.OriginTLSClientAuthDeleteResponseUnknown or shared.UnionString.

type OriginTLSClientAuthDeleteResponseEnvelope 

type OriginTLSClientAuthDeleteResponseEnvelope struct {
	Errors   []OriginTLSClientAuthDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OriginTLSClientAuthDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   OriginTLSClientAuthDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success OriginTLSClientAuthDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    originTLSClientAuthDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*OriginTLSClientAuthDeleteResponseEnvelope) UnmarshalJSON 

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

type OriginTLSClientAuthDeleteResponseEnvelopeErrors 

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

func (*OriginTLSClientAuthDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type OriginTLSClientAuthDeleteResponseEnvelopeMessages 

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

func (*OriginTLSClientAuthDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type OriginTLSClientAuthDeleteResponseEnvelopeSuccess 

type OriginTLSClientAuthDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	OriginTLSClientAuthDeleteResponseEnvelopeSuccessTrue OriginTLSClientAuthDeleteResponseEnvelopeSuccess = true
)

type OriginTLSClientAuthGetParams 

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

type OriginTLSClientAuthGetResponse 

type OriginTLSClientAuthGetResponse interface {
	ImplementsOriginTLSClientAuthOriginTLSClientAuthGetResponse()
}

Union satisfied by origin_tls_client_auth.OriginTLSClientAuthGetResponseUnknown or shared.UnionString.

type OriginTLSClientAuthGetResponseEnvelope 

type OriginTLSClientAuthGetResponseEnvelope struct {
	Errors   []OriginTLSClientAuthGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OriginTLSClientAuthGetResponseEnvelopeMessages `json:"messages,required"`
	Result   OriginTLSClientAuthGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success OriginTLSClientAuthGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    originTLSClientAuthGetResponseEnvelopeJSON    `json:"-"`
}

func (*OriginTLSClientAuthGetResponseEnvelope) UnmarshalJSON 

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

type OriginTLSClientAuthGetResponseEnvelopeErrors 

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

func (*OriginTLSClientAuthGetResponseEnvelopeErrors) UnmarshalJSON 

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

type OriginTLSClientAuthGetResponseEnvelopeMessages 

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

func (*OriginTLSClientAuthGetResponseEnvelopeMessages) UnmarshalJSON 

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

type OriginTLSClientAuthGetResponseEnvelopeSuccess 

type OriginTLSClientAuthGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	OriginTLSClientAuthGetResponseEnvelopeSuccessTrue OriginTLSClientAuthGetResponseEnvelopeSuccess = true
)

type OriginTLSClientAuthListParams 

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

type OriginTLSClientAuthListResponse 

type OriginTLSClientAuthListResponse struct {
	// Identifier
	ID string `json:"id"`
	// The zone's leaf certificate.
	Certificate string `json:"certificate"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool `json:"enabled"`
	// The zone's private key.
	PrivateKey string                              `json:"private_key"`
	JSON       originTLSClientAuthListResponseJSON `json:"-"`
}

func (*OriginTLSClientAuthListResponse) UnmarshalJSON 

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

type OriginTLSClientAuthListResponseEnvelope 

type OriginTLSClientAuthListResponseEnvelope struct {
	Errors   []OriginTLSClientAuthListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OriginTLSClientAuthListResponseEnvelopeMessages `json:"messages,required"`
	Result   []OriginTLSClientAuthListResponse                 `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    OriginTLSClientAuthListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo OriginTLSClientAuthListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       originTLSClientAuthListResponseEnvelopeJSON       `json:"-"`
}

func (*OriginTLSClientAuthListResponseEnvelope) UnmarshalJSON 

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

type OriginTLSClientAuthListResponseEnvelopeErrors 

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

func (*OriginTLSClientAuthListResponseEnvelopeErrors) UnmarshalJSON 

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

type OriginTLSClientAuthListResponseEnvelopeMessages 

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

func (*OriginTLSClientAuthListResponseEnvelopeMessages) UnmarshalJSON 

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

type OriginTLSClientAuthListResponseEnvelopeResultInfo 

type OriginTLSClientAuthListResponseEnvelopeResultInfo 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       originTLSClientAuthListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*OriginTLSClientAuthListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type OriginTLSClientAuthListResponseEnvelopeSuccess 

type OriginTLSClientAuthListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	OriginTLSClientAuthListResponseEnvelopeSuccessTrue OriginTLSClientAuthListResponseEnvelopeSuccess = true
)

type OriginTLSClientAuthNewParams 

type OriginTLSClientAuthNewParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The zone's leaf certificate.
	Certificate param.Field[string] `json:"certificate,required"`
	// The zone's private key.
	PrivateKey param.Field[string] `json:"private_key,required"`
}

func (OriginTLSClientAuthNewParams) MarshalJSON 

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

type OriginTLSClientAuthNewResponse 

type OriginTLSClientAuthNewResponse interface {
	ImplementsOriginTLSClientAuthOriginTLSClientAuthNewResponse()
}

Union satisfied by origin_tls_client_auth.OriginTLSClientAuthNewResponseUnknown or shared.UnionString.

type OriginTLSClientAuthNewResponseEnvelope 

type OriginTLSClientAuthNewResponseEnvelope struct {
	Errors   []OriginTLSClientAuthNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OriginTLSClientAuthNewResponseEnvelopeMessages `json:"messages,required"`
	Result   OriginTLSClientAuthNewResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success OriginTLSClientAuthNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    originTLSClientAuthNewResponseEnvelopeJSON    `json:"-"`
}

func (*OriginTLSClientAuthNewResponseEnvelope) UnmarshalJSON 

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

type OriginTLSClientAuthNewResponseEnvelopeErrors 

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

func (*OriginTLSClientAuthNewResponseEnvelopeErrors) UnmarshalJSON 

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

type OriginTLSClientAuthNewResponseEnvelopeMessages 

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

func (*OriginTLSClientAuthNewResponseEnvelopeMessages) UnmarshalJSON 

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

type OriginTLSClientAuthNewResponseEnvelopeSuccess 

type OriginTLSClientAuthNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	OriginTLSClientAuthNewResponseEnvelopeSuccessTrue OriginTLSClientAuthNewResponseEnvelopeSuccess = true
)

type OriginTLSClientAuthService 

type OriginTLSClientAuthService struct {
	Options   []option.RequestOption
	Hostnames *HostnameService
	Settings  *SettingService
}

OriginTLSClientAuthService 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 NewOriginTLSClientAuthService method instead.

func NewOriginTLSClientAuthService 

func NewOriginTLSClientAuthService(opts ...option.RequestOption) (r *OriginTLSClientAuthService)

NewOriginTLSClientAuthService 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 (*OriginTLSClientAuthService) Delete 

func (r *OriginTLSClientAuthService) Delete(ctx context.Context, certificateID string, body OriginTLSClientAuthDeleteParams, opts ...option.RequestOption) (res *OriginTLSClientAuthDeleteResponse, err error)

Delete Certificate

func (*OriginTLSClientAuthService) Get 

func (r *OriginTLSClientAuthService) Get(ctx context.Context, certificateID string, query OriginTLSClientAuthGetParams, opts ...option.RequestOption) (res *OriginTLSClientAuthGetResponse, err error)

Get Certificate Details

func (*OriginTLSClientAuthService) List 

func (r *OriginTLSClientAuthService) List(ctx context.Context, query OriginTLSClientAuthListParams, opts ...option.RequestOption) (res *[]OriginTLSClientAuthListResponse, err error)

List Certificates

func (*OriginTLSClientAuthService) New 

func (r *OriginTLSClientAuthService) New(ctx context.Context, params OriginTLSClientAuthNewParams, opts ...option.RequestOption) (res *OriginTLSClientAuthNewResponse, err error)

Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.

type SettingGetParams 

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

type SettingGetResponse 

type SettingGetResponse struct {
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool                   `json:"enabled"`
	JSON    settingGetResponseJSON `json:"-"`
}

func (*SettingGetResponse) UnmarshalJSON 

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

type SettingGetResponseEnvelope 

type SettingGetResponseEnvelope struct {
	Errors   []SettingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingGetResponseEnvelopeMessages `json:"messages,required"`
	Result   SettingGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success SettingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    settingGetResponseEnvelopeJSON    `json:"-"`
}

func (*SettingGetResponseEnvelope) UnmarshalJSON 

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

type SettingGetResponseEnvelopeErrors 

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

func (*SettingGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingGetResponseEnvelopeMessages 

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

func (*SettingGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingGetResponseEnvelopeSuccess 

type SettingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SettingGetResponseEnvelopeSuccessTrue SettingGetResponseEnvelopeSuccess = true
)

type SettingService 

type SettingService struct {
	Options []option.RequestOption
}

SettingService 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 NewSettingService method instead.

func NewSettingService 

func NewSettingService(opts ...option.RequestOption) (r *SettingService)

NewSettingService 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 (*SettingService) Get 

func (r *SettingService) Get(ctx context.Context, query SettingGetParams, opts ...option.RequestOption) (res *SettingGetResponse, err error)

Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.

func (*SettingService) Update 

func (r *SettingService) Update(ctx context.Context, params SettingUpdateParams, opts ...option.RequestOption) (res *SettingUpdateResponse, err error)

Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.

type SettingUpdateParams 

type SettingUpdateParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled param.Field[bool] `json:"enabled,required"`
}

func (SettingUpdateParams) MarshalJSON 

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

type SettingUpdateResponse 

type SettingUpdateResponse struct {
	// Indicates whether zone-level authenticated origin pulls is enabled.
	Enabled bool                      `json:"enabled"`
	JSON    settingUpdateResponseJSON `json:"-"`
}

func (*SettingUpdateResponse) UnmarshalJSON 

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

type SettingUpdateResponseEnvelope 

type SettingUpdateResponseEnvelope struct {
	Errors   []SettingUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   SettingUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success SettingUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    settingUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*SettingUpdateResponseEnvelope) UnmarshalJSON 

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

type SettingUpdateResponseEnvelopeErrors 

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

func (*SettingUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingUpdateResponseEnvelopeMessages 

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

func (*SettingUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingUpdateResponseEnvelopeSuccess 

type SettingUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SettingUpdateResponseEnvelopeSuccessTrue SettingUpdateResponseEnvelopeSuccess = true
)

type TLSCertificatesAndHostnamesHostnameCertidObject 

type TLSCertificatesAndHostnamesHostnameCertidObject struct {
	// Identifier
	CertID string `json:"cert_id"`
	// Status of the certificate or the association.
	CertStatus TLSCertificatesAndHostnamesHostnameCertidObjectCertStatus `json:"cert_status"`
	// The time when the certificate was updated.
	CertUpdatedAt time.Time `json:"cert_updated_at" format:"date-time"`
	// The time when the certificate was uploaded.
	CertUploadedOn time.Time `json:"cert_uploaded_on" format:"date-time"`
	// The hostname certificate.
	Certificate string `json:"certificate"`
	// The time when the certificate was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Indicates whether hostname-level authenticated origin pulls is enabled. A null
	// value voids the association.
	Enabled bool `json:"enabled,nullable"`
	// The date when the certificate expires.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// The hostname on the origin for which the client certificate uploaded will be
	// used.
	Hostname string `json:"hostname"`
	// The certificate authority that issued the certificate.
	Issuer string `json:"issuer"`
	// The serial number on the uploaded certificate.
	SerialNumber string `json:"serial_number"`
	// The type of hash used for the certificate.
	Signature string `json:"signature"`
	// Status of the certificate or the association.
	Status TLSCertificatesAndHostnamesHostnameCertidObjectStatus `json:"status"`
	// The time when the certificate was updated.
	UpdatedAt time.Time                                           `json:"updated_at" format:"date-time"`
	JSON      tlsCertificatesAndHostnamesHostnameCertidObjectJSON `json:"-"`
}

func (*TLSCertificatesAndHostnamesHostnameCertidObject) UnmarshalJSON 

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

type TLSCertificatesAndHostnamesHostnameCertidObjectCertStatus 

type TLSCertificatesAndHostnamesHostnameCertidObjectCertStatus string

Status of the certificate or the association. 

const (
	TLSCertificatesAndHostnamesHostnameCertidObjectCertStatusInitializing       TLSCertificatesAndHostnamesHostnameCertidObjectCertStatus = "initializing"
	TLSCertificatesAndHostnamesHostnameCertidObjectCertStatusPendingDeployment  TLSCertificatesAndHostnamesHostnameCertidObjectCertStatus = "pending_deployment"
	TLSCertificatesAndHostnamesHostnameCertidObjectCertStatusPendingDeletion    TLSCertificatesAndHostnamesHostnameCertidObjectCertStatus = "pending_deletion"
	TLSCertificatesAndHostnamesHostnameCertidObjectCertStatusActive             TLSCertificatesAndHostnamesHostnameCertidObjectCertStatus = "active"
	TLSCertificatesAndHostnamesHostnameCertidObjectCertStatusDeleted            TLSCertificatesAndHostnamesHostnameCertidObjectCertStatus = "deleted"
	TLSCertificatesAndHostnamesHostnameCertidObjectCertStatusDeploymentTimedOut TLSCertificatesAndHostnamesHostnameCertidObjectCertStatus = "deployment_timed_out"
	TLSCertificatesAndHostnamesHostnameCertidObjectCertStatusDeletionTimedOut   TLSCertificatesAndHostnamesHostnameCertidObjectCertStatus = "deletion_timed_out"
)

type TLSCertificatesAndHostnamesHostnameCertidObjectStatus 

type TLSCertificatesAndHostnamesHostnameCertidObjectStatus string

Status of the certificate or the association. 

const (
	TLSCertificatesAndHostnamesHostnameCertidObjectStatusInitializing       TLSCertificatesAndHostnamesHostnameCertidObjectStatus = "initializing"
	TLSCertificatesAndHostnamesHostnameCertidObjectStatusPendingDeployment  TLSCertificatesAndHostnamesHostnameCertidObjectStatus = "pending_deployment"
	TLSCertificatesAndHostnamesHostnameCertidObjectStatusPendingDeletion    TLSCertificatesAndHostnamesHostnameCertidObjectStatus = "pending_deletion"
	TLSCertificatesAndHostnamesHostnameCertidObjectStatusActive             TLSCertificatesAndHostnamesHostnameCertidObjectStatus = "active"
	TLSCertificatesAndHostnamesHostnameCertidObjectStatusDeleted            TLSCertificatesAndHostnamesHostnameCertidObjectStatus = "deleted"
	TLSCertificatesAndHostnamesHostnameCertidObjectStatusDeploymentTimedOut TLSCertificatesAndHostnamesHostnameCertidObjectStatus = "deployment_timed_out"
	TLSCertificatesAndHostnamesHostnameCertidObjectStatusDeletionTimedOut   TLSCertificatesAndHostnamesHostnameCertidObjectStatus = "deletion_timed_out"
)

type TLSCertificatesAndHostnamesSchemasCertificateObject 

type TLSCertificatesAndHostnamesSchemasCertificateObject struct {
	// Identifier
	ID string `json:"id"`
	// The hostname certificate.
	Certificate string `json:"certificate"`
	// The date when the certificate expires.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// The certificate authority that issued the certificate.
	Issuer string `json:"issuer"`
	// The serial number on the uploaded certificate.
	SerialNumber string `json:"serial_number"`
	// The type of hash used for the certificate.
	Signature string `json:"signature"`
	// Status of the certificate or the association.
	Status TLSCertificatesAndHostnamesSchemasCertificateObjectStatus `json:"status"`
	// The time when the certificate was uploaded.
	UploadedOn time.Time                                               `json:"uploaded_on" format:"date-time"`
	JSON       tlsCertificatesAndHostnamesSchemasCertificateObjectJSON `json:"-"`
}

func (*TLSCertificatesAndHostnamesSchemasCertificateObject) UnmarshalJSON 

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

type TLSCertificatesAndHostnamesSchemasCertificateObjectStatus 

type TLSCertificatesAndHostnamesSchemasCertificateObjectStatus string

Status of the certificate or the association. 

const (
	TLSCertificatesAndHostnamesSchemasCertificateObjectStatusInitializing       TLSCertificatesAndHostnamesSchemasCertificateObjectStatus = "initializing"
	TLSCertificatesAndHostnamesSchemasCertificateObjectStatusPendingDeployment  TLSCertificatesAndHostnamesSchemasCertificateObjectStatus = "pending_deployment"
	TLSCertificatesAndHostnamesSchemasCertificateObjectStatusPendingDeletion    TLSCertificatesAndHostnamesSchemasCertificateObjectStatus = "pending_deletion"
	TLSCertificatesAndHostnamesSchemasCertificateObjectStatusActive             TLSCertificatesAndHostnamesSchemasCertificateObjectStatus = "active"
	TLSCertificatesAndHostnamesSchemasCertificateObjectStatusDeleted            TLSCertificatesAndHostnamesSchemasCertificateObjectStatus = "deleted"
	TLSCertificatesAndHostnamesSchemasCertificateObjectStatusDeploymentTimedOut TLSCertificatesAndHostnamesSchemasCertificateObjectStatus = "deployment_timed_out"
	TLSCertificatesAndHostnamesSchemasCertificateObjectStatusDeletionTimedOut   TLSCertificatesAndHostnamesSchemasCertificateObjectStatus = "deletion_timed_out"
)

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.