Deprovision a Computer Agent

Removes the shared Computer used by the selected Agent and stops Computer access for every Agent assigned to it. By default saved state is preserved so it can be provisioned again later. Permanent removal first requires a successful recent safety backup.

OpenAPI

````yaml post /api/v2/computer/accounts/{targetAccountId}/deprovision
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}/deprovision:
post:
tags:
- Computer Agents
summary: Deprovision a Computer Agent
description: >
Removes the shared Computer used by the selected Agent and stops
Computer access for every Agent assigned to it. By default saved state
is preserved so it can be provisioned again later. Permanent removal
first requires a successful recent safety backup.
operationId: lifecyclePostDeprovision
parameters:
- name: targetAccountId
in: path
required: true
description: ''
schema:
type: string
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
wipeState:
type: boolean
default: false
description: >
Permanently delete the Computer Agent's saved state after
its safety backup. Use only when the user explicitly
requests a fresh start.
responses:
'200':
description: The shared Computer was deprovisioned
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token

````