Skip to main content

BackupResponsePagedResponse

A generic page of results, used by list endpoints across this API.

items object[]nullable

The items on this page.

  • Array [
  • idstring<uuid>

    The unique identifier of the backup.

    vmIdstring<uuid>

    The identifier of the VM this backup belongs to.

    sourceImageIdstring<uuid>nullable

    The id of the OS image the VM was running when this backup was taken, so you can tell which OS the backup will restore. Null for backups created before this field was introduced.

    sizeBytesinteger<int64>

    The size of the backup, in bytes.

    createdAtstring<date-time>

    The date and time (UTC) at which the backup was created.

  • ]
  • totalinteger<int32>

    Total number of items across all pages.

    pageinteger<int32>

    The current page number, starting at 1.

    pageSizeinteger<int32>

    Number of items per page.

    totalPagesinteger<int32>

    Total number of pages available.

    hasNextPageboolean

    Whether a next page is available.

    BackupResponsePagedResponse
    {
    "items": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "vmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sourceImageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sizeBytes": 0,
    "createdAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "total": 0,
    "page": 0,
    "pageSize": 0,
    "totalPages": 0,
    "hasNextPage": true
    }