Odoo Instances

List all instances

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
get/instances

Request

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

Response

Instances retrieved successfully

idstring uuid

Unique identifier for the instance

parentIdstring uuid nullable

Parent instance ID (set on staging instances)

namestring

Instance name (typically used as database name)

domainstring

Primary domain name for the instance

aliasDomainsstring[]

Additional domain aliases for this instance

redirectDomainsstring[]

Domains that redirect to the primary domain

status'creating' | 'deleting' | 'error' | 'modifying' | 'started' | 'restarting' | 'stopped' | 'stopping'

Current instance status

serverIdstring uuid

ID of the server hosting this instance

Changes

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