Skip to content

ALTR Commands

Comprehensive ALTR data security platform commands and workflows for data governance and protection.

Platform Authentication

CommandDescription
altr auth loginLogin to ALTR platform
altr auth logoutLogout from platform
altr auth statusCheck authentication status
altr auth tokenManage API tokens
export ALTR_API_KEY=<key>Set environment API key
export ALTR_ENDPOINT=<url>Set platform endpoint

Data Source Management

CommandDescription
altr datasource listList all data sources
altr datasource add --type snowflakeAdd Snowflake data source
altr datasource add --type redshiftAdd Redshift data source
altr datasource add --type bigqueryAdd BigQuery data source
altr datasource test <source-id>Test data source connection
altr datasource remove <source-id>Remove data source

Data Classification

CommandDescription
altr classify scan --source <source-id>Scan data source for classification
altr classify rules listList classification rules
altr classify rules createCreate classification rule
altr classify results --source <source-id>View classification results
altr classify export --format jsonExport classification data

Data Masking and Tokenization

CommandDescription
altr mask create --table <table> --column <column>Create masking policy
altr mask listList masking policies
altr mask apply --policy <policy-id>Apply masking policy
altr mask test --policy <policy-id>Test masking policy
altr tokenize --table <table> --column <column>Create tokenization policy

Access Control

CommandDescription
altr access policies listList access policies
altr access policies createCreate access policy
altr access grant --user <user> --resource <resource>Grant access
altr access revoke --user <user> --resource <resource>Revoke access
altr access audit --user <user>Audit user access

Monitoring and Alerting

CommandDescription
altr monitor start --source <source-id>Start monitoring data source
altr monitor stop --source <source-id>Stop monitoring
altr monitor statusCheck monitoring status
altr alerts listList active alerts
altr alerts configure --type <type>Configure alert rules

Compliance Management

CommandDescription
altr compliance scan --framework gdprScan for GDPR compliance
altr compliance scan --framework ccpaScan for CCPA compliance
altr compliance scan --framework hipaaScan for HIPAA compliance
altr compliance report --framework <framework>Generate compliance report
altr compliance statusCheck overall compliance status

Data Discovery

CommandDescription
altr discover scan --source <source-id>Discover sensitive data
altr discover results --source <source-id>View discovery results
altr discover export --format csvExport discovery results
altr discover schedule --source <source-id>Schedule discovery scans

Risk Assessment

CommandDescription
altr risk assess --source <source-id>Assess data risk
altr risk score --table <table>Get risk score for table
altr risk trendsView risk trends
altr risk reportGenerate risk assessment report

Data Lineage

CommandDescription
altr lineage trace --table <table>Trace data lineage
altr lineage map --source <source-id>Generate lineage map
altr lineage export --format jsonExport lineage data
altr lineage visualize --table <table>Visualize data lineage

Policy Management

CommandDescription
altr policy listList all policies
altr policy create --type <type>Create new policy
altr policy update <policy-id>Update existing policy
altr policy delete <policy-id>Delete policy
altr policy validate <policy-id>Validate policy

User and Role Management

CommandDescription
altr users listList all users
altr users create --email <email>Create new user
altr users update <user-id>Update user information
altr users delete <user-id>Delete user
altr roles assign --user <user-id> --role <role>Assign role to user

Audit and Logging

CommandDescription
altr audit logs --source <source-id>View audit logs
altr audit export --start-date <date>Export audit logs
altr audit search --query <query>Search audit logs
altr audit retention --days <days>Set log retention period

Integration Management

CommandDescription
altr integrations listList available integrations
altr integrations add --type siemAdd SIEM integration
altr integrations configure <integration-id>Configure integration
altr integrations test <integration-id>Test integration
altr integrations remove <integration-id>Remove integration

Data Encryption

CommandDescription
altr encrypt enable --table <table>Enable encryption for table
altr encrypt disable --table <table>Disable encryption
altr encrypt keys listList encryption keys
altr encrypt keys rotate <key-id>Rotate encryption key
altr encrypt status --table <table>Check encryption status

Backup and Recovery

CommandDescription
altr backup create --source <source-id>Create data backup
altr backup listList available backups
altr backup restore <backup-id>Restore from backup
altr backup schedule --source <source-id>Schedule automatic backups
altr backup verify <backup-id>Verify backup integrity

Performance Monitoring

CommandDescription
altr performance metricsView performance metrics
altr performance optimize --source <source-id>Optimize performance
altr performance alertsConfigure performance alerts
altr performance reportGenerate performance report

Configuration Management

CommandDescription
altr config showShow current configuration
altr config set <key> <value>Set configuration value
altr config resetReset to default configuration
altr config exportExport configuration
altr config import --file <file>Import configuration

API Management

CommandDescription
curl -H "Authorization: Bearer <token>" <endpoint>API authentication
GET /api/v1/datasourcesList data sources via API
POST /api/v1/policiesCreate policy via API
GET /api/v1/compliance/statusGet compliance status via API
GET /api/v1/audit/logsGet audit logs via API

Snowflake Integration

CommandDescription
altr snowflake connect --account <account>Connect to Snowflake
altr snowflake sync --database <database>Sync Snowflake database
altr snowflake policies applyApply policies to Snowflake
altr snowflake monitor enableEnable Snowflake monitoring

AWS Integration

CommandDescription
altr aws connect --region <region>Connect to AWS
altr aws s3 scan --bucket <bucket>Scan S3 bucket
altr aws rds connect --instance <instance>Connect to RDS
altr aws redshift connect --cluster <cluster>Connect to Redshift

Google Cloud Integration

CommandDescription
altr gcp connect --project <project>Connect to GCP
altr gcp bigquery scan --dataset <dataset>Scan BigQuery dataset
altr gcp storage scan --bucket <bucket>Scan Cloud Storage

Microsoft Azure Integration

CommandDescription
altr azure connect --subscription <subscription>Connect to Azure
altr azure sql scan --server <server>Scan Azure SQL
altr azure storage scan --account <account>Scan Azure Storage

Reporting and Analytics

CommandDescription
altr reports generate --type complianceGenerate compliance report
altr reports generate --type riskGenerate risk report
altr reports schedule --type <type>Schedule report generation
altr reports export --format pdfExport report as PDF
altr analytics dashboardOpen analytics dashboard

Automation and Workflows

CommandDescription
altr workflows listList automation workflows
altr workflows create --name <name>Create new workflow
altr workflows run <workflow-id>Run workflow
altr workflows schedule <workflow-id>Schedule workflow
altr workflows logs <workflow-id>View workflow logs

Environment Variables

VariableDescription
ALTR_API_KEYAPI authentication key
ALTR_ENDPOINTPlatform endpoint URL
ALTR_TIMEOUTRequest timeout
ALTR_LOG_LEVELLogging level
ALTR_CONFIG_FILEConfiguration file path

Configuration Files

FileDescription
altr.config.jsonMain configuration file
altr-policies.ymlPolicy definitions
altr-datasources.ymlData source configurations
.altr-credentialsStored credentials

Troubleshooting

CommandDescription
altr debug --log-level debugEnable debug logging
altr debug connectivityTest connectivity
altr debug permissionsCheck permissions
altr debug validateValidate configuration
altr support logsGenerate support logs