- Create Source
- Get Source By Id
- Get Sources
- Update Source
- Delete Source
POST /api/v1/core/sourceCreate a new source in the database.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.string
Display name.
string
Free-text description.
string
ID of the source type.
object
boolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
The endpoint’s response payload.
curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/core/source" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"name": "Snowflake Production",
"description": "Primary analytics warehouse",
"source_type_id": "6bec0bfd-d228-593f-bff0-4b52308f0489",
"config": {
"account": "<account>",
"warehouse": "<warehouse>",
"database": "<database>"
},
"credentials": {
"username": "<username>",
"password": "<password>"
}
}'
Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.
Request body
{
"name": "Snowflake Production",
"description": "Primary analytics warehouse",
"source_type_id": "6bec0bfd-d228-593f-bff0-4b52308f0489",
"config": {
"account": "<account>",
"warehouse": "<warehouse>",
"database": "<database>"
},
"credentials": {
"username": "<username>",
"password": "<password>"
}
}
Response
{
"success": true,
"message": "Create a new source in the database.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
GET /api/v1/core/source/{sourceId}Get a source by its ID.Path Parametersstring
required
Example:
3fa85f64-5717-4562-b3fc-2c963f66afa6boolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
string
Example:
"3fad887f-effb-57e0-8b80-4e8185a785f0".string
Example:
"SAMPLE_SOURCE".string
string
Example:
"MSSQL".object
object
boolean
Example:
true.boolean
Example:
true.boolean
Example:
false.string
Example:
"27d14b45-c863-5075-b943-00d91b70b078".object
string
Example:
"27d14b45-c863-5075-b943-00d91b70b078".string
Example:
"MSSQL".string
Example:
"It is nothing but SQL Server, use Relational Database".string
Example:
"It is nothing but SQL Server, use Relational Database".string
Example:
"MSSQL".string
Example:
"Datawarehouse".boolean
Example:
true.boolean
Example:
false.string
Example:
"491be29a-189c-5539-b9c2-6f4f7dc7972a".string
Example:
"2026-09-21T07:34:27.996322Z".string
Example:
"2026-09-21T07:34:28.043702Z".curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/core/source/{sourceId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "Get a source by its ID.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {
"id": "3fad887f-effb-57e0-8b80-4e8185a785f0",
"name": "SAMPLE_SOURCE",
"description": null,
"type": "MSSQL",
"credentials": {
"port": "1433",
"server": "<encrypted>",
"database": "analytics",
"password": "<encrypted>",
"username": "<encrypted>",
"auth_type": "username_password",
"included_databases": []
},
"config": {},
"is_valid": true,
"is_active": true,
"is_api_connection": false,
"source_type_id": "27d14b45-c863-5075-b943-00d91b70b078",
"source_type": {
"id": "27d14b45-c863-5075-b943-00d91b70b078",
"name": "MSSQL",
"short_description": "It is nothing but SQL Server, use Relational Database",
"long_description": "It is nothing but SQL Server, use Relational Database",
"type": "MSSQL",
"tag": "Datawarehouse",
"is_active": true,
"is_delete": false
},
"created_by": "491be29a-189c-5539-b9c2-6f4f7dc7972a",
"created_at": "2026-09-21T07:34:27.996322Z",
"modified_at": "2026-09-21T07:34:28.043702Z"
}
}
POST /api/v1/core/source/listGet all sources with optional filtering and pagination.Request Bodyobject[]
object[]
string
Example:
"".boolean
Example:
false.boolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
object[]
string
Example:
"3fad887f-effb-57e0-8b80-4e8185a785f0".string
Example:
"SAMPLE_SOURCE".string
string
Example:
"MSSQL".object
boolean
Example:
true.boolean
Example:
true.boolean
Example:
false.string
Example:
"491be29a-189c-5539-b9c2-6f4f7dc7972a".string
Example:
"2026-09-21T07:34:27.996322Z".string
Example:
"2026-09-21T07:34:28.043702Z".object[]
string
Example:
"Datawarehouse".integer
Example:
50.object[]
curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/core/source/list" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"pagination": {
"page": 1,
"pageSize": 10
},
"sorting": [],
"filters": [],
"search": "",
"export": false
}'
Response
{
"success": true,
"message": "Get all sources with optional filtering and pagination.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {
"data": [
{
"id": "3fad887f-effb-57e0-8b80-4e8185a785f0",
"name": "SAMPLE_SOURCE",
"description": null,
"type": "MSSQL",
"config": {},
"is_valid": true,
"is_active": true,
"is_api_connection": false,
"created_by": "491be29a-189c-5539-b9c2-6f4f7dc7972a",
"created_at": "2026-09-21T07:34:27.996322Z",
"modified_at": "2026-09-21T07:34:28.043702Z",
"audiences": [],
"source_type_tag": "Datawarehouse"
}
],
"total_count": 50,
"metrics": []
}
}
PUT /api/v1/core/source/{sourceId}Updates the name, description or settings of an existing data source.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.string
Display name.
string
Free-text description.
boolean
Whether the object is active.
string
required
Example:
3fa85f64-5717-4562-b3fc-2c963f66afa6boolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
The endpoint’s response payload.
curl -X PUT "https://<your-workspace>.prizmdata.ai/api/v1/core/source/{sourceId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"name": "Snowflake Production",
"description": "Primary analytics warehouse (updated)",
"is_active": true
}'
Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.
Request body
{
"name": "Snowflake Production",
"description": "Primary analytics warehouse (updated)",
"is_active": true
}
Response
{
"success": true,
"message": "Update Source",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
DELETE /api/v1/core/source/{sourceId}Delete a source by its ID.Path Parametersstring
required
Example:
3fa85f64-5717-4562-b3fc-2c963f66afa6boolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
The endpoint’s response payload.
curl -X DELETE "https://<your-workspace>.prizmdata.ai/api/v1/core/source/{sourceId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "Delete a source by its ID.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}