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.
Get Application by Name or Unique ID - API
/rest/{version}/applications/{teamName}/lookup?name={appName}
/rest/{version}/applications/{teamName}/lookup?uniqueId={uniqueId}
Descriptor | Value |
---|---|
HTTP Method | GET |
Description | Retrieves an application using the given teamName, appName, and uniqueId. Allows searching for names containing special characters. |
Required Permission | Read Access (Any Role) |
Version Introduced | 2.3.0 |
Changes in 2.4.0 | Added new “tags” and “versions” sections to response. |
Changes in 2.5.0.2 | Added new "filterSet" field to response. |
Changes in 2.5.1 | Added the "updatedDate" field to the response. This field is present when using older REST versions as well. |
Changes in 2.7.5 | Added the Application Metadata to the response. Only if using v2.7.5 or later. Also added "testEnvironment", "releaseFrequency", and "isInternal" to the REST call response. |
Changes in 2.7.9 | Added "unassignedVulnCount" for unmapped severities. |
Changes in 2.8.6 | Added “uniqueId” as a query parameter. |
Request Header Parameters
Parameter | Value | Required | Description |
---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
Sample Call:
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/applications/Test%20Team/lookup?name=Test%20App
Request POST Data Parameters
Parameter | Value | Required | Description |
---|---|---|---|
name | String | Yes* | The name of a ThreadFix application to lookup. |
uniqueId | String | Yes* | The uniqueId of a ThreadFix application to lookup. |
*Both parameters are not required simultaneously, however one must be provided.
name
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/applications/Test%20Team/lookup?name=Test%20App
uniqueId
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/applications/Another%20Team/lookup?uniqueId=alpha
Sample Output:
Values for importTime, updatedDate, and date are returned as Epoch time in milliseconds.
www.threadfix.it | www.coalfire.com
Copyright © 2024 Coalfire. All rights reserved.
This Information Security Policy is CoalFire - Public: Distribution of this material is not limited.