v1

latestOpenAPI 3.0.0MIT2026-07-14102210128.7 KB
scheduler

Run discover schema for a given source a source configuration

post/v1/scheduler/sources/discover_schema

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"}}
sourceDefinitionIdstring uuid required
sourceIdstring uuid
workspaceIdstring uuid required

Example request

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

Response

Successful operation

breakingChangeboolean
catalogIdstring uuid
connectionStatus'active' | 'inactive' | 'deprecated'

Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced.