Services represent containerized applications or microservices running in your stack. They define the Docker images, commands, and configurations for your application components.
namestringThe name of the service.
containersarrayAn array of container objects that belong to this service, showing all running instances.
source_typestringThe source type for the service image (e.g., git, image).
git_refstringThe git reference (branch or tag) used for building this service.
image_namestringThe Docker image name for this service.
image_uidstringThe unique identifier of the Docker image.
image_tagstringThe Docker image tag version.
commandstringThe command that the service containers execute when they start.
build_commandstringThe command used to build the Docker image for this service.
deploy_commandstringThe command executed during deployment of this service.
wrap_commandstringThe wrapper command used to execute the service in specific environments.
desired_countintegerFor Kubernetes-based stacks, the desired number of replicas for this service.
Example
{
"name": "web",
"containers": [
{
"id": "container-123",
"status": "running",
"server_uid": "550e8400-e29b-41d4-a716-446655440001"
},
{
"id": "container-124",
"status": "running",
"server_uid": "550e8400-e29b-41d4-a716-446655440002"
}
],
"source_type": "git",
"git_ref": "main",
"image_name": "myapp/web",
"image_uid": "sha256:1234567890abcdef",
"image_tag": "latest",
"command": "bundle exec rails server -b 0.0.0.0 -p 3000",
"build_command": "bundle install && npm install && npm run build",
"deploy_command": "bundle exec rake db:migrate",
"wrap_command": null,
"desired_count": 3
}