api

Documentation

Index

• type APIToken
• type Client
  • func NewAPITokenClient(baseURL, tokenID, secret string, tlsInsecure bool) (*Client, error)
  • func NewTicketClient(baseURL, user, pass, totpSeed string, tlsInsecure bool) (*Client, error)
  • func (c *Client) Delete(url *url.URL) ([]byte, error)
  • func (c *Client) DeleteItem(item ItemDeleter, basePath, id string, digest string, extraParams ...URLParam) error
  • func (c *Client) Get(url *url.URL) ([]byte, error)
  • func (c Client) GetAll(g Getter, basePath string) ([]byte, error)
  • func (c Client) GetItem(g ItemGetter, basePath, id string) ([]byte, error)
  • func (c *Client) Post(url *url.URL) ([]byte, error)
  • func (c Client) PostItem(p Poster, basePath string) ([]byte, error)
  • func (c *Client) Put(url *url.URL) ([]byte, error)
  • func (c Client) PutItem(p ItemPutter, basePath, id string) ([]byte, error)
• type Getter
• type ItemDeleter
• type ItemGetter
• type ItemPutter
• type Poster
• type Ticket
• type URLParam
• type UserPass

Types

type APIToken

type APIToken struct {
	TokenID string
	Secret  string
}

type Client

type Client struct {
	APIurl   url.URL
	APIToken *APIToken
	// UserPass    *UserPass
	Ticket      *Ticket
	TLSInsecure bool
	HTTPClient  *http.Client
}

func NewAPITokenClient

func NewAPITokenClient(baseURL, tokenID, secret string, tlsInsecure bool) (*Client, error)

func NewTicketClient

func NewTicketClient(baseURL, user, pass, totpSeed string, tlsInsecure bool) (*Client, error)

func (*Client) Delete

func (c *Client) Delete(url *url.URL) ([]byte, error)

func (*Client) DeleteItem

func (c *Client) DeleteItem(item ItemDeleter, basePath, id string, digest string, extraParams ...URLParam) error

func (*Client) Get

func (c *Client) Get(url *url.URL) ([]byte, error)

func (Client) GetAll

func (c Client) GetAll(g Getter, basePath string) ([]byte, error)

func (Client) GetItem

func (c Client) GetItem(g ItemGetter, basePath, id string) ([]byte, error)

func (*Client) Post

func (c *Client) Post(url *url.URL) ([]byte, error)

func (Client) PostItem

func (c Client) PostItem(p Poster, basePath string) ([]byte, error)

func (*Client) Put

func (c *Client) Put(url *url.URL) ([]byte, error)

func (Client) PutItem

func (c Client) PutItem(p ItemPutter, basePath, id string) ([]byte, error)

type Getter

type Getter interface {
	GetAll() ([]byte, error)
	ParseParams(*url.URL) error
}

type ItemDeleter

type ItemDeleter interface {
	Delete() error
}

type ItemGetter

type ItemGetter interface {
	GetItem() ([]byte, error)
}

type ItemPutter

type ItemPutter interface {
	PutItem() ([]byte, error)
	ParseParams(*url.URL) error
}

type Poster

type Poster interface {
	PostItem() ([]byte, error)
	ParseParams(*url.URL) error
}

type Ticket

type Ticket struct {
	CSRFPreventionToken string `json:"CSRFPreventionToken"`
	Ticket              string `json:"ticket"`
	Username            string `json:"username"`
	NeedTFA             int    `json:"NeedTFA"`
}

type URLParam

type URLParam struct {
	Key   string
	Value types.PVEAPIType
}

type UserPass

type UserPass struct {
	User     string
	Pass     string
	TOTPSeed string
}