Servers

Create

Changed on

Create Server.

post/servers

Request

  • Base URL: https://app.coolify.io/api/v1
  • URL: https://app.coolify.io/api/v1/servers
  • Auth: HTTP bearer

Request body

namestring

The name of the server.

descriptionstring

The description of the server.

ipstring

The IP of the server.

portinteger

The port of the server.

userstring

The user of the server.

private_key_uuidstring

The UUID of the private key.

server_role'deployment' | 'build' | 'both'

Server role.

is_build_serverboolean

Deprecated: use server_role instead. true sets server_role to build, false sets it to both. Must not conflict with server_role.

instant_validateboolean

Instant validate.

proxy_type'traefik' | 'caddy' | 'none'

The proxy type.

Example request

{
  "name": "My Server",
  "description": "My Server Description",
  "ip": "127.0.0.1",
  "port": 22,
  "user": "root",
  "private_key_uuid": "og888os",
  "server_role": "both",
  "proxy_type": "traefik"
}

Response

Server created.

uuidstring

The UUID of the server.

Example response

{
  "uuid": "og888os"
}

Changes