lidarr.AutoTaggingApi

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

Method	HTTP request	Description
create_auto_tagging	POST /api/v1/autotagging
delete_auto_tagging	DELETE /api/v1/autotagging/{id}
get_auto_tagging_by_id	GET /api/v1/autotagging/{id}
list_auto_tagging	GET /api/v1/autotagging
list_auto_tagging_schema	GET /api/v1/autotagging/schema
update_auto_tagging	PUT /api/v1/autotagging/{id}

create_auto_tagging

AutoTaggingResource create_auto_tagging(auto_tagging_resource=auto_tagging_resource)

Example

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

import lidarr
from lidarr.models.auto_tagging_resource import AutoTaggingResource
from lidarr.rest import ApiException
from pprint import pprint

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

# 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 lidarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lidarr.AutoTaggingApi(api_client)
    auto_tagging_resource = lidarr.AutoTaggingResource() # AutoTaggingResource |  (optional)

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

Parameters

Name	Type	Description	Notes
auto_tagging_resource	AutoTaggingResource		[optional]

Return type

AutoTaggingResource

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]

delete_auto_tagging

delete_auto_tagging(id)

Example

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

import lidarr
from lidarr.rest import ApiException
from pprint import pprint

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

# 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 lidarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lidarr.AutoTaggingApi(api_client)
    id = 56 # int | 

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

get_auto_tagging_by_id

AutoTaggingResource get_auto_tagging_by_id(id)

Example

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

import lidarr
from lidarr.models.auto_tagging_resource import AutoTaggingResource
from lidarr.rest import ApiException
from pprint import pprint

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

# 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 lidarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lidarr.AutoTaggingApi(api_client)
    id = 56 # int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

AutoTaggingResource

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_auto_tagging

List[AutoTaggingResource] list_auto_tagging()

Example

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

import lidarr
from lidarr.models.auto_tagging_resource import AutoTaggingResource
from lidarr.rest import ApiException
from pprint import pprint

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

# 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 lidarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lidarr.AutoTaggingApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[AutoTaggingResource]

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_auto_tagging_schema

List[AutoTaggingSpecificationSchema] list_auto_tagging_schema()

Example

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

import lidarr
from lidarr.models.auto_tagging_specification_schema import AutoTaggingSpecificationSchema
from lidarr.rest import ApiException
from pprint import pprint

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

# 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 lidarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lidarr.AutoTaggingApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[AutoTaggingSpecificationSchema]

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_auto_tagging

AutoTaggingResource update_auto_tagging(id, auto_tagging_resource=auto_tagging_resource)

Example

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

import lidarr
from lidarr.models.auto_tagging_resource import AutoTaggingResource
from lidarr.rest import ApiException
from pprint import pprint

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

# 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 lidarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lidarr.AutoTaggingApi(api_client)
    id = 'id_example' # str | 
    auto_tagging_resource = lidarr.AutoTaggingResource() # AutoTaggingResource |  (optional)

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

Parameters

Name	Type	Description	Notes
id	str
auto_tagging_resource	AutoTaggingResource		[optional]

Return type

AutoTaggingResource

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]

Files

AutoTaggingApi.md

Latest commit

History

AutoTaggingApi.md

File metadata and controls

lidarr.AutoTaggingApi

create_auto_tagging

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_auto_tagging

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_auto_tagging_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_auto_tagging

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_auto_tagging_schema

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_auto_tagging

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details