directadmin

package
v0.0.0-...-2c9df62 Latest Latest
Warning

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

Go to latest
Published: Nov 17, 2023 License: 0BSD Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DNSControlActionType

type DNSControlActionType string

DNSContolActionType represents DNS control action type.

const (
	// DNSControlActionAdd represents "add" action for DNS control.
	DNSControlActionAdd DNSControlActionType = "add"
	// DNSControlActionEdit represents "edit" action for DNS control.
	DNSControlActionEdit DNSControlActionType = "edit"
	// DNSControlActionDelete represents "delete" action for DNS control.
	DNSControlActionDelete DNSControlActionType = "delete"
)

type DNSControlParams

type DNSControlParams struct {
	// Domain represents domain name from DirectAdmin panel.
	Domain string `schema:"domain"`
	// Action represents DNS control action type.
	Action DNSControlActionType `schema:"action"`
	// Type represents DNS record type.
	Type DNSControlRecordType `schema:"type"`
	// Name represents DNS record name.
	Name string `schema:"name"`
	// Value represents DNS record value.
	Value string `schema:"value"`
	// TTL represents DNS record time-to-live value.
	TTL *uint16 `schema:"ttl,omitempty"`
	// ARECS0 represents aresc0 DNS record query (required for DNS record editing and deleting).
	ARECS0 string `schema:"arecs0,omitempty"`
}

DNSControlParams represents DNS control request params.

func (*DNSControlParams) MarshalZerologObject

func (p *DNSControlParams) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements zerolog.LogObjectMarshaler.

type DNSControlRecordType

type DNSControlRecordType string

DNSControlRecordType represents DNS control record type.

const (
	// DNSControlRecordTypeA represents DNS A record type for DNS control.
	DNSControlRecordTypeA DNSControlRecordType = "A"
	// DNSControlRecordTypeNS represents DNS NS record type for DNS control.
	DNSControlRecordTypeNS DNSControlRecordType = "NS"
	// DNSControlRecordTypeMX represents DNS MX record type for DNS control.
	DNSControlRecordTypeMX DNSControlRecordType = "MX"
	// DNSControlRecordTypeCNAME represents DNS CNAME record type for DNS control.
	DNSControlRecordTypeCNAME DNSControlRecordType = "CNAME"
	// DNSControlRecordTypePTR represents DNS PTR record type for DNS control.
	DNSControlRecordTypePTR DNSControlRecordType = "PTR"
)

type DNSControlResponse

type DNSControlResponse struct {
	// Error determines if error occurred during request processing.
	Error bool `schema:"error"`
	// Text represents request execution summary.
	Text string `schema:"text"`
	// Details represents additional information to request execution status.
	Details string `schema:"details"`
}

DNSControlResponse represents DNS control request response.

func (*DNSControlResponse) MarshalZerologObject

func (r *DNSControlResponse) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements zerolog.LogObjectMarshaler.

type DirectAdminClient

type DirectAdminClient interface {
	// DNSControl represents DNS control request.
	DNSControl(params *DNSControlParams) (*DNSControlResponse, error)
}

DirectAdminClient represents DirectAdmin API client.

func New

func New(addr, username, token string) DirectAdminClient

New creates new DirectAdmin client.

Jump to

Keyboard shortcuts

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