Resources

Managing Conformity resources.

Get Excluded Resources

get/resources

This endpoint allows a user with FULL access to get the list of excluded resources due to exceptions been configured.

There is a 10k limit to the maximum number of excluded resources that can be returned. Paging will not work for excluded resources higher than this limit. To fetch larger numbers, segment your requests using account and/or region filtering. On larger organisations, filter requests per account, per region or provider to avoid timeouts

Filtering

The filter query parameter is reserved to be used as the basis for filtering.

For example, the following is a request for a page of excluded resources filtered by cloud provider AWS:

GET /resources?excluded=true&accountIds=r1gyR4cqg&page[size]=100&page[number]=0&filter[providers]=aws

Multiple filter values can be combined in a comma-separated list. For example the following is a request for a page of excluded resources in us-west-2 or us-west-1 regions:

GET /resources?excluded=true&accountIds=r1gyR4cqg&page[size]=100&page[number]=0&filter[regions]=us-west-1,us-west-2

Furthermore, multiple filters can be applied to a single request. For example, the following is a request to get excluded resources for us-west-2 region when the provider of the resource is aws

GET /resources?excluded=true&accountIds=r1gyR4cqg&page[size]=100&page[number]=0&filter[regions]=us-west-2&filter[tags]=MyBucket

The table below give more information about filter options:

Name	Values
filter[regions]	Example: global \| us-east-1 \| us-east-2 \| southafricanorth \| southafricawest For a complete list, please refer to Cloud Conformity Region Endpoint
filter[tags]	Any assigned metadata tags to your resources
filter[providers]	Cloud providers. Accepted values: ["aws" \| "azure" \| "gcp"]

SecurityApiKeyAuth

Request

query Parameters

accountIds	string A comma-separated list of Cloud Conformity accountIds. If not specified, results will be returned for all accounts the user has access to. Example: accountIds=r1gyR4cqg,W5xs6srh2
excluded required	string true for returning excluded resources. Currently only `true` is supported. Value: true
filter[providers]	string Used to filter based on the cloud providers. Accepts a comma-separated list of providers. Example: filter[providers]=aws,azure
filter[regions]	string Used to filter based on provider regions. Accepts a comma-separated list of regions. Example: filter[regions]=us-east-1,eu-west-1,ap-southeast-2
filter[tags]	string Used to filter based on Any assigned metadata tags to your resources. Accepts a comma-separated list of tags. Example: filter[tags]=tag1,tag2,tag3
page[number]	number Default: 0 Indicates the page number. Example: page[number]=2
page[size]	number <= 2000 Default: 100 Indicates the number of excluded resources that should be returned. Example: page[size]=200

Responses

200

401

Unauthorized. When the API Key is not provided.

403

Unauthorized. The requesting user does not have enough privilege.

Response samples

application/json

{"data": [{"type": "resources",
"id": "ccrn:aws:r1gyR4cqg:CloudFormation:us-west-2:CloudConformityMonitoring",
"attributes": {"account-id": "r1gyR4cqg",
"ccrn": "ccrn:aws:r1gyR4cqg:CloudFormation:us-west-2:CloudConformityMonitoring",
"resource": "CloudConformityMonitoring",
"region": "us-west-2",
"descriptor-type": "cfm-stack",
"link": "https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks?filter=active",
"link-title": "CloudConformityMonitoring",
"resource-name": "CloudFormation Stack",
"tags": ["Version::4"
],
"provider": "aws",
"excluded-rules": [{"rule-id": "CFM-001"
}
]
}
}
]
}

➔ Next to Services