seerr.ServiceApi

All URIs are relative to http://localhost:5055/api/v1

Method	HTTP request	Description
get_service_radarr_by_radarr_id	GET /service/radarr/{radarrId}	Get Radarr server quality profiles and root folders
get_service_sonarr_by_sonarr_id	GET /service/sonarr/{sonarrId}	Get Sonarr server quality profiles and root folders
list_service_radarr	GET /service/radarr	Get non-sensitive Radarr server list
list_service_sonarr	GET /service/sonarr	Get non-sensitive Sonarr server list
list_service_sonarr_lookup_by_tmdb_id	GET /service/sonarr/lookup/{tmdbId}	Get series from Sonarr

get_service_radarr_by_radarr_id

GetServiceRadarrByRadarrId2XXResponse get_service_radarr_by_radarr_id(radarr_id)

Get Radarr server quality profiles and root folders

Returns a Radarr server's quality profile and root folder details in a JSON object.

Example

Api Key Authentication (apiKey):
Api Key Authentication (cookieAuth):

import seerr
from seerr.models.get_service_radarr_by_radarr_id2_xx_response import GetServiceRadarrByRadarrId2XXResponse
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.ServiceApi(api_client)
    radarr_id = 0 # float | 

    try:
        # Get Radarr server quality profiles and root folders
        api_response = api_instance.get_service_radarr_by_radarr_id(radarr_id)
        print("The response of ServiceApi->get_service_radarr_by_radarr_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceApi->get_service_radarr_by_radarr_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
radarr_id	float

Return type

GetServiceRadarrByRadarrId2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Request successful	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_service_sonarr_by_sonarr_id

GetServiceSonarrBySonarrId2XXResponse get_service_sonarr_by_sonarr_id(sonarr_id)

Get Sonarr server quality profiles and root folders

Returns a Sonarr server's quality profile and root folder details in a JSON object.

Example

Api Key Authentication (apiKey):
Api Key Authentication (cookieAuth):

import seerr
from seerr.models.get_service_sonarr_by_sonarr_id2_xx_response import GetServiceSonarrBySonarrId2XXResponse
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.ServiceApi(api_client)
    sonarr_id = 0 # float | 

    try:
        # Get Sonarr server quality profiles and root folders
        api_response = api_instance.get_service_sonarr_by_sonarr_id(sonarr_id)
        print("The response of ServiceApi->get_service_sonarr_by_sonarr_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceApi->get_service_sonarr_by_sonarr_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
sonarr_id	float

Return type

GetServiceSonarrBySonarrId2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Request successful	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_service_radarr

List[RadarrSettings] list_service_radarr()

Get non-sensitive Radarr server list

Returns a list of Radarr server IDs and names in a JSON object.

Example

Api Key Authentication (apiKey):
Api Key Authentication (cookieAuth):

import seerr
from seerr.models.radarr_settings import RadarrSettings
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.ServiceApi(api_client)

    try:
        # Get non-sensitive Radarr server list
        api_response = api_instance.list_service_radarr()
        print("The response of ServiceApi->list_service_radarr:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceApi->list_service_radarr: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[RadarrSettings]

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Request successful	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_service_sonarr

List[SonarrSettings] list_service_sonarr()

Get non-sensitive Sonarr server list

Returns a list of Sonarr server IDs and names in a JSON object.

Example

Api Key Authentication (apiKey):
Api Key Authentication (cookieAuth):

import seerr
from seerr.models.sonarr_settings import SonarrSettings
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.ServiceApi(api_client)

    try:
        # Get non-sensitive Sonarr server list
        api_response = api_instance.list_service_sonarr()
        print("The response of ServiceApi->list_service_sonarr:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceApi->list_service_sonarr: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[SonarrSettings]

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Request successful	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_service_sonarr_lookup_by_tmdb_id

List[SonarrSeries] list_service_sonarr_lookup_by_tmdb_id(tmdb_id)

Get series from Sonarr

Returns a list of series returned by searching for the name in Sonarr.

Example

Api Key Authentication (apiKey):
Api Key Authentication (cookieAuth):

import seerr
from seerr.models.sonarr_series import SonarrSeries
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.ServiceApi(api_client)
    tmdb_id = 0 # float | 

    try:
        # Get series from Sonarr
        api_response = api_instance.list_service_sonarr_lookup_by_tmdb_id(tmdb_id)
        print("The response of ServiceApi->list_service_sonarr_lookup_by_tmdb_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceApi->list_service_sonarr_lookup_by_tmdb_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
tmdb_id	float

Return type

List[SonarrSeries]

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Request successful	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Navigation Menu

Repository navigation

seerr.ServiceApi

get_service_radarr_by_radarr_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_service_sonarr_by_sonarr_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_service_radarr

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_service_sonarr

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_service_sonarr_lookup_by_tmdb_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

FilesExpand file tree

ServiceApi.md

Latest commit

History

ServiceApi.md

File metadata and controls

seerr.ServiceApi

get_service_radarr_by_radarr_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_service_sonarr_by_sonarr_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_service_radarr

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_service_sonarr

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_service_sonarr_lookup_by_tmdb_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details