iOS and Android apps API

Your project's iOS and Android apps tell Dynalinks which app should open your links. They drive the apple-app-site-association and assetlinks.json files served on your domain, and the App Store and Google Play redirects for users who do not have the app installed.

You can manage them in the console, or with the endpoints on this page. They are useful when you provision projects automatically, rotate an Android signing certificate, or keep app settings in sync with your own configuration.

These endpoints follow the conventions described in API basics: the same base URL, authentication, pagination and error format.

Before you startCopy Anchor Link

• Use a project API key from Settings > API Keys. The apps belong to that key's project.
• If the key has custom scopes, it needs the matching ones: ios_apps.index, ios_apps.show, ios_apps.create, ios_apps.update, ios_apps.destroy, and the same five for android_apps.
• Reading apps requires Viewer access to the project. Creating, updating and deleting apps requires Manager or Owner access. See Team members & roles.

EndpointsCopy Anchor Link

:id is the app's id (a UUID) from the create or list response, not its bundle ID or package name.

iOS appsCopy Anchor Link

FieldsCopy Anchor Link

The response also contains id.

Create an iOS appCopy Anchor Link

Send the fields inside an ios_app object:

curl --request POST https://dynalinks.app/api/v1/ios_apps \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "ios_app": {
      "name": "Example",
      "bundle_id": "com.example.app",
      "team_id": "ABCDE12345",
      "app_store_id": "1234567890"
    }
  }'

Response (201 Created):

{
  "id": "6b1f2c3d-8e4a-4f5b-9c7d-2a1e0f3b4c5d",
  "name": "Example",
  "bundle_id": "com.example.app",
  "team_id": "ABCDE12345",
  "app_store_id": "1234567890",
  "clip_bundle_id": null,
  "custom_scheme": null
}

Update an iOS appCopy Anchor Link

Send only the fields you want to change. Fields you leave out keep their current value.

curl --request PATCH https://dynalinks.app/api/v1/ios_apps/6b1f2c3d-8e4a-4f5b-9c7d-2a1e0f3b4c5d \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"ios_app": {"custom_scheme": "exampleapp"}}'

The response (200 OK) contains the full updated app.

Android appsCopy Anchor Link

FieldsCopy Anchor Link

The response also contains id.

Each fingerprint must be written as pairs of hexadecimal characters separated by colons, the format printed by keytool and ./gradlew signingReport:

14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5

Fingerprints are stored in upper case, and empty entries are dropped.

Create an Android appCopy Anchor Link

Send the fields inside an android_app object:

curl --request POST https://dynalinks.app/api/v1/android_apps \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "android_app": {
      "name": "Example",
      "package_name": "com.example.app",
      "fingerprints": [
        "14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"
      ]
    }
  }'

Response (201 Created):

{
  "id": "0e9d8c7b-6a5f-4e3d-8c2b-1a0f9e8d7c6b",
  "name": "Example",
  "package_name": "com.example.app",
  "fingerprints": [
    "14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"
  ],
  "custom_scheme": null
}

Update an Android appCopy Anchor Link

Send only the fields you want to change. When you send fingerprints, the array replaces the existing list, so include every fingerprint you want to keep:

curl --request PATCH https://dynalinks.app/api/v1/android_apps/0e9d8c7b-6a5f-4e3d-8c2b-1a0f9e8d7c6b \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "android_app": {
      "fingerprints": [
        "14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5",
        "A1:B2:C3:D4:E5:F6:07:18:29:3A:4B:5C:6D:7E:8F:90:A1:B2:C3:D4:E5:F6:07:18:29:3A:4B:5C:6D:7E:8F:90"
      ]
    }
  }'

The response (200 OK) contains the full updated app.

Listing appsCopy Anchor Link

curl https://dynalinks.app/api/v1/ios_apps \
  --header 'Authorization: Token YOUR_API_KEY'

{
  "ios_apps": [
    {
      "id": "6b1f2c3d-8e4a-4f5b-9c7d-2a1e0f3b4c5d",
      "name": "Example",
      "bundle_id": "com.example.app",
      "team_id": "ABCDE12345",
      "app_store_id": "1234567890",
      "clip_bundle_id": null,
      "custom_scheme": "exampleapp"
    }
  ],
  "meta": { "page": 1, "limit": 20, "count": 1, "last": 1, "from": 1, "to": 1 }
}

GET /api/v1/android_apps works the same way and returns an android_apps array.

Lists support page and limit (see Pagination) and filters in the q parameter (see Filtering and sorting). You can filter on these fields:

For example, to find an app by its bundle ID:

curl --get https://dynalinks.app/api/v1/ios_apps \
  --header 'Authorization: Token YOUR_API_KEY' \
  --data-urlencode 'q[bundle_id_eq]=com.example.app'

Getting one appCopy Anchor Link

curl https://dynalinks.app/api/v1/android_apps/0e9d8c7b-6a5f-4e3d-8c2b-1a0f9e8d7c6b \
  --header 'Authorization: Token YOUR_API_KEY'

Returns the app (200 OK), or 404 Not Found if the id does not exist in the key's project.

Deleting an appCopy Anchor Link

curl --request DELETE https://dynalinks.app/api/v1/ios_apps/6b1f2c3d-8e4a-4f5b-9c7d-2a1e0f3b4c5d \
  --header 'Authorization: Token YOUR_API_KEY'

A successful delete returns 204 No Content with an empty body.

Validation errorsCopy Anchor Link

When the data is invalid, the API responds with 422 Unprocessable Content and lists every problem in a single error message:

{
  "error": "Bundle is invalid, Bundle can't be blank, and Team is the wrong length (should be 10 characters)"
}

Common messages:

Other errors:

• 400 Bad Request if the body has no ios_app / android_app object, the body is not valid JSON, or Content-Type is not application/json.
• 401 Unauthorized if the key is invalid, lacks the required scope, or its owner does not have the required role.
• 404 Not Found with {"error": "iOS app not found"} or {"error": "Android app not found"} for an unknown id.
• 429 Too Many Requests if you exceed the rate limit of 600 create, update and delete requests per minute (shared per key for iOS apps, and separately for Android apps).

RelatedCopy Anchor Link

• iOS setup and Android setup
• Custom apple-app-site-association
• Android debugging, if links do not open your app after you change fingerprints
• Full reference: API reference