Get Remote Provider Applications By Name - API

/rest/{version}/remoteprovider/remoteProviderApplication/search

Descriptor	Value
HTTP Method	GET
Description	Returns a list of Remote Provider Applications with the provided name.
Required Permission	Manage Remote Providers
Version Introduced	2.5.0

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
name	String	Yes	Name of the Remote Provider Application to return.
remoteProviderId	Integer	No	ID of a Remote Provider to restrict the search to.

Sample Calls:

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {API Key}" http://localhost:8080/threadfix/rest/latest/remoteprovider/remoteProviderApplication/search?name=WebGoat%20.NET

Sample Output:

{
    "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": null,
            "lastImportTime": null,
            "lastImportAttemptTime": null,
            "lastImportStatus": "NOT_ATTEMPTED"
        },
        {
            "id": 10,
            "nativeId": "1118",
            "nativeName": "WebGoat .NET",
            "customName": null,
            "versionsUrl": null,
            "remoteProviderEntity": {
                "id": 2,
                "name": "WHS 2",
                "remoteProviderType": {
                    "name": "WhiteHat Sentinel Source",
                    "id": 10
                }
            },
            "application": null,
            "lastImportTime": null,
            "lastImportAttemptTime": null,
            "lastImportStatus": "NOT_ATTEMPTED"
        }
    ]
}