Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/teams
Descriptor | Value |
|---|---|
HTTP Method | GET |
Description | Retrieves all the teams. |
Required Permission | Read Access (Any Role) |
Version Introduced | 2.3.0 |
Changes in 2.4.0 | The output has had several fields removed to keep the response from being too verbose. |
Changes in 2.7.5 | Added "testEnvironment", "releaseFrequency", "isInternal", and "policyStatuses" to the REST call response. |
Changes in 2.8.3 | Added "page" and "pageSize" GET parameters. Added application vuln counts, lastAssessedDate, lastScanDate, riskRating, and tags to the REST call response. |
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 |
|---|---|---|---|
page | Integer | No | Which page of findings to retrieve of size "pageSize". Defaults to 1 if not provided. |
pageSize | Integer | No | How many findings to retrieve per "page". Defaults to 10000 if not provided and cannot be greater than 10000. |
Sample Call:
| Code Block | theme | Eclipse
|---|
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/v2.4/teams |
Sample Output:
| Code Block | |
|---|---|
| Eclipse | {
"message": "",
"success": true,
"responseCode": -1,
"object": [
{
"id": 50,
"infoVulnCount": 0,
"lowVulnCount": 0,
"mediumVulnCount": 0,
"highVulnCount": 0,
"criticalVulnCount": 0,
"totalVulnCount": 0,
"name": "50",
"applications": [
{
"id": 50,
"name": "50",
"url": null,
"applicationCriticality": {
"id": 1,
"name": "Low"
},
"policyStatuses": [],
"description": null,
"releaseFrequency": "UNKNOWN",
"testEnvironment": null,
"grcApplication": null,
"infoVulnCount": 0,
"lowVulnCount": 0,
"mediumVulnCount": 0,
"highVulnCount": 0,
"criticalVulnCount": 0,
"totalVulnCount": 0,
"isInternal": false,
"tags": [],
"riskRating": null,
"lastAssessedDate": null,
"lastScanDate": null
}
]
}
]
} |
| Page Tree | ||
|---|---|---|
|