Schemas API

Auto-generated from codebase analysis

This section documents the Schemas API endpoints.

GET Endpoints

GET /api/schema/config/columns/{table_name}/{column_name}/test

Get test configuration for a specific column

Parameters

Name	Type	Required	Description
table_name	str	Yes
column_name	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/schema/config/columns/{table_name}/{column_name}/test" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /api/schema/config/columns/{table_name}/{column_name}/monitoring

Get monitoring configuration for a specific column

Parameters

Name	Type	Required	Description
table_name	str	Yes
column_name	str	Yes
schema_type	str	No

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/schema/config/columns/{table_name}/{column_name}/monitoring" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /api/schema/config/tables/{table_name}/monitoring

Get monitoring configuration for a specific table

Parameters

Name	Type	Required	Description
table_name	str	Yes
schema_type	str	No

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/schema/config/tables/{table_name}/monitoring" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /api/schema/config/summary

Get a summary of all test and monitoring configurations

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/schema/config/summary" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /

Get all available schemas

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /workspace/sync/status

Get sync status for workspace schema with enhanced UI indicators

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/workspace/sync/status" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /workspace

Get workspace schema.json content

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/workspace" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /templates

Get list of available library schema templates

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/templates" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /templates/{template_name}

Get a specific library schema template

Parameters

Name	Type	Required	Description
template_name	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/templates/{template_name}" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /workspace/ddl

Get DDL statements for all tables in the workspace's target schema.

Parameters

Name	Type	Required	Description
grant_user	Optional[str]	No

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/workspace/ddl" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /workspace/connections

Get all available reverse ETL connections for the current workspace.

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/workspace/connections" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST Endpoints

POST /templates/{template_name}/assign

Assign a template schema to the current workspace

Parameters

Name	Type	Required	Description
template_name	str	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/templates/{template_name}/assign" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /workspace/sync

Sync workspace schema to the target database and reconcile with existing mappings

Parameters

Name	Type	Required	Description
sync_request	SyncSchemaRequest	No

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/workspace/sync" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /workspace

Save workspace schema.json content and reconcile with existing mappings

Parameters

Name	Type	Required	Description
schema_update	WorkspaceSchemaUpdate	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/workspace" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /workspace/copy-from-library/{library_schema_name}

Copy a library schema to workspace schema.json

Parameters

Name	Type	Required	Description
library_schema_name	str	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/workspace/copy-from-library/{library_schema_name}" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /workspace/tables/{table_name}/columns

Add a new column to an existing table in the workspace's target schema.

Parameters

Name	Type	Required	Description
table_name	str	Yes
column	dict	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/workspace/tables/{table_name}/columns" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT Endpoints

PUT /api/schema/config/columns/{table_name}/{column_name}/test

Update test configuration for a specific column

Parameters

Name	Type	Required	Description
table_name	str	Yes
column_name	str	Yes
config	ColumnTestConfig	Yes

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/api/schema/config/columns/{table_name}/{column_name}/test" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT /api/schema/config/columns/{table_name}/{column_name}/monitoring

Update monitoring configuration for a specific column

Parameters

Name	Type	Required	Description
table_name	str	Yes
column_name	str	Yes
config	ColumnMonitoringConfig	Yes
schema_type	str	No

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/api/schema/config/columns/{table_name}/{column_name}/monitoring" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT /api/schema/config/tables/{table_name}/monitoring

Update monitoring configuration for a specific table

Parameters

Name	Type	Required	Description
table_name	str	Yes
config	TableMonitoringConfig	Yes
schema_type	str	No

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/api/schema/config/tables/{table_name}/monitoring" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT /workspace/tables/{table_name}/connection

Assign or remove a reverse ETL connection for a specific table.

Parameters

Name	Type	Required	Description
table_name	str	Yes

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/workspace/tables/{table_name}/connection" \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE Endpoints

DELETE /api/schema/config/columns/{table_name}/{column_name}/test

Delete test configuration for a specific column

Parameters

Name	Type	Required	Description
table_name	str	Yes
column_name	str	Yes

Example Request

curl -X DELETE "https://your-instance.datalinx.ai/api/api/schema/config/columns/{table_name}/{column_name}/test" \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE /api/schema/config/columns/{table_name}/{column_name}/monitoring

Delete monitoring configuration for a specific column

Parameters

Name	Type	Required	Description
table_name	str	Yes
column_name	str	Yes
schema_type	str	No

Example Request

curl -X DELETE "https://your-instance.datalinx.ai/api/api/schema/config/columns/{table_name}/{column_name}/monitoring" \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE /api/schema/config/tables/{table_name}/monitoring

Delete monitoring configuration for a specific table

Parameters

Name	Type	Required	Description
table_name	str	Yes
schema_type	str	No

Example Request

curl -X DELETE "https://your-instance.datalinx.ai/api/api/schema/config/tables/{table_name}/monitoring" \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE /workspace

Delete workspace schema.json

Example Request

curl -X DELETE "https://your-instance.datalinx.ai/api/workspace" \
  -H "Authorization: Bearer YOUR_TOKEN"