Skip to content
Coolify's Docs

Get

GET
/servers/{uuid}

Get server by UUID.

Authorizations

Parameters

Path Parameters

uuid
required
string

Server’s UUID

Responses

200

Get server by UUID

Server model

object
id

The server ID.

integer
uuid

The server UUID.

string
name

The server name.

string
description

The server description.

string
ip

The IP address.

string
user

The user.

string
port

The port number.

integer
proxy

The proxy configuration.

object
proxy_type

The proxy type.

string
Allowed values: traefik caddy none
high_disk_usage_notification_sent

The flag to indicate if the high disk usage notification has been sent.

boolean
unreachable_notification_sent

The flag to indicate if the unreachable notification has been sent.

boolean
unreachable_count

The unreachable count for your server.

integer
validation_logs

The validation logs.

string
log_drain_notification_sent

The flag to indicate if the log drain notification has been sent.

boolean
swarm_cluster

The swarm cluster configuration.

string
settings

Server Settings model

object
id
integer
concurrent_builds
integer
dynamic_timeout
integer
force_disabled
boolean
force_server_cleanup
boolean
is_build_server
boolean
is_cloudflare_tunnel
boolean
is_jump_server
boolean
is_logdrain_axiom_enabled
boolean
is_logdrain_custom_enabled
boolean
is_logdrain_highlight_enabled
boolean
is_logdrain_newrelic_enabled
boolean
is_metrics_enabled
boolean
is_reachable
boolean
is_sentinel_enabled
boolean
is_swarm_manager
boolean
is_swarm_worker
boolean
is_usable
boolean
logdrain_axiom_api_key
string
logdrain_axiom_dataset_name
string
logdrain_custom_config
string
logdrain_custom_config_parser
string
logdrain_highlight_project_id
string
logdrain_newrelic_base_uri
string
logdrain_newrelic_license_key
string
sentinel_metrics_history_days
integer
sentinel_metrics_refresh_rate_seconds
integer
sentinel_token
string
docker_cleanup_frequency
string
docker_cleanup_threshold
integer
server_id
integer
wildcard_domain
string
created_at
string
updated_at
string
delete_unused_volumes

The flag to indicate if the unused volumes should be deleted.

boolean
delete_unused_networks

The flag to indicate if the unused networks should be deleted.

boolean

400

Invalid token.

object
message
string
Invalid token.

401

Unauthenticated.

object
message
string
Unauthenticated.

404

Resource not found.

object
message
string
Resource not found.