Scanners

Scanner Registration for use with Cloud One Container Security

Create a scanner

post/scanners

Create a scanner.

Request
header Parameters
api-version
string
Default: v1

The version of the API to use.

Value: "v1"
Request Body schema: application/json
description
string <= 128 characters

If you provided a description for the scanner, it will be returned here.

name
required
string <= 64 characters ^[a-zA-Z0-9._]+$

The friendly name for the scanner.

Responses
201

The registration request has been accepted, the scanner has been created. The body will return the details of the scanner that was created.

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
application/json
{
  • "name": "example_scanner",
  • "description": "My scanner description"
}
Response samples
application/json
{
  • "id": "60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff",
  • "name": "example_scanner",
  • "description": "My scanner description",
  • "lastScanReceived": "2020-03-01T00:00:00Z",
  • "created": "2019-03-01T00:00:00Z",
  • "updated": "2019-03-01T00:00:00Z",
  • "apiKey": "54422daa-a7d9-4007-a37b-a09b34ec2f79"
}

List all scanners

get/scanners

Retrieve a list of scanners.

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

Modify a scanner

post/scanners/{id}

Modify a scanner

Request
path Parameters
id
required
string

The scanner id.

header Parameters
api-version
string
Default: v1

The version of the API to use.

Value: "v1"
Request Body schema: application/json
description
string <= 128 characters

If you provided a description for the scanner, it will be returned here.

Responses
200

The response body contains the scanner 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.

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
application/json
{
  • "description": "My scanner description"
}
Response samples
application/json
{
  • "id": "60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff",
  • "name": "example_scanner",
  • "description": "My scanner description",
  • "lastScanReceived": "2020-03-01T00:00:00Z",
  • "created": "2019-03-01T00:00:00Z",
  • "updated": "2019-03-01T00:00:00Z",
  • "apiKey": "54422daa-a7d9-4007-a37b-a09b34ec2f79"
}

Describe a scanner's details

get/scanners/{id}

Describe a scanner's details

Request
path Parameters
id
required
string

The scanner id.

header Parameters
api-version
string
Default: v1

The version of the API to use.

Value: "v1"
Responses
200

The response body contains the scanner 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
curl --request GET \
  --url https://container.us-1.cloudone.trendmicro.com/api/scanners/{id} \
  --header 'Authorization: REPLACE_KEY_VALUE'
Response samples
application/json
{
  • "id": "60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff",
  • "name": "example_scanner",
  • "description": "My scanner description",
  • "lastScanReceived": "2020-03-01T00:00:00Z",
  • "created": "2019-03-01T00:00:00Z",
  • "updated": "2019-03-01T00:00:00Z",
  • "apiKey": "54422daa-a7d9-4007-a37b-a09b34ec2f79"
}

Delete a scanner

delete/scanners/{id}

Delete a scanner

Request
path Parameters
id
required
string

The scanner id.

header Parameters
api-version
string
Default: v1

The version of the API to use.

Value: "v1"
Responses
204

The request was received and accepted

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 DELETE \
  --url https://container.us-1.cloudone.trendmicro.com/api/scanners/{id} \
  --header 'Authorization: REPLACE_KEY_VALUE'
Response samples
application/json
{
  • "message": "Something went wrong. To fix it, try ...",
  • "fields": {
    }
}