create_server
Add a new server to Coolify by providing SSH access details and a private key for authentication, enabling deployment management.
Instructions
Create a new server in Coolify. Requires SSH access details and a private key for authentication.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| description | No | Optional description of the server's purpose or configuration | |
| instant_validate | No | Whether to validate the server configuration immediately after creation | |
| ip | Yes | IP address of the server. Can be IPv4 or IPv6. | |
| is_build_server | No | Whether this server should be used for building applications | |
| name | Yes | A unique, human-readable name for the server | |
| port | Yes | SSH port number | |
| private_key_uuid | Yes | UUID of the private key to use for SSH authentication. Obtain this from list_private_keys. | |
| proxy_type | No | Type of proxy to use for this server | nginx |
| user | Yes | SSH username for authentication |
Input Schema (JSON Schema)
{
"properties": {
"description": {
"description": "Optional description of the server's purpose or configuration",
"examples": [
"Main production server for customer-facing applications"
],
"type": "string"
},
"instant_validate": {
"default": true,
"description": "Whether to validate the server configuration immediately after creation",
"type": "boolean"
},
"ip": {
"description": "IP address of the server. Can be IPv4 or IPv6.",
"examples": [
"192.168.1.100"
],
"pattern": "^(?:[0-9]{1,3}.){3}[0-9]{1,3}$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$",
"type": "string"
},
"is_build_server": {
"default": false,
"description": "Whether this server should be used for building applications",
"type": "boolean"
},
"name": {
"description": "A unique, human-readable name for the server",
"examples": [
"production-server-1"
],
"type": "string"
},
"port": {
"default": 22,
"description": "SSH port number",
"examples": [
22
],
"maximum": 65535,
"minimum": 1,
"type": "number"
},
"private_key_uuid": {
"description": "UUID of the private key to use for SSH authentication. Obtain this from list_private_keys.",
"pattern": "^[a-zA-Z0-9]+$",
"type": "string"
},
"proxy_type": {
"default": "nginx",
"description": "Type of proxy to use for this server",
"enum": [
"none",
"nginx",
"caddy"
],
"type": "string"
},
"user": {
"description": "SSH username for authentication",
"examples": [
"root"
],
"type": "string"
}
},
"required": [
"name",
"ip",
"port",
"user",
"private_key_uuid"
],
"type": "object"
}