Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Create Application
/rest/{version}/teams/{teamId}/applications/new
Descriptor | Value |
|---|---|
HTTP Method | POST |
Description | Creates an application under the given team with id of teamId. |
Required Permission | Manage Applications |
| Version Introduced | 2.3.0 |
| Changes in 2.7.5 | Added "testEnvironment", "releaseFrequency", and "isInternal" to the REST call response. |
| Changes in 2.7.9 | Added "unassignedVulnCount" for unmapped severities. |
| Changes in 2.8.2 | Added ability to add description to application. |
Request Header Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
| Authorization | APIKEY {apiKey} | Yes | API being used to execute API call. |
Request POST Data Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
name | String | Yes | The name of the new application that is being created. |
url | String | noNo | The URL of where the application being assessed lives. |
| description | String | No | The text to be included in the description field for the application. |
Sample Call:
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'name=Test App&url=http://example.com' http://localhost:8080/threadfix/rest/latest/teams/1/applications/new |
Sample Output:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": {
"id": 38,
"name": "API team",
"url": "http://example.com",
"uniqueId": null,
"applicationCriticality": {
"id": 1,
"name": "Low"
},
"policyStatuses": [],
"description": null,
"releaseFrequency": "UNKNOWN",
"testEnvironment": null,
"grcApplication": null,
"scans": [],
"infoVulnCount": 0,
"lowVulnCount": 0,
"mediumVulnCount": 0,
"highVulnCount": 0,
"criticalVulnCount": 0,
"totalVulnCount": 0,
"isInternal": false,
"unassignedVulnCount": 0,
"waf": null,
"organization": {
"name": "Test Team",
"id": 1
}
}
} |
| Page Tree | ||
|---|---|---|
|