Get information about the specified system's servers.

get/private-cloud-business/v1beta1/systems/{id}/servers

Get server information by system id

Returns details about the servers for the specified system id. Retrieving all of the properties for all servers in a system can take a long time because the amount of data is large. Use the 'select' query parameter to choose only the properties you want to retrieve.

For example, to get the server id, name, serial number and hypervisor host, use ?select=id,name,serialNumber,hypervisorHost

Securitybearer
Request
path Parameters
id
required
string <uuid>

Unique Identifier of the system, usually a UUID.

query Parameters
select
string

Query parameter listing the properties of Server information to fetch.

Example: select=id,name,serialNumber,hypervisorHost
offset
integer

Use offset in conjunction with limit for paging, e.g.: offset=30&&limit=10. Offset is the number of items from the beginning of the result set to the first item included in the response.

Example: offset=30
limit
integer <int32> [ 10 .. 100 ]
Default: 10

Use limit in conjunction with offset for paging, e.g.: offset=30&&limit=10. Limit is the maximum number of items to include in the response.

Example: limit=10
filter
string

The expression to filter responses.

Example: filter=health/overallHealth eq OK
sort
string

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified the default order is ascending.

Example: sort=id desc,name asc
Responses
200

Success

400

Bad Request

401

The current user is not authorized to perform the requested operation.

404

Not Found

500

Internal Server Error

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