/v1/admin/control-backup

GET /v1/admin/control-backup

Signer fingerprint, freeze state, bundles, recent runs and redacted settings

operationId

getControlBackupStatus

认证

• 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

响应

失败时怎么办

• 401 检查凭据格式、是否过期或被轮换。
• 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表

POST /v1/admin/control-backup/backups

Queue an immediate backup

operationId

requestControlBackup

认证

• 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

响应

失败时怎么办

• 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表

DELETE /v1/admin/control-backup/backups/{backup_id}

Queue deletion of a bundle and its remote copies; body confirm must equal backup_id

operationId

deleteControlBackup

认证

• 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

参数

响应

失败时怎么办

• 400 按字段说明修正参数或请求体再发；不要原样重试。

↑ 回到列表

GET /v1/admin/control-backup/backups/{backup_id}/restore-commands

Text commands to restore a bundle onto an empty host (nothing is executed)

operationId

getControlBackupRestoreCommands

认证

• 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

参数

响应

↑ 回到列表

POST /v1/admin/control-backup/host-key

Read an SSH host key fingerprint to pin before a migration

operationId

fetchControlBackupHostKey

认证

• 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

响应

↑ 回到列表

POST /v1/admin/control-backup/migrations

Queue a migration to an empty new host; confirm must equal host. This control plane stays frozen after success.

operationId

requestControlMigration

认证

• 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

响应

失败时怎么办

• 400 按字段说明修正参数或请求体再发；不要原样重试。
• 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表

POST /v1/admin/control-backup/recovery-kit

Download the backup identity sealed with a passphrase (scrypt) for off-host disaster recovery

operationId

exportControlBackupRecoveryKit

认证

• 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

响应

失败时怎么办

• 400 按字段说明修正参数或请求体再发；不要原样重试。

↑ 回到列表

GET /v1/admin/control-backup/runs/{run_id}

One agent run with its redacted log

operationId

getControlBackupRun

认证

• 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

参数

响应

失败时怎么办

• 404 资源不存在或不属于当前租户。

↑ 回到列表

PUT /v1/admin/control-backup/settings

Replace schedule, retention and off-host targets

operationId

putControlBackupSettings

认证

• 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

说明（契约原文）

expected_revision must equal settings.revision of the status read (409 control_backup_revision_conflict otherwise). Each target names the saved target it edits in stored_name (absent for a new target, which never inherits stored secrets). Empty secret fields keep the stored value of stored_name; for SFTP only while auth stays the same: a changed auth without a matching new credential is 400 control_backup_auth_changed, and a credential that does not fit auth is 400 control_backup_invalid_private_key / control_backup_invalid_password, with error.details {target, field}.

响应

失败时怎么办

• 400 按字段说明修正参数或请求体再发；不要原样重试。
• 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表

POST /v1/admin/control-backup/targets/probe

Write, read back and delete a probe object on the target as on screen (nothing is saved)

operationId

probeControlBackupTarget

认证

• 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

说明（契约原文）

Body {expected_revision, target}. target is merged over the stored settings exactly as a save would (same stored_name and credential rules), then probed.

响应

失败时怎么办

• 400 按字段说明修正参数或请求体再发；不要原样重试。
• 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表