Axonius · OzJacobii · Mar 24, 2025 · Mar 20, 2025
diff --git a/README.md b/README.md
@@ -7,6 +7,11 @@
 [![Documentation Status](https://readthedocs.org/projects/axonius-api-client/badge/?version=latest)](https://axonius-api-client.readthedocs.io/en/latest/?badge=latest)
 [![Downloads](https://pepy.tech/badge/axonius-api-client)](https://pepy.tech/project/axonius-api-client)
 
+### :warning:**This API client is deprecated.**:warning:<br/>
+Axonius API v2 is now available, we recommend you move to API v2.<br/>
+New features will no longer be added to this API. Axonius will only provide bug fixes.<br/>
+[Read about API v2](https://docs.axonius.com/docs/axonius-rest-api)
+### Overview:
 axonius-api-client is an API client for [Axonius](https://axonius.com) that provides:
 
 * A fully modeled python API library that makes using the Axonius REST API easy.
@@ -18,3 +23,5 @@ Resources:
 * [Documentation](https://axonius-api-client.readthedocs.io/)
 * [PyPi package listing](https://pypi.org/project/axonius-api-client/)
 * [GitHub repository](https://github.com/Axonius/axonius_api_client)
+
+
diff --git a/axonius_api_client/version.py b/axonius_api_client/version.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """Version information for this package."""
 
-__version__ = "5.0.20"
+__version__ = "5.0.21"
 VERSION: str = __version__
 """Version of package."""
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,5 @@
 .. include:: /main/.special.rst
+.. include:: /main/deprecation_banner.rst
 
 |MIT license| |made-with-python| |PyPi| |github| |doc-status| |Downloads|
 

diff --git a/docs/main/axtokens.rst b/docs/main/axtokens.rst
@@ -1,4 +1,5 @@
 .. include:: /main/.special.rst
+.. include:: /main/deprecation_banner.rst
 
 .. _axtokens:
 

diff --git a/docs/main/contributing.rst b/docs/main/contributing.rst
@@ -1,4 +1,5 @@
 .. include:: /main/.special.rst
+.. include:: /main/deprecation_banner.rst
 
 Contribution
 ###################################################

diff --git a/docs/main/deprecation_banner.rst b/docs/main/deprecation_banner.rst
@@ -0,0 +1,9 @@
+.. warning:: **This API is deprecated.**
+
+   Axonius API v2 is now available, we recommend you move to API v2.
+
+   New features will no longer be added to this API. Axonius will only provide bug fixes.
+
+   `Read about API v2`_
+
+.. _Read about API v2: https://docs.axonius.com/docs/axonius-rest-api
diff --git a/docs/main/install.rst b/docs/main/install.rst
@@ -1,4 +1,5 @@
 .. include:: /main/.special.rst
+.. include:: /main/deprecation_banner.rst
 
 .. _installation:
 

diff --git a/docs/main/usage_api/api/adapters/adapters.rst b/docs/main/usage_api/api/adapters/adapters.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Adapters
 ###############################################
 

diff --git a/docs/main/usage_api/api/adapters/cnx.rst b/docs/main/usage_api/api/adapters/cnx.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Connections
 ###############################################
 

diff --git a/docs/main/usage_api/api/adapters/index.rst b/docs/main/usage_api/api/adapters/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Adapters and connections
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/callbacks/base.rst b/docs/main/usage_api/api/assets/callbacks/base.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Base
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/callbacks/csv.rst b/docs/main/usage_api/api/assets/callbacks/csv.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 CSV
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/callbacks/index.rst b/docs/main/usage_api/api/assets/callbacks/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Export callbacks
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/callbacks/json.rst b/docs/main/usage_api/api/assets/callbacks/json.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 JSON
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/callbacks/json_to_csv.rst b/docs/main/usage_api/api/assets/callbacks/json_to_csv.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 JSON to CSV
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/callbacks/table.rst b/docs/main/usage_api/api/assets/callbacks/table.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Table
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/callbacks/xlsx.rst b/docs/main/usage_api/api/assets/callbacks/xlsx.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Excel
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/devices.rst b/docs/main/usage_api/api/assets/devices.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Device assets
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/fields.rst b/docs/main/usage_api/api/assets/fields.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Fields
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/index.rst b/docs/main/usage_api/api/assets/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Assets
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/labels.rst b/docs/main/usage_api/api/assets/labels.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Tags
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/saved_query.rst b/docs/main/usage_api/api/assets/saved_query.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Saved queries
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/users.rst b/docs/main/usage_api/api/assets/users.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 User assets
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/wizards/index.rst b/docs/main/usage_api/api/assets/wizards/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Query Wizards
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/wizards/wizard.rst b/docs/main/usage_api/api/assets/wizards/wizard.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 From python objects
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/wizards/wizard_csv.rst b/docs/main/usage_api/api/assets/wizards/wizard_csv.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 From CSV files
 ###############################################
 

diff --git a/docs/main/usage_api/api/assets/wizards/wizard_text.rst b/docs/main/usage_api/api/assets/wizards/wizard_text.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 From text files
 ###############################################
 

diff --git a/docs/main/usage_api/api/enforcements/actions.rst b/docs/main/usage_api/api/enforcements/actions.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Actions
 ###############################################
 

diff --git a/docs/main/usage_api/api/enforcements/enforcements.rst b/docs/main/usage_api/api/enforcements/enforcements.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Enforcements
 ###############################################
 

diff --git a/docs/main/usage_api/api/enforcements/index.rst b/docs/main/usage_api/api/enforcements/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Enforcements and actions
 ###############################################
 

diff --git a/docs/main/usage_api/api/system/dashboard.rst b/docs/main/usage_api/api/system/dashboard.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Dashboards and discovery cycles
 ###############################################
 

diff --git a/docs/main/usage_api/api/system/index.rst b/docs/main/usage_api/api/system/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 System
 ###########################################################
 

diff --git a/docs/main/usage_api/api/system/instances.rst b/docs/main/usage_api/api/system/instances.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Instances
 ###############################################
 

diff --git a/docs/main/usage_api/api/system/meta.rst b/docs/main/usage_api/api/system/meta.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Product metadata
 ###########################################################
 

diff --git a/docs/main/usage_api/api/system/settings_global.rst b/docs/main/usage_api/api/system/settings_global.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 System Settings -> Global Settings
 ###########################################################
 

diff --git a/docs/main/usage_api/api/system/settings_gui.rst b/docs/main/usage_api/api/system/settings_gui.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 System Settings -> GUI Settings
 ###########################################################
 

diff --git a/docs/main/usage_api/api/system/settings_lifecycle.rst b/docs/main/usage_api/api/system/settings_lifecycle.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 System Settings -> Lifecycle Settings
 ###########################################################
 

diff --git a/docs/main/usage_api/api/system/signup.rst b/docs/main/usage_api/api/system/signup.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Initial signup
 ###############################################
 

diff --git a/docs/main/usage_api/api/system/system_roles.rst b/docs/main/usage_api/api/system/system_roles.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 System Roles
 ###########################################################
 

diff --git a/docs/main/usage_api/api/system/system_users.rst b/docs/main/usage_api/api/system/system_users.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 System Users
 ###########################################################
 

diff --git a/docs/main/usage_api/connect.rst b/docs/main/usage_api/connect.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Connection Handler
 ###############################################
 

diff --git a/docs/main/usage_api/library/api/api_mixins.rst b/docs/main/usage_api/library/api/api_mixins.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 API models
 ###############################################
 

diff --git a/docs/main/usage_api/library/api/asset_mixins.rst b/docs/main/usage_api/library/api/asset_mixins.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Asset API models
 ###############################################
 

diff --git a/docs/main/usage_api/library/api/index.rst b/docs/main/usage_api/library/api/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 API library backend
 ###############################################
 

diff --git a/docs/main/usage_api/library/api/routers.rst b/docs/main/usage_api/library/api/routers.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Endpoint routers
 ###############################################
 

diff --git a/docs/main/usage_api/library/api/settings_mixins.rst b/docs/main/usage_api/library/api/settings_mixins.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Settings mixins
 ###########################################################
 

diff --git a/docs/main/usage_api/library/auth/api_key.rst b/docs/main/usage_api/library/auth/api_key.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Authenticating
 ###############################################
 

diff --git a/docs/main/usage_api/library/auth/index.rst b/docs/main/usage_api/library/auth/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Authenticating
 ###############################################
 

diff --git a/docs/main/usage_api/library/auth/models.rst b/docs/main/usage_api/library/auth/models.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Models
 ###############################################
 

diff --git a/docs/main/usage_api/library/constants/adapters.rst b/docs/main/usage_api/library/constants/adapters.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Adapters
 ###############################################
 

diff --git a/docs/main/usage_api/library/constants/api.rst b/docs/main/usage_api/library/constants/api.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 API models
 ###############################################
 

diff --git a/docs/main/usage_api/library/constants/fields.rst b/docs/main/usage_api/library/constants/fields.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Fields
 ###############################################
 

diff --git a/docs/main/usage_api/library/constants/general.rst b/docs/main/usage_api/library/constants/general.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 General
 ###############################################
 

diff --git a/docs/main/usage_api/library/constants/index.rst b/docs/main/usage_api/library/constants/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Constants
 ###############################################
 

diff --git a/docs/main/usage_api/library/constants/logs.rst b/docs/main/usage_api/library/constants/logs.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Logs
 ###############################################
 

diff --git a/docs/main/usage_api/library/constants/system.rst b/docs/main/usage_api/library/constants/system.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 System
 ###############################################
 

diff --git a/docs/main/usage_api/library/constants/wizards.rst b/docs/main/usage_api/library/constants/wizards.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Wizards
 ###############################################
 

diff --git a/docs/main/usage_api/library/index.rst b/docs/main/usage_api/library/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Library backend
 ###############################################
 

diff --git a/docs/main/usage_api/library/parsers/adapters.rst b/docs/main/usage_api/library/parsers/adapters.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Adapter schemas
 ###############################################
 

diff --git a/docs/main/usage_api/library/parsers/config.rst b/docs/main/usage_api/library/parsers/config.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Configuration schemas
 ###############################################
 

diff --git a/docs/main/usage_api/library/parsers/fields.rst b/docs/main/usage_api/library/parsers/fields.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Field schemas
 ###############################################
 

diff --git a/docs/main/usage_api/library/parsers/index.rst b/docs/main/usage_api/library/parsers/index.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 Parsers
 ###############################################
 

diff --git a/docs/main/usage_api/library/parsers/system.rst b/docs/main/usage_api/library/parsers/system.rst
@@ -1,3 +1,5 @@
+.. include:: /main/deprecation_banner.rst
+
 System
 ###############################################