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 Domain
- type DomainGetParams
- type DomainGetResponseArray
- type DomainGetResponseEnvelope
- type DomainGetResponseEnvelopeSuccess
- type DomainGetResponseUnion
- type DomainListParams
- type DomainRegistrantContact
- type DomainService
- func (r *DomainService) Get(ctx context.Context, domainName string, query DomainGetParams, ...) (res *DomainGetResponseUnion, err error)
- func (r *DomainService) List(ctx context.Context, query DomainListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Domain], err error)
- func (r *DomainService) ListAutoPaging(ctx context.Context, query DomainListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Domain]
- func (r *DomainService) Update(ctx context.Context, domainName string, params DomainUpdateParams, ...) (res *DomainUpdateResponseUnion, err error)
- type DomainTransferIn
- type DomainUpdateParams
- type DomainUpdateResponseArray
- type DomainUpdateResponseEnvelope
- type DomainUpdateResponseEnvelopeSuccess
- type DomainUpdateResponseUnion
- 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 RegistrarService
- 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 Domain ¶
type Domain struct { // Domain identifier. ID string `json:"id"` // Shows if a domain is available for transferring into Cloudflare Registrar. Available bool `json:"available"` // Indicates if the domain can be registered as a new domain. CanRegister bool `json:"can_register"` // Shows time of creation. CreatedAt time.Time `json:"created_at" format:"date-time"` // Shows name of current registrar. CurrentRegistrar string `json:"current_registrar"` // Shows when domain name registration expires. ExpiresAt time.Time `json:"expires_at" format:"date-time"` // Shows whether a registrar lock is in place for a domain. Locked bool `json:"locked"` // Shows contact information for domain registrant. RegistrantContact DomainRegistrantContact `json:"registrant_contact"` // A comma-separated list of registry status codes. A full list of status codes can // be found at // [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en). RegistryStatuses string `json:"registry_statuses"` // Whether a particular TLD is currently supported by Cloudflare Registrar. Refer // to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list of // supported TLDs. SupportedTld bool `json:"supported_tld"` // Statuses for domain transfers into Cloudflare Registrar. TransferIn DomainTransferIn `json:"transfer_in"` // Last updated. UpdatedAt time.Time `json:"updated_at" format:"date-time"` JSON domainJSON `json:"-"` }
func (*Domain) UnmarshalJSON ¶
type DomainGetParams ¶
type DomainGetResponseArray ¶
type DomainGetResponseArray []interface{}
func (DomainGetResponseArray) ImplementsRegistrarDomainGetResponseUnion ¶
func (r DomainGetResponseArray) ImplementsRegistrarDomainGetResponseUnion()
type DomainGetResponseEnvelope ¶
type DomainGetResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` Result DomainGetResponseUnion `json:"result,required,nullable"` // Whether the API call was successful Success DomainGetResponseEnvelopeSuccess `json:"success,required"` JSON domainGetResponseEnvelopeJSON `json:"-"` }
func (*DomainGetResponseEnvelope) UnmarshalJSON ¶
func (r *DomainGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DomainGetResponseEnvelopeSuccess ¶
type DomainGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
DomainGetResponseEnvelopeSuccessTrue DomainGetResponseEnvelopeSuccess = true
)
func (DomainGetResponseEnvelopeSuccess) IsKnown ¶
func (r DomainGetResponseEnvelopeSuccess) IsKnown() bool
type DomainGetResponseUnion ¶
type DomainGetResponseUnion interface {
ImplementsRegistrarDomainGetResponseUnion()
}
Union satisfied by registrar.DomainGetResponseUnknown, registrar.DomainGetResponseArray or shared.UnionString.
type DomainListParams ¶
type DomainRegistrantContact ¶
type DomainRegistrantContact struct { // Address. Address string `json:"address,required"` // City. City string `json:"city,required"` // The country in which the user lives. Country string `json:"country,required,nullable"` // User's first name FirstName string `json:"first_name,required,nullable"` // User's last name LastName string `json:"last_name,required,nullable"` // Name of organization. Organization string `json:"organization,required"` // User's telephone number Phone string `json:"phone,required,nullable"` // State. State string `json:"state,required"` // The zipcode or postal code where the user lives. Zip string `json:"zip,required,nullable"` // Contact Identifier. ID string `json:"id"` // Optional address line for unit, floor, suite, etc. Address2 string `json:"address2"` // The contact email address of the user. Email string `json:"email"` // Contact fax number. Fax string `json:"fax"` JSON domainRegistrantContactJSON `json:"-"` }
Shows contact information for domain registrant.
func (*DomainRegistrantContact) UnmarshalJSON ¶
func (r *DomainRegistrantContact) UnmarshalJSON(data []byte) (err error)
type DomainService ¶
type DomainService struct {
Options []option.RequestOption
}
DomainService 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 NewDomainService method instead.
func NewDomainService ¶
func NewDomainService(opts ...option.RequestOption) (r *DomainService)
NewDomainService 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 (*DomainService) Get ¶
func (r *DomainService) Get(ctx context.Context, domainName string, query DomainGetParams, opts ...option.RequestOption) (res *DomainGetResponseUnion, err error)
Show individual domain.
func (*DomainService) List ¶
func (r *DomainService) List(ctx context.Context, query DomainListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Domain], err error)
List domains handled by Registrar.
func (*DomainService) ListAutoPaging ¶
func (r *DomainService) ListAutoPaging(ctx context.Context, query DomainListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Domain]
List domains handled by Registrar.
func (*DomainService) Update ¶
func (r *DomainService) Update(ctx context.Context, domainName string, params DomainUpdateParams, opts ...option.RequestOption) (res *DomainUpdateResponseUnion, err error)
Update individual domain.
type DomainTransferIn ¶
type DomainTransferIn struct { // Form of authorization has been accepted by the registrant. AcceptFoa string `json:"accept_foa"` // Shows transfer status with the registry. ApproveTransfer string `json:"approve_transfer"` // Indicates if cancellation is still possible. CanCancelTransfer bool `json:"can_cancel_transfer"` // Privacy guards are disabled at the foreign registrar. DisablePrivacy interface{} `json:"disable_privacy"` // Auth code has been entered and verified. EnterAuthCode string `json:"enter_auth_code"` // Domain is unlocked at the foreign registrar. UnlockDomain interface{} `json:"unlock_domain"` JSON domainTransferInJSON `json:"-"` }
Statuses for domain transfers into Cloudflare Registrar.
func (*DomainTransferIn) UnmarshalJSON ¶
func (r *DomainTransferIn) UnmarshalJSON(data []byte) (err error)
type DomainUpdateParams ¶
type DomainUpdateParams struct { // Identifier AccountID param.Field[string] `path:"account_id,required"` // Auto-renew controls whether subscription is automatically renewed upon domain // expiration. AutoRenew param.Field[bool] `json:"auto_renew"` // Shows whether a registrar lock is in place for a domain. Locked param.Field[bool] `json:"locked"` // Privacy option controls redacting WHOIS information. Privacy param.Field[bool] `json:"privacy"` }
func (DomainUpdateParams) MarshalJSON ¶
func (r DomainUpdateParams) MarshalJSON() (data []byte, err error)
type DomainUpdateResponseArray ¶
type DomainUpdateResponseArray []interface{}
func (DomainUpdateResponseArray) ImplementsRegistrarDomainUpdateResponseUnion ¶
func (r DomainUpdateResponseArray) ImplementsRegistrarDomainUpdateResponseUnion()
type DomainUpdateResponseEnvelope ¶
type DomainUpdateResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` Result DomainUpdateResponseUnion `json:"result,required,nullable"` // Whether the API call was successful Success DomainUpdateResponseEnvelopeSuccess `json:"success,required"` JSON domainUpdateResponseEnvelopeJSON `json:"-"` }
func (*DomainUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *DomainUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DomainUpdateResponseEnvelopeSuccess ¶
type DomainUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
DomainUpdateResponseEnvelopeSuccessTrue DomainUpdateResponseEnvelopeSuccess = true
)
func (DomainUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r DomainUpdateResponseEnvelopeSuccess) IsKnown() bool
type DomainUpdateResponseUnion ¶
type DomainUpdateResponseUnion interface {
ImplementsRegistrarDomainUpdateResponseUnion()
}
Union satisfied by registrar.DomainUpdateResponseUnknown, registrar.DomainUpdateResponseArray or shared.UnionString.
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.
type RegistrarService ¶
type RegistrarService struct { Options []option.RequestOption Domains *DomainService }
RegistrarService 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 NewRegistrarService method instead.
func NewRegistrarService ¶
func NewRegistrarService(opts ...option.RequestOption) (r *RegistrarService)
NewRegistrarService 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.