API reference
The Deep Blue Links REST API: create, update and resolve your app’s links from its servers and mobile apps with its API key.
Base URL
Every endpoint is relative to https://dev.thedbl.ink, over HTTPS.
Authentication
Send your app’s API key in the Api-Key header. The key stands for one app: it creates links in that app and opens only that app’s links. You generate it on your app’s page in the dashboard, which shows it once.
An app can also have a sandbox key, which starts with sandbox_. Links created with it are sandbox links, and it can’t change or delete live links. See Sandbox links and Authentication.
Errors
An error answers with its HTTP status. A 400, 403 or 404 also carries a JSON body that says what went wrong; a 401 has an empty body.
{ "message": "Max links reached for subscription. Please upgrade to re-enable usage." }| Status | When |
|---|---|
400 | The body is missing a field or isn’t valid, the short code is taken, or the organization’s links for the month are used up. |
401 | The Api-Key header is missing, or the key is unknown or belongs to a deleted app. |
403 | The link belongs to another app. |
404 | The link doesn’t exist, isn’t one of your app’s, or is a live link a sandbox key tried to change. |
Endpoints
- POST
/api/linksCreate a link - GET
/api/links/{id}Get a link - PUT
/api/links/{id}Update a link - DELETE
/api/links/{id}Delete a link - POST
/api/links/check-deferredGet the link that led to an install - POST
/api/links/resolveResolve the link that opened the app
OpenAPI document
These pages are generated from the API’s OpenAPI document, https://dev.thedbl.ink/swagger/public/swagger.json. Point a client generator at it to get typed models for these endpoints.