Skip to main content

Save and Export addons

Logo

Configure Kexa to save scan results and export data gathering to various storage backends


Report Bug · Request Feature

Overview​

Kexa supports save / exporting of your data. Saving your data will save all scan results, ressources and rules (all Kexa entities) While exporting will just save you cloud ressources current states.

Currently supported addons​

Database Storage​

  • MongoDB - NoSQL document database
  • MySQL - Relational database with automatic schema creation
  • PostgreSQL - Advanced relational database with JSONB support

Cloud Storage​

Premium Platform​

Configuration Structure​

Save Configuration​

Add a "save" attribute to your default.json to store all Kexa entities:

{
  "save": [
    {
      "type": "postgres",
      "urlName": "POSTGRES_CONNECTION_STRING",
      "name": "Production Results",
      "description": "PostgreSQL for scan results",
      "origin": "kexa-production",
      "tags": {
        "environment": "production"
      },
      "onlyErrors": false,
      "logs": true
    }
  ]
}

Export Configuration​

Add an "export" attribute to your default.json to store raw data gathering:

{
  "export": [
    {
      "type": "postgres",
      "urlName": "POSTGRES_EXPORT_CONNECTION",
      "name": "Data Export",
      "description": "Raw infrastructure data",
      "origin": "kexa-datacenter",
      "tags": {
        "purpose": "analytics"
      }
    }
  ]
}

Common Configuration Fields​

SaveConfig Interface​

Based on the Kexa models, each save/export configuration supports:

  • type: Addon name (required)
  • urlName: Environment variable name or direct URL
  • name: Descriptive name (optional)
  • description: Purpose description (optional)
  • origin: Kexa run location identifier (optional)
  • tags: Additional metadata dictionary (optional)

Save-Specific Fields​

  • onlyErrors: Boolean to save only error results
  • logs: Boolean to save execution logs in database

Environment Variables​

Most addons support referencing environment variables for connection details:

{
  "urlName": "DATABASE_CONNECTION_STRING"
}

This will use the value from the DATABASE_CONNECTION_STRING environment variable.

Next Steps​

  1. Choose your storage backend from the available options above
  2. Follow the specific configuration guide for your chosen addon
  3. Set up required environment variables
  4. Test with a simple scan to verify connectivity

For detailed addon-specific configuration, click on the documentation links above.