create_service
Deploy containerized applications on Coolify servers by specifying either a pre-defined service type or custom Docker Compose configuration.
Instructions
Create a new service on a specified server. Services are containerized applications that run on your Coolify servers. Either "type" or "docker_compose_raw" must be provided - you cannot specify both.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| description | No | Optional description of the service's purpose or configuration | |
| docker_compose_raw | No | Raw Docker Compose configuration for the service. Required if type is not provided. Cannot be used together with type. | |
| environment_name | No | Name of the environment (e.g., production, staging, development) | |
| environment_uuid | No | Optional UUID of an existing environment to use | |
| name | Yes | A unique, human-readable name for the service | |
| project_uuid | Yes | UUID of the project this service belongs to. Projects help organize related services. | |
| server_uuid | Yes | UUID of the server where this service will run. Obtain this from list_servers. | |
| type | No | Type of service to create. Required if docker_compose_raw is not provided. Cannot be used together with docker_compose_raw. |
Input Schema (JSON Schema)
{
"properties": {
"description": {
"description": "Optional description of the service's purpose or configuration",
"examples": [
"Node.js backend API service"
],
"type": "string"
},
"docker_compose_raw": {
"description": "Raw Docker Compose configuration for the service. Required if type is not provided. Cannot be used together with type.",
"examples": [
"version: '3.8'\nservices:\n web:\n image: nginx:alpine\n ports:\n - \"80:80\""
],
"type": "string"
},
"environment_name": {
"description": "Name of the environment (e.g., production, staging, development)",
"examples": [
"production"
],
"type": "string"
},
"environment_uuid": {
"description": "Optional UUID of an existing environment to use",
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
},
"name": {
"description": "A unique, human-readable name for the service",
"examples": [
"backend-api"
],
"type": "string"
},
"project_uuid": {
"description": "UUID of the project this service belongs to. Projects help organize related services.",
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
},
"server_uuid": {
"description": "UUID of the server where this service will run. Obtain this from list_servers.",
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
},
"type": {
"description": "Type of service to create. Required if docker_compose_raw is not provided. Cannot be used together with docker_compose_raw.",
"examples": [
"mysql",
"redis",
"postgresql",
"mongodb"
],
"type": "string"
}
},
"required": [
"name",
"server_uuid",
"project_uuid"
],
"type": "object"
}