List all servers

get/compute-ops-mgmt/v1/servers

Retrieve data for all Servers

Servers without a valid subscription will not return the following:

  • hardware.health
  • hardware.memoryMb
  • hardware.formFactor
  • hardware.bmc
  • hardware.platform
  • hardware.powerState
  • hardware.indicatorLed
  • firmwareInventory
  • softwareInventory
  • lastFirmwareUpdate
  • host
  • firmwareBundleUri
  • tags
  • originIp
  • biosFamily
  • storageInventory
  • processorVendor
  • autoIloFwupdate
  • serverGeneration
  • connectionType
  • oneview
SecurityBearer
Request
query Parameters
offset
integer >= 0
Default: 0

Zero-based resource offset to start the response from

Example: offset=10
limit
integer [ 0 .. 100 ]

The maximum number of records to return.

Example: limit=10
filter
string

Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.

NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents. Server IDs contain a +, which must be encoded as %2B.
For example: the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.

CLASS EXAMPLES
Types integer, decimal, timestamp, string, boolean, null
Operations eq, ne, gt, ge, lt, le, in
Logic and, or, not

Servers can be filtered by:

  • biosFamily
  • createdAt
  • firmwareBundleUri
  • hardware and all nested properties
  • host and all nested properties
  • id
  • name †
  • oneview and all nested properties
  • platformFamily
  • processorVendor
  • resourceUri
  • state and all nested properties

† When searching for a server using the name filter, you must supply the serial number of the server, not the hostname. To filter by hostname use host/hostname instead of name

The following examples are not an exhaustive list of all possible filtering options.

Examples:
Return servers where a property equals a value. <property> eq <value>
filter=host/hostname eq 'myServer'
Return servers where a nested property equals a value. <property>/<nestedProperty> eq <value>
filter=state/managed eq 'true'
Return servers where a property equals a value, using a url. <property>%20eq%20%27<value>
filter=id%20eq%20%27497f6eca-6276-4993-bfeb-53cbbbba6f08
Return servers where a property does not equal a value not <property> eq <value>
filter=not name eq 'MXQ89990RR'
Return servers with populated property. not <property> eq null
filter=not name eq null
Return servers where property contains a value. contains(<property>, <value>)
filter=contains(createdAt,'2019')
Return servers where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)
filter=not name eq null and contains(createdAt,'2019')
Return servers where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)
filter=state/managed in ('true','false')
header Parameters
Tenant-Acid
string <uuid>

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Responses
200

OK

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "count": 1,
  • "total": 12,
  • "items": [
    ]
}