---
title: "List all instances"
method: GET
path: "/instances"
tags: ["Odoo Instances"]
---

# List all instances

`GET /instances`

## Request

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

Retrieves a list of all Odoo instances in your account. This endpoint returns basic information about each instance, including identifiers, domain names, and current status. This data can be used for monitoring your Odoo deployments or integrating with other systems.

**Returns Information About:**
- Instance IDs and names
- Domain configuration including primary domain and aliases
- Current operational status
- Relationships between instances (parent/staging)
- Server assignment via serverId

## Response `200`

Instances retrieved successfully

- Instance[]
  - `id` string, uuid: Unique identifier for the instance
  - `parentId` string, uuid, nullable: Parent instance ID (set on staging instances)
  - `name` string: Instance name (typically used as database name)
  - `domain` string: Primary domain name for the instance
  - `aliasDomains` string[]: Additional domain aliases for this instance
  - `redirectDomains` string[]: Domains that redirect to the primary domain
  - `status` 'creating' | 'deleting' | 'error' | 'modifying' | 'started' | 'restarting' | 'stopped' | 'stopping': Current instance status
  - `serverId` string, uuid: ID of the server hosting this instance

## Other responses

- `403`: Insufficient permissions (requires admin privileges)

---

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