Remote Provider Connections Endpoint 3.X

The following is available for ThreadFix 3.1 and newer.

/api/application/queue/importRequests/connections

To obtain the authorization token, refer to the API Authentication 3.X guide.

Descriptor	Value

Descriptor	Value
HTTP Method	GET
Description	This method returns all active remote provider import requests grouped by connection.
Required Permission	View Scans Queue
Version Introduced	3.1.0

Request Header Parameters

Parameter	Value	Required	Description

Parameter	Value	Required	Description
Accept	String	Yes	A value of ‘application/json’ must be provided.
api-version	1.0	Yes	‘latest’ is also a valid option

Request GET Parameters

Parameter	Value	Required	Description

Parameter	Value	Required	Description
_page	1	Optional	Page of the result set being requested
_limit	6	Optional	Size of the result set page - default is 10

Sample Call:

curl --insecure -H 'Authorization: Bearer <bearer_token>' -H 'api-version: latest' -H "Content-type: application/json" 'https://localhost/api/application/queue/importRequests/connections?_page=1&_limit=6'

Sample Output:

{
    "content": [
        {
            "name": "Black Duck",
            "scannerType": "Black Duck",
            "remoteProviderEntityId": 8,
            "numTfAppAssets": 5,
            "processing": [
                {
                    "id": "5105e8ff-3019-11ec-9fca-67954101196e",
                    "createdDate": "2021-10-18T13:43:03+00:00",
                    "modifiedDate": "2021-10-18T13:43:03+00:00",
                    "requestTimestamp": "2021-10-18T13:43:03.330+00:00",
                    "processingStartTimestamp": "2021-10-18T13:43:06.354+00:00",
                    "remoteProviderEntityId": 8,
                    "error": false,
                    "userId": 1,
                    "status": "PROCESSING",
                    "type": "RP_ENTITY_REQUEST",
                    "attempts": 1
                }
            ],
            "queued": [],
            "completed": []
        },
        {
            "name": "WhiteHat",
            "scannerType": "WhiteHat Sentinel",
            "remoteProviderEntityId": 7,
            "numTfAppAssets": 4,
            "processing": [],
            "queued": [
                {
                    "id": "5248f050-3019-11ec-9fca-859078fb218c",
                    "createdDate": "2021-10-18T13:43:05+00:00",
                    "modifiedDate": "2021-10-18T13:43:05+00:00",
                    "requestTimestamp": "2021-10-18T13:43:05.447+00:00",
                    "remoteProviderEntityId": 7,
                    "error": false,
                    "userId": 1,
                    "status": "REQUESTED",
                    "type": "RP_ENTITY_REQUEST",
                    "attempts": 0
                }
            ],
            "completed": []
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 6,
        "unpaged": false,
        "paged": true
    },
    "totalElements": 2,
    "totalPages": 1,
    "last": true,
    "size": 6,
    "number": 0,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "first": true,
    "numberOfElements": 2,
    "empty": false
}