integrations

Patch Instance

Update editable settings on an integration (connected tool / MCP & OAuth registration) you own — a partial update, so pass ONLY the fields you want to change; omitted fields are left untouched. Set alias to rename only this connection; name and description edit the shared connector definition used by sibling connections. The registration_id comes from integration_list. Editable fields:

  • alias: the display name (e.g. rename 'Gmail (read-only)' to 'Gmail — dan@example.com'). Must be non-empty.
  • health_check_tool: the tool the proactive probe + 'Test connection' call to validate the credential. tools/list-only by default, which can show green even when a per-user OAuth credential is dead; naming a safe READ-ONLY no-required-args tool (e.g. 'list_calendars', 'list_files') makes the probe actually exercise the credential. Pass an empty string to clear it (revert to tools/list-only).
  • health_check_arguments: reviewed JSON arguments for the safe probe. These are stored on the profile and supplied by the platform, never by the caller of the synthetic health tool.
  • health_check_declined + health_check_decline_reason: explicitly record that no safe probe exists and why. Declining clears the configured tool and arguments.
  • enabled: enable/disable the integration.
  • description: free-text description.
  • connection_mode: 'shared' (one credential the whole folder uses) or 'per_caller' (each identity connects and uses their own credential). shared -> per_caller is a pure flip. per_caller -> shared keeps only the most-recently-updated connection and deletes the rest; if more than one row would be deleted this fails with the count unless you also pass confirm_credential_deletion=true. In a folder with MORE THAN ONE member, per_caller -> shared also means 'Share the owner's account with this group' — everyone acts as one account — so it fails with the blast radius unless you also pass confirm_shared_account_exposure=true. Show that to the user first; the safe default is 'Each member connects separately' (per_caller). Fails with a clear message if you don't own the integration, the new alias collides, connection_mode is invalid, a per_caller -> shared downgrade needs confirmation, or no editable field was provided.
patch/api/integrations/instances/{instance_id}

Request

  • Base URL: https://app.thinqos.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.thinqos.com/api/integrations/instances/{instance_id}
  • Auth: none declared

Path parameters

instance_idstring uuid required

Headers

x-impersonate-identity-idstring nullable

Request body

namestring nullable

Shared connector definition name. Changes every connection using that definition and this connection's alias. To rename only this connection, set alias instead.

aliasstring nullable

Display label for this connection only. Does not rename sibling connections.

transport'http' | 'sse' | 'stdio_bridge' | 'rest' nullable
base_urlstring nullable
display_icon_urlstring nullable
descriptionstring nullable

Shared connector definition description. Changes every connection using that definition; this is not a per-connection note.

trustedboolean nullable
enabledboolean nullable
refresh_secondsinteger nullable
rate_limit_per_minuteinteger nullable
request_max_bytesinteger nullable
response_max_bytesinteger nullable
plaintext_secretstring nullable
health_check_toolstring nullable
health_check_argumentsobject nullable
health_check_declinedboolean nullable
health_check_decline_reasonstring nullable
impersonate_service_accountstring nullable
oauth_client_idstring nullable
oauth_authorization_urlstring nullable
oauth_token_urlstring nullable
oauth_registration_urlstring nullable
oauth_scopesstring nullable
oauth_pkce_enabledboolean nullable
oauth_client_secret_plaintextstring nullable
auth_kind'none' | 'bearer' | 'api_key_header' | 'oauth2' | 'gcp_oidc' | 'gcp_service_account' | 'github_app' nullable
auth_header_namestring nullable
oauth_resource_urlstring nullable
stdio_commandstring nullable
stdio_envobject nullable
rest_manifestobject nullable
rest_openapi_source_urlstring nullable
secret_refsobject nullable
secret_valuesobject nullable
remove_secret_namesstring[] nullable
talkableboolean nullable
library_idstring uuid nullable
connection_mode'shared' | 'per_caller' nullable
confirm_credential_deletionboolean
confirm_shared_account_exposureboolean

Response

Successful Response

idstring uuid required
definition_idstring uuid required
definition_slugstring nullable
account_capture_source'gmail' | 'google-calendar' nullable
library_idstring uuid nullable
library_namestring nullable
my_rolestring nullable
connection_mode'shared' | 'per_caller' required
aliasstring required
namestring required
transport'http' | 'sse' | 'stdio_bridge' | 'rest' required
base_urlstring required
display_icon_urlstring nullable
display_icon_is_inferredboolean
auth_kind'none' | 'bearer' | 'api_key_header' | 'oauth2' | 'gcp_oidc' | 'gcp_service_account' | 'github_app' required
auth_header_namestring nullable required
auth_secret_refstring nullable
descriptionstring nullable required
trustedboolean required
enabledboolean required
health_check_toolstring nullable required
health_check_argumentsobject
health_check_declinedboolean
health_check_decline_reasonstring nullable
refresh_secondsinteger required
rate_limit_per_minuteinteger nullable required
request_max_bytesinteger required
response_max_bytesinteger required
talkableboolean
stdio_commandstring nullable
stdio_envobject
rest_manifestobject nullable
rest_openapi_source_urlstring nullable
icon_urlstring nullable
icon_data_urlstring nullable
secret_refsobject
config_versioninteger nullable
tool_overridesobject
installed_template_versioninteger nullable
latest_template_versioninteger nullable
template_update_availableboolean
published_as_templateboolean
published_template_versioninteger nullable
published_template_visibilitystring nullable
oauth_resource_urlstring nullable
oauth_authorization_urlstring nullable
oauth_token_urlstring nullable
oauth_client_idstring nullable
oauth_scopesstring nullable
oauth_pkce_enabledboolean
oauth_client_secret_setboolean
oauth_requires_manual_clientboolean
oauth_token_expires_atstring date-time nullable
oauth_connectedboolean
oauth_granted_scopesstring nullable
oauth_principalobject nullable
account_identifiableboolean nullable
permissions_summarystring nullable
provider_namestring nullable
provider_consent_urlstring nullable
sign_in_notestring nullable
owned_by_viewerboolean nullable
org_naming_mismatch_warningstring nullable
credential_connectedboolean
credential_status'connected' | 'needs_reconnect' | 'admin_repair' | 'unreachable' | 'missing'
viewer_removal'self' | 'other' nullable
credential_last_auth_errorstring nullable
credential_failure_codestring nullable
access_naturestring nullable
reauth_classstring nullable
server_namestring nullable
server_versionstring nullable
protocol_versionstring nullable
server_capabilitiesobject nullable
server_instructionsstring nullable
last_test_successboolean nullable
last_test_tool_countinteger nullable
last_test_errorstring nullable
last_test_duration_msinteger nullable
last_test_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.