Reset a Sandbox Workspace

• Request Parameters

• Response

Resets the sandbox workspace associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.

JavaScript

Resets the sandbox workspace associated with the authentication value.

Code

await seam.workspaces.resetSandbox();

Output

{
  "action_attempt_id": "f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f",
  "action_type": "RESET_SANDBOX_WORKSPACE",
  "error": null,
  "result": {},
  "status": "success"
}

cURL

Resets the sandbox workspace associated with the authentication value.

Code

curl --include --request POST "https://connect.getseam.com/workspaces/reset_sandbox" \
  --header "Authorization: Bearer $SEAM_API_KEY"

Output

{
  "action_attempt": {
    "action_attempt_id": "f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f",
    "action_type": "RESET_SANDBOX_WORKSPACE",
    "error": null,
    "result": {},
    "status": "success"
  }
}

Python

Resets the sandbox workspace associated with the authentication value.

Code

seam.workspaces.reset_sandbox()

Output

ActionAttempt(
    action_attempt_id="f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f",
    action_type="RESET_SANDBOX_WORKSPACE",
    error=None,
    result={},
    status="success",
)

Ruby

Resets the sandbox workspace associated with the authentication value.

Code

seam.workspaces.reset_sandbox()

Output

{
  "action_attempt_id" => "f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f",
  "action_type" => "RESET_SANDBOX_WORKSPACE",
  "error" => nil,
  "result" => {
  },
  "status" => "success",
}

PHP

Resets the sandbox workspace associated with the authentication value.

Code

<?php
$seam->workspaces->reset_sandbox();

Output

<?php
[
    "action_attempt_id" => "f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f",
    "action_type" => "RESET_SANDBOX_WORKSPACE",
    "error" => null,
    "result" => [],
    "status" => "success",
];

Seam CLI

Resets the sandbox workspace associated with the authentication value.

Code

seam workspaces reset-sandbox

Output

{
  "action_attempt_id": "f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f",
  "action_type": "RESET_SANDBOX_WORKSPACE",
  "error": null,
  "result": {},
  "status": "success"
}

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

None

Response

action_attempt

JSON

{
  "action_attempt_id": "f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f",
  "action_type": "RESET_SANDBOX_WORKSPACE",
  "error": null,
  "result": {},
  "status": "success"
}