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 5 Next »

/rest/{version}/defectTrackers/projects

Descriptor

Value

HTTP Method

POST (for security reasons)

Description

Using provided URL and credentials, get a list of projects for a Defect Tracker.

Required Permission

Manage Defect Trackers

Version Introduced

2.6

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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

Request POST Data Parameters

Parameter

Value

Required

Description

defectTrackerTypeId

Integer

Yes

The type of defect tracker. Get the possible values with /rest/defectTrackers/types.

url

String

Yes

The URL for the tracker.

username

String

Yes*

The username used to request Defect Tracker projects. *Some defect trackers use an API Key instead

password

String

Yes*

The password for the username. *Not required if the defect tracker uses an API Key

apiKey

String

Yes*

The API Key used to request Defect Tracker projects. *Some defect trackers use a username and password instead

Sample Call:

curl -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'defectTrackerTypeId=3&url=https://yourproject.atlassian.net&username=validUser&password=validPassword' http://localhost:8080/threadfix/rest/latest/defectTrackers/projects

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "projects": [
            {
                "name": "Project with \"Quotes\""
            },
            {
                "name": "YourProjectHere"
            },
            {
                "name": "Another Project"
            },
            {
                "name": "test"
            }
        ]
    }
}

The selected root page could not be found.

  • No labels