Go API client for radarr

Radarr API docs

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• Package version: 0.5.0

• API version: 3.0.0

• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import radarr "github.com/devopsarr/radarr-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), radarr.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), radarr.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), radarr.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), radarr.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost:7878

Class	Method	HTTP request	Description
AlternativeTitleApi	GetAlttitleById	Get /api/v3/alttitle/{id}
AlternativeTitleApi	ListAlttitle	Get /api/v3/alttitle
ApiInfoApi	GetApi	Get /api
AuthenticationApi	CreateLogin	Post /login
AuthenticationApi	GetLogout	Get /logout
AutoTaggingApi	CreateAutoTagging	Post /api/v3/autotagging
AutoTaggingApi	DeleteAutoTagging	Delete /api/v3/autotagging/{id}
AutoTaggingApi	GetAutoTaggingById	Get /api/v3/autotagging/{id}
AutoTaggingApi	ListAutoTagging	Get /api/v3/autotagging
AutoTaggingApi	ListAutoTaggingSchema	Get /api/v3/autotagging/schema
AutoTaggingApi	UpdateAutoTagging	Put /api/v3/autotagging/{id}
BackupApi	CreateSystemBackupRestoreById	Post /api/v3/system/backup/restore/{id}
BackupApi	CreateSystemBackupRestoreUpload	Post /api/v3/system/backup/restore/upload
BackupApi	DeleteSystemBackup	Delete /api/v3/system/backup/{id}
BackupApi	ListSystemBackup	Get /api/v3/system/backup
BlocklistApi	DeleteBlocklist	Delete /api/v3/blocklist/{id}
BlocklistApi	DeleteBlocklistBulk	Delete /api/v3/blocklist/bulk
BlocklistApi	GetBlocklist	Get /api/v3/blocklist
BlocklistApi	ListBlocklistMovie	Get /api/v3/blocklist/movie
CalendarApi	GetCalendarById	Get /api/v3/calendar/{id}
CalendarApi	ListCalendar	Get /api/v3/calendar
CalendarFeedApi	GetFeedV3CalendarRadarrIcs	Get /feed/v3/calendar/radarr.ics
CollectionApi	GetCollectionById	Get /api/v3/collection/{id}
CollectionApi	ListCollection	Get /api/v3/collection
CollectionApi	PutCollection	Put /api/v3/collection
CollectionApi	UpdateCollection	Put /api/v3/collection/{id}
CommandApi	CreateCommand	Post /api/v3/command
CommandApi	DeleteCommand	Delete /api/v3/command/{id}
CommandApi	GetCommandById	Get /api/v3/command/{id}
CommandApi	ListCommand	Get /api/v3/command
CreditApi	GetCredit	Get /api/v3/credit
CreditApi	GetCreditById	Get /api/v3/credit/{id}
CustomFilterApi	CreateCustomFilter	Post /api/v3/customfilter
CustomFilterApi	DeleteCustomFilter	Delete /api/v3/customfilter/{id}
CustomFilterApi	GetCustomFilterById	Get /api/v3/customfilter/{id}
CustomFilterApi	ListCustomFilter	Get /api/v3/customfilter
CustomFilterApi	UpdateCustomFilter	Put /api/v3/customfilter/{id}
CustomFormatApi	CreateCustomFormat	Post /api/v3/customformat
CustomFormatApi	DeleteCustomFormat	Delete /api/v3/customformat/{id}
CustomFormatApi	GetCustomFormatById	Get /api/v3/customformat/{id}
CustomFormatApi	ListCustomFormat	Get /api/v3/customformat
CustomFormatApi	ListCustomFormatSchema	Get /api/v3/customformat/schema
CustomFormatApi	UpdateCustomFormat	Put /api/v3/customformat/{id}
DelayProfileApi	CreateDelayProfile	Post /api/v3/delayprofile
DelayProfileApi	DeleteDelayProfile	Delete /api/v3/delayprofile/{id}
DelayProfileApi	GetDelayProfileById	Get /api/v3/delayprofile/{id}
DelayProfileApi	ListDelayProfile	Get /api/v3/delayprofile
DelayProfileApi	UpdateDelayProfile	Put /api/v3/delayprofile/{id}
DiskSpaceApi	ListDiskSpace	Get /api/v3/diskspace
DownloadClientApi	CreateDownloadClient	Post /api/v3/downloadclient
DownloadClientApi	CreateDownloadClientActionByName	Post /api/v3/downloadclient/action/{name}
DownloadClientApi	DeleteDownloadClient	Delete /api/v3/downloadclient/{id}
DownloadClientApi	DeleteDownloadClientBulk	Delete /api/v3/downloadclient/bulk
DownloadClientApi	GetDownloadClientById	Get /api/v3/downloadclient/{id}
DownloadClientApi	ListDownloadClient	Get /api/v3/downloadclient
DownloadClientApi	ListDownloadClientSchema	Get /api/v3/downloadclient/schema
DownloadClientApi	PutDownloadClientBulk	Put /api/v3/downloadclient/bulk
DownloadClientApi	TestDownloadClient	Post /api/v3/downloadclient/test
DownloadClientApi	TestallDownloadClient	Post /api/v3/downloadclient/testall
DownloadClientApi	UpdateDownloadClient	Put /api/v3/downloadclient/{id}
DownloadClientConfigApi	GetDownloadClientConfig	Get /api/v3/config/downloadclient
DownloadClientConfigApi	GetDownloadClientConfigById	Get /api/v3/config/downloadclient/{id}
DownloadClientConfigApi	UpdateDownloadClientConfig	Put /api/v3/config/downloadclient/{id}
ExtraFileApi	ListExtraFile	Get /api/v3/extrafile
FileSystemApi	GetFileSystem	Get /api/v3/filesystem
FileSystemApi	GetFileSystemMediafiles	Get /api/v3/filesystem/mediafiles
FileSystemApi	GetFileSystemType	Get /api/v3/filesystem/type
HealthApi	GetHealthById	Get /api/v3/health/{id}
HealthApi	ListHealth	Get /api/v3/health
HistoryApi	CreateHistoryFailedById	Post /api/v3/history/failed/{id}
HistoryApi	GetHistory	Get /api/v3/history
HistoryApi	ListHistoryMovie	Get /api/v3/history/movie
HistoryApi	ListHistorySince	Get /api/v3/history/since
HostConfigApi	GetHostConfig	Get /api/v3/config/host
HostConfigApi	GetHostConfigById	Get /api/v3/config/host/{id}
HostConfigApi	UpdateHostConfig	Put /api/v3/config/host/{id}
ImportExclusionsApi	CreateExclusions	Post /api/v3/exclusions
ImportExclusionsApi	CreateExclusionsBulk	Post /api/v3/exclusions/bulk
ImportExclusionsApi	DeleteExclusions	Delete /api/v3/exclusions/{id}
ImportExclusionsApi	GetExclusionsById	Get /api/v3/exclusions/{id}
ImportExclusionsApi	ListExclusions	Get /api/v3/exclusions
ImportExclusionsApi	UpdateExclusions	Put /api/v3/exclusions/{id}
ImportListApi	CreateImportList	Post /api/v3/importlist
ImportListApi	CreateImportListActionByName	Post /api/v3/importlist/action/{name}
ImportListApi	DeleteImportList	Delete /api/v3/importlist/{id}
ImportListApi	DeleteImportListBulk	Delete /api/v3/importlist/bulk
ImportListApi	GetImportListById	Get /api/v3/importlist/{id}
ImportListApi	ListImportList	Get /api/v3/importlist
ImportListApi	ListImportListSchema	Get /api/v3/importlist/schema
ImportListApi	PutImportListBulk	Put /api/v3/importlist/bulk
ImportListApi	TestImportList	Post /api/v3/importlist/test
ImportListApi	TestallImportList	Post /api/v3/importlist/testall
ImportListApi	UpdateImportList	Put /api/v3/importlist/{id}
ImportListConfigApi	GetImportListConfig	Get /api/v3/config/importlist
ImportListConfigApi	GetImportListConfigById	Get /api/v3/config/importlist/{id}
ImportListConfigApi	UpdateImportListConfig	Put /api/v3/config/importlist/{id}
ImportListMoviesApi	CreateImportlistMovie	Post /api/v3/importlist/movie
ImportListMoviesApi	GetImportlistMovie	Get /api/v3/importlist/movie
IndexerApi	CreateIndexer	Post /api/v3/indexer
IndexerApi	CreateIndexerActionByName	Post /api/v3/indexer/action/{name}
IndexerApi	DeleteIndexer	Delete /api/v3/indexer/{id}
IndexerApi	DeleteIndexerBulk	Delete /api/v3/indexer/bulk
IndexerApi	GetIndexerById	Get /api/v3/indexer/{id}
IndexerApi	ListIndexer	Get /api/v3/indexer
IndexerApi	ListIndexerSchema	Get /api/v3/indexer/schema
IndexerApi	PutIndexerBulk	Put /api/v3/indexer/bulk
IndexerApi	TestIndexer	Post /api/v3/indexer/test
IndexerApi	TestallIndexer	Post /api/v3/indexer/testall
IndexerApi	UpdateIndexer	Put /api/v3/indexer/{id}
IndexerConfigApi	GetIndexerConfig	Get /api/v3/config/indexer
IndexerConfigApi	GetIndexerConfigById	Get /api/v3/config/indexer/{id}
IndexerConfigApi	UpdateIndexerConfig	Put /api/v3/config/indexer/{id}
IndexerFlagApi	ListIndexerFlag	Get /api/v3/indexerflag
LanguageApi	GetLanguageById	Get /api/v3/language/{id}
LanguageApi	ListLanguage	Get /api/v3/language
LocalizationApi	GetLocalization	Get /api/v3/localization
LocalizationApi	GetLocalizationLanguage	Get /api/v3/localization/language
LogApi	GetLog	Get /api/v3/log
LogFileApi	GetLogFileByFilename	Get /api/v3/log/file/{filename}
LogFileApi	ListLogFile	Get /api/v3/log/file
ManualImportApi	CreateManualImport	Post /api/v3/manualimport
ManualImportApi	ListManualImport	Get /api/v3/manualimport
MediaCoverApi	GetMediaCovermovieIdByFilename	Get /api/v3/mediacover/{movieId}/{filename}
MediaManagementConfigApi	GetMediaManagementConfig	Get /api/v3/config/mediamanagement
MediaManagementConfigApi	GetMediaManagementConfigById	Get /api/v3/config/mediamanagement/{id}
MediaManagementConfigApi	UpdateMediaManagementConfig	Put /api/v3/config/mediamanagement/{id}
MetadataApi	CreateMetadata	Post /api/v3/metadata
MetadataApi	CreateMetadataActionByName	Post /api/v3/metadata/action/{name}
MetadataApi	DeleteMetadata	Delete /api/v3/metadata/{id}
MetadataApi	GetMetadataById	Get /api/v3/metadata/{id}
MetadataApi	ListMetadata	Get /api/v3/metadata
MetadataApi	ListMetadataSchema	Get /api/v3/metadata/schema
MetadataApi	TestMetadata	Post /api/v3/metadata/test
MetadataApi	TestallMetadata	Post /api/v3/metadata/testall
MetadataApi	UpdateMetadata	Put /api/v3/metadata/{id}
MetadataConfigApi	GetMetadataConfig	Get /api/v3/config/metadata
MetadataConfigApi	GetMetadataConfigById	Get /api/v3/config/metadata/{id}
MetadataConfigApi	UpdateMetadataConfig	Put /api/v3/config/metadata/{id}
MovieApi	CreateMovie	Post /api/v3/movie
MovieApi	DeleteMovie	Delete /api/v3/movie/{id}
MovieApi	GetMovieById	Get /api/v3/movie/{id}
MovieApi	ListMovie	Get /api/v3/movie
MovieApi	UpdateMovie	Put /api/v3/movie/{id}
MovieEditorApi	DeleteMovieEditor	Delete /api/v3/movie/editor
MovieEditorApi	PutMovieEditor	Put /api/v3/movie/editor
MovieFileApi	DeleteMovieFile	Delete /api/v3/moviefile/{id}
MovieFileApi	DeleteMovieFileBulk	Delete /api/v3/moviefile/bulk
MovieFileApi	GetMovieFileById	Get /api/v3/moviefile/{id}
MovieFileApi	ListMovieFile	Get /api/v3/moviefile
MovieFileApi	PutMovieFileEditor	Put /api/v3/moviefile/editor
MovieFileApi	UpdateMovieFile	Put /api/v3/moviefile/{id}
MovieImportApi	CreateMovieImport	Post /api/v3/movie/import
MovieImportApi	GetMovieImportById	Get /api/v3/movie/import/{id}
MovieLookupApi	GetMovieLookup	Get /api/v3/movie/lookup
MovieLookupApi	GetMovieLookupById	Get /api/v3/movie/lookup/{id}
MovieLookupApi	GetMovieLookupImdb	Get /api/v3/movie/lookup/imdb
MovieLookupApi	GetMovieLookupTmdb	Get /api/v3/movie/lookup/tmdb
NamingConfigApi	GetNamingConfig	Get /api/v3/config/naming
NamingConfigApi	GetNamingConfigById	Get /api/v3/config/naming/{id}
NamingConfigApi	GetNamingConfigExamples	Get /api/v3/config/naming/examples
NamingConfigApi	UpdateNamingConfig	Put /api/v3/config/naming/{id}
NotificationApi	CreateNotification	Post /api/v3/notification
NotificationApi	CreateNotificationActionByName	Post /api/v3/notification/action/{name}
NotificationApi	DeleteNotification	Delete /api/v3/notification/{id}
NotificationApi	GetNotificationById	Get /api/v3/notification/{id}
NotificationApi	ListNotification	Get /api/v3/notification
NotificationApi	ListNotificationSchema	Get /api/v3/notification/schema
NotificationApi	TestNotification	Post /api/v3/notification/test
NotificationApi	TestallNotification	Post /api/v3/notification/testall
NotificationApi	UpdateNotification	Put /api/v3/notification/{id}
ParseApi	GetParse	Get /api/v3/parse
PingApi	GetPing	Get /ping
QualityDefinitionApi	GetQualityDefinitionById	Get /api/v3/qualitydefinition/{id}
QualityDefinitionApi	ListQualityDefinition	Get /api/v3/qualitydefinition
QualityDefinitionApi	PutQualityDefinitionUpdate	Put /api/v3/qualitydefinition/update
QualityDefinitionApi	UpdateQualityDefinition	Put /api/v3/qualitydefinition/{id}
QualityProfileApi	CreateQualityProfile	Post /api/v3/qualityprofile
QualityProfileApi	DeleteQualityProfile	Delete /api/v3/qualityprofile/{id}
QualityProfileApi	GetQualityProfileById	Get /api/v3/qualityprofile/{id}
QualityProfileApi	ListQualityProfile	Get /api/v3/qualityprofile
QualityProfileApi	UpdateQualityProfile	Put /api/v3/qualityprofile/{id}
QualityProfileSchemaApi	GetQualityprofileSchema	Get /api/v3/qualityprofile/schema
QueueApi	DeleteQueue	Delete /api/v3/queue/{id}
QueueApi	DeleteQueueBulk	Delete /api/v3/queue/bulk
QueueApi	GetQueue	Get /api/v3/queue
QueueApi	GetQueueById	Get /api/v3/queue/{id}
QueueActionApi	CreateQueueGrabBulk	Post /api/v3/queue/grab/bulk
QueueActionApi	CreateQueueGrabById	Post /api/v3/queue/grab/{id}
QueueDetailsApi	GetQueueDetailsById	Get /api/v3/queue/details/{id}
QueueDetailsApi	ListQueueDetails	Get /api/v3/queue/details
QueueStatusApi	GetQueueStatus	Get /api/v3/queue/status
QueueStatusApi	GetQueueStatusById	Get /api/v3/queue/status/{id}
ReleaseApi	CreateRelease	Post /api/v3/release
ReleaseApi	GetReleaseById	Get /api/v3/release/{id}
ReleaseApi	ListRelease	Get /api/v3/release
ReleaseProfileApi	CreateReleaseProfile	Post /api/v3/releaseprofile
ReleaseProfileApi	DeleteReleaseProfile	Delete /api/v3/releaseprofile/{id}
ReleaseProfileApi	GetReleaseProfileById	Get /api/v3/releaseprofile/{id}
ReleaseProfileApi	ListReleaseProfile	Get /api/v3/releaseprofile
ReleaseProfileApi	UpdateReleaseProfile	Put /api/v3/releaseprofile/{id}
ReleasePushApi	CreateReleasePush	Post /api/v3/release/push
ReleasePushApi	GetReleasePushById	Get /api/v3/release/push/{id}
RemotePathMappingApi	CreateRemotePathMapping	Post /api/v3/remotepathmapping
RemotePathMappingApi	DeleteRemotePathMapping	Delete /api/v3/remotepathmapping/{id}
RemotePathMappingApi	GetRemotePathMappingById	Get /api/v3/remotepathmapping/{id}
RemotePathMappingApi	ListRemotePathMapping	Get /api/v3/remotepathmapping
RemotePathMappingApi	UpdateRemotePathMapping	Put /api/v3/remotepathmapping/{id}
RenameMovieApi	ListRename	Get /api/v3/rename
RootFolderApi	CreateRootFolder	Post /api/v3/rootfolder
RootFolderApi	DeleteRootFolder	Delete /api/v3/rootfolder/{id}
RootFolderApi	GetRootFolderById	Get /api/v3/rootfolder/{id}
RootFolderApi	ListRootFolder	Get /api/v3/rootfolder
StaticResourceApi	Get	Get /
StaticResourceApi	GetByPath	Get /{path}
StaticResourceApi	GetContentByPath	Get /content/{path}
StaticResourceApi	GetLogin	Get /login
SystemApi	CreateSystemRestart	Post /api/v3/system/restart
SystemApi	CreateSystemShutdown	Post /api/v3/system/shutdown
SystemApi	GetSystemRoutes	Get /api/v3/system/routes
SystemApi	GetSystemRoutesDuplicate	Get /api/v3/system/routes/duplicate
SystemApi	GetSystemStatus	Get /api/v3/system/status
TagApi	CreateTag	Post /api/v3/tag
TagApi	DeleteTag	Delete /api/v3/tag/{id}
TagApi	GetTagById	Get /api/v3/tag/{id}
TagApi	ListTag	Get /api/v3/tag
TagApi	UpdateTag	Put /api/v3/tag/{id}
TagDetailsApi	GetTagDetailById	Get /api/v3/tag/detail/{id}
TagDetailsApi	ListTagDetail	Get /api/v3/tag/detail
TaskApi	GetSystemTaskById	Get /api/v3/system/task/{id}
TaskApi	ListSystemTask	Get /api/v3/system/task
UiConfigApi	GetUiConfig	Get /api/v3/config/ui
UiConfigApi	GetUiConfigById	Get /api/v3/config/ui/{id}
UiConfigApi	UpdateUiConfig	Put /api/v3/config/ui/{id}
UpdateApi	ListUpdate	Get /api/v3/update
UpdateLogFileApi	GetLogFileUpdateByFilename	Get /api/v3/log/file/update/{filename}
UpdateLogFileApi	ListLogFileUpdate	Get /api/v3/log/file/update

Documentation For Models

• AddMovieMethod
• AddMovieOptions
• AlternativeTitle
• AlternativeTitleResource
• ApiInfoResource
• ApplyTags
• AuthenticationRequiredType
• AuthenticationType
• AutoTaggingResource
• AutoTaggingSpecificationSchema
• BackupResource
• BackupType
• BlocklistBulkResource
• BlocklistResource
• BlocklistResourcePagingResource
• CertificateValidationType
• CollectionMovieResource
• CollectionResource
• CollectionUpdateResource
• ColonReplacementFormat
• Command
• CommandPriority
• CommandResource
• CommandResult
• CommandStatus
• CommandTrigger
• CreditResource
• CreditType
• CustomFilterResource
• CustomFormatResource
• CustomFormatSpecificationSchema
• DatabaseType
• DelayProfileResource
• DiskSpaceResource
• DownloadClientBulkResource
• DownloadClientConfigResource
• DownloadClientResource
• DownloadProtocol
• ExtraFileResource
• ExtraFileType
• Field
• FileDateType
• HealthCheckResult
• HealthResource
• HistoryResource
• HistoryResourcePagingResource
• HostConfigResource
• ImportExclusionsResource
• ImportListBulkResource
• ImportListConfigResource
• ImportListResource
• ImportListType
• IndexerBulkResource
• IndexerConfigResource
• IndexerFlagResource
• IndexerResource
• Language
• LanguageResource
• LocalizationLanguageResource
• LogFileResource
• LogResource
• LogResourcePagingResource
• ManualImportReprocessResource
• ManualImportResource
• MediaCover
• MediaCoverTypes
• MediaInfoResource
• MediaManagementConfigResource
• MetadataConfigResource
• MetadataResource
• Modifier
• MonitorTypes
• MovieCollection
• MovieEditorResource
• MovieFileListResource
• MovieFileResource
• MovieHistoryEventType
• MovieMetadata
• MovieResource
• MovieRuntimeFormatType
• MovieStatusType
• MovieTranslation
• NamingConfigResource
• NotificationResource
• PagingResourceFilter
• ParseResource
• ParsedMovieInfo
• PingResource
• PrivacyLevel
• ProfileFormatItemResource
• ProperDownloadTypes
• ProviderMessage
• ProviderMessageType
• ProxyType
• Quality
• QualityDefinitionResource
• QualityModel
• QualityProfileQualityItemResource
• QualityProfileResource
• QualitySource
• QueueBulkResource
• QueueResource
• QueueResourcePagingResource
• QueueStatusResource
• RatingChild
• RatingType
• Ratings
• Rejection
• RejectionType
• ReleaseProfileResource
• ReleaseResource
• RemotePathMappingResource
• RenameMovieResource
• RescanAfterRefreshType
• Revision
• RootFolderResource
• RuntimeMode
• SelectOption
• SortDirection
• SourceType
• SystemResource
• TMDbCountryCode
• TagDetailsResource
• TagResource
• TaskResource
• TrackedDownloadState
• TrackedDownloadStatus
• TrackedDownloadStatusMessage
• UiConfigResource
• UnmappedFolder
• UpdateChanges
• UpdateMechanism
• UpdateResource

Documentation For Authorization

X-Api-Key

• Type: API key
• API key parameter name: X-Api-Key
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-Api-Key and passed in as the auth context for each request.

apikey

• Type: API key
• API key parameter name: apikey
• Location: URL query string

Note, each API key must be added to a map of map[string]APIKey where the key is: apikey and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author