Use the Instances API

Retrieve information about B2C Commerce instances. Instances represent specific environments (development, staging, production) within a realm and are identified by a unique combination of realm ID and tenant type.

To retrieve a paginated list of all instances available to your organization, send a GET request to /dw/rest/v1/instances. Use the pageable query parameter to control pagination. See the getInstances endpoint reference for complete details.

The response includes instances for all environments, including:

• Development environments
• Staging environments
• Production environments

To retrieve detailed information about a specific instance, send a GET request to /dw/rest/v1/instances/{instanceId}. See the getInstance endpoint reference for complete details.

The instance ID is typically in the format {realmId}_{tenantType} (for example, "aalm_prd").

Each instance includes these properties:

• id: Unique identifier of the instance.
• realmId: Realm identifier associated with the instance.
• tenantType: Type of tenant/instance (for example, "dev," "stg," "prd").
• description: Description of the instance.