Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/remoteprovider/remoteProviderApplication/list
Descriptor | Value |
|---|---|
HTTP Method | GET |
Description | Returns a list of Remote Provider applications as well as the applications they are mapped to. |
Required Permission | Manage Remote Providers |
| Version Introduced | 2.5.0 |
| Changes in 2.7.5 | Added "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. |
Request GET Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
teamId | Integer | No | Return only results mapped to ThreadFix applications that belong to the specified Team. |
remoteProviderId | Integer | No | Return only results that belong to the specified Remote Provider. |
applicationId | Integer | No | Return only results mapped to the specified ThreadFix applications. |
hideMapped | Boolean | No | Default=false; Do not return results that are already mapped to ThreadFix applications. |
hideUnmapped | Boolean | No | Default=false; Do not return results that lack a ThreadFix application mapping. |
Sample Calls:
| Code Block | ||
|---|---|---|
| ||
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {API Key}" http://localhost:8080/threadfix/rest/latest/remoteprovider/remoteProviderApplication/list?apiKey={apiKey} |
| Code Block | ||
|---|---|---|
| ||
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {API Key}" http://localhost:8080/threadfix/rest/latest/remoteprovider/remoteProviderApplication/list?hideUnmapped=true&remoteProviderId=1&apiKey={apiKey} |
Sample Output:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": [
{
"id": 4,
"nativeId": "1118",
"nativeName": "WebGoat .NET",
"customName": null,
"versionsUrl": null,
"remoteProviderEntity": {
"id": 1,
"name": "WHS",
"remoteProviderType": {
"name": "WhiteHat Sentinel Source",
"id": 10
}
},
"application": {
"id": 1,
"name": "Test AppExample",
"url": null,
"applicationCriticality": {
"id": 2,
"name": "Medium"
},
"policyStatuses": [
{
"id": 1
}
],
"description": null,
"releaseFrequency": "UNKNOWN",
"testEnvironment": null,
"isInternal": false,
"team": {
"name": "Test Team",
"id": 1
}
},
"lastImportTime": null,
"lastImportAttemptTime": null,
"lastImportStatus": "NOT_ATTEMPTED"
}
]
} |
| Page Tree | ||
|---|---|---|
|