v1

latestOpenAPI 3.0.0MIT2026-07-14102210128.7 KB
scheduler

Run check connection for a given destination configuration

post/v1/scheduler/destinations/check_connection

Request body

{"stackTrail":"components:schemas:DestinationConfiguration","oasType":"schema","type":"unknown","description":"The values required to configure the destination. The schema for this must match the schema return by destination_definition_specifications/get for the destinationDefinition.","example":{"user":"charles"}}
destinationDefinitionIdstring uuid required
destinationIdstring uuid
workspaceIdstring uuid required

Example request

{
  "connectionConfiguration": {
    "user": "charles"
  }
}

Response

Successful operation

messagestring
status'succeeded' | 'failed' required