Scans

Kubernetes Admission Controller Scan Service

List all scans

get/scans

Retrieve a list of scan events.

Request
query Parameters
cursor
string <byte>
Default: ""

An encoded value used to retrieve the next set of results for a query that returns more than limit results.

image
string

The image identifier for which to list scans.

Example: image=docker.io/library/busybox
limit
integer <int64> <= 100
Default: 25

The maximum number of records to return.

scannerID
string

The scanner identifier for which to list scans.

Example: scannerID=prod_scanner-439dsg48-4d6399-gjk5848
header Parameters
api-version
string
Default: 2018-05-01

The version of the API to use.

Value: "2018-05-01"
Responses
200

The response body contains the scan objects.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Did you forget to include an API Key in your request? You need to include a valid authentication header in your request. See API reference documentation for details on available authentication methods.

403

You tried to do something that you're not allowed to do, you naughty scamp. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Request samples
curl --request GET \
  --url 'https://container.us-1.cloudone.trendmicro.com/api/scans?image=SOME_STRING_VALUE&scannerID=SOME_STRING_VALUE&cursor=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE' \
  --header 'Authorization: REPLACE_KEY_VALUE'
Response samples
application/json
{
  • "scans": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}