47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
---
|
|
name: dr-routes
|
|
description: Handle 4 OpenAPI operation(s) under /api/v1/dr for the dr route group.
|
|
---
|
|
|
|
# dr API Routes
|
|
|
|
Handle 4 OpenAPI operation(s) under /api/v1/dr for the dr route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### start_org_failback
|
|
|
|
- Operation ID: `start_org_failback`
|
|
- Route: `POST /api/v1/dr/failback`
|
|
- Mode: WRITE
|
|
- Summary: Start the failback of your org
|
|
- Body: JSON request body accepted.
|
|
|
|
### start_org_failover
|
|
|
|
- Operation ID: `start_org_failover`
|
|
- Route: `POST /api/v1/dr/failover`
|
|
- Mode: WRITE
|
|
- Summary: Start the failover of your org
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_dr_status
|
|
|
|
- Operation ID: `get_dr_status`
|
|
- Route: `GET /api/v1/dr/status`
|
|
- Mode: READ
|
|
- Summary: Retrieve the disaster recovery status for all domains
|
|
|
|
### get_dr_status_for_domain
|
|
|
|
- Operation ID: `get_dr_status_for_domain`
|
|
- Route: `GET /api/v1/dr/status/{domain}`
|
|
- Mode: READ
|
|
- Summary: Retrieve the disaster recovery status for a domain
|
|
- Parameters:
|
|
- `domain` in `path` required
|