Configure Existing Remote Provider 3.0 - API

/rest/{version}/remoteprovider/{remoteProviderEntityId}/configure

Descriptor	Value
HTTP Method	POST
Description	Updates existing ThreadFix remote provider configuration
Required Permissions	Manage Remote Providers
Version Introduced	2.8

Request Header Parameters

Parameter	Value	Required	Description
Accept	String	Yes	A value of ‘application/json’ must be provided.

Request Parameters

Parameter	Value	Required	Description
url	URL	No	Updated URL of the remote provider application.
name	String	No	Used if the user wants to update the name of the remote provider in ThreadFix.
password	String	No*	Updated password of the remote provider application.
ApiKey	String	No*	Updated API key of the remote provider application.
SecretKey	String	No*	Updated secret key value for the remote provider application.

*If updating only the name and/or URL of the remote provider, the current values will need to be provided.

Sample Call:

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data "name=Veracode&ApiKey={apiKey}&SecretKey={secretKey}" http://localhost:8080/threadfix/rest/latest/remoteprovider/{remoteProviderEntityId}/configure

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Veracode Remote Provider is edited successfully."
}