Skip to content
AutoDB AutoDB Docs

Trigger Introspection

POST
/api/v1/connections/{connection_id}/introspect

Trigger schema introspection for a database connection.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
connection_id
required
Connection Id
string format: uuid

Query Parameters

Section titled “Query Parameters ”
schemas
Any of:
string

Comma-separated schema names to introspect. Omit for all non-excluded schemas.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

IntrospectionApiResponse

Response for POST /connections/{id}/introspect.

object
success
required
Success

Whether the request succeeded.

boolean
data
Any of:
IntrospectionResponse
object
connection_id
required
Connection Id

ID of the connection that was introspected.

string format: uuid
table_count
required
Table Count

Number of tables discovered across all introspected schemas.

integer
tables
required
Tables

Sorted list of schema-qualified table names (schema.table) found during introspection.

Array<string>
schemas_introspected
required
Schemas Introspected

List of schema names that were introspected in this run.

Array<string>
snapshot_id
required
Snapshot Id

ID of the SchemaSnapshot record storing the introspection results.

string format: uuid
introspected_at
required
Introspected At

Timestamp when the introspection completed.

string format: date-time
error
Any of:
ErrorDetail
object
code
required
Code

Machine-readable error code (e.g., ‘NOT_FOUND’, ‘VALIDATION_ERROR’).

string
message
required
Message

Human-readable error message describing what went wrong.

string
details
Any of:

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object