plugin_portainer_api

Documentation

Index

• type Client
  • func (c Client) CreateRegistry(name string, url string, user string, password string) (PortainerApiRegistry, error)
  • func (c Client) CreateStack(endpointId int, body string) (PortainerApiStack, error)
  • func (c Client) CreateTeam(name string) (PortainerApiTeamResult, error)
  • func (c Client) CreateTeamMembership(teamId string, userId string) error
  • func (c Client) CreateUser(username string, password string) (PortainerApiUsersResult, error)
  • func (c Client) DeleteStack(stackId int) error
  • func (c Client) GetAuthToken() string
  • func (c Client) GetEndpoints() ([]PortainerApiEndpoint, error)
  • func (c Client) GetRegistries() ([]PortainerApiRegistry, error)
  • func (c Client) GetRegistry(id int) (*PortainerApiRegistry, error)
  • func (c Client) GetUser(username string) (*PortainerApiUsersResult, error)
  • func (c Client) InitialSetup(setupData SetupData) (PortainerApiUsersResult, error)
  • func (c Client) UpdateStack(stackId int, body string) (PortainerApiStack, error)
• type PortainerApiEndpoint
• type PortainerApiRegistry
• type PortainerApiStack
• type PortainerApiTeamResult
• type PortainerApiUsersResult
• type SetupData

Types

type Client

type Client struct {
	Host string
	Port int

	AuthUser string
	AuthPass string
}

func (Client) CreateRegistry

func (c Client) CreateRegistry(name string, url string, user string, password string) (PortainerApiRegistry, error)

func (Client) CreateStack

func (c Client) CreateStack(endpointId int, body string) (PortainerApiStack, error)

func (Client) CreateTeam

func (c Client) CreateTeam(name string) (PortainerApiTeamResult, error)

func (Client) CreateTeamMembership

func (c Client) CreateTeamMembership(teamId string, userId string) error

func (Client) CreateUser

func (c Client) CreateUser(username string, password string) (PortainerApiUsersResult, error)

func (Client) DeleteStack

func (c Client) DeleteStack(stackId int) error

func (Client) GetAuthToken

func (c Client) GetAuthToken() string

func (Client) GetEndpoints

func (c Client) GetEndpoints() ([]PortainerApiEndpoint, error)

func (Client) GetRegistries

func (c Client) GetRegistries() ([]PortainerApiRegistry, error)

func (Client) GetRegistry

func (c Client) GetRegistry(id int) (*PortainerApiRegistry, error)

func (Client) GetUser

func (c Client) GetUser(username string) (*PortainerApiUsersResult, error)

func (Client) InitialSetup

func (c Client) InitialSetup(setupData SetupData) (PortainerApiUsersResult, error)

func (Client) UpdateStack

func (c Client) UpdateStack(stackId int, body string) (PortainerApiStack, error)

type PortainerApiEndpoint

type PortainerApiEndpoint struct {
	Id   string
	Name string
}

type PortainerApiRegistry

type PortainerApiRegistry struct {
	Id   string
	Name string
}

type PortainerApiStack

type PortainerApiStack struct {
	Id   string
	Name string
}

type PortainerApiTeamResult

type PortainerApiTeamResult struct {
	Id   string
	Name string
}

type PortainerApiUsersResult

type PortainerApiUsersResult struct {
	Id       string
	Username string
	Role     int
}

type SetupData

type SetupData struct {
	Username string
	Password string
}