Get Connection Status

Overview

get_connection_status checks the current status of a data connection previously started with create_connection (e.g. bluebutton, epic). Call this after create_connection to let a user see whether their data is still being retrieved or is ready.

Required Parameters

endpoint_name (string)

The data source endpoint name to check (e.g. bluebutton, epic).
Same value passed to create_connection as connection_id.

Optional Parameters

wait_seconds (number)

  • Default: 0
  • How long to wait, in seconds, for the status to change before returning, up to a server-enforced cap (currently 25s). Use this to avoid re-calling the tool on a tight timer — pass the status from the previous call as last_known_status on the next call.

last_known_status (string)

  • Default: none
  • The status value returned by the previous call. When provided, the call returns as soon as the status differs from this value (or reaches a terminal status), instead of waiting the full wait_seconds.

Returns

A status of one of: pending, retrieving, complete, error, removing, removed, not_found (no connection found yet for this endpoint_name), or unknown (an unrecognized status value was returned by the platform — treat as "still in progress"). Also returns waited_seconds, indicating how long the call actually waited before returning.

##



Did this page help you?