Skip to main content

createapp.do

The createapp.do call creates a new application profile in the portfolio.

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 POST to /appsec/v1/applications in the Applications 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/createapp.do

Parameters

NameTypeDescription
app_name
Required
StringYour application name.
business_criticality
Required
String (case-sensitive)Matches the names of Business Criticality enums: Very High, High, Medium, Low, Very Low
descriptionStringDescription of the target application.
vendor_idIntegerIndicates a third-party (COTS) application. It validates against existing vendors.
policyString (case-sensitive)Validates against the names of existing policies for this account. Default is the policy set as default for the business criticality parameter.
business_unitString (case-sensitive)Validates against the names of existing business units for this account.
business_ownerStringName of the business owner for the application.
business_owner_emailStringEmail for the business owner of the application.
teamsStringComma-separated list of team names associated with the specified application. Validates against the names of existing teams for this account.
originString (case-sensitive)Validates against the names of the Origin enums:
  • 3rd party library
  • Purchased Application
  • Contractor
  • Internally Developed
  • Open Source
  • Outsourced Team
industryString (case-sensitive)Validates against the names of the Industry enums. See industry parameter values. Default is the same industry as the account.
app_typeString (case-sensitive)Validates against the names of the Application Purpose enums. See app_type parameter values.
deployment_methodString (case-sensitive)Validates against the names of the Deployment Method enums:
  • Web Based
  • Enterprise Application Enhancement
  • Client/Server
  • Mobile
  • Stand Alone
web_applicationBooleanDefault is false.
archer_app_nameStringName of the application in Archer.
tagsStringComma-separated list of tags.
next_day_scheduling_enabledBooleanSpecifies if a user can schedule next-day consultations. Only available to user accounts with the Security Lead role or Administrator role and to API service account with the Upload and Scan API role. Default is false.

industry parameter values

Values are case-sensitive.

ValueDescription
agmineAgriculture & Mining
busiservBusiness Services
compelecComputers & Electronics
conservConsumer Services
eduEducation
enerutilEnergy & Utilities
fedFederal
finservFinancial Services
gvmtGovernment
hpbHealthcare, Pharmaceuticals, & Biotech
localLocal
manuManufacturing
mediaentMedia & Entertainment
non-profitNon-Profit
notspecNot Specified
prtnrPartner
realconstReal Estate & Construction
retailRetail
softintSoftware & Internet
telcomTelecommunications
transervTransportation & Storage
travelTravel, Recreation, and Leisure
wholedistWholesale & 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.

http --auth-type=veracode_hmac "https://analysiscenter.veracode.com/api/5.0/createapp.do" "app_name==<app name>" "business_criticality==Very High"

HTTPie results

The createapp.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>" business_criticality="Very High"
policy="Veracode Recommended Very High" teams="" origin="Not Specified" industry_vertical="Not Specified"
app_type="Not Specified" deployment_method="Not Specified" is_web_application="false"
modified_date="2019-08-15T13&#x3a;56&#x3a;46-04&#x3a;00" cots="false" vast="false"
business_unit="Not Specified" tags="">
<customfield name="Custom 1" value="100"/>
<customfield name="Custom 2" value="Deferred"/>
<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=""/>
</application>
</appinfo>

Java example

java -jar vosp-api-wrappers-java-<version #>.jar -vid <VeracodeApiId> -vkey <VeracodeApiKey> -action createapp -appname MyApp -criticality veryhigh

Java results

The createapp.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" standalone="no"?>

<appinfo xmlns="https://analysiscenter.veracode.com/schema/2.0/appinfo"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
account_id=<account id> appinfo_version="1.1"
xsi:schemaLocation="https://analysiscenter.veracode.com/schema/2.0/appinfo https://analysiscenter.veracode.com/resource/2.0/appinfo.xsd">
<application app_id=<app id> app_name="MyApp" app_type="Not Specified" business_criticality="Very High" business_unit="Not Specified"
cots="false" deployment_method="Not Specified" industry_vertical="Not Specified" is_web_application="false"
modified_date="2018-12-04T11:18:38-05:00" origin="Not Specified" policy="Veracode Recommended Very High" tags="" teams="" vast="false">
<customfield name="Custom 1" value="100"/>
<customfield name="Custom 2" value="Deferred"/>
<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=""/>
</application>
</appinfo>