v1

latestOpenAPI 3.0.0MIT2026-07-14102210128.7 KB
source

Check connection for a proposed update to a source

post/v1/sources/check_connection_for_update

Request body

{"stackTrail":"components:schemas:SourceConfiguration","oasType":"schema","type":"unknown","description":"The values required to configure the source. The schema for this must match the schema return by source_definition_specifications/get for the source.","example":{"user":"charles"}}
namestring required
sourceIdstring uuid required

Example request

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

Response

Successful operation

messagestring
status'succeeded' | 'failed' required