Skip to content

CutoffApi.md

Latest commit

 

History

History
99 lines (69 loc) · 3.4 KB

CutoffApi.md

File metadata and controls

99 lines (69 loc) · 3.4 KB

radarr.CutoffApi

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

Method HTTP request Description
get_wanted_cutoff GET /api/v3/wanted/cutoff

get_wanted_cutoff

MovieResourcePagingResource get_wanted_cutoff(page=page, page_size=page_size, sort_key=sort_key, sort_direction=sort_direction, monitored=monitored)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import radarr
from radarr.models.movie_resource_paging_resource import MovieResourcePagingResource
from radarr.models.sort_direction import SortDirection
from radarr.rest import ApiException
from pprint import pprint

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

# 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 radarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = radarr.CutoffApi(api_client)
    page = 1 # int |  (optional) (default to 1)
    page_size = 10 # int |  (optional) (default to 10)
    sort_key = 'sort_key_example' # str |  (optional)
    sort_direction = radarr.SortDirection() # SortDirection |  (optional)
    monitored = True # bool |  (optional) (default to True)

    try:
        api_response = api_instance.get_wanted_cutoff(page=page, page_size=page_size, sort_key=sort_key, sort_direction=sort_direction, monitored=monitored)
        print("The response of CutoffApi->get_wanted_cutoff:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CutoffApi->get_wanted_cutoff: %s\n" % e)

Parameters

Name Type Description Notes
page int [optional] [default to 1]
page_size int [optional] [default to 10]
sort_key str [optional]
sort_direction SortDirection [optional]
monitored bool [optional] [default to True]

Return type

MovieResourcePagingResource

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]