Box

Resume box

post/boxes/{boxId}/resume

Request

Base URL
https://ascii.dev/api/box/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ascii/apis/box-public-api-v1/docs/boxes/:boxId/resume/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

boxIdstring required

Public Box id returned by create/list/get box calls.

Request body

noEnvboolean

Resume into a no-env box: withhold account secrets and scrub inherited owner secrets from the restored snapshot before the box is exposed. One-way; once a box is resumed as no-env it stays no-env on later resumes.

Response

Resume started.

okboolean required

typestring required

Stable success envelope discriminator added by v1.

idstring required

statusstring required

Example response

{
  "ok": true,
  "type": "box.stopping",
  "status": "archiving",
  "box": {
    "id": "bx_23456789",
    "name": "Box 2026-05-31 12:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.