As of December 31st, 2023 ThreadFix 2.X has reached End of Life and is no longer supported. For any further information please contact the Success and Implementation team.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Current »

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 Introduced2.3.0
Changes in 2.7.5Added "testEnvironment", "releaseFrequency", and "isInternal" to the REST call response.
Changes in 2.7.9Added "unassignedVulnCount" for unmapped severities.
Changes in 2.8.2Added ability to add description to application.

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.

AuthorizationAPIKEY {apiKey}YesAPI 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

No

The URL of where the application being assessed lives.

descriptionStringNoThe text to be included in the description field for the application.


Sample Call:

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:


{
    "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
        }
    }
}

  • No labels