Get Resources

Get Resources

Get a listing of resources based on the query spec specified

Request
URI
GET
https://{api_host}/suite-api/api/resources
COPY
Query Parameters
string of array
name
Optional

Array of resource names to query for.
NOTE: Currently, only single element supported

string of array
regex
Optional

Array of resource names in java regex format.
NOTE: regex and name are mutually exclusive. If both are specified, name is given preference.

string of array
adapterKind
Optional

Array of Adapter Kind keys

string of array
resourceKind
Optional

Array of Resource Kind keys

string of array
collectorName
Optional

Array of Collector names

integer of array
collectorId
Optional

Array of Collector Identifiers

string of array
maintenanceScheduleId
Optional Deprecated

Array of {@link UUID} that identify Maintenance Schedules.
Since vROps 6.1.0 release onwards, we don't support search
and look up of Resources using Maintenance Schedules' identifiers.

string of array
adapterInstanceId
Optional

Array of uuids that identify adapter instances

integer
recentlyAdded
Optional

Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT.

resourceState
Optional

Array of resource states. NOTE, the following states are applicable only for adapter instances: STOPPED, STARTING, STOPPING, UPDATING, FAILED, REMOVING

resourceStatus
Optional

Array of resource data collection statuses. NOTE, the following statuses are applicable only for adapter instances: ERROR, DOWN, COLLECTOR_DOWN. The statuses OLD_DATA_RECEIVING, NO_PARENT_MONITORING and UNKNOWN are deprecated.

resourceHealth
Optional

Array of resource health

string of array
parentId
Optional

Array of UUID of object that are the parent resource in a parent child relationship

string of array
credentialId
Optional

Array of CredentialIDs

string of array
resourceId
Optional

Array of Resource Identifiers

string
propertyName
Optional

Name of property. Query only supports filtering for a single property.

string
propertyValue
Optional

Value of property. Omitting the property value will check for existence
of the property name on the resource.
NOTE: Use 'propertyConditions' to specify lookup of Resource using multiple properties.

string
statKey
Optional

Name of resource StatKey to validate value is within a range.
Use with statKeyLowerBound, statKeyUpperBound and statKeyInclusive to create comparison conditions
NOTE: Use 'statConditions' to specify lookup of Resource using multiple stat keys.

number
statKeyLowerBound
Optional

StatKey value matching range lower bound

number
statKeyUpperBound
Optional

StatKey value matching range upper bound

boolean
statKeyInclusive
Optional

Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to true

string
includeRelated
Optional

None null value specifies to include related resource ids of given relationship type in resource result.
Uses the RelationshipType.representation value.

Possible values are : PARENT, CHILD,
integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 1000

Expected number of entries per page


Authentication
This operation uses the following authentication methods.
Responses
200

The Collection of Resources matching the specified query parameters

Returns resources of type(s) application/json
"No Custom Example is Available"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
resourceList
Optional

The Collection of Resources


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/resources