Actions available for resources. You will need a resource ID.
get
Gets basic metadata about a resource.
Parameters:
--company [company_id]
--id [12345]
--resource-id [cloud-resource-id]
--latest-configuration (optional) [boolean]get-compliance
Gets compliance check details for a resource.
Parameters:
--company [company_id]
--id [12345]
--resource-id [cloud-resource-id]
--status [open | remediated | policy-exception | mitigation]get-drift
Gets change records for a resource.
Parameters:
--company [company_id]
--id [12345]
--resource-id [cloud-resource-id]
--status [new | inprogress | acknowledged | resolved]
--concern "concern name"
--type [configuration_alert | security_alert]get-metric-names
Fetches metric names for a resource.
Parameters:
--company [company slug]
--id [12345]
--resource-id [cloud-resource-id]get-tags
Gets tags attached to a resource.
Parameters:
--company [company_id]
--id [12345]
--resource-id [cloud-resource-id]list
Lists a set of resources that match any given criteria.
Parameters:
--company [company_id]
--accounts [account_id]
--ids [12345]
--resource-ids [cloud-resource-id]
--cloud-providers [aws | azure | gcp | microsoft365]
--resource-types [resource-type-name]
--region-ids [region-id]
--tags [tag-value]
--resource-creation-date-beginning ["2020-11-11 00:00:00.000"]
--resource-creation-date-end ["2021-11-11 00:00:00.000"]
--open-compliance-issues [true | false]
--unacknowledged-changes [true | false]
--skip [12345]add-tags
Attaches one or more tags to a resource.
Parameters:
--company [company_id]
--id [12345]
--resource-id [cloud-resource-id]
--tag [tag-value]remove-tags
Removes one or more tags to a resource.
Parameters:
--company [company_id]
--id [12345]
--resource-id [cloud-resource-id]
--tag [tag-value]get-usage-analytics
Calculates the resource usage analytics for given criteria.
Parameters:
--id [resource_id]
--metric-type [string]
--analysis-type (optional) [string]
--grouping-period (optional) [h | d | m | y]
--calculated-at-from (optional) [2021-09-01T00:00:00.000Z]
--calculated-at-to (optional) [2023-10-01T00:00:00.000Z]get-metric-names-for-resource-type
Fetches metric names for provided resource type.
Parameters:
--company [company slug]
--resource-type [string]upload-metrics
Uploads a file of metrics for a resource.
Parameters:
--company [company_id]
--account [account_id]
--resource-id [cloud-resource-id]
--metrics [path to metrics file]scan (beta)
Queues the requested resources / account for scanning. Currently only accessible through beta.
Parameters:
--company [company slug]
--account [account_id]
--ids (optional) [resource numeric id] Example: --ids 12345,56854,104455
--resourceIds (optional) [resource cloud id] Example: --resourceIds arn:aws:ec2:us-east-1:444855252760:customer-gateway/1234
--resourceTags (optional) [tag-value]get-latest-configuration
Gets the latest configuration for a resource.
Parameters:
--company [company_id]
--id [resource id]
--resource-id [cloud-resource-id]get-overprovisioned
Gets resources that have been marked as being overprovisioned.
Parameters:
--company [company_id]get-metric-check-results
Gets the metric check results for a resource.
Parameters:
--company [company_id]
--id [resource id]
--resource-id [cloud-resource-id]get-aggregate-metrics
Gets the aggregate metrics for a resource.
Parameters:
--granularity ['Day' or 'Hour']
--metric-check-result-id (optional) [metric check result id]
--offset (optional) [number] assists in pagination of records, default is 0
--limit (optional) [number] assists in pagination of records, default is 100, max is 250
--resource-id (optional) [database resource id]
--metric-type (optional) [string]
--calculated-at-from (optional) [timestamp]
--calculated-at-to (optional) [timestamp]