Skip to content

Latest commit

 

History

History
410 lines (278 loc) · 13.6 KB

QualityDefinitionApi.md

File metadata and controls

410 lines (278 loc) · 13.6 KB

sonarr.QualityDefinitionApi

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

Method HTTP request Description
get_quality_definition_by_id GET /api/v3/qualitydefinition/{id}
get_quality_definition_limits GET /api/v3/qualitydefinition/limits
list_quality_definition GET /api/v3/qualitydefinition
put_quality_definition_update PUT /api/v3/qualitydefinition/update
update_quality_definition PUT /api/v3/qualitydefinition/{id}

get_quality_definition_by_id

QualityDefinitionResource get_quality_definition_by_id(id)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.quality_definition_resource import QualityDefinitionResource
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.QualityDefinitionApi(api_client)
    id = 56 # int | 

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

Parameters

Name Type Description Notes
id int

Return type

QualityDefinitionResource

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]

get_quality_definition_limits

QualityDefinitionLimitsResource get_quality_definition_limits()

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.quality_definition_limits_resource import QualityDefinitionLimitsResource
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.QualityDefinitionApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

QualityDefinitionLimitsResource

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_quality_definition

List[QualityDefinitionResource] list_quality_definition()

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.quality_definition_resource import QualityDefinitionResource
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.QualityDefinitionApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[QualityDefinitionResource]

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_quality_definition_update

put_quality_definition_update(quality_definition_resource=quality_definition_resource)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.quality_definition_resource import QualityDefinitionResource
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.QualityDefinitionApi(api_client)
    quality_definition_resource = [sonarr.QualityDefinitionResource()] # List[QualityDefinitionResource] |  (optional)

    try:
        api_instance.put_quality_definition_update(quality_definition_resource=quality_definition_resource)
    except Exception as e:
        print("Exception when calling QualityDefinitionApi->put_quality_definition_update: %s\n" % e)

Parameters

Name Type Description Notes
quality_definition_resource List[QualityDefinitionResource] [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_quality_definition

QualityDefinitionResource update_quality_definition(id, quality_definition_resource=quality_definition_resource)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.quality_definition_resource import QualityDefinitionResource
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.QualityDefinitionApi(api_client)
    id = 'id_example' # str | 
    quality_definition_resource = sonarr.QualityDefinitionResource() # QualityDefinitionResource |  (optional)

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

Parameters

Name Type Description Notes
id str
quality_definition_resource QualityDefinitionResource [optional]

Return type

QualityDefinitionResource

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]