Apps

Launch app

Open an installed app and get a portal URL.

POST/apps/installed/{installed_app_id}/portal

Launch returns a short-lived portal_url for an installed app.

Blnk asks the app’s portal generator for that URL, then returns it so the app can open inside the dashboard.

X-blnk-keystringheader

Enterprise API key, or an OAuth access token. Use this when the app does not require a launch password.

Authorizationstringheader

Bearer session token for the current organization. Required when the app has require_password_to_launch set. An API key cannot confirm the password.

Path

installed_app_idstringrequiredpath

Id of the installation from Install app or List apps (instapp_...).

Body

passwordstringbody

Account password of the signed-in user. Required when the app has require_password_to_launch set.

two_factor_codestringbody

2FA code. Required with password when 2FA is on for this user.

Response

A 200 response returns the portal URL. Load portal_url to open the app.

portal_urlstringrequired

Short-lived URL returned by the app’s portal generator.

curl -X POST "https://api.cloud.blnkfinance.com/apps/installed/instapp_8cc22560-5ace-4989-8953-fcbad7947d48/portal" \
  -H "X-blnk-key: CLOUD_API_KEY"

curl -X POST "https://api.cloud.blnkfinance.com/apps/installed/instapp_8cc22560-5ace-4989-8953-fcbad7947d48/portal" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "account-password"
  }'

{
  "portal_url": "https://app.example.com/portal/9f3c2a"
}

{
  "error": "launching this app requires a user session token"
}

{
  "error": "password is required to launch this app"
}

{
  "error": "two_factor_code is required"
}

{
  "error": "password verification failed"
}

{
  "error": "2fa verification failed"
}

{
  "error": "you are not assigned to launch this app"
}

{
  "error": "app has no portal generator URL configured"
}

{
  "error": "portal generator did not return a portal URL"
}

{
  "error": "installed app with id 'instapp_8cc22560-5ace-4989-8953-fcbad7947d48' not found"
}

{
  "error": "User not authenticated"
}

{
  "error": "Organization not found"
}

Launch app

Header

Path

Body

Response