All URIs are relative to http://localhost:8686
Method | HTTP request | Description |
---|---|---|
get_naming_config | GET /api/v1/config/naming | |
get_naming_config_by_id | GET /api/v1/config/naming/{id} | |
get_naming_config_examples | GET /api/v1/config/naming/examples | |
update_naming_config | PUT /api/v1/config/naming/{id} |
NamingConfigResource get_naming_config()
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import lidarr
from lidarr.models.naming_config_resource import NamingConfigResource
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.NamingConfigApi(api_client)
try:
api_response = api_instance.get_naming_config()
print("The response of NamingConfigApi->get_naming_config:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NamingConfigApi->get_naming_config: %s\n" % e)
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
Status code | Description | Response headers |
---|---|---|
2XX | Success | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamingConfigResource get_naming_config_by_id(id)
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import lidarr
from lidarr.models.naming_config_resource import NamingConfigResource
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.NamingConfigApi(api_client)
id = 56 # int |
try:
api_response = api_instance.get_naming_config_by_id(id)
print("The response of NamingConfigApi->get_naming_config_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NamingConfigApi->get_naming_config_by_id: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
Status code | Description | Response headers |
---|---|---|
2XX | Success | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_naming_config_examples(rename_tracks=rename_tracks, replace_illegal_characters=replace_illegal_characters, colon_replacement_format=colon_replacement_format, standard_track_format=standard_track_format, multi_disc_track_format=multi_disc_track_format, artist_folder_format=artist_folder_format, include_artist_name=include_artist_name, include_album_title=include_album_title, include_quality=include_quality, replace_spaces=replace_spaces, separator=separator, number_style=number_style, id=id, resource_name=resource_name)
- 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.NamingConfigApi(api_client)
rename_tracks = True # bool | (optional)
replace_illegal_characters = True # bool | (optional)
colon_replacement_format = 56 # int | (optional)
standard_track_format = 'standard_track_format_example' # str | (optional)
multi_disc_track_format = 'multi_disc_track_format_example' # str | (optional)
artist_folder_format = 'artist_folder_format_example' # str | (optional)
include_artist_name = True # bool | (optional)
include_album_title = True # bool | (optional)
include_quality = True # bool | (optional)
replace_spaces = True # bool | (optional)
separator = 'separator_example' # str | (optional)
number_style = 'number_style_example' # str | (optional)
id = 56 # int | (optional)
resource_name = 'resource_name_example' # str | (optional)
try:
api_instance.get_naming_config_examples(rename_tracks=rename_tracks, replace_illegal_characters=replace_illegal_characters, colon_replacement_format=colon_replacement_format, standard_track_format=standard_track_format, multi_disc_track_format=multi_disc_track_format, artist_folder_format=artist_folder_format, include_artist_name=include_artist_name, include_album_title=include_album_title, include_quality=include_quality, replace_spaces=replace_spaces, separator=separator, number_style=number_style, id=id, resource_name=resource_name)
except Exception as e:
print("Exception when calling NamingConfigApi->get_naming_config_examples: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
rename_tracks | bool | [optional] | |
replace_illegal_characters | bool | [optional] | |
colon_replacement_format | int | [optional] | |
standard_track_format | str | [optional] | |
multi_disc_track_format | str | [optional] | |
artist_folder_format | str | [optional] | |
include_artist_name | bool | [optional] | |
include_album_title | bool | [optional] | |
include_quality | bool | [optional] | |
replace_spaces | bool | [optional] | |
separator | str | [optional] | |
number_style | str | [optional] | |
id | int | [optional] | |
resource_name | str | [optional] |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
2XX | Success | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamingConfigResource update_naming_config(id, naming_config_resource=naming_config_resource)
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import lidarr
from lidarr.models.naming_config_resource import NamingConfigResource
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.NamingConfigApi(api_client)
id = 'id_example' # str |
naming_config_resource = lidarr.NamingConfigResource() # NamingConfigResource | (optional)
try:
api_response = api_instance.update_naming_config(id, naming_config_resource=naming_config_resource)
print("The response of NamingConfigApi->update_naming_config:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NamingConfigApi->update_naming_config: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | ||
naming_config_resource | NamingConfigResource | [optional] |
- Content-Type: application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
Status code | Description | Response headers |
---|---|---|
2XX | Success | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]