Query the resolvers on this Site for available resources.

Prev Next
Get
/sites/{id}/resources

Query the resolvers on this Site for available resources. Controller will make a query to a random Gateway which will query the resolver providers in turn for the given parameters.

Security
HTTP
Type bearer
Path parameters
id
string (uuid) Required

ID of the object.

Example12699e27-b584-464a-81ee-5b4784b6d425
Query parameters
query
string

Query string to filter the result list. It's used for various fields depending on the object type. Send multiple query parameters to make the queries more specific.

range
string

'Range string to limit the result list. Format: -. 3-10 means he items between the (including) 3rd and the 10th will be returned. Defaults to all objects.'

Example0-10
resolver
stringRequired

Resolver type to query.

Valid values[ "aws", "azure", "gcp", "illumio", "esx", "dns" ]
type
stringRequired

Resource type to query.

Valid values[ "instances-security-groups", "instances-tags", "instances-tag-values", "lbs", "lbs-security-groups", "lbs-tags", "lbs-tag-values", "lbsv2", "lbsv2-security-groups", "lbvs2-tags", "lbvs2-tag-values", "enis-security-groups", "enis-security-groups-ids", "enis-tags", "enis-tag-values", "regions", "accounts", "network-security-groups", "network-security-groups-tags", "network-security-groups-tag-values", "virtual-machines-tags", "virtual-machines-tag-values", "virtual-networks", "subnets", "projects-ids", "forwarding-rules", "instances", "instances-network-tags", "service-account-emails", "labels", "virtual-machines", "folders", "resources-pools", "tags", "zones", "zone-values", "eks-clusters", "eks-cluster-tags", "eks-cluster-tag-values", "rds-db-instances", "rds-db-instance-tags", "rds-db-instance-tag-values" ]
value
string

Optional parameter to search for values. Used with "...-tag-values" types.

Responses
200

Query result.

Expand All
object
range
string

The range applied to the list. Format: -/. 3-5/8 means, out of 8 count (query affects the total), the items between (including) the 3rd and the 5th are returned.

Example0-30/54
orderBy
string

The field name used to sort the list.

Examplename
descending
boolean

Whether the sorting is applied descending or ascending.

queries
Array of string

The queries applied to the list.

string
totalCount
integer

The total readable count of entities. Not influenced by the query.

Example328
filterBy
Array of object (FilterBy)

The filters applied to the list.

object
name
string

The field name the filter is applied to.

Examplename
value
string

The value used for comparison.

ExampleAWS
data
Array of string

List of queries resources.

string
Exampletest-web-server
resolver
string

Resolver type.

Valid values[ "aws", "azure", "gcp", "illumio", "esx", "dns" ]
type
string

Resource type.

Valid values[ "instances-security-groups", "instances-tags", "instances-tag-values", "lbs", "lbs-security-groups", "lbs-tags", "lbs-tag-values", "lbsv2", "lbsv2-security-groups", "lbvs2-tags", "lbvs2-tag-values", "enis-security-groups", "enis-security-groups-ids", "enis-tags", "enis-tag-values", "regions", "accounts", "network-security-groups", "network-security-groups-tags", "network-security-groups-tag-values", "virtual-machines-tags", "virtual-machines-tag-values", "virtual-networks", "subnets", "projects-ids", "forwarding-rules", "instances", "instances-network-tags", "service-account-emails", "labels", "virtual-machines", "folders", "resources-pools", "tags", "zones", "zone-values", "eks-clusters", "eks-cluster-tags", "eks-cluster-tag-values", "rds-db-instances", "rds-db-instance-tags", "rds-db-instance-tag-values" ]
gatewayName
string

The name of the Gateway which returned the result.

401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.