Instance Modules

Add instance module

Adds a new module to an Odoo instance. This is a Git repository module. The module will be installed on the specified instance. This endpoint allows you to extend your Odoo instance with custom or third-party modules. The installation process is managed asynchronously, and you can track the module status within the UI.

Key Parameters:

  • id: Instance id to which you want to add the module.
  • repo: Repository URL or identifier for the module (e.g., 'https://github.com/OCA/web.git')
  • branch: Branch name of the repository to use (e.g., '16.0', '17.0')
  • type: Module type ('git' or 'file') - defaults to 'git' if not specified
  • init: Optional module name to initialize if different from repository name

NOTE: All pre-fill values are examples and should be replaced with actual data. You can leave optional fields empty if you don't need them.

post/instances/{id}/modules

Request

  • Base URL: https://api.cloudpepper.io
  • URL: https://api.cloudpepper.io/instances/{id}/modules
  • Auth: HTTP bearer

Request body

repostring required

Repository URL or identifier for the module

branchstring required

Branch name of the repository to use

type'git' | 'file'

Module type (git or file)

initstring

Module name to initialize (if different from repository name)

Example request

{
  "repo": "https://github.com/OCA/web.git",
  "branch": "16.0",
  "type": "git",
  "init": "web_enterprise"
}

Response

Module installation initiated successfully

idstring uuid

Unique identifier for the module repository

repostring

Repository URL or identifier

branchstring

Branch name being used

dirsstring[] nullable

Specific directories used from the repository; null or ["*"] means the whole repository

Changes

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