Skip to content

Data readiness of a request's enclave

GET
/v1/requests/{id}/status
curl --request GET \
--url https://localhost:8080/v1/requests/example/status \
--header 'Authorization: <Authorization>'

Reports whether the datasets of an activated request have been pulled into its enclave yet: state is provisioning (container not up), loading (env-enzo pulling data), ready (query away) or failed (error says why). Poll this after activation until ready; a query sent earlier answers 409. datasets lists each loaded relation with its row count, and those relation names are the table names to use in SQL. This is the customer-facing view of env-enzo’s own healthcheck, which is not exposed.

id
required
string

Request ID

OK

Media typeapplication/json
object
datasets
Array<object>
object
relation
string
rows_loaded
integer
success
boolean
datasets_failed
integer
datasets_loaded
integer
datasets_total
integer
environment_status
string
error
string
request_status
string
state

Provisioning | loading | ready | failed

string

Example generated

{
"datasets": [
{
"relation": "example",
"rows_loaded": 1,
"success": true
}
],
"datasets_failed": 1,
"datasets_loaded": 1,
"datasets_total": 1,
"environment_status": "example",
"error": "example",
"request_status": "example",
"state": "example"
}

Unauthorized

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}

Not Found

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}