createapp.do

APIs

Creates a new 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/createapp.do

Parameters

app_name String. Required.  
description String. No default.  
vendor_id String. No default.  
vendor_id Integer. This parameter indicates that this is a third-party (COTS) application. It validates against existing vendors. No default.  
business_criticality String. Required. Matches the names of business criticality enums. Case-sensitive enum values include:
  • Very High
  • High
  • Medium
  • Low
  • Very Low
policy String. Validates against the names of existing policies for this account. Defaults to the policy set as default for the business criticality parameter. Case-sensitive string value.
business_unit String. Validates against the names of existing business units for this account. No default. Case-sensitive string value.
business_owner String. No default.  
business_owner_email String. No default.  
teams String. Comma-separated list of team names. Validates against the names of existing teams for this account. No default. Case-sensitive string value.
origin String. Validates against the names of the Origin enums. Defaults to Not Specified. Case-sensitive enum values include: 3rd party library, Purchased Application, Contractor, Internally Developed, Open Source, or Outsourced Team.
industry String. Validates against the names of the Industry enums. Defaults to the same industry of the account. Case-sensitive enum values include: Aerospace, Agriculture, Apparel, Automotive and Transport, Banking, Beverages, Biotechnology, Business Services, Charitable Organizations, Chemicals, Communications, Computer Hardware, Consulting, Construction, Consumer Products Manufacturers, Consumer Services, Cultural Institutions, Education, Electronics, Energy, Engineering, Environmental, Finance, Food & Beverage, Foundations, Government, Healthcare, Hospitality, Insurance, Manufacturing, Machinery, Media & Entertainment, Membership Organizations, Metals and Mining, Other, Pharmaceuticals, Real Estate, Recreation, Retail, Security Products and Services, Software, Technology, Telecommunications Equipment, Telecommunications, Transportation, Utilities.
app_type String. Validates against the names of the Application Purpose enums. Defaults to Not Specified. Case-sensitive enum values include: Application Design/Construction/IDE/Analysis, Application Life-Cycle Management, Application Server/Integration Server, Back-Office Enterprise, CRM, Collaboration/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.
deployment_method String. Validates against the names of the Deployment Method enums. Defaults to Not Specified. Case-sensitive enum values include: Web Based, Enterprise Application Enhancement, Client/Server, Mobile, Stand Alone.
web_application Boolean. Defaults to false.  
archer_app_name String. No default.  
tags String. Comma-separated list of tags. No default.  
next_day_scheduling_enabled Boolean. Specifies if a user can schedule next-day consultations. Defaults to false. Only available to Veracode human user accounts with the Security Lead or Administrator roles and to non-human API accounts with the Upload API role.

cURL Example

curl --compressed -u
        <VeracodeUsername>:<VeracodePassword>
        https://analysiscenter.veracode.com/api/5.0/createapp.do -F "app_name=TestApp" -F
        "business_criticality=Very High" 

cURL Results

The createapp.do call returns the appinfo XML document, which references the appinfo.xsd. Additional appinfo.xsd schema documentation is available. Use the XSD file to validate the XML data.

Java Example

This example uses the Veracode username and password:

java -jar vosp-api-wrappers-java-<version #>.jar -vuser <VeracodeUsername> -vpassword <VeracodePassword> -action createapp -appname MyApp -criticality veryhigh

Java Results

The createapp.do call returns the appinfo XML document, which references the appinfo.xsd. Additional appinfo.xsd schema documentation is available. The following is an example of the returned XML:

<?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=""/>
  
    <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=""/>

  </application>
 
 </appinfo>