Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/policy/status/application/{appId}/evaluate
Descriptor | Value |
|---|---|
HTTP Method | GET |
Description | Checks the specified application against all of the CI/CD Pass Criteria it is attached to. |
Required Permission | Manage CI/CD |
Version Introduced | 2.5.0 |
Request Header Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
Request GET Data Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
fromDate | Date | No | Evaluate against any new open vulnerabilities from this date. If no date is specified, the start date will be December 31, 1969. The time will be the start of day, 00:00:00. Note: Epoch time is returned in milliseconds. |
toDate | Date | No | Evaluate against any new open vulnerabilities until this date. If no start date is specified, the end date will be the current date. The time will be the end of day, 23:59:59. Note: Epoch time is returned in milliseconds. |
Dates are formatted as yyyy-MM-dd
Sample Call:
| Code Block | theme | Eclipse
|---|
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X GET http://localhost:8080/threadfix/rest/latest/policy/status/application/1/evaluate&fromDate=2017-04-01&toDate=2017-04-27
|
Sample Output:
Values for fromDate and toDate are returned as Epoch time in milliseconds.
| Code Block | theme | Eclipse
|---|
{
"message": "",
"success": true,
"responseCode": -1,
"object": {
"id": 1,
"passed": [
{
"id": 1,
"severity": "Critical",
"maxAllowed": 9,
"maxIntroduced": 8
}
],
"failed": [],
"fromDate": 1491022800000,
"toDate": 1493355599059,
"passing": true,
"snapshot": {
"id": 1,
"vulnerabilitySummary": {
"id": 1,
"infoTotal": 2,
"lowTotal": 0,
"mediumTotal": 8,
"highTotal": 5,
"criticalTotal": 2,
"newInfoTotal": 2,
"newLowTotal": 0,
"newMediumTotal": 8,
"newHighTotal": 5,
"newCriticalTotal": 2
},
"snapshotType": "POLICY_EVAL"
}
}
} |
| Page Tree | ||
|---|---|---|
|