Coolify Octri Demo
GET/servers

List servers

Lists all servers available to the authenticated user. Use this endpoint to inspect server identifiers, connection details, proxy configuration, and settings.

3 status codes
200Returns an array of server objects, including server identifiers, connection details, proxy configuration, settings, and status-related fields.
descriptionstringoptional
The server description.
high_disk_usage_notification_sentbooleanoptional
The flag to indicate if the high disk usage notification has been sent.
idintegeroptional
The server ID.
ipstringoptional
The IP address.
log_drain_notification_sentbooleanoptional
The flag to indicate if the log drain notification has been sent.
namestringoptional
The server name.
portintegeroptional
The port number.
proxyobjectoptional
The proxy configuration.
proxy_typestringoptional
The proxy type.
Allowed:traefikcaddynone
settingsobjectoptional
Server Settings model
swarm_clusterstringoptional
The swarm cluster configuration.
unreachable_countintegeroptional
The unreachable count for your server.
unreachable_notification_sentbooleanoptional
The flag to indicate if the unreachable notification has been sent.
userstringoptional
The user.
uuidstringoptional
The server UUID.
validation_logsstringoptional
The validation logs.
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional

Error handling

Send a valid token with the request. A 400 indicates an invalid token, and a 401 indicates that the request is unauthenticated.