Skip to content

Sync changes from private repo main branch #313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 7, 2025
Merged

Sync changes from private repo main branch #313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
.. include:: /main/.special.rst
.. include:: /main/deprecation_banner.rst

|MIT license| |made-with-python| |PyPi| |github| |doc-status| |Downloads|

Axonius API Client
##################################################################

.. include:: /main/deprecation_banner.rst

axonius-api-client is an API client for `Axonius`_. You can :doc:`Install it <main/install>` today!
It provides:

Expand Down
3 changes: 2 additions & 1 deletion docs/main/axtokens.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
.. include:: /main/.special.rst
.. include:: /main/deprecation_banner.rst

.. _axtokens:

API Key and Secret
#########################

.. include:: /main/deprecation_banner.rst

The API Key and Secret for an Axonius user is available from the :blue:`My Account` page.

You can get to the :blue:`My Account` page by clicking the gear icon in the left hand
Expand Down
4 changes: 3 additions & 1 deletion docs/main/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
.. include:: /main/.special.rst
.. include:: /main/deprecation_banner.rst

Contribution
###################################################

.. include:: /main/deprecation_banner.rst


We welcome all contributions to `axonius-api-client`.

Support
Expand Down
3 changes: 2 additions & 1 deletion docs/main/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
.. include:: /main/.special.rst
.. include:: /main/deprecation_banner.rst

.. _installation:

Installation
#########################

.. include:: /main/deprecation_banner.rst

Install Python
============================================================

Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/adapters/adapters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Adapters
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.adapters.adapters
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/adapters/cnx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Connections
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.adapters.cnx
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/adapters/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Adapters and connections
###############################################

.. include:: /main/deprecation_banner.rst

.. toctree::
adapters
cnx
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/callbacks/base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Base
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.asset_callbacks.base
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/callbacks/csv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

CSV
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.asset_callbacks.base_csv
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/callbacks/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Export callbacks
###############################################

.. include:: /main/deprecation_banner.rst

.. toctree::
base
csv
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/callbacks/json.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

JSON
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.asset_callbacks.base_json
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/callbacks/json_to_csv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

JSON to CSV
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.asset_callbacks.base_json_to_csv
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/callbacks/table.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Table
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.asset_callbacks.base_table
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/callbacks/xlsx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Excel
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.asset_callbacks.base_xlsx
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/devices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Device assets
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.assets.devices
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/fields.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Fields
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.assets.fields
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Assets
###############################################

.. include:: /main/deprecation_banner.rst

.. toctree::
devices
users
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/labels.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Tags
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.assets.labels
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/saved_query.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Saved queries
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.assets.saved_query
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/users.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

User assets
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.assets.users
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/wizards/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Query Wizards
###############################################

.. include:: /main/deprecation_banner.rst

.. toctree::
wizard
wizard_csv
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/wizards/wizard.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

From python objects
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.wizards.wizard
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/wizards/wizard_csv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

From CSV files
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.wizards.wizard_csv
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/assets/wizards/wizard_text.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

From text files
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.wizards.wizard_text
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/enforcements/actions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Actions
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.enforcements.actions
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/enforcements/enforcements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Enforcements
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.enforcements.enforcements
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/enforcements/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Enforcements and actions
###############################################

.. include:: /main/deprecation_banner.rst

.. toctree::
enforcements
actions
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/system/dashboard.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Dashboards and discovery cycles
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.system.dashboard
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/system/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

System
###########################################################

.. include:: /main/deprecation_banner.rst

.. toctree::
dashboard
instances
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/system/instances.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Instances
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.system.instances
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/system/meta.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Product metadata
###########################################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.system.meta
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/system/settings_global.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

System Settings -> Global Settings
###########################################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.system.settings_global
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/system/settings_gui.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

System Settings -> GUI Settings
###########################################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.system.settings_gui
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/system/settings_lifecycle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

System Settings -> Lifecycle Settings
###########################################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.system.settings_lifecycle
:members:
:show-inheritance:
Expand Down
3 changes: 2 additions & 1 deletion docs/main/usage_api/api/system/signup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. include:: /main/deprecation_banner.rst

Initial signup
###############################################

.. include:: /main/deprecation_banner.rst

.. automodule:: axonius_api_client.api.system.signup
:members:
:show-inheritance:
Expand Down
Loading
Loading