Query API
Access your organization’s Instructure data using a robust REST API.
The DAP Query API is a robust RESTful API that enables seamless, programmatic access to data within the Data Access Platform (DAP). Designed to handle large-scale data retrieval, it supports secure, flexible interactions with Instructure datasets.
Before using they Query API, it is recommended to familiarize yourself with the key concepts of DAP.
API Endpoint
The Query API can be accessed via the following endpoint:
Conventions
The HTTP method used in an endpoint determines the type of action performed on a resource. Common methods include GET, POST, DELETE, and PATCH. Refer to the REST API reference documentation for details on the HTTP methods for each endpoint.
Rate Limiting
DAP CLI follows the rate limiting policies of DAP. Be mindful of these limits when making requests.
Status Codes
The Query API uses standard HTTP response codes to indicate the success or failure of requests:
Codes in the
2xxrange indicate success.Codes in the
4xxrange indicate incorrect or incomplete parameters (e.g. invalid authentication credentials, non-exist namespace etc.).Codes in the
5xxrange indicate a server-side issue (e.g. gateway timeout error, restricted client access etc.).
Where To Get Help
Last updated