38.4. deleteSnapshots

Name
deleteSnapshots
Description
Deletes all snapshots for a given system based on the date criteria. For example,
  • If the user provides startDate only, all snapshots created either on or after the date provided will be removed.
  • If user provides startDate and endDate, all snapshots created on or between the dates provided will be removed.
  • If the user doesn't provide a startDate and endDate, all snapshots associated with the server will be removed.
Available since: 10.1
Parameters
  • string sessionKey
  • int sid - system id of system to delete snapshots for
  • struct - date details
    • dateTime.iso8601 startDate - Optional, unless endDate is provided.
    • dateTime.iso8601 endDate - Optional.
Return Value
  • int - 1 on success, exception thrown otherwise.