whm

package

v4.15.1 Latest Latest Go to latest Published: Feb 17, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ChintuIdrive/lego

Links

Open Source Insights

Documentation ¶

Index ¶

type APIResponse
type Client
- func NewClient(baseURL string, username string, token string) (*Client, error)
type Metadata
type ZoneData

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type APIResponse ¶

type APIResponse[T any] struct {
	Metadata Metadata `json:"metadata,omitempty"`
	Data     T        `json:"data,omitempty"`
}

type Client ¶

type Client struct {
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(baseURL string, username string, token string) (*Client, error)

func (Client) AddRecord ¶

func (c Client) AddRecord(ctx context.Context, serial uint32, domain string, record shared.Record) (*shared.ZoneSerial, error)

AddRecord adds a new record.

add='{"dname":"example", "ttl":14400, "record_type":"TXT", "data":["string1", "string2"]}'

func (Client) DeleteRecord ¶

func (c Client) DeleteRecord(ctx context.Context, serial uint32, domain string, lineIndex int) (*shared.ZoneSerial, error)

DeleteRecord deletes an existing record.

remove=22

func (Client) EditRecord ¶

func (c Client) EditRecord(ctx context.Context, serial uint32, domain string, record shared.Record) (*shared.ZoneSerial, error)

EditRecord edits an existing record.

edit='{"line_index": 9, "dname":"example", "ttl":14400, "record_type":"TXT", "data":["string1", "string2"]}'

func (Client) FetchZoneInformation ¶

func (c Client) FetchZoneInformation(ctx context.Context, domain string) ([]shared.ZoneRecord, error)

FetchZoneInformation fetches zone information. https://api.docs.cpanel.net/openapi/whm/operation/parse_dns_zone/

type Metadata ¶

type Metadata struct {
	Command string `json:"command,omitempty"`
	Reason  string `json:"reason,omitempty"`
	Result  int    `json:"result,omitempty"`
	Version int    `json:"version,omitempty"`
}

type ZoneData ¶

type ZoneData struct {
	Payload []shared.ZoneRecord `json:"payload,omitempty"`
}

Source Files ¶

View all Source files

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