Resume box - ascii

POST

boxes

{boxId}

resume

Resume box

curl --request POST \
  --url https://ascii.dev/api/box/v1/boxes/{boxId}/resume \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "env": {},
  "environment": "<string>",
  "noEnv": true,
  "ttlSeconds": 1296000
}
'

import requests

url = "https://ascii.dev/api/box/v1/boxes/{boxId}/resume"

payload = {
    "env": {},
    "environment": "<string>",
    "noEnv": True,
    "ttlSeconds": 1296000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({env: {}, environment: '<string>', noEnv: true, ttlSeconds: 1296000})
};

fetch('https://ascii.dev/api/box/v1/boxes/{boxId}/resume', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ascii.dev/api/box/v1/boxes/{boxId}/resume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'env' => [
        
    ],
    'environment' => '<string>',
    'noEnv' => true,
    'ttlSeconds' => 1296000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ascii.dev/api/box/v1/boxes/{boxId}/resume"

	payload := strings.NewReader("{\n  \"env\": {},\n  \"environment\": \"<string>\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 1296000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://ascii.dev/api/box/v1/boxes/{boxId}/resume")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"env\": {},\n  \"environment\": \"<string>\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 1296000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ascii.dev/api/box/v1/boxes/{boxId}/resume")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"env\": {},\n  \"environment\": \"<string>\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 1296000\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "type": "box.resuming",
  "id": "bx_23456789",
  "status": "resuming",
  "box": {
    "id": "bx_23456789",
    "name": "Box 2026-05-31 12:00",
    "state": "provisioning",
    "desktopAvailable": false,
    "snapshotAvailable": true
  }
}

{
  "ok": false,
  "type": "box.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

boxId

string

required

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

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Body

application/json

Options for resuming a stopped Box.

type

enum<string>

Resume onto a different machine size. Omit to keep the box's current type. A resume already restores onto a fresh machine, so changing size costs nothing extra. Shrinking is rejected with type_too_small when the box's data would not fit the smaller disk.

Available options:

small,

default,

large

env

object

Replaces the box's per-box environment variables. Omit to keep the box's current env. Same validation rules as CreateBoxRequest.env.

Show child attributes

environment

string

Optionally re-pin the box to a different named Box environment on resume. Omit to keep the box's current environment. Unknown names are rejected with unknown_environment.

Examples:

"base"

"customer-demos"

noEnv

boolean

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.

ttlSeconds

integer | null

Auto-stop for the resumed Box, in seconds, stored on the Box. Omit to keep the TTL the Box already had. null disables auto-stop, which means nothing will ever stop this Box for you.

Required range: 1 <= x <= 2592000

Response

Resume started.

boolean

required

Example:

true

type

string

required

Stable success envelope discriminator added by v1.

Example:

"box.stopping"

string

required

status

string

required

Example:

"archiving"

box

object | null

Show child attributes

Resume box

curl --request POST \
  --url https://ascii.dev/api/box/v1/boxes/{boxId}/resume \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "env": {},
  "environment": "<string>",
  "noEnv": true,
  "ttlSeconds": 1296000
}
'

import requests

url = "https://ascii.dev/api/box/v1/boxes/{boxId}/resume"

payload = {
    "env": {},
    "environment": "<string>",
    "noEnv": True,
    "ttlSeconds": 1296000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({env: {}, environment: '<string>', noEnv: true, ttlSeconds: 1296000})
};

fetch('https://ascii.dev/api/box/v1/boxes/{boxId}/resume', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ascii.dev/api/box/v1/boxes/{boxId}/resume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'env' => [
        
    ],
    'environment' => '<string>',
    'noEnv' => true,
    'ttlSeconds' => 1296000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ascii.dev/api/box/v1/boxes/{boxId}/resume"

	payload := strings.NewReader("{\n  \"env\": {},\n  \"environment\": \"<string>\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 1296000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://ascii.dev/api/box/v1/boxes/{boxId}/resume")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"env\": {},\n  \"environment\": \"<string>\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 1296000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ascii.dev/api/box/v1/boxes/{boxId}/resume")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"env\": {},\n  \"environment\": \"<string>\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 1296000\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "type": "box.resuming",
  "id": "bx_23456789",
  "status": "resuming",
  "box": {
    "id": "bx_23456789",
    "name": "Box 2026-05-31 12:00",
    "state": "provisioning",
    "desktopAvailable": false,
    "snapshotAvailable": true
  }
}

{
  "ok": false,
  "type": "box.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}