set_resource_standby_mirror

Switch the live mirror into a resource's standby on or off, so a failover lands members in a channel that already holds the content.

Purpose

When on, every post made in the channel is copied into the standby as it is made. Only a channel can be mirrored (a group cannot), the resource must keep a standby, switching on needs the Growth plan, and only the project owner may do it. Returns the standby as it now stands. The REST twin is PATCH /v1/projects/{project}/resources/{resource}/standby.

Required ability

project-recovery:update

Input schema

{
    "type": "object",
    "required": [
        "resource_id",
        "mirror"
    ],
    "properties": {
        "resource_id": {
            "type": "string",
            "description": "UUID of the resource whose standby to mirror into."
        },
        "mirror": {
            "type": "boolean",
            "description": "True to copy every post into the standby, false to stop."
        }
    }
}

Output shape

{
    "data": {
        "resource_id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6",
        "mirror_enabled": true,
        "health_status": "healthy",
        "health_status_label": "Healthy",
        "health_reason": null,
        "health_checked_at": "2026-09-12T02:00:00Z",
        "last_mirrored_at": "2026-09-12T01:45:12Z",
        "linked_at": "2026-09-01T14:22:09Z"
    },
    "meta": {}
}

Example prompts

"Start mirroring Signals into its standby."

Failure modes

  • VALIDATION_FAILED — a group, no standby, the plan lacks the prevention features, or the token is not the project owner's.
  • RESOURCE_NOT_FOUNDresource_id is not a resource the token can see.
  • AUTHENTICATION_REQUIRED — no authenticated user on the request.
  • TOKEN_MISSING_ABILITY — token lacks project-recovery:update.

How is this guide?

On this page

Subscriby is a product designed by you — for you.

No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request