Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/rest/{version}/applications

Descriptor

Value

HTTP Method

GET

Description

Retrieves a list of all applications, or all applications in for a team.

Required Permission

Read Access (Any Role)

Version Introduced

2.7.5

Changes in 2.7.9

Added "unassignedVulnCount" for unmapped severities.

Changes in 2.8

Added metadata filter parameter

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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

Request GET Parameters

Parameter

Value

Required

Description

team

String

No

Only return applications belonging to this team.

metadata

Map

No

Filter results by metadata key / value pairs.

Sample Call:

Code Block
languagebash
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/v2.7.5/applications?team=Test%20Team

Sample Call with Metadata Filtering:

Code Block
languagebash
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/v2.7.5/applications?metadata.foo=bar&metadata.hello=world

Sample Output:

Values for importTime, updatedDate, and date are returned as Epoch time in milliseconds.

Code Block
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "id": 1,
            "name": "App 1",
            "url": null,
            "uniqueId": null,
            "applicationCriticality": {
                "id": 1,
                "name": "Low"
            },
            "policyStatuses": [
                {
                    "id": 1,
                    "currentStatus": "FAILING",
                    "policy": {
                        "name": "CP",
                        "filterName": "Critical",
                        "id": 1
                    }
                },
                {
                    "id": 2,
                    "currentStatus": "FAILING",
                    "policy": {
                        "name": "HP",
                        "filterName": "High",
                        "id": 2
                    }
                },
                {
                    "id": 3,
                    "currentStatus": "FAILING",
                    "policy": {
                        "name": "MP",
                        "filterName": "Medium",
                        "id": 3
                    }
                }
            ],
            "description": null,
            "releaseFrequency": "UNKNOWN",
            "testEnvironment": null,
            "grcApplication": {
                "id": 11,
                "nativeId": "5f8a84a848b83ee3cda444b83a",
                "name": "grc test app",
                "policyNumber": "5f8a84a848b83ee3cda444b83a",
                "application": {
                    "teamName": "Team 0002",
                    "teamId": 1,
                    "name": "App 1",
                    "id": 1
                }
            },
            "scans": [
                {
                    "id": 2,
                    "importTime": 1459116538000,
                    "updatedDate": 1459116538000,
                    "numberClosedVulnerabilities": 171,
                    "numberNewVulnerabilities": 0,
                    "numberOldVulnerabilities": 362,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 362,
                    "numberRepeatResults": 376,
                    "numberRepeatFindings": 367,
                    "numberInfoVulnerabilities": 257,
                    "numberLowVulnerabilities": 27,
                    "numberMediumVulnerabilities": 7,
                    "numberHighVulnerabilities": 8,
                    "numberCriticalVulnerabilities": 63,
                    "scannerName": "WebInspect"
                },
                {
                    "id": 1,
                    "importTime": 1458943738000,
                    "updatedDate": 1458943738000,
                    "numberClosedVulnerabilities": 0,
                    "numberNewVulnerabilities": 533,
                    "numberOldVulnerabilities": 0,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 533,
                    "numberRepeatResults": 0,
                    "numberRepeatFindings": 0,
                    "numberInfoVulnerabilities": 257,
                    "numberLowVulnerabilities": 36,
                    "numberMediumVulnerabilities": 7,
                    "numberHighVulnerabilities": 8,
                    "numberCriticalVulnerabilities": 225,
                    "scannerName": "WebInspect"
                },
                {
                    "id": 4022,
                    "importTime": 1455146449000,
                    "updatedDate": 1455213232000,
                    "numberClosedVulnerabilities": 222,
                    "numberNewVulnerabilities": 8,
                    "numberOldVulnerabilities": 0,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 8,
                    "numberRepeatResults": 0,
                    "numberRepeatFindings": 0,
                    "numberInfoVulnerabilities": 0,
                    "numberLowVulnerabilities": 8,
                    "numberMediumVulnerabilities": 0,
                    "numberHighVulnerabilities": 0,
                    "numberCriticalVulnerabilities": 0,
                    "scannerName": "Fortify SCA"
                },
                {
                    "id": 4021,
                    "importTime": 1441776439000,
                    "updatedDate": 1441776439000,
                    "numberClosedVulnerabilities": 136,
                    "numberNewVulnerabilities": 86,
                    "numberOldVulnerabilities": 0,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 86,
                    "numberRepeatResults": 0,
                    "numberRepeatFindings": 0,
                    "numberInfoVulnerabilities": 0,
                    "numberLowVulnerabilities": 34,
                    "numberMediumVulnerabilities": 0,
                    "numberHighVulnerabilities": 52,
                    "numberCriticalVulnerabilities": 0,
                    "scannerName": "Fortify SCA"
                },
                {
                    "id": 4020,
                    "importTime": 1427732739000,
                    "updatedDate": 1427919214000,
                    "numberClosedVulnerabilities": 20,
                    "numberNewVulnerabilities": 116,
                    "numberOldVulnerabilities": 0,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 116,
                    "numberRepeatResults": 0,
                    "numberRepeatFindings": 0,
                    "numberInfoVulnerabilities": 0,
                    "numberLowVulnerabilities": 0,
                    "numberMediumVulnerabilities": 0,
                    "numberHighVulnerabilities": 116,
                    "numberCriticalVulnerabilities": 0,
                    "scannerName": "Fortify SCA"
                },
                {
                    "id": 4019,
                    "importTime": 1427210563000,
                    "updatedDate": 1427210656000,
                    "numberClosedVulnerabilities": 20,
                    "numberNewVulnerabilities": 0,
                    "numberOldVulnerabilities": 0,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 0,
                    "numberRepeatResults": 0,
                    "numberRepeatFindings": 0,
                    "numberInfoVulnerabilities": 0,
                    "numberLowVulnerabilities": 0,
                    "numberMediumVulnerabilities": 0,
                    "numberHighVulnerabilities": 0,
                    "numberCriticalVulnerabilities": 0,
                    "scannerName": "Fortify SCA"
                },
                {
                    "id": 4018,
                    "importTime": 1426769717000,
                    "updatedDate": 1426769940000,
                    "numberClosedVulnerabilities": 20,
                    "numberNewVulnerabilities": 0,
                    "numberOldVulnerabilities": 0,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 0,
                    "numberRepeatResults": 0,
                    "numberRepeatFindings": 0,
                    "numberInfoVulnerabilities": 0,
                    "numberLowVulnerabilities": 0,
                    "numberMediumVulnerabilities": 0,
                    "numberHighVulnerabilities": 0,
                    "numberCriticalVulnerabilities": 0,
                    "scannerName": "Fortify SCA"
                },
                {
                    "id": 4017,
                    "importTime": 1408667139000,
                    "updatedDate": 1408667876000,
                    "numberClosedVulnerabilities": 6,
                    "numberNewVulnerabilities": 14,
                    "numberOldVulnerabilities": 0,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 14,
                    "numberRepeatResults": 0,
                    "numberRepeatFindings": 0,
                    "numberInfoVulnerabilities": 0,
                    "numberLowVulnerabilities": 0,
                    "numberMediumVulnerabilities": 0,
                    "numberHighVulnerabilities": 14,
                    "numberCriticalVulnerabilities": 0,
                    "scannerName": "Fortify SCA"
                },
                {
                    "id": 3,
                    "importTime": 1387298340000,
                    "updatedDate": 1387301160000,
                    "numberClosedVulnerabilities": 0,
                    "numberNewVulnerabilities": 204,
                    "numberOldVulnerabilities": 0,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 204,
                    "numberRepeatResults": 0,
                    "numberRepeatFindings": 0,
                    "numberInfoVulnerabilities": 50,
                    "numberLowVulnerabilities": 16,
                    "numberMediumVulnerabilities": 74,
                    "numberHighVulnerabilities": 64,
                    "numberCriticalVulnerabilities": 0,
                    "scannerName": "Checkmarx"
                },
                {
                    "id": 4016,
                    "importTime": 1371039047000,
                    "updatedDate": 1371039047000,
                    "numberClosedVulnerabilities": 0,
                    "numberNewVulnerabilities": 6,
                    "numberOldVulnerabilities": 0,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 6,
                    "numberRepeatResults": 0,
                    "numberRepeatFindings": 0,
                    "numberInfoVulnerabilities": 0,
                    "numberLowVulnerabilities": 0,
                    "numberMediumVulnerabilities": 0,
                    "numberHighVulnerabilities": 6,
                    "numberCriticalVulnerabilities": 0,
                    "scannerName": "Fortify SCA"
                },
                {
                    "id": 4015,
                    "importTime": 1254513027000,
                    "updatedDate": 1254513041000,
                    "numberClosedVulnerabilities": 0,
                    "numberNewVulnerabilities": 0,
                    "numberOldVulnerabilities": 0,
                    "numberResurfacedVulnerabilities": 0,
                    "numberTotalVulnerabilities": 0,
                    "numberRepeatResults": 0,
                    "numberRepeatFindings": 0,
                    "numberInfoVulnerabilities": 0,
                    "numberLowVulnerabilities": 0,
                    "numberMediumVulnerabilities": 0,
                    "numberHighVulnerabilities": 0,
                    "numberCriticalVulnerabilities": 0,
                    "scannerName": "Fortify SCA"
                }
            ],
            "infoVulnCount": 307,
            "lowVulnCount": 51,
            "mediumVulnCount": 81,
            "highVulnCount": 72,
            "criticalVulnCount": 63,
            "totalVulnCount": 574,
            "isInternal": false,
            "tags": [
                {
                    "id": 3,
                    "name": "HIPAA",
                    "type": "APPLICATION"
                },
                {
                    "id": 1,
                    "name": "PCI",
                    "type": "APPLICATION"
                }
            ],
            "versions": [
                {
                    "id": 1,
                    "name": "Test 1",
                    "date": 1547272800000
                },
                {
                    "id": 2,
                    "name": "Test 2",
                    "date": 1549951200000
                }
            ],
            "riskRating": null,
            "filterSet": null,
            "applicationMetadataList": [
                {
                    "id": 1,
                    "orderPosition": 1,
                    "description": "data",
                    "title": "Meta"
                },
                {
                    "id": 2,
                    "orderPosition": 2,
                    "description": "meta",
                    "title": "Data"
                }
            ],
			"unassignedVulnCount": 0,
            "waf": null,

            "organization": {
                "name": "Team 0002",
                "id": 1
            },
            "waf": {
                "name": "FLE",
                "id": 1
            }
        },
        {
            "id": 2,
            "name": "App 2",
            "url": null,
            "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,
            "tags": [
                {
                    "id": 3,
                    "name": "HIPAA",
                    "type": "APPLICATION"
                },
                {
                    "id": 1,
                    "name": "PCI",
                    "type": "APPLICATION"
                }
            ],
            "versions": [],
            "riskRating": null,
            "filterSet": null,
            "applicationMetadataList": [],
            "unassignedVulnCount": 0,
            "waf": null,
            "organization": {
                "name": "Team 0002",
                "id": 1
            }
        }
    ]
}

Page Tree
rootApplications API 3.0 - WIP