diagnostics

package
v6.6.0 Latest Latest
Warning

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

Go to latest
Published: Jan 16, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

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 CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

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 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 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 CloudflareTunnelConfigSrc

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

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 DiagnosticService

type DiagnosticService struct {
	Options              []option.RequestOption
	Traceroutes          *TracerouteService
	EndpointHealthchecks *EndpointHealthcheckService
}

DiagnosticService 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 NewDiagnosticService method instead.

func NewDiagnosticService

func NewDiagnosticService(opts ...option.RequestOption) (r *DiagnosticService)

NewDiagnosticService 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 EndpointHealthcheckCheckType

type EndpointHealthcheckCheckType string

type of check to perform

const (
	EndpointHealthcheckCheckTypeIcmp EndpointHealthcheckCheckType = "icmp"
)

func (EndpointHealthcheckCheckType) IsKnown

func (r EndpointHealthcheckCheckType) IsKnown() bool

type EndpointHealthcheckDeleteParams

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

type EndpointHealthcheckDeleteResponse

type EndpointHealthcheckDeleteResponse struct {
	Errors   []EndpointHealthcheckDeleteResponseError   `json:"errors,required"`
	Messages []EndpointHealthcheckDeleteResponseMessage `json:"messages,required"`
	// Whether the API call was successful.
	Success EndpointHealthcheckDeleteResponseSuccess `json:"success,required"`
	JSON    endpointHealthcheckDeleteResponseJSON    `json:"-"`
}

func (*EndpointHealthcheckDeleteResponse) UnmarshalJSON

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

type EndpointHealthcheckDeleteResponseError

type EndpointHealthcheckDeleteResponseError struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           EndpointHealthcheckDeleteResponseErrorsSource `json:"source"`
	JSON             endpointHealthcheckDeleteResponseErrorJSON    `json:"-"`
}

func (*EndpointHealthcheckDeleteResponseError) UnmarshalJSON

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

type EndpointHealthcheckDeleteResponseErrorsSource

type EndpointHealthcheckDeleteResponseErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    endpointHealthcheckDeleteResponseErrorsSourceJSON `json:"-"`
}

func (*EndpointHealthcheckDeleteResponseErrorsSource) UnmarshalJSON

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

type EndpointHealthcheckDeleteResponseMessage

type EndpointHealthcheckDeleteResponseMessage struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           EndpointHealthcheckDeleteResponseMessagesSource `json:"source"`
	JSON             endpointHealthcheckDeleteResponseMessageJSON    `json:"-"`
}

func (*EndpointHealthcheckDeleteResponseMessage) UnmarshalJSON

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

type EndpointHealthcheckDeleteResponseMessagesSource

type EndpointHealthcheckDeleteResponseMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    endpointHealthcheckDeleteResponseMessagesSourceJSON `json:"-"`
}

func (*EndpointHealthcheckDeleteResponseMessagesSource) UnmarshalJSON

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

type EndpointHealthcheckDeleteResponseSuccess

type EndpointHealthcheckDeleteResponseSuccess bool

Whether the API call was successful.

const (
	EndpointHealthcheckDeleteResponseSuccessTrue EndpointHealthcheckDeleteResponseSuccess = true
)

func (EndpointHealthcheckDeleteResponseSuccess) IsKnown

type EndpointHealthcheckGetParams

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

type EndpointHealthcheckGetResponse

type EndpointHealthcheckGetResponse struct {
	// type of check to perform
	CheckType EndpointHealthcheckGetResponseCheckType `json:"check_type,required"`
	// the IP address of the host to perform checks against
	Endpoint string `json:"endpoint,required"`
	// UUID.
	ID string `json:"id"`
	// Optional name associated with this check
	Name string                             `json:"name"`
	JSON endpointHealthcheckGetResponseJSON `json:"-"`
}

func (*EndpointHealthcheckGetResponse) UnmarshalJSON

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

type EndpointHealthcheckGetResponseCheckType

type EndpointHealthcheckGetResponseCheckType string

type of check to perform

const (
	EndpointHealthcheckGetResponseCheckTypeIcmp EndpointHealthcheckGetResponseCheckType = "icmp"
)

func (EndpointHealthcheckGetResponseCheckType) IsKnown

type EndpointHealthcheckGetResponseEnvelope

type EndpointHealthcheckGetResponseEnvelope struct {
	Errors   []EndpointHealthcheckGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []EndpointHealthcheckGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success EndpointHealthcheckGetResponseEnvelopeSuccess `json:"success,required"`
	Result  EndpointHealthcheckGetResponse                `json:"result"`
	JSON    endpointHealthcheckGetResponseEnvelopeJSON    `json:"-"`
}

func (*EndpointHealthcheckGetResponseEnvelope) UnmarshalJSON

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

type EndpointHealthcheckGetResponseEnvelopeErrors

type EndpointHealthcheckGetResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           EndpointHealthcheckGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             endpointHealthcheckGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*EndpointHealthcheckGetResponseEnvelopeErrors) UnmarshalJSON

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

type EndpointHealthcheckGetResponseEnvelopeErrorsSource

type EndpointHealthcheckGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    endpointHealthcheckGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*EndpointHealthcheckGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type EndpointHealthcheckGetResponseEnvelopeMessages

type EndpointHealthcheckGetResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code,required"`
	Message          string                                               `json:"message,required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           EndpointHealthcheckGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             endpointHealthcheckGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*EndpointHealthcheckGetResponseEnvelopeMessages) UnmarshalJSON

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

type EndpointHealthcheckGetResponseEnvelopeMessagesSource

type EndpointHealthcheckGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    endpointHealthcheckGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*EndpointHealthcheckGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type EndpointHealthcheckGetResponseEnvelopeSuccess

type EndpointHealthcheckGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	EndpointHealthcheckGetResponseEnvelopeSuccessTrue EndpointHealthcheckGetResponseEnvelopeSuccess = true
)

func (EndpointHealthcheckGetResponseEnvelopeSuccess) IsKnown

type EndpointHealthcheckListParams

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

type EndpointHealthcheckListResponse

type EndpointHealthcheckListResponse struct {
	// type of check to perform
	CheckType EndpointHealthcheckListResponseCheckType `json:"check_type,required"`
	// the IP address of the host to perform checks against
	Endpoint string `json:"endpoint,required"`
	// UUID.
	ID string `json:"id"`
	// Optional name associated with this check
	Name string                              `json:"name"`
	JSON endpointHealthcheckListResponseJSON `json:"-"`
}

func (*EndpointHealthcheckListResponse) UnmarshalJSON

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

type EndpointHealthcheckListResponseCheckType

type EndpointHealthcheckListResponseCheckType string

type of check to perform

const (
	EndpointHealthcheckListResponseCheckTypeIcmp EndpointHealthcheckListResponseCheckType = "icmp"
)

func (EndpointHealthcheckListResponseCheckType) IsKnown

type EndpointHealthcheckListResponseEnvelope

type EndpointHealthcheckListResponseEnvelope struct {
	Errors   []EndpointHealthcheckListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []EndpointHealthcheckListResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success EndpointHealthcheckListResponseEnvelopeSuccess `json:"success,required"`
	Result  EndpointHealthcheckListResponse                `json:"result"`
	JSON    endpointHealthcheckListResponseEnvelopeJSON    `json:"-"`
}

func (*EndpointHealthcheckListResponseEnvelope) UnmarshalJSON

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

type EndpointHealthcheckListResponseEnvelopeErrors

type EndpointHealthcheckListResponseEnvelopeErrors struct {
	Code             int64                                               `json:"code,required"`
	Message          string                                              `json:"message,required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           EndpointHealthcheckListResponseEnvelopeErrorsSource `json:"source"`
	JSON             endpointHealthcheckListResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*EndpointHealthcheckListResponseEnvelopeErrors) UnmarshalJSON

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

type EndpointHealthcheckListResponseEnvelopeErrorsSource

type EndpointHealthcheckListResponseEnvelopeErrorsSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    endpointHealthcheckListResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*EndpointHealthcheckListResponseEnvelopeErrorsSource) UnmarshalJSON

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

type EndpointHealthcheckListResponseEnvelopeMessages

type EndpointHealthcheckListResponseEnvelopeMessages struct {
	Code             int64                                                 `json:"code,required"`
	Message          string                                                `json:"message,required"`
	DocumentationURL string                                                `json:"documentation_url"`
	Source           EndpointHealthcheckListResponseEnvelopeMessagesSource `json:"source"`
	JSON             endpointHealthcheckListResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*EndpointHealthcheckListResponseEnvelopeMessages) UnmarshalJSON

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

type EndpointHealthcheckListResponseEnvelopeMessagesSource

type EndpointHealthcheckListResponseEnvelopeMessagesSource struct {
	Pointer string                                                    `json:"pointer"`
	JSON    endpointHealthcheckListResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*EndpointHealthcheckListResponseEnvelopeMessagesSource) UnmarshalJSON

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

type EndpointHealthcheckListResponseEnvelopeSuccess

type EndpointHealthcheckListResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	EndpointHealthcheckListResponseEnvelopeSuccessTrue EndpointHealthcheckListResponseEnvelopeSuccess = true
)

func (EndpointHealthcheckListResponseEnvelopeSuccess) IsKnown

type EndpointHealthcheckNewParams

type EndpointHealthcheckNewParams struct {
	// Identifier
	AccountID           param.Field[string]      `path:"account_id,required"`
	EndpointHealthcheck EndpointHealthcheckParam `json:"endpoint_healthcheck,required"`
}

func (EndpointHealthcheckNewParams) MarshalJSON

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

type EndpointHealthcheckNewResponse

type EndpointHealthcheckNewResponse struct {
	// type of check to perform
	CheckType EndpointHealthcheckNewResponseCheckType `json:"check_type,required"`
	// the IP address of the host to perform checks against
	Endpoint string `json:"endpoint,required"`
	// UUID.
	ID string `json:"id"`
	// Optional name associated with this check
	Name string                             `json:"name"`
	JSON endpointHealthcheckNewResponseJSON `json:"-"`
}

func (*EndpointHealthcheckNewResponse) UnmarshalJSON

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

type EndpointHealthcheckNewResponseCheckType

type EndpointHealthcheckNewResponseCheckType string

type of check to perform

const (
	EndpointHealthcheckNewResponseCheckTypeIcmp EndpointHealthcheckNewResponseCheckType = "icmp"
)

func (EndpointHealthcheckNewResponseCheckType) IsKnown

type EndpointHealthcheckNewResponseEnvelope

type EndpointHealthcheckNewResponseEnvelope struct {
	Errors   []EndpointHealthcheckNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []EndpointHealthcheckNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success EndpointHealthcheckNewResponseEnvelopeSuccess `json:"success,required"`
	Result  EndpointHealthcheckNewResponse                `json:"result"`
	JSON    endpointHealthcheckNewResponseEnvelopeJSON    `json:"-"`
}

func (*EndpointHealthcheckNewResponseEnvelope) UnmarshalJSON

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

type EndpointHealthcheckNewResponseEnvelopeErrors

type EndpointHealthcheckNewResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           EndpointHealthcheckNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             endpointHealthcheckNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*EndpointHealthcheckNewResponseEnvelopeErrors) UnmarshalJSON

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

type EndpointHealthcheckNewResponseEnvelopeErrorsSource

type EndpointHealthcheckNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    endpointHealthcheckNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*EndpointHealthcheckNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type EndpointHealthcheckNewResponseEnvelopeMessages

type EndpointHealthcheckNewResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code,required"`
	Message          string                                               `json:"message,required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           EndpointHealthcheckNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             endpointHealthcheckNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*EndpointHealthcheckNewResponseEnvelopeMessages) UnmarshalJSON

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

type EndpointHealthcheckNewResponseEnvelopeMessagesSource

type EndpointHealthcheckNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    endpointHealthcheckNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*EndpointHealthcheckNewResponseEnvelopeMessagesSource) UnmarshalJSON

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

type EndpointHealthcheckNewResponseEnvelopeSuccess

type EndpointHealthcheckNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	EndpointHealthcheckNewResponseEnvelopeSuccessTrue EndpointHealthcheckNewResponseEnvelopeSuccess = true
)

func (EndpointHealthcheckNewResponseEnvelopeSuccess) IsKnown

type EndpointHealthcheckParam

type EndpointHealthcheckParam struct {
	// type of check to perform
	CheckType param.Field[EndpointHealthcheckCheckType] `json:"check_type,required"`
	// the IP address of the host to perform checks against
	Endpoint param.Field[string] `json:"endpoint,required"`
	// Optional name associated with this check
	Name param.Field[string] `json:"name"`
}

func (EndpointHealthcheckParam) MarshalJSON

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

type EndpointHealthcheckService

type EndpointHealthcheckService struct {
	Options []option.RequestOption
}

EndpointHealthcheckService 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 NewEndpointHealthcheckService method instead.

func NewEndpointHealthcheckService

func NewEndpointHealthcheckService(opts ...option.RequestOption) (r *EndpointHealthcheckService)

NewEndpointHealthcheckService 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 (*EndpointHealthcheckService) Delete

Delete Endpoint Health Check.

func (*EndpointHealthcheckService) Get

Get a single Endpoint Health Check.

func (*EndpointHealthcheckService) List

List Endpoint Health Checks.

func (*EndpointHealthcheckService) New

Create Endpoint Health Check.

func (*EndpointHealthcheckService) Update

Update a Endpoint Health Check.

type EndpointHealthcheckUpdateParams

type EndpointHealthcheckUpdateParams struct {
	// Identifier
	AccountID           param.Field[string]      `path:"account_id,required"`
	EndpointHealthcheck EndpointHealthcheckParam `json:"endpoint_healthcheck,required"`
}

func (EndpointHealthcheckUpdateParams) MarshalJSON

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

type EndpointHealthcheckUpdateResponse

type EndpointHealthcheckUpdateResponse struct {
	// type of check to perform
	CheckType EndpointHealthcheckUpdateResponseCheckType `json:"check_type,required"`
	// the IP address of the host to perform checks against
	Endpoint string `json:"endpoint,required"`
	// UUID.
	ID string `json:"id"`
	// Optional name associated with this check
	Name string                                `json:"name"`
	JSON endpointHealthcheckUpdateResponseJSON `json:"-"`
}

func (*EndpointHealthcheckUpdateResponse) UnmarshalJSON

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

type EndpointHealthcheckUpdateResponseCheckType

type EndpointHealthcheckUpdateResponseCheckType string

type of check to perform

const (
	EndpointHealthcheckUpdateResponseCheckTypeIcmp EndpointHealthcheckUpdateResponseCheckType = "icmp"
)

func (EndpointHealthcheckUpdateResponseCheckType) IsKnown

type EndpointHealthcheckUpdateResponseEnvelope

type EndpointHealthcheckUpdateResponseEnvelope struct {
	Errors   []EndpointHealthcheckUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []EndpointHealthcheckUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success EndpointHealthcheckUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  EndpointHealthcheckUpdateResponse                `json:"result"`
	JSON    endpointHealthcheckUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*EndpointHealthcheckUpdateResponseEnvelope) UnmarshalJSON

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

type EndpointHealthcheckUpdateResponseEnvelopeErrors

type EndpointHealthcheckUpdateResponseEnvelopeErrors struct {
	Code             int64                                                 `json:"code,required"`
	Message          string                                                `json:"message,required"`
	DocumentationURL string                                                `json:"documentation_url"`
	Source           EndpointHealthcheckUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             endpointHealthcheckUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*EndpointHealthcheckUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type EndpointHealthcheckUpdateResponseEnvelopeErrorsSource

type EndpointHealthcheckUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                                    `json:"pointer"`
	JSON    endpointHealthcheckUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*EndpointHealthcheckUpdateResponseEnvelopeErrorsSource) UnmarshalJSON

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

type EndpointHealthcheckUpdateResponseEnvelopeMessages

type EndpointHealthcheckUpdateResponseEnvelopeMessages struct {
	Code             int64                                                   `json:"code,required"`
	Message          string                                                  `json:"message,required"`
	DocumentationURL string                                                  `json:"documentation_url"`
	Source           EndpointHealthcheckUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             endpointHealthcheckUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*EndpointHealthcheckUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type EndpointHealthcheckUpdateResponseEnvelopeMessagesSource

type EndpointHealthcheckUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                      `json:"pointer"`
	JSON    endpointHealthcheckUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*EndpointHealthcheckUpdateResponseEnvelopeMessagesSource) UnmarshalJSON

type EndpointHealthcheckUpdateResponseEnvelopeSuccess

type EndpointHealthcheckUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	EndpointHealthcheckUpdateResponseEnvelopeSuccessTrue EndpointHealthcheckUpdateResponseEnvelopeSuccess = true
)

func (EndpointHealthcheckUpdateResponseEnvelopeSuccess) IsKnown

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

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

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

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 TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

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.

type Traceroute

type Traceroute struct {
	Colos []TracerouteColo `json:"colos"`
	// The target hostname, IPv6, or IPv6 address.
	Target string         `json:"target"`
	JSON   tracerouteJSON `json:"-"`
}

func (*Traceroute) UnmarshalJSON

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

type TracerouteColo

type TracerouteColo struct {
	Colo TracerouteColosColo `json:"colo"`
	// Errors resulting from collecting traceroute from colo to target.
	Error TracerouteColosError `json:"error"`
	Hops  []TracerouteColosHop `json:"hops"`
	// Aggregated statistics from all hops about the target.
	TargetSummary interface{} `json:"target_summary"`
	// Total time of traceroute in ms.
	TracerouteTimeMs int64              `json:"traceroute_time_ms"`
	JSON             tracerouteColoJSON `json:"-"`
}

func (*TracerouteColo) UnmarshalJSON

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

type TracerouteColosColo

type TracerouteColosColo struct {
	// Source colo city.
	City string `json:"city"`
	// Source colo name.
	Name string                  `json:"name"`
	JSON tracerouteColosColoJSON `json:"-"`
}

func (*TracerouteColosColo) UnmarshalJSON

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

type TracerouteColosError

type TracerouteColosError string

Errors resulting from collecting traceroute from colo to target.

const (
	TracerouteColosErrorEmpty                             TracerouteColosError = ""
	TracerouteColosErrorCouldNotGatherTracerouteDataCode1 TracerouteColosError = "Could not gather traceroute data: Code 1"
	TracerouteColosErrorCouldNotGatherTracerouteDataCode2 TracerouteColosError = "Could not gather traceroute data: Code 2"
	TracerouteColosErrorCouldNotGatherTracerouteDataCode3 TracerouteColosError = "Could not gather traceroute data: Code 3"
	TracerouteColosErrorCouldNotGatherTracerouteDataCode4 TracerouteColosError = "Could not gather traceroute data: Code 4"
)

func (TracerouteColosError) IsKnown

func (r TracerouteColosError) IsKnown() bool

type TracerouteColosHop

type TracerouteColosHop struct {
	// An array of node objects.
	Nodes []TracerouteColosHopsNode `json:"nodes"`
	// Number of packets where no response was received.
	PacketsLost int64 `json:"packets_lost"`
	// Number of packets sent with specified TTL.
	PacketsSent int64 `json:"packets_sent"`
	// The time to live (TTL).
	PacketsTTL int64                  `json:"packets_ttl"`
	JSON       tracerouteColosHopJSON `json:"-"`
}

func (*TracerouteColosHop) UnmarshalJSON

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

type TracerouteColosHopsNode

type TracerouteColosHopsNode struct {
	// AS number associated with the node object.
	ASN string `json:"asn"`
	// IP address of the node.
	IP string `json:"ip"`
	// Field appears if there is an additional annotation printed when the probe
	// returns. Field also appears when running a GRE+ICMP traceroute to denote which
	// traceroute a node comes from.
	Labels []string `json:"labels"`
	// Maximum RTT in ms.
	MaxRTTMs float64 `json:"max_rtt_ms"`
	// Mean RTT in ms.
	MeanRTTMs float64 `json:"mean_rtt_ms"`
	// Minimum RTT in ms.
	MinRTTMs float64 `json:"min_rtt_ms"`
	// Host name of the address, this may be the same as the IP address.
	Name string `json:"name"`
	// Number of packets with a response from this node.
	PacketCount int64 `json:"packet_count"`
	// Standard deviation of the RTTs in ms.
	StdDevRTTMs float64                     `json:"std_dev_rtt_ms"`
	JSON        tracerouteColosHopsNodeJSON `json:"-"`
}

func (*TracerouteColosHopsNode) UnmarshalJSON

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

type TracerouteNewParams

type TracerouteNewParams struct {
	// Identifier
	AccountID param.Field[string]   `path:"account_id,required"`
	Targets   param.Field[[]string] `json:"targets,required"`
	// If no source colo names specified, all colos will be used. China colos are
	// unavailable for traceroutes.
	Colos   param.Field[[]string]                   `json:"colos"`
	Options param.Field[TracerouteNewParamsOptions] `json:"options"`
}

func (TracerouteNewParams) MarshalJSON

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

type TracerouteNewParamsOptions

type TracerouteNewParamsOptions struct {
	// Max TTL.
	MaxTTL param.Field[int64] `json:"max_ttl"`
	// Type of packet sent.
	PacketType param.Field[TracerouteNewParamsOptionsPacketType] `json:"packet_type"`
	// Number of packets sent at each TTL.
	PacketsPerTTL param.Field[int64] `json:"packets_per_ttl"`
	// For UDP and TCP, specifies the destination port. For ICMP, specifies the initial
	// ICMP sequence value. Default value 0 will choose the best value to use for each
	// protocol.
	Port param.Field[int64] `json:"port"`
	// Set the time (in seconds) to wait for a response to a probe.
	WaitTime param.Field[int64] `json:"wait_time"`
}

func (TracerouteNewParamsOptions) MarshalJSON

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

type TracerouteNewParamsOptionsPacketType

type TracerouteNewParamsOptionsPacketType string

Type of packet sent.

const (
	TracerouteNewParamsOptionsPacketTypeIcmp    TracerouteNewParamsOptionsPacketType = "icmp"
	TracerouteNewParamsOptionsPacketTypeTCP     TracerouteNewParamsOptionsPacketType = "tcp"
	TracerouteNewParamsOptionsPacketTypeUdp     TracerouteNewParamsOptionsPacketType = "udp"
	TracerouteNewParamsOptionsPacketTypeGRE     TracerouteNewParamsOptionsPacketType = "gre"
	TracerouteNewParamsOptionsPacketTypeGREIcmp TracerouteNewParamsOptionsPacketType = "gre+icmp"
)

func (TracerouteNewParamsOptionsPacketType) IsKnown

type TracerouteService

type TracerouteService struct {
	Options []option.RequestOption
}

TracerouteService 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 NewTracerouteService method instead.

func NewTracerouteService

func NewTracerouteService(opts ...option.RequestOption) (r *TracerouteService)

NewTracerouteService 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 (*TracerouteService) New

Run traceroutes from Cloudflare colos.

func (*TracerouteService) NewAutoPaging

Run traceroutes from Cloudflare colos.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL