Probe a source connection live: check its credential and read one page of an entity
POST
/api/workspaces/{workspaceId}/connectors/{id}/probe
const url = 'http://localhost:8080/api/workspaces/example/connectors/example/probe';const options = { method: 'POST', headers: {cookie: 'auth_session=<auth_session>', 'Content-Type': 'application/json'}, body: '{"entity":"example","limit":1,"fields":["example"],"since":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:8080/api/workspaces/example/connectors/example/probe \ --header 'Content-Type: application/json' \ --cookie auth_session=<auth_session> \ --data '{ "entity": "example", "limit": 1, "fields": [ "example" ], "since": "example" }'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”Media typeapplication/json
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
Example generated
{ "entity": "example", "limit": 1, "fields": [ "example" ], "since": "example"}Responses
Section titled “Responses”Successful response
Media typeapplication/json
object
success
Whether the request succeeded.
boolean
data
Endpoint-specific response payload.
message
string
error
string
Example
{ "message": "Operation completed", "error": "Error message"}Invalid request
Media typeapplication/json
object
success
boolean
error
string
Example
{ "error": "Error message"}Internal server error
Media typeapplication/json
object
success
boolean
error
string
Example
{ "error": "Error message"}