Cloud One Container Security API (2022-12-02)

Download OpenAPI specification:Download

URL: https://www.trendmicro.com/en_ca/business/products/hybrid-cloud/cloud-one-container-image-security.html

Trend Micro Cloud One™ - Container Security provides policy-based deployment security, ensuring that container images are run only when they meet the security criteria that you define.

Policies

Kubernetes Admission Controller policies

List policies

get/policies

Retrieve a list of policies.

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 policy 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/policies?cursor=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

application/json

{"policies": [{"id": "Policy-1fhJJhPdbKbGK83VL4GjBsFrXIR",
"name": "example_policy",
"description": "My policy description",
"default": {"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
},
"namespaced": [{"name": "example_ns_policy_definition",
"namespaces": ["dev",
"prod"
],
"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
}
],
"created": "2019-03-01T00:00:00Z",
"updated": "2019-03-01T00:00:00Z",
"rulesetsUpdated": "2019-03-01T00:00:00Z"
}
],
"next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}

Create a policy

post/policies

Create a policy.

SecurityTrend Micro Cloud One API Key

Request

header Parameters

api-version

string

Default: v1

The version of the API to use.

Value: "v1"

Request Body schema: application/json

required	object (DefaultPolicyDefinition)
description	string <= 128 characters (optional) A description for the policy.
name required	string <= 64 characters ^[a-zA-Z0-9._]+$ A descriptive name for the policy.
	Array of objects (NamespacedPolicyDefinition) The definition of all the policies.
	object (RuntimeDefinition) The runtime properties of this policy.

Responses

201

The policy request has been accepted, the policy has been created, and the system will begin processing it soon.

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

Payload
Shell/Curl
Node
Python3
Go

application/json

{"name": "example_policy",
"description": "(optional) a descriptive string",
"default": {"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
},
"namespaced": [{"name": "example_ns_policy_definition",
"namespaces": ["dev",
"prod"
],
"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
}
],
"runtime": {"default": {"rulesets": [{"id": "ruleset1-1u8aTLsht8qh2M0d7cPXqxnBfDG"
}
]
}
}
}

Response samples

application/json

{"runtime": {"default": {"rulesets": [{"id": "ruleset1-1u8aTLsht8qh2M0d7cPXqxnBfDG",
"name": "ruleset1"
}
]
}
},
"id": "Policy-1fhJJhPdbKbGK83VL4GjBsFrXIR",
"name": "example_policy",
"description": "My policy description",
"default": {"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
},
"namespaced": [{"name": "example_ns_policy_definition",
"namespaces": ["dev",
"prod"
],
"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
}
],
"created": "2019-03-01T00:00:00Z",
"updated": "2019-03-01T00:00:00Z",
"rulesetsUpdated": "2019-03-01T00:00:00Z"
}

Describe a policy

get/policies/{id}

Retrieve policy details.

SecurityTrend Micro Cloud One API Key

Request

path Parameters

id

required

string

The policy ID.

header Parameters

api-version

string

Default: v1

The version of the API to use.

Value: "v1"

Responses

200

The response body contains the policy object.

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/policies/{id} \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

application/json

{"runtime": {"default": {"rulesets": [{"id": "ruleset1-1u8aTLsht8qh2M0d7cPXqxnBfDG",
"name": "ruleset1"
}
]
}
},
"id": "Policy-1fhJJhPdbKbGK83VL4GjBsFrXIR",
"name": "example_policy",
"description": "My policy description",
"default": {"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
},
"namespaced": [{"name": "example_ns_policy_definition",
"namespaces": ["dev",
"prod"
],
"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
}
],
"created": "2019-03-01T00:00:00Z",
"updated": "2019-03-01T00:00:00Z",
"rulesetsUpdated": "2019-03-01T00:00:00Z"
}

Update a policy

post/policies/{id}

Update a new policy.

SecurityTrend Micro Cloud One API Key

Request

path Parameters

id

required

string

The policy ID.

header Parameters

api-version

string

Default: v1

The version of the API to use.

Value: "v1"

Request Body schema: application/json

required	object (DefaultPolicyDefinition)
description	string <= 128 characters (optional) A description for the policy.
	Array of objects (NamespacedPolicyDefinition) The definition of all the policies.
	object (RuntimeDefinition) The runtime properties of this policy.

Responses

200

The response body contains the policy details.

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

Payload
Shell/Curl
Node
Python3
Go

application/json

{"description": "(optional) a descriptive string",
"default": {"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
},
"namespaced": [{"name": "example_ns_policy_definition",
"namespaces": ["dev",
"prod"
],
"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
}
],
"runtime": {"default": {"rulesets": [{"id": "ruleset1-1u8aTLsht8qh2M0d7cPXqxnBfDG"
}
]
}
}
}

Response samples

application/json

{"runtime": {"default": {"rulesets": [{"id": "ruleset1-1u8aTLsht8qh2M0d7cPXqxnBfDG",
"name": "ruleset1"
}
]
}
},
"id": "Policy-1fhJJhPdbKbGK83VL4GjBsFrXIR",
"name": "example_policy",
"description": "My policy description",
"default": {"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
},
"namespaced": [{"name": "example_ns_policy_definition",
"namespaces": ["dev",
"prod"
],
"rules": [{"type": "registry",
"enabled": true,
"action": "block",
"statement": {"key": "equals",
"value": "gcr.io"
}
}
],
"exceptions": [{"type": "registry",
"enabled": true,
"statement": {"key": "equals",
"value": "docker.io"
}
}
]
}
],
"created": "2019-03-01T00:00:00Z",
"updated": "2019-03-01T00:00:00Z",
"rulesetsUpdated": "2019-03-01T00:00:00Z"
}

Delete a policy

delete/policies/{id}

Delete a policy.

SecurityTrend Micro Cloud One API Key

Request

path Parameters

id

required

string

The policy ID.

header Parameters

api-version

string

Default: v1

The version of the API to use.

Value: "v1"

Responses

200

The policy is deleted.

202

The policy has been deleted.

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 DELETE \
  --url https://container.us-1.cloudone.trendmicro.com/api/policies/{id} \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

application/json

{"message": "Something went wrong. To fix it, try ...",
"fields": {"property1": "string",
"property2": "string"
}
}