Coolify icon

Coolify

Interact with Coolify to manage applications, services, databases, servers, deployments and more.

Server → Create

AI-generated

Summary

Create a new server in Coolify by specifying its connection details and configurations.

Inputs

  • Name (required) — The name of the server.
  • Description — A description for the server.
  • IP Address (required) — The IP address of the server.
  • Port — The SSH port of the server, defaulting to 22.
  • User — The SSH user of the server, default is 'root'.
  • Private Key (required) — The private key UUID used to establish the SSH connection.
  • Is Build Server — Flag indicating if this server is used for building applications, default is false.
  • Instant Validate — Flag to immediately validate the server connection after creation, default is false.
  • Proxy Type — The proxy type for the server, options are Traefik (default), Caddy, or None.

Output shape

a single JSON object representing the created server's details

The operation returns the created server data as a JSON object. Any errors during creation will be reported as failures.

Examples

Example 1: Create a server with required SSH connection information

Provide Server Name, IP Address, SSH Port if custom (default 22), SSH User if not root, select the Private Key by UUID, optionally mark as build server, choose proxy type, and optionally set instant validate.

Links

Discussion