Environments

Retrieves the multi-region failover status for an environment.

get/environments/{environmentId}/multi-region-failover

Request

Base URL
https://api.acquia.com/v3
Auth
HTTP bearer
TypeScript
https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/docs/environments/:environmentId/multi-region-failover/get.ts
A function with typed inputs. Its response is checked against the schema.

environmentIdstring required

Unique identifier for the environment.

is_enabledboolean required

Whether multi-region failover is enabled for the environment.

failover_group_idstring

The identifier of the failover group associated with the environment.

is_traffic_failed_overboolean

Whether traffic has been failed over to the secondary region.

_embeddedobject

Embedded resources (optional)

{
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources/1"
    }
  }
}

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