Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AddressMap
- type AddressMapAccountDeleteParams
- type AddressMapAccountDeleteResponse
- type AddressMapAccountDeleteResponseError
- type AddressMapAccountDeleteResponseErrorsSource
- type AddressMapAccountDeleteResponseMessage
- type AddressMapAccountDeleteResponseMessagesSource
- type AddressMapAccountDeleteResponseResultInfo
- type AddressMapAccountDeleteResponseSuccess
- type AddressMapAccountService
- func (r *AddressMapAccountService) Delete(ctx context.Context, addressMapID string, body AddressMapAccountDeleteParams, ...) (res *AddressMapAccountDeleteResponse, err error)
- func (r *AddressMapAccountService) Update(ctx context.Context, addressMapID string, params AddressMapAccountUpdateParams, ...) (res *AddressMapAccountUpdateResponse, err error)
- type AddressMapAccountUpdateParams
- type AddressMapAccountUpdateResponse
- type AddressMapAccountUpdateResponseError
- type AddressMapAccountUpdateResponseErrorsSource
- type AddressMapAccountUpdateResponseMessage
- type AddressMapAccountUpdateResponseMessagesSource
- type AddressMapAccountUpdateResponseResultInfo
- type AddressMapAccountUpdateResponseSuccess
- type AddressMapDeleteParams
- type AddressMapDeleteResponse
- type AddressMapDeleteResponseError
- type AddressMapDeleteResponseErrorsSource
- type AddressMapDeleteResponseMessage
- type AddressMapDeleteResponseMessagesSource
- type AddressMapDeleteResponseResultInfo
- type AddressMapDeleteResponseSuccess
- type AddressMapEditParams
- type AddressMapEditResponseEnvelope
- type AddressMapEditResponseEnvelopeErrors
- type AddressMapEditResponseEnvelopeErrorsSource
- type AddressMapEditResponseEnvelopeMessages
- type AddressMapEditResponseEnvelopeMessagesSource
- type AddressMapEditResponseEnvelopeSuccess
- type AddressMapGetParams
- type AddressMapGetResponse
- type AddressMapGetResponseEnvelope
- type AddressMapGetResponseEnvelopeErrors
- type AddressMapGetResponseEnvelopeErrorsSource
- type AddressMapGetResponseEnvelopeMessages
- type AddressMapGetResponseEnvelopeMessagesSource
- type AddressMapGetResponseEnvelopeSuccess
- type AddressMapGetResponseIP
- type AddressMapGetResponseMembership
- type AddressMapIPDeleteParams
- type AddressMapIPDeleteResponse
- type AddressMapIPDeleteResponseError
- type AddressMapIPDeleteResponseErrorsSource
- type AddressMapIPDeleteResponseMessage
- type AddressMapIPDeleteResponseMessagesSource
- type AddressMapIPDeleteResponseResultInfo
- type AddressMapIPDeleteResponseSuccess
- type AddressMapIPService
- type AddressMapIPUpdateParams
- type AddressMapIPUpdateResponse
- type AddressMapIPUpdateResponseError
- type AddressMapIPUpdateResponseErrorsSource
- type AddressMapIPUpdateResponseMessage
- type AddressMapIPUpdateResponseMessagesSource
- type AddressMapIPUpdateResponseResultInfo
- type AddressMapIPUpdateResponseSuccess
- type AddressMapListParams
- type AddressMapNewParams
- type AddressMapNewParamsMembership
- type AddressMapNewResponse
- type AddressMapNewResponseEnvelope
- type AddressMapNewResponseEnvelopeErrors
- type AddressMapNewResponseEnvelopeErrorsSource
- type AddressMapNewResponseEnvelopeMessages
- type AddressMapNewResponseEnvelopeMessagesSource
- type AddressMapNewResponseEnvelopeSuccess
- type AddressMapNewResponseIP
- type AddressMapNewResponseMembership
- type AddressMapService
- func (r *AddressMapService) Delete(ctx context.Context, addressMapID string, body AddressMapDeleteParams, ...) (res *AddressMapDeleteResponse, err error)
- func (r *AddressMapService) Edit(ctx context.Context, addressMapID string, params AddressMapEditParams, ...) (res *AddressMap, err error)
- func (r *AddressMapService) Get(ctx context.Context, addressMapID string, query AddressMapGetParams, ...) (res *AddressMapGetResponse, err error)
- func (r *AddressMapService) List(ctx context.Context, query AddressMapListParams, opts ...option.RequestOption) (res *pagination.SinglePage[AddressMap], err error)
- func (r *AddressMapService) ListAutoPaging(ctx context.Context, query AddressMapListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AddressMap]
- func (r *AddressMapService) New(ctx context.Context, params AddressMapNewParams, opts ...option.RequestOption) (res *AddressMapNewResponse, err error)
- type AddressMapZoneDeleteParams
- type AddressMapZoneDeleteResponse
- type AddressMapZoneDeleteResponseError
- type AddressMapZoneDeleteResponseErrorsSource
- type AddressMapZoneDeleteResponseMessage
- type AddressMapZoneDeleteResponseMessagesSource
- type AddressMapZoneDeleteResponseResultInfo
- type AddressMapZoneDeleteResponseSuccess
- type AddressMapZoneService
- func (r *AddressMapZoneService) Delete(ctx context.Context, addressMapID string, body AddressMapZoneDeleteParams, ...) (res *AddressMapZoneDeleteResponse, err error)
- func (r *AddressMapZoneService) Update(ctx context.Context, addressMapID string, params AddressMapZoneUpdateParams, ...) (res *AddressMapZoneUpdateResponse, err error)
- type AddressMapZoneUpdateParams
- type AddressMapZoneUpdateResponse
- type AddressMapZoneUpdateResponseError
- type AddressMapZoneUpdateResponseErrorsSource
- type AddressMapZoneUpdateResponseMessage
- type AddressMapZoneUpdateResponseMessagesSource
- type AddressMapZoneUpdateResponseResultInfo
- type AddressMapZoneUpdateResponseSuccess
- type AddressingService
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type BGPPrefix
- type BGPPrefixBGPSignalOpts
- type BGPPrefixOnDemand
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Delegations
- type Error
- type ErrorData
- type ErrorDataSource
- type Kind
- type LOADocumentGetParams
- type LOADocumentNewParams
- type LOADocumentNewResponse
- type LOADocumentNewResponseEnvelope
- type LOADocumentNewResponseEnvelopeErrors
- type LOADocumentNewResponseEnvelopeErrorsSource
- type LOADocumentNewResponseEnvelopeMessages
- type LOADocumentNewResponseEnvelopeMessagesSource
- type LOADocumentNewResponseEnvelopeSuccess
- type LOADocumentService
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type Prefix
- type PrefixAdvertisementStatusEditParams
- type PrefixAdvertisementStatusEditResponse
- type PrefixAdvertisementStatusEditResponseEnvelope
- type PrefixAdvertisementStatusEditResponseEnvelopeErrors
- type PrefixAdvertisementStatusEditResponseEnvelopeErrorsSource
- type PrefixAdvertisementStatusEditResponseEnvelopeMessages
- type PrefixAdvertisementStatusEditResponseEnvelopeMessagesSource
- type PrefixAdvertisementStatusEditResponseEnvelopeSuccess
- type PrefixAdvertisementStatusGetParams
- type PrefixAdvertisementStatusGetResponse
- type PrefixAdvertisementStatusGetResponseEnvelope
- type PrefixAdvertisementStatusGetResponseEnvelopeErrors
- type PrefixAdvertisementStatusGetResponseEnvelopeErrorsSource
- type PrefixAdvertisementStatusGetResponseEnvelopeMessages
- type PrefixAdvertisementStatusGetResponseEnvelopeMessagesSource
- type PrefixAdvertisementStatusGetResponseEnvelopeSuccess
- type PrefixAdvertisementStatusService
- func (r *PrefixAdvertisementStatusService) Edit(ctx context.Context, prefixID string, ...) (res *PrefixAdvertisementStatusEditResponse, err error)
- func (r *PrefixAdvertisementStatusService) Get(ctx context.Context, prefixID string, query PrefixAdvertisementStatusGetParams, ...) (res *PrefixAdvertisementStatusGetResponse, err error)
- type PrefixBGPPrefixEditParams
- type PrefixBGPPrefixEditParamsOnDemand
- type PrefixBGPPrefixEditResponseEnvelope
- type PrefixBGPPrefixEditResponseEnvelopeErrors
- type PrefixBGPPrefixEditResponseEnvelopeErrorsSource
- type PrefixBGPPrefixEditResponseEnvelopeMessages
- type PrefixBGPPrefixEditResponseEnvelopeMessagesSource
- type PrefixBGPPrefixEditResponseEnvelopeSuccess
- type PrefixBGPPrefixGetParams
- type PrefixBGPPrefixGetResponseEnvelope
- type PrefixBGPPrefixGetResponseEnvelopeErrors
- type PrefixBGPPrefixGetResponseEnvelopeErrorsSource
- type PrefixBGPPrefixGetResponseEnvelopeMessages
- type PrefixBGPPrefixGetResponseEnvelopeMessagesSource
- type PrefixBGPPrefixGetResponseEnvelopeSuccess
- type PrefixBGPPrefixListParams
- type PrefixBGPPrefixNewParams
- type PrefixBGPPrefixNewResponseEnvelope
- type PrefixBGPPrefixNewResponseEnvelopeErrors
- type PrefixBGPPrefixNewResponseEnvelopeErrorsSource
- type PrefixBGPPrefixNewResponseEnvelopeMessages
- type PrefixBGPPrefixNewResponseEnvelopeMessagesSource
- type PrefixBGPPrefixNewResponseEnvelopeSuccess
- type PrefixBGPPrefixService
- func (r *PrefixBGPPrefixService) Edit(ctx context.Context, prefixID string, bgpPrefixID string, ...) (res *BGPPrefix, err error)
- func (r *PrefixBGPPrefixService) Get(ctx context.Context, prefixID string, bgpPrefixID string, ...) (res *BGPPrefix, err error)
- func (r *PrefixBGPPrefixService) List(ctx context.Context, prefixID string, query PrefixBGPPrefixListParams, ...) (res *pagination.SinglePage[BGPPrefix], err error)
- func (r *PrefixBGPPrefixService) ListAutoPaging(ctx context.Context, prefixID string, query PrefixBGPPrefixListParams, ...) *pagination.SinglePageAutoPager[BGPPrefix]
- func (r *PrefixBGPPrefixService) New(ctx context.Context, prefixID string, params PrefixBGPPrefixNewParams, ...) (res *BGPPrefix, err error)
- type PrefixDelegationDeleteParams
- type PrefixDelegationDeleteResponse
- type PrefixDelegationDeleteResponseEnvelope
- type PrefixDelegationDeleteResponseEnvelopeErrors
- type PrefixDelegationDeleteResponseEnvelopeErrorsSource
- type PrefixDelegationDeleteResponseEnvelopeMessages
- type PrefixDelegationDeleteResponseEnvelopeMessagesSource
- type PrefixDelegationDeleteResponseEnvelopeSuccess
- type PrefixDelegationListParams
- type PrefixDelegationNewParams
- type PrefixDelegationNewResponseEnvelope
- type PrefixDelegationNewResponseEnvelopeErrors
- type PrefixDelegationNewResponseEnvelopeErrorsSource
- type PrefixDelegationNewResponseEnvelopeMessages
- type PrefixDelegationNewResponseEnvelopeMessagesSource
- type PrefixDelegationNewResponseEnvelopeSuccess
- type PrefixDelegationService
- func (r *PrefixDelegationService) Delete(ctx context.Context, prefixID string, delegationID string, ...) (res *PrefixDelegationDeleteResponse, err error)
- func (r *PrefixDelegationService) List(ctx context.Context, prefixID string, query PrefixDelegationListParams, ...) (res *pagination.SinglePage[Delegations], err error)
- func (r *PrefixDelegationService) ListAutoPaging(ctx context.Context, prefixID string, query PrefixDelegationListParams, ...) *pagination.SinglePageAutoPager[Delegations]
- func (r *PrefixDelegationService) New(ctx context.Context, prefixID string, params PrefixDelegationNewParams, ...) (res *Delegations, err error)
- type PrefixDeleteParams
- type PrefixDeleteResponse
- type PrefixDeleteResponseError
- type PrefixDeleteResponseErrorsSource
- type PrefixDeleteResponseMessage
- type PrefixDeleteResponseMessagesSource
- type PrefixDeleteResponseResultInfo
- type PrefixDeleteResponseSuccess
- type PrefixEditParams
- type PrefixEditResponseEnvelope
- type PrefixEditResponseEnvelopeErrors
- type PrefixEditResponseEnvelopeErrorsSource
- type PrefixEditResponseEnvelopeMessages
- type PrefixEditResponseEnvelopeMessagesSource
- type PrefixEditResponseEnvelopeSuccess
- type PrefixGetParams
- type PrefixGetResponseEnvelope
- type PrefixGetResponseEnvelopeErrors
- type PrefixGetResponseEnvelopeErrorsSource
- type PrefixGetResponseEnvelopeMessages
- type PrefixGetResponseEnvelopeMessagesSource
- type PrefixGetResponseEnvelopeSuccess
- type PrefixListParams
- type PrefixNewParams
- type PrefixNewResponseEnvelope
- type PrefixNewResponseEnvelopeErrors
- type PrefixNewResponseEnvelopeErrorsSource
- type PrefixNewResponseEnvelopeMessages
- type PrefixNewResponseEnvelopeMessagesSource
- type PrefixNewResponseEnvelopeSuccess
- type PrefixService
- func (r *PrefixService) Delete(ctx context.Context, prefixID string, body PrefixDeleteParams, ...) (res *PrefixDeleteResponse, err error)
- func (r *PrefixService) Edit(ctx context.Context, prefixID string, params PrefixEditParams, ...) (res *Prefix, err error)
- func (r *PrefixService) Get(ctx context.Context, prefixID string, query PrefixGetParams, ...) (res *Prefix, err error)
- func (r *PrefixService) List(ctx context.Context, query PrefixListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Prefix], err error)
- func (r *PrefixService) ListAutoPaging(ctx context.Context, query PrefixListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Prefix]
- func (r *PrefixService) New(ctx context.Context, params PrefixNewParams, opts ...option.RequestOption) (res *Prefix, err error)
- type PrefixServiceBindingDeleteParams
- type PrefixServiceBindingDeleteResponse
- type PrefixServiceBindingDeleteResponseError
- type PrefixServiceBindingDeleteResponseErrorsSource
- type PrefixServiceBindingDeleteResponseMessage
- type PrefixServiceBindingDeleteResponseMessagesSource
- type PrefixServiceBindingDeleteResponseSuccess
- type PrefixServiceBindingGetParams
- type PrefixServiceBindingGetResponseEnvelope
- type PrefixServiceBindingGetResponseEnvelopeErrors
- type PrefixServiceBindingGetResponseEnvelopeErrorsSource
- type PrefixServiceBindingGetResponseEnvelopeMessages
- type PrefixServiceBindingGetResponseEnvelopeMessagesSource
- type PrefixServiceBindingGetResponseEnvelopeSuccess
- type PrefixServiceBindingListParams
- type PrefixServiceBindingNewParams
- type PrefixServiceBindingNewResponseEnvelope
- type PrefixServiceBindingNewResponseEnvelopeErrors
- type PrefixServiceBindingNewResponseEnvelopeErrorsSource
- type PrefixServiceBindingNewResponseEnvelopeMessages
- type PrefixServiceBindingNewResponseEnvelopeMessagesSource
- type PrefixServiceBindingNewResponseEnvelopeSuccess
- type PrefixServiceBindingService
- func (r *PrefixServiceBindingService) Delete(ctx context.Context, prefixID string, bindingID string, ...) (res *PrefixServiceBindingDeleteResponse, err error)
- func (r *PrefixServiceBindingService) Get(ctx context.Context, prefixID string, bindingID string, ...) (res *ServiceBinding, err error)
- func (r *PrefixServiceBindingService) List(ctx context.Context, prefixID string, query PrefixServiceBindingListParams, ...) (res *pagination.SinglePage[ServiceBinding], err error)
- func (r *PrefixServiceBindingService) ListAutoPaging(ctx context.Context, prefixID string, query PrefixServiceBindingListParams, ...) *pagination.SinglePageAutoPager[ServiceBinding]
- func (r *PrefixServiceBindingService) New(ctx context.Context, prefixID string, params PrefixServiceBindingNewParams, ...) (res *ServiceBinding, err error)
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type RegionalHostnameDeleteParams
- type RegionalHostnameDeleteResponse
- type RegionalHostnameDeleteResponseError
- type RegionalHostnameDeleteResponseErrorsSource
- type RegionalHostnameDeleteResponseMessage
- type RegionalHostnameDeleteResponseMessagesSource
- type RegionalHostnameDeleteResponseSuccess
- type RegionalHostnameEditParams
- type RegionalHostnameEditResponse
- type RegionalHostnameEditResponseEnvelope
- type RegionalHostnameEditResponseEnvelopeErrors
- type RegionalHostnameEditResponseEnvelopeErrorsSource
- type RegionalHostnameEditResponseEnvelopeMessages
- type RegionalHostnameEditResponseEnvelopeMessagesSource
- type RegionalHostnameEditResponseEnvelopeSuccess
- type RegionalHostnameGetParams
- type RegionalHostnameGetResponse
- type RegionalHostnameGetResponseEnvelope
- type RegionalHostnameGetResponseEnvelopeErrors
- type RegionalHostnameGetResponseEnvelopeErrorsSource
- type RegionalHostnameGetResponseEnvelopeMessages
- type RegionalHostnameGetResponseEnvelopeMessagesSource
- type RegionalHostnameGetResponseEnvelopeSuccess
- type RegionalHostnameListParams
- type RegionalHostnameListResponse
- type RegionalHostnameNewParams
- type RegionalHostnameNewResponse
- type RegionalHostnameNewResponseEnvelope
- type RegionalHostnameNewResponseEnvelopeErrors
- type RegionalHostnameNewResponseEnvelopeErrorsSource
- type RegionalHostnameNewResponseEnvelopeMessages
- type RegionalHostnameNewResponseEnvelopeMessagesSource
- type RegionalHostnameNewResponseEnvelopeSuccess
- type RegionalHostnameRegionListParams
- type RegionalHostnameRegionListResponse
- type RegionalHostnameRegionService
- func (r *RegionalHostnameRegionService) List(ctx context.Context, query RegionalHostnameRegionListParams, ...) (res *pagination.SinglePage[RegionalHostnameRegionListResponse], err error)
- func (r *RegionalHostnameRegionService) ListAutoPaging(ctx context.Context, query RegionalHostnameRegionListParams, ...) *pagination.SinglePageAutoPager[RegionalHostnameRegionListResponse]
- type RegionalHostnameService
- func (r *RegionalHostnameService) Delete(ctx context.Context, hostname string, body RegionalHostnameDeleteParams, ...) (res *RegionalHostnameDeleteResponse, err error)
- func (r *RegionalHostnameService) Edit(ctx context.Context, hostname string, params RegionalHostnameEditParams, ...) (res *RegionalHostnameEditResponse, err error)
- func (r *RegionalHostnameService) Get(ctx context.Context, hostname string, query RegionalHostnameGetParams, ...) (res *RegionalHostnameGetResponse, err error)
- func (r *RegionalHostnameService) List(ctx context.Context, query RegionalHostnameListParams, ...) (res *pagination.SinglePage[RegionalHostnameListResponse], err error)
- func (r *RegionalHostnameService) ListAutoPaging(ctx context.Context, query RegionalHostnameListParams, ...) *pagination.SinglePageAutoPager[RegionalHostnameListResponse]
- func (r *RegionalHostnameService) New(ctx context.Context, params RegionalHostnameNewParams, ...) (res *RegionalHostnameNewResponse, err error)
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type ServiceBinding
- type ServiceBindingProvisioning
- type ServiceBindingProvisioningState
- type ServiceListParams
- type ServiceListResponse
- type ServiceService
- func (r *ServiceService) List(ctx context.Context, query ServiceListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ServiceListResponse], err error)
- func (r *ServiceService) ListAutoPaging(ctx context.Context, query ServiceListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ServiceListResponse]
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddressMap ¶
type AddressMap struct {
// Identifier of an Address Map.
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 AddressMapAccountDeleteResponse ¶
type AddressMapAccountDeleteResponse struct {
Errors []AddressMapAccountDeleteResponseError `json:"errors,required"`
Messages []AddressMapAccountDeleteResponseMessage `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 AddressMapAccountDeleteResponseError ¶ added in v4.3.0
type AddressMapAccountDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapAccountDeleteResponseErrorsSource `json:"source"`
JSON addressMapAccountDeleteResponseErrorJSON `json:"-"`
}
func (*AddressMapAccountDeleteResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapAccountDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type AddressMapAccountDeleteResponseErrorsSource ¶ added in v4.3.0
type AddressMapAccountDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON addressMapAccountDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*AddressMapAccountDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapAccountDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type AddressMapAccountDeleteResponseMessage ¶ added in v4.3.0
type AddressMapAccountDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapAccountDeleteResponseMessagesSource `json:"source"`
JSON addressMapAccountDeleteResponseMessageJSON `json:"-"`
}
func (*AddressMapAccountDeleteResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapAccountDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type AddressMapAccountDeleteResponseMessagesSource ¶ added in v4.3.0
type AddressMapAccountDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON addressMapAccountDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*AddressMapAccountDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapAccountDeleteResponseMessagesSource) 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 of a Cloudflare account.
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 []AddressMapAccountUpdateResponseError `json:"errors,required"`
Messages []AddressMapAccountUpdateResponseMessage `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 AddressMapAccountUpdateResponseError ¶ added in v4.3.0
type AddressMapAccountUpdateResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapAccountUpdateResponseErrorsSource `json:"source"`
JSON addressMapAccountUpdateResponseErrorJSON `json:"-"`
}
func (*AddressMapAccountUpdateResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapAccountUpdateResponseError) UnmarshalJSON(data []byte) (err error)
type AddressMapAccountUpdateResponseErrorsSource ¶ added in v4.3.0
type AddressMapAccountUpdateResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON addressMapAccountUpdateResponseErrorsSourceJSON `json:"-"`
}
func (*AddressMapAccountUpdateResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapAccountUpdateResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type AddressMapAccountUpdateResponseMessage ¶ added in v4.3.0
type AddressMapAccountUpdateResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapAccountUpdateResponseMessagesSource `json:"source"`
JSON addressMapAccountUpdateResponseMessageJSON `json:"-"`
}
func (*AddressMapAccountUpdateResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapAccountUpdateResponseMessage) UnmarshalJSON(data []byte) (err error)
type AddressMapAccountUpdateResponseMessagesSource ¶ added in v4.3.0
type AddressMapAccountUpdateResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON addressMapAccountUpdateResponseMessagesSourceJSON `json:"-"`
}
func (*AddressMapAccountUpdateResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapAccountUpdateResponseMessagesSource) 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 AddressMapDeleteResponse ¶
type AddressMapDeleteResponse struct {
Errors []AddressMapDeleteResponseError `json:"errors,required"`
Messages []AddressMapDeleteResponseMessage `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 AddressMapDeleteResponseError ¶ added in v4.3.0
type AddressMapDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapDeleteResponseErrorsSource `json:"source"`
JSON addressMapDeleteResponseErrorJSON `json:"-"`
}
func (*AddressMapDeleteResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type AddressMapDeleteResponseErrorsSource ¶ added in v4.3.0
type AddressMapDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON addressMapDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*AddressMapDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type AddressMapDeleteResponseMessage ¶ added in v4.3.0
type AddressMapDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapDeleteResponseMessagesSource `json:"source"`
JSON addressMapDeleteResponseMessageJSON `json:"-"`
}
func (*AddressMapDeleteResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type AddressMapDeleteResponseMessagesSource ¶ added in v4.3.0
type AddressMapDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON addressMapDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*AddressMapDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapDeleteResponseMessagesSource) 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 of a Cloudflare account.
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 []AddressMapEditResponseEnvelopeErrors `json:"errors,required"`
Messages []AddressMapEditResponseEnvelopeMessages `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 AddressMapEditResponseEnvelopeErrors ¶ added in v4.3.0
type AddressMapEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapEditResponseEnvelopeErrorsSource `json:"source"`
JSON addressMapEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*AddressMapEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type AddressMapEditResponseEnvelopeErrorsSource ¶ added in v4.3.0
type AddressMapEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON addressMapEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*AddressMapEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type AddressMapEditResponseEnvelopeMessages ¶ added in v4.3.0
type AddressMapEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapEditResponseEnvelopeMessagesSource `json:"source"`
JSON addressMapEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*AddressMapEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type AddressMapEditResponseEnvelopeMessagesSource ¶ added in v4.3.0
type AddressMapEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON addressMapEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*AddressMapEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapEditResponseEnvelopeMessagesSource) 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 AddressMapGetResponse ¶
type AddressMapGetResponse struct {
// Identifier of an Address Map.
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 []AddressMapGetResponseEnvelopeErrors `json:"errors,required"`
Messages []AddressMapGetResponseEnvelopeMessages `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 AddressMapGetResponseEnvelopeErrors ¶ added in v4.3.0
type AddressMapGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapGetResponseEnvelopeErrorsSource `json:"source"`
JSON addressMapGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*AddressMapGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type AddressMapGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type AddressMapGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON addressMapGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*AddressMapGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type AddressMapGetResponseEnvelopeMessages ¶ added in v4.3.0
type AddressMapGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapGetResponseEnvelopeMessagesSource `json:"source"`
JSON addressMapGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*AddressMapGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type AddressMapGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type AddressMapGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON addressMapGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*AddressMapGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapGetResponseEnvelopeMessagesSource) 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 AddressMapIPDeleteResponse ¶
type AddressMapIPDeleteResponse struct {
Errors []AddressMapIPDeleteResponseError `json:"errors,required"`
Messages []AddressMapIPDeleteResponseMessage `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 AddressMapIPDeleteResponseError ¶ added in v4.3.0
type AddressMapIPDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapIPDeleteResponseErrorsSource `json:"source"`
JSON addressMapIPDeleteResponseErrorJSON `json:"-"`
}
func (*AddressMapIPDeleteResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapIPDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type AddressMapIPDeleteResponseErrorsSource ¶ added in v4.3.0
type AddressMapIPDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON addressMapIPDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*AddressMapIPDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapIPDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type AddressMapIPDeleteResponseMessage ¶ added in v4.3.0
type AddressMapIPDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapIPDeleteResponseMessagesSource `json:"source"`
JSON addressMapIPDeleteResponseMessageJSON `json:"-"`
}
func (*AddressMapIPDeleteResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapIPDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type AddressMapIPDeleteResponseMessagesSource ¶ added in v4.3.0
type AddressMapIPDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON addressMapIPDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*AddressMapIPDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapIPDeleteResponseMessagesSource) 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 of a Cloudflare account.
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 []AddressMapIPUpdateResponseError `json:"errors,required"`
Messages []AddressMapIPUpdateResponseMessage `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 AddressMapIPUpdateResponseError ¶ added in v4.3.0
type AddressMapIPUpdateResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapIPUpdateResponseErrorsSource `json:"source"`
JSON addressMapIPUpdateResponseErrorJSON `json:"-"`
}
func (*AddressMapIPUpdateResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapIPUpdateResponseError) UnmarshalJSON(data []byte) (err error)
type AddressMapIPUpdateResponseErrorsSource ¶ added in v4.3.0
type AddressMapIPUpdateResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON addressMapIPUpdateResponseErrorsSourceJSON `json:"-"`
}
func (*AddressMapIPUpdateResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapIPUpdateResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type AddressMapIPUpdateResponseMessage ¶ added in v4.3.0
type AddressMapIPUpdateResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapIPUpdateResponseMessagesSource `json:"source"`
JSON addressMapIPUpdateResponseMessageJSON `json:"-"`
}
func (*AddressMapIPUpdateResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapIPUpdateResponseMessage) UnmarshalJSON(data []byte) (err error)
type AddressMapIPUpdateResponseMessagesSource ¶ added in v4.3.0
type AddressMapIPUpdateResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON addressMapIPUpdateResponseMessagesSourceJSON `json:"-"`
}
func (*AddressMapIPUpdateResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapIPUpdateResponseMessagesSource) 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 AddressMapNewParams ¶
type AddressMapNewParams struct {
// Identifier of a Cloudflare account.
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 of an Address Map.
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 []AddressMapNewResponseEnvelopeErrors `json:"errors,required"`
Messages []AddressMapNewResponseEnvelopeMessages `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 AddressMapNewResponseEnvelopeErrors ¶ added in v4.3.0
type AddressMapNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapNewResponseEnvelopeErrorsSource `json:"source"`
JSON addressMapNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*AddressMapNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type AddressMapNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type AddressMapNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON addressMapNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*AddressMapNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type AddressMapNewResponseEnvelopeMessages ¶ added in v4.3.0
type AddressMapNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapNewResponseEnvelopeMessagesSource `json:"source"`
JSON addressMapNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*AddressMapNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type AddressMapNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type AddressMapNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON addressMapNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*AddressMapNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapNewResponseEnvelopeMessagesSource) 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 AddressMapZoneDeleteResponse ¶
type AddressMapZoneDeleteResponse struct {
Errors []AddressMapZoneDeleteResponseError `json:"errors,required"`
Messages []AddressMapZoneDeleteResponseMessage `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 AddressMapZoneDeleteResponseError ¶ added in v4.3.0
type AddressMapZoneDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapZoneDeleteResponseErrorsSource `json:"source"`
JSON addressMapZoneDeleteResponseErrorJSON `json:"-"`
}
func (*AddressMapZoneDeleteResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapZoneDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type AddressMapZoneDeleteResponseErrorsSource ¶ added in v4.3.0
type AddressMapZoneDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON addressMapZoneDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*AddressMapZoneDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapZoneDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type AddressMapZoneDeleteResponseMessage ¶ added in v4.3.0
type AddressMapZoneDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapZoneDeleteResponseMessagesSource `json:"source"`
JSON addressMapZoneDeleteResponseMessageJSON `json:"-"`
}
func (*AddressMapZoneDeleteResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapZoneDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type AddressMapZoneDeleteResponseMessagesSource ¶ added in v4.3.0
type AddressMapZoneDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON addressMapZoneDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*AddressMapZoneDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapZoneDeleteResponseMessagesSource) 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 of a zone.
ZoneID param.Field[string] `path:"zone_id,required"`
// Identifier of a Cloudflare account.
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 []AddressMapZoneUpdateResponseError `json:"errors,required"`
Messages []AddressMapZoneUpdateResponseMessage `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 AddressMapZoneUpdateResponseError ¶ added in v4.3.0
type AddressMapZoneUpdateResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapZoneUpdateResponseErrorsSource `json:"source"`
JSON addressMapZoneUpdateResponseErrorJSON `json:"-"`
}
func (*AddressMapZoneUpdateResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapZoneUpdateResponseError) UnmarshalJSON(data []byte) (err error)
type AddressMapZoneUpdateResponseErrorsSource ¶ added in v4.3.0
type AddressMapZoneUpdateResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON addressMapZoneUpdateResponseErrorsSourceJSON `json:"-"`
}
func (*AddressMapZoneUpdateResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapZoneUpdateResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type AddressMapZoneUpdateResponseMessage ¶ added in v4.3.0
type AddressMapZoneUpdateResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AddressMapZoneUpdateResponseMessagesSource `json:"source"`
JSON addressMapZoneUpdateResponseMessageJSON `json:"-"`
}
func (*AddressMapZoneUpdateResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapZoneUpdateResponseMessage) UnmarshalJSON(data []byte) (err error)
type AddressMapZoneUpdateResponseMessagesSource ¶ added in v4.3.0
type AddressMapZoneUpdateResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON addressMapZoneUpdateResponseMessagesSourceJSON `json:"-"`
}
func (*AddressMapZoneUpdateResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AddressMapZoneUpdateResponseMessagesSource) 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 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 of BGP Prefix.
ID string `json:"id"`
// Autonomous System Number (ASN) the prefix will be advertised under.
ASN int64 `json:"asn,nullable"`
// Number of times to prepend the Cloudflare ASN to the BGP AS-Path attribute
ASNPrependCount int64 `json:"asn_prepend_count"`
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"`
// Controls whether the BGP prefix is automatically withdrawn when prefix is
// withdrawn from Magic routing table (for Magic Transit customers using Direct
// CNI)
WithdrawIfNoRoute bool `json:"withdraw_if_no_route"`
JSON bgpPrefixJSON `json:"-"`
}
func (*BGPPrefix) UnmarshalJSON ¶
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 {
// Identifier of a Delegation.
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 of an IP Prefix.
ParentPrefixID string `json:"parent_prefix_id"`
JSON delegationsJSON `json:"-"`
}
func (*Delegations) UnmarshalJSON ¶
func (r *Delegations) UnmarshalJSON(data []byte) (err error)
type ErrorDataSource ¶ added in v4.2.0
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type LOADocumentGetParams ¶
type LOADocumentNewParams ¶
type LOADocumentNewParams struct {
// Identifier of a Cloudflare account.
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 of a Cloudflare account.
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 []LOADocumentNewResponseEnvelopeErrors `json:"errors,required"`
Messages []LOADocumentNewResponseEnvelopeMessages `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 LOADocumentNewResponseEnvelopeErrors ¶ added in v4.3.0
type LOADocumentNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source LOADocumentNewResponseEnvelopeErrorsSource `json:"source"`
JSON loaDocumentNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*LOADocumentNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *LOADocumentNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type LOADocumentNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type LOADocumentNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON loaDocumentNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*LOADocumentNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *LOADocumentNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type LOADocumentNewResponseEnvelopeMessages ¶ added in v4.3.0
type LOADocumentNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source LOADocumentNewResponseEnvelopeMessagesSource `json:"source"`
JSON loaDocumentNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*LOADocumentNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *LOADocumentNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type LOADocumentNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type LOADocumentNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON loaDocumentNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*LOADocumentNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *LOADocumentNewResponseEnvelopeMessagesSource) 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
}
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) Get ¶
func (r *LOADocumentService) Get(ctx context.Context, loaDocumentID string, query LOADocumentGetParams, opts ...option.RequestOption) (res *http.Response, err error)
Download specified LOA document under the account.
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 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 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 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 of an IP Prefix.
ID string `json:"id"`
// Identifier of a Cloudflare account.
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 ¶
type PrefixAdvertisementStatusEditParams ¶
type PrefixAdvertisementStatusEditParams struct {
// Identifier of a Cloudflare account.
AccountID param.Field[string] `path:"account_id,required"`
// Advertisement status of the prefix. If `true`, the BGP route for the prefix is
// advertised to the Internet. If `false`, the BGP route is withdrawn.
Advertised param.Field[bool] `json:"advertised,required"`
}
func (PrefixAdvertisementStatusEditParams) MarshalJSON ¶
func (r PrefixAdvertisementStatusEditParams) MarshalJSON() (data []byte, err error)
type PrefixAdvertisementStatusEditResponse ¶
type PrefixAdvertisementStatusEditResponse struct {
// Advertisement status of the prefix. If `true`, the BGP route for the prefix is
// advertised to the Internet. If `false`, the BGP route is withdrawn.
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 prefixAdvertisementStatusEditResponseJSON `json:"-"`
}
func (*PrefixAdvertisementStatusEditResponse) UnmarshalJSON ¶
func (r *PrefixAdvertisementStatusEditResponse) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusEditResponseEnvelope ¶
type PrefixAdvertisementStatusEditResponseEnvelope struct {
Errors []PrefixAdvertisementStatusEditResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixAdvertisementStatusEditResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success PrefixAdvertisementStatusEditResponseEnvelopeSuccess `json:"success,required"`
Result PrefixAdvertisementStatusEditResponse `json:"result"`
JSON prefixAdvertisementStatusEditResponseEnvelopeJSON `json:"-"`
}
func (*PrefixAdvertisementStatusEditResponseEnvelope) UnmarshalJSON ¶
func (r *PrefixAdvertisementStatusEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusEditResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixAdvertisementStatusEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixAdvertisementStatusEditResponseEnvelopeErrorsSource `json:"source"`
JSON prefixAdvertisementStatusEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixAdvertisementStatusEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixAdvertisementStatusEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusEditResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixAdvertisementStatusEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixAdvertisementStatusEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixAdvertisementStatusEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixAdvertisementStatusEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusEditResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixAdvertisementStatusEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixAdvertisementStatusEditResponseEnvelopeMessagesSource `json:"source"`
JSON prefixAdvertisementStatusEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixAdvertisementStatusEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixAdvertisementStatusEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusEditResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixAdvertisementStatusEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixAdvertisementStatusEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixAdvertisementStatusEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixAdvertisementStatusEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusEditResponseEnvelopeSuccess ¶
type PrefixAdvertisementStatusEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
PrefixAdvertisementStatusEditResponseEnvelopeSuccessTrue PrefixAdvertisementStatusEditResponseEnvelopeSuccess = true
)
func (PrefixAdvertisementStatusEditResponseEnvelopeSuccess) IsKnown ¶
func (r PrefixAdvertisementStatusEditResponseEnvelopeSuccess) IsKnown() bool
type PrefixAdvertisementStatusGetResponse ¶
type PrefixAdvertisementStatusGetResponse struct {
// Advertisement status of the prefix. If `true`, the BGP route for the prefix is
// advertised to the Internet. If `false`, the BGP route is withdrawn.
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 prefixAdvertisementStatusGetResponseJSON `json:"-"`
}
func (*PrefixAdvertisementStatusGetResponse) UnmarshalJSON ¶
func (r *PrefixAdvertisementStatusGetResponse) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusGetResponseEnvelope ¶
type PrefixAdvertisementStatusGetResponseEnvelope struct {
Errors []PrefixAdvertisementStatusGetResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixAdvertisementStatusGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success PrefixAdvertisementStatusGetResponseEnvelopeSuccess `json:"success,required"`
Result PrefixAdvertisementStatusGetResponse `json:"result"`
JSON prefixAdvertisementStatusGetResponseEnvelopeJSON `json:"-"`
}
func (*PrefixAdvertisementStatusGetResponseEnvelope) UnmarshalJSON ¶
func (r *PrefixAdvertisementStatusGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusGetResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixAdvertisementStatusGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixAdvertisementStatusGetResponseEnvelopeErrorsSource `json:"source"`
JSON prefixAdvertisementStatusGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixAdvertisementStatusGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixAdvertisementStatusGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixAdvertisementStatusGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixAdvertisementStatusGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixAdvertisementStatusGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixAdvertisementStatusGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusGetResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixAdvertisementStatusGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixAdvertisementStatusGetResponseEnvelopeMessagesSource `json:"source"`
JSON prefixAdvertisementStatusGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixAdvertisementStatusGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixAdvertisementStatusGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixAdvertisementStatusGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixAdvertisementStatusGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixAdvertisementStatusGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixAdvertisementStatusGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type PrefixAdvertisementStatusGetResponseEnvelopeSuccess ¶
type PrefixAdvertisementStatusGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
PrefixAdvertisementStatusGetResponseEnvelopeSuccessTrue PrefixAdvertisementStatusGetResponseEnvelopeSuccess = true
)
func (PrefixAdvertisementStatusGetResponseEnvelopeSuccess) IsKnown ¶
func (r PrefixAdvertisementStatusGetResponseEnvelopeSuccess) IsKnown() bool
type PrefixAdvertisementStatusService ¶
type PrefixAdvertisementStatusService struct {
Options []option.RequestOption
}
PrefixAdvertisementStatusService 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 NewPrefixAdvertisementStatusService method instead.
func NewPrefixAdvertisementStatusService ¶
func NewPrefixAdvertisementStatusService(opts ...option.RequestOption) (r *PrefixAdvertisementStatusService)
NewPrefixAdvertisementStatusService 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 (*PrefixAdvertisementStatusService) Edit ¶
func (r *PrefixAdvertisementStatusService) Edit(ctx context.Context, prefixID string, params PrefixAdvertisementStatusEditParams, opts ...option.RequestOption) (res *PrefixAdvertisementStatusEditResponse, err error)
Advertise or withdraw the BGP route for a prefix.
**Deprecated:** Prefer the BGP Prefixes endpoints, which additionally allow for advertising and withdrawing subnets of an IP prefix.
func (*PrefixAdvertisementStatusService) Get ¶
func (r *PrefixAdvertisementStatusService) Get(ctx context.Context, prefixID string, query PrefixAdvertisementStatusGetParams, opts ...option.RequestOption) (res *PrefixAdvertisementStatusGetResponse, err error)
View the current advertisement state for a prefix.
**Deprecated:** Prefer the BGP Prefixes endpoints, which additionally allow for advertising and withdrawing subnets of an IP prefix.
type PrefixBGPPrefixEditParams ¶
type PrefixBGPPrefixEditParams struct {
// Identifier of a Cloudflare account.
AccountID param.Field[string] `path:"account_id,required"`
// Number of times to prepend the Cloudflare ASN to the BGP AS-Path attribute
ASNPrependCount param.Field[int64] `json:"asn_prepend_count"`
OnDemand param.Field[PrefixBGPPrefixEditParamsOnDemand] `json:"on_demand"`
// Controls whether the BGP prefix is automatically withdrawn when prefix is
// withdrawn from Magic routing table (for Magic Transit customers using Direct
// CNI)
WithdrawIfNoRoute param.Field[bool] `json:"withdraw_if_no_route"`
}
func (PrefixBGPPrefixEditParams) MarshalJSON ¶
func (r PrefixBGPPrefixEditParams) MarshalJSON() (data []byte, err error)
type PrefixBGPPrefixEditParamsOnDemand ¶
func (PrefixBGPPrefixEditParamsOnDemand) MarshalJSON ¶
func (r PrefixBGPPrefixEditParamsOnDemand) MarshalJSON() (data []byte, err error)
type PrefixBGPPrefixEditResponseEnvelope ¶
type PrefixBGPPrefixEditResponseEnvelope struct {
Errors []PrefixBGPPrefixEditResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixBGPPrefixEditResponseEnvelopeMessages `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 PrefixBGPPrefixEditResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixBGPPrefixEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixBGPPrefixEditResponseEnvelopeErrorsSource `json:"source"`
JSON prefixBGPPrefixEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixBGPPrefixEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixEditResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixBGPPrefixEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixBGPPrefixEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixBGPPrefixEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixEditResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixBGPPrefixEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixBGPPrefixEditResponseEnvelopeMessagesSource `json:"source"`
JSON prefixBGPPrefixEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixBGPPrefixEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixEditResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixBGPPrefixEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixBGPPrefixEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixBGPPrefixEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixEditResponseEnvelopeMessagesSource) 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 PrefixBGPPrefixGetResponseEnvelope ¶
type PrefixBGPPrefixGetResponseEnvelope struct {
Errors []PrefixBGPPrefixGetResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixBGPPrefixGetResponseEnvelopeMessages `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 PrefixBGPPrefixGetResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixBGPPrefixGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixBGPPrefixGetResponseEnvelopeErrorsSource `json:"source"`
JSON prefixBGPPrefixGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixBGPPrefixGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixBGPPrefixGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixBGPPrefixGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixBGPPrefixGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixGetResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixBGPPrefixGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixBGPPrefixGetResponseEnvelopeMessagesSource `json:"source"`
JSON prefixBGPPrefixGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixBGPPrefixGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixBGPPrefixGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixBGPPrefixGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixBGPPrefixGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixGetResponseEnvelopeMessagesSource) 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 PrefixBGPPrefixNewParams ¶
type PrefixBGPPrefixNewParams struct {
// Identifier of a Cloudflare account.
AccountID param.Field[string] `path:"account_id,required"`
// IP Prefix in Classless Inter-Domain Routing format.
CIDR param.Field[string] `json:"cidr"`
}
func (PrefixBGPPrefixNewParams) MarshalJSON ¶
func (r PrefixBGPPrefixNewParams) MarshalJSON() (data []byte, err error)
type PrefixBGPPrefixNewResponseEnvelope ¶
type PrefixBGPPrefixNewResponseEnvelope struct {
Errors []PrefixBGPPrefixNewResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixBGPPrefixNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success PrefixBGPPrefixNewResponseEnvelopeSuccess `json:"success,required"`
Result BGPPrefix `json:"result"`
JSON prefixBGPPrefixNewResponseEnvelopeJSON `json:"-"`
}
func (*PrefixBGPPrefixNewResponseEnvelope) UnmarshalJSON ¶
func (r *PrefixBGPPrefixNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixNewResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixBGPPrefixNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixBGPPrefixNewResponseEnvelopeErrorsSource `json:"source"`
JSON prefixBGPPrefixNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixBGPPrefixNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixBGPPrefixNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixBGPPrefixNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixBGPPrefixNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixNewResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixBGPPrefixNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixBGPPrefixNewResponseEnvelopeMessagesSource `json:"source"`
JSON prefixBGPPrefixNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixBGPPrefixNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixBGPPrefixNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixBGPPrefixNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixBGPPrefixNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixBGPPrefixNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type PrefixBGPPrefixNewResponseEnvelopeSuccess ¶
type PrefixBGPPrefixNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
PrefixBGPPrefixNewResponseEnvelopeSuccessTrue PrefixBGPPrefixNewResponseEnvelopeSuccess = true
)
func (PrefixBGPPrefixNewResponseEnvelopeSuccess) IsKnown ¶
func (r PrefixBGPPrefixNewResponseEnvelopeSuccess) IsKnown() bool
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.
func (*PrefixBGPPrefixService) New ¶
func (r *PrefixBGPPrefixService) New(ctx context.Context, prefixID string, params PrefixBGPPrefixNewParams, opts ...option.RequestOption) (res *BGPPrefix, err error)
Create a BGP prefix, controlling the BGP advertisement status of a specific subnet. When created, BGP prefixes are initially withdrawn, and can be advertised with the Update BGP Prefix API.
type PrefixDelegationDeleteResponse ¶
type PrefixDelegationDeleteResponse struct {
// Identifier of a Delegation.
ID string `json:"id"`
JSON prefixDelegationDeleteResponseJSON `json:"-"`
}
func (*PrefixDelegationDeleteResponse) UnmarshalJSON ¶
func (r *PrefixDelegationDeleteResponse) UnmarshalJSON(data []byte) (err error)
type PrefixDelegationDeleteResponseEnvelope ¶
type PrefixDelegationDeleteResponseEnvelope struct {
Errors []PrefixDelegationDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixDelegationDeleteResponseEnvelopeMessages `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 PrefixDelegationDeleteResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixDelegationDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixDelegationDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON prefixDelegationDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixDelegationDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDelegationDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixDelegationDeleteResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixDelegationDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixDelegationDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixDelegationDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDelegationDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixDelegationDeleteResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixDelegationDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixDelegationDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON prefixDelegationDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixDelegationDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDelegationDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixDelegationDeleteResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixDelegationDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixDelegationDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixDelegationDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDelegationDeleteResponseEnvelopeMessagesSource) 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 PrefixDelegationNewParams ¶
type PrefixDelegationNewParams struct {
// Identifier of a Cloudflare account.
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 []PrefixDelegationNewResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixDelegationNewResponseEnvelopeMessages `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 PrefixDelegationNewResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixDelegationNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixDelegationNewResponseEnvelopeErrorsSource `json:"source"`
JSON prefixDelegationNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixDelegationNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDelegationNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixDelegationNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixDelegationNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixDelegationNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixDelegationNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDelegationNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixDelegationNewResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixDelegationNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixDelegationNewResponseEnvelopeMessagesSource `json:"source"`
JSON prefixDelegationNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixDelegationNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDelegationNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixDelegationNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixDelegationNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixDelegationNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixDelegationNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDelegationNewResponseEnvelopeMessagesSource) 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 PrefixDeleteResponse ¶
type PrefixDeleteResponse struct {
Errors []PrefixDeleteResponseError `json:"errors,required"`
Messages []PrefixDeleteResponseMessage `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 PrefixDeleteResponseError ¶ added in v4.3.0
type PrefixDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixDeleteResponseErrorsSource `json:"source"`
JSON prefixDeleteResponseErrorJSON `json:"-"`
}
func (*PrefixDeleteResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type PrefixDeleteResponseErrorsSource ¶ added in v4.3.0
type PrefixDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*PrefixDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixDeleteResponseMessage ¶ added in v4.3.0
type PrefixDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixDeleteResponseMessagesSource `json:"source"`
JSON prefixDeleteResponseMessageJSON `json:"-"`
}
func (*PrefixDeleteResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type PrefixDeleteResponseMessagesSource ¶ added in v4.3.0
type PrefixDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*PrefixDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixDeleteResponseMessagesSource) 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 of a Cloudflare account.
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 []PrefixEditResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixEditResponseEnvelopeMessages `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 PrefixEditResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixEditResponseEnvelopeErrorsSource `json:"source"`
JSON prefixEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixEditResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixEditResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixEditResponseEnvelopeMessagesSource `json:"source"`
JSON prefixEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixEditResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixEditResponseEnvelopeMessagesSource) 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 PrefixGetResponseEnvelope ¶
type PrefixGetResponseEnvelope struct {
Errors []PrefixGetResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixGetResponseEnvelopeMessages `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 PrefixGetResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixGetResponseEnvelopeErrorsSource `json:"source"`
JSON prefixGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixGetResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixGetResponseEnvelopeMessagesSource `json:"source"`
JSON prefixGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixGetResponseEnvelopeMessagesSource) 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 PrefixNewParams ¶
type PrefixNewParams struct {
// Identifier of a Cloudflare account.
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 []PrefixNewResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixNewResponseEnvelopeMessages `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 PrefixNewResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixNewResponseEnvelopeErrorsSource `json:"source"`
JSON prefixNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixNewResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixNewResponseEnvelopeMessagesSource `json:"source"`
JSON prefixNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixNewResponseEnvelopeMessagesSource) 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
ServiceBindings *PrefixServiceBindingService
BGPPrefixes *PrefixBGPPrefixService
AdvertisementStatus *PrefixAdvertisementStatusService
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 PrefixServiceBindingDeleteResponse ¶
type PrefixServiceBindingDeleteResponse struct {
Errors []PrefixServiceBindingDeleteResponseError `json:"errors,required"`
Messages []PrefixServiceBindingDeleteResponseMessage `json:"messages,required"`
// Whether the API call was successful.
Success PrefixServiceBindingDeleteResponseSuccess `json:"success,required"`
JSON prefixServiceBindingDeleteResponseJSON `json:"-"`
}
func (*PrefixServiceBindingDeleteResponse) UnmarshalJSON ¶
func (r *PrefixServiceBindingDeleteResponse) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingDeleteResponseError ¶ added in v4.3.0
type PrefixServiceBindingDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixServiceBindingDeleteResponseErrorsSource `json:"source"`
JSON prefixServiceBindingDeleteResponseErrorJSON `json:"-"`
}
func (*PrefixServiceBindingDeleteResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingDeleteResponseErrorsSource ¶ added in v4.3.0
type PrefixServiceBindingDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixServiceBindingDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*PrefixServiceBindingDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingDeleteResponseMessage ¶ added in v4.3.0
type PrefixServiceBindingDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixServiceBindingDeleteResponseMessagesSource `json:"source"`
JSON prefixServiceBindingDeleteResponseMessageJSON `json:"-"`
}
func (*PrefixServiceBindingDeleteResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingDeleteResponseMessagesSource ¶ added in v4.3.0
type PrefixServiceBindingDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixServiceBindingDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*PrefixServiceBindingDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingDeleteResponseMessagesSource) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingDeleteResponseSuccess ¶
type PrefixServiceBindingDeleteResponseSuccess bool
Whether the API call was successful.
const (
PrefixServiceBindingDeleteResponseSuccessTrue PrefixServiceBindingDeleteResponseSuccess = true
)
func (PrefixServiceBindingDeleteResponseSuccess) IsKnown ¶
func (r PrefixServiceBindingDeleteResponseSuccess) IsKnown() bool
type PrefixServiceBindingGetResponseEnvelope ¶
type PrefixServiceBindingGetResponseEnvelope struct {
Errors []PrefixServiceBindingGetResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixServiceBindingGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success PrefixServiceBindingGetResponseEnvelopeSuccess `json:"success,required"`
Result ServiceBinding `json:"result"`
JSON prefixServiceBindingGetResponseEnvelopeJSON `json:"-"`
}
func (*PrefixServiceBindingGetResponseEnvelope) UnmarshalJSON ¶
func (r *PrefixServiceBindingGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingGetResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixServiceBindingGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixServiceBindingGetResponseEnvelopeErrorsSource `json:"source"`
JSON prefixServiceBindingGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixServiceBindingGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixServiceBindingGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixServiceBindingGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixServiceBindingGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingGetResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixServiceBindingGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixServiceBindingGetResponseEnvelopeMessagesSource `json:"source"`
JSON prefixServiceBindingGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixServiceBindingGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixServiceBindingGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixServiceBindingGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixServiceBindingGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingGetResponseEnvelopeSuccess ¶
type PrefixServiceBindingGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
PrefixServiceBindingGetResponseEnvelopeSuccessTrue PrefixServiceBindingGetResponseEnvelopeSuccess = true
)
func (PrefixServiceBindingGetResponseEnvelopeSuccess) IsKnown ¶
func (r PrefixServiceBindingGetResponseEnvelopeSuccess) IsKnown() bool
type PrefixServiceBindingNewParams ¶
type PrefixServiceBindingNewParams struct {
// Identifier of a Cloudflare account.
AccountID param.Field[string] `path:"account_id,required"`
// IP Prefix in Classless Inter-Domain Routing format.
CIDR param.Field[string] `json:"cidr"`
// Identifier of a Service on the Cloudflare network. Available services and their
// IDs may be found in the **List Services** endpoint.
ServiceID param.Field[string] `json:"service_id"`
}
func (PrefixServiceBindingNewParams) MarshalJSON ¶
func (r PrefixServiceBindingNewParams) MarshalJSON() (data []byte, err error)
type PrefixServiceBindingNewResponseEnvelope ¶
type PrefixServiceBindingNewResponseEnvelope struct {
Errors []PrefixServiceBindingNewResponseEnvelopeErrors `json:"errors,required"`
Messages []PrefixServiceBindingNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success PrefixServiceBindingNewResponseEnvelopeSuccess `json:"success,required"`
Result ServiceBinding `json:"result"`
JSON prefixServiceBindingNewResponseEnvelopeJSON `json:"-"`
}
func (*PrefixServiceBindingNewResponseEnvelope) UnmarshalJSON ¶
func (r *PrefixServiceBindingNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingNewResponseEnvelopeErrors ¶ added in v4.3.0
type PrefixServiceBindingNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixServiceBindingNewResponseEnvelopeErrorsSource `json:"source"`
JSON prefixServiceBindingNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PrefixServiceBindingNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type PrefixServiceBindingNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON prefixServiceBindingNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*PrefixServiceBindingNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingNewResponseEnvelopeMessages ¶ added in v4.3.0
type PrefixServiceBindingNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source PrefixServiceBindingNewResponseEnvelopeMessagesSource `json:"source"`
JSON prefixServiceBindingNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PrefixServiceBindingNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type PrefixServiceBindingNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON prefixServiceBindingNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*PrefixServiceBindingNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *PrefixServiceBindingNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type PrefixServiceBindingNewResponseEnvelopeSuccess ¶
type PrefixServiceBindingNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
PrefixServiceBindingNewResponseEnvelopeSuccessTrue PrefixServiceBindingNewResponseEnvelopeSuccess = true
)
func (PrefixServiceBindingNewResponseEnvelopeSuccess) IsKnown ¶
func (r PrefixServiceBindingNewResponseEnvelopeSuccess) IsKnown() bool
type PrefixServiceBindingService ¶
type PrefixServiceBindingService struct {
Options []option.RequestOption
}
PrefixServiceBindingService 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 NewPrefixServiceBindingService method instead.
func NewPrefixServiceBindingService ¶
func NewPrefixServiceBindingService(opts ...option.RequestOption) (r *PrefixServiceBindingService)
NewPrefixServiceBindingService 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 (*PrefixServiceBindingService) Delete ¶
func (r *PrefixServiceBindingService) Delete(ctx context.Context, prefixID string, bindingID string, body PrefixServiceBindingDeleteParams, opts ...option.RequestOption) (res *PrefixServiceBindingDeleteResponse, err error)
Delete a Service Binding
func (*PrefixServiceBindingService) Get ¶
func (r *PrefixServiceBindingService) Get(ctx context.Context, prefixID string, bindingID string, query PrefixServiceBindingGetParams, opts ...option.RequestOption) (res *ServiceBinding, err error)
Fetch a single Service Binding
func (*PrefixServiceBindingService) List ¶
func (r *PrefixServiceBindingService) List(ctx context.Context, prefixID string, query PrefixServiceBindingListParams, 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 (*PrefixServiceBindingService) ListAutoPaging ¶
func (r *PrefixServiceBindingService) ListAutoPaging(ctx context.Context, prefixID string, query PrefixServiceBindingListParams, 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 (*PrefixServiceBindingService) New ¶
func (r *PrefixServiceBindingService) New(ctx context.Context, prefixID string, params PrefixServiceBindingNewParams, 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/Cloudflare CDN/Cloudflare Spectrum service binding, and only allows creating upgrade service bindings for the Cloudflare CDN or Cloudflare Spectrum.
type RatePlanID ¶ added in v4.1.0
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
This is an alias to an internal type.
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type RegionalHostnameDeleteResponse ¶
type RegionalHostnameDeleteResponse struct {
Errors []RegionalHostnameDeleteResponseError `json:"errors,required"`
Messages []RegionalHostnameDeleteResponseMessage `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 RegionalHostnameDeleteResponseError ¶ added in v4.3.0
type RegionalHostnameDeleteResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RegionalHostnameDeleteResponseErrorsSource `json:"source"`
JSON regionalHostnameDeleteResponseErrorJSON `json:"-"`
}
func (*RegionalHostnameDeleteResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameDeleteResponseError) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameDeleteResponseErrorsSource ¶ added in v4.3.0
type RegionalHostnameDeleteResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON regionalHostnameDeleteResponseErrorsSourceJSON `json:"-"`
}
func (*RegionalHostnameDeleteResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameDeleteResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameDeleteResponseMessage ¶ added in v4.3.0
type RegionalHostnameDeleteResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RegionalHostnameDeleteResponseMessagesSource `json:"source"`
JSON regionalHostnameDeleteResponseMessageJSON `json:"-"`
}
func (*RegionalHostnameDeleteResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameDeleteResponseMessage) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameDeleteResponseMessagesSource ¶ added in v4.3.0
type RegionalHostnameDeleteResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON regionalHostnameDeleteResponseMessagesSourceJSON `json:"-"`
}
func (*RegionalHostnameDeleteResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameDeleteResponseMessagesSource) 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"`
// Configure which routing method to use for the regional hostname
Routing string `json:"routing"`
JSON regionalHostnameEditResponseJSON `json:"-"`
}
func (*RegionalHostnameEditResponse) UnmarshalJSON ¶
func (r *RegionalHostnameEditResponse) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameEditResponseEnvelope ¶
type RegionalHostnameEditResponseEnvelope struct {
Errors []RegionalHostnameEditResponseEnvelopeErrors `json:"errors,required"`
Messages []RegionalHostnameEditResponseEnvelopeMessages `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 RegionalHostnameEditResponseEnvelopeErrors ¶ added in v4.3.0
type RegionalHostnameEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RegionalHostnameEditResponseEnvelopeErrorsSource `json:"source"`
JSON regionalHostnameEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RegionalHostnameEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameEditResponseEnvelopeErrorsSource ¶ added in v4.3.0
type RegionalHostnameEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON regionalHostnameEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RegionalHostnameEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameEditResponseEnvelopeMessages ¶ added in v4.3.0
type RegionalHostnameEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RegionalHostnameEditResponseEnvelopeMessagesSource `json:"source"`
JSON regionalHostnameEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RegionalHostnameEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameEditResponseEnvelopeMessagesSource ¶ added in v4.3.0
type RegionalHostnameEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON regionalHostnameEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RegionalHostnameEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameEditResponseEnvelopeMessagesSource) 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 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"`
// Configure which routing method to use for the regional hostname
Routing string `json:"routing"`
JSON regionalHostnameGetResponseJSON `json:"-"`
}
func (*RegionalHostnameGetResponse) UnmarshalJSON ¶
func (r *RegionalHostnameGetResponse) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameGetResponseEnvelope ¶
type RegionalHostnameGetResponseEnvelope struct {
Errors []RegionalHostnameGetResponseEnvelopeErrors `json:"errors,required"`
Messages []RegionalHostnameGetResponseEnvelopeMessages `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 RegionalHostnameGetResponseEnvelopeErrors ¶ added in v4.3.0
type RegionalHostnameGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RegionalHostnameGetResponseEnvelopeErrorsSource `json:"source"`
JSON regionalHostnameGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RegionalHostnameGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type RegionalHostnameGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON regionalHostnameGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RegionalHostnameGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameGetResponseEnvelopeMessages ¶ added in v4.3.0
type RegionalHostnameGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RegionalHostnameGetResponseEnvelopeMessagesSource `json:"source"`
JSON regionalHostnameGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RegionalHostnameGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type RegionalHostnameGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON regionalHostnameGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RegionalHostnameGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameGetResponseEnvelopeMessagesSource) 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 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"`
// Configure which routing method to use for the regional hostname
Routing string `json:"routing"`
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"`
// Configure which routing method to use for the regional hostname
Routing param.Field[string] `json:"routing"`
}
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"`
// Configure which routing method to use for the regional hostname
Routing string `json:"routing"`
JSON regionalHostnameNewResponseJSON `json:"-"`
}
func (*RegionalHostnameNewResponse) UnmarshalJSON ¶
func (r *RegionalHostnameNewResponse) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameNewResponseEnvelope ¶
type RegionalHostnameNewResponseEnvelope struct {
Errors []RegionalHostnameNewResponseEnvelopeErrors `json:"errors,required"`
Messages []RegionalHostnameNewResponseEnvelopeMessages `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 RegionalHostnameNewResponseEnvelopeErrors ¶ added in v4.3.0
type RegionalHostnameNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RegionalHostnameNewResponseEnvelopeErrorsSource `json:"source"`
JSON regionalHostnameNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RegionalHostnameNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type RegionalHostnameNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON regionalHostnameNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*RegionalHostnameNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameNewResponseEnvelopeMessages ¶ added in v4.3.0
type RegionalHostnameNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source RegionalHostnameNewResponseEnvelopeMessagesSource `json:"source"`
JSON regionalHostnameNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RegionalHostnameNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RegionalHostnameNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type RegionalHostnameNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON regionalHostnameNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*RegionalHostnameNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *RegionalHostnameNewResponseEnvelopeMessagesSource) 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 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 ResponseInfoSource ¶ added in v4.3.0
type ResponseInfoSource = shared.ResponseInfoSource
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 of a Service Binding.
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 of a Service on the Cloudflare network. Available services and their
// IDs may be found in the **List Services** endpoint.
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 ServiceListResponse ¶
type ServiceListResponse struct {
// Identifier of a Service on the Cloudflare network. Available services and their
// IDs may be found in the **List Services** endpoint.
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 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 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 TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.