As we reach the end of September 2024, ThreadFix version 3.x on-premises has officially reached its End-of-Life. Therefore, there is no longer support or updates for this version of the product. We have fully transitioned our product and development teams to focus ThreadFix SaaS and migrating all customers over from the on-premises versions. Our Customer Success and Support teams are here to help you in migrating to ThreadFix SaaS and maximizing the value you see from this improved offering from Coalfire. This is the next phase of ThreadFix and our team is looking forward to continuing to support you on this journey.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

/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:

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/v2.4/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
                }
            ]
        }
    ]
}

  • No labels