Stop, restart or set updates

PATCH
/v1/installs/{install}

Stops the package (your own off switch), starts it again, or changes whether updates install by themselves. A package VoiceLayer stopped for abuse stays stopped until VoiceLayer lifts it; the answer says why.

Requires an API key with the workspace:write scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Path Parameters

install*string

The install id from GET /v1/installs.

Request Body

application/json
  1. body
updateMode?string

manual or automatic.

Value in"manual""automatic"
state?string

stopped to stop the package, active to start it again.

Value in"active""stopped"
note?string

Why you are stopping it (recorded; up to 500 characters).

Lengthlength <= 500

Response Body

The install after the change

application/json
  1. response
id*string
Formatuuid
packageId*string
kind*string
Value in"connector""tool-set""agent-template""mcp-server""plugin"
publisherWorkspaceId*string
versionId*string
label*string
state*string
Value in"active""stopped"
updateMode*string
Value in"manual""automatic"
summary*
consentedBy*string
consentedAt*string
Formatdate-time
notice*|null
pendingUpdate*|null
sizeClass*string
Value in"small""medium""large"
warmCount*integer
screens*boolean
Example Request
curl -X PATCH "https://api.vlayers.ai/v1/installs/$INSTALL_ID" \  -H "Authorization: Bearer $VOICELAYER_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "state": "stopped",    "note": "Paused while we review it."  }'
Example Response
{  "id": "0192f5c3-7a8b-7c9d-8e1f-3a4b5c6d7e89",  "packageId": "com.example/orders-panel",  "kind": "tool-set",  "publisherWorkspaceId": "org_publisher",  "versionId": "0192f5c1-5e6f-7a8b-9c0d-1e2f3a4b5c67",  "label": "com.example/[email protected]",  "state": "stopped",  "updateMode": "manual",  "summary": {    "lines": [      {        "section": "hosts",        "key": "host:api.example.com",        "text": "It can send data to api.example.com."      }    ],    "hash": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"  },  "consentedBy": "user_2abc",  "consentedAt": "2026-10-20T15:04:05.000Z",  "notice": {    "by": "customer",    "reason": "Paused while we review it.",    "at": "2026-10-20T15:04:05.000Z",    "reportId": null  },  "pendingUpdate": null,  "sizeClass": "small",  "warmCount": 1,  "screens": false}