v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Resources

Get resources matching rules

Returns the list of resources matching the rules provided.

post/organizations/{organization_id}/accounts/{account_id}/rules/resources

Path parameters

organization_idstring required

Organization Id of the Organization that you are working with. This can be found by looking at the organization id in the URL of the dashboard. These are randomly generated alphanumber values

account_idstring required

Account id of the CloudRanger Account that you are managing inside an organization, these can be found by call the /organizations/{organization_id}/accounts endpoints which returns all accounts inside an Organization These are randomly generated alphanumber values

Query parameters

environment_idinteger

The ID of the environment that you want to perform the request against. These can be found by the GET call /organizations/:organization_id/accounts/:account_id/environments which returns all envionments inside an account

filterstring

Filter object containing keys that can be one or more of [region, tags, types, hasbackuppolicy, hasschedule, resource_id, resource_name, accounts]. Values must be a an array of strings. EG: {"region": ["us-east-1"]}

pageSizeinteger

The number of records to be returned for a single page for the request.

offsetinteger

Defines the offset from the first result you want to fetch.

Request body

resource_typesstring[]
regionsstring[]
idinteger
dr_plan_idinteger
rule_typestring
all_resource_typesboolean
excludeboolean
createdAtstring date-time
updatedAtstring date-time
resourcesstring[]
matchinteger
protectedStatusstring

Response

200 response

totalinteger