Skip to content

CollectionApi.md

Latest commit

 

History

History
336 lines (228 loc) · 10.5 KB

CollectionApi.md

File metadata and controls

336 lines (228 loc) · 10.5 KB

radarr.CollectionApi

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

Method HTTP request Description
get_collection_by_id GET /api/v3/collection/{id}
list_collection GET /api/v3/collection
put_collection PUT /api/v3/collection
update_collection PUT /api/v3/collection/{id}

get_collection_by_id

CollectionResource get_collection_by_id(id)

Example

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

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

Parameters

Name Type Description Notes
id int

Return type

CollectionResource

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_collection

List[CollectionResource] list_collection(tmdb_id=tmdb_id)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import radarr
from radarr.models.collection_resource import CollectionResource
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.CollectionApi(api_client)
    tmdb_id = 56 # int |  (optional)

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

Parameters

Name Type Description Notes
tmdb_id int [optional]

Return type

List[CollectionResource]

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_collection

put_collection(collection_update_resource=collection_update_resource)

Example

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

    try:
        api_instance.put_collection(collection_update_resource=collection_update_resource)
    except Exception as e:
        print("Exception when calling CollectionApi->put_collection: %s\n" % e)

Parameters

Name Type Description Notes
collection_update_resource CollectionUpdateResource [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_collection

CollectionResource update_collection(id, collection_resource=collection_resource)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import radarr
from radarr.models.collection_resource import CollectionResource
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.CollectionApi(api_client)
    id = 'id_example' # str | 
    collection_resource = radarr.CollectionResource() # CollectionResource |  (optional)

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

Parameters

Name Type Description Notes
id str
collection_resource CollectionResource [optional]

Return type

CollectionResource

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]