updateapp.do

Veracode APIs

The updateapp.do call modifies the settings of an existing application in the portfolio.

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

Resource URL

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

Parameters

Name Type Description
app_id

Required

 Integer Application ID.
app_name String Changes the application name.
description String Changes the application description.
business_criticality String (case-sensitive) Matches the names of the business criticality enums:
  • Very High
  • High
  • Medium
  • Low
  • Very Low
You cannot change this value for applications that a vendor shares with your account.
policy String (case-sensitive) Validates against the names of existing policies for this account. You cannot change this value for applications that a vendor shares with your account.

Default is the policy set as default for the business_criticality parameter.
business_unit String (case-sensitive) Validates against the names of existing business units for this account.
business_owner String Name of the business owner for the application.
business_owner_email String Email address for the business owner of the application.
teams String (case-sensitive) Comma-separated list of team names. Validates against the names of existing teams for this account.
origin String (case-sensitive) Validates against the names of the Origin enums:
  • 3rd party library
  • Purchased Application
  • Contractor
  • Internally Developed
  • Open Source
  • Outsourced Team
Default is Not Specified.
industry String (case-sensitive) Validates against the names of the Industry enums. See industry Parameter Values. Defaults to the same industry as the account.
app_type String (case-sensitive) Validates against the names of the Application Purpose enums. See app_type Parameter Values. Defaults to Not Specified.
deployment_method String (case-sensitive) Validates against the names of the Deployment Method enums. Default is Not Specified. Case-sensitive enum values include:
  • Web Based
  • Enterprise Application Enhancement
  • Client/Server
  • Mobile
  • Stand Alone
archer_app_name String Name of the application in Archer.
tags String Comma-separated list of tags.
custom_field_name String (case-sensitive) Specifies the custom field that custom_field_value changes. If either is present, then the other is required. Call updateapp.do once for each custom field you need to update.
custom_field_value String The value of the custom field that custom_field_name specifies. If either is present, then the other is required. Call updateapp.do once for each custom field you need to update.
next_day_scheduling_enabled Boolean Specifies if a user can schedule next-day consultations. Only available to user accounts with the Security Lead or Administrator roles and to API service accounts with the Upload and Scan API role. Default is false.

industry Parameter Values

Values are case-sensitive.
Value Description
agmine Agriculture & Mining
busiserv Business Services
compelec Computers & Electronics
conserv Consumer Services
edu Education
enerutil Energy & Utilities
fed Federal
finserv Financial Services
gvmt Government
hpb Healthcare, Pharmaceuticals, & Biotech
local Local
manu Manufacturing
mediaent Media & Entertainment
non-profit Non-Profit
notspec Not Specified
prtnr Partner
realconst Real Estate & Construction
retail Retail
softint Software & Internet
telcom Telecommunications
transerv Transportation & Storage
travel Travel, Recreation, and Leisure
wholedist Wholesale & Distribution

app_type Parameter Values

Values are case-sensitive.

  • Application Design/Construction/IDE/Analysis
  • Application Life-Cycle Management
  • Application Server/Integration Server
  • Back-Office Enterprise
  • CRM/Groupware/Messaging
  • Consumer
  • Content Management/Authoring
  • Engineering
  • Enterprise Resource Planning
  • Information Access/Delivery/Mining/Portal
  • Information/Data Management/Database
  • Middleware/Message-oriented/Transaction
  • Network Management
  • Networking
  • Other
  • Other Development Tools
  • Security
  • ServerWare/Clustering/Web/VM
  • Storage
  • System-Level Software
  • Systems Management
  • Testing Tools

HTTPie Example

Examples use the HTTPie command-line tool. See Using HTTPie with the Python Authentication Library.

http --auth-type=veracode_hmac "https://analysiscenter.veracode.com/api/5.0/updateapp.do" "app_id==<app id>" "custom_field_name==Custom 10" "custom_field_value==jjones"

HTTPie Results

The updateapp.do call returns the appinfo XML document, which references the appinfo.xsd schema file. You can use the XSD schema file to validate the XML data.
<?xml version="1.0" encoding="UTF-8"?>

<appinfo xmlns:xsi="http&#x3a;&#x2f;&#x2f;www.w3.org&#x2f;2001&#x2f;XMLSchema-instance" 
      xmlns="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;2.0&#x2f;appinfo" 
      xsi:schemaLocation="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;2.0&#x2f;appinfo 
      https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;resource&#x2f;2.0&#x2f;appinfo.xsd" appinfo_version="1.1" 
      account_id="<account id>">
   <application app_id="<app id>" app_name="<app name>" description="<app description>" 
      business_criticality="Very High" policy="Veracode Transitional Very High" 
      policy_updated_date="2019-08-13T14&#x3a;02&#x3a;08-04&#x3a;00" teams="Demo Team" origin="Not Specified" 
      industry_vertical="Other" app_type="Other" deployment_method="Not Specified" is_web_application="false" 
      archer_app_name="<archer app name>" modified_date="2019-08-13T13&#x3a;59&#x3a;38-04&#x3a;00" cots="false" 
      vast="false" business_unit="Not Specified" tags="">
      <customfield name="Custom 1" value=""/>
      <customfield name="Custom 2" value=""/>
      <customfield name="Custom 3" value=""/>
      <customfield name="Custom 4" value=""/>
      <customfield name="Custom 5" value=""/>
      <customfield name="Custom 6" value=""/>
      <customfield name="Custom 7" value=""/>
      <customfield name="Custom 8" value=""/>
      <customfield name="Custom 9" value=""/>
      <customfield name="Custom 10" value="jjones"/>
   </application>
</appinfo>