Skip to content

Latest commit

 

History

History
88 lines (57 loc) · 2.54 KB

QueueStatusApi.md

File metadata and controls

88 lines (57 loc) · 2.54 KB
Raw

lidarr.QueueStatusApi

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

Method HTTP request Description
get_queue_status GET /api/v1/queue/status

get_queue_status

QueueStatusResource get_queue_status()

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import lidarr
from lidarr.models.queue_status_resource import QueueStatusResource
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.QueueStatusApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

QueueStatusResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
2XX Success -

[Back to top] [Back to API list] [Back to Model list] [Back to README]