lidarr.TrackFileApi

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

Method	HTTP request	Description
delete_track_file	DELETE /api/v1/trackfile/{id}
delete_track_file_bulk	DELETE /api/v1/trackfile/bulk
get_track_file_by_id	GET /api/v1/trackfile/{id}
list_track_file	GET /api/v1/trackfile
put_track_file_editor	PUT /api/v1/trackfile/editor
update_track_file	PUT /api/v1/trackfile/{id}

delete_track_file

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

    try:
        api_instance.delete_track_file(id)
    except Exception as e:
        print("Exception when calling TrackFileApi->delete_track_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_track_file_bulk

delete_track_file_bulk(track_file_list_resource=track_file_list_resource)

Example

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

import lidarr
from lidarr.models.track_file_list_resource import TrackFileListResource
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.TrackFileApi(api_client)
    track_file_list_resource = lidarr.TrackFileListResource() # TrackFileListResource |  (optional)

    try:
        api_instance.delete_track_file_bulk(track_file_list_resource=track_file_list_resource)
    except Exception as e:
        print("Exception when calling TrackFileApi->delete_track_file_bulk: %s\n" % e)

Parameters

Name	Type	Description	Notes
track_file_list_resource	TrackFileListResource		[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_track_file_by_id

TrackFileResource get_track_file_by_id(id)

Example

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

import lidarr
from lidarr.models.track_file_resource import TrackFileResource
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.TrackFileApi(api_client)
    id = 56 # int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

TrackFileResource

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_track_file

List[TrackFileResource] list_track_file(artist_id=artist_id, track_file_ids=track_file_ids, album_id=album_id, unmapped=unmapped)

Example

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

import lidarr
from lidarr.models.track_file_resource import TrackFileResource
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.TrackFileApi(api_client)
    artist_id = 56 # int |  (optional)
    track_file_ids = [56] # List[int] |  (optional)
    album_id = [56] # List[int] |  (optional)
    unmapped = True # bool |  (optional)

    try:
        api_response = api_instance.list_track_file(artist_id=artist_id, track_file_ids=track_file_ids, album_id=album_id, unmapped=unmapped)
        print("The response of TrackFileApi->list_track_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TrackFileApi->list_track_file: %s\n" % e)

Parameters

Name	Type	Notes
artist_id	int	[optional]
track_file_ids	List[int]	[optional]
album_id	List[int]	[optional]
unmapped	bool	[optional]

Return type

List[TrackFileResource]

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]

put_track_file_editor

put_track_file_editor(track_file_list_resource=track_file_list_resource)

Example

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

import lidarr
from lidarr.models.track_file_list_resource import TrackFileListResource
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.TrackFileApi(api_client)
    track_file_list_resource = lidarr.TrackFileListResource() # TrackFileListResource |  (optional)

    try:
        api_instance.put_track_file_editor(track_file_list_resource=track_file_list_resource)
    except Exception as e:
        print("Exception when calling TrackFileApi->put_track_file_editor: %s\n" % e)

Parameters

Name	Type	Description	Notes
track_file_list_resource	TrackFileListResource		[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]

update_track_file

TrackFileResource update_track_file(id, track_file_resource=track_file_resource)

Example

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

import lidarr
from lidarr.models.track_file_resource import TrackFileResource
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.TrackFileApi(api_client)
    id = 'id_example' # str | 
    track_file_resource = lidarr.TrackFileResource() # TrackFileResource |  (optional)

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

Parameters

Name	Type	Description	Notes
id	str
track_file_resource	TrackFileResource		[optional]

Return type

TrackFileResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json, text/json, 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]

FilesExpand file tree

TrackFileApi.md

Latest commit

History

TrackFileApi.md

File metadata and controls

lidarr.TrackFileApi

delete_track_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_track_file_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_track_file_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_track_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_track_file_editor

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_track_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details