radarr.MovieFileApi

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

Method	HTTP request	Description
delete_movie_file	DELETE /api/v3/moviefile/{id}
delete_movie_file_bulk	DELETE /api/v3/moviefile/bulk
get_movie_file_by_id	GET /api/v3/moviefile/{id}
list_movie_file	GET /api/v3/moviefile
put_movie_file_bulk	PUT /api/v3/moviefile/bulk
put_movie_file_editor	PUT /api/v3/moviefile/editor
update_movie_file	PUT /api/v3/moviefile/{id}

delete_movie_file

delete_movie_file(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.MovieFileApi(api_client)
    id = 56 # int | 

    try:
        api_instance.delete_movie_file(id)
    except Exception as e:
        print("Exception when calling MovieFileApi->delete_movie_file: %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_movie_file_bulk

delete_movie_file_bulk(movie_file_list_resource=movie_file_list_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import radarr
from radarr.models.movie_file_list_resource import MovieFileListResource
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.MovieFileApi(api_client)
    movie_file_list_resource = radarr.MovieFileListResource() # MovieFileListResource |  (optional)

    try:
        api_instance.delete_movie_file_bulk(movie_file_list_resource=movie_file_list_resource)
    except Exception as e:
        print("Exception when calling MovieFileApi->delete_movie_file_bulk: %s\n" % e)

Parameters

Name	Type	Description	Notes
movie_file_list_resource	MovieFileListResource		[optional]

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: 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_movie_file_by_id

MovieFileResource get_movie_file_by_id(id)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import radarr
from radarr.models.movie_file_resource import MovieFileResource
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.MovieFileApi(api_client)
    id = 56 # int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

MovieFileResource

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]

list_movie_file

List[MovieFileResource] list_movie_file(movie_id=movie_id, movie_file_ids=movie_file_ids)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import radarr
from radarr.models.movie_file_resource import MovieFileResource
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.MovieFileApi(api_client)
    movie_id = [56] # List[int] |  (optional)
    movie_file_ids = [56] # List[int] |  (optional)

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

Parameters

Name	Type	Description	Notes
movie_id	List[int]		[optional]
movie_file_ids	List[int]		[optional]

Return type

List[MovieFileResource]

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]

put_movie_file_bulk

put_movie_file_bulk(movie_file_resource=movie_file_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import radarr
from radarr.models.movie_file_resource import MovieFileResource
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.MovieFileApi(api_client)
    movie_file_resource = [radarr.MovieFileResource()] # List[MovieFileResource] |  (optional)

    try:
        api_instance.put_movie_file_bulk(movie_file_resource=movie_file_resource)
    except Exception as e:
        print("Exception when calling MovieFileApi->put_movie_file_bulk: %s\n" % e)

Parameters

Name	Type	Description	Notes
movie_file_resource	List[MovieFileResource]		[optional]

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

put_movie_file_editor

put_movie_file_editor(movie_file_list_resource=movie_file_list_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import radarr
from radarr.models.movie_file_list_resource import MovieFileListResource
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.MovieFileApi(api_client)
    movie_file_list_resource = radarr.MovieFileListResource() # MovieFileListResource |  (optional)

    try:
        api_instance.put_movie_file_editor(movie_file_list_resource=movie_file_list_resource)
    except Exception as e:
        print("Exception when calling MovieFileApi->put_movie_file_editor: %s\n" % e)

Parameters

Name	Type	Description	Notes
movie_file_list_resource	MovieFileListResource		[optional]

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

update_movie_file

MovieFileResource update_movie_file(id, movie_file_resource=movie_file_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import radarr
from radarr.models.movie_file_resource import MovieFileResource
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.MovieFileApi(api_client)
    id = 'id_example' # str | 
    movie_file_resource = radarr.MovieFileResource() # MovieFileResource |  (optional)

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

Parameters

Name	Type	Description	Notes
id	str
movie_file_resource	MovieFileResource		[optional]

Return type

MovieFileResource

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]

Uh oh!

FilesExpand file tree

MovieFileApi.md

Latest commit

History

MovieFileApi.md

File metadata and controls

radarr.MovieFileApi

delete_movie_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_movie_file_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_movie_file_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_movie_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_movie_file_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_movie_file_editor

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_movie_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details