Data Version Snapshots API Code Samples

Selection of code samples that demonstrate the use of the Data Version Snapshots API. Copy and edit these code samples to suit your needs.

When using the code samples, remember to replace:

  • {vanity_name} with your tenant name
  • {api_key} with your API key
  • {security_token} with a valid security token

These code samples may not include all available parameters and request body fields for each endpoint. For the endpoint's full request schema, see "Data Version Snapshots" in API Reference.

Retrieve data version snapshots

Use this sample request to retrieve all the data version snapshots in your tenant.

Copy
cURL sample request: Retrieve all data version snapshots
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/admin/data-version-snapshots' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns the list of snapshots.

Retrieve a data version snapshot

Use this sample request to retrieve the details of a specific data version snapshot.

Copy
cURL sample request: Retrieve the data version snapshot with ID 3f9a5d2c-8b1e-4c7a-9f2d-1a2b3c4d5e6f
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/admin/data-version-snapshots/3f9a5d2c-8b1e-4c7a-9f2d-1a2b3c4d5e6f' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns the snapshot's details.

Create a data version snapshot

Use this sample request to create a new data version snapshot. This example omits the data version ID and production version ID so it creates a data version snapshot using the latest production version.

Copy
cURL sample request: Create a data version snapshot of the latest production version
curl -X POST --url 'https://{vanity_name}.api.visier.io/v1alpha/admin/data-version-snapshots' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Q1 2026 snapshot"
}'

Use this sample request to create a new data version snapshot of a specific data version.

Copy
cURL sample request: Create a data version snapshot of data version 1024
curl -X POST --url 'https://{vanity_name}.api.visier.io/v1alpha/admin/data-version-snapshots' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Q1 2026 snapshot",
    "dataVersionId": "1024"
}'

The response returns the new snapshot's details.

Delete a data version snapshot

Use this sample request to delete an existing data version snapshot.

Copy
cURL sample request: Delete the data version snapshot with ID 3f9a5d2c-8b1e-4c7a-9f2d-1a2b3c4d5e6f
curl -X DELETE --url 'https://{vanity_name}.api.visier.io/v1alpha/admin/data-version-snapshots/3f9a5d2c-8b1e-4c7a-9f2d-1a2b3c4d5e6f' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns a 200 OK with an empty body.