Skip to content

Latest commit

 

History

History
161 lines (107 loc) · 4.78 KB

LocalizationApi.md

File metadata and controls

161 lines (107 loc) · 4.78 KB

prowlarr.LocalizationApi

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

Method HTTP request Description
get_localization GET /api/v1/localization
list_localization_options GET /api/v1/localization/options

get_localization

get_localization()

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import prowlarr
from prowlarr.rest import ApiException
from pprint import pprint

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

# 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 prowlarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = prowlarr.LocalizationApi(api_client)

    try:
        api_instance.get_localization()
    except Exception as e:
        print("Exception when calling LocalizationApi->get_localization: %s\n" % e)

Parameters

This endpoint does not need any parameter.

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]

list_localization_options

List[LocalizationOption] list_localization_options()

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import prowlarr
from prowlarr.models.localization_option import LocalizationOption
from prowlarr.rest import ApiException
from pprint import pprint

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

# 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 prowlarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = prowlarr.LocalizationApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[LocalizationOption]

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]