Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.
fivesocket.com
Menu
Documentation
API Reference
/ready
GET
Response
200 · The control plane and data plane are ready
status
*
"ready" | "warming" | "bootstrap_required" | "unavailable"
checkedAt
*
string
controlPlane
*
object
Show properties
status
*
"ready" | "unavailable"
dataPlane
*
object
Show properties
status
*
"ready" | "warming" | "bootstrap_required" | "unavailable"
region
*
stringnull
generationId
*
stringnull
readyWorkers
*
integer
Min:
0
minimumReadyWorkers
*
integer
Min:
0
503 · The service is warming, requires server bootstrap, or is unavailable
status
*
"ready" | "warming" | "bootstrap_required" | "unavailable"
checkedAt
*
string
controlPlane
*
object
Show properties
status
*
"ready" | "unavailable"
dataPlane
*
object
Show properties
status
*
"ready" | "warming" | "bootstrap_required" | "unavailable"
region
*
stringnull
generationId
*
stringnull
readyWorkers
*
integer
Min:
0
minimumReadyWorkers
*
integer
Min:
0
Copy as Markdown
Request example
cURL
curl -X GET "https://api.fivesocket.com/ready"
Powered by
Holocron