4.7.1.3. Endpoint routers

REST API route definitions.

class axonius_api_client.api.routers.Router(object_type, base, version, **routes)[source]

Bases: object

Simple object store for REST API routes.

Parameters
  • object_type (str) –

  • base (str) –

  • version (int) –

__init__(object_type, base, version, **routes)[source]

Object store for REST API routes.

Parameters
  • object_type (str) – object type for this set of routes

  • base (str) – base path for this set of routes

  • version (int) – api version for this set of routes

  • **routes – routes for this object_type

__str__()[source]

Show object info.

Return type

str

__repr__()[source]

Show object info.

Return type

str

class axonius_api_client.api.routers.ApiV1[source]

Bases: object

Routes provided by the Axonius REST API version 1.

version: int = 1

Version of API.

base: str = 'api/V1'

Base URL of endpoints.

users: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='users', version=1)

Endpoints for axonius_api_client.api.assets.users.Users

devices: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='devices', version=1)

Endpoints for axonius_api_client.api.assets.devices.Devices

actions: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='actions', version=1)

Endpoints for axonius_api_client.api.enforcements.actions

adapters: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='adapters', version=1)

Endpoints for axonius_api_client.api.adapters.adapters

alerts: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='alerts', version=1)

Endpoints for axonius_api_client.api.enforcements.enforcements

system: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='system', version=1)

Endpoints for system APIs

all_objects: List[axonius_api_client.api.routers.Router] = [axonius_api_client.api.routers.Router(object_type='users', version=1), axonius_api_client.api.routers.Router(object_type='devices', version=1), axonius_api_client.api.routers.Router(object_type='actions', version=1), axonius_api_client.api.routers.Router(object_type='adapters', version=1), axonius_api_client.api.routers.Router(object_type='alerts', version=1), axonius_api_client.api.routers.Router(object_type='system', version=1)]

All endpoint objects.

class axonius_api_client.api.routers.ApiV4[source]

Bases: object

Routes provided by the Axonius REST API version 4.0.

version: float = 4.0

Version of API.

base: str = 'api/V4.0'

Base URL of endpoints.

users: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='users', version=4.0)

Endpoints for axonius_api_client.api.assets.users.Users

devices: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='devices', version=4.0)

Endpoints for axonius_api_client.api.assets.devices.Devices

actions: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='actions', version=4.0)

Endpoints for axonius_api_client.api.enforcements.actions

adapters: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='adapters', version=4.0)

Endpoints for axonius_api_client.api.adapters.adapters

alerts: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='enforcements', version=4.0)

Endpoints for axonius_api_client.api.enforcements.enforcements

instances: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='instances', version=4.0)

Endpoints for axonius_api_client.api.system.instances

dashboard: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='dashboard', version=4.0)

Endpoints for axonius_api_client.api.system.dashboard

system: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='settings', version=4.0)

Endpoints for system APIs

signup: axonius_api_client.api.routers.Router = axonius_api_client.api.routers.Router(object_type='signup', version=4.0)

Endpoints for axonius_api_client.api.system.signup

all_objects: List[axonius_api_client.api.routers.Router] = [axonius_api_client.api.routers.Router(object_type='users', version=4.0), axonius_api_client.api.routers.Router(object_type='devices', version=4.0), axonius_api_client.api.routers.Router(object_type='actions', version=4.0), axonius_api_client.api.routers.Router(object_type='adapters', version=4.0), axonius_api_client.api.routers.Router(object_type='enforcements', version=4.0), axonius_api_client.api.routers.Router(object_type='instances', version=4.0), axonius_api_client.api.routers.Router(object_type='dashboard', version=4.0), axonius_api_client.api.routers.Router(object_type='settings', version=4.0), axonius_api_client.api.routers.Router(object_type='signup', version=4.0)]

All endpoint objects.

axonius_api_client.api.routers.API_VERSION

Version of API to use package wide.

alias of axonius_api_client.api.routers.ApiV4