secondary_dns

package
v2.3.0 Latest Latest
Warning

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

Go to latest
Published: Jun 18, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ACL

type ACL struct {
	ID string `json:"id,required"`
	// Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will
	// be applied for the entire account. The IP range is used to allow additional
	// NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from
	// for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for
	// IPv6 respectively.
	IPRange string `json:"ip_range,required"`
	// The name of the acl.
	Name string  `json:"name,required"`
	JSON aclJSON `json:"-"`
}

func (*ACL) UnmarshalJSON

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

type ACLDeleteParams

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

type ACLDeleteResponse

type ACLDeleteResponse struct {
	ID   string                `json:"id"`
	JSON aclDeleteResponseJSON `json:"-"`
}

func (*ACLDeleteResponse) UnmarshalJSON

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

type ACLDeleteResponseEnvelope

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

func (*ACLDeleteResponseEnvelope) UnmarshalJSON

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

type ACLDeleteResponseEnvelopeSuccess

type ACLDeleteResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ACLDeleteResponseEnvelopeSuccessTrue ACLDeleteResponseEnvelopeSuccess = true
)

func (ACLDeleteResponseEnvelopeSuccess) IsKnown

type ACLGetParams

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

type ACLGetResponseEnvelope

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

func (*ACLGetResponseEnvelope) UnmarshalJSON

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

type ACLGetResponseEnvelopeSuccess

type ACLGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ACLGetResponseEnvelopeSuccessTrue ACLGetResponseEnvelopeSuccess = true
)

func (ACLGetResponseEnvelopeSuccess) IsKnown

func (r ACLGetResponseEnvelopeSuccess) IsKnown() bool

type ACLListParams

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

type ACLNewParams

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

func (ACLNewParams) MarshalJSON

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

type ACLNewResponseEnvelope

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

func (*ACLNewResponseEnvelope) UnmarshalJSON

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

type ACLNewResponseEnvelopeSuccess

type ACLNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ACLNewResponseEnvelopeSuccessTrue ACLNewResponseEnvelopeSuccess = true
)

func (ACLNewResponseEnvelopeSuccess) IsKnown

func (r ACLNewResponseEnvelopeSuccess) IsKnown() bool

type ACLParam

type ACLParam struct {
	// Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will
	// be applied for the entire account. The IP range is used to allow additional
	// NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from
	// for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for
	// IPv6 respectively.
	IPRange param.Field[string] `json:"ip_range,required"`
	// The name of the acl.
	Name param.Field[string] `json:"name,required"`
}

func (ACLParam) MarshalJSON

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

type ACLService

type ACLService struct {
	Options []option.RequestOption
}

ACLService 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 NewACLService method instead.

func NewACLService

func NewACLService(opts ...option.RequestOption) (r *ACLService)

NewACLService 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 (*ACLService) Delete

func (r *ACLService) Delete(ctx context.Context, aclID string, body ACLDeleteParams, opts ...option.RequestOption) (res *ACLDeleteResponse, err error)

Delete ACL.

func (*ACLService) Get

func (r *ACLService) Get(ctx context.Context, aclID string, query ACLGetParams, opts ...option.RequestOption) (res *ACL, err error)

Get ACL.

func (*ACLService) List

func (r *ACLService) List(ctx context.Context, query ACLListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ACL], err error)

List ACLs.

func (*ACLService) ListAutoPaging

List ACLs.

func (*ACLService) New

func (r *ACLService) New(ctx context.Context, params ACLNewParams, opts ...option.RequestOption) (res *ACL, err error)

Create ACL.

func (*ACLService) Update

func (r *ACLService) Update(ctx context.Context, aclID string, params ACLUpdateParams, opts ...option.RequestOption) (res *ACL, err error)

Modify ACL.

type ACLUpdateParams

type ACLUpdateParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	ACL       ACLParam            `json:"acl,required"`
}

func (ACLUpdateParams) MarshalJSON

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

type ACLUpdateResponseEnvelope

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

func (*ACLUpdateResponseEnvelope) UnmarshalJSON

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

type ACLUpdateResponseEnvelopeSuccess

type ACLUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ACLUpdateResponseEnvelopeSuccessTrue ACLUpdateResponseEnvelopeSuccess = true
)

func (ACLUpdateResponseEnvelopeSuccess) IsKnown

type ASN added in v2.1.0

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA added in v2.2.0

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType added in v2.2.0

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 added in v2.3.0

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 DisableTransfer

type DisableTransfer = string

type EnableTransfer

type EnableTransfer = string

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ForceAXFR

type ForceAXFR = string

type ForceAXFRNewParams

type ForceAXFRNewParams struct {
	ZoneID param.Field[string] `path:"zone_id,required"`
	Body   interface{}         `json:"body,required"`
}

func (ForceAXFRNewParams) MarshalJSON

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

type ForceAXFRNewResponseEnvelope

type ForceAXFRNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success ForceAXFRNewResponseEnvelopeSuccess `json:"success,required"`
	// When force_axfr query parameter is set to true, the response is a simple string
	Result ForceAXFR                        `json:"result"`
	JSON   forceAXFRNewResponseEnvelopeJSON `json:"-"`
}

func (*ForceAXFRNewResponseEnvelope) UnmarshalJSON

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

type ForceAXFRNewResponseEnvelopeSuccess

type ForceAXFRNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ForceAXFRNewResponseEnvelopeSuccessTrue ForceAXFRNewResponseEnvelopeSuccess = true
)

func (ForceAXFRNewResponseEnvelopeSuccess) IsKnown

type ForceAXFRService

type ForceAXFRService struct {
	Options []option.RequestOption
}

ForceAXFRService 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 NewForceAXFRService method instead.

func NewForceAXFRService

func NewForceAXFRService(opts ...option.RequestOption) (r *ForceAXFRService)

NewForceAXFRService 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 (*ForceAXFRService) New

func (r *ForceAXFRService) New(ctx context.Context, params ForceAXFRNewParams, opts ...option.RequestOption) (res *ForceAXFR, err error)

Sends AXFR zone transfer request to primary nameserver(s).

type IncomingDeleteParams

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

type IncomingDeleteResponse

type IncomingDeleteResponse struct {
	ID   string                     `json:"id"`
	JSON incomingDeleteResponseJSON `json:"-"`
}

func (*IncomingDeleteResponse) UnmarshalJSON

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

type IncomingDeleteResponseEnvelope

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

func (*IncomingDeleteResponseEnvelope) UnmarshalJSON

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

type IncomingDeleteResponseEnvelopeSuccess

type IncomingDeleteResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	IncomingDeleteResponseEnvelopeSuccessTrue IncomingDeleteResponseEnvelopeSuccess = true
)

func (IncomingDeleteResponseEnvelopeSuccess) IsKnown

type IncomingGetParams

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

type IncomingGetResponse

type IncomingGetResponse struct {
	ID string `json:"id"`
	// How often should a secondary zone auto refresh regardless of DNS NOTIFY. Not
	// applicable for primary zones.
	AutoRefreshSeconds float64 `json:"auto_refresh_seconds"`
	// The time for a specific event.
	CheckedTime string `json:"checked_time"`
	// The time for a specific event.
	CreatedTime string `json:"created_time"`
	// The time for a specific event.
	ModifiedTime string `json:"modified_time"`
	// Zone name.
	Name string `json:"name"`
	// A list of peer tags.
	Peers []interface{} `json:"peers"`
	// The serial number of the SOA for the given zone.
	SOASerial float64                 `json:"soa_serial"`
	JSON      incomingGetResponseJSON `json:"-"`
}

func (*IncomingGetResponse) UnmarshalJSON

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

type IncomingGetResponseEnvelope

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

func (*IncomingGetResponseEnvelope) UnmarshalJSON

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

type IncomingGetResponseEnvelopeSuccess

type IncomingGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	IncomingGetResponseEnvelopeSuccessTrue IncomingGetResponseEnvelopeSuccess = true
)

func (IncomingGetResponseEnvelopeSuccess) IsKnown

type IncomingNewParams

type IncomingNewParams struct {
	ZoneID param.Field[string] `path:"zone_id,required"`
	// How often should a secondary zone auto refresh regardless of DNS NOTIFY. Not
	// applicable for primary zones.
	AutoRefreshSeconds param.Field[float64] `json:"auto_refresh_seconds,required"`
	// Zone name.
	Name param.Field[string] `json:"name,required"`
	// A list of peer tags.
	Peers param.Field[[]interface{}] `json:"peers,required"`
}

func (IncomingNewParams) MarshalJSON

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

type IncomingNewResponse

type IncomingNewResponse struct {
	ID string `json:"id"`
	// How often should a secondary zone auto refresh regardless of DNS NOTIFY. Not
	// applicable for primary zones.
	AutoRefreshSeconds float64 `json:"auto_refresh_seconds"`
	// The time for a specific event.
	CheckedTime string `json:"checked_time"`
	// The time for a specific event.
	CreatedTime string `json:"created_time"`
	// The time for a specific event.
	ModifiedTime string `json:"modified_time"`
	// Zone name.
	Name string `json:"name"`
	// A list of peer tags.
	Peers []interface{} `json:"peers"`
	// The serial number of the SOA for the given zone.
	SOASerial float64                 `json:"soa_serial"`
	JSON      incomingNewResponseJSON `json:"-"`
}

func (*IncomingNewResponse) UnmarshalJSON

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

type IncomingNewResponseEnvelope

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

func (*IncomingNewResponseEnvelope) UnmarshalJSON

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

type IncomingNewResponseEnvelopeSuccess

type IncomingNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	IncomingNewResponseEnvelopeSuccessTrue IncomingNewResponseEnvelopeSuccess = true
)

func (IncomingNewResponseEnvelopeSuccess) IsKnown

type IncomingService

type IncomingService struct {
	Options []option.RequestOption
}

IncomingService 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 NewIncomingService method instead.

func NewIncomingService

func NewIncomingService(opts ...option.RequestOption) (r *IncomingService)

NewIncomingService 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 (*IncomingService) Delete

Delete secondary zone configuration for incoming zone transfers.

func (*IncomingService) Get

Get secondary zone configuration for incoming zone transfers.

func (*IncomingService) New

Create secondary zone configuration for incoming zone transfers.

func (*IncomingService) Update

Update secondary zone configuration for incoming zone transfers.

type IncomingUpdateParams

type IncomingUpdateParams struct {
	ZoneID param.Field[string] `path:"zone_id,required"`
	// How often should a secondary zone auto refresh regardless of DNS NOTIFY. Not
	// applicable for primary zones.
	AutoRefreshSeconds param.Field[float64] `json:"auto_refresh_seconds,required"`
	// Zone name.
	Name param.Field[string] `json:"name,required"`
	// A list of peer tags.
	Peers param.Field[[]interface{}] `json:"peers,required"`
}

func (IncomingUpdateParams) MarshalJSON

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

type IncomingUpdateResponse

type IncomingUpdateResponse struct {
	ID string `json:"id"`
	// How often should a secondary zone auto refresh regardless of DNS NOTIFY. Not
	// applicable for primary zones.
	AutoRefreshSeconds float64 `json:"auto_refresh_seconds"`
	// The time for a specific event.
	CheckedTime string `json:"checked_time"`
	// The time for a specific event.
	CreatedTime string `json:"created_time"`
	// The time for a specific event.
	ModifiedTime string `json:"modified_time"`
	// Zone name.
	Name string `json:"name"`
	// A list of peer tags.
	Peers []interface{} `json:"peers"`
	// The serial number of the SOA for the given zone.
	SOASerial float64                    `json:"soa_serial"`
	JSON      incomingUpdateResponseJSON `json:"-"`
}

func (*IncomingUpdateResponse) UnmarshalJSON

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

type IncomingUpdateResponseEnvelope

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

func (*IncomingUpdateResponseEnvelope) UnmarshalJSON

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

type IncomingUpdateResponseEnvelopeSuccess

type IncomingUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	IncomingUpdateResponseEnvelopeSuccessTrue IncomingUpdateResponseEnvelopeSuccess = true
)

func (IncomingUpdateResponseEnvelopeSuccess) IsKnown

type MemberParam added in v2.1.0

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus added in v2.3.0

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam added in v2.1.0

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type OutgoingDeleteParams

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

type OutgoingDeleteResponse

type OutgoingDeleteResponse struct {
	ID   string                     `json:"id"`
	JSON outgoingDeleteResponseJSON `json:"-"`
}

func (*OutgoingDeleteResponse) UnmarshalJSON

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

type OutgoingDeleteResponseEnvelope

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

func (*OutgoingDeleteResponseEnvelope) UnmarshalJSON

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

type OutgoingDeleteResponseEnvelopeSuccess

type OutgoingDeleteResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	OutgoingDeleteResponseEnvelopeSuccessTrue OutgoingDeleteResponseEnvelopeSuccess = true
)

func (OutgoingDeleteResponseEnvelopeSuccess) IsKnown

type OutgoingDisableParams

type OutgoingDisableParams struct {
	ZoneID param.Field[string] `path:"zone_id,required"`
	Body   interface{}         `json:"body,required"`
}

func (OutgoingDisableParams) MarshalJSON

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

type OutgoingDisableResponseEnvelope

type OutgoingDisableResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success OutgoingDisableResponseEnvelopeSuccess `json:"success,required"`
	// The zone transfer status of a primary zone
	Result DisableTransfer                     `json:"result"`
	JSON   outgoingDisableResponseEnvelopeJSON `json:"-"`
}

func (*OutgoingDisableResponseEnvelope) UnmarshalJSON

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

type OutgoingDisableResponseEnvelopeSuccess

type OutgoingDisableResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	OutgoingDisableResponseEnvelopeSuccessTrue OutgoingDisableResponseEnvelopeSuccess = true
)

func (OutgoingDisableResponseEnvelopeSuccess) IsKnown

type OutgoingEnableParams

type OutgoingEnableParams struct {
	ZoneID param.Field[string] `path:"zone_id,required"`
	Body   interface{}         `json:"body,required"`
}

func (OutgoingEnableParams) MarshalJSON

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

type OutgoingEnableResponseEnvelope

type OutgoingEnableResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success OutgoingEnableResponseEnvelopeSuccess `json:"success,required"`
	// The zone transfer status of a primary zone
	Result EnableTransfer                     `json:"result"`
	JSON   outgoingEnableResponseEnvelopeJSON `json:"-"`
}

func (*OutgoingEnableResponseEnvelope) UnmarshalJSON

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

type OutgoingEnableResponseEnvelopeSuccess

type OutgoingEnableResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	OutgoingEnableResponseEnvelopeSuccessTrue OutgoingEnableResponseEnvelopeSuccess = true
)

func (OutgoingEnableResponseEnvelopeSuccess) IsKnown

type OutgoingForceNotifyParams

type OutgoingForceNotifyParams struct {
	ZoneID param.Field[string] `path:"zone_id,required"`
	Body   interface{}         `json:"body,required"`
}

func (OutgoingForceNotifyParams) MarshalJSON

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

type OutgoingForceNotifyResponseEnvelope

type OutgoingForceNotifyResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success OutgoingForceNotifyResponseEnvelopeSuccess `json:"success,required"`
	// When force_notify query parameter is set to true, the response is a simple
	// string
	Result string                                  `json:"result"`
	JSON   outgoingForceNotifyResponseEnvelopeJSON `json:"-"`
}

func (*OutgoingForceNotifyResponseEnvelope) UnmarshalJSON

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

type OutgoingForceNotifyResponseEnvelopeSuccess

type OutgoingForceNotifyResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	OutgoingForceNotifyResponseEnvelopeSuccessTrue OutgoingForceNotifyResponseEnvelopeSuccess = true
)

func (OutgoingForceNotifyResponseEnvelopeSuccess) IsKnown

type OutgoingGetParams

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

type OutgoingGetResponse

type OutgoingGetResponse struct {
	ID string `json:"id"`
	// The time for a specific event.
	CheckedTime string `json:"checked_time"`
	// The time for a specific event.
	CreatedTime string `json:"created_time"`
	// The time for a specific event.
	LastTransferredTime string `json:"last_transferred_time"`
	// Zone name.
	Name string `json:"name"`
	// A list of peer tags.
	Peers []interface{} `json:"peers"`
	// The serial number of the SOA for the given zone.
	SOASerial float64                 `json:"soa_serial"`
	JSON      outgoingGetResponseJSON `json:"-"`
}

func (*OutgoingGetResponse) UnmarshalJSON

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

type OutgoingGetResponseEnvelope

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

func (*OutgoingGetResponseEnvelope) UnmarshalJSON

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

type OutgoingGetResponseEnvelopeSuccess

type OutgoingGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	OutgoingGetResponseEnvelopeSuccessTrue OutgoingGetResponseEnvelopeSuccess = true
)

func (OutgoingGetResponseEnvelopeSuccess) IsKnown

type OutgoingNewParams

type OutgoingNewParams struct {
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Zone name.
	Name param.Field[string] `json:"name,required"`
	// A list of peer tags.
	Peers param.Field[[]interface{}] `json:"peers,required"`
}

func (OutgoingNewParams) MarshalJSON

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

type OutgoingNewResponse

type OutgoingNewResponse struct {
	ID string `json:"id"`
	// The time for a specific event.
	CheckedTime string `json:"checked_time"`
	// The time for a specific event.
	CreatedTime string `json:"created_time"`
	// The time for a specific event.
	LastTransferredTime string `json:"last_transferred_time"`
	// Zone name.
	Name string `json:"name"`
	// A list of peer tags.
	Peers []interface{} `json:"peers"`
	// The serial number of the SOA for the given zone.
	SOASerial float64                 `json:"soa_serial"`
	JSON      outgoingNewResponseJSON `json:"-"`
}

func (*OutgoingNewResponse) UnmarshalJSON

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

type OutgoingNewResponseEnvelope

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

func (*OutgoingNewResponseEnvelope) UnmarshalJSON

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

type OutgoingNewResponseEnvelopeSuccess

type OutgoingNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	OutgoingNewResponseEnvelopeSuccessTrue OutgoingNewResponseEnvelopeSuccess = true
)

func (OutgoingNewResponseEnvelopeSuccess) IsKnown

type OutgoingService

type OutgoingService struct {
	Options []option.RequestOption
	Status  *OutgoingStatusService
}

OutgoingService 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 NewOutgoingService method instead.

func NewOutgoingService

func NewOutgoingService(opts ...option.RequestOption) (r *OutgoingService)

NewOutgoingService 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 (*OutgoingService) Delete

Delete primary zone configuration for outgoing zone transfers.

func (*OutgoingService) Disable

func (r *OutgoingService) Disable(ctx context.Context, params OutgoingDisableParams, opts ...option.RequestOption) (res *DisableTransfer, err error)

Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.

func (*OutgoingService) Enable

func (r *OutgoingService) Enable(ctx context.Context, params OutgoingEnableParams, opts ...option.RequestOption) (res *EnableTransfer, err error)

Enable outgoing zone transfers for primary zone.

func (*OutgoingService) ForceNotify

func (r *OutgoingService) ForceNotify(ctx context.Context, params OutgoingForceNotifyParams, opts ...option.RequestOption) (res *string, err error)

Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.

func (*OutgoingService) Get

Get primary zone configuration for outgoing zone transfers.

func (*OutgoingService) New

Create primary zone configuration for outgoing zone transfers.

func (*OutgoingService) Update

Update primary zone configuration for outgoing zone transfers.

type OutgoingStatusGetParams

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

type OutgoingStatusGetResponseEnvelope

type OutgoingStatusGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success OutgoingStatusGetResponseEnvelopeSuccess `json:"success,required"`
	// The zone transfer status of a primary zone
	Result EnableTransfer                        `json:"result"`
	JSON   outgoingStatusGetResponseEnvelopeJSON `json:"-"`
}

func (*OutgoingStatusGetResponseEnvelope) UnmarshalJSON

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

type OutgoingStatusGetResponseEnvelopeSuccess

type OutgoingStatusGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	OutgoingStatusGetResponseEnvelopeSuccessTrue OutgoingStatusGetResponseEnvelopeSuccess = true
)

func (OutgoingStatusGetResponseEnvelopeSuccess) IsKnown

type OutgoingStatusService

type OutgoingStatusService struct {
	Options []option.RequestOption
}

OutgoingStatusService 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 NewOutgoingStatusService method instead.

func NewOutgoingStatusService

func NewOutgoingStatusService(opts ...option.RequestOption) (r *OutgoingStatusService)

NewOutgoingStatusService 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 (*OutgoingStatusService) Get

Get primary zone transfer status.

type OutgoingUpdateParams

type OutgoingUpdateParams struct {
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Zone name.
	Name param.Field[string] `json:"name,required"`
	// A list of peer tags.
	Peers param.Field[[]interface{}] `json:"peers,required"`
}

func (OutgoingUpdateParams) MarshalJSON

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

type OutgoingUpdateResponse

type OutgoingUpdateResponse struct {
	ID string `json:"id"`
	// The time for a specific event.
	CheckedTime string `json:"checked_time"`
	// The time for a specific event.
	CreatedTime string `json:"created_time"`
	// The time for a specific event.
	LastTransferredTime string `json:"last_transferred_time"`
	// Zone name.
	Name string `json:"name"`
	// A list of peer tags.
	Peers []interface{} `json:"peers"`
	// The serial number of the SOA for the given zone.
	SOASerial float64                    `json:"soa_serial"`
	JSON      outgoingUpdateResponseJSON `json:"-"`
}

func (*OutgoingUpdateResponse) UnmarshalJSON

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

type OutgoingUpdateResponseEnvelope

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

func (*OutgoingUpdateResponseEnvelope) UnmarshalJSON

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

type OutgoingUpdateResponseEnvelopeSuccess

type OutgoingUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	OutgoingUpdateResponseEnvelopeSuccessTrue OutgoingUpdateResponseEnvelopeSuccess = true
)

func (OutgoingUpdateResponseEnvelopeSuccess) IsKnown

type Peer

type Peer struct {
	ID string `json:"id,required"`
	// The name of the peer.
	Name string `json:"name,required"`
	// IPv4/IPv6 address of primary or secondary nameserver, depending on what zone
	// this peer is linked to. For primary zones this IP defines the IP of the
	// secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary
	// zones this IP defines the IP of the primary nameserver Cloudflare will send
	// AXFR/IXFR requests to.
	IP string `json:"ip"`
	// Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary
	// zones.
	IxfrEnable bool `json:"ixfr_enable"`
	// DNS port of primary or secondary nameserver, depending on what zone this peer is
	// linked to.
	Port float64 `json:"port"`
	// TSIG authentication will be used for zone transfer if configured.
	TSIGID string   `json:"tsig_id"`
	JSON   peerJSON `json:"-"`
}

func (*Peer) UnmarshalJSON

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

type PeerDeleteParams

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

type PeerDeleteResponse

type PeerDeleteResponse struct {
	ID   string                 `json:"id"`
	JSON peerDeleteResponseJSON `json:"-"`
}

func (*PeerDeleteResponse) UnmarshalJSON

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

type PeerDeleteResponseEnvelope

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

func (*PeerDeleteResponseEnvelope) UnmarshalJSON

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

type PeerDeleteResponseEnvelopeSuccess

type PeerDeleteResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	PeerDeleteResponseEnvelopeSuccessTrue PeerDeleteResponseEnvelopeSuccess = true
)

func (PeerDeleteResponseEnvelopeSuccess) IsKnown

type PeerGetParams

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

type PeerGetResponseEnvelope

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

func (*PeerGetResponseEnvelope) UnmarshalJSON

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

type PeerGetResponseEnvelopeSuccess

type PeerGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	PeerGetResponseEnvelopeSuccessTrue PeerGetResponseEnvelopeSuccess = true
)

func (PeerGetResponseEnvelopeSuccess) IsKnown

type PeerListParams

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

type PeerNewParams

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

func (PeerNewParams) MarshalJSON

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

type PeerNewResponseEnvelope

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

func (*PeerNewResponseEnvelope) UnmarshalJSON

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

type PeerNewResponseEnvelopeSuccess

type PeerNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	PeerNewResponseEnvelopeSuccessTrue PeerNewResponseEnvelopeSuccess = true
)

func (PeerNewResponseEnvelopeSuccess) IsKnown

type PeerParam

type PeerParam struct {
	// The name of the peer.
	Name param.Field[string] `json:"name,required"`
	// IPv4/IPv6 address of primary or secondary nameserver, depending on what zone
	// this peer is linked to. For primary zones this IP defines the IP of the
	// secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary
	// zones this IP defines the IP of the primary nameserver Cloudflare will send
	// AXFR/IXFR requests to.
	IP param.Field[string] `json:"ip"`
	// Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary
	// zones.
	IxfrEnable param.Field[bool] `json:"ixfr_enable"`
	// DNS port of primary or secondary nameserver, depending on what zone this peer is
	// linked to.
	Port param.Field[float64] `json:"port"`
	// TSIG authentication will be used for zone transfer if configured.
	TSIGID param.Field[string] `json:"tsig_id"`
}

func (PeerParam) MarshalJSON

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

type PeerService

type PeerService struct {
	Options []option.RequestOption
}

PeerService 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 NewPeerService method instead.

func NewPeerService

func NewPeerService(opts ...option.RequestOption) (r *PeerService)

NewPeerService 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 (*PeerService) Delete

func (r *PeerService) Delete(ctx context.Context, peerID string, body PeerDeleteParams, opts ...option.RequestOption) (res *PeerDeleteResponse, err error)

Delete Peer.

func (*PeerService) Get

func (r *PeerService) Get(ctx context.Context, peerID string, query PeerGetParams, opts ...option.RequestOption) (res *Peer, err error)

Get Peer.

func (*PeerService) List

func (r *PeerService) List(ctx context.Context, query PeerListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Peer], err error)

List Peers.

func (*PeerService) ListAutoPaging

List Peers.

func (*PeerService) New

func (r *PeerService) New(ctx context.Context, params PeerNewParams, opts ...option.RequestOption) (res *Peer, err error)

Create Peer.

func (*PeerService) Update

func (r *PeerService) Update(ctx context.Context, peerID string, params PeerUpdateParams, opts ...option.RequestOption) (res *Peer, err error)

Modify Peer.

type PeerUpdateParams

type PeerUpdateParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	Peer      PeerParam           `json:"peer,required"`
}

func (PeerUpdateParams) MarshalJSON

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

type PeerUpdateResponseEnvelope

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

func (*PeerUpdateResponseEnvelope) UnmarshalJSON

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

type PeerUpdateResponseEnvelopeSuccess

type PeerUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	PeerUpdateResponseEnvelopeSuccessTrue PeerUpdateResponseEnvelopeSuccess = true
)

func (PeerUpdateResponseEnvelopeSuccess) IsKnown

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type SecondaryDNSService

type SecondaryDNSService struct {
	Options   []option.RequestOption
	ForceAXFR *ForceAXFRService
	Incoming  *IncomingService
	Outgoing  *OutgoingService
	ACLs      *ACLService
	Peers     *PeerService
	TSIGs     *TSIGService
}

SecondaryDNSService 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 NewSecondaryDNSService method instead.

func NewSecondaryDNSService

func NewSecondaryDNSService(opts ...option.RequestOption) (r *SecondaryDNSService)

NewSecondaryDNSService 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 SortDirection added in v2.2.0

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type TSIG

type TSIG struct {
	ID string `json:"id,required"`
	// TSIG algorithm.
	Algo string `json:"algo,required"`
	// TSIG key name.
	Name string `json:"name,required"`
	// TSIG secret.
	Secret string   `json:"secret,required"`
	JSON   tsigJSON `json:"-"`
}

func (*TSIG) UnmarshalJSON

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

type TSIGDeleteParams

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

type TSIGDeleteResponse

type TSIGDeleteResponse struct {
	ID   string                 `json:"id"`
	JSON tsigDeleteResponseJSON `json:"-"`
}

func (*TSIGDeleteResponse) UnmarshalJSON

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

type TSIGDeleteResponseEnvelope

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

func (*TSIGDeleteResponseEnvelope) UnmarshalJSON

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

type TSIGDeleteResponseEnvelopeSuccess

type TSIGDeleteResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	TSIGDeleteResponseEnvelopeSuccessTrue TSIGDeleteResponseEnvelopeSuccess = true
)

func (TSIGDeleteResponseEnvelopeSuccess) IsKnown

type TSIGGetParams

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

type TSIGGetResponseEnvelope

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

func (*TSIGGetResponseEnvelope) UnmarshalJSON

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

type TSIGGetResponseEnvelopeSuccess

type TSIGGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	TSIGGetResponseEnvelopeSuccessTrue TSIGGetResponseEnvelopeSuccess = true
)

func (TSIGGetResponseEnvelopeSuccess) IsKnown

type TSIGListParams

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

type TSIGNewParams

type TSIGNewParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	TSIG      TSIGParam           `json:"tsig,required"`
}

func (TSIGNewParams) MarshalJSON

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

type TSIGNewResponseEnvelope

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

func (*TSIGNewResponseEnvelope) UnmarshalJSON

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

type TSIGNewResponseEnvelopeSuccess

type TSIGNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	TSIGNewResponseEnvelopeSuccessTrue TSIGNewResponseEnvelopeSuccess = true
)

func (TSIGNewResponseEnvelopeSuccess) IsKnown

type TSIGParam

type TSIGParam struct {
	// TSIG algorithm.
	Algo param.Field[string] `json:"algo,required"`
	// TSIG key name.
	Name param.Field[string] `json:"name,required"`
	// TSIG secret.
	Secret param.Field[string] `json:"secret,required"`
}

func (TSIGParam) MarshalJSON

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

type TSIGService

type TSIGService struct {
	Options []option.RequestOption
}

TSIGService 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 NewTSIGService method instead.

func NewTSIGService

func NewTSIGService(opts ...option.RequestOption) (r *TSIGService)

NewTSIGService 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 (*TSIGService) Delete

func (r *TSIGService) Delete(ctx context.Context, tsigID string, body TSIGDeleteParams, opts ...option.RequestOption) (res *TSIGDeleteResponse, err error)

Delete TSIG.

func (*TSIGService) Get

func (r *TSIGService) Get(ctx context.Context, tsigID string, query TSIGGetParams, opts ...option.RequestOption) (res *TSIG, err error)

Get TSIG.

func (*TSIGService) List

func (r *TSIGService) List(ctx context.Context, query TSIGListParams, opts ...option.RequestOption) (res *pagination.SinglePage[TSIG], err error)

List TSIGs.

func (*TSIGService) ListAutoPaging

List TSIGs.

func (*TSIGService) New

func (r *TSIGService) New(ctx context.Context, params TSIGNewParams, opts ...option.RequestOption) (res *TSIG, err error)

Create TSIG.

func (*TSIGService) Update

func (r *TSIGService) Update(ctx context.Context, tsigID string, params TSIGUpdateParams, opts ...option.RequestOption) (res *TSIG, err error)

Modify TSIG.

type TSIGUpdateParams

type TSIGUpdateParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	TSIG      TSIGParam           `json:"tsig,required"`
}

func (TSIGUpdateParams) MarshalJSON

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

type TSIGUpdateResponseEnvelope

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

func (*TSIGUpdateResponseEnvelope) UnmarshalJSON

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

type TSIGUpdateResponseEnvelopeSuccess

type TSIGUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	TSIGUpdateResponseEnvelopeSuccessTrue TSIGUpdateResponseEnvelopeSuccess = true
)

func (TSIGUpdateResponseEnvelopeSuccess) IsKnown

Jump to

Keyboard shortcuts

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