Argus API¶
ArgusAPI is a package that supplies you with automatically generated endpoints for Argus.
It uses Argus’ swagger.json
definition to generate endpoints the first time the module is
loaded, and will re-generate them again if they’re more than a day old, ensuring that the
local functions are up to date with the remote API.
When Argus API has converted the api definition into Python code, the modules will be available
under argus_api.api
, and can be imported like any other Python module — you only need to import
the functions you actually need.
Using Argus API on the command-line¶
Every generated API function registers itself as a plugin, and can be used from the command
line. Type argus_cli --help
to view the available plugins — all API endpoints will be available
here, e.g argus_cli alarms v1 alarm get-alarms
. For more information on each command, use the --help
parameter.
Using Argus API in your scripts¶
By default, all API functions accept some additional arguments apart from their normal API parameters, provided by this package. These are:
Argument | Default | Description |
---|---|---|
json |
True |
Return the JSON as a dict. If this is set to fault, a requests.Response object will be returned |
apiKey |
None |
Explicitly provide an API key to use for authenticating the request. By default, your requests are unauthenticated. You can use a helper from argus_api.helpers.authentication to handle this for you. |
verify |
True |
Set this to False to disable SSL/TLS verification, or provide a path to a TLS/SSL certificate to verify against. Useful when you’re behind a proxy |
authentication |
{} |
Extra authentication headers. You may pass in either a dict of headers to add to the request, or a function that returns a dict of headers. The function will receive the target URL of the request. |
Simply import the functions you want to use, and begin using them, e.g
from argus_api.api.alarms.v1.alarm import get_alarms, search_alarms
from argus_api.helpers import authentication
@authentication.with_authentication(mode="api_key", api_key=os.environ.get("ARGUS_API_KEY))
def your_function(authentication: callable):
"""Do something with the API"""
# Just pass on the authentication variable to your API calls, and
# they'll be authenticated
alarms = get_alarms(authentication=authentication)
pass
Authentication¶
ArgusAPI supports authentication with a variety of methods.
When using the library, you can always pass api_key="YOUR API KEY"
to any function that interacts with
the API, or you can decorate your function with the provided authentication helper
argus_api.helpers.authentication.with_authentication
, and receive a keyword argument authentication
that you can pass to any function you import. This will ensure your API calls are authenticated.
This package provides a couple of different helpers to help you authenticate your requests, abstracting away the need to ask the user for API keys or username / password.
Option 1: Using a decorator¶
The with_authentication
decorator creates a function that helps you generate
valid authentication headers for Argus.
In the case of API key, it will just
return the correct headers with your API key to Argus, while if you use
LDAP / TOTP / Password authentication, it will generate the CSRF token based
on your session key after logging you into Argus. This function is passed to
the decorated method as a keyword argument called authentication
, and can
be passed along to any generated API function.
from argus_api.api.alarms.v1.alarm import get_alarms, search_alarms
from argus_api.helpers import authentication
@authentication.with_authentication(mode="api_key", api_key=os.environ.get("ARGUS_API_KEY))
def your_function(authentication: callable):
"""Do something with the API"""
# Just pass on the authentication variable to your API calls, and
# they'll be authenticated
alarms = get_alarms(authentication=authentication)
pass
Option 2: Provide an API key¶
All API functions accept the apiKey
keyword argument, so passing an API key
to the function will always be supported.
from argus_api.api.alarms.v1.alarm import get_alarms, search_alarms
def your_function():
"""Do something with the API"""
# Just pass on the authentication variable to your API calls, and
# they'll be authenticated
alarms = get_alarms(api_key=os.environ.get("ARGUS_API_KEY))
pass
Option 3: Turn a function into an authenticated function¶
from argus_api.api.alarms.v1.alarm import get_alarms, search_alarms
from argus_api.helpers import authentication
# Wrap the function with_credentials and set the mode to "password"
# Since no username / password are provided, Argus API will ask the user for this.
get_authenticated_alarms = authentication.with_credentials(mode="password")(get_alarms)
# Provide an API key:
search_authenticated_alarms = authentication.with_api_key(api_key=os.enviro.get("ARGUS_API_KEY"))(search_alarms)
def your_function():
"""Do something with the API"""
# Just pass on the authentication variable to your API calls, and
# they'll be authenticated
alarms = get_authenticated_alarms()
search = search_authenticate_alarms(keywords=["This call uses my API key!"])
pass
Subpackages¶
- argus_api.exceptions package
- argus_api.helpers package
- argus_api.parsers package
- argus_api.api: Autogenerated API
- api.alarms.v1 package
- api.assets.v1 package
- api.authentication.v1 package
- Subpackages
- Submodules
- api.authentication.v1.apikey module
- api.authentication.v1.constrain module
- api.authentication.v1.impersonate module
- api.authentication.v1.logout module
- api.authentication.v1.methods module
- api.authentication.v1.session module
- api.authentication.v1.totp module
- Module contents
- api.cases.v1 package
- api.cases.v2 package
- api.currentuser.v1 package
- api.customernetworks.v1 package
- api.customers.v1 package
- api.datastores.v1 package
- api.documents.v1 package
- api.eventfilters.v1 package
- api.events.v1 package
- Subpackages
- Submodules
- api.events.v1.aggregated module
- api.events.v1.nids module
- api.events.v1.payload module
- api.events.v1.pcap module
- Module contents
- api.pdns.v3 package
- api.permissions.v1 package
- api.reports.v1 package
- api.reputation.v1 package
- api.sampledb.v1 package
- api.sensors.v1 package
- api.system.components.code.v1 package
- api.system.components.configuration.v1 package
- api.system.components.runtime.v1 package
- api.system.notification.v1 package
- api.system.services.v1 package
- api.users.v1 package
- api.world.v1 package
- api.alarms.v1.test_helpers package
- api.alarms.v1.test_helpers.alarm package
- api.alarms.v1.test_helpers.category package
- api.alarms.v1.test_helpers.signature package
- api.assets.v1.test_helpers package
- Subpackages
- api.assets.v1.test_helpers.application package
- Submodules
- api.assets.v1.test_helpers.application.add_host_application module
- api.assets.v1.test_helpers.application.delete_host_application module
- api.assets.v1.test_helpers.application.get_host_application module
- api.assets.v1.test_helpers.application.search_host_applications module
- api.assets.v1.test_helpers.application.search_host_applications_simplified module
- api.assets.v1.test_helpers.application.update_host_application module
- Module contents
- api.assets.v1.test_helpers.businessprocess package
- Submodules
- api.assets.v1.test_helpers.businessprocess.add_business_process module
- api.assets.v1.test_helpers.businessprocess.attach_services_to_business_process module
- api.assets.v1.test_helpers.businessprocess.delete_business_process module
- api.assets.v1.test_helpers.businessprocess.detach_services_from_business_process module
- api.assets.v1.test_helpers.businessprocess.get_business_process module
- api.assets.v1.test_helpers.businessprocess.search_business_processes module
- api.assets.v1.test_helpers.businessprocess.search_business_processes_simplified module
- api.assets.v1.test_helpers.businessprocess.update_business_process module
- Module contents
- api.assets.v1.test_helpers.host package
- Submodules
- api.assets.v1.test_helpers.host.add_host_asset module
- api.assets.v1.test_helpers.host.bulk_update_host_asset module
- api.assets.v1.test_helpers.host.delete_host_asset module
- api.assets.v1.test_helpers.host.get_host_asset module
- api.assets.v1.test_helpers.host.search_host_assets module
- api.assets.v1.test_helpers.host.search_host_assets_simplified module
- api.assets.v1.test_helpers.host.update_host_asset module
- Module contents
- api.assets.v1.test_helpers.scan package
- api.assets.v1.test_helpers.service package
- Submodules
- api.assets.v1.test_helpers.service.add_service_asset module
- api.assets.v1.test_helpers.service.attach_hosts_to_service module
- api.assets.v1.test_helpers.service.delete_service_asset module
- api.assets.v1.test_helpers.service.detach_hosts_from_service module
- api.assets.v1.test_helpers.service.get_service_asset module
- api.assets.v1.test_helpers.service.search_service_assets module
- api.assets.v1.test_helpers.service.search_service_assets_simplified module
- api.assets.v1.test_helpers.service.update_service_asset module
- Module contents
- api.assets.v1.test_helpers.vulnerability package
- Submodules
- api.assets.v1.test_helpers.vulnerability.add_asset_vulnerability module
- api.assets.v1.test_helpers.vulnerability.delete_asset_vulnerability module
- api.assets.v1.test_helpers.vulnerability.get_asset_vulnerability module
- api.assets.v1.test_helpers.vulnerability.resolve_asset_vulnerability module
- api.assets.v1.test_helpers.vulnerability.search_asset_vulnerabilities module
- api.assets.v1.test_helpers.vulnerability.search_asset_vulnerabilities_simplified module
- api.assets.v1.test_helpers.vulnerability.update_asset_vulnerability module
- Module contents
- api.assets.v1.test_helpers.application package
- Module contents
- Subpackages
- api.assets.v1.test_helpers.application package
- Submodules
- api.assets.v1.test_helpers.application.add_host_application module
- api.assets.v1.test_helpers.application.delete_host_application module
- api.assets.v1.test_helpers.application.get_host_application module
- api.assets.v1.test_helpers.application.search_host_applications module
- api.assets.v1.test_helpers.application.search_host_applications_simplified module
- api.assets.v1.test_helpers.application.update_host_application module
- Module contents
- api.assets.v1.test_helpers.businessprocess package
- Submodules
- api.assets.v1.test_helpers.businessprocess.add_business_process module
- api.assets.v1.test_helpers.businessprocess.attach_services_to_business_process module
- api.assets.v1.test_helpers.businessprocess.delete_business_process module
- api.assets.v1.test_helpers.businessprocess.detach_services_from_business_process module
- api.assets.v1.test_helpers.businessprocess.get_business_process module
- api.assets.v1.test_helpers.businessprocess.search_business_processes module
- api.assets.v1.test_helpers.businessprocess.search_business_processes_simplified module
- api.assets.v1.test_helpers.businessprocess.update_business_process module
- Module contents
- api.assets.v1.test_helpers.host package
- Submodules
- api.assets.v1.test_helpers.host.add_host_asset module
- api.assets.v1.test_helpers.host.bulk_update_host_asset module
- api.assets.v1.test_helpers.host.delete_host_asset module
- api.assets.v1.test_helpers.host.get_host_asset module
- api.assets.v1.test_helpers.host.search_host_assets module
- api.assets.v1.test_helpers.host.search_host_assets_simplified module
- api.assets.v1.test_helpers.host.update_host_asset module
- Module contents
- api.assets.v1.test_helpers.scan package
- api.assets.v1.test_helpers.service package
- Submodules
- api.assets.v1.test_helpers.service.add_service_asset module
- api.assets.v1.test_helpers.service.attach_hosts_to_service module
- api.assets.v1.test_helpers.service.delete_service_asset module
- api.assets.v1.test_helpers.service.detach_hosts_from_service module
- api.assets.v1.test_helpers.service.get_service_asset module
- api.assets.v1.test_helpers.service.search_service_assets module
- api.assets.v1.test_helpers.service.search_service_assets_simplified module
- api.assets.v1.test_helpers.service.update_service_asset module
- Module contents
- api.assets.v1.test_helpers.vulnerability package
- Submodules
- api.assets.v1.test_helpers.vulnerability.add_asset_vulnerability module
- api.assets.v1.test_helpers.vulnerability.delete_asset_vulnerability module
- api.assets.v1.test_helpers.vulnerability.get_asset_vulnerability module
- api.assets.v1.test_helpers.vulnerability.resolve_asset_vulnerability module
- api.assets.v1.test_helpers.vulnerability.search_asset_vulnerabilities module
- api.assets.v1.test_helpers.vulnerability.search_asset_vulnerabilities_simplified module
- api.assets.v1.test_helpers.vulnerability.update_asset_vulnerability module
- Module contents
- api.authentication.v1.ldap.test_helpers package
- api.authentication.v1.ldap.test_helpers.ldap_authenticate package
- api.authentication.v1.password.test_helpers package
- api.authentication.v1.password.test_helpers.password_authenticate package
- api.authentication.v1.radius.test_helpers package
- api.authentication.v1.radius.test_helpers.radius_authenticate package
- api.authentication.v1.signature.test_helpers package
- api.authentication.v1.sms.test_helpers package
- api.authentication.v1.sms.test_helpers.sms_authenticate package
- api.authentication.v1.test_helpers package
- Subpackages
- api.authentication.v1.test_helpers.apikey package
- Submodules
- api.authentication.v1.test_helpers.apikey.authenticate module
- api.authentication.v1.test_helpers.apikey.initiate module
- api.authentication.v1.test_helpers.apikey.list module
- api.authentication.v1.test_helpers.apikey.renew module
- api.authentication.v1.test_helpers.apikey.revoke module
- Module contents
- api.authentication.v1.test_helpers.constrain package
- api.authentication.v1.test_helpers.logout package
- api.authentication.v1.test_helpers.methods package
- api.authentication.v1.test_helpers.totp package
- api.authentication.v1.test_helpers.apikey package
- Module contents
- Subpackages
- api.authentication.v1.test_helpers.apikey package
- Submodules
- api.authentication.v1.test_helpers.apikey.authenticate module
- api.authentication.v1.test_helpers.apikey.initiate module
- api.authentication.v1.test_helpers.apikey.list module
- api.authentication.v1.test_helpers.apikey.renew module
- api.authentication.v1.test_helpers.apikey.revoke module
- Module contents
- api.authentication.v1.test_helpers.constrain package
- api.authentication.v1.test_helpers.logout package
- api.authentication.v1.test_helpers.methods package
- api.authentication.v1.test_helpers.totp package
- api.authentication.v1.user.test_helpers package
- Subpackages
- api.authentication.v1.user.test_helpers.user_apikey package
- Submodules
- api.authentication.v1.user.test_helpers.user_apikey.disable_method_for_user module
- api.authentication.v1.user.test_helpers.user_apikey.enable_method_for_user module
- api.authentication.v1.user.test_helpers.user_apikey.get_user_methods module
- api.authentication.v1.user.test_helpers.user_apikey.initiate module
- api.authentication.v1.user.test_helpers.user_apikey.list module
- api.authentication.v1.user.test_helpers.user_apikey.renew module
- api.authentication.v1.user.test_helpers.user_apikey.retrieve_s_m_s_token module
- api.authentication.v1.user.test_helpers.user_apikey.revoke module
- Module contents
- api.authentication.v1.user.test_helpers.user_apikey package
- Module contents
- Subpackages
- api.authentication.v1.user.test_helpers.user_apikey package
- Submodules
- api.authentication.v1.user.test_helpers.user_apikey.disable_method_for_user module
- api.authentication.v1.user.test_helpers.user_apikey.enable_method_for_user module
- api.authentication.v1.user.test_helpers.user_apikey.get_user_methods module
- api.authentication.v1.user.test_helpers.user_apikey.initiate module
- api.authentication.v1.user.test_helpers.user_apikey.list module
- api.authentication.v1.user.test_helpers.user_apikey.renew module
- api.authentication.v1.user.test_helpers.user_apikey.retrieve_s_m_s_token module
- api.authentication.v1.user.test_helpers.user_apikey.revoke module
- Module contents
- api.cases.v1.test_helpers package
- api.cases.v2.test_helpers package
- Subpackages
- api.cases.v2.test_helpers.case package
- Submodules
- api.cases.v2.test_helpers.case.acknowledge_workflow module
- api.cases.v2.test_helpers.case.add_attachment module
- api.cases.v2.test_helpers.case.add_case_link module
- api.cases.v2.test_helpers.case.add_case_tag module
- api.cases.v2.test_helpers.case.add_case_watcher module
- api.cases.v2.test_helpers.case.add_comment module
- api.cases.v2.test_helpers.case.advanced_case_search module
- api.cases.v2.test_helpers.case.change_access_settings module
- api.cases.v2.test_helpers.case.close_case module
- api.cases.v2.test_helpers.case.create_case module
- api.cases.v2.test_helpers.case.current_user_watcher_status module
- api.cases.v2.test_helpers.case.delete_attachment module
- api.cases.v2.test_helpers.case.delete_case module
- api.cases.v2.test_helpers.case.delete_case_link module
- api.cases.v2.test_helpers.case.delete_comment module
- api.cases.v2.test_helpers.case.download_attachment module
- api.cases.v2.test_helpers.case.edit_comment module
- api.cases.v2.test_helpers.case.get_attachment module
- api.cases.v2.test_helpers.case.get_case_comment module
- api.cases.v2.test_helpers.case.get_case_metadata_by_id module
- api.cases.v2.test_helpers.case.grant_access module
- api.cases.v2.test_helpers.case.list_case_a_c_l module
- api.cases.v2.test_helpers.case.list_case_attachments module
- api.cases.v2.test_helpers.case.list_case_comments module
- api.cases.v2.test_helpers.case.list_case_links module
- api.cases.v2.test_helpers.case.list_case_tags module
- api.cases.v2.test_helpers.case.list_case_watchers module
- api.cases.v2.test_helpers.case.list_workflows module
- api.cases.v2.test_helpers.case.merge_cases module
- api.cases.v2.test_helpers.case.move_case module
- api.cases.v2.test_helpers.case.publish_case module
- api.cases.v2.test_helpers.case.remove_access module
- api.cases.v2.test_helpers.case.remove_case_contact_watcher module
- api.cases.v2.test_helpers.case.remove_case_tag_by_id module
- api.cases.v2.test_helpers.case.remove_case_tag_by_key_value module
- api.cases.v2.test_helpers.case.remove_case_watcher module
- api.cases.v2.test_helpers.case.remove_current_user_watcher module
- api.cases.v2.test_helpers.case.request_workflow module
- api.cases.v2.test_helpers.case.search_case_statistics module
- api.cases.v2.test_helpers.case.simple_case_search module
- api.cases.v2.test_helpers.case.update_case module
- api.cases.v2.test_helpers.case.update_case_watcher module
- api.cases.v2.test_helpers.case.update_watcher_settings module
- Module contents
- api.cases.v2.test_helpers.case package
- Module contents
- Subpackages
- api.cases.v2.test_helpers.case package
- Submodules
- api.cases.v2.test_helpers.case.acknowledge_workflow module
- api.cases.v2.test_helpers.case.add_attachment module
- api.cases.v2.test_helpers.case.add_case_link module
- api.cases.v2.test_helpers.case.add_case_tag module
- api.cases.v2.test_helpers.case.add_case_watcher module
- api.cases.v2.test_helpers.case.add_comment module
- api.cases.v2.test_helpers.case.advanced_case_search module
- api.cases.v2.test_helpers.case.change_access_settings module
- api.cases.v2.test_helpers.case.close_case module
- api.cases.v2.test_helpers.case.create_case module
- api.cases.v2.test_helpers.case.current_user_watcher_status module
- api.cases.v2.test_helpers.case.delete_attachment module
- api.cases.v2.test_helpers.case.delete_case module
- api.cases.v2.test_helpers.case.delete_case_link module
- api.cases.v2.test_helpers.case.delete_comment module
- api.cases.v2.test_helpers.case.download_attachment module
- api.cases.v2.test_helpers.case.edit_comment module
- api.cases.v2.test_helpers.case.get_attachment module
- api.cases.v2.test_helpers.case.get_case_comment module
- api.cases.v2.test_helpers.case.get_case_metadata_by_id module
- api.cases.v2.test_helpers.case.grant_access module
- api.cases.v2.test_helpers.case.list_case_a_c_l module
- api.cases.v2.test_helpers.case.list_case_attachments module
- api.cases.v2.test_helpers.case.list_case_comments module
- api.cases.v2.test_helpers.case.list_case_links module
- api.cases.v2.test_helpers.case.list_case_tags module
- api.cases.v2.test_helpers.case.list_case_watchers module
- api.cases.v2.test_helpers.case.list_workflows module
- api.cases.v2.test_helpers.case.merge_cases module
- api.cases.v2.test_helpers.case.move_case module
- api.cases.v2.test_helpers.case.publish_case module
- api.cases.v2.test_helpers.case.remove_access module
- api.cases.v2.test_helpers.case.remove_case_contact_watcher module
- api.cases.v2.test_helpers.case.remove_case_tag_by_id module
- api.cases.v2.test_helpers.case.remove_case_tag_by_key_value module
- api.cases.v2.test_helpers.case.remove_case_watcher module
- api.cases.v2.test_helpers.case.remove_current_user_watcher module
- api.cases.v2.test_helpers.case.request_workflow module
- api.cases.v2.test_helpers.case.search_case_statistics module
- api.cases.v2.test_helpers.case.simple_case_search module
- api.cases.v2.test_helpers.case.update_case module
- api.cases.v2.test_helpers.case.update_case_watcher module
- api.cases.v2.test_helpers.case.update_watcher_settings module
- Module contents
- api.currentuser.v1.permission.test_helpers package
- api.currentuser.v1.permission.test_helpers.permission package
- api.currentuser.v1.test_helpers package
- Subpackages
- api.currentuser.v1.test_helpers.authmethods package
- api.currentuser.v1.test_helpers.functions package
- api.currentuser.v1.test_helpers.picture package
- api.currentuser.v1.test_helpers.prefs package
- Submodules
- api.currentuser.v1.test_helpers.prefs.delete_properties module
- api.currentuser.v1.test_helpers.prefs.delete_property module
- api.currentuser.v1.test_helpers.prefs.get_property module
- api.currentuser.v1.test_helpers.prefs.list_properties module
- api.currentuser.v1.test_helpers.prefs.set_properties module
- Module contents
- api.currentuser.v1.test_helpers.user package
- Module contents
- Subpackages
- api.currentuser.v1.test_helpers.authmethods package
- api.currentuser.v1.test_helpers.functions package
- api.currentuser.v1.test_helpers.picture package
- api.currentuser.v1.test_helpers.prefs package
- Submodules
- api.currentuser.v1.test_helpers.prefs.delete_properties module
- api.currentuser.v1.test_helpers.prefs.delete_property module
- api.currentuser.v1.test_helpers.prefs.get_property module
- api.currentuser.v1.test_helpers.prefs.list_properties module
- api.currentuser.v1.test_helpers.prefs.set_properties module
- Module contents
- api.currentuser.v1.test_helpers.user package
- api.customernetworks.v1.test_helpers package
- Subpackages
- api.customernetworks.v1.test_helpers.network package
- Submodules
- api.customernetworks.v1.test_helpers.network.add_customer_network module
- api.customernetworks.v1.test_helpers.network.add_customer_network_comment module
- api.customernetworks.v1.test_helpers.network.delete_customer_network module
- api.customernetworks.v1.test_helpers.network.delete_customer_network_comment module
- api.customernetworks.v1.test_helpers.network.get_customer_network module
- api.customernetworks.v1.test_helpers.network.get_customer_network_comments module
- api.customernetworks.v1.test_helpers.network.get_customer_networks module
- api.customernetworks.v1.test_helpers.network.search_customer_network module
- api.customernetworks.v1.test_helpers.network.update_customer_network module
- Module contents
- api.customernetworks.v1.test_helpers.network package
- Module contents
- Subpackages
- api.customernetworks.v1.test_helpers.network package
- Submodules
- api.customernetworks.v1.test_helpers.network.add_customer_network module
- api.customernetworks.v1.test_helpers.network.add_customer_network_comment module
- api.customernetworks.v1.test_helpers.network.delete_customer_network module
- api.customernetworks.v1.test_helpers.network.delete_customer_network_comment module
- api.customernetworks.v1.test_helpers.network.get_customer_network module
- api.customernetworks.v1.test_helpers.network.get_customer_network_comments module
- api.customernetworks.v1.test_helpers.network.get_customer_networks module
- api.customernetworks.v1.test_helpers.network.search_customer_network module
- api.customernetworks.v1.test_helpers.network.update_customer_network module
- Module contents
- api.customers.v1.test_helpers package
- Subpackages
- api.customers.v1.test_helpers.customer package
- Submodules
- api.customers.v1.test_helpers.customer.add_customer module
- api.customers.v1.test_helpers.customer.add_customer_service module
- api.customers.v1.test_helpers.customer.disable_customer module
- api.customers.v1.test_helpers.customer.get_customer_by_id module
- api.customers.v1.test_helpers.customer.get_customer_by_shortname module
- api.customers.v1.test_helpers.customer.get_customer_logo_by_id module
- api.customers.v1.test_helpers.customer.get_customer_logo_by_shortname module
- api.customers.v1.test_helpers.customer.list_customers module
- api.customers.v1.test_helpers.customer.remove_customer_service module
- api.customers.v1.test_helpers.customer.search_customers module
- api.customers.v1.test_helpers.customer.update_customer module
- Module contents
- api.customers.v1.test_helpers.customer package
- Module contents
- Subpackages
- api.customers.v1.test_helpers.customer package
- Submodules
- api.customers.v1.test_helpers.customer.add_customer module
- api.customers.v1.test_helpers.customer.add_customer_service module
- api.customers.v1.test_helpers.customer.disable_customer module
- api.customers.v1.test_helpers.customer.get_customer_by_id module
- api.customers.v1.test_helpers.customer.get_customer_by_shortname module
- api.customers.v1.test_helpers.customer.get_customer_logo_by_id module
- api.customers.v1.test_helpers.customer.get_customer_logo_by_shortname module
- api.customers.v1.test_helpers.customer.list_customers module
- api.customers.v1.test_helpers.customer.remove_customer_service module
- api.customers.v1.test_helpers.customer.search_customers module
- api.customers.v1.test_helpers.customer.update_customer module
- Module contents
- api.datastores.v1.store.test_helpers package
- Subpackages
- api.datastores.v1.store.test_helpers.store package
- Submodules
- api.datastores.v1.store.test_helpers.store.delete_data_store_entries module
- api.datastores.v1.store.test_helpers.store.get_entries_from_store module
- api.datastores.v1.store.test_helpers.store.get_entries_from_store_simplified module
- api.datastores.v1.store.test_helpers.store.get_single_entry module
- api.datastores.v1.store.test_helpers.store.put_data_store_entries module
- api.datastores.v1.store.test_helpers.store.put_single_data_store_entry module
- Module contents
- api.datastores.v1.store.test_helpers.store package
- Module contents
- Subpackages
- api.datastores.v1.store.test_helpers.store package
- Submodules
- api.datastores.v1.store.test_helpers.store.delete_data_store_entries module
- api.datastores.v1.store.test_helpers.store.get_entries_from_store module
- api.datastores.v1.store.test_helpers.store.get_entries_from_store_simplified module
- api.datastores.v1.store.test_helpers.store.get_single_entry module
- api.datastores.v1.store.test_helpers.store.put_data_store_entries module
- api.datastores.v1.store.test_helpers.store.put_single_data_store_entry module
- Module contents
- api.datastores.v1.test_helpers package
- Subpackages
- api.datastores.v1.test_helpers.descriptor package
- Submodules
- api.datastores.v1.test_helpers.descriptor.add_data_store_descriptor module
- api.datastores.v1.test_helpers.descriptor.delete_data_store_descriptor module
- api.datastores.v1.test_helpers.descriptor.get_descriptor module
- api.datastores.v1.test_helpers.descriptor.search_descriptors module
- api.datastores.v1.test_helpers.descriptor.search_descriptors_simple module
- api.datastores.v1.test_helpers.descriptor.update_data_store_descriptor module
- Module contents
- api.datastores.v1.test_helpers.descriptor package
- Module contents
- Subpackages
- api.datastores.v1.test_helpers.descriptor package
- Submodules
- api.datastores.v1.test_helpers.descriptor.add_data_store_descriptor module
- api.datastores.v1.test_helpers.descriptor.delete_data_store_descriptor module
- api.datastores.v1.test_helpers.descriptor.get_descriptor module
- api.datastores.v1.test_helpers.descriptor.search_descriptors module
- api.datastores.v1.test_helpers.descriptor.search_descriptors_simple module
- api.datastores.v1.test_helpers.descriptor.update_data_store_descriptor module
- Module contents
- api.documents.v1.customer.test_helpers package
- api.documents.v1.customer.test_helpers.customer package
- api.documents.v1.document.test_helpers package
- Subpackages
- api.documents.v1.document.test_helpers.document package
- Submodules
- api.documents.v1.document.test_helpers.document.commit_document module
- api.documents.v1.document.test_helpers.document.get_document_content_by_id module
- api.documents.v1.document.test_helpers.document.get_document_revisions module
- api.documents.v1.document.test_helpers.document.get_meta_info_by_id module
- api.documents.v1.document.test_helpers.document.grant_document_access module
- api.documents.v1.document.test_helpers.document.list_document_access module
- api.documents.v1.document.test_helpers.document.lock_document module
- api.documents.v1.document.test_helpers.document.revoke_document_access module
- api.documents.v1.document.test_helpers.document.update_document module
- api.documents.v1.document.test_helpers.document.update_document_access_settings module
- Module contents
- api.documents.v1.document.test_helpers.document package
- Module contents
- Subpackages
- api.documents.v1.document.test_helpers.document package
- Submodules
- api.documents.v1.document.test_helpers.document.commit_document module
- api.documents.v1.document.test_helpers.document.get_document_content_by_id module
- api.documents.v1.document.test_helpers.document.get_document_revisions module
- api.documents.v1.document.test_helpers.document.get_meta_info_by_id module
- api.documents.v1.document.test_helpers.document.grant_document_access module
- api.documents.v1.document.test_helpers.document.list_document_access module
- api.documents.v1.document.test_helpers.document.lock_document module
- api.documents.v1.document.test_helpers.document.revoke_document_access module
- api.documents.v1.document.test_helpers.document.update_document module
- api.documents.v1.document.test_helpers.document.update_document_access_settings module
- Module contents
- api.documents.v1.folder.test_helpers package
- Subpackages
- api.documents.v1.folder.test_helpers.folder_root package
- Submodules
- api.documents.v1.folder.test_helpers.folder_root.add_document module
- api.documents.v1.folder.test_helpers.folder_root.add_folder module
- api.documents.v1.folder.test_helpers.folder_root.browse_folder module
- api.documents.v1.folder.test_helpers.folder_root.delete_folder module
- api.documents.v1.folder.test_helpers.folder_root.get_current_user_root_folder module
- api.documents.v1.folder.test_helpers.folder_root.get_folder_meta_info_by_id module
- api.documents.v1.folder.test_helpers.folder_root.grant_folder_access module
- api.documents.v1.folder.test_helpers.folder_root.list_folder_access module
- api.documents.v1.folder.test_helpers.folder_root.revoke_folder_access module
- api.documents.v1.folder.test_helpers.folder_root.update_document_access_settings module
- api.documents.v1.folder.test_helpers.folder_root.update_folder module
- Module contents
- api.documents.v1.folder.test_helpers.folder_root package
- Module contents
- Subpackages
- api.documents.v1.folder.test_helpers.folder_root package
- Submodules
- api.documents.v1.folder.test_helpers.folder_root.add_document module
- api.documents.v1.folder.test_helpers.folder_root.add_folder module
- api.documents.v1.folder.test_helpers.folder_root.browse_folder module
- api.documents.v1.folder.test_helpers.folder_root.delete_folder module
- api.documents.v1.folder.test_helpers.folder_root.get_current_user_root_folder module
- api.documents.v1.folder.test_helpers.folder_root.get_folder_meta_info_by_id module
- api.documents.v1.folder.test_helpers.folder_root.grant_folder_access module
- api.documents.v1.folder.test_helpers.folder_root.list_folder_access module
- api.documents.v1.folder.test_helpers.folder_root.revoke_folder_access module
- api.documents.v1.folder.test_helpers.folder_root.update_document_access_settings module
- api.documents.v1.folder.test_helpers.folder_root.update_folder module
- Module contents
- api.eventfilters.v1.test_helpers package
- api.events.v1.test_helpers package
- api.events.v1.test_helpers.aggregated package
- api.events.v1.test_helpers.nids package
- api.events.v1.test_helpers.payload package
- api.events.v1.test_helpers.pcap package
- api.pdns.v3.test_helpers package
- api.pdns.v3.test_helpers.search package
- api.permissions.v1.function.test_helpers package
- api.reports.v1.test_helpers package
- api.reputation.v1.calculated.test_helpers package
- api.reputation.v1.override.test_helpers package
- api.reputation.v1.test_helpers package
- api.sampledb.v1.submission.test_helpers package
- api.sampledb.v1.test_helpers package
- api.sensors.v1.test_helpers package
- api.sensors.v1.test_helpers.sensor package
- api.sensors.v1.test_helpers.status package
- api.system.components.code.v1.test_helpers package
- api.system.components.configuration.v1.test_helpers package
- api.system.components.runtime.v1.host.cachedconfigurations.test_helpers package
- api.system.components.runtime.v1.instance.test_helpers package
- api.system.components.runtime.v1.property.test_helpers package
- api.system.components.runtime.v1.test_helpers package
- api.system.notification.v1.test_helpers package
- api.system.services.v1.test_helpers package
- api.users.v1.test_helpers package
- Subpackages
- api.users.v1.test_helpers.group package
- api.users.v1.test_helpers.subject package
- api.users.v1.test_helpers.user package
- Submodules
- api.users.v1.test_helpers.user.check_permission module
- api.users.v1.test_helpers.user.find_users module
- api.users.v1.test_helpers.user.get_functions module
- api.users.v1.test_helpers.user.get_profile module
- api.users.v1.test_helpers.user.get_user_by_username module
- api.users.v1.test_helpers.user.list_users module
- api.users.v1.test_helpers.user.update_profile_picture_for_user module
- Module contents
- Module contents
- Subpackages
- api.users.v1.test_helpers.group package
- api.users.v1.test_helpers.subject package
- api.users.v1.test_helpers.user package
- Submodules
- api.users.v1.test_helpers.user.check_permission module
- api.users.v1.test_helpers.user.find_users module
- api.users.v1.test_helpers.user.get_functions module
- api.users.v1.test_helpers.user.get_profile module
- api.users.v1.test_helpers.user.get_user_by_username module
- api.users.v1.test_helpers.user.list_users module
- api.users.v1.test_helpers.user.update_profile_picture_for_user module
- Module contents
- api.world.v1.test_helpers package
- api.world.v1.test_helpers.timezone package
- Module contents
argus_api.argus module¶
Provides the wrapper class for Argus API
-
argus_api.argus.
load
(swagger_files: list = ['/swagger.json'], parser: module = None, **kwargs) → module[source]¶ Initializes the ArgusAPI, so that when called, the static API files will be generated to disk if they dont already exist, and the module then returned to the user. If the api module already exists, return the loaded module.
Return type: module
Parameters: - base_url – Base URL to fetch the schema
- parser (
module
) – Optional custom parser module for parsing the schema before writing to disk
argus_api.schema module¶
Module contents¶
-
argus_api.
ArgusAPI
(swagger_files: list = ['/swagger.json'], parser: module = None, **kwargs) → module¶ Initializes the ArgusAPI, so that when called, the static API files will be generated to disk if they dont already exist, and the module then returned to the user. If the api module already exists, return the loaded module.
Return type: module
Parameters: - base_url – Base URL to fetch the schema
- parser (
module
) – Optional custom parser module for parsing the schema before writing to disk
itance: