Coolify Octri Demo
GET/servers/{uuid}

Get a server by UUID

Retrieves a server by its UUID. Use this endpoint to inspect the server's connection details, proxy configuration, settings, and status-related fields.

1 parameter
uuidstringrequired
The UUID of the server to retrieve.

4 status codes
200Returns a server object with its identifier, 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
404Returned when the server resource cannot be found.
messagestringoptional

Error handling

A 400 indicates an invalid token, a 401 indicates an unauthenticated request, and a 404 indicates that the server resource was not found. The uuid path parameter must identify the server you want to retrieve.