dap env vars

Configure Environment Variables for DAP CLI Authentication

To simplify configuration and improve security, the DAP CLI supports reading authentication and connection settings from environment variables. This is optional but highly recommended for automation and scripting on macOS, Linux, and Windows.

Available Environment Variables

export DAP_API_URL='https://api-gateway.instructure.com'
export DAP_CLIENT_ID='your_canvas_data_client_id'
export DAP_CLIENT_SECRET='your_canvas_data_secret'
export DAP_CONNECTION_STRING='your_database_connection_string'
export DAP_TRACKING='your_tracking_preference'

Variable Descriptions

  • DAP_API_URL (optional) Specifies the API endpoint. If omitted, the CLI uses the default production URL. Useful when working in beta or staging environments.

  • DAP_CLIENT_ID Your client ID from Instructure Identity.

  • DAP_CLIENT_SECRET Your client secret from Instructure Identity.

  • DAP_CONNECTION_STRING (optional) The connection string to your target database. Supported formats:

    postgresql://user:password@host:5432/database
    mysql://user:password@host:3306/database
    mssql://user:password@host:1433/database
  • DAP_TRACKING Controls whether CLI usage tracking is enabled. Tracking is enabled by default. To opt out, use one of the values listed below.

    Valid values for enabling/disabling tracking:

    Enabled Values
    Disabled Values

    true, 1, yes, on

    false, 0, no, off

Last updated

Was this helpful?