Occurrences

List the occurrences of images discovered in an account

get/occurrences

List the occurrences of 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.

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 occurrences, 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

Shell/Curl
Node
Python3
Go

curl --request GET \
  --url 'https://container.us-1.cloudone.trendmicro.com/api/occurrences?cursor=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

application/json

{"occurrences": [{"digest": "sha256:temp",
"repository": "container-name",
"registry": "gcr.io",
"tag": "1.0.1",
"imageID": "gcr.io/ubuntu@sha256:6d5d0e4065777eec8237cefac4821702a31cd5b6255483ac50c334c057ffecfa",
"clusterID": "gke_prod-27LciLy2igWWwo9CbRk5OE2",
"namespace": "dev",
"resourceType": "Pod",
"resourceName": "frontend",
"containerName": "my-container",
"uid": "1f4aba65-301c-4e09-b91d-7419f676ec47",
"entryTime": "2022-06-16T09:55:58.000Z"
}
],
"next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}

List the occurrences of images discovered in a particular cluster

get/clusters/{id}/occurrences

List the occurrences of 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.

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 occurrences, 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

Shell/Curl
Node
Python3
Go

curl --request GET \
  --url 'https://container.us-1.cloudone.trendmicro.com/api/clusters/{id}/occurrences?cursor=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

application/json

{"occurrences": [{"digest": "sha256:temp",
"repository": "container-name",
"registry": "gcr.io",
"tag": "1.0.1",
"imageID": "gcr.io/ubuntu@sha256:6d5d0e4065777eec8237cefac4821702a31cd5b6255483ac50c334c057ffecfa",
"clusterID": "gke_prod-27LciLy2igWWwo9CbRk5OE2",
"namespace": "dev",
"resourceType": "Pod",
"resourceName": "frontend",
"containerName": "my-container",
"uid": "1f4aba65-301c-4e09-b91d-7419f676ec47",
"entryTime": "2022-06-16T09:55:58.000Z"
}
],
"next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}

List the occurrences of a particular image in a particular cluster

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

List the occurrences of images that have been found for a particular image 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 list of occurrences, 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

Shell/Curl
Node
Python3
Go

curl --request GET \
  --url 'https://container.us-1.cloudone.trendmicro.com/api/clusters/{id}/images/{image}/occurrences?cursor=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

application/json

{"occurrences": [{"digest": "sha256:temp",
"repository": "container-name",
"registry": "gcr.io",
"tag": "1.0.1",
"imageID": "gcr.io/ubuntu@sha256:6d5d0e4065777eec8237cefac4821702a31cd5b6255483ac50c334c057ffecfa",
"clusterID": "gke_prod-27LciLy2igWWwo9CbRk5OE2",
"namespace": "dev",
"resourceType": "Pod",
"resourceName": "frontend",
"containerName": "my-container",
"uid": "1f4aba65-301c-4e09-b91d-7419f676ec47",
"entryTime": "2022-06-16T09:55:58.000Z"
}
],
"next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}