Coolify Octri Demo
GET/services/{uuid}

Get a service by UUID

Retrieves a service by its UUID. Use uuid to identify the service and inspect its configuration, metadata, and Docker Compose content.

1 parameter
uuidstringrequired
The UUID of the service to retrieve.

4 status codes
200Returns the service object, including its configuration, name, description, destination details, and Docker Compose content.
config_hashstringoptional
The hash of the service configuration.
connect_to_docker_networkbooleanoptional
The flag to connect the service to the predefined Docker network.
created_atstringoptional
The date and time when the service was created.
deleted_atstringoptional
The date and time when the service was deleted.
descriptionstringoptional
The description of the service.
destination_idintegeroptional
The unique identifier of the destination where the service is running.
destination_typestringoptional
Destination type.
docker_composestringoptional
The docker-compose.yml file that is parsed and modified by Coolify.
docker_compose_rawstringoptional
The raw docker-compose.yml file of the service.
environment_idintegeroptional
The unique identifier of the environment where the service is attached to.
idintegeroptional
The unique identifier of the service. Only used for database identification.
is_container_label_escape_enabledbooleanoptional
The flag to enable the container label escape.
is_container_label_readonly_enabledbooleanoptional
The flag to enable the container label readonly.
namestringoptional
The name of the service.
redact_all_env_values_in_logsbooleanoptional
Hide every environment variable value in logs. When false, only locked values are hidden.
server_idintegeroptional
The unique identifier of the server where the service is running.
service_typestringoptional
The type of the service.
updated_atstringoptional
The date and time when the service was last updated.
uuidstringoptional
The unique identifier of the service.
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the service resource is not found.
messagestringoptional

Error handling

A 400 indicates an invalid token, and a 401 indicates an unauthenticated request. A 404 indicates the resource was not found; the uuid path parameter must identify an existing service.