---
title: "Get site instance details."
method: GET
path: "/site-instances/{siteId}.{environmentId}"
tags: ["Site Instances"]
---

# Get site instance details.

`GET /site-instances/{siteId}.{environmentId}`

## Request

- Base URL: `https://api.acquia.com/v3`
- URL: `https://api.acquia.com/v3/site-instances/{siteId}.{environmentId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/docs/site-instances/:siteId.:environmentId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `siteId` string, required
- `environmentId` string, required

## Response `200`

Site Instance details

- object: Site Instance properties
  - `site_id` string, required: The unique identifier of the site
  - `environment_id` string, required: The unique identifier of the environment
  - `status` 'active' | 'creating' | 'create-failed' | 'updating' | 'update-failed' | 'deleting' | 'deleted' | 'delete-failed', required: The current status of the site instance
  - `health_status` object, required: Health status information for the site instance
    - `code` string, required: Health status code
    - `summary` string, required: Summary of the health status
    - `details` string, required: Detailed health status information
  - `domains` object[], required: List of domains associated with the site instance. Each entry carries the same values as the corresponding domain read.
    - `name` string, required: The domain name.
    - `is_managed` boolean, required: Whether the domain is managed by Acquia. Carries the same value as the `is_managed` property of the domain reads, including when `type` is absent.
    - `type` 'custom' | 'environment-pattern' | 'codebase-pattern' | 'acquia' | 'launch-group': The type of the domain. Carries the same value space as the `type` property of the domain reads. Absent when the platform holds no recorded type for the domain, or reports one this API does not recognise.
  - `deployment_order` integer, nullable: The order in which this site instance is deployed relative to others.
  - `delete_at` string, date-time, nullable: The scheduled deletion date-time for this site instance, if set.
  - `date_marked_for_deletion` string, date-time, nullable: The date-time when this site instance was marked for deletion.
  - `deployed_vcs_ref` string: The VCS reference (e.g. branch or tag) that is currently deployed on this site instance.
  - `code_hash` string: The commit hash of the code currently deployed on this site instance.
  - `protection_mode` object, nullable: The current protection mode of the site instance
    - `is_enabled` boolean, required: Indicates whether the protection mode is enabled for the site instance
    - `is_inherited` boolean, required: Indicates whether the protection mode is inherited from the environment
  - `_links` object, required: HAL links for the resource
    - `self` EnvironmentServiceAPIHalLink, required: HAL link object
      - `href` union, required: The target URI of the link (can be a URI or URI template)
        - string, uri
        - string, uri-template
      - `templated` boolean: Whether the link is a URI template
      - `type` string: Hint about the media type expected when dereferencing the target resource
      - `deprecation` string: A URL to a resource that provides deprecation information
      - `name` string: A secondary key for selecting links
      - `profile` string: A URI that hints about the profile of the target resource
      - `title` string: A human-readable identifier for the link
      - `hreflang` string: The language of the target resource
  - `_embedded` object: Embedded resources (optional)

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api.md) - [All operations](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/revisions/508f8f94456d?raw)