ACacquia
Failover Groups

Retrieves a collection of failover groups.

Retrieves a collection of failover groups. Use the filter parameter to scope results by source environment.

Filter syntax:

  • By source environment: filter=environment_id:<id>
get/failover-groups

Request

Query parameters

offsetinteger
Example:20

The number of items to skip before starting to collect the result set.

limitinteger
Example:10

The maximum number of items to return per page.

filterstring

Filter the result set using field-based criteria. Format: field=value or field<operator>value Logical operators:

  • , (comma) - OR logic between filters
  • ; (semicolon) - AND logic between filters
  • Note: Cannot mix OR and AND operators in the same query Comparison operators:
  • = - Equals. This is the default comparison operator; : is accepted as a backward-compatible alias for =
  • != - Does not equal
  • > - Greater than
  • < - Less than
  • >= - Greater than or equal to
  • <= - Less than or equal to
  • =@ - Contains substring
  • !@ - Does not contain substring Wildcards:
  • * - Wildcard character for pattern matching Examples:
  • status=active - Filter by status equals active
  • name=@prod - Filter by name containing "prod"
  • status=active;type=standard - Status is active AND type is standard
  • status=active,status=pending - Status is active OR pending

Response

OK

countinteger required

The number of items in the current page

totalinteger required

The total number of items available

Example response

{
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources?filter=field=value*;field2=value2*"
    },
    "filter": {
      "href": "https://api.acquia.com/v3/resources{?filter}",
      "templated": true
    }
  },
  "_embedded": {
    "items": [
      {
        "id": "1",
        "name": "Resource 1",
        "_links": {
          "self": {
            "href": "https://api.acquia.com/v3/resources/1"
          }
        }
      },
      {
        "id": "2",
        "name": "Resource 2",
        "_links": {
          "self": {
            "href": "https://api.acquia.com/v3/resources/2"
          }
        }
      }
    ]
  }
}

Changes

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