All URIs are relative to http://localhost:8989
Method | HTTP request | Description |
---|---|---|
create_import_list_exclusion | POST /api/v3/importlistexclusion | |
delete_import_list_exclusion | DELETE /api/v3/importlistexclusion/{id} | |
delete_import_list_exclusion_bulk | DELETE /api/v3/importlistexclusion/bulk | |
get_import_list_exclusion_by_id | GET /api/v3/importlistexclusion/{id} | |
get_import_list_exclusion_paged | GET /api/v3/importlistexclusion/paged | |
list_import_list_exclusion | GET /api/v3/importlistexclusion | |
update_import_list_exclusion | PUT /api/v3/importlistexclusion/{id} |
ImportListExclusionResource create_import_list_exclusion(import_list_exclusion_resource=import_list_exclusion_resource)
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.import_list_exclusion_resource import ImportListExclusionResource
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.ImportListExclusionApi(api_client)
import_list_exclusion_resource = sonarr.ImportListExclusionResource() # ImportListExclusionResource | (optional)
try:
api_response = api_instance.create_import_list_exclusion(import_list_exclusion_resource=import_list_exclusion_resource)
print("The response of ImportListExclusionApi->create_import_list_exclusion:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ImportListExclusionApi->create_import_list_exclusion: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
import_list_exclusion_resource | ImportListExclusionResource | [optional] |
- Content-Type: application/json
- Accept: text/plain, application/json, text/json
Status code | Description | Response headers |
---|---|---|
2XX | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_import_list_exclusion(id)
- 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.ImportListExclusionApi(api_client)
id = 56 # int |
try:
api_instance.delete_import_list_exclusion(id)
except Exception as e:
print("Exception when calling ImportListExclusionApi->delete_import_list_exclusion: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
2XX | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_import_list_exclusion_bulk(import_list_exclusion_bulk_resource=import_list_exclusion_bulk_resource)
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.import_list_exclusion_bulk_resource import ImportListExclusionBulkResource
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.ImportListExclusionApi(api_client)
import_list_exclusion_bulk_resource = sonarr.ImportListExclusionBulkResource() # ImportListExclusionBulkResource | (optional)
try:
api_instance.delete_import_list_exclusion_bulk(import_list_exclusion_bulk_resource=import_list_exclusion_bulk_resource)
except Exception as e:
print("Exception when calling ImportListExclusionApi->delete_import_list_exclusion_bulk: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
import_list_exclusion_bulk_resource | ImportListExclusionBulkResource | [optional] |
void (empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
2XX | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ImportListExclusionResource get_import_list_exclusion_by_id(id)
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.import_list_exclusion_resource import ImportListExclusionResource
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.ImportListExclusionApi(api_client)
id = 56 # int |
try:
api_response = api_instance.get_import_list_exclusion_by_id(id)
print("The response of ImportListExclusionApi->get_import_list_exclusion_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ImportListExclusionApi->get_import_list_exclusion_by_id: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
2XX | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ImportListExclusionResourcePagingResource get_import_list_exclusion_paged(page=page, page_size=page_size, sort_key=sort_key, sort_direction=sort_direction)
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.import_list_exclusion_resource_paging_resource import ImportListExclusionResourcePagingResource
from sonarr.models.sort_direction import SortDirection
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.ImportListExclusionApi(api_client)
page = 1 # int | (optional) (default to 1)
page_size = 10 # int | (optional) (default to 10)
sort_key = 'sort_key_example' # str | (optional)
sort_direction = sonarr.SortDirection() # SortDirection | (optional)
try:
api_response = api_instance.get_import_list_exclusion_paged(page=page, page_size=page_size, sort_key=sort_key, sort_direction=sort_direction)
print("The response of ImportListExclusionApi->get_import_list_exclusion_paged:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ImportListExclusionApi->get_import_list_exclusion_paged: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
page | int | [optional] [default to 1] | |
page_size | int | [optional] [default to 10] | |
sort_key | str | [optional] | |
sort_direction | SortDirection | [optional] |
ImportListExclusionResourcePagingResource
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
2XX | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
List[ImportListExclusionResource] list_import_list_exclusion()
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.import_list_exclusion_resource import ImportListExclusionResource
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.ImportListExclusionApi(api_client)
try:
api_response = api_instance.list_import_list_exclusion()
print("The response of ImportListExclusionApi->list_import_list_exclusion:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ImportListExclusionApi->list_import_list_exclusion: %s\n" % e)
This endpoint does not need any parameter.
List[ImportListExclusionResource]
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
2XX | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ImportListExclusionResource update_import_list_exclusion(id, import_list_exclusion_resource=import_list_exclusion_resource)
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import sonarr
from sonarr.models.import_list_exclusion_resource import ImportListExclusionResource
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.ImportListExclusionApi(api_client)
id = 'id_example' # str |
import_list_exclusion_resource = sonarr.ImportListExclusionResource() # ImportListExclusionResource | (optional)
try:
api_response = api_instance.update_import_list_exclusion(id, import_list_exclusion_resource=import_list_exclusion_resource)
print("The response of ImportListExclusionApi->update_import_list_exclusion:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ImportListExclusionApi->update_import_list_exclusion: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | str | ||
import_list_exclusion_resource | ImportListExclusionResource | [optional] |
- Content-Type: application/json
- Accept: text/plain, application/json, text/json
Status code | Description | Response headers |
---|---|---|
2XX | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]