Check database status | Athena | API Reference Docs

Check if a database is running, suspended, or starting up. Poll this endpoint to determine when a serverless database is ready.

Status Values:

running - Database is active and accepting connections
suspended - Database is suspended (scale-to-zero), will auto-resume on first query
starting - Database is waking up
failed - Database failed to start
unknown - Status could not be determined

Check if a database is running, suspended, or starting up. Poll this endpoint to determine when a serverless database is ready. **Status Values:** - `running` - Database is active and accepting connections - `suspended` - Database is suspended (scale-to-zero), will auto-resume on first query - `starting` - Database is waking up - `failed` - Database failed to start - `unknown` - Status could not be determined

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

asset_idstringRequired

Response

Successful Response

asset_idstring

The database asset ID

providerstring

Database provider (‘neon_cloud’ or ‘kronos’)

statusenum

Standardized database status

messagestring or null

Optional status message or error details

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

501

Not Implemented Error