Probe a source connection live: check its credential and read one page of an entity
POST /api/workspaces/{workspaceId}/connectors/{id}/probe
POST
/api/workspaces/{workspaceId}/connectors/{id}/probe
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” workspaceId
required
string
id
required
string
Request Body
Section titled “Request Body ”object
entity
Entity to read one page of. Omit to check the credential only.
string
limit
Maximum records to return (default 20).
integer
fields
Keep only these top-level fields of each record.
Array<string>
since
ISO 8601 instant: records changed since then, where the connector supports it.
string
Responses
Section titled “ Responses ”Successful response
object
success
Whether the request succeeded.
boolean
data
Endpoint-specific response payload.
message
string
Example
Operation completed error
string
Example
Error messageInvalid request
object
success
boolean
error
string
Example
Error messageInternal server error
object
success
boolean
error
string
Example
Error message