---
title: "List"
method: GET
path: "/backends/failover"
tags: ["FailoverBackends"]
---

# List

`GET /backends/failover`

List all Failover backends on this account

## Query parameters

- `before_id` string
- `limit` string

## Headers

- `ngrok-version` integer, required

## Response `200`

List all Failover backends on this account

- FailoverBackendList
  - `backends` FailoverBackend[] — the list of all Failover backends on this account
    - `id` string — unique identifier for this Failover backend
    - `uri` string — URI of the FailoverBackend API resource
    - `created_at` string — timestamp when the backend was created, RFC 3339 format
    - `description` string — human-readable description of this backend. Optional
    - `metadata` string — arbitrary user-defined machine-readable data of this backend. Optional
    - `backends` string[] — the ids of the child backends in order
  - `uri` string — URI of the Failover backends list API resource
  - `next_page_uri` string — URI of the next page, or null if there is no next page

## Other responses

- `4XX` — An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.
- `5XX` — An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.

---

[API](https://skmtc.dev/ngrok/apis/ngrok-openapi.md) · [All operations](https://skmtc.dev/ngrok/apis/ngrok-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ngrok/ngrok-openapi/revisions/c697539ac350/schema)