Resources

A resource is a tracked object inside of a project such as an EC2 instance, S3 bucket, or AWS Lambda Function.

List resources inside of a project

get/api/projects/{projectID}/resources

List the resources inside of a project

SecuritycloudOneToken or cloudOneAPIKey
Request
path Parameters
projectID
required
string

The projectID

query Parameters
cursor
string

An encoded value used to retrieve the next set of results for a query that returns more results than the provided limit. It uses the next value from the previous response.

Example: cursor=eyJrIjoiMXVLa2lsb3B2RnhsS0FuYUU0bThqUmVjZDdCIiwibiI6IkJUY2hRU2pOVDBSUjc0cHUifQ.EilR0MPcmh9JdsQ1omPx1cJQvh_RjDwI_AnHAWu-G1YSN9ZTjoKswEhDObUaefE8nf97AlccfogXrvrcjfpE7gDJCz4oI-6rfM43E9T_Or3uyOG3OgHoK9eyUX-qv8WTYwnf1tzwVN1e1D4B0Kr81yQBi2Y-MdeIH60rkOFI42w6I9fEJRDnPRoFqRn2Hw70ehjrCRpkeRKS9emduCL_YNZmjNEst1i6heg5-sqtkBYrYaqWecKJ5rqskQN_apfrX-BEfh6Ph2j7hYKJ6s32j3dOGR9paTFikewtKWMXBcy6kW5uZqGwO05sVW1Wy6HavxpNm5ha50WKotoEndvzuW0RasT9YLbCry1qRYt3X8NKybpERt2u7lRHNSY3DuVtbXbeR9oUzsO1Br31ywH0dBkn3WsfPYFOaEt0htVo0_DlDZh-0oH4PdzvCkzDQn-EM8u9PCxzvxSMGtQ_UXcDxEZcUgfgnLQy4Fu2AHumF136tXZyTh8GAd-mLqC6xtvOXJTDF7s0TxQ7A57d9C1EDrEJOBuq
limit
integer

The maximum numbers of records to return. It accepts an integer ranging from 1 to 50. Otherwise, the request will be rejected.

Example: limit=50
sort
string

The property to sort by. A - in front of the property indicates a descending order, the property name by itself indicates ascending order. Only one sortable property is allowed.

Enum: "-type" "type" "-name" "name" "-lastScan" "lastScan"
type
string

The type of the resource

Enum: "aws-ec2-instance" "aws-lambda-function" "aws-ecr-repository"
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The resources inside of a project

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. 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

The service has encountered an unexpected internal error. 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.

Response samples
application/json
{
  • "resources": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}

Describe a count of resources inside of a project

get/api/projects/{projectID}/resources/counts

Describe a count of resources inside of a project

SecuritycloudOneToken or cloudOneAPIKey
Request
path Parameters
projectID
required
string

The projectID

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The count of resources in a project

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. 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

The service has encountered an unexpected internal error. 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.

Response samples
application/json
{
  • "total": 10,
  • "counts": {
    }
}

Describe a single resource inside of a project

get/api/projects/{projectID}/resources/{resourceID}

Describe a single resource inside of a project

SecuritycloudOneToken or cloudOneAPIKey
Request
path Parameters
projectID
required
string

The projectID

resourceID
required
string

The resourceID

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

A single resource inside of a project

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. 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

The service has encountered an unexpected internal error. 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.

Response samples
application/json
{
  • "details": {
    },
  • "id": "89aa5c20-b23b-4db1-ab7f-93bd96d46e8f",
  • "lastScan": "2022-05-13T15:06:53Z",
  • "cloudResourceID": "arn:aws:lambda:us-east-1:012345678912:function:my-lambda",
  • "name": "my-first-lambda",
  • "type": "aws-lambda-function"
}