Readarr API docs
This Python package is automatically generated by the OpenAPI Generator project:
- API version: v0.3.18.2411
- Package version: 1.0.1
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 3.7+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/devopsarr/readarr-py.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/devopsarr/readarr-py.git
)
Then import the package:
import readarr
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import readarr
Execute pytest
to run the tests.
Please follow the installation procedure and then run the following:
import readarr
from readarr.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
host = "http://localhost:8787"
)
# 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 readarr.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = readarr.ApiInfoApi(api_client)
try:
api_response = api_instance.get_api()
print("The response of ApiInfoApi->get_api:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ApiInfoApi->get_api: %s\n" % e)
All URIs are relative to http://localhost:8787
Class | Method | HTTP request | Description |
---|---|---|---|
ApiInfoApi | get_api | GET /api | |
AuthenticationApi | create_login | POST /login | |
AuthenticationApi | get_logout | GET /logout | |
AuthorApi | create_author | POST /api/v1/author | |
AuthorApi | delete_author | DELETE /api/v1/author/{id} | |
AuthorApi | get_author_by_id | GET /api/v1/author/{id} | |
AuthorApi | list_author | GET /api/v1/author | |
AuthorApi | update_author | PUT /api/v1/author/{id} | |
AuthorEditorApi | delete_author_editor | DELETE /api/v1/author/editor | |
AuthorEditorApi | put_author_editor | PUT /api/v1/author/editor | |
AuthorLookupApi | get_author_lookup | GET /api/v1/author/lookup | |
BackupApi | create_system_backup_restore_by_id | POST /api/v1/system/backup/restore/{id} | |
BackupApi | create_system_backup_restore_upload | POST /api/v1/system/backup/restore/upload | |
BackupApi | delete_system_backup | DELETE /api/v1/system/backup/{id} | |
BackupApi | list_system_backup | GET /api/v1/system/backup | |
BlocklistApi | delete_blocklist | DELETE /api/v1/blocklist/{id} | |
BlocklistApi | delete_blocklist_bulk | DELETE /api/v1/blocklist/bulk | |
BlocklistApi | get_blocklist | GET /api/v1/blocklist | |
BookApi | create_book | POST /api/v1/book | |
BookApi | delete_book | DELETE /api/v1/book/{id} | |
BookApi | get_book_by_id | GET /api/v1/book/{id} | |
BookApi | get_book_overview | GET /api/v1/book/{id}/overview | |
BookApi | list_book | GET /api/v1/book | |
BookApi | put_book_monitor | PUT /api/v1/book/monitor | |
BookApi | update_book | PUT /api/v1/book/{id} | |
BookEditorApi | delete_book_editor | DELETE /api/v1/book/editor | |
BookEditorApi | put_book_editor | PUT /api/v1/book/editor | |
BookFileApi | delete_book_file | DELETE /api/v1/bookfile/{id} | |
BookFileApi | delete_book_file_bulk | DELETE /api/v1/bookfile/bulk | |
BookFileApi | get_book_file_by_id | GET /api/v1/bookfile/{id} | |
BookFileApi | list_book_file | GET /api/v1/bookfile | |
BookFileApi | put_book_file_editor | PUT /api/v1/bookfile/editor | |
BookFileApi | update_book_file | PUT /api/v1/bookfile/{id} | |
BookLookupApi | get_book_lookup | GET /api/v1/book/lookup | |
BookshelfApi | create_bookshelf | POST /api/v1/bookshelf | |
CalendarApi | get_calendar_by_id | GET /api/v1/calendar/{id} | |
CalendarApi | list_calendar | GET /api/v1/calendar | |
CalendarFeedApi | get_feed_v1_calendar_readarr_ics | GET /feed/v1/calendar/readarr.ics | |
CommandApi | create_command | POST /api/v1/command | |
CommandApi | delete_command | DELETE /api/v1/command/{id} | |
CommandApi | get_command_by_id | GET /api/v1/command/{id} | |
CommandApi | list_command | GET /api/v1/command | |
CustomFilterApi | create_custom_filter | POST /api/v1/customfilter | |
CustomFilterApi | delete_custom_filter | DELETE /api/v1/customfilter/{id} | |
CustomFilterApi | get_custom_filter_by_id | GET /api/v1/customfilter/{id} | |
CustomFilterApi | list_custom_filter | GET /api/v1/customfilter | |
CustomFilterApi | update_custom_filter | PUT /api/v1/customfilter/{id} | |
CustomFormatApi | create_custom_format | POST /api/v1/customformat | |
CustomFormatApi | delete_custom_format | DELETE /api/v1/customformat/{id} | |
CustomFormatApi | get_custom_format_by_id | GET /api/v1/customformat/{id} | |
CustomFormatApi | get_custom_format_schema | GET /api/v1/customformat/schema | |
CustomFormatApi | list_custom_format | GET /api/v1/customformat | |
CustomFormatApi | update_custom_format | PUT /api/v1/customformat/{id} | |
CutoffApi | get_wanted_cutoff | GET /api/v1/wanted/cutoff | |
CutoffApi | get_wanted_cutoff_by_id | GET /api/v1/wanted/cutoff/{id} | |
DelayProfileApi | create_delay_profile | POST /api/v1/delayprofile | |
DelayProfileApi | delete_delay_profile | DELETE /api/v1/delayprofile/{id} | |
DelayProfileApi | get_delay_profile_by_id | GET /api/v1/delayprofile/{id} | |
DelayProfileApi | list_delay_profile | GET /api/v1/delayprofile | |
DelayProfileApi | update_delay_profile | PUT /api/v1/delayprofile/{id} | |
DelayProfileApi | update_delay_profile_reorder | PUT /api/v1/delayprofile/reorder/{id} | |
DevelopmentConfigApi | get_development_config | GET /api/v1/config/development | |
DevelopmentConfigApi | get_development_config_by_id | GET /api/v1/config/development/{id} | |
DevelopmentConfigApi | update_development_config | PUT /api/v1/config/development/{id} | |
DiskSpaceApi | list_disk_space | GET /api/v1/diskspace | |
DownloadClientApi | create_download_client | POST /api/v1/downloadclient | |
DownloadClientApi | create_download_client_action_by_name | POST /api/v1/downloadclient/action/{name} | |
DownloadClientApi | delete_download_client | DELETE /api/v1/downloadclient/{id} | |
DownloadClientApi | delete_download_client_bulk | DELETE /api/v1/downloadclient/bulk | |
DownloadClientApi | get_download_client_by_id | GET /api/v1/downloadclient/{id} | |
DownloadClientApi | list_download_client | GET /api/v1/downloadclient | |
DownloadClientApi | list_download_client_schema | GET /api/v1/downloadclient/schema | |
DownloadClientApi | put_download_client_bulk | PUT /api/v1/downloadclient/bulk | |
DownloadClientApi | test_download_client | POST /api/v1/downloadclient/test | |
DownloadClientApi | testall_download_client | POST /api/v1/downloadclient/testall | |
DownloadClientApi | update_download_client | PUT /api/v1/downloadclient/{id} | |
DownloadClientConfigApi | get_download_client_config | GET /api/v1/config/downloadclient | |
DownloadClientConfigApi | get_download_client_config_by_id | GET /api/v1/config/downloadclient/{id} | |
DownloadClientConfigApi | update_download_client_config | PUT /api/v1/config/downloadclient/{id} | |
EditionApi | list_edition | GET /api/v1/edition | |
FileSystemApi | get_file_system | GET /api/v1/filesystem | |
FileSystemApi | get_file_system_mediafiles | GET /api/v1/filesystem/mediafiles | |
FileSystemApi | get_file_system_type | GET /api/v1/filesystem/type | |
HealthApi | list_health | GET /api/v1/health | |
HistoryApi | create_history_failed_by_id | POST /api/v1/history/failed/{id} | |
HistoryApi | get_history | GET /api/v1/history | |
HistoryApi | list_history_author | GET /api/v1/history/author | |
HistoryApi | list_history_since | GET /api/v1/history/since | |
HostConfigApi | get_host_config | GET /api/v1/config/host | |
HostConfigApi | get_host_config_by_id | GET /api/v1/config/host/{id} | |
HostConfigApi | update_host_config | PUT /api/v1/config/host/{id} | |
ImportListApi | create_import_list | POST /api/v1/importlist | |
ImportListApi | create_import_list_action_by_name | POST /api/v1/importlist/action/{name} | |
ImportListApi | delete_import_list | DELETE /api/v1/importlist/{id} | |
ImportListApi | delete_import_list_bulk | DELETE /api/v1/importlist/bulk | |
ImportListApi | get_import_list_by_id | GET /api/v1/importlist/{id} | |
ImportListApi | list_import_list | GET /api/v1/importlist | |
ImportListApi | list_import_list_schema | GET /api/v1/importlist/schema | |
ImportListApi | put_import_list_bulk | PUT /api/v1/importlist/bulk | |
ImportListApi | test_import_list | POST /api/v1/importlist/test | |
ImportListApi | testall_import_list | POST /api/v1/importlist/testall | |
ImportListApi | update_import_list | PUT /api/v1/importlist/{id} | |
ImportListExclusionApi | create_import_list_exclusion | POST /api/v1/importlistexclusion | |
ImportListExclusionApi | delete_import_list_exclusion | DELETE /api/v1/importlistexclusion/{id} | |
ImportListExclusionApi | get_import_list_exclusion_by_id | GET /api/v1/importlistexclusion/{id} | |
ImportListExclusionApi | list_import_list_exclusion | GET /api/v1/importlistexclusion | |
ImportListExclusionApi | update_import_list_exclusion | PUT /api/v1/importlistexclusion/{id} | |
IndexerApi | create_indexer | POST /api/v1/indexer | |
IndexerApi | create_indexer_action_by_name | POST /api/v1/indexer/action/{name} | |
IndexerApi | delete_indexer | DELETE /api/v1/indexer/{id} | |
IndexerApi | delete_indexer_bulk | DELETE /api/v1/indexer/bulk | |
IndexerApi | get_indexer_by_id | GET /api/v1/indexer/{id} | |
IndexerApi | list_indexer | GET /api/v1/indexer | |
IndexerApi | list_indexer_schema | GET /api/v1/indexer/schema | |
IndexerApi | put_indexer_bulk | PUT /api/v1/indexer/bulk | |
IndexerApi | test_indexer | POST /api/v1/indexer/test | |
IndexerApi | testall_indexer | POST /api/v1/indexer/testall | |
IndexerApi | update_indexer | PUT /api/v1/indexer/{id} | |
IndexerConfigApi | get_indexer_config | GET /api/v1/config/indexer | |
IndexerConfigApi | get_indexer_config_by_id | GET /api/v1/config/indexer/{id} | |
IndexerConfigApi | update_indexer_config | PUT /api/v1/config/indexer/{id} | |
LanguageApi | get_language_by_id | GET /api/v1/language/{id} | |
LanguageApi | list_language | GET /api/v1/language | |
LocalizationApi | get_localization | GET /api/v1/localization | |
LogApi | get_log | GET /api/v1/log | |
LogFileApi | get_log_file_by_filename | GET /api/v1/log/file/{filename} | |
LogFileApi | list_log_file | GET /api/v1/log/file | |
ManualImportApi | create_manual_import | POST /api/v1/manualimport | |
ManualImportApi | list_manual_import | GET /api/v1/manualimport | |
MediaCoverApi | get_media_cover_author_by_filename | GET /api/v1/mediacover/author/{authorId}/{filename} | |
MediaCoverApi | get_media_cover_book_by_filename | GET /api/v1/mediacover/book/{bookId}/{filename} | |
MediaManagementConfigApi | get_media_management_config | GET /api/v1/config/mediamanagement | |
MediaManagementConfigApi | get_media_management_config_by_id | GET /api/v1/config/mediamanagement/{id} | |
MediaManagementConfigApi | update_media_management_config | PUT /api/v1/config/mediamanagement/{id} | |
MetadataApi | create_metadata | POST /api/v1/metadata | |
MetadataApi | create_metadata_action_by_name | POST /api/v1/metadata/action/{name} | |
MetadataApi | delete_metadata | DELETE /api/v1/metadata/{id} | |
MetadataApi | get_metadata_by_id | GET /api/v1/metadata/{id} | |
MetadataApi | list_metadata | GET /api/v1/metadata | |
MetadataApi | list_metadata_schema | GET /api/v1/metadata/schema | |
MetadataApi | test_metadata | POST /api/v1/metadata/test | |
MetadataApi | testall_metadata | POST /api/v1/metadata/testall | |
MetadataApi | update_metadata | PUT /api/v1/metadata/{id} | |
MetadataProfileApi | create_metadata_profile | POST /api/v1/metadataprofile | |
MetadataProfileApi | delete_metadata_profile | DELETE /api/v1/metadataprofile/{id} | |
MetadataProfileApi | get_metadata_profile_by_id | GET /api/v1/metadataprofile/{id} | |
MetadataProfileApi | list_metadata_profile | GET /api/v1/metadataprofile | |
MetadataProfileApi | update_metadata_profile | PUT /api/v1/metadataprofile/{id} | |
MetadataProfileSchemaApi | get_metadataprofile_schema | GET /api/v1/metadataprofile/schema | |
MetadataProviderConfigApi | get_metadata_provider_config | GET /api/v1/config/metadataprovider | |
MetadataProviderConfigApi | get_metadata_provider_config_by_id | GET /api/v1/config/metadataprovider/{id} | |
MetadataProviderConfigApi | update_metadata_provider_config | PUT /api/v1/config/metadataprovider/{id} | |
MissingApi | get_wanted_missing | GET /api/v1/wanted/missing | |
MissingApi | get_wanted_missing_by_id | GET /api/v1/wanted/missing/{id} | |
NamingConfigApi | get_naming_config | GET /api/v1/config/naming | |
NamingConfigApi | get_naming_config_by_id | GET /api/v1/config/naming/{id} | |
NamingConfigApi | get_naming_config_examples | GET /api/v1/config/naming/examples | |
NamingConfigApi | update_naming_config | PUT /api/v1/config/naming/{id} | |
NotificationApi | create_notification | POST /api/v1/notification | |
NotificationApi | create_notification_action_by_name | POST /api/v1/notification/action/{name} | |
NotificationApi | delete_notification | DELETE /api/v1/notification/{id} | |
NotificationApi | get_notification_by_id | GET /api/v1/notification/{id} | |
NotificationApi | list_notification | GET /api/v1/notification | |
NotificationApi | list_notification_schema | GET /api/v1/notification/schema | |
NotificationApi | test_notification | POST /api/v1/notification/test | |
NotificationApi | testall_notification | POST /api/v1/notification/testall | |
NotificationApi | update_notification | PUT /api/v1/notification/{id} | |
ParseApi | get_parse | GET /api/v1/parse | |
PingApi | get_ping | GET /ping | |
QualityDefinitionApi | get_quality_definition_by_id | GET /api/v1/qualitydefinition/{id} | |
QualityDefinitionApi | list_quality_definition | GET /api/v1/qualitydefinition | |
QualityDefinitionApi | put_quality_definition_update | PUT /api/v1/qualitydefinition/update | |
QualityDefinitionApi | update_quality_definition | PUT /api/v1/qualitydefinition/{id} | |
QualityProfileApi | create_quality_profile | POST /api/v1/qualityprofile | |
QualityProfileApi | delete_quality_profile | DELETE /api/v1/qualityprofile/{id} | |
QualityProfileApi | get_quality_profile_by_id | GET /api/v1/qualityprofile/{id} | |
QualityProfileApi | list_quality_profile | GET /api/v1/qualityprofile | |
QualityProfileApi | update_quality_profile | PUT /api/v1/qualityprofile/{id} | |
QualityProfileSchemaApi | get_qualityprofile_schema | GET /api/v1/qualityprofile/schema | |
QueueApi | delete_queue | DELETE /api/v1/queue/{id} | |
QueueApi | delete_queue_bulk | DELETE /api/v1/queue/bulk | |
QueueApi | get_queue | GET /api/v1/queue | |
QueueActionApi | create_queue_grab_bulk | POST /api/v1/queue/grab/bulk | |
QueueActionApi | create_queue_grab_by_id | POST /api/v1/queue/grab/{id} | |
QueueDetailsApi | list_queue_details | GET /api/v1/queue/details | |
QueueStatusApi | get_queue_status | GET /api/v1/queue/status | |
ReleaseApi | create_release | POST /api/v1/release | |
ReleaseApi | list_release | GET /api/v1/release | |
ReleaseProfileApi | create_release_profile | POST /api/v1/releaseprofile | |
ReleaseProfileApi | delete_release_profile | DELETE /api/v1/releaseprofile/{id} | |
ReleaseProfileApi | get_release_profile_by_id | GET /api/v1/releaseprofile/{id} | |
ReleaseProfileApi | list_release_profile | GET /api/v1/releaseprofile | |
ReleaseProfileApi | update_release_profile | PUT /api/v1/releaseprofile/{id} | |
ReleasePushApi | create_release_push | POST /api/v1/release/push | |
RemotePathMappingApi | create_remote_path_mapping | POST /api/v1/remotepathmapping | |
RemotePathMappingApi | delete_remote_path_mapping | DELETE /api/v1/remotepathmapping/{id} | |
RemotePathMappingApi | get_remote_path_mapping_by_id | GET /api/v1/remotepathmapping/{id} | |
RemotePathMappingApi | list_remote_path_mapping | GET /api/v1/remotepathmapping | |
RemotePathMappingApi | update_remote_path_mapping | PUT /api/v1/remotepathmapping/{id} | |
RenameBookApi | list_rename | GET /api/v1/rename | |
RetagBookApi | list_retag | GET /api/v1/retag | |
RootFolderApi | create_root_folder | POST /api/v1/rootfolder | |
RootFolderApi | delete_root_folder | DELETE /api/v1/rootfolder/{id} | |
RootFolderApi | get_root_folder_by_id | GET /api/v1/rootfolder/{id} | |
RootFolderApi | list_root_folder | GET /api/v1/rootfolder | |
RootFolderApi | update_root_folder | PUT /api/v1/rootfolder/{id} | |
SearchApi | get_search | GET /api/v1/search | |
SeriesApi | list_series | GET /api/v1/series | |
StaticResourceApi | get | GET / | |
StaticResourceApi | get_by_path | GET /{path} | |
StaticResourceApi | get_content_by_path | GET /content/{path} | |
StaticResourceApi | get_login | GET /login | |
SystemApi | create_system_restart | POST /api/v1/system/restart | |
SystemApi | create_system_shutdown | POST /api/v1/system/shutdown | |
SystemApi | get_system_routes | GET /api/v1/system/routes | |
SystemApi | get_system_routes_duplicate | GET /api/v1/system/routes/duplicate | |
SystemApi | get_system_status | GET /api/v1/system/status | |
TagApi | create_tag | POST /api/v1/tag | |
TagApi | delete_tag | DELETE /api/v1/tag/{id} | |
TagApi | get_tag_by_id | GET /api/v1/tag/{id} | |
TagApi | list_tag | GET /api/v1/tag | |
TagApi | update_tag | PUT /api/v1/tag/{id} | |
TagDetailsApi | get_tag_detail_by_id | GET /api/v1/tag/detail/{id} | |
TagDetailsApi | list_tag_detail | GET /api/v1/tag/detail | |
TaskApi | get_system_task_by_id | GET /api/v1/system/task/{id} | |
TaskApi | list_system_task | GET /api/v1/system/task | |
UiConfigApi | get_ui_config | GET /api/v1/config/ui | |
UiConfigApi | get_ui_config_by_id | GET /api/v1/config/ui/{id} | |
UiConfigApi | update_ui_config | PUT /api/v1/config/ui/{id} | |
UpdateApi | list_update | GET /api/v1/update | |
UpdateLogFileApi | get_log_file_update_by_filename | GET /api/v1/log/file/update/{filename} | |
UpdateLogFileApi | list_log_file_update | GET /api/v1/log/file/update |
- AddAuthorOptions
- AddBookOptions
- AllowFingerprinting
- ApiInfoResource
- ApplyTags
- AuthenticationType
- Author
- AuthorEditorResource
- AuthorLazyLoaded
- AuthorMetadata
- AuthorMetadataLazyLoaded
- AuthorResource
- AuthorStatisticsResource
- AuthorStatusType
- AuthorTitleInfo
- BackupResource
- BackupType
- BlocklistBulkResource
- BlocklistResource
- BlocklistResourcePagingResource
- Book
- BookAddType
- BookEditorResource
- BookFile
- BookFileListLazyLoaded
- BookFileListResource
- BookFileResource
- BookLazyLoaded
- BookListLazyLoaded
- BookResource
- BookResourcePagingResource
- BookStatisticsResource
- BooksMonitoredResource
- BookshelfAuthorResource
- BookshelfResource
- CertificateValidationType
- Command
- CommandPriority
- CommandResource
- CommandResult
- CommandStatus
- CommandTrigger
- ContractField
- CustomFilterResource
- CustomFormat
- CustomFormatResource
- CustomFormatSpecificationSchema
- DatabaseType
- DelayProfileResource
- DevelopmentConfigResource
- DiskSpaceResource
- DownloadClientBulkResource
- DownloadClientConfigResource
- DownloadClientResource
- DownloadProtocol
- Edition
- EditionLazyLoaded
- EditionListLazyLoaded
- EditionResource
- EntityHistoryEventType
- FileDateType
- HealthCheckResult
- HealthResource
- HistoryResource
- HistoryResourcePagingResource
- HostConfigResource
- ICustomFormatSpecification
- ImportListBulkResource
- ImportListExclusionResource
- ImportListMonitorType
- ImportListResource
- ImportListType
- IndexerBulkResource
- IndexerConfigResource
- IndexerResource
- IsoCountry
- LanguageResource
- Links
- LogFileResource
- LogResource
- LogResourcePagingResource
- ManualImportResource
- ManualImportUpdateResource
- MediaCover
- MediaCoverTypes
- MediaInfoModel
- MediaInfoResource
- MediaManagementConfigResource
- MetadataProfile
- MetadataProfileLazyLoaded
- MetadataProfileResource
- MetadataProviderConfigResource
- MetadataResource
- MonitorTypes
- MonitoringOptions
- NamingConfigResource
- NewItemMonitorTypes
- NotificationResource
- ParseResource
- ParsedBookInfo
- ParsedTrackInfo
- PingResource
- ProfileFormatItem
- ProfileFormatItemResource
- ProperDownloadTypes
- ProviderMessage
- ProviderMessageType
- ProxyType
- Quality
- QualityDefinitionResource
- QualityModel
- QualityProfile
- QualityProfileLazyLoaded
- QualityProfileQualityItem
- QualityProfileQualityItemResource
- QualityProfileResource
- QueueBulkResource
- QueueResource
- QueueResourcePagingResource
- QueueStatusResource
- Ratings
- Rejection
- RejectionType
- ReleaseProfileResource
- ReleaseResource
- RemotePathMappingResource
- RenameBookResource
- RescanAfterRefreshType
- RetagBookResource
- Revision
- RootFolderResource
- RuntimeMode
- SelectOption
- Series
- SeriesBookLink
- SeriesBookLinkListLazyLoaded
- SeriesBookLinkResource
- SeriesLazyLoaded
- SeriesListLazyLoaded
- SeriesResource
- SortDirection
- SystemResource
- TagDetailsResource
- TagDifference
- TagResource
- TaskResource
- TrackedDownloadState
- TrackedDownloadStatus
- TrackedDownloadStatusMessage
- UiConfigResource
- UpdateChanges
- UpdateMechanism
- UpdateResource
- WriteAudioTagsType
- WriteBookTagsType
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: X-Api-Key
- Location: HTTP header
- Type: API key
- API key parameter name: apikey
- Location: URL query string