sonarr.DelayProfileApi

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

Method	HTTP request	Description
create_delay_profile	POST /api/v3/delayprofile
delete_delay_profile	DELETE /api/v3/delayprofile/{id}
get_delay_profile_by_id	GET /api/v3/delayprofile/{id}
list_delay_profile	GET /api/v3/delayprofile
update_delay_profile	PUT /api/v3/delayprofile/{id}
update_delay_profile_reorder	PUT /api/v3/delayprofile/reorder/{id}

create_delay_profile

DelayProfileResource create_delay_profile(delay_profile_resource=delay_profile_resource)

Example

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

import sonarr
from sonarr.models.delay_profile_resource import DelayProfileResource
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.DelayProfileApi(api_client)
    delay_profile_resource = sonarr.DelayProfileResource() # DelayProfileResource |  (optional)

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

Parameters

Name	Type	Description	Notes
delay_profile_resource	DelayProfileResource		[optional]

Return type

DelayProfileResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: 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]

delete_delay_profile

delete_delay_profile(id)

Example

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

import sonarr
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.DelayProfileApi(api_client)
    id = 56 # int | 

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

Parameters

Name	Type	Description	Notes
id	int

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]

get_delay_profile_by_id

DelayProfileResource get_delay_profile_by_id(id)

Example

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

import sonarr
from sonarr.models.delay_profile_resource import DelayProfileResource
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.DelayProfileApi(api_client)
    id = 56 # int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

DelayProfileResource

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]

list_delay_profile

List[DelayProfileResource] list_delay_profile()

Example

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

import sonarr
from sonarr.models.delay_profile_resource import DelayProfileResource
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.DelayProfileApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[DelayProfileResource]

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]

update_delay_profile

DelayProfileResource update_delay_profile(id, delay_profile_resource=delay_profile_resource)

Example

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

import sonarr
from sonarr.models.delay_profile_resource import DelayProfileResource
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.DelayProfileApi(api_client)
    id = 'id_example' # str | 
    delay_profile_resource = sonarr.DelayProfileResource() # DelayProfileResource |  (optional)

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

Parameters

Name	Type	Description	Notes
id	str
delay_profile_resource	DelayProfileResource		[optional]

Return type

DelayProfileResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: 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]

update_delay_profile_reorder

List[DelayProfileResource] update_delay_profile_reorder(id, after=after)

Example

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

import sonarr
from sonarr.models.delay_profile_resource import DelayProfileResource
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.DelayProfileApi(api_client)
    id = 56 # int | 
    after = 56 # int |  (optional)

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

Parameters

Name	Type	Description	Notes
id	int
after	int		[optional]

Return type

List[DelayProfileResource]

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]

Files

DelayProfileApi.md

Latest commit

History

DelayProfileApi.md

File metadata and controls

sonarr.DelayProfileApi

create_delay_profile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_delay_profile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_delay_profile_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_delay_profile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_delay_profile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_delay_profile_reorder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details