Images

List the images discovered in an account

get/images

List the images that have been found running in all clusters of the account

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.

limit
integer <int64> <= 100
Default: 25

The maximum number of records to return.

sort
string
Default: "vuln_counts"

When present, the sort query parameter will order the list of events by the value of the provided field This query parameter may be combined with only the cursor and limit query parameters.

Value: "vuln_counts"
header Parameters
api-version
string
Default: v1

The version of the API to use.

Value: "v1"
Responses
200

The response body contains the list of images, or nothing if Container Security is not deployed into any clusters.

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.

404

The resource you were looking for doesn't exist.

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/images?cursor=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE' \
  --header 'Authorization: REPLACE_KEY_VALUE'
Response samples
application/json
{
  • "images": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}

List the images discovered in a particular cluster

get/clusters/{id}/images

List the images that have been found running in a particular cluster

SecurityTrend Micro Cloud One API Key
Request
path Parameters
id
required
string

The cluster id.

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.

limit
integer <int64> <= 100
Default: 25

The maximum number of records to return.

sort
string
Default: "cluster_vuln_counts"

When present, the sort query parameter will order the list of events by the value of the provided field This query parameter may be combined with only the cursor and limit query parameters.

Value: "cluster_vuln_counts"
header Parameters
api-version
string
Default: v1

The version of the API to use.

Value: "v1"
Responses
200

The response body contains the list of images, or nothing if Container Security is not deployed into any clusters.

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.

404

The resource you were looking for doesn't exist.

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/clusters/{id}/images?cursor=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE' \
  --header 'Authorization: REPLACE_KEY_VALUE'
Response samples
application/json
{
  • "images": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}

Return image details

get/clusters/{id}/images/{image}

Return the image with a paticular imageID, discovered in a particular cluster

SecurityTrend Micro Cloud One API Key
Request
path Parameters
id
required
string

The cluster id.

image
required
string

The image id.

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.

limit
integer <int64> <= 100
Default: 25

The maximum number of records to return.

header Parameters
api-version
string
Default: v1

The version of the API to use.

Value: "v1"
Responses
200

The response body contains the an image, or nothing if Container Security is not deployed into any clusters.

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.

404

The resource you were looking for doesn't exist.

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/clusters/{id}/images/{image}?cursor=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE' \
  --header 'Authorization: REPLACE_KEY_VALUE'
Response samples
application/json
{
  • "digest": "sha256:temp",
  • "repository": "container-name",
  • "registry": "gcr.io",
  • "imageID": "gcr.io/ubuntu@sha256:6d5d0e4065777eec8237cefac4821702a31cd5b6255483ac50c334c057ffecfa",
  • "clusterID": "gke_prod-27LciLy2igWWwo9CbRk5OE2",
  • "totalVulnCount": 10,
  • "highCount": 10,
  • "criticalCount": 10,
  • "mediumCount": 10,
  • "lowCount": 10,
  • "negligibleCount": 10,
  • "unknownCount": 10
}