Return all snapshot ids of a client

GET 
/v2/modules/:module/setups/:setupId/clients/:clientId/snapshots

Lists all versioned snapshots of the specified client. Snapshots capture the client configuration at a specific point in time, including past, present, and scheduled future states. Use validAt to retrieve only snapshots effective at a given date, and includeSoftDeletedStates to include soft-deleted states in the result.

Request

Path Parameters

module stringrequired
setupId stringrequired
clientId stringrequired

Query Parameters

validAt any
includeSoftDeletedStates boolean

Responses

200

A list of snapshot IDs for the specified client

application/json

Schema

Schema

snapshotIds string[]

Example (from schema)

{
  "snapshotIds": [
    "string"
  ]
}

400

The validAt parameter is present but has an invalid date format

404

No client exists with the specified ID in this setup

Loading...