Skip to content

Latest commit

 

History

History
258 lines (171 loc) · 8.44 KB

DownloadClientConfigApi.md

File metadata and controls

258 lines (171 loc) · 8.44 KB
Raw

sonarr.DownloadClientConfigApi

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

Method HTTP request Description
get_download_client_config GET /api/v3/config/downloadclient
get_download_client_config_by_id GET /api/v3/config/downloadclient/{id}
update_download_client_config PUT /api/v3/config/downloadclient/{id}

get_download_client_config

DownloadClientConfigResource get_download_client_config()

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.download_client_config_resource import DownloadClientConfigResource
from sonarr.rest import ApiException
from pprint import pprint

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

# 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: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

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

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

    try:
        api_response = api_instance.get_download_client_config()
        print("The response of DownloadClientConfigApi->get_download_client_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadClientConfigApi->get_download_client_config: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DownloadClientConfigResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
2XX OK -

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

get_download_client_config_by_id

DownloadClientConfigResource get_download_client_config_by_id(id)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.download_client_config_resource import DownloadClientConfigResource
from sonarr.rest import ApiException
from pprint import pprint

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

# 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: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientConfigApi(api_client)
    id = 56 # int | 

    try:
        api_response = api_instance.get_download_client_config_by_id(id)
        print("The response of DownloadClientConfigApi->get_download_client_config_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadClientConfigApi->get_download_client_config_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

DownloadClientConfigResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
2XX OK -

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

update_download_client_config

DownloadClientConfigResource update_download_client_config(id, download_client_config_resource=download_client_config_resource)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.download_client_config_resource import DownloadClientConfigResource
from sonarr.rest import ApiException
from pprint import pprint

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

# 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: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientConfigApi(api_client)
    id = 'id_example' # str | 
    download_client_config_resource = sonarr.DownloadClientConfigResource() # DownloadClientConfigResource |  (optional)

    try:
        api_response = api_instance.update_download_client_config(id, download_client_config_resource=download_client_config_resource)
        print("The response of DownloadClientConfigApi->update_download_client_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadClientConfigApi->update_download_client_config: %s\n" % e)

Parameters

Name Type Description Notes
id str
download_client_config_resource DownloadClientConfigResource [optional]

Return type

DownloadClientConfigResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
2XX OK -

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