DAP CLI
Access your organization's Instructure data from the command line.
The Data Access Platform (DAP) CLI is a command-line tool that enables efficient access to large volumes of educational data with high fidelity and low latency. It adheres to a canonical data model and integrates with various educational products.
Built on top of the Query API, DAP CLI allows you to:
Fetch initial snapshots of data.
Track incremental changes.
Initialize and synchronize a supported database with DAP data.
Before using DAP CLI, it is recommended to familiarize yourself with the key concepts of DAP.
Requirements
Supported Operating Systems: Ubuntu 22, Windows 11, Windows Server 2022, macOS 1
Supported Database Integrations: PostgreSQL 16.1+, MySQL 8.2+
Installation
The DAP CLI is available as a Python package in the Python Package Index (PyPI). To install, use the following command:
If you are synchronizing with a database, install the package with the following features:
Learn more details about the installation and setup in the Getting Started guide.
Commands
The basic syntax is:
Refer to Reference section in the sidebar for a list of available commands. Or, run the dap --help command to get this information right in your terminal.
Upgrading DAP CLI
To ensure optimal performance, always use the latest version of DAP CLI. Check your current version and available updates with:
To upgrade to the latest version, run:
Rate Limiting
DAP CLI follows the rate limiting policies of DAP. Be aware of these limits when making requests.
Logging & Debugging
The default log level is info, and messages are printed to the console. To change the log level or save logs to a file, use the following parameters:
Where To Get Help
Last updated