updatesandbox.do

APIs

The updatesandbox.do call enables you to amend an existing sandbox in the application profile.

Before using this API, Veracode strongly recommends that you read API Usage and Access Guidelines.

Permissions

You must have the Creator, Security Lead, or Sandbox Administrator API role to be able to use this API call.

Resource URL

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

Parameters

sandbox_id Integer. Required.
custom_field_name String. Required. Specifies the custom field that the custom_field_value changes. It is only possible to input one field per update call. You have to call updatesandbox.do for each custom field that you have.
custom_field_value String. Required. The value of the custom field that the custom_field_name specifies. It is only possible to input one field per update call. You have to call updatesandbox.do for each custom field that you have.

Example

curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/updatesandbox.do -F "sandbox_id=10886" -F
          "custom_field_name=Custom 2" -F "custom_field_value=mycustomvalue"

Results

The updatesandbox.do call returns the sandboxinfo XML document, which references the sandboxinfo.xsd. Additional sandboxinfo.xsd schema documentation is available. Use the XSD file to validate the XML data. The following is an example of the returned XML.
<?xml version="1.0" encoding="UTF-8"?>
<sandboxinfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://analysiscenter.veracode.com/schema/5.0/sandboxinfo" xsi:schemaLocation="https://analysiscenter.veracode.com/schema/5.0/sandboxinfo https://analysiscenter.veracode.com/resource/5.0/sandboxinfo.xsd" sandboxinfo_version="1.2" account_id="11111" app_id="12345">
<sandbox sandbox_id="10886" sandbox_name="MySandbox" sandbox_status="sandbox" owner="veracode" modified_date="2015-05-01T13:07:54-04:00" created_date="2015-05-01T13:07:54-04:00">
<customfield name="Custom 1" value=""/>
<customfield name="Custom 2" value="something"/>
<customfield name="Custom 3" value=""/>
<customfield name="Custom 4" value=""/>
<customfield name="Custom 5" value=""/>
</sandbox>
<sandboxinfo>