Skip to content

Latest commit

 

History

History
94 lines (62 loc) · 2.83 KB

RenameEpisodeApi.md

File metadata and controls

94 lines (62 loc) · 2.83 KB
Raw

sonarr.RenameEpisodeApi

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

Method HTTP request Description
list_rename GET /api/v3/rename

list_rename

List[RenameEpisodeResource] list_rename(series_id=series_id, season_number=season_number)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.rename_episode_resource import RenameEpisodeResource
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.RenameEpisodeApi(api_client)
    series_id = 56 # int |  (optional)
    season_number = 56 # int |  (optional)

    try:
        api_response = api_instance.list_rename(series_id=series_id, season_number=season_number)
        print("The response of RenameEpisodeApi->list_rename:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RenameEpisodeApi->list_rename: %s\n" % e)

Parameters

Name Type Description Notes
series_id int [optional]
season_number int [optional]

Return type

List[RenameEpisodeResource]

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]