Documentation ¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelTunType
- type DNSSEC
- type DNSSECDeleteParams
- type DNSSECDeleteResponseEnvelope
- type DNSSECDeleteResponseEnvelopeSuccess
- type DNSSECDeleteResponseUnion
- type DNSSECEditParams
- type DNSSECEditParamsStatus
- type DNSSECEditResponseEnvelope
- type DNSSECEditResponseEnvelopeSuccess
- type DNSSECGetParams
- type DNSSECGetResponseEnvelope
- type DNSSECGetResponseEnvelopeSuccess
- type DNSSECService
- func (r *DNSSECService) Delete(ctx context.Context, params DNSSECDeleteParams, opts ...option.RequestOption) (res *DNSSECDeleteResponseUnion, err error)
- func (r *DNSSECService) Edit(ctx context.Context, params DNSSECEditParams, opts ...option.RequestOption) (res *DNSSEC, err error)
- func (r *DNSSECService) Get(ctx context.Context, query DNSSECGetParams, opts ...option.RequestOption) (res *DNSSEC, err error)
- type DNSSECStatus
- type Error
- type ErrorData
- type Member
- type MemberParam
- type MemberRole
- type MemberRoleParam
- type MemberRolesPermissions
- type MemberRolesPermissionsParam
- type MemberUser
- type MemberUserParam
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type ResponseInfo
- type Role
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 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 CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 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 CloudflareTunnelTunType ¶
type CloudflareTunnelTunType = shared.CloudflareTunnelTunType
The type of tunnel.
This is an alias to an internal type.
type DNSSEC ¶
type DNSSEC struct { // Algorithm key code. Algorithm string `json:"algorithm,nullable"` // Digest hash. Digest string `json:"digest,nullable"` // Type of digest algorithm. DigestAlgorithm string `json:"digest_algorithm,nullable"` // Coded type for digest algorithm. DigestType string `json:"digest_type,nullable"` // If true, multi-signer DNSSEC is enabled on the zone, allowing multiple providers // to serve a DNSSEC-signed zone at the same time. This is required for DNSKEY // records (except those automatically generated by Cloudflare) to be added to the // zone. // // See // [Multi-signer DNSSEC](https://developers.cloudflare.com/dns/dnssec/multi-signer-dnssec/) // for details. DNSSECMultiSigner bool `json:"dnssec_multi_signer"` // If true, allows Cloudflare to transfer in a DNSSEC-signed zone including // signatures from an external provider, without requiring Cloudflare to sign any // records on the fly. // // Note that this feature has some limitations. See // [Cloudflare as Secondary](https://developers.cloudflare.com/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup/#dnssec) // for details. DNSSECPresigned bool `json:"dnssec_presigned"` // Full DS record. DS string `json:"ds,nullable"` // Flag for DNSSEC record. Flags float64 `json:"flags,nullable"` // Code for key tag. KeyTag float64 `json:"key_tag,nullable"` // Algorithm key type. KeyType string `json:"key_type,nullable"` // When DNSSEC was last modified. ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"` // Public key for DS record. PublicKey string `json:"public_key,nullable"` // Status of DNSSEC, based on user-desired state and presence of necessary records. Status DNSSECStatus `json:"status"` JSON dnssecJSON `json:"-"` }
func (*DNSSEC) UnmarshalJSON ¶
type DNSSECDeleteParams ¶
type DNSSECDeleteParams struct { // Identifier ZoneID param.Field[string] `path:"zone_id,required"` Body interface{} `json:"body,required"` }
func (DNSSECDeleteParams) MarshalJSON ¶
func (r DNSSECDeleteParams) MarshalJSON() (data []byte, err error)
type DNSSECDeleteResponseEnvelope ¶
type DNSSECDeleteResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success DNSSECDeleteResponseEnvelopeSuccess `json:"success,required"` Result DNSSECDeleteResponseUnion `json:"result"` JSON dnssecDeleteResponseEnvelopeJSON `json:"-"` }
func (*DNSSECDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSECDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSECDeleteResponseEnvelopeSuccess ¶
type DNSSECDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
DNSSECDeleteResponseEnvelopeSuccessTrue DNSSECDeleteResponseEnvelopeSuccess = true
)
func (DNSSECDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r DNSSECDeleteResponseEnvelopeSuccess) IsKnown() bool
type DNSSECDeleteResponseUnion ¶
type DNSSECDeleteResponseUnion interface {
ImplementsDNSSECDNSSECDeleteResponseUnion()
}
Union satisfied by dnssec.DNSSECDeleteResponseUnknown or shared.UnionString.
type DNSSECEditParams ¶
type DNSSECEditParams struct { // Identifier ZoneID param.Field[string] `path:"zone_id,required"` // If true, multi-signer DNSSEC is enabled on the zone, allowing multiple providers // to serve a DNSSEC-signed zone at the same time. This is required for DNSKEY // records (except those automatically generated by Cloudflare) to be added to the // zone. // // See // [Multi-signer DNSSEC](https://developers.cloudflare.com/dns/dnssec/multi-signer-dnssec/) // for details. DNSSECMultiSigner param.Field[bool] `json:"dnssec_multi_signer"` // If true, allows Cloudflare to transfer in a DNSSEC-signed zone including // signatures from an external provider, without requiring Cloudflare to sign any // records on the fly. // // Note that this feature has some limitations. See // [Cloudflare as Secondary](https://developers.cloudflare.com/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup/#dnssec) // for details. DNSSECPresigned param.Field[bool] `json:"dnssec_presigned"` // Status of DNSSEC, based on user-desired state and presence of necessary records. Status param.Field[DNSSECEditParamsStatus] `json:"status"` }
func (DNSSECEditParams) MarshalJSON ¶
func (r DNSSECEditParams) MarshalJSON() (data []byte, err error)
type DNSSECEditParamsStatus ¶
type DNSSECEditParamsStatus string
Status of DNSSEC, based on user-desired state and presence of necessary records.
const ( DNSSECEditParamsStatusActive DNSSECEditParamsStatus = "active" DNSSECEditParamsStatusDisabled DNSSECEditParamsStatus = "disabled" )
func (DNSSECEditParamsStatus) IsKnown ¶
func (r DNSSECEditParamsStatus) IsKnown() bool
type DNSSECEditResponseEnvelope ¶
type DNSSECEditResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success DNSSECEditResponseEnvelopeSuccess `json:"success,required"` Result DNSSEC `json:"result"` JSON dnssecEditResponseEnvelopeJSON `json:"-"` }
func (*DNSSECEditResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSECEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSECEditResponseEnvelopeSuccess ¶
type DNSSECEditResponseEnvelopeSuccess bool
Whether the API call was successful
const (
DNSSECEditResponseEnvelopeSuccessTrue DNSSECEditResponseEnvelopeSuccess = true
)
func (DNSSECEditResponseEnvelopeSuccess) IsKnown ¶
func (r DNSSECEditResponseEnvelopeSuccess) IsKnown() bool
type DNSSECGetParams ¶
type DNSSECGetResponseEnvelope ¶
type DNSSECGetResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success DNSSECGetResponseEnvelopeSuccess `json:"success,required"` Result DNSSEC `json:"result"` JSON dnssecGetResponseEnvelopeJSON `json:"-"` }
func (*DNSSECGetResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSECGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSECGetResponseEnvelopeSuccess ¶
type DNSSECGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
DNSSECGetResponseEnvelopeSuccessTrue DNSSECGetResponseEnvelopeSuccess = true
)
func (DNSSECGetResponseEnvelopeSuccess) IsKnown ¶
func (r DNSSECGetResponseEnvelopeSuccess) IsKnown() bool
type DNSSECService ¶
type DNSSECService struct {
Options []option.RequestOption
}
DNSSECService 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 NewDNSSECService method instead.
func NewDNSSECService ¶
func NewDNSSECService(opts ...option.RequestOption) (r *DNSSECService)
NewDNSSECService 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 (*DNSSECService) Delete ¶
func (r *DNSSECService) Delete(ctx context.Context, params DNSSECDeleteParams, opts ...option.RequestOption) (res *DNSSECDeleteResponseUnion, err error)
Delete DNSSEC.
func (*DNSSECService) Edit ¶
func (r *DNSSECService) Edit(ctx context.Context, params DNSSECEditParams, opts ...option.RequestOption) (res *DNSSEC, err error)
Enable or disable DNSSEC.
func (*DNSSECService) Get ¶
func (r *DNSSECService) Get(ctx context.Context, query DNSSECGetParams, opts ...option.RequestOption) (res *DNSSEC, err error)
Details about DNSSEC status and configuration.
type DNSSECStatus ¶
type DNSSECStatus string
Status of DNSSEC, based on user-desired state and presence of necessary records.
const ( DNSSECStatusActive DNSSECStatus = "active" DNSSECStatusPending DNSSECStatus = "pending" DNSSECStatusDisabled DNSSECStatus = "disabled" DNSSECStatusPendingDisabled DNSSECStatus = "pending-disabled" DNSSECStatusError DNSSECStatus = "error" )
func (DNSSECStatus) IsKnown ¶
func (r DNSSECStatus) IsKnown() bool
type MemberParam ¶ added in v2.1.0
type MemberParam = shared.MemberParam
This is an alias to an internal type.
type MemberRole ¶ added in v2.1.0
type MemberRole = shared.MemberRole
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 MemberRolesPermissions ¶ added in v2.1.0
type MemberRolesPermissions = shared.MemberRolesPermissions
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 MemberUser ¶ added in v2.1.0
type MemberUser = shared.MemberUser
This is an alias to an internal type.
type MemberUserParam ¶ added in v2.1.0
type MemberUserParam = shared.MemberUserParam
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.