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 Team by Name - API

/rest/{version}/teams/lookup?name={name}


Descriptor

Value

HTTP Method

GET

Description

Retrieves a team using the given name.

Required Permission

Read Access (Any Role)

Version Introduced2.3.0
Changes in 2.7.5Added "testEnvironment", "releaseFrequency", "isInternal", and "policyStatuses" to the REST call response.


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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


Sample Call:


curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/teams/lookup?name=Test%20Team


Sample Output:


{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "id": 1,
        "infoVulnCount": 0,
        "lowVulnCount": 0,
        "mediumVulnCount": 1,
        "highVulnCount": 1,
        "criticalVulnCount": 0,
        "totalVulnCount": 2,
        "name": "Test Team",
        "applications": [
            {
                "id": 1,
                "name": "Application",
                "url": null,
                "applicationCriticality": {
                    "id": 2,
                    "name": "Medium"
                },
                "policyStatuses": [],
                "description": null,
                "releaseFrequency": "UNKNOWN",
                "testEnvironment": null,
                "grcApplication": null,
                "isInternal": false
            }
        ]
    }
}

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.