Skip to main content
POST
/
boxes
/
{boxId}
/
terminate
JavaScript
import GboxSDK from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});

async function main() {
  // Create a new Android box for demonstration purposes
	const boxId = (await gboxSDK.create({ type: "android" })).data.id;

  // Use the 'get' method to establish a connection to the box for interactions
  const box = await gboxSDK.get(boxId);

  // Terminate the box
  await box.terminate();

  console.log(`Box terminated: ${JSON.stringify(box.data.status)}`);
}

main();

Authorizations

Authorization
string
header
required

Enter your API Key in the format: Bearer <token>. Get it from https://gbox.ai

Path Parameters

boxId
string
required

Box ID

Example:

"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"

Body

application/json

Configuration for box operation waiting behavior

wait
boolean
default:true

Wait for the box operation to be completed, default is true

Example:

true

Response

200

terminate box success

I