Server Info

Create a new server

Creates a new server for hosting Odoo instances. This endpoint provisions a cloud server or sets up a custom SSH server with the necessary infrastructure to run Odoo applications. The server will be prepared with all required system dependencies, security configurations, and monitoring tools.

Key Parameters:

  • type: The cloud provider to use (e.g., 'cloudpepper', 'digitalocean', 'vultr', 'aws', 'linode', 'custom')
  • region: Datacenter location identifier (varies by provider, not required for custom servers)
  • plan/size/instanceType: Server resources specification (name varies by provider, not required for custom servers)
  • config.odoo_version: Version of Odoo to install (e.g., '16.0', '17.0')
  • ssh: SSH configuration object (required only for custom servers)

Custom SSH Server Requirements:

  • Must be a clean Linux installation (amd64 architecture)
  • Supported operating systems:
    • Debian 13 Trixie (for Odoo 19.0)
    • Debian 12 Bookworm (for Odoo 16.0, 17.0, 18.0)
    • Debian 11 Bullseye (for Odoo 13.0, 14.0, 15.0)
    • Debian 10 Buster (for Odoo 11.0, 12.0)
    • Ubuntu 26.04 LTS (planned for Odoo 20.0)
    • Ubuntu 24.04 LTS (for Odoo 18.0, 19.0)
    • Ubuntu 22.04 LTS (for Odoo 14.0, 15.0, 16.0, 17.0)
    • Ubuntu 20.04 LTS (for Odoo 12.0, 13.0)
  • User must have sudo privileges
  • SSH access must be available
  • User cannot be 'odoo' (reserved for Odoo installation)

NOTE: Server provisioning runs asynchronously. After receiving a 200 response, the server will continue setting up in the background. The process typically takes 5-10 minutes to complete for cloud providers, or 10-15 minutes for custom SSH servers. You can check the server status using the server management endpoints.

post/servers

Request

  • Base URL: https://api.cloudpepper.io
  • URL: https://api.cloudpepper.io/servers
  • Auth: HTTP bearer

Query parameters

venv'true' | 'false'

Whether to use a virtual environment for Odoo

Request body

OR
OR
OR
OR
OR

Example request

{
  "ssh": {
    "host": "192.168.1.100",
    "port": 22,
    "user": "root",
    "auth_type": "password",
    "password": "your_secure_password",
    "private_key": "-----BEGIN OPENSSH PRIVATE KEY-----\n[private key content]\n-----END OPENSSH PRIVATE KEY-----"
  },
  "config": {
    "odoo_version": "17.0"
  }
}

Response

Server creation initiated successfully

idstring uuid

Unique identifier for the newly created server

Changes

No recorded changes to this operation across all 1 revision of this API.