ParseApi.md

sonarr.ParseApi

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

Method	HTTP request	Description
get_parse	GET /api/v3/parse

get_parse

ParseResource get_parse(title=title, path=path)

Example

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

import sonarr
from sonarr.models.parse_resource import ParseResource
from sonarr.rest import ApiException
from pprint import pprint

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

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.ParseApi(api_client)
    title = 'title_example' # str |  (optional)
    path = 'path_example' # str |  (optional)

    try:
        api_response = api_instance.get_parse(title=title, path=path)
        print("The response of ParseApi->get_parse:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ParseApi->get_parse: %s\n" % e)

Parameters

Name	Type	Description	Notes
title	str		[optional]
path	str		[optional]

Return type

ParseResource

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]