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 service is ready or operational with degraded attach evidence
status
*
"ready" | "degraded" | "warming" | "unavailable"
checkedAt
*
string
controlPlane
*
object
Show properties
status
*
"ready" | "unavailable"
reasons
?
object[]
Show item properties
code
*
string
detail
*
string
dataPlane
*
object
Show properties
status
*
"ready" | "degraded" | "warming" | "unavailable"
region
*
stringnull
readyRuntimes
*
integer
Min:
0
minimumWarmRuntimes
*
integer
Min:
0
runtimes
*
object[]
Show item properties
runtimeId
*
string
Min length:
1
lastSuccessfulAttachAt
*
string,null (date-time)
lastAttachFailureAt
*
string,null (date-time)
consecutiveAttachFailures
*
integer
Min:
0
attachDegraded
*
boolean
durableDirectory
?
"available" | "unavailable" | "degraded"
reasons
?
object[]
Show item properties
code
*
string
detail
*
string
reasons
?
object[]
Show item properties
code
*
string
detail
*
string
503 · The service is warming or unavailable
status
*
"ready" | "degraded" | "warming" | "unavailable"
checkedAt
*
string
controlPlane
*
object
Show properties
status
*
"ready" | "unavailable"
reasons
?
object[]
Show item properties
code
*
string
detail
*
string
dataPlane
*
object
Show properties
status
*
"ready" | "degraded" | "warming" | "unavailable"
region
*
stringnull
readyRuntimes
*
integer
Min:
0
minimumWarmRuntimes
*
integer
Min:
0
runtimes
*
object[]
Show item properties
runtimeId
*
string
Min length:
1
lastSuccessfulAttachAt
*
string,null (date-time)
lastAttachFailureAt
*
string,null (date-time)
consecutiveAttachFailures
*
integer
Min:
0
attachDegraded
*
boolean
durableDirectory
?
"available" | "unavailable" | "degraded"
reasons
?
object[]
Show item properties
code
*
string
detail
*
string
reasons
?
object[]
Show item properties
code
*
string
detail
*
string
Copy as Markdown
Request example
cURL
curl -X GET "https://api.fivesocket.com/ready"
Powered by
Holocron