---
title: "Switch a standby's live mirror"
method: PATCH
path: "/v1/projects/{project}/resources/{resource}/standby"
tags: ["Disaster Recovery"]
---

# Switch a standby's live mirror

`PATCH /v1/projects/{project}/resources/{resource}/standby`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/resources/{resource}/standby`
- Auth: HTTP bearer

```bash
curl -X PATCH https://api.subscriby.net/v1/projects/$PROJECT_ID/resources/$RESOURCE_ID/standby \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"mirror": true}'
```

Switches the live mirror on or off: when on, every post made in the channel is copied into the standby as it is made. Only a channel can be mirrored, and switching on needs the Growth plan. Answers `200` with the standby.

## Path parameters

- `project` string, uuid, required
- `resource` string, uuid, required

## Headers

- `Idempotency-Key` string, uuid, required

## Request body

- UpdateResourceStandbyRequest: The one switch a resource's standby carries.
  - `mirror` boolean, required: Whether every post made in the channel is copied into the standby as it is made. Only a channel can be mirrored, and switching on needs the Growth plan.

## Response `200`

200 with the standby, updated.

- object
  - `data` ResourceStandbyResource, required: The standby space kept ready for one resource: whether it is healthy and mirrored, and when it was last probed and written to. Its identifier on the platform stays out.
    - `resource_id` string, required: The resource the standby is kept for.
    - `mirror_enabled` boolean, required: Whether every post made in the channel is copied into the standby as it is made.
    - `health_status` string, required: `healthy`, `degraded` or `detached`, as the last probe found it; null before the first probe.
    - `health_status_label` 'Healthy' | 'Degraded' | 'Detached', required: The status in the creator's language.
    - `health_reason` string, nullable, required: The connector's code for a degraded or detached standby, such as `chat_not_found`, `bot_removed`, `bot_not_administrator`, `bot_missing_rights` or `connector_api_error`; null while healthy.
    - `health_checked_at` string, nullable, required: When the standby was last probed, ISO 8601; null before the first probe.
    - `last_mirrored_at` string, nullable, required: When a post was last copied into the standby, ISO 8601; null if never.
    - `linked_at` string, required: When the standby was linked, ISO 8601.

## Other responses

- `400`: `IDEMPOTENCY_KEY_MISSING`: every write needs an `Idempotency-Key` header. Send a fresh UUID per distinct operation.
- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `409`: `IDEMPOTENCY_KEY_REUSED`: the key was already used in the last 24 hours with a different request body.
- `422`: `VALIDATION_FAILED`: the payload broke a rule, and `error.fields` maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with `error.message` saying why and no `fields`. On this endpoint: `VALIDATION_FAILED`: for a group, a resource without a standby, a plan without the feature, or a caller who is not the project owner.
- `425`: `IDEMPOTENCY_REPLAY_IN_PROGRESS`: the first request with this key is still running; retry in a few seconds and the original response is replayed.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)