---
title: "Add instance module"
method: POST
path: "/instances/{id}/modules"
tags: ["Instance Modules"]
---

# Add instance module

`POST /instances/{id}/modules`

## Request

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

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.

## Request body

- object
  - `repo` string, required: Repository URL or identifier for the module
  - `branch` string, required: Branch name of the repository to use
  - `type` 'git' | 'file': Module type (git or file)
  - `init` string: Module name to initialize (if different from repository name)

## Response `200`

Module installation initiated successfully

- Module
  - `id` string, uuid: Unique identifier for the module repository
  - `repo` string: Repository URL or identifier
  - `branch` string: Branch name being used
  - `dirs` string[], nullable: Specific directories used from the repository; null or ["*"] means the whole repository

## Other responses

- `404`: Instance not found

---

[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)