---
title: "Retrieves a failover group by ID."
method: GET
path: "/failover-groups/{failoverGroupId}"
tags: ["Failover Groups"]
---

# Retrieves a failover group by ID.

`GET /failover-groups/{failoverGroupId}`

## Request

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

## Path parameters

- `failoverGroupId` string, required

## Response `200`

OK

- object
  - `id` string, required: Unique identifier for the failover group.
  - `name` string, required: The name of the failover group.
  - `status` 'creating' | 'normal' | 'failed-over' | 'failing-over' | 'error' | 'deleting' | 'deleted', required: The current status of the failover group.
  - `pairs` FailoverServiceAPIFailoverPair[], required: The list of failover pairs belonging to this failover group.
    - `service_name` string, required: The name of the service for this failover pair.
    - `primary_id` string, required: The ID of the primary resource in the failover pair.
    - `failover_id` string, required: The UUID of the failover resource in the failover pair.
  - `_links` object, required: HAL links for the resource
    - `self` FailoverServiceAPIHalLink, 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)