mtls_certificates

package
v4.4.0 Latest Latest
Warning

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

 Go to latest Published: May 16, 2025 License: Apache-2.0 Imports: 12 Imported by: 1

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

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 AssociationGetParams 

type AssociationGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type AssociationService 

type AssociationService struct {
	Options []option.RequestOption
}

AssociationService 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 NewAssociationService method instead.

func NewAssociationService 

func NewAssociationService(opts ...option.RequestOption) (r *AssociationService)

NewAssociationService 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 (*AssociationService) Get 

func (r *AssociationService) Get(ctx context.Context, mtlsCertificateID string, query AssociationGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[CertificateAsssociation], err error)

Lists all active associations between the certificate and Cloudflare services.

func (*AssociationService) GetAutoPaging added in v4.1.0 

func (r *AssociationService) GetAutoPaging(ctx context.Context, mtlsCertificateID string, query AssociationGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[CertificateAsssociation]

Lists all active associations between the certificate and Cloudflare services.

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 CertificateAsssociation 

type CertificateAsssociation struct {
	// The service using the certificate.
	Service string `json:"service"`
	// Certificate deployment status for the given service.
	Status string                      `json:"status"`
	JSON   certificateAsssociationJSON `json:"-"`
}

func (*CertificateAsssociation) UnmarshalJSON 

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

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

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 CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

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 ErrorDataSource added in v4.2.0 

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type MTLSCertificate 

type MTLSCertificate struct {
	// Identifier.
	ID string `json:"id"`
	// Indicates whether the certificate is a CA or leaf certificate.
	CA bool `json:"ca"`
	// The uploaded root CA certificate.
	Certificates string `json:"certificates"`
	// When the certificate expires.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// The certificate authority that issued the certificate.
	Issuer string `json:"issuer"`
	// Optional unique name for the certificate. Only used for human readability.
	Name string `json:"name"`
	// The certificate serial number.
	SerialNumber string `json:"serial_number"`
	// The type of hash used for the certificate.
	Signature string `json:"signature"`
	// This is the time the certificate was uploaded.
	UploadedOn time.Time           `json:"uploaded_on" format:"date-time"`
	JSON       mtlsCertificateJSON `json:"-"`
}

func (*MTLSCertificate) UnmarshalJSON 

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

type MTLSCertificateDeleteParams 

type MTLSCertificateDeleteParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type MTLSCertificateDeleteResponseEnvelope 

type MTLSCertificateDeleteResponseEnvelope struct {
	Errors   []MTLSCertificateDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []MTLSCertificateDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success MTLSCertificateDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  MTLSCertificate                              `json:"result"`
	JSON    mtlsCertificateDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*MTLSCertificateDeleteResponseEnvelope) UnmarshalJSON 

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

type MTLSCertificateDeleteResponseEnvelopeErrors added in v4.3.0 

type MTLSCertificateDeleteResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           MTLSCertificateDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             mtlsCertificateDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*MTLSCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateDeleteResponseEnvelopeErrorsSource added in v4.3.0 

type MTLSCertificateDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    mtlsCertificateDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*MTLSCertificateDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateDeleteResponseEnvelopeMessages added in v4.3.0 

type MTLSCertificateDeleteResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code,required"`
	Message          string                                              `json:"message,required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           MTLSCertificateDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             mtlsCertificateDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*MTLSCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateDeleteResponseEnvelopeMessagesSource added in v4.3.0 

type MTLSCertificateDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    mtlsCertificateDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*MTLSCertificateDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateDeleteResponseEnvelopeSuccess 

type MTLSCertificateDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	MTLSCertificateDeleteResponseEnvelopeSuccessTrue MTLSCertificateDeleteResponseEnvelopeSuccess = true
)

func (MTLSCertificateDeleteResponseEnvelopeSuccess) IsKnown 

func (r MTLSCertificateDeleteResponseEnvelopeSuccess) IsKnown() bool

type MTLSCertificateGetParams 

type MTLSCertificateGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type MTLSCertificateGetResponseEnvelope 

type MTLSCertificateGetResponseEnvelope struct {
	Errors   []MTLSCertificateGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []MTLSCertificateGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success MTLSCertificateGetResponseEnvelopeSuccess `json:"success,required"`
	Result  MTLSCertificate                           `json:"result"`
	JSON    mtlsCertificateGetResponseEnvelopeJSON    `json:"-"`
}

func (*MTLSCertificateGetResponseEnvelope) UnmarshalJSON 

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

type MTLSCertificateGetResponseEnvelopeErrors added in v4.3.0 

type MTLSCertificateGetResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           MTLSCertificateGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             mtlsCertificateGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*MTLSCertificateGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateGetResponseEnvelopeErrorsSource added in v4.3.0 

type MTLSCertificateGetResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    mtlsCertificateGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*MTLSCertificateGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateGetResponseEnvelopeMessages added in v4.3.0 

type MTLSCertificateGetResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           MTLSCertificateGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             mtlsCertificateGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*MTLSCertificateGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateGetResponseEnvelopeMessagesSource added in v4.3.0 

type MTLSCertificateGetResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    mtlsCertificateGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*MTLSCertificateGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateGetResponseEnvelopeSuccess 

type MTLSCertificateGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	MTLSCertificateGetResponseEnvelopeSuccessTrue MTLSCertificateGetResponseEnvelopeSuccess = true
)

func (MTLSCertificateGetResponseEnvelopeSuccess) IsKnown 

func (r MTLSCertificateGetResponseEnvelopeSuccess) IsKnown() bool

type MTLSCertificateListParams 

type MTLSCertificateListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type MTLSCertificateNewParams 

type MTLSCertificateNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Indicates whether the certificate is a CA or leaf certificate.
	CA param.Field[bool] `json:"ca,required"`
	// The uploaded root CA certificate.
	Certificates param.Field[string] `json:"certificates,required"`
	// Optional unique name for the certificate. Only used for human readability.
	Name param.Field[string] `json:"name"`
	// The private key for the certificate. This field is only needed for specific use
	// cases such as using a custom certificate with Zero Trust's block page.
	PrivateKey param.Field[string] `json:"private_key"`
}

func (MTLSCertificateNewParams) MarshalJSON 

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

type MTLSCertificateNewResponse 

type MTLSCertificateNewResponse struct {
	// Identifier.
	ID string `json:"id"`
	// Indicates whether the certificate is a CA or leaf certificate.
	CA bool `json:"ca"`
	// The uploaded root CA certificate.
	Certificates string `json:"certificates"`
	// When the certificate expires.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// The certificate authority that issued the certificate.
	Issuer string `json:"issuer"`
	// Optional unique name for the certificate. Only used for human readability.
	Name string `json:"name"`
	// The certificate serial number.
	SerialNumber string `json:"serial_number"`
	// The type of hash used for the certificate.
	Signature string `json:"signature"`
	// This is the time the certificate was updated.
	UpdatedAt time.Time `json:"updated_at" format:"date-time"`
	// This is the time the certificate was uploaded.
	UploadedOn time.Time                      `json:"uploaded_on" format:"date-time"`
	JSON       mtlsCertificateNewResponseJSON `json:"-"`
}

func (*MTLSCertificateNewResponse) UnmarshalJSON 

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

type MTLSCertificateNewResponseEnvelope 

type MTLSCertificateNewResponseEnvelope struct {
	Errors   []MTLSCertificateNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []MTLSCertificateNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success MTLSCertificateNewResponseEnvelopeSuccess `json:"success,required"`
	Result  MTLSCertificateNewResponse                `json:"result"`
	JSON    mtlsCertificateNewResponseEnvelopeJSON    `json:"-"`
}

func (*MTLSCertificateNewResponseEnvelope) UnmarshalJSON 

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

type MTLSCertificateNewResponseEnvelopeErrors added in v4.3.0 

type MTLSCertificateNewResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           MTLSCertificateNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             mtlsCertificateNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*MTLSCertificateNewResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateNewResponseEnvelopeErrorsSource added in v4.3.0 

type MTLSCertificateNewResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    mtlsCertificateNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*MTLSCertificateNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateNewResponseEnvelopeMessages added in v4.3.0 

type MTLSCertificateNewResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           MTLSCertificateNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             mtlsCertificateNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*MTLSCertificateNewResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateNewResponseEnvelopeMessagesSource added in v4.3.0 

type MTLSCertificateNewResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    mtlsCertificateNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*MTLSCertificateNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0 

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

type MTLSCertificateNewResponseEnvelopeSuccess 

type MTLSCertificateNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	MTLSCertificateNewResponseEnvelopeSuccessTrue MTLSCertificateNewResponseEnvelopeSuccess = true
)

func (MTLSCertificateNewResponseEnvelopeSuccess) IsKnown 

func (r MTLSCertificateNewResponseEnvelopeSuccess) IsKnown() bool

type MTLSCertificateService 

type MTLSCertificateService struct {
	Options      []option.RequestOption
	Associations *AssociationService
}

MTLSCertificateService 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 NewMTLSCertificateService method instead.

func NewMTLSCertificateService 

func NewMTLSCertificateService(opts ...option.RequestOption) (r *MTLSCertificateService)

NewMTLSCertificateService 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 (*MTLSCertificateService) Delete 

func (r *MTLSCertificateService) Delete(ctx context.Context, mtlsCertificateID string, body MTLSCertificateDeleteParams, opts ...option.RequestOption) (res *MTLSCertificate, err error)

Deletes the mTLS certificate unless the certificate is in use by one or more Cloudflare services.

func (*MTLSCertificateService) Get 

func (r *MTLSCertificateService) Get(ctx context.Context, mtlsCertificateID string, query MTLSCertificateGetParams, opts ...option.RequestOption) (res *MTLSCertificate, err error)

Fetches a single mTLS certificate.

func (*MTLSCertificateService) List 

func (r *MTLSCertificateService) List(ctx context.Context, query MTLSCertificateListParams, opts ...option.RequestOption) (res *pagination.SinglePage[MTLSCertificate], err error)

Lists all mTLS certificates.

func (*MTLSCertificateService) ListAutoPaging 

func (r *MTLSCertificateService) ListAutoPaging(ctx context.Context, query MTLSCertificateListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[MTLSCertificate]

Lists all mTLS certificates.

func (*MTLSCertificateService) New 

func (r *MTLSCertificateService) New(ctx context.Context, params MTLSCertificateNewParams, opts ...option.RequestOption) (res *MTLSCertificateNewResponse, err error)

Upload a certificate that you want to use with mTLS-enabled Cloudflare services.

type Member 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser 

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

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 RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID added in v4.1.0 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource added in v4.3.0 

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenStatus 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue 

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

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.