---
title: "Create a new Odoo instance"
method: POST
path: "/instances"
tags: ["Odoo Instances"]
---

# Create a new Odoo instance

`POST /instances`

## Request

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

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.

## Request body

- object
  - `serverId` string, uuid: ID of the server where you want to create the instance (must be a valid UUID)
  - `backupId` string: Optional: ID of a backup to restore from
  - `instanceId` string, 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).
  - `config` object, required: Configuration settings for the new instance
    - `name` string, required: Name for your Odoo instance (will be used as database name)
    - `domain` string, required: Domain name where your instance will be accessible
    - `odoo_version` string: Version of Odoo to install (e.g., '16.0', '17.0'). Not required if restoring from backup.
  - `options` object: Additional options for instance creation
    - `admin_password` string: Custom admin password for the instance. If not provided, a secure password will be generated automatically.
    - `lang` string: Language code for the Odoo instance (e.g., 'en_US', 'fr_FR', 'de_DE', 'es_ES'). Defaults to 'en_US' if not specified.
    - `country` string: Country code in ISO 3166-1 alpha-2 format (e.g., 'US', 'FR', 'DE'). Sets the default country for the Odoo instance.
    - `external_database` object: Optional: External PostgreSQL database configuration. Allows connecting to an existing external database instead of using the server's local database. The database must already exist, be reachable from the server, and be completely empty. Note: The database name is taken from `config.name`.
      - `host` string, required: Hostname or IP address of the external PostgreSQL server
      - `port` integer, required: Port number of the external PostgreSQL server
      - `user` string, required: PostgreSQL username for authentication
      - `password` string, required: PostgreSQL password for authentication

## Response `200`

Instance creation started successfully

- object
  - `id` string
  - `status` string
  - `generatedPassword` string

## Other responses

- `400`: Invalid input data

---

[API](https://skmtc.dev/cloudpepper/apis/cloudpepper-api-docs.md) · [All operations](https://skmtc.dev/cloudpepper/apis/cloudpepper-api-docs/llms.txt) · [OpenAPI document](https://skmtc.dev/cloudpepper/apis/cloudpepper-api-docs/revisions/b6a59274cedc?raw)