Odoo Instances

Create a new Odoo instance

Creates a new Odoo instance on your server. This simple process lets you set up a complete Odoo environment with just a few clicks. You can choose to create a fresh installation or restore from an existing backup. The system will handle all the technical details of provisioning, configuring, and launching your new Odoo instance.

Key Parameters:

  • serverId: The ID of the server where you want to create the instance (must be a valid UUID)
  • backupId: Optional ID of a backup to restore from
  • instanceId: Optional ID of an existing instance to clone as a staging/test environment
  • config.name: Name for your Odoo instance (will be used as database name). Can differ from the domain name.
  • config.domain: Domain name where your instance will be accessible
  • config.odoo_version: Version of Odoo to install (e.g., '16.0', '17.0', '18.0', '19.0', '20.0')
  • options.admin_password: Custom admin password (if not provided, a secure password will be generated)
  • options.lang: Language code for the Odoo instance (e.g., 'en_US', 'fr_FR', 'de_DE', 'hi_IN')
  • options.country: Country code in ISO 3166-1 alpha-2 format (e.g., 'US', 'FR', 'DE', 'IN')
  • options.external_database: Optional external PostgreSQL database configuration. The external database must already exist, be reachable from the server, and be completely empty. When using an external database, config.name will be used as the database name.

NOTE: All pre-fill values are examples and should be replaced with actual data. Please remove the optional fields completely if you don't need them.

post/instances

Request

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

Request body

serverIdstring uuid

ID of the server where you want to create the instance (must be a valid UUID)

backupIdstring

Optional: ID of a backup to restore from

instanceIdstring uuid

Optional: ID of an existing instance to clone. Used to create staging/test environments. The new instance will be a copy of the specified instance with staging-specific configurations applied (e.g., mailhog enabled, workers disabled, database neutralized).

Example request

{
  "serverId": "550e8400-e29b-41d4-a716-446655440000",
  "backupId": "7a1b3cd4-e5f6-7g8h-9i0j-1k2l3m4n5o6p",
  "instanceId": "019c8e50-fa32-74e0-83d2-102756725a13",
  "config": {
    "name": "mycompany",
    "domain": "mycompany.example.com",
    "odoo_version": "17.0"
  },
  "options": {
    "admin_password": "MySecureP@ssw0rd!",
    "lang": "en_US",
    "country": "US",
    "external_database": {
      "host": "db.example.com",
      "port": 5432,
      "user": "dbadmin",
      "password": "your_database_password"
    }
  }
}

Response

Instance creation started successfully

idstring
statusstring
generatedPasswordstring

Example response

{
  "id": "019808ae-ecdb-73bf-8bf9-0db4cb5c31da",
  "status": "ok",
  "generatedPassword": "null"
}

Changes

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