Reconnect App

put

https://api.lumos.com/apps/{app_id}

Update an app in place: apply domain-specific metadata overrides (the same fields as PATCH /apps/{app_id}) and/or rotate an integration's credentials. Providing auth/settings/version (with the matching app_class_id) reconnects the app: credentials are always overwritten and re-validated, and a sync is triggered — like connect, the app either connects in-band or awaits browser consent in the Lumos UI, and while a sync is in flight the request is throttled with 429 and a Retry-After header. Metadata-only bodies (custom apps, or integrations without credential changes) never touch credentials.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

app_id

string

required

Body Params

Body of PUT /apps/{app_id}: update metadata overrides and/or reconnect.

One flat model serves both operations (mirroring AppInputCreate): the
metadata fields apply the same domain-specific overrides as
PATCH /apps/{app_id}, and providing credentials (auth/settings/
version, which require the matching app_class_id) additionally
reconnects the integration with those credentials.

name

The updated domain-specific display name of the app. Set to null to reset to the app's default name.

category

The updated domain-specific category of the app. Set to null to reset to the app's default category. Possible values: 'Accounting & Finance', 'Marketing & Analytics', 'Content & Social Media', 'Sales & Support', 'Design & Creativity', 'IT & Security', 'Developers', 'HR & Learning', 'Office & Legal', 'Communication', 'Collaboration', 'Commerce & Marketplaces', 'Other', 'Internal'

description

The updated domain-specific description of the app. Set to null to reset to the app's default description.

logo_url

The updated domain-specific URL of the logo of the app. Set to null to reset to the app's default logo.

website_url

The updated URL of the website of the app. Set to null to clear it.

request_instructions

The updated request instructions.

app_class_id

Canonical identifier of the integration this app belongs to, e.g. okta.com. Must match the existing app (a mismatch is rejected with 400); required when rotating credentials via auth/settings/version.

auth

object | null

New credentials for the integration, as a JSON object — all secrets go here. Providing credentials reconnects the app: they are always overwritten and re-validated, and a sync is triggered. The accepted keys depend on the integration and are validated server-side. Missing or wrong-shaped credentials are rejected with 400; credentials the third party rejects return 502. Requires app_class_id.

settings

object | null

Non-secret configuration for the integration being reconnected, as a JSON object — e.g. host, port, region, or tenant / instance URL. The accepted keys vary by integration and some integrations need none. Requires app_class_id.

version

Optional integration version override for the reconnect. Pins the connection to a specific integration implementation/version instead of the current default; leave unset (null) unless directed otherwise. Requires app_class_id.

Responses

400

Bad request — the request could not be processed. Common causes: missing or malformed credentials, an unknown app_class_id, or an invalid configuration value. See the detail field for the specific reason.

403

Forbidden — the caller lacks permission to manage apps on this domain.

404

Not found — no app with this id in your domain.

409

Conflict — credentials were provided for an app that is not managed via the API (connection_source is not API), so it cannot be reconnected here.

429

Too many requests — a sync is already in flight for this app. Includes a Retry-After header (seconds).

501

Not implemented — this app does not support the requested operation.

502

Bad gateway — the third-party service rejected the credentials, or the post-reconnect sync failed.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error