Schema API

Database schema introspection

REST API endpoints for Schema. 5 operations.

Get the database schema

plaintext

GET /api/v1/schema

Returns the tables, views, and types in the tenant's database.

Auth: Bearer API key

Responses

operationId: getSchema

plaintext

GET /api/v1/schema/columns

Returns columns across the schema matching an optional name search term.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`q`	query	`string`	No	Column-name search term

Responses

operationId: searchSchemaColumns

plaintext

GET /api/v1/schema/pii

Returns columns flagged as likely personally identifiable information.

Auth: Bearer API key

Responses

operationId: listPiiColumns

plaintext

GET /api/v1/schema/relationships

Returns the foreign-key relationships between tables in the schema.

Auth: Bearer API key

Responses

operationId: getSchemaRelationships

plaintext

GET /api/v1/schema/table/{name}

Returns the columns and types for a single table.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`name`	path	`string`	Yes	Table name

Responses

operationId: getTableSchema