docs icon indicating copy to clipboard operation
docs copied to clipboard

imageID querystring is not functional on examples throughout the API docs

Open iansk opened this issue 4 years ago • 0 comments

When searching in 20.04, the correct querystring is search and no longer imageID. This reference is found for example under the CI scan results example documentation:

https://cdn.twistlock.com/docs/api/twistlock_api.html#scans_get

To get the report of a specific scan, you can add query parameters to narrow the scope of the request.

The following example curl command uses basic auth to retrieve the scan report for just an image with a SHA256 ID of sha256:f756e84300d8e53006090573dd33abe5b8cfac3e42d104fc4be37f435fe512f3.

$ curl -k
-u <USER>
-H 'Content-Type: application/json'
-X GET
https://<CONSOLE>:8083/api/v1/scans?imageID=sha256:f756e84300d8e53006090573dd33abe5b8cfac3e42d104fc4be37f

Query Parameters imageID: (string) ImageID is the scanned image ID

imageID is no longer functional. Instead, customers should user the search parameter, which is undocumented.

(Reported by @joshfalgout on Sep 21, 2020)

iansk avatar Nov 10 '20 01:11 iansk