Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/rest/{version}/remoteprovider/remoteProviderApplication/{remoteProviderApplicationId}/status 

Descriptor

Value

HTTP Method

GET

Description

Returns the status for the Remote Provider Application import.

Required Permissions

Manage Remote Providers and Upload Scans

Version Introduced

2.5.0

 

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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

 

Sample Call:

theme
Code Block
Eclipse
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {API Key}" http://localhost:8080/threadfix/rest/latest/remoteprovider/remoteProviderApplication/4/status?apiKey={apiKey}

 

Sample Output:

Code BlockthemeEclipse

For a time parameter, values are returned as Epoch time in milliseconds.

Code Block
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "id": 2,
            "fileDataList": [
                {
                    "id": 6,
                    "originalName": "WhiteHat Sentinel Source-WHS-WebGoat .NET-1"
                }
            ],
            "appId": 1,
            "errorMessage": null,
            "status": "DONE",
            "error": false,
            "type": "upload",
            "name": "WhiteHat Sentinel Source-WHS-WebGoat .NET-1",
            "time": 1490729026000,
            "scanMessage": null
        },
..//SECTION OMMITTED FOR BREVITY//..
        {
            "id": 8,
            "fileDataList": [
                {
                    "id": 12,
                    "originalName": "WhiteHat Sentinel Source-WHS-WebGoat .NET-7"
                }
            ],
            "appId": 1,
            "errorMessage": null,
            "status": "APPLICATION_MERGED",
            "error": false,
            "type": "upload",
            "name": "WhiteHat Sentinel Source-WHS-WebGoat .NET-7",
            "time": 1490729026000,
            "scanMessage": "Merging Application Findings Completed"
        },
        {
            "id": 9,
            "fileDataList": [
                {
                    "id": 13,
                    "originalName": "WhiteHat Sentinel Source-WHS-WebGoat .NET-8"
                }
            ],
            "appId": 1,
            "errorMessage": null,
            "status": "FINISHED_FINDING_PULLING",
            "error": false,
            "type": "upload",
            "name": "WhiteHat Sentinel Source-WHS-WebGoat .NET-8",
            "time": 1490729026000,
            "scanMessage": "Findings Import From Server Finished."
        }
    ]
}


Page Tree
rootRemote Providers API