Skip to main content
POST
Stop the session

Authorizations

Authorization
string
header
required

An API key from your Devic console, sent as Authorization: Bearer <key>. An embedded front end sends a tenant-session token instead, so no API key reaches the browser, and an OAuth integration sends its access token. Missing, invalid or expired credentials get a 401. See Authentication.

Path Parameters

environmentId
string
required

Environment id

Body

application/json
sandboxId
string
required

Sandbox to stop

saveChanges
boolean

Save the filesystem into the environment snapshot before stopping (default true, and a no-op when snapshots are disabled).

force
boolean

Overwrite the snapshot even if another session replaced it while this one was open.

Response

Success