DLH.io API
Use the DLH.io API to run Sync Bridges, create new connectors, and automate common DLH.io tasks from your own tools and pipelines.
DLH.io has a REST API for basic platform tasks, so you can automate them from your own scripts, schedulers, and CI/CD pipelines instead of using the DLH.io web app.
What You Can Do
- Run a Sync Bridge: start a Sync Bridge on demand, for example after an upstream job finishes. See API Sync Bridge Initiation for which connectors support it.
- Create a New Connector: create a new source or target connector from code.
Authentication
Every request must include your API key in the X-DLH-API-KEY header. Treat the key like a password: keep it in a secrets manager or environment variable, and never commit it to source control.
Example Request
Requests send a JSON payload to an API endpoint. The example below shows the request format. Your endpoint URL and the payload fields for each action are provided when API access is enabled for your account.
curl -X POST "https://<your-dlh-api-endpoint>" \
-H "Content-Type: application/json" \
-H "X-DLH-API-KEY: $DLH_API_KEY" \
-d '{
"action": "run_sync_bridge",
"sync_bridge_id": "<your-sync-bridge-id>"
}'Request API Access
API access is enabled per account. To request it, contact us and mention that you are requesting API access.