Skip to content

BlocklistApi.md

Latest commit

 

History

History
343 lines (235 loc) · 11.1 KB

BlocklistApi.md

File metadata and controls

343 lines (235 loc) · 11.1 KB

radarr.BlocklistApi

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

Method HTTP request Description
delete_blocklist DELETE /api/v3/blocklist/{id}
delete_blocklist_bulk DELETE /api/v3/blocklist/bulk
get_blocklist GET /api/v3/blocklist
list_blocklist_movie GET /api/v3/blocklist/movie

delete_blocklist

delete_blocklist(id)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import radarr
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.BlocklistApi(api_client)
    id = 56 # int | 

    try:
        api_instance.delete_blocklist(id)
    except Exception as e:
        print("Exception when calling BlocklistApi->delete_blocklist: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
2XX OK -

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

delete_blocklist_bulk

delete_blocklist_bulk(blocklist_bulk_resource=blocklist_bulk_resource)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import radarr
from radarr.models.blocklist_bulk_resource import BlocklistBulkResource
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.BlocklistApi(api_client)
    blocklist_bulk_resource = radarr.BlocklistBulkResource() # BlocklistBulkResource |  (optional)

    try:
        api_instance.delete_blocklist_bulk(blocklist_bulk_resource=blocklist_bulk_resource)
    except Exception as e:
        print("Exception when calling BlocklistApi->delete_blocklist_bulk: %s\n" % e)

Parameters

Name Type Description Notes
blocklist_bulk_resource BlocklistBulkResource [optional]

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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_blocklist

BlocklistResourcePagingResource get_blocklist(page=page, page_size=page_size, sort_key=sort_key, sort_direction=sort_direction, movie_ids=movie_ids, protocols=protocols)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import radarr
from radarr.models.blocklist_resource_paging_resource import BlocklistResourcePagingResource
from radarr.models.download_protocol import DownloadProtocol
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.BlocklistApi(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)
    movie_ids = [56] # List[int] |  (optional)
    protocols = [radarr.DownloadProtocol()] # List[DownloadProtocol] |  (optional)

    try:
        api_response = api_instance.get_blocklist(page=page, page_size=page_size, sort_key=sort_key, sort_direction=sort_direction, movie_ids=movie_ids, protocols=protocols)
        print("The response of BlocklistApi->get_blocklist:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BlocklistApi->get_blocklist: %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]
movie_ids List[int] [optional]
protocols List[DownloadProtocol] [optional]

Return type

BlocklistResourcePagingResource

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]

list_blocklist_movie

List[BlocklistResource] list_blocklist_movie(movie_id=movie_id)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import radarr
from radarr.models.blocklist_resource import BlocklistResource
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.BlocklistApi(api_client)
    movie_id = 56 # int |  (optional)

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

Parameters

Name Type Description Notes
movie_id int [optional]

Return type

List[BlocklistResource]

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • 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]