38.7. listSnapshots
- Name
- listSnapshots
- Description
- List snapshots for a given system. A user may optionally provide a start and end date to narrow the snapshots that will be listed. For example,
- If the user provides startDate only, all snapshots created either on or after the date provided will be returned.
- If user provides startDate and endDate, all snapshots created on or between the dates provided will be returned.
- If the user doesn't provide a startDate and endDate, all snapshots associated with the server will be returned.
Available since: 10.1 - Parameters
- string sessionKey
- int serverId
- struct - date details
- dateTime.iso8601
startDate- Optional, unless endDate is provided. - dateTime.iso8601
endDate- Optional.
- Return Value
- array:
- struct - server snapshot
- int
id - string
reason- the reason for the snapshot's existence - dateTime.iso8601
created - array
channels- string - labels of channels associated with the snapshot
- array
groups- string - Names of server groups associated with the snapshot
- array
entitlements- string - Names of system entitlements associated with the snapshot
- array
config_channels- string - Labels of config channels the snapshot is associated with.
- array
tags- string - Tag names associated with this snapshot.
- string
Invalid_reason- If the snapshot is invalid, this is the reason (optional).
