Restore a Computer Agent backup
Starts an asynchronous restore from a selected backup and returns a job for tracking its progress. Restoring replaces the Computer Agent's current data. The Computer Agent is stopped and restarted automatically. Read the available backups first and poll the returned restore job until it finishes.
OpenAPI
````yaml post /api/v2/computer/accounts/{targetAccountId}/restore
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/computer/accounts/{targetAccountId}/restore:
post:
tags:
- Computer Agents
summary: Restore a Computer Agent backup
description: >
Starts an asynchronous restore from a selected backup and returns a job
for tracking its progress. Restoring replaces the Computer Agent's
current data. The Computer Agent is stopped and restarted automatically.
Read the available backups first and poll the returned restore job until
it finishes.
operationId: backupsPostRestore
parameters:
- name: targetAccountId
in: path
required: true
description: ''
schema:
type: string
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
snapshotId:
type: string
description: >-
Backup snapshot to restore. Omit to restore the latest
available snapshot.
delete:
type: boolean
description: >
When true, also removes local files that are not present in
the selected backup. Send false unless the user explicitly
wants an exact replacement.
responses:
'202':
description: Restore was accepted
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
