Scans

Kubernetes Admission Controller Scan Service

List all scans

get/scans

Retrieve a list of scan events.

SecurityTrend Micro Cloud One API Key

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

Shell/Curl
Node
Python3
Go

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": [{"scannerID": "scannerID",
"image": "docker.io/Library/busybox",
"source": "60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff",
"scan": {"id": "60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff",
"href": "/api/scans/60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff",
"name": "My scan",
"source": {"type": "docker",
"registry": "registry.example.com",
"repository": "organization/project",
"tag": "latest",
"digest": "sha256:02892826401a9d18f0ea01f8a2f35d328ef039db4e1edcc45c630314a0457d5b",
"insecureSkipVerify": false,
"rootCAs": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCi4uLiBhbmQgc28gb24gLi4uCg=="
},
"context": {"key": "value"
},
"status": "completed-with-findings",
"details": {"detail": "More details about the scan status",
"requested": "2018-05-01T00:00:00Z",
"started": "2018-05-01T00:00:00Z",
"updated": "2018-05-01T00:00:00Z",
"completed": "2018-05-01T00:00:00Z",
"digest": "sha256:43ea500473edb96e079fe23aba62d60e09c11d4c4714ca284d50b80e064c05e3",
"os": "linux",
"architecture": "amd64",
"labels": {"key": "value"
},
"results": [{"id": "sha256:77beb64c6eca68574566d5b04b9f64c71d9b7757a446d562b7d0ae4b13b7c467",
"createdAt": "2018-05-01T00:00:00Z",
"createdBy": "/bin/sh -c #(nop) ADD file:5d127078b2f213dbbf08ca35dafd027011606887a655f641024b14d93ee0de2f in /run-httpd.sh\"",
"malware": "/api/scans/60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff/layers/sha256:77beb64c6eca68574566d5b04b9f64c71d9b7757a446d562b7d0ae4b13b7c467/malware",
"vulnerabilities": "/api/scans/60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff/layers/sha256:77beb64c6eca68574566d5b04b9f64c71d9b7757a446d562b7d0ae4b13b7c467/vulnerabilities",
"contents": "/api/scans/60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff/layers/sha256:77beb64c6eca68574566d5b04b9f64c71d9b7757a446d562b7d0ae4b13b7c467/contents",
"findings": {"scanners": null,
"malware": null,
"contents": null,
"vulnerabilities": null,
"checklists": null
}
}
],
"checklists": "/api/scans/60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff/checklists"
},
"findings": {"scanners": {"malware": {"status": "ok",
"updated": "2018-05-01T00:00:00Z",
"versions": {"icrc": null,
"trendX": null,
"denylist": null,
"blacklist": null
}
},
"vulnerabilities": {"status": "ok",
"updated": "2018-05-01T00:00:00Z"
},
"vulnerabilityPatterns": {"status": "ok",
"date": "2018-05-01T00:00:00Z",
"updated": "2018-05-01T00:00:00Z"
}
},
"malware": 0,
"contents": {"total": {"defcon1": 0,
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"negligible": 0,
"unknown": 0
},
"unresolved": {"defcon1": 0,
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"negligible": 0,
"unknown": 0
}
},
"vulnerabilities": {"total": {"defcon1": 0,
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"negligible": 0,
"unknown": 0
},
"unresolved": {"defcon1": 0,
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"negligible": 0,
"unknown": 0
},
"fixAvailable": {"defcon1": 0,
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"negligible": 0,
"unknown": 0
}
},
"checklists": {"total": {"defcon1": 0,
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"negligible": 0,
"unknown": 0
},
"unresolved": {"defcon1": 0,
"critical": 0,
"high": 0,
"medium": 0,
"low": 0,
"negligible": 0,
"unknown": 0
}
}
},
"extendedResult": {"vulnerabilityVectors": {"defcon1": {"v3": [null
],
"v2": [null
]
},
"critical": {"v3": [null
],
"v2": [null
]
},
"high": {"v3": [null
],
"v2": [null
]
},
"medium": {"v3": [null
],
"v2": [null
]
},
"low": {"v3": [null
],
"v2": [null
]
},
"negligible": {"v3": [null
],
"v2": [null
]
}
},
"checklists": [{"id": "string",
"profiles": [null
]
}
]
},
"malwareCount": 0,
"contentScanDefcon1Count": 0,
"contentScanCriticalCount": 0,
"contentScanHighCount": 0,
"contentScanMediumCount": 0,
"contentScanLowCount": 0,
"contentScanNegligibleCount": 0,
"contentScanUnknownCount": 0,
"contentScanUnresolvedDefcon1Count": 0,
"contentScanUnresolvedCriticalCount": 0,
"contentScanUnresolvedHighCount": 0,
"contentScanUnresolvedMediumCount": 0,
"contentScanUnresolvedLowCount": 0,
"contentScanUnresolvedNegligibleCount": 0,
"contentScanUnresolvedUnknownCount": 0,
"defcon1Count": 0,
"criticalCount": 0,
"highCount": 0,
"mediumCount": 0,
"lowCount": 0,
"negligibleCount": 0,
"unknownCount": 0,
"unresolvedDefcon1Count": 0,
"unresolvedCriticalCount": 0,
"unresolvedHighCount": 0,
"unresolvedMediumCount": 0,
"unresolvedLowCount": 0,
"unresolvedNegligibleCount": 0,
"unresolvedUnknownCount": 0,
"fixAvailableDefcon1Count": 0,
"fixAvailableCriticalCount": 0,
"fixAvailableHighCount": 0,
"fixAvailableMediumCount": 0,
"fixAvailableLowCount": 0,
"fixAvailableNegligibleCount": 0,
"fixAvailableUnknownCount": 0,
"checklistsDefcon1FailureCount": 0,
"checklistsCriticalFailureCount": 0,
"checklistsHighFailureCount": 0,
"checklistsMediumFailureCount": 0,
"checklistsLowFailureCount": 0,
"checklistsNegligibleFailureCount": 0,
"checklistsUnknownFailureCount": 0,
"checklistsUnresolvedDefcon1FailureCount": 0,
"checklistsUnresolvedCriticalFailureCount": 0,
"checklistsUnresolvedHighFailureCount": 0,
"checklistsUnresolvedMediumFailureCount": 0,
"checklistsUnresolvedLowFailureCount": 0,
"checklistsUnresolvedNegligibleFailureCount": 0,
"checklistsUnresolvedUnknownFailureCount": 0
},
"ingestTime": "2019-03-01T00:00:00Z",
"expirationTime": 1601694554
}
],
"next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}

➔ Next to Events