prowlarr

Documentation

Index

• Constants
• type Prowlarr
  • func New(config *starr.Config) *Prowlarr
  • func (p *Prowlarr) AddTag(tag *starr.Tag) (*starr.Tag, error)
  • func (p *Prowlarr) AddTagContext(ctx context.Context, tag *starr.Tag) (*starr.Tag, error)
  • func (p *Prowlarr) DeleteTag(tagID int) error
  • func (p *Prowlarr) DeleteTagContext(ctx context.Context, tagID int) error
  • func (p *Prowlarr) GetBackupFiles() ([]*starr.BackupFile, error)
  • func (p *Prowlarr) GetBackupFilesContext(ctx context.Context) ([]*starr.BackupFile, error)
  • func (p *Prowlarr) GetSystemStatus() (*SystemStatus, error)
  • func (p *Prowlarr) GetSystemStatusContext(ctx context.Context) (*SystemStatus, error)
  • func (p *Prowlarr) GetTag(tagID int) (*starr.Tag, error)
  • func (p *Prowlarr) GetTagContext(ctx context.Context, tagID int) (*starr.Tag, error)
  • func (p *Prowlarr) GetTags() ([]*starr.Tag, error)
  • func (p *Prowlarr) GetTagsContext(ctx context.Context) ([]*starr.Tag, error)
  • func (p *Prowlarr) UpdateTag(tag *starr.Tag) (*starr.Tag, error)
  • func (p *Prowlarr) UpdateTagContext(ctx context.Context, tag *starr.Tag) (*starr.Tag, error)
• type SystemStatus

Constants

const APIver = "v1"

APIver is the Prowlarr API version supported by this library.

Types

type Prowlarr

type Prowlarr struct {
	starr.APIer
}

Prowlarr contains all the methods to interact with a Prowlarr server.

func New

func New(config *starr.Config) *Prowlarr

New returns a Prowlarr object used to interact with the Prowlarr API.

func (*Prowlarr) AddTag

func (p *Prowlarr) AddTag(tag *starr.Tag) (*starr.Tag, error)

AddTag creates a tag.

func (*Prowlarr) AddTagContext

func (p *Prowlarr) AddTagContext(ctx context.Context, tag *starr.Tag) (*starr.Tag, error)

AddTagContext creates a tag.

func (*Prowlarr) DeleteTag

func (p *Prowlarr) DeleteTag(tagID int) error

DeleteTag removes a single tag.

func (*Prowlarr) DeleteTagContext

func (p *Prowlarr) DeleteTagContext(ctx context.Context, tagID int) error

func (*Prowlarr) GetBackupFiles

func (p *Prowlarr) GetBackupFiles() ([]*starr.BackupFile, error)

GetBackupFiles returns all available Prowlarr backup files. Use GetBody to download a file using BackupFile.Path.

func (*Prowlarr) GetBackupFilesContext

func (p *Prowlarr) GetBackupFilesContext(ctx context.Context) ([]*starr.BackupFile, error)

GetBackupFiles returns all available Prowlarr backup files. Use GetBody to download a file using BackupFile.Path.

func (*Prowlarr) GetSystemStatus

func (p *Prowlarr) GetSystemStatus() (*SystemStatus, error)

GetSystemStatus returns system status.

func (*Prowlarr) GetSystemStatusContext

func (p *Prowlarr) GetSystemStatusContext(ctx context.Context) (*SystemStatus, error)

GetSystemStatusContext returns system status.

func (*Prowlarr) GetTag

func (p *Prowlarr) GetTag(tagID int) (*starr.Tag, error)

GetTag returns a single tag.

func (*Prowlarr) GetTagContext

func (p *Prowlarr) GetTagContext(ctx context.Context, tagID int) (*starr.Tag, error)

GetTagContext returns a single tag.

func (*Prowlarr) GetTags

func (p *Prowlarr) GetTags() ([]*starr.Tag, error)

GetTags returns all configured tags.

func (*Prowlarr) GetTagsContext

func (p *Prowlarr) GetTagsContext(ctx context.Context) ([]*starr.Tag, error)

GetTagsContext returns all configured tags.

func (*Prowlarr) UpdateTag

func (p *Prowlarr) UpdateTag(tag *starr.Tag) (*starr.Tag, error)

UpdateTag updates a tag.

func (*Prowlarr) UpdateTagContext

func (p *Prowlarr) UpdateTagContext(ctx context.Context, tag *starr.Tag) (*starr.Tag, error)

UpdateTagContext updates a tag.

type SystemStatus

type SystemStatus struct {
	AppData                string    `json:"appData"`
	AppName                string    `json:"appName"`
	Authentication         string    `json:"authentication"`
	Branch                 string    `json:"branch"`
	BuildTime              time.Time `json:"buildTime"`
	DatabaseType           string    `json:"databaseType"`
	DatabaseVersion        string    `json:"databaseVersion"`
	InstanceName           string    `json:"instanceName"`
	IsAdmin                bool      `json:"isAdmin"`
	IsDebug                bool      `json:"isDebug"`
	IsDocker               bool      `json:"isDocker"`
	IsLinux                bool      `json:"isLinux"`
	IsMono                 bool      `json:"isMono"`
	IsNetCore              bool      `json:"isNetCore"`
	IsOsx                  bool      `json:"isOsx"`
	IsProduction           bool      `json:"isProduction"`
	IsUserInteractive      bool      `json:"isUserInteractive"`
	IsWindows              bool      `json:"isWindows"`
	MigrationVersion       int64     `json:"migrationVersion"`
	Mode                   string    `json:"mode"`
	OsName                 string    `json:"osName"`
	OsVersion              string    `json:"osVersion"`
	PackageAuthor          string    `json:"packageAuthor"`
	PackageUpdateMechanism string    `json:"packageUpdateMechanism"`
	PackageVersion         string    `json:"packageVersion"`
	RuntimeName            string    `json:"runtimeName"`
	RuntimeVersion         string    `json:"runtimeVersion"`
	StartTime              time.Time `json:"startTime"`
	StartupPath            string    `json:"startupPath"`
	URLBase                string    `json:"urlBase"`
	Version                string    `json:"version"`
}

SystemStatus is the /api/v1/system/status endpoint.