prowlarr

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2025 License: MIT Imports: 9 Imported by: 7

Documentation

Index

Constants

View Source 
const APIver = "v1"

APIver is the Prowlarr API version supported by this library.

Variables

This section is empty.

Functions

This section is empty.

Types

type BulkIndexer added in v1.1.0 

type BulkIndexer struct {
	IDs            []int64         `json:"ids"`
	Tags           []int           `json:"tags,omitempty"`
	ApplyTags      starr.ApplyTags `json:"applyTags,omitempty"`
	Enable         *bool           `json:"enable,omitempty"`
	AppProfileID   *int64          `json:"appProfileId,omitempty"`
	Priority       *int64          `json:"priority,omitempty"`
	MinimumSeeders *int            `json:"minimumSeeders,omitempty"`
	SeedRatio      *int            `json:"seedRatio,omitempty"`
	SeedTime       *int            `json:"seedTime,omitempty"`
	PackSeedTime   *int            `json:"packSeedTime,omitempty"`
}

BulkIndexer is the input to UpdateIndexers. Use the starr.Ptr(any) func to create the pointers.

type Capabilities added in v1.0.0 

type Capabilities struct {
	SupportsRawSearch bool          `json:"supportsRawSearch"`
	LimitsMax         int64         `json:"limitsMax"`
	LimitsDefault     int64         `json:"limitsDefault"`
	SearchParams      []string      `json:"searchParams"`
	TvSearchParams    []string      `json:"tvSearchParams"`
	MovieSearchParams []string      `json:"movieSearchParams"`
	MusicSearchParams []string      `json:"musicSearchParams"`
	BookSearchParams  []string      `json:"bookSearchParams"`
	Categories        []*Categories `json:"categories"`
}

Capabilities is part of IndexerOutput.

type Categories added in v1.0.0 

type Categories struct {
	ID            int64         `json:"id"`
	Name          string        `json:"name"`
	SubCategories []*Categories `json:"subCategories"`
}

Categories is part of Capabilities.

type Category added in v1.1.0 

type Category struct {
	ID            int64       `json:"id"`
	Name          string      `json:"name"`
	SubCategories []*Category `json:"subCategories"`
}

Category is part of the Search output.

type DownloadClientInput added in v1.0.0 

type DownloadClientInput struct {
	Enable         bool                `json:"enable"`
	Priority       int                 `json:"priority"`
	ID             int64               `json:"id,omitempty"`
	ConfigContract string              `json:"configContract"`
	Implementation string              `json:"implementation"`
	Name           string              `json:"name"`
	Protocol       starr.Protocol      `json:"protocol"`
	Tags           []int               `json:"tags"`
	Fields         []*starr.FieldInput `json:"fields"`
}

DownloadClientInput is the input for a new or updated download client.

type DownloadClientOutput added in v1.0.0 

type DownloadClientOutput struct {
	Enable             bool                 `json:"enable"`
	Priority           int                  `json:"priority"`
	ID                 int64                `json:"id,omitempty"`
	ConfigContract     string               `json:"configContract"`
	Implementation     string               `json:"implementation"`
	ImplementationName string               `json:"implementationName"`
	InfoLink           string               `json:"infoLink"`
	Name               string               `json:"name"`
	Protocol           starr.Protocol       `json:"protocol"`
	Tags               []int                `json:"tags"`
	Fields             []*starr.FieldOutput `json:"fields"`
}

DownloadClientOutput is the output from the download client methods.

type IndexerInput added in v1.0.0 

type IndexerInput struct {
	Enable         bool                `json:"enable"`
	Redirect       bool                `json:"redirect"`
	Priority       int64               `json:"priority"`
	ID             int64               `json:"id,omitempty"`
	AppProfileID   int64               `json:"appProfileId"`
	ConfigContract string              `json:"configContract"`
	Implementation string              `json:"implementation"`
	Name           string              `json:"name"`
	Protocol       starr.Protocol      `json:"protocol"`
	Tags           []int               `json:"tags,omitempty"`
	Fields         []*starr.FieldInput `json:"fields"`
}

IndexerInput is the input for a new or updated indexer.

type IndexerOutput added in v1.0.0 

type IndexerOutput struct {
	Enable             bool                 `json:"enable"`
	Redirect           bool                 `json:"redirect"`
	SupportsRss        bool                 `json:"supportsRss"`
	SupportsSearch     bool                 `json:"supportsSearch"`
	SupportsRedirect   bool                 `json:"supportsRedirect"`
	AppProfileID       int64                `json:"appProfileId"`
	ID                 int64                `json:"id,omitempty"`
	Priority           int64                `json:"priority"`
	SortName           string               `json:"sortName"`
	Name               string               `json:"name"`
	Protocol           starr.Protocol       `json:"protocol"`
	Privacy            string               `json:"privacy"`
	DefinitionName     string               `json:"definitionName"`
	Description        string               `json:"description"`
	Language           string               `json:"language"`
	Encoding           string               `json:"encoding,omitempty"`
	ImplementationName string               `json:"implementationName"`
	Implementation     string               `json:"implementation"`
	ConfigContract     string               `json:"configContract"`
	InfoLink           string               `json:"infoLink"`
	Added              time.Time            `json:"added"`
	Capabilities       *Capabilities        `json:"capabilities,omitempty"`
	Tags               []int                `json:"tags"`
	IndexerUrls        []string             `json:"indexerUrls"`
	LegacyUrls         []string             `json:"legacyUrls"`
	Fields             []*starr.FieldOutput `json:"fields"`
}

IndexerOutput is the output from the indexer methods.

type NotificationInput added in v1.0.0 

type NotificationInput struct {
	OnGrab                      bool                `json:"onGrab"`
	OnHealthIssue               bool                `json:"onHealthIssue"`
	OnHealthRestored            bool                `json:"onHealthRestored"`
	OnApplicationUpdate         bool                `json:"onApplicationUpdate"`
	SupportsOnGrab              bool                `json:"supportsOnGrab"`
	IncludeManualGrabs          bool                `json:"includeManualGrabs"`
	SupportsOnHealthIssue       bool                `json:"supportsOnHealthIssue"`
	SupportsOnHealthRestored    bool                `json:"supportsOnHealthRestored"`
	IncludeHealthWarnings       bool                `json:"includeHealthWarnings"`
	SupportsOnApplicationUpdate bool                `json:"supportsOnApplicationUpdate"`
	ID                          int64               `json:"id,omitempty"` // update only
	Name                        string              `json:"name"`
	ImplementationName          string              `json:"implementationName"`
	Implementation              string              `json:"implementation"`
	ConfigContract              string              `json:"configContract"`
	InfoLink                    string              `json:"infoLink"`
	Tags                        []int               `json:"tags"`
	Fields                      []*starr.FieldInput `json:"fields"`
}

NotificationInput is the input for a new or updated notification.

type NotificationOutput added in v1.0.0 

type NotificationOutput struct {
	OnGrab                      bool                 `json:"onGrab"`
	OnHealthIssue               bool                 `json:"onHealthIssue"`
	OnHealthRestored            bool                 `json:"onHealthRestored"`
	OnApplicationUpdate         bool                 `json:"onApplicationUpdate"`
	SupportsOnGrab              bool                 `json:"supportsOnGrab"`
	IncludeManualGrabs          bool                 `json:"includeManualGrabs"`
	SupportsOnHealthIssue       bool                 `json:"supportsOnHealthIssue"`
	SupportsOnHealthRestored    bool                 `json:"supportsOnHealthRestored"`
	IncludeHealthWarnings       bool                 `json:"includeHealthWarnings"`
	SupportsOnApplicationUpdate bool                 `json:"supportsOnApplicationUpdate"`
	ID                          int64                `json:"id"`
	Name                        string               `json:"name"`
	ImplementationName          string               `json:"implementationName"`
	Implementation              string               `json:"implementation"`
	ConfigContract              string               `json:"configContract"`
	InfoLink                    string               `json:"infoLink"`
	Tags                        []int                `json:"tags"`
	Fields                      []*starr.FieldOutput `json:"fields"`
	Message                     struct {
		Message string `json:"message"` // this is a weird place for a message
		Type    string `json:"type"`
	} `json:"message"`
}

NotificationOutput is the output from the notification methods.

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) AddDownloadClient added in v1.0.0 

func (p *Prowlarr) AddDownloadClient(downloadclient *DownloadClientInput) (*DownloadClientOutput, error)

AddDownloadClient creates a download client without testing it.

func (*Prowlarr) AddDownloadClientContext added in v1.0.0 

func (p *Prowlarr) AddDownloadClientContext(ctx context.Context,
	client *DownloadClientInput,
) (*DownloadClientOutput, error)

AddDownloadClientContext creates a download client without testing it.

func (*Prowlarr) AddIndexer added in v1.0.0 

func (p *Prowlarr) AddIndexer(indexer *IndexerInput) (*IndexerOutput, error)

AddIndexer creates an indexer without testing it.

func (*Prowlarr) AddIndexerContext added in v1.0.0 

func (p *Prowlarr) AddIndexerContext(ctx context.Context, indexer *IndexerInput) (*IndexerOutput, error)

AddIndexerContext creates an indexer without testing it.

func (*Prowlarr) AddNotification added in v1.0.0 

func (p *Prowlarr) AddNotification(notification *NotificationInput) (*NotificationOutput, error)

AddNotification creates a notification.

func (*Prowlarr) AddNotificationContext added in v1.0.0 

func (p *Prowlarr) AddNotificationContext(ctx context.Context, client *NotificationInput) (*NotificationOutput, error)

AddNotificationContext creates a notification.

func (*Prowlarr) AddTag added in v0.14.0 

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

AddTag creates a tag.

func (*Prowlarr) AddTagContext added in v0.14.0 

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

AddTagContext creates a tag.

func (*Prowlarr) DeleteDownloadClient added in v1.0.0 

func (p *Prowlarr) DeleteDownloadClient(downloadclientID int64) error

DeleteDownloadClient removes a single download client.

func (*Prowlarr) DeleteDownloadClientContext added in v1.0.0 

func (p *Prowlarr) DeleteDownloadClientContext(ctx context.Context, downloadclientID int64) error

DeleteDownloadClientContext removes a single download client.

func (*Prowlarr) DeleteIndexer added in v1.0.0 

func (p *Prowlarr) DeleteIndexer(indexerID int64) error

DeleteIndexer removes a single indexer.

func (*Prowlarr) DeleteIndexerContext added in v1.0.0 

func (p *Prowlarr) DeleteIndexerContext(ctx context.Context, indexerID int64) error

DeleteIndexerContext removes a single indexer.

func (*Prowlarr) DeleteNotification added in v1.0.0 

func (p *Prowlarr) DeleteNotification(notificationID int64) error

DeleteNotification removes a single notification.

func (*Prowlarr) DeleteNotificationContext added in v1.0.0 

func (p *Prowlarr) DeleteNotificationContext(ctx context.Context, notificationID int64) error

func (*Prowlarr) DeleteTag added in v0.14.0 

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

DeleteTag removes a single tag.

func (*Prowlarr) DeleteTagContext added in v0.14.0 

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 added in v0.13.0 

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) GetDownloadClient added in v1.0.0 

func (p *Prowlarr) GetDownloadClient(downloadclientID int64) (*DownloadClientOutput, error)

GetDownloadClient returns a single download client.

func (*Prowlarr) GetDownloadClientContext added in v1.0.0 

func (p *Prowlarr) GetDownloadClientContext(ctx context.Context, clientID int64) (*DownloadClientOutput, error)

GetDownloadClientContext returns a single download client.

func (*Prowlarr) GetDownloadClients added in v1.0.0 

func (p *Prowlarr) GetDownloadClients() ([]*DownloadClientOutput, error)

GetDownloadClients returns all configured download clients.

func (*Prowlarr) GetDownloadClientsContext added in v1.0.0 

func (p *Prowlarr) GetDownloadClientsContext(ctx context.Context) ([]*DownloadClientOutput, error)

GetDownloadClientsContext returns all configured download clients.

func (*Prowlarr) GetIndexer added in v1.0.0 

func (p *Prowlarr) GetIndexer(indexerID int64) (*IndexerOutput, error)

GetIndexer returns a single indexer.

func (*Prowlarr) GetIndexerContext added in v1.0.0 

func (p *Prowlarr) GetIndexerContext(ctx context.Context, indexerID int64) (*IndexerOutput, error)

GetIndexerContext returns a single indexer.

func (*Prowlarr) GetIndexers added in v1.0.0 

func (p *Prowlarr) GetIndexers() ([]*IndexerOutput, error)

GetIndexers returns all configured indexers.

func (*Prowlarr) GetIndexersContext added in v1.0.0 

func (p *Prowlarr) GetIndexersContext(ctx context.Context) ([]*IndexerOutput, error)

GetIndexersContext returns all configured indexers.

func (*Prowlarr) GetNotification added in v1.0.0 

func (p *Prowlarr) GetNotification(notificationID int) (*NotificationOutput, error)

GetNotification returns a single notification.

func (*Prowlarr) GetNotificationContext added in v1.0.0 

func (p *Prowlarr) GetNotificationContext(ctx context.Context, notificationID int) (*NotificationOutput, error)

GetNotificationContext returns a single notification.

func (*Prowlarr) GetNotifications added in v1.0.0 

func (p *Prowlarr) GetNotifications() ([]*NotificationOutput, error)

GetNotifications returns all configured notifications.

func (*Prowlarr) GetNotificationsContext added in v1.0.0 

func (p *Prowlarr) GetNotificationsContext(ctx context.Context) ([]*NotificationOutput, error)

GetNotificationsContext returns all configured notifications.

func (*Prowlarr) GetSystemStatus added in v0.13.0 

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

GetSystemStatus returns system status.

func (*Prowlarr) GetSystemStatusContext added in v0.13.0 

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

GetSystemStatusContext returns system status.

func (*Prowlarr) GetTag added in v0.14.0 

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

GetTag returns a single tag.

func (*Prowlarr) GetTagContext added in v0.14.0 

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

GetTagContext returns a single tag.

func (*Prowlarr) GetTags added in v0.14.0 

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

GetTags returns all configured tags.

func (*Prowlarr) GetTagsContext added in v0.14.0 

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

GetTagsContext returns all configured tags.

func (*Prowlarr) Grab added in v1.1.0 

func (p *Prowlarr) Grab(guid string, indexerID int64) (*Search, error)

Grab attempts to download a searched item by guid. Use this with Pr*wlarr search output.

func (*Prowlarr) GrabContext added in v1.1.0 

func (p *Prowlarr) GrabContext(ctx context.Context, guid string, indexerID int64) (*Search, error)

GrabContext attempts to download a searched item by guid. Use this with Pr*wlarr search output.

func (*Prowlarr) GrabSearch added in v1.1.0 

func (p *Prowlarr) GrabSearch(search *Search) (*Search, error)

GrabSearch attempts to download an item returned from a search. Pass the search for the item from the Search() output.

func (*Prowlarr) GrabSearchContext added in v1.1.0 

func (p *Prowlarr) GrabSearchContext(ctx context.Context, search *Search) (*Search, error)

GrabSearchContext attempts to download an item returned from a search. Pass the search for the item from the Search() output.

func (*Prowlarr) Ping added in v1.1.0 

func (p *Prowlarr) Ping() error

Ping returns an error if the Prowlarr instance does not respond with a 200 to an HTTP /ping request.

func (*Prowlarr) PingContext added in v1.1.0 

func (p *Prowlarr) PingContext(ctx context.Context) error

PingContext returns an error if the Prowlarr instance does not respond with a 200 to an HTTP /ping request.

func (*Prowlarr) Search added in v1.1.0 

func (p *Prowlarr) Search(search SearchInput) ([]*Search, error)

Search the Prowlarr indexers for media and content. Must provide a Query in the SearchInput.

func (*Prowlarr) SearchContext added in v1.1.0 

func (p *Prowlarr) SearchContext(ctx context.Context, search SearchInput) ([]*Search, error)

SearchContext searches the Prowlarr indexers for media and content.

func (*Prowlarr) TestDownloadClient added in v1.0.0 

func (p *Prowlarr) TestDownloadClient(client *DownloadClientInput) error

TestDownloadClient tests a download client.

func (*Prowlarr) TestDownloadClientContext added in v1.0.0 

func (p *Prowlarr) TestDownloadClientContext(ctx context.Context, client *DownloadClientInput) error

TestDownloadClientContext tests a download client.

func (*Prowlarr) TestIndexer added in v1.0.0 

func (p *Prowlarr) TestIndexer(indexer *IndexerInput) error

TestIndexer tests an indexer.

func (*Prowlarr) TestIndexerContext added in v1.0.0 

func (p *Prowlarr) TestIndexerContext(ctx context.Context, indexer *IndexerInput) error

TestIndexerContext tests an indexer.

func (*Prowlarr) UpdateDownloadClient added in v1.0.0 

func (p *Prowlarr) UpdateDownloadClient(client *DownloadClientInput, force bool) (*DownloadClientOutput, error)

UpdateDownloadClient updates the download client.

func (*Prowlarr) UpdateDownloadClientContext added in v1.0.0 

func (p *Prowlarr) UpdateDownloadClientContext(ctx context.Context,
	client *DownloadClientInput,
	force bool,
) (*DownloadClientOutput, error)

UpdateDownloadClientContext updates the download client.

func (*Prowlarr) UpdateIndexer added in v1.0.0 

func (p *Prowlarr) UpdateIndexer(indexer *IndexerInput, force bool) (*IndexerOutput, error)

UpdateIndexer updates the indexer.

func (*Prowlarr) UpdateIndexerContext added in v1.0.0 

func (p *Prowlarr) UpdateIndexerContext(
	ctx context.Context,
	indexer *IndexerInput,
	force bool,
) (*IndexerOutput, error)

UpdateIndexerContext updates the indexer.

func (*Prowlarr) UpdateIndexers added in v1.1.0 

func (p *Prowlarr) UpdateIndexers(indexer *BulkIndexer) (*IndexerOutput, error)

UpdateIndexers bulk updates indexers.

func (*Prowlarr) UpdateIndexersContext added in v1.1.0 

func (p *Prowlarr) UpdateIndexersContext(ctx context.Context, indexer *BulkIndexer) (*IndexerOutput, error)

UpdateIndexersContext bulk updates indexers.

func (*Prowlarr) UpdateNotification added in v1.0.0 

func (p *Prowlarr) UpdateNotification(notification *NotificationInput) (*NotificationOutput, error)

UpdateNotification updates the notification.

func (*Prowlarr) UpdateNotificationContext added in v1.0.0 

func (p *Prowlarr) UpdateNotificationContext(ctx context.Context,
	client *NotificationInput,
) (*NotificationOutput, error)

UpdateNotificationContext updates the notification.

func (*Prowlarr) UpdateTag added in v0.14.0 

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

UpdateTag updates a tag.

func (*Prowlarr) UpdateTagContext added in v0.14.0 

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

UpdateTagContext updates a tag. 

type Search struct {
	GUID         string         `json:"guid"`
	Age          int64          `json:"age"`
	AgeHours     float64        `json:"ageHours"`
	AgeMinutes   float64        `json:"ageMinutes"`
	Size         int64          `json:"size"`
	Files        int            `json:"files"`
	Grabs        int            `json:"grabs"`
	IndexerID    int64          `json:"indexerId"`
	Indexer      string         `json:"indexer"`
	Title        string         `json:"title"`
	SortTitle    string         `json:"sortTitle"`
	ImdbID       int64          `json:"imdbId"`
	TmdbID       int64          `json:"tmdbId"`
	TvdbID       int64          `json:"tvdbId"`
	TvMazeID     int64          `json:"tvMazeId"`
	PublishDate  time.Time      `json:"publishDate"`
	CommentURL   string         `json:"commentUrl"`
	DownloadURL  string         `json:"downloadUrl"`
	InfoURL      string         `json:"infoUrl"`
	IndexerFlags []string       `json:"indexerFlags,omitempty"`
	Categories   []*Category    `json:"categories"`
	Protocol     starr.Protocol `json:"protocol"`
	FileName     string         `json:"fileName"`
	InfoHash     string         `json:"infoHash"`
	Seeders      int            `json:"seeders"`
	Leechers     int            `json:"leechers"`
}

Search is the output from the Prowlarr search endpoint.

type SearchInput added in v1.1.0 

type SearchInput struct {
	Query      string  `json:"query"` // Query is required. Fill it in.
	Type       string  `json:"type"`  // defaults to "search" if left empty
	IndexerIDs []int64 `json:"indexerIds"`
	Categories []int64 `json:"categories"`
	Limit      int     `json:"limit"`  // Defaults to 100 if left empty or less than 1.
	Offset     int     `json:"offset"` // Skip this many records.
}

SearchInput is the input to the search endpoint.

type SystemStatus added in v0.13.0 

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.