get_recovery_settings
Read one project's Disaster Recovery settings — automatic failover and its fee consent, how members are told after a swap, and whether a standby installation is kept.
Purpose
The switches the Prevention page holds per project. auto_failover_enabled says whether the platform may swap a banned channel for its standby on its own, and auto_failover_email_consented_at when the creator accepted the per-email fee that failover may charge; email_delivery says how members are told after a channel swap the creator ran (self: the creator tells them; platform: Subscriby emails them at the fee); standby_installation_registered whether a spare bot is kept. The payload is exactly what the REST endpoint returns. The REST twin is GET /v1/projects/{project}/recovery/settings.
Required ability
project-recovery:view
Input schema
{
"type": "object",
"required": [
"project_id"
],
"properties": {
"project_id": {
"type": "string",
"description": "UUID of the project."
}
}
}Output shape
{
"data": {
"project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
"auto_failover_enabled": true,
"auto_failover_email_consented_at": "2026-09-01T14:20:00Z",
"email_delivery": "platform",
"email_delivery_label": "Subscriby emails them",
"standby_installation_registered": true
},
"meta": {}
}Example prompts
"Is automatic failover on for Research Premium?"
"Do I keep a standby bot for that project?"
Failure modes
RESOURCE_NOT_FOUND—project_idis not a project the token can see.AUTHENTICATION_REQUIRED— no authenticated user on the request.TOKEN_MISSING_ABILITY— token lacksproject-recovery:view.
Related
update_recovery_settings— change them.- Recovery API
How is this guide?
get_recovery_roll_call
Read where the re-admission after one Disaster Recovery operation stands — how many members hold a fresh link, how many have joined, who is still outside, and whether a reminder may go out now.
get_resource_standby
Read the standby kept for one resource — its health, whether posts are mirrored into it, and when it was last probed and written to.