Skip to content
Coolify's Docs

Get

GET
/services/{uuid}

Get service by UUID.

Authorizations

Parameters

Path Parameters

uuid
required
string

Service UUID

Responses

200

Get a service by UUID.

Service model

object
id

The unique identifier of the service. Only used for database identification.

integer
uuid

The unique identifier of the service.

string
name

The name of the service.

string
environment_id

The unique identifier of the environment where the service is attached to.

integer
server_id

The unique identifier of the server where the service is running.

integer
description

The description of the service.

string
docker_compose_raw

The raw docker-compose.yml file of the service.

string
docker_compose

The docker-compose.yml file that is parsed and modified by Coolify.

string
destination_type

Destination type.

string
destination_id

The unique identifier of the destination where the service is running.

integer
connect_to_docker_network

The flag to connect the service to the predefined Docker network.

boolean
is_container_label_escape_enabled

The flag to enable the container label escape.

boolean
is_container_label_readonly_enabled

The flag to enable the container label readonly.

boolean
config_hash

The hash of the service configuration.

string
service_type

The type of the service.

string
created_at

The date and time when the service was created.

string
updated_at

The date and time when the service was last updated.

string
deleted_at

The date and time when the service was deleted.

string

400

Invalid token.

object
message
string
Invalid token.

401

Unauthenticated.

object
message
string
Unauthenticated.

404

Resource not found.

object
message
string
Resource not found.