mage package

Subpackages

• mage.api_resources package
  • Subpackages
    • mage.api_resources.abstract package
      • Submodules
        • mage.api_resources.abstract.data_api_resource module
        • mage.api_resources.abstract.filterable_api_resource module
        • mage.api_resources.abstract.listable_api_resource module
        • mage.api_resources.abstract.mutable_api_resource module
        • mage.api_resources.abstract.util module
      • Module contents
  • Submodules
    • mage.api_resources.assessment module
    • mage.api_resources.assessment_asset_connection module
    • mage.api_resources.assessment_asset_group_connection module
    • mage.api_resources.assessment_run module
    • mage.api_resources.assessment_run_asset_connection module
    • mage.api_resources.assessment_run_credential_connection module
    • mage.api_resources.asset module
    • mage.api_resources.asset_connection module
    • mage.api_resources.asset_group module
    • mage.api_resources.asset_group_connection module
    • mage.api_resources.client module
    • mage.api_resources.cloud_credential module
    • mage.api_resources.credential module
    • mage.api_resources.credential_connection module
    • mage.api_resources.finding module
    • mage.api_resources.invoice module
    • mage.api_resources.lead module
    • mage.api_resources.score module
    • mage.api_resources.ttp module
  • Module contents

Submodules

• mage.query module
• mage.schema module

Module contents

mage.auto_page = False

Iterators should iterate through all data, fetching more from the server as needed

Type

bool

mage.connect(envfile_path=None)

Connects to the MAGE server. The connection details may be passed in as an argument. Additional locations checked for the information include: ~/.env and ./.env

Parameters

envfile_path (str, optional) – Location of file that contains the connection parameters.

Returns

True on success, False on failure

Return type

bool

mage.logger = <Logger mage (INFO)>

The MAGE Logger

Type

logging.Logger