List all servers

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The old prefix will continue to be supported to allow for a smooth transition. The Guide contains more information about this change.

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:

Filter with equality check

Return servers where a property equals a value. <property> eq <value>

filter=host/hostname eq 'myServer'

Filter with equality check on a nested attribute

Return servers where a nested property equals a value. <property>/<nestedProperty> eq <value>

filter=state/managed eq 'true'

Filter with url encoding applied to all reserved characters (example is fully URL encoded)

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

Filter on an inverted query

Return servers where a property does not equal a value not <property> eq <value>

filter=not name eq 'MXQ89990RR'

Filter that a property contains a value

Return servers with populated property. not <property> eq null

filter=not name eq null

Filter that field value contains a specific substring

Return servers where property contains a value. contains(<property>, <value>)

filter=contains(createdAt,'2019')

Filter on multiple conditionals

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')

Filter for a value to have one of multiple possibilities

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

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

Request samples

curl
JavaScript
Python
Go

Response samples

application/json

{"offset": 0,
"count": 1,
"total": 12,
"items": [{"id": "string",
"name": "myServer",
"type": "compute-ops-mgmt/server",
"resourceUri": "/compute-ops-mgmt/v1beta2/servers/875765-S01+1M512501AB",
"generation": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"platformFamily": { },
"serverGeneration": "GEN_10",
"hardware": {"serialNumber": "string",
"model": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"productId": "string",
"powerState": "UNKNOWN",
"indicatorLed": "UNKNOWN",
"health": {"summary": "UNKNOWN",
"fans": "UNKNOWN",
"fanRedundancy": "NON_REDUNDANT",
"liquidCooling": "UNKNOWN",
"liquidCoolingRedundancy": "NON_REDUNDANT",
"memory": "UNKNOWN",
"network": "UNKNOWN",
"powerSupplies": "UNKNOWN",
"powerSupplyRedundancy": "NON_REDUNDANT",
"processor": "UNKNOWN",
"storage": "UNKNOWN",
"temperature": "UNKNOWN",
"bios": "UNKNOWN",
"smartStorage": "UNKNOWN",
"healthLED": "UNKNOWN"
},
"platform": "string",
"formFactor": "string",
"bmc": {"mac": "string",
"ip": "string",
"hostname": "string",
"license": "string"
},
"memoryMb": { }
},
"state": {"managed": true,
"connected": true,
"connectedModifiedAt": "2019-08-24T14:15:22Z",
"subscriptionState": "REQUIRED",
"subscriptionTier": "Enhanced",
"subscriptionExpiresAt": "2019-08-24T14:15:22Z"
},
"firmwareInventory": [{"name": "string",
"version": "string",
"deviceContext": "string"
}
],
"softwareInventory": [{"name": "string",
"version": "string",
"deviceContext": "string"
}
],
"firmwareBundleUri": "string",
"lastFirmwareUpdate": {"status": "OK",
"attemptedAt": "2019-08-24T14:15:22Z",
"firmwareInventoryUpdates": [{"name": "string",
"version": "string",
"status": "OK"
}
]
},
"tags": {"location": "San Jose"
},
"processorVendor": "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz",
"biosFamily": "string",
"host": {"osName": "string",
"osVersion": "string",
"hostname": "string",
"osDescription": "string",
"osType": 0
},
"autoIloFwUpdate": true,
"oneview": {"applianceUri": "string",
"maintenanceMode": true,
"name": "string",
"state": "string"
},
"lastFullInventoryCollectionAt": "2019-08-24T14:15:22Z",
"lastFullInventoryCollectionPowerState": "string"
}
]
}