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 All Teams - API

/rest/{version}/teams


Descriptor

Value

HTTP Method

GET

Description

Retrieves all the teams.

Required Permission

Read Access (Any Role)

Version Introduced2.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.5Added "testEnvironment", "releaseFrequency", "isInternal", and "policyStatuses" to the REST call response.
Changes in 2.8.3Added "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

ParameterValueRequiredDescription
pageIntegerNoWhich page of findings to retrieve of size "pageSize".  Defaults to 1 if not provided.
pageSizeIntegerNoHow many findings to retrieve per "page".  Defaults to 10000 if not provided and cannot be greater than 10000.

Sample Call:


curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/teams


Sample Output:


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

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.