deletesandbox.do

The deletesandbox.do call deletes the specified sandbox.

Before using this API, Veracode strongly recommends that you read API usage and access guidelines. Ensure you access the APIs with the domain for your region.

REST API equivalent

The REST API equivalent of this call is a DELETE to /appsec/v1/applications/{applicationGuid}/sandboxes/{sandboxGuid} using the Development Sandbox API. Veracode strongly recommends that you use the REST API for this action. For new integrations, always use the REST APIs.

Resource URL

https://analysiscenter.veracode.com/api/5.0/deletesandbox.do

The deletesandbox.do call deletes a sandbox and its contents. You cannot undo the deletion.

Permissions

An API service account requires the Upload and Scan role to use this call. A user account requires the Creator, Security Lead, or Sandbox Administrator role to use this call. If you have delete permission, you do not have to own the sandbox to delete it. If you are a team-restricted user, you can only delete sandboxes that your teams own.

Parameters

Name	Type	Description
sandbox_id Required	Integer	ID of the target sandbox.

HTTPie example

Examples use the HTTPie command-line tool.

http --auth-type=veracode_hmac "https://analysiscenter.veracode.com/api/5.0/deletesandbox.do" "sandbox_id==1554802"

HTTPie results

The deletesandbox.do call returns the deletesandboxresult XML document, which references the deletesandboxresult.xsd schema file. You can use the XSD schema file to validate the XML data.

<?xml version="1.0" encoding="UTF-8"?>

<deletesandboxresult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns="https://analysiscenter.veracode.com/schema/deletesandboxresult" 
  xsi:schemaLocation="https://analysiscenter.veracode.com/schema/deletesandboxresult.xsd" 
  account_id="28823" app_id="61230" sandbox_id="1554802">
    <result>success</result>
</deletesandboxresult>