Snapservice.Clusters.VirtualMachines.Snapshots.FilterSpec

The Snapservice.Clusters.VirtualMachines.Snapshots.FilterSpec schema contains properties used to filter the results when listing snapshots for a protection group. See GET /snapservice/clusters/{cluster}/virtual-machines/{vm}/snapshots. When multiple filters are specified, it operates as an AND operation. The snapshots returned will match all the specified filters.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "expires_after": "string",
    "expires_before": "string",
    "created_after": "string",
    "created_before": "string",
    "snapshot_type": "string"
}

string As date-time As date-time

expires_after

Optional

Minimum expiration time for the snapshots that must match the filter.

This property was added in vSphere API 8.0.3.0.

If missing or null snapshots with any expiration time match the filter.

string As date-time As date-time

expires_before

Optional

Maximum expiration time for the snapshots that must match the filter.

This property was added in vSphere API 8.0.3.0.

If missing or null snapshots with any expiration time match the filter.

string As date-time As date-time

created_after

Optional

Minimum creation date for the snapshots that must match the filter.

This property was added in vSphere API 8.0.3.0.

If missing or null snapshots with any creation time match the filter.

string As date-time As date-time

created_before

Optional

Maximum creation date for the snapshots that must match the filter.

This property was added in vSphere API 8.0.3.0.

If missing or null snapshots with any creation time match the filter.

string

snapshot_type

Optional

Snapshot type that must match the filter.

Possible values:

SCHEDULED: Indicates that a snapshot was taken as part of a periodic schedule.
ONE_TIME: Indicates that the snapshot was taken as a one time operation triggered by the user.
SYSTEM_CREATED: Indicates that the snapshot was taken by the system

For more information see: Snapservice.Clusters.VirtualMachines.Snapshots.Type.

This property was added in vSphere API 8.0.3.0.

If missing or null snapshots with any type match the filter.