addressing

package
v4.0.0-...-c4abdee Latest Latest
Warning

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

 Go to latest Published: Dec 11, 2024 License: Apache-2.0 Imports: 15 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 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 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 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 AddressMap 

type AddressMap struct {
	// Identifier
	ID string `json:"id"`
	// If set to false, then the Address Map cannot be deleted via API. This is true
	// for Cloudflare-managed maps.
	CanDelete bool `json:"can_delete"`
	// If set to false, then the IPs on the Address Map cannot be modified via the API.
	// This is true for Cloudflare-managed maps.
	CanModifyIPs bool      `json:"can_modify_ips"`
	CreatedAt    time.Time `json:"created_at" format:"date-time"`
	// If you have legacy TLS clients which do not send the TLS server name indicator,
	// then you can specify one default SNI on the map. If Cloudflare receives a TLS
	// handshake from a client without an SNI, it will respond with the default SNI on
	// those IPs. The default SNI can be any valid zone or subdomain owned by the
	// account.
	DefaultSNI string `json:"default_sni,nullable"`
	// An optional description field which may be used to describe the types of IPs or
	// zones on the map.
	Description string `json:"description,nullable"`
	// Whether the Address Map is enabled or not. Cloudflare's DNS will not respond
	// with IP addresses on an Address Map until the map is enabled.
	Enabled    bool           `json:"enabled,nullable"`
	ModifiedAt time.Time      `json:"modified_at" format:"date-time"`
	JSON       addressMapJSON `json:"-"`
}

func (*AddressMap) UnmarshalJSON 

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

type AddressMapAccountDeleteParams 

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

type AddressMapAccountDeleteResponse 

type AddressMapAccountDeleteResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success    AddressMapAccountDeleteResponseSuccess    `json:"success,required"`
	ResultInfo AddressMapAccountDeleteResponseResultInfo `json:"result_info"`
	JSON       addressMapAccountDeleteResponseJSON       `json:"-"`
}

func (*AddressMapAccountDeleteResponse) UnmarshalJSON 

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

type AddressMapAccountDeleteResponseResultInfo 

type AddressMapAccountDeleteResponseResultInfo 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       addressMapAccountDeleteResponseResultInfoJSON `json:"-"`
}

func (*AddressMapAccountDeleteResponseResultInfo) UnmarshalJSON 

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

type AddressMapAccountDeleteResponseSuccess 

type AddressMapAccountDeleteResponseSuccess bool

Whether the API call was successful 

const (
	AddressMapAccountDeleteResponseSuccessTrue AddressMapAccountDeleteResponseSuccess = true
)

func (AddressMapAccountDeleteResponseSuccess) IsKnown 

func (r AddressMapAccountDeleteResponseSuccess) IsKnown() bool

type AddressMapAccountService 

type AddressMapAccountService struct {
	Options []option.RequestOption
}

AddressMapAccountService 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 NewAddressMapAccountService method instead.

func NewAddressMapAccountService 

func NewAddressMapAccountService(opts ...option.RequestOption) (r *AddressMapAccountService)

NewAddressMapAccountService 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 (*AddressMapAccountService) Delete 

func (r *AddressMapAccountService) Delete(ctx context.Context, addressMapID string, body AddressMapAccountDeleteParams, opts ...option.RequestOption) (res *AddressMapAccountDeleteResponse, err error)

Remove an account as a member of a particular address map.

func (*AddressMapAccountService) Update 

func (r *AddressMapAccountService) Update(ctx context.Context, addressMapID string, params AddressMapAccountUpdateParams, opts ...option.RequestOption) (res *AddressMapAccountUpdateResponse, err error)

Add an account as a member of a particular address map.

type AddressMapAccountUpdateParams 

type AddressMapAccountUpdateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	Body      interface{}         `json:"body,required"`
}

func (AddressMapAccountUpdateParams) MarshalJSON 

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

type AddressMapAccountUpdateResponse 

type AddressMapAccountUpdateResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success    AddressMapAccountUpdateResponseSuccess    `json:"success,required"`
	ResultInfo AddressMapAccountUpdateResponseResultInfo `json:"result_info"`
	JSON       addressMapAccountUpdateResponseJSON       `json:"-"`
}

func (*AddressMapAccountUpdateResponse) UnmarshalJSON 

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

type AddressMapAccountUpdateResponseResultInfo 

type AddressMapAccountUpdateResponseResultInfo 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       addressMapAccountUpdateResponseResultInfoJSON `json:"-"`
}

func (*AddressMapAccountUpdateResponseResultInfo) UnmarshalJSON 

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

type AddressMapAccountUpdateResponseSuccess 

type AddressMapAccountUpdateResponseSuccess bool

Whether the API call was successful 

const (
	AddressMapAccountUpdateResponseSuccessTrue AddressMapAccountUpdateResponseSuccess = true
)

func (AddressMapAccountUpdateResponseSuccess) IsKnown 

func (r AddressMapAccountUpdateResponseSuccess) IsKnown() bool

type AddressMapDeleteParams 

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

type AddressMapDeleteResponse 

type AddressMapDeleteResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success    AddressMapDeleteResponseSuccess    `json:"success,required"`
	ResultInfo AddressMapDeleteResponseResultInfo `json:"result_info"`
	JSON       addressMapDeleteResponseJSON       `json:"-"`
}

func (*AddressMapDeleteResponse) UnmarshalJSON 

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

type AddressMapDeleteResponseResultInfo 

type AddressMapDeleteResponseResultInfo 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       addressMapDeleteResponseResultInfoJSON `json:"-"`
}

func (*AddressMapDeleteResponseResultInfo) UnmarshalJSON 

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

type AddressMapDeleteResponseSuccess 

type AddressMapDeleteResponseSuccess bool

Whether the API call was successful 

const (
	AddressMapDeleteResponseSuccessTrue AddressMapDeleteResponseSuccess = true
)

func (AddressMapDeleteResponseSuccess) IsKnown 

func (r AddressMapDeleteResponseSuccess) IsKnown() bool

type AddressMapEditParams 

type AddressMapEditParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// If you have legacy TLS clients which do not send the TLS server name indicator,
	// then you can specify one default SNI on the map. If Cloudflare receives a TLS
	// handshake from a client without an SNI, it will respond with the default SNI on
	// those IPs. The default SNI can be any valid zone or subdomain owned by the
	// account.
	DefaultSNI param.Field[string] `json:"default_sni"`
	// An optional description field which may be used to describe the types of IPs or
	// zones on the map.
	Description param.Field[string] `json:"description"`
	// Whether the Address Map is enabled or not. Cloudflare's DNS will not respond
	// with IP addresses on an Address Map until the map is enabled.
	Enabled param.Field[bool] `json:"enabled"`
}

func (AddressMapEditParams) MarshalJSON 

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

type AddressMapEditResponseEnvelope 

type AddressMapEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success AddressMapEditResponseEnvelopeSuccess `json:"success,required"`
	Result  AddressMap                            `json:"result"`
	JSON    addressMapEditResponseEnvelopeJSON    `json:"-"`
}

func (*AddressMapEditResponseEnvelope) UnmarshalJSON 

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

type AddressMapEditResponseEnvelopeSuccess 

type AddressMapEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AddressMapEditResponseEnvelopeSuccessTrue AddressMapEditResponseEnvelopeSuccess = true
)

func (AddressMapEditResponseEnvelopeSuccess) IsKnown 

func (r AddressMapEditResponseEnvelopeSuccess) IsKnown() bool

type AddressMapGetParams 

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

type AddressMapGetResponse 

type AddressMapGetResponse struct {
	// Identifier
	ID string `json:"id"`
	// If set to false, then the Address Map cannot be deleted via API. This is true
	// for Cloudflare-managed maps.
	CanDelete bool `json:"can_delete"`
	// If set to false, then the IPs on the Address Map cannot be modified via the API.
	// This is true for Cloudflare-managed maps.
	CanModifyIPs bool      `json:"can_modify_ips"`
	CreatedAt    time.Time `json:"created_at" format:"date-time"`
	// If you have legacy TLS clients which do not send the TLS server name indicator,
	// then you can specify one default SNI on the map. If Cloudflare receives a TLS
	// handshake from a client without an SNI, it will respond with the default SNI on
	// those IPs. The default SNI can be any valid zone or subdomain owned by the
	// account.
	DefaultSNI string `json:"default_sni,nullable"`
	// An optional description field which may be used to describe the types of IPs or
	// zones on the map.
	Description string `json:"description,nullable"`
	// Whether the Address Map is enabled or not. Cloudflare's DNS will not respond
	// with IP addresses on an Address Map until the map is enabled.
	Enabled bool `json:"enabled,nullable"`
	// The set of IPs on the Address Map.
	IPs []AddressMapGetResponseIP `json:"ips"`
	// Zones and Accounts which will be assigned IPs on this Address Map. A zone
	// membership will take priority over an account membership.
	Memberships []AddressMapGetResponseMembership `json:"memberships"`
	ModifiedAt  time.Time                         `json:"modified_at" format:"date-time"`
	JSON        addressMapGetResponseJSON         `json:"-"`
}

func (*AddressMapGetResponse) UnmarshalJSON 

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

type AddressMapGetResponseEnvelope 

type AddressMapGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success AddressMapGetResponseEnvelopeSuccess `json:"success,required"`
	Result  AddressMapGetResponse                `json:"result"`
	JSON    addressMapGetResponseEnvelopeJSON    `json:"-"`
}

func (*AddressMapGetResponseEnvelope) UnmarshalJSON 

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

type AddressMapGetResponseEnvelopeSuccess 

type AddressMapGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AddressMapGetResponseEnvelopeSuccessTrue AddressMapGetResponseEnvelopeSuccess = true
)

func (AddressMapGetResponseEnvelopeSuccess) IsKnown 

func (r AddressMapGetResponseEnvelopeSuccess) IsKnown() bool

type AddressMapGetResponseIP 

type AddressMapGetResponseIP struct {
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// An IPv4 or IPv6 address.
	IP   string                      `json:"ip"`
	JSON addressMapGetResponseIPJSON `json:"-"`
}

func (*AddressMapGetResponseIP) UnmarshalJSON 

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

type AddressMapGetResponseMembership 

type AddressMapGetResponseMembership struct {
	// Controls whether the membership can be deleted via the API or not.
	CanDelete bool      `json:"can_delete"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The identifier for the membership (eg. a zone or account tag).
	Identifier string `json:"identifier"`
	// The type of the membership.
	Kind Kind                                `json:"kind"`
	JSON addressMapGetResponseMembershipJSON `json:"-"`
}

func (*AddressMapGetResponseMembership) UnmarshalJSON 

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

type AddressMapIPDeleteParams 

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

type AddressMapIPDeleteResponse 

type AddressMapIPDeleteResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success    AddressMapIPDeleteResponseSuccess    `json:"success,required"`
	ResultInfo AddressMapIPDeleteResponseResultInfo `json:"result_info"`
	JSON       addressMapIPDeleteResponseJSON       `json:"-"`
}

func (*AddressMapIPDeleteResponse) UnmarshalJSON 

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

type AddressMapIPDeleteResponseResultInfo 

type AddressMapIPDeleteResponseResultInfo 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       addressMapIPDeleteResponseResultInfoJSON `json:"-"`
}

func (*AddressMapIPDeleteResponseResultInfo) UnmarshalJSON 

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

type AddressMapIPDeleteResponseSuccess 

type AddressMapIPDeleteResponseSuccess bool

Whether the API call was successful 

const (
	AddressMapIPDeleteResponseSuccessTrue AddressMapIPDeleteResponseSuccess = true
)

func (AddressMapIPDeleteResponseSuccess) IsKnown 

func (r AddressMapIPDeleteResponseSuccess) IsKnown() bool

type AddressMapIPService 

type AddressMapIPService struct {
	Options []option.RequestOption
}

AddressMapIPService 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 NewAddressMapIPService method instead.

func NewAddressMapIPService 

func NewAddressMapIPService(opts ...option.RequestOption) (r *AddressMapIPService)

NewAddressMapIPService 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 (*AddressMapIPService) Delete 

func (r *AddressMapIPService) Delete(ctx context.Context, addressMapID string, ipAddress string, body AddressMapIPDeleteParams, opts ...option.RequestOption) (res *AddressMapIPDeleteResponse, err error)

Remove an IP from a particular address map.

func (*AddressMapIPService) Update 

func (r *AddressMapIPService) Update(ctx context.Context, addressMapID string, ipAddress string, params AddressMapIPUpdateParams, opts ...option.RequestOption) (res *AddressMapIPUpdateResponse, err error)

Add an IP from a prefix owned by the account to a particular address map.

type AddressMapIPUpdateParams 

type AddressMapIPUpdateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	Body      interface{}         `json:"body,required"`
}

func (AddressMapIPUpdateParams) MarshalJSON 

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

type AddressMapIPUpdateResponse 

type AddressMapIPUpdateResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success    AddressMapIPUpdateResponseSuccess    `json:"success,required"`
	ResultInfo AddressMapIPUpdateResponseResultInfo `json:"result_info"`
	JSON       addressMapIPUpdateResponseJSON       `json:"-"`
}

func (*AddressMapIPUpdateResponse) UnmarshalJSON 

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

type AddressMapIPUpdateResponseResultInfo 

type AddressMapIPUpdateResponseResultInfo 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       addressMapIPUpdateResponseResultInfoJSON `json:"-"`
}

func (*AddressMapIPUpdateResponseResultInfo) UnmarshalJSON 

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

type AddressMapIPUpdateResponseSuccess 

type AddressMapIPUpdateResponseSuccess bool

Whether the API call was successful 

const (
	AddressMapIPUpdateResponseSuccessTrue AddressMapIPUpdateResponseSuccess = true
)

func (AddressMapIPUpdateResponseSuccess) IsKnown 

func (r AddressMapIPUpdateResponseSuccess) IsKnown() bool

type AddressMapListParams 

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

type AddressMapNewParams 

type AddressMapNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// An optional description field which may be used to describe the types of IPs or
	// zones on the map.
	Description param.Field[string] `json:"description"`
	// Whether the Address Map is enabled or not. Cloudflare's DNS will not respond
	// with IP addresses on an Address Map until the map is enabled.
	Enabled param.Field[bool]     `json:"enabled"`
	IPs     param.Field[[]string] `json:"ips"`
	// Zones and Accounts which will be assigned IPs on this Address Map. A zone
	// membership will take priority over an account membership.
	Memberships param.Field[[]AddressMapNewParamsMembership] `json:"memberships"`
}

func (AddressMapNewParams) MarshalJSON 

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

type AddressMapNewParamsMembership 

type AddressMapNewParamsMembership struct {
	// The identifier for the membership (eg. a zone or account tag).
	Identifier param.Field[string] `json:"identifier"`
	// The type of the membership.
	Kind param.Field[Kind] `json:"kind"`
}

func (AddressMapNewParamsMembership) MarshalJSON 

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

type AddressMapNewResponse 

type AddressMapNewResponse struct {
	// Identifier
	ID string `json:"id"`
	// If set to false, then the Address Map cannot be deleted via API. This is true
	// for Cloudflare-managed maps.
	CanDelete bool `json:"can_delete"`
	// If set to false, then the IPs on the Address Map cannot be modified via the API.
	// This is true for Cloudflare-managed maps.
	CanModifyIPs bool      `json:"can_modify_ips"`
	CreatedAt    time.Time `json:"created_at" format:"date-time"`
	// If you have legacy TLS clients which do not send the TLS server name indicator,
	// then you can specify one default SNI on the map. If Cloudflare receives a TLS
	// handshake from a client without an SNI, it will respond with the default SNI on
	// those IPs. The default SNI can be any valid zone or subdomain owned by the
	// account.
	DefaultSNI string `json:"default_sni,nullable"`
	// An optional description field which may be used to describe the types of IPs or
	// zones on the map.
	Description string `json:"description,nullable"`
	// Whether the Address Map is enabled or not. Cloudflare's DNS will not respond
	// with IP addresses on an Address Map until the map is enabled.
	Enabled bool `json:"enabled,nullable"`
	// The set of IPs on the Address Map.
	IPs []AddressMapNewResponseIP `json:"ips"`
	// Zones and Accounts which will be assigned IPs on this Address Map. A zone
	// membership will take priority over an account membership.
	Memberships []AddressMapNewResponseMembership `json:"memberships"`
	ModifiedAt  time.Time                         `json:"modified_at" format:"date-time"`
	JSON        addressMapNewResponseJSON         `json:"-"`
}

func (*AddressMapNewResponse) UnmarshalJSON 

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

type AddressMapNewResponseEnvelope 

type AddressMapNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success AddressMapNewResponseEnvelopeSuccess `json:"success,required"`
	Result  AddressMapNewResponse                `json:"result"`
	JSON    addressMapNewResponseEnvelopeJSON    `json:"-"`
}

func (*AddressMapNewResponseEnvelope) UnmarshalJSON 

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

type AddressMapNewResponseEnvelopeSuccess 

type AddressMapNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AddressMapNewResponseEnvelopeSuccessTrue AddressMapNewResponseEnvelopeSuccess = true
)

func (AddressMapNewResponseEnvelopeSuccess) IsKnown 

func (r AddressMapNewResponseEnvelopeSuccess) IsKnown() bool

type AddressMapNewResponseIP 

type AddressMapNewResponseIP struct {
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// An IPv4 or IPv6 address.
	IP   string                      `json:"ip"`
	JSON addressMapNewResponseIPJSON `json:"-"`
}

func (*AddressMapNewResponseIP) UnmarshalJSON 

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

type AddressMapNewResponseMembership 

type AddressMapNewResponseMembership struct {
	// Controls whether the membership can be deleted via the API or not.
	CanDelete bool      `json:"can_delete"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The identifier for the membership (eg. a zone or account tag).
	Identifier string `json:"identifier"`
	// The type of the membership.
	Kind Kind                                `json:"kind"`
	JSON addressMapNewResponseMembershipJSON `json:"-"`
}

func (*AddressMapNewResponseMembership) UnmarshalJSON 

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

type AddressMapService 

type AddressMapService struct {
	Options  []option.RequestOption
	Accounts *AddressMapAccountService
	IPs      *AddressMapIPService
	Zones    *AddressMapZoneService
}

AddressMapService 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 NewAddressMapService method instead.

func NewAddressMapService 

func NewAddressMapService(opts ...option.RequestOption) (r *AddressMapService)

NewAddressMapService 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 (*AddressMapService) Delete 

func (r *AddressMapService) Delete(ctx context.Context, addressMapID string, body AddressMapDeleteParams, opts ...option.RequestOption) (res *AddressMapDeleteResponse, err error)

Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.

func (*AddressMapService) Edit 

func (r *AddressMapService) Edit(ctx context.Context, addressMapID string, params AddressMapEditParams, opts ...option.RequestOption) (res *AddressMap, err error)

Modify properties of an address map owned by the account.

func (*AddressMapService) Get 

func (r *AddressMapService) Get(ctx context.Context, addressMapID string, query AddressMapGetParams, opts ...option.RequestOption) (res *AddressMapGetResponse, err error)

Show a particular address map owned by the account.

func (*AddressMapService) List 

func (r *AddressMapService) List(ctx context.Context, query AddressMapListParams, opts ...option.RequestOption) (res *pagination.SinglePage[AddressMap], err error)

List all address maps owned by the account.

func (*AddressMapService) ListAutoPaging 

func (r *AddressMapService) ListAutoPaging(ctx context.Context, query AddressMapListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AddressMap]

List all address maps owned by the account.

func (*AddressMapService) New 

func (r *AddressMapService) New(ctx context.Context, params AddressMapNewParams, opts ...option.RequestOption) (res *AddressMapNewResponse, err error)

Create a new address map under the account.

type AddressMapZoneDeleteParams 

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

type AddressMapZoneDeleteResponse 

type AddressMapZoneDeleteResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success    AddressMapZoneDeleteResponseSuccess    `json:"success,required"`
	ResultInfo AddressMapZoneDeleteResponseResultInfo `json:"result_info"`
	JSON       addressMapZoneDeleteResponseJSON       `json:"-"`
}

func (*AddressMapZoneDeleteResponse) UnmarshalJSON 

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

type AddressMapZoneDeleteResponseResultInfo 

type AddressMapZoneDeleteResponseResultInfo 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       addressMapZoneDeleteResponseResultInfoJSON `json:"-"`
}

func (*AddressMapZoneDeleteResponseResultInfo) UnmarshalJSON 

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

type AddressMapZoneDeleteResponseSuccess 

type AddressMapZoneDeleteResponseSuccess bool

Whether the API call was successful 

const (
	AddressMapZoneDeleteResponseSuccessTrue AddressMapZoneDeleteResponseSuccess = true
)

func (AddressMapZoneDeleteResponseSuccess) IsKnown 

func (r AddressMapZoneDeleteResponseSuccess) IsKnown() bool

type AddressMapZoneService 

type AddressMapZoneService struct {
	Options []option.RequestOption
}

AddressMapZoneService 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 NewAddressMapZoneService method instead.

func NewAddressMapZoneService 

func NewAddressMapZoneService(opts ...option.RequestOption) (r *AddressMapZoneService)

NewAddressMapZoneService 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 (*AddressMapZoneService) Delete 

func (r *AddressMapZoneService) Delete(ctx context.Context, addressMapID string, body AddressMapZoneDeleteParams, opts ...option.RequestOption) (res *AddressMapZoneDeleteResponse, err error)

Remove a zone as a member of a particular address map.

func (*AddressMapZoneService) Update 

func (r *AddressMapZoneService) Update(ctx context.Context, addressMapID string, params AddressMapZoneUpdateParams, opts ...option.RequestOption) (res *AddressMapZoneUpdateResponse, err error)

Add a zone as a member of a particular address map.

type AddressMapZoneUpdateParams 

type AddressMapZoneUpdateParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	Body      interface{}         `json:"body,required"`
}

func (AddressMapZoneUpdateParams) MarshalJSON 

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

type AddressMapZoneUpdateResponse 

type AddressMapZoneUpdateResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success    AddressMapZoneUpdateResponseSuccess    `json:"success,required"`
	ResultInfo AddressMapZoneUpdateResponseResultInfo `json:"result_info"`
	JSON       addressMapZoneUpdateResponseJSON       `json:"-"`
}

func (*AddressMapZoneUpdateResponse) UnmarshalJSON 

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

type AddressMapZoneUpdateResponseResultInfo 

type AddressMapZoneUpdateResponseResultInfo 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       addressMapZoneUpdateResponseResultInfoJSON `json:"-"`
}

func (*AddressMapZoneUpdateResponseResultInfo) UnmarshalJSON 

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

type AddressMapZoneUpdateResponseSuccess 

type AddressMapZoneUpdateResponseSuccess bool

Whether the API call was successful 

const (
	AddressMapZoneUpdateResponseSuccessTrue AddressMapZoneUpdateResponseSuccess = true
)

func (AddressMapZoneUpdateResponseSuccess) IsKnown 

func (r AddressMapZoneUpdateResponseSuccess) IsKnown() bool

type AddressingService 

type AddressingService struct {
	Options           []option.RequestOption
	RegionalHostnames *RegionalHostnameService
	Services          *ServiceService
	AddressMaps       *AddressMapService
	LOADocuments      *LOADocumentService
	Prefixes          *PrefixService
}

AddressingService 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 NewAddressingService method instead.

func NewAddressingService 

func NewAddressingService(opts ...option.RequestOption) (r *AddressingService)

NewAddressingService 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 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 BGPPrefix 

type BGPPrefix struct {
	// Identifier
	ID string `json:"id"`
	// Autonomous System Number (ASN) the prefix will be advertised under.
	ASN           int64                  `json:"asn,nullable"`
	BGPSignalOpts BGPPrefixBGPSignalOpts `json:"bgp_signal_opts"`
	// IP Prefix in Classless Inter-Domain Routing format.
	CIDR       string            `json:"cidr"`
	CreatedAt  time.Time         `json:"created_at" format:"date-time"`
	ModifiedAt time.Time         `json:"modified_at" format:"date-time"`
	OnDemand   BGPPrefixOnDemand `json:"on_demand"`
	JSON       bgpPrefixJSON     `json:"-"`
}

func (*BGPPrefix) UnmarshalJSON 

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

type BGPPrefixBGPSignalOpts 

type BGPPrefixBGPSignalOpts struct {
	// Whether control of advertisement of the prefix to the Internet is enabled to be
	// performed via BGP signal
	Enabled bool `json:"enabled"`
	// Last time BGP signaling control was toggled. This field is null if BGP signaling
	// has never been enabled.
	ModifiedAt time.Time                  `json:"modified_at,nullable" format:"date-time"`
	JSON       bgpPrefixBGPSignalOptsJSON `json:"-"`
}

func (*BGPPrefixBGPSignalOpts) UnmarshalJSON 

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

type BGPPrefixOnDemand 

type BGPPrefixOnDemand struct {
	// Prefix advertisement status to the Internet. This field is only not 'null' if on
	// demand is enabled.
	Advertised bool `json:"advertised,nullable"`
	// Last time the advertisement status was changed. This field is only not 'null' if
	// on demand is enabled.
	AdvertisedModifiedAt time.Time `json:"advertised_modified_at,nullable" format:"date-time"`
	// Whether advertisement of the prefix to the Internet may be dynamically enabled
	// or disabled.
	OnDemandEnabled bool `json:"on_demand_enabled"`
	// Whether advertisement status of the prefix is locked, meaning it cannot be
	// changed.
	OnDemandLocked bool                  `json:"on_demand_locked"`
	JSON           bgpPrefixOnDemandJSON `json:"-"`
}

func (*BGPPrefixOnDemand) UnmarshalJSON 

func (r *BGPPrefixOnDemand) 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 Delegations 

type Delegations struct {
	// Delegation identifier tag.
	ID string `json:"id"`
	// IP Prefix in Classless Inter-Domain Routing format.
	CIDR      string    `json:"cidr"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Account identifier for the account to which prefix is being delegated.
	DelegatedAccountID string    `json:"delegated_account_id"`
	ModifiedAt         time.Time `json:"modified_at" format:"date-time"`
	// Identifier
	ParentPrefixID string          `json:"parent_prefix_id"`
	JSON           delegationsJSON `json:"-"`
}

func (*Delegations) UnmarshalJSON 

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

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type Kind 

type Kind string

The type of the membership. 

const (
	KindZone    Kind = "zone"
	KindAccount Kind = "account"
)

func (Kind) IsKnown 

func (r Kind) IsKnown() bool

type LOADocumentDownloadGetParams 

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

type LOADocumentDownloadService 

type LOADocumentDownloadService struct {
	Options []option.RequestOption
}

LOADocumentDownloadService 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 NewLOADocumentDownloadService method instead.

func NewLOADocumentDownloadService 

func NewLOADocumentDownloadService(opts ...option.RequestOption) (r *LOADocumentDownloadService)

NewLOADocumentDownloadService 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 (*LOADocumentDownloadService) Get 

func (r *LOADocumentDownloadService) Get(ctx context.Context, loaDocumentID string, query LOADocumentDownloadGetParams, opts ...option.RequestOption) (res *http.Response, err error)

Download specified LOA document under the account.

type LOADocumentNewParams 

type LOADocumentNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// LOA document to upload.
	LOADocument param.Field[string] `json:"loa_document,required"`
}

func (LOADocumentNewParams) MarshalMultipart 

func (r LOADocumentNewParams) MarshalMultipart() (data []byte, contentType string, err error)

type LOADocumentNewResponse 

type LOADocumentNewResponse struct {
	// Identifier for the uploaded LOA document.
	ID string `json:"id,nullable"`
	// Identifier
	AccountID string    `json:"account_id"`
	Created   time.Time `json:"created" format:"date-time"`
	// Name of LOA document. Max file size 10MB, and supported filetype is pdf.
	Filename string `json:"filename"`
	// File size of the uploaded LOA document.
	SizeBytes int64 `json:"size_bytes"`
	// Whether the LOA has been verified by Cloudflare staff.
	Verified bool `json:"verified"`
	// Timestamp of the moment the LOA was marked as validated.
	VerifiedAt time.Time                  `json:"verified_at,nullable" format:"date-time"`
	JSON       loaDocumentNewResponseJSON `json:"-"`
}

func (*LOADocumentNewResponse) UnmarshalJSON 

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

type LOADocumentNewResponseEnvelope 

type LOADocumentNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success LOADocumentNewResponseEnvelopeSuccess `json:"success,required"`
	Result  LOADocumentNewResponse                `json:"result"`
	JSON    loaDocumentNewResponseEnvelopeJSON    `json:"-"`
}

func (*LOADocumentNewResponseEnvelope) UnmarshalJSON 

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

type LOADocumentNewResponseEnvelopeSuccess 

type LOADocumentNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	LOADocumentNewResponseEnvelopeSuccessTrue LOADocumentNewResponseEnvelopeSuccess = true
)

func (LOADocumentNewResponseEnvelopeSuccess) IsKnown 

func (r LOADocumentNewResponseEnvelopeSuccess) IsKnown() bool

type LOADocumentService 

type LOADocumentService struct {
	Options   []option.RequestOption
	Downloads *LOADocumentDownloadService
}

LOADocumentService 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 NewLOADocumentService method instead.

func NewLOADocumentService 

func NewLOADocumentService(opts ...option.RequestOption) (r *LOADocumentService)

NewLOADocumentService 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 (*LOADocumentService) New 

func (r *LOADocumentService) New(ctx context.Context, params LOADocumentNewParams, opts ...option.RequestOption) (res *LOADocumentNewResponse, err error)

Submit LOA document (pdf format) under the account.

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 Prefix 

type Prefix struct {
	// Identifier
	ID string `json:"id"`
	// Identifier
	AccountID string `json:"account_id"`
	// Prefix advertisement status to the Internet. This field is only not 'null' if on
	// demand is enabled.
	Advertised bool `json:"advertised,nullable"`
	// Last time the advertisement status was changed. This field is only not 'null' if
	// on demand is enabled.
	AdvertisedModifiedAt time.Time `json:"advertised_modified_at,nullable" format:"date-time"`
	// Approval state of the prefix (P = pending, V = active).
	Approved string `json:"approved"`
	// Autonomous System Number (ASN) the prefix will be advertised under.
	ASN int64 `json:"asn,nullable"`
	// IP Prefix in Classless Inter-Domain Routing format.
	CIDR      string    `json:"cidr"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Description of the prefix.
	Description string `json:"description"`
	// Identifier for the uploaded LOA document.
	LOADocumentID string    `json:"loa_document_id,nullable"`
	ModifiedAt    time.Time `json:"modified_at" format:"date-time"`
	// Whether advertisement of the prefix to the Internet may be dynamically enabled
	// or disabled.
	OnDemandEnabled bool `json:"on_demand_enabled"`
	// Whether advertisement status of the prefix is locked, meaning it cannot be
	// changed.
	OnDemandLocked bool       `json:"on_demand_locked"`
	JSON           prefixJSON `json:"-"`
}

func (*Prefix) UnmarshalJSON 

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

type PrefixBGPBindingDeleteParams 

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

type PrefixBGPBindingDeleteResponse 

type PrefixBGPBindingDeleteResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixBGPBindingDeleteResponseSuccess `json:"success,required"`
	JSON    prefixBGPBindingDeleteResponseJSON    `json:"-"`
}

func (*PrefixBGPBindingDeleteResponse) UnmarshalJSON 

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

type PrefixBGPBindingDeleteResponseSuccess 

type PrefixBGPBindingDeleteResponseSuccess bool

Whether the API call was successful 

const (
	PrefixBGPBindingDeleteResponseSuccessTrue PrefixBGPBindingDeleteResponseSuccess = true
)

func (PrefixBGPBindingDeleteResponseSuccess) IsKnown 

func (r PrefixBGPBindingDeleteResponseSuccess) IsKnown() bool

type PrefixBGPBindingGetParams 

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

type PrefixBGPBindingGetResponseEnvelope 

type PrefixBGPBindingGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixBGPBindingGetResponseEnvelopeSuccess `json:"success,required"`
	Result  ServiceBinding                             `json:"result"`
	JSON    prefixBGPBindingGetResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixBGPBindingGetResponseEnvelope) UnmarshalJSON 

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

type PrefixBGPBindingGetResponseEnvelopeSuccess 

type PrefixBGPBindingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixBGPBindingGetResponseEnvelopeSuccessTrue PrefixBGPBindingGetResponseEnvelopeSuccess = true
)

func (PrefixBGPBindingGetResponseEnvelopeSuccess) IsKnown 

func (r PrefixBGPBindingGetResponseEnvelopeSuccess) IsKnown() bool

type PrefixBGPBindingListParams 

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

type PrefixBGPBindingNewParams 

type PrefixBGPBindingNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// IP Prefix in Classless Inter-Domain Routing format.
	CIDR param.Field[string] `json:"cidr"`
	// Identifier
	ServiceID param.Field[string] `json:"service_id"`
}

func (PrefixBGPBindingNewParams) MarshalJSON 

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

type PrefixBGPBindingNewResponseEnvelope 

type PrefixBGPBindingNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixBGPBindingNewResponseEnvelopeSuccess `json:"success,required"`
	Result  ServiceBinding                             `json:"result"`
	JSON    prefixBGPBindingNewResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixBGPBindingNewResponseEnvelope) UnmarshalJSON 

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

type PrefixBGPBindingNewResponseEnvelopeSuccess 

type PrefixBGPBindingNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixBGPBindingNewResponseEnvelopeSuccessTrue PrefixBGPBindingNewResponseEnvelopeSuccess = true
)

func (PrefixBGPBindingNewResponseEnvelopeSuccess) IsKnown 

func (r PrefixBGPBindingNewResponseEnvelopeSuccess) IsKnown() bool

type PrefixBGPBindingService 

type PrefixBGPBindingService struct {
	Options []option.RequestOption
}

PrefixBGPBindingService 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 NewPrefixBGPBindingService method instead.

func NewPrefixBGPBindingService 

func NewPrefixBGPBindingService(opts ...option.RequestOption) (r *PrefixBGPBindingService)

NewPrefixBGPBindingService 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 (*PrefixBGPBindingService) Delete 

func (r *PrefixBGPBindingService) Delete(ctx context.Context, prefixID string, bindingID string, body PrefixBGPBindingDeleteParams, opts ...option.RequestOption) (res *PrefixBGPBindingDeleteResponse, err error)

Delete a Service Binding

func (*PrefixBGPBindingService) Get 

func (r *PrefixBGPBindingService) Get(ctx context.Context, prefixID string, bindingID string, query PrefixBGPBindingGetParams, opts ...option.RequestOption) (res *ServiceBinding, err error)

Fetch a single Service Binding

func (*PrefixBGPBindingService) List 

func (r *PrefixBGPBindingService) List(ctx context.Context, prefixID string, query PrefixBGPBindingListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ServiceBinding], err error)

List the Cloudflare services this prefix is currently bound to. Traffic sent to an address within an IP prefix will be routed to the Cloudflare service of the most-specific Service Binding matching the address. **Example:** binding `192.0.2.0/24` to Cloudflare Magic Transit and `192.0.2.1/32` to the Cloudflare CDN would route traffic for `192.0.2.1` to the CDN, and traffic for all other IPs in the prefix to Cloudflare Magic Transit.

func (*PrefixBGPBindingService) ListAutoPaging 

func (r *PrefixBGPBindingService) ListAutoPaging(ctx context.Context, prefixID string, query PrefixBGPBindingListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ServiceBinding]

List the Cloudflare services this prefix is currently bound to. Traffic sent to an address within an IP prefix will be routed to the Cloudflare service of the most-specific Service Binding matching the address. **Example:** binding `192.0.2.0/24` to Cloudflare Magic Transit and `192.0.2.1/32` to the Cloudflare CDN would route traffic for `192.0.2.1` to the CDN, and traffic for all other IPs in the prefix to Cloudflare Magic Transit.

func (*PrefixBGPBindingService) New 

func (r *PrefixBGPBindingService) New(ctx context.Context, prefixID string, params PrefixBGPBindingNewParams, opts ...option.RequestOption) (res *ServiceBinding, err error)

Creates a new Service Binding, routing traffic to IPs within the given CIDR to a service running on Cloudflare's network. **Note:** This API may only be used on prefixes currently configured with a Magic Transit service binding, and only allows creating service bindings for the Cloudflare CDN or Cloudflare Spectrum.

type PrefixBGPPrefixEditParams 

type PrefixBGPPrefixEditParams struct {
	// Identifier
	AccountID param.Field[string]                            `path:"account_id,required"`
	OnDemand  param.Field[PrefixBGPPrefixEditParamsOnDemand] `json:"on_demand"`
}

func (PrefixBGPPrefixEditParams) MarshalJSON 

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

type PrefixBGPPrefixEditParamsOnDemand 

type PrefixBGPPrefixEditParamsOnDemand struct {
	Advertised param.Field[bool] `json:"advertised"`
}

func (PrefixBGPPrefixEditParamsOnDemand) MarshalJSON 

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

type PrefixBGPPrefixEditResponseEnvelope 

type PrefixBGPPrefixEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixBGPPrefixEditResponseEnvelopeSuccess `json:"success,required"`
	Result  BGPPrefix                                  `json:"result"`
	JSON    prefixBGPPrefixEditResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixBGPPrefixEditResponseEnvelope) UnmarshalJSON 

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

type PrefixBGPPrefixEditResponseEnvelopeSuccess 

type PrefixBGPPrefixEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixBGPPrefixEditResponseEnvelopeSuccessTrue PrefixBGPPrefixEditResponseEnvelopeSuccess = true
)

func (PrefixBGPPrefixEditResponseEnvelopeSuccess) IsKnown 

func (r PrefixBGPPrefixEditResponseEnvelopeSuccess) IsKnown() bool

type PrefixBGPPrefixGetParams 

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

type PrefixBGPPrefixGetResponseEnvelope 

type PrefixBGPPrefixGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixBGPPrefixGetResponseEnvelopeSuccess `json:"success,required"`
	Result  BGPPrefix                                 `json:"result"`
	JSON    prefixBGPPrefixGetResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixBGPPrefixGetResponseEnvelope) UnmarshalJSON 

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

type PrefixBGPPrefixGetResponseEnvelopeSuccess 

type PrefixBGPPrefixGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixBGPPrefixGetResponseEnvelopeSuccessTrue PrefixBGPPrefixGetResponseEnvelopeSuccess = true
)

func (PrefixBGPPrefixGetResponseEnvelopeSuccess) IsKnown 

func (r PrefixBGPPrefixGetResponseEnvelopeSuccess) IsKnown() bool

type PrefixBGPPrefixListParams 

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

type PrefixBGPPrefixService 

type PrefixBGPPrefixService struct {
	Options []option.RequestOption
}

PrefixBGPPrefixService 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 NewPrefixBGPPrefixService method instead.

func NewPrefixBGPPrefixService 

func NewPrefixBGPPrefixService(opts ...option.RequestOption) (r *PrefixBGPPrefixService)

NewPrefixBGPPrefixService 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 (*PrefixBGPPrefixService) Edit 

func (r *PrefixBGPPrefixService) Edit(ctx context.Context, prefixID string, bgpPrefixID string, params PrefixBGPPrefixEditParams, opts ...option.RequestOption) (res *BGPPrefix, err error)

Update the properties of a BGP Prefix, such as the on demand advertisement status (advertised or withdrawn).

func (*PrefixBGPPrefixService) Get 

func (r *PrefixBGPPrefixService) Get(ctx context.Context, prefixID string, bgpPrefixID string, query PrefixBGPPrefixGetParams, opts ...option.RequestOption) (res *BGPPrefix, err error)

Retrieve a single BGP Prefix according to its identifier

func (*PrefixBGPPrefixService) List 

func (r *PrefixBGPPrefixService) List(ctx context.Context, prefixID string, query PrefixBGPPrefixListParams, opts ...option.RequestOption) (res *pagination.SinglePage[BGPPrefix], err error)

List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes.

func (*PrefixBGPPrefixService) ListAutoPaging 

func (r *PrefixBGPPrefixService) ListAutoPaging(ctx context.Context, prefixID string, query PrefixBGPPrefixListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[BGPPrefix]

List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes.

type PrefixBGPService 

type PrefixBGPService struct {
	Options  []option.RequestOption
	Bindings *PrefixBGPBindingService
	Prefixes *PrefixBGPPrefixService
	Statuses *PrefixBGPStatusService
}

PrefixBGPService 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 NewPrefixBGPService method instead.

func NewPrefixBGPService 

func NewPrefixBGPService(opts ...option.RequestOption) (r *PrefixBGPService)

NewPrefixBGPService 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 PrefixBGPStatusEditParams 

type PrefixBGPStatusEditParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Enablement of prefix advertisement to the Internet.
	Advertised param.Field[bool] `json:"advertised,required"`
}

func (PrefixBGPStatusEditParams) MarshalJSON 

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

type PrefixBGPStatusEditResponse 

type PrefixBGPStatusEditResponse struct {
	// Enablement of prefix advertisement to the Internet.
	Advertised bool `json:"advertised"`
	// Last time the advertisement status was changed. This field is only not 'null' if
	// on demand is enabled.
	AdvertisedModifiedAt time.Time                       `json:"advertised_modified_at,nullable" format:"date-time"`
	JSON                 prefixBGPStatusEditResponseJSON `json:"-"`
}

func (*PrefixBGPStatusEditResponse) UnmarshalJSON 

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

type PrefixBGPStatusEditResponseEnvelope 

type PrefixBGPStatusEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixBGPStatusEditResponseEnvelopeSuccess `json:"success,required"`
	Result  PrefixBGPStatusEditResponse                `json:"result"`
	JSON    prefixBGPStatusEditResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixBGPStatusEditResponseEnvelope) UnmarshalJSON 

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

type PrefixBGPStatusEditResponseEnvelopeSuccess 

type PrefixBGPStatusEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixBGPStatusEditResponseEnvelopeSuccessTrue PrefixBGPStatusEditResponseEnvelopeSuccess = true
)

func (PrefixBGPStatusEditResponseEnvelopeSuccess) IsKnown 

func (r PrefixBGPStatusEditResponseEnvelopeSuccess) IsKnown() bool

type PrefixBGPStatusGetParams 

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

type PrefixBGPStatusGetResponse 

type PrefixBGPStatusGetResponse struct {
	// Enablement of prefix advertisement to the Internet.
	Advertised bool `json:"advertised"`
	// Last time the advertisement status was changed. This field is only not 'null' if
	// on demand is enabled.
	AdvertisedModifiedAt time.Time                      `json:"advertised_modified_at,nullable" format:"date-time"`
	JSON                 prefixBGPStatusGetResponseJSON `json:"-"`
}

func (*PrefixBGPStatusGetResponse) UnmarshalJSON 

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

type PrefixBGPStatusGetResponseEnvelope 

type PrefixBGPStatusGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixBGPStatusGetResponseEnvelopeSuccess `json:"success,required"`
	Result  PrefixBGPStatusGetResponse                `json:"result"`
	JSON    prefixBGPStatusGetResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixBGPStatusGetResponseEnvelope) UnmarshalJSON 

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

type PrefixBGPStatusGetResponseEnvelopeSuccess 

type PrefixBGPStatusGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixBGPStatusGetResponseEnvelopeSuccessTrue PrefixBGPStatusGetResponseEnvelopeSuccess = true
)

func (PrefixBGPStatusGetResponseEnvelopeSuccess) IsKnown 

func (r PrefixBGPStatusGetResponseEnvelopeSuccess) IsKnown() bool

type PrefixBGPStatusService 

type PrefixBGPStatusService struct {
	Options []option.RequestOption
}

PrefixBGPStatusService 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 NewPrefixBGPStatusService method instead.

func NewPrefixBGPStatusService 

func NewPrefixBGPStatusService(opts ...option.RequestOption) (r *PrefixBGPStatusService)

NewPrefixBGPStatusService 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 (*PrefixBGPStatusService) Edit 

func (r *PrefixBGPStatusService) Edit(ctx context.Context, prefixID string, params PrefixBGPStatusEditParams, opts ...option.RequestOption) (res *PrefixBGPStatusEditResponse, err error)

Advertise or withdraw BGP route for a prefix.

func (*PrefixBGPStatusService) Get 

func (r *PrefixBGPStatusService) Get(ctx context.Context, prefixID string, query PrefixBGPStatusGetParams, opts ...option.RequestOption) (res *PrefixBGPStatusGetResponse, err error)

List the current advertisement state for a prefix.

type PrefixDelegationDeleteParams 

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

type PrefixDelegationDeleteResponse 

type PrefixDelegationDeleteResponse struct {
	// Delegation identifier tag.
	ID   string                             `json:"id"`
	JSON prefixDelegationDeleteResponseJSON `json:"-"`
}

func (*PrefixDelegationDeleteResponse) UnmarshalJSON 

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

type PrefixDelegationDeleteResponseEnvelope 

type PrefixDelegationDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixDelegationDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  PrefixDelegationDeleteResponse                `json:"result"`
	JSON    prefixDelegationDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixDelegationDeleteResponseEnvelope) UnmarshalJSON 

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

type PrefixDelegationDeleteResponseEnvelopeSuccess 

type PrefixDelegationDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixDelegationDeleteResponseEnvelopeSuccessTrue PrefixDelegationDeleteResponseEnvelopeSuccess = true
)

func (PrefixDelegationDeleteResponseEnvelopeSuccess) IsKnown 

func (r PrefixDelegationDeleteResponseEnvelopeSuccess) IsKnown() bool

type PrefixDelegationListParams 

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

type PrefixDelegationNewParams 

type PrefixDelegationNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// IP Prefix in Classless Inter-Domain Routing format.
	CIDR param.Field[string] `json:"cidr,required"`
	// Account identifier for the account to which prefix is being delegated.
	DelegatedAccountID param.Field[string] `json:"delegated_account_id,required"`
}

func (PrefixDelegationNewParams) MarshalJSON 

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

type PrefixDelegationNewResponseEnvelope 

type PrefixDelegationNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixDelegationNewResponseEnvelopeSuccess `json:"success,required"`
	Result  Delegations                                `json:"result"`
	JSON    prefixDelegationNewResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixDelegationNewResponseEnvelope) UnmarshalJSON 

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

type PrefixDelegationNewResponseEnvelopeSuccess 

type PrefixDelegationNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixDelegationNewResponseEnvelopeSuccessTrue PrefixDelegationNewResponseEnvelopeSuccess = true
)

func (PrefixDelegationNewResponseEnvelopeSuccess) IsKnown 

func (r PrefixDelegationNewResponseEnvelopeSuccess) IsKnown() bool

type PrefixDelegationService 

type PrefixDelegationService struct {
	Options []option.RequestOption
}

PrefixDelegationService 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 NewPrefixDelegationService method instead.

func NewPrefixDelegationService 

func NewPrefixDelegationService(opts ...option.RequestOption) (r *PrefixDelegationService)

NewPrefixDelegationService 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 (*PrefixDelegationService) Delete 

func (r *PrefixDelegationService) Delete(ctx context.Context, prefixID string, delegationID string, body PrefixDelegationDeleteParams, opts ...option.RequestOption) (res *PrefixDelegationDeleteResponse, err error)

Delete an account delegation for a given IP prefix.

func (*PrefixDelegationService) List 

func (r *PrefixDelegationService) List(ctx context.Context, prefixID string, query PrefixDelegationListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Delegations], err error)

List all delegations for a given account IP prefix.

func (*PrefixDelegationService) ListAutoPaging 

func (r *PrefixDelegationService) ListAutoPaging(ctx context.Context, prefixID string, query PrefixDelegationListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Delegations]

List all delegations for a given account IP prefix.

func (*PrefixDelegationService) New 

func (r *PrefixDelegationService) New(ctx context.Context, prefixID string, params PrefixDelegationNewParams, opts ...option.RequestOption) (res *Delegations, err error)

Create a new account delegation for a given IP prefix.

type PrefixDeleteParams 

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

type PrefixDeleteResponse 

type PrefixDeleteResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success    PrefixDeleteResponseSuccess    `json:"success,required"`
	ResultInfo PrefixDeleteResponseResultInfo `json:"result_info"`
	JSON       prefixDeleteResponseJSON       `json:"-"`
}

func (*PrefixDeleteResponse) UnmarshalJSON 

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

type PrefixDeleteResponseResultInfo 

type PrefixDeleteResponseResultInfo 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       prefixDeleteResponseResultInfoJSON `json:"-"`
}

func (*PrefixDeleteResponseResultInfo) UnmarshalJSON 

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

type PrefixDeleteResponseSuccess 

type PrefixDeleteResponseSuccess bool

Whether the API call was successful 

const (
	PrefixDeleteResponseSuccessTrue PrefixDeleteResponseSuccess = true
)

func (PrefixDeleteResponseSuccess) IsKnown 

func (r PrefixDeleteResponseSuccess) IsKnown() bool

type PrefixEditParams 

type PrefixEditParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Description of the prefix.
	Description param.Field[string] `json:"description,required"`
}

func (PrefixEditParams) MarshalJSON 

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

type PrefixEditResponseEnvelope 

type PrefixEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixEditResponseEnvelopeSuccess `json:"success,required"`
	Result  Prefix                            `json:"result"`
	JSON    prefixEditResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixEditResponseEnvelope) UnmarshalJSON 

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

type PrefixEditResponseEnvelopeSuccess 

type PrefixEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixEditResponseEnvelopeSuccessTrue PrefixEditResponseEnvelopeSuccess = true
)

func (PrefixEditResponseEnvelopeSuccess) IsKnown 

func (r PrefixEditResponseEnvelopeSuccess) IsKnown() bool

type PrefixGetParams 

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

type PrefixGetResponseEnvelope 

type PrefixGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixGetResponseEnvelopeSuccess `json:"success,required"`
	Result  Prefix                           `json:"result"`
	JSON    prefixGetResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixGetResponseEnvelope) UnmarshalJSON 

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

type PrefixGetResponseEnvelopeSuccess 

type PrefixGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixGetResponseEnvelopeSuccessTrue PrefixGetResponseEnvelopeSuccess = true
)

func (PrefixGetResponseEnvelopeSuccess) IsKnown 

func (r PrefixGetResponseEnvelopeSuccess) IsKnown() bool

type PrefixListParams 

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

type PrefixNewParams 

type PrefixNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Autonomous System Number (ASN) the prefix will be advertised under.
	ASN param.Field[int64] `json:"asn,required"`
	// IP Prefix in Classless Inter-Domain Routing format.
	CIDR param.Field[string] `json:"cidr,required"`
	// Identifier for the uploaded LOA document.
	LOADocumentID param.Field[string] `json:"loa_document_id,required"`
}

func (PrefixNewParams) MarshalJSON 

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

type PrefixNewResponseEnvelope 

type PrefixNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success PrefixNewResponseEnvelopeSuccess `json:"success,required"`
	Result  Prefix                           `json:"result"`
	JSON    prefixNewResponseEnvelopeJSON    `json:"-"`
}

func (*PrefixNewResponseEnvelope) UnmarshalJSON 

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

type PrefixNewResponseEnvelopeSuccess 

type PrefixNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	PrefixNewResponseEnvelopeSuccessTrue PrefixNewResponseEnvelopeSuccess = true
)

func (PrefixNewResponseEnvelopeSuccess) IsKnown 

func (r PrefixNewResponseEnvelopeSuccess) IsKnown() bool

type PrefixService 

type PrefixService struct {
	Options     []option.RequestOption
	BGP         *PrefixBGPService
	Delegations *PrefixDelegationService
}

PrefixService 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 NewPrefixService method instead.

func NewPrefixService 

func NewPrefixService(opts ...option.RequestOption) (r *PrefixService)

NewPrefixService 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 (*PrefixService) Delete 

func (r *PrefixService) Delete(ctx context.Context, prefixID string, body PrefixDeleteParams, opts ...option.RequestOption) (res *PrefixDeleteResponse, err error)

Delete an unapproved prefix owned by the account.

func (*PrefixService) Edit 

func (r *PrefixService) Edit(ctx context.Context, prefixID string, params PrefixEditParams, opts ...option.RequestOption) (res *Prefix, err error)

Modify the description for a prefix owned by the account.

func (*PrefixService) Get 

func (r *PrefixService) Get(ctx context.Context, prefixID string, query PrefixGetParams, opts ...option.RequestOption) (res *Prefix, err error)

List a particular prefix owned by the account.

func (*PrefixService) List 

func (r *PrefixService) List(ctx context.Context, query PrefixListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Prefix], err error)

List all prefixes owned by the account.

func (*PrefixService) ListAutoPaging 

func (r *PrefixService) ListAutoPaging(ctx context.Context, query PrefixListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Prefix]

List all prefixes owned by the account.

func (*PrefixService) New 

func (r *PrefixService) New(ctx context.Context, params PrefixNewParams, opts ...option.RequestOption) (res *Prefix, err error)

Add a new prefix under the account.

type RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

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 RegionalHostnameDeleteParams 

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

type RegionalHostnameDeleteResponse 

type RegionalHostnameDeleteResponse struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success RegionalHostnameDeleteResponseSuccess `json:"success,required"`
	JSON    regionalHostnameDeleteResponseJSON    `json:"-"`
}

func (*RegionalHostnameDeleteResponse) UnmarshalJSON 

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

type RegionalHostnameDeleteResponseSuccess 

type RegionalHostnameDeleteResponseSuccess bool

Whether the API call was successful 

const (
	RegionalHostnameDeleteResponseSuccessTrue RegionalHostnameDeleteResponseSuccess = true
)

func (RegionalHostnameDeleteResponseSuccess) IsKnown 

func (r RegionalHostnameDeleteResponseSuccess) IsKnown() bool

type RegionalHostnameEditParams 

type RegionalHostnameEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Identifying key for the region
	RegionKey param.Field[string] `json:"region_key,required"`
}

func (RegionalHostnameEditParams) MarshalJSON 

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

type RegionalHostnameEditResponse 

type RegionalHostnameEditResponse struct {
	// When the regional hostname was created
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are
	// supported for one level, e.g `*.example.com`
	Hostname string `json:"hostname,required"`
	// Identifying key for the region
	RegionKey string                           `json:"region_key,required"`
	JSON      regionalHostnameEditResponseJSON `json:"-"`
}

func (*RegionalHostnameEditResponse) UnmarshalJSON 

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

type RegionalHostnameEditResponseEnvelope 

type RegionalHostnameEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success RegionalHostnameEditResponseEnvelopeSuccess `json:"success,required"`
	Result  RegionalHostnameEditResponse                `json:"result"`
	JSON    regionalHostnameEditResponseEnvelopeJSON    `json:"-"`
}

func (*RegionalHostnameEditResponseEnvelope) UnmarshalJSON 

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

type RegionalHostnameEditResponseEnvelopeSuccess 

type RegionalHostnameEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RegionalHostnameEditResponseEnvelopeSuccessTrue RegionalHostnameEditResponseEnvelopeSuccess = true
)

func (RegionalHostnameEditResponseEnvelopeSuccess) IsKnown 

func (r RegionalHostnameEditResponseEnvelopeSuccess) IsKnown() bool

type RegionalHostnameGetParams 

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

type RegionalHostnameGetResponse 

type RegionalHostnameGetResponse struct {
	// When the regional hostname was created
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are
	// supported for one level, e.g `*.example.com`
	Hostname string `json:"hostname,required"`
	// Identifying key for the region
	RegionKey string                          `json:"region_key,required"`
	JSON      regionalHostnameGetResponseJSON `json:"-"`
}

func (*RegionalHostnameGetResponse) UnmarshalJSON 

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

type RegionalHostnameGetResponseEnvelope 

type RegionalHostnameGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success RegionalHostnameGetResponseEnvelopeSuccess `json:"success,required"`
	Result  RegionalHostnameGetResponse                `json:"result"`
	JSON    regionalHostnameGetResponseEnvelopeJSON    `json:"-"`
}

func (*RegionalHostnameGetResponseEnvelope) UnmarshalJSON 

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

type RegionalHostnameGetResponseEnvelopeSuccess 

type RegionalHostnameGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RegionalHostnameGetResponseEnvelopeSuccessTrue RegionalHostnameGetResponseEnvelopeSuccess = true
)

func (RegionalHostnameGetResponseEnvelopeSuccess) IsKnown 

func (r RegionalHostnameGetResponseEnvelopeSuccess) IsKnown() bool

type RegionalHostnameListParams 

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

type RegionalHostnameListResponse 

type RegionalHostnameListResponse struct {
	// When the regional hostname was created
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are
	// supported for one level, e.g `*.example.com`
	Hostname string `json:"hostname,required"`
	// Identifying key for the region
	RegionKey string                           `json:"region_key,required"`
	JSON      regionalHostnameListResponseJSON `json:"-"`
}

func (*RegionalHostnameListResponse) UnmarshalJSON 

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

type RegionalHostnameNewParams 

type RegionalHostnameNewParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are
	// supported for one level, e.g `*.example.com`
	Hostname param.Field[string] `json:"hostname,required"`
	// Identifying key for the region
	RegionKey param.Field[string] `json:"region_key,required"`
}

func (RegionalHostnameNewParams) MarshalJSON 

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

type RegionalHostnameNewResponse 

type RegionalHostnameNewResponse struct {
	// When the regional hostname was created
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are
	// supported for one level, e.g `*.example.com`
	Hostname string `json:"hostname,required"`
	// Identifying key for the region
	RegionKey string                          `json:"region_key,required"`
	JSON      regionalHostnameNewResponseJSON `json:"-"`
}

func (*RegionalHostnameNewResponse) UnmarshalJSON 

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

type RegionalHostnameNewResponseEnvelope 

type RegionalHostnameNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success RegionalHostnameNewResponseEnvelopeSuccess `json:"success,required"`
	Result  RegionalHostnameNewResponse                `json:"result"`
	JSON    regionalHostnameNewResponseEnvelopeJSON    `json:"-"`
}

func (*RegionalHostnameNewResponseEnvelope) UnmarshalJSON 

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

type RegionalHostnameNewResponseEnvelopeSuccess 

type RegionalHostnameNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RegionalHostnameNewResponseEnvelopeSuccessTrue RegionalHostnameNewResponseEnvelopeSuccess = true
)

func (RegionalHostnameNewResponseEnvelopeSuccess) IsKnown 

func (r RegionalHostnameNewResponseEnvelopeSuccess) IsKnown() bool

type RegionalHostnameRegionListParams 

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

type RegionalHostnameRegionListResponse 

type RegionalHostnameRegionListResponse struct {
	// Identifying key for the region
	Key string `json:"key"`
	// Human-readable text label for the region
	Label string                                 `json:"label"`
	JSON  regionalHostnameRegionListResponseJSON `json:"-"`
}

func (*RegionalHostnameRegionListResponse) UnmarshalJSON 

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

type RegionalHostnameRegionService 

type RegionalHostnameRegionService struct {
	Options []option.RequestOption
}

RegionalHostnameRegionService 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 NewRegionalHostnameRegionService method instead.

func NewRegionalHostnameRegionService 

func NewRegionalHostnameRegionService(opts ...option.RequestOption) (r *RegionalHostnameRegionService)

NewRegionalHostnameRegionService 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 (*RegionalHostnameRegionService) List 

func (r *RegionalHostnameRegionService) List(ctx context.Context, query RegionalHostnameRegionListParams, opts ...option.RequestOption) (res *pagination.SinglePage[RegionalHostnameRegionListResponse], err error)

List all Regional Services regions available for use by this account.

func (*RegionalHostnameRegionService) ListAutoPaging 

func (r *RegionalHostnameRegionService) ListAutoPaging(ctx context.Context, query RegionalHostnameRegionListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RegionalHostnameRegionListResponse]

List all Regional Services regions available for use by this account.

type RegionalHostnameService 

type RegionalHostnameService struct {
	Options []option.RequestOption
	Regions *RegionalHostnameRegionService
}

RegionalHostnameService 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 NewRegionalHostnameService method instead.

func NewRegionalHostnameService 

func NewRegionalHostnameService(opts ...option.RequestOption) (r *RegionalHostnameService)

NewRegionalHostnameService 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 (*RegionalHostnameService) Delete 

func (r *RegionalHostnameService) Delete(ctx context.Context, hostname string, body RegionalHostnameDeleteParams, opts ...option.RequestOption) (res *RegionalHostnameDeleteResponse, err error)

Delete the region configuration for a specific Regional Hostname.

func (*RegionalHostnameService) Edit 

func (r *RegionalHostnameService) Edit(ctx context.Context, hostname string, params RegionalHostnameEditParams, opts ...option.RequestOption) (res *RegionalHostnameEditResponse, err error)

Update the configuration for a specific Regional Hostname. Only the region_key of a hostname is mutable.

func (*RegionalHostnameService) Get 

func (r *RegionalHostnameService) Get(ctx context.Context, hostname string, query RegionalHostnameGetParams, opts ...option.RequestOption) (res *RegionalHostnameGetResponse, err error)

Fetch the configuration for a specific Regional Hostname, within a zone.

func (*RegionalHostnameService) List 

func (r *RegionalHostnameService) List(ctx context.Context, query RegionalHostnameListParams, opts ...option.RequestOption) (res *pagination.SinglePage[RegionalHostnameListResponse], err error)

List all Regional Hostnames within a zone.

func (*RegionalHostnameService) ListAutoPaging 

func (r *RegionalHostnameService) ListAutoPaging(ctx context.Context, query RegionalHostnameListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RegionalHostnameListResponse]

List all Regional Hostnames within a zone.

func (*RegionalHostnameService) New 

func (r *RegionalHostnameService) New(ctx context.Context, params RegionalHostnameNewParams, opts ...option.RequestOption) (res *RegionalHostnameNewResponse, err error)

Create a new Regional Hostname entry. Cloudflare will only use data centers that are physically located within the chosen region to decrypt and service HTTPS traffic. Learn more about [Regional Services](https://developers.cloudflare.com/data-localization/regional-services/get-started/).

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

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

type ServiceBinding struct {
	// Identifier
	ID string `json:"id"`
	// IP Prefix in Classless Inter-Domain Routing format.
	CIDR string `json:"cidr"`
	// Status of a Service Binding's deployment to the Cloudflare network
	Provisioning ServiceBindingProvisioning `json:"provisioning"`
	// Identifier
	ServiceID string `json:"service_id"`
	// Name of a service running on the Cloudflare network
	ServiceName string             `json:"service_name"`
	JSON        serviceBindingJSON `json:"-"`
}

func (*ServiceBinding) UnmarshalJSON 

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

type ServiceBindingProvisioning 

type ServiceBindingProvisioning struct {
	// When a binding has been deployed to a majority of Cloudflare datacenters, the
	// binding will become active and can be used with its associated service.
	State ServiceBindingProvisioningState `json:"state"`
	JSON  serviceBindingProvisioningJSON  `json:"-"`
}

Status of a Service Binding's deployment to the Cloudflare network

func (*ServiceBindingProvisioning) UnmarshalJSON 

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

type ServiceBindingProvisioningState 

type ServiceBindingProvisioningState string

When a binding has been deployed to a majority of Cloudflare datacenters, the binding will become active and can be used with its associated service. 

const (
	ServiceBindingProvisioningStateProvisioning ServiceBindingProvisioningState = "provisioning"
	ServiceBindingProvisioningStateActive       ServiceBindingProvisioningState = "active"
)

func (ServiceBindingProvisioningState) IsKnown 

func (r ServiceBindingProvisioningState) IsKnown() bool

type ServiceListParams 

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

type ServiceListResponse 

type ServiceListResponse struct {
	// Identifier
	ID string `json:"id"`
	// Name of a service running on the Cloudflare network
	Name string                  `json:"name"`
	JSON serviceListResponseJSON `json:"-"`
}

func (*ServiceListResponse) UnmarshalJSON 

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

type ServiceService 

type ServiceService struct {
	Options []option.RequestOption
}

ServiceService 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 NewServiceService method instead.

func NewServiceService 

func NewServiceService(opts ...option.RequestOption) (r *ServiceService)

NewServiceService 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 (*ServiceService) List 

func (r *ServiceService) List(ctx context.Context, query ServiceListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ServiceListResponse], err error)

Bring-Your-Own IP (BYOIP) prefixes onboarded to Cloudflare must be bound to a service running on the Cloudflare network to enable a Cloudflare product on the IP addresses. This endpoint can be used as a reference of available services on the Cloudflare network, and their service IDs.

func (*ServiceService) ListAutoPaging 

func (r *ServiceService) ListAutoPaging(ctx context.Context, query ServiceListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ServiceListResponse]

Bring-Your-Own IP (BYOIP) prefixes onboarded to Cloudflare must be bound to a service running on the Cloudflare network to enable a Cloudflare product on the IP addresses. This endpoint can be used as a reference of available services on the Cloudflare network, and their service IDs.

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 TokenPolicyResources 

type TokenPolicyResources = shared.TokenPolicyResources

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesParam 

type TokenPolicyResourcesParam = shared.TokenPolicyResourcesParam

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.

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.