Get a list of CSP machine images

get/virtualization/v1beta1/csp-machine-images

Returns a list of cloud service provider (CSP) machine images based on the query parameters for paging, filtering, and sorting.

Securitybearer
Request
query Parameters
offset
integer >= 0
Default: 0

The number of items to omit from the beginning of the result set. Use offset in conjunction with limit for pagination, for example "offset=30&limit=10" indicates the fourth page of 10 items.

Example: offset=30
limit
integer <int32> [ 0 .. 1000 ]
Default: 20

The maximum number of items to include in the response. Use offset in conjunction with limit for pagination, for example "offset=30&limit=10" indicates the fourth page of 10 items.

Example: limit=10
filter
string

An expression to filter the results.

Filtering is supported with following attributes:

  • name
  • cspInfo.id
  • cspInfo.region
  • cspInfo.architecture
  • cspInfo.state
  • cspInfo.hypervisor
  • cspInfo.rootDeviceType
  • cspInfo.rootDeviceName
  • cspInfo.virtualizationType
  • cspType
  • cspInfo.location
  • cspInfo.ownerId
Example: filter=filter=hypervisor eq 'hvm' and region eq 'eu-west-3'
sort
string
Default: "name asc"

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc").

Example: sort=name asc
select
string

A list of properties to include in the response.

Example: select=id,name,state
Responses
200

List of CSP machine images

400

Bad Request.

401

Unauthenticated request

403

Unauthorized request

500

An unexpected error occurred.

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