Remote Provider Projects Endpoint 3.X

The following is available for ThreadFix 3.1 and newer.

/api/application/queue/importRequests/{importRequestId}/apps/{tfApplicationAssetId}/projects

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

Descriptor

Value

Descriptor

Value

HTTP Method

GET

Description

This endpoint returns the status of each mapped remote provider application for the supplied import request id and ThreadFix application asset id.

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

String

Yes

The version of the API to use - ‘1.0’ returns the current version.

Request GET Parameters

Parameter

Value

Required

Description

Parameter

Value

Required

Description

import_request_id

UUID

Yes

The id of the remote provider import request.

TF_application_asset_id

Integer

Yes

The id of the TF application asset.

_page

Integer

Optional

Page of the result set being requested.

_limit

Integer

Optional

Size of the result set page - default is 10.


Sample Call:

curl --insecure -H 'Authorization: Bearer {token}' -H 'api-version: 1.0' -H "Content-type: application/json" 'https://localhost/api/application/queue/importRequests/a25f8d2e-5b7e-11eb-b494-9db75f325519/apps/1/projects?_page=1&_limit=10'

Sample Output:

{ "content": [ { "id": "6e78f858-3019-11ec-a1fa-695b6e9755bc", "createdDate": "2021-10-18T13:43:52+00:00", "modifiedDate": "2021-10-18T13:43:52+00:00", "remoteProviderImportRequestId": "5248f050-3019-11ec-9fca-859078fb218c", "pendingScanId": "6daa84b1-3019-11ec-a1fa-9d92390be6f3", "remoteProviderAppId": 21, "remoteProviderAppName": "Test123", "appId": 1, "appName": "App 1", "status": "NOT_ATTEMPTED", "importAttemptTime": "2021-10-18T13:43:52.738+00:00" }, { "id": "6db11462-3019-11ec-a1fa-df6a0bee8851", "createdDate": "2021-10-18T13:43:51+00:00", "modifiedDate": "2021-10-18T13:43:51+00:00", "remoteProviderImportRequestId": "5248f050-3019-11ec-9fca-859078fb218c", "pendingScanId": "6daa84b1-3019-11ec-a1fa-9d92390be6f3", "remoteProviderAppId": 18, "remoteProviderAppName": "testing", "appId": 1, "appName": "App 1", "status": "GET_SCANS_RETURNED", "importAttemptTime": "2021-10-18T13:43:51.428+00:00", "importTime": "2021-10-18T02:16:55.000+00:00" } ], "pageable": { "sort": { "sorted": false, "unsorted": true, "empty": true }, "offset": 0, "pageNumber": 0, "pageSize": 10, "unpaged": false, "paged": true }, "totalElements": 2, "totalPages": 1, "last": true, "size": 10, "number": 0, "sort": { "sorted": false, "unsorted": true, "empty": true }, "first": true, "numberOfElements": 2, "empty": false }

www.threadfix.it | www.coalfire.com
Copyright © 2024 Coalfire. All rights reserved.

This Information Security Policy is CoalFire - Public: Distribution of this material is not limited.