---
title: "Create volume group snapshot"
method: POST
path: "/volume_group_snapshots"
tags: ["volume_group_snapshot"]
---

# Create volume group snapshot

`POST /volume_group_snapshots`

Given an intentful spec, creates a snapshot with associated metadata.

## Request body

- VolumeGroupSnapshotIntentInput — An intentful representation of a volume_group_snapshot
  - `spec` VolumeGroupSnapshot, required — The input object that defines a volume group snapshot.
    - `name` string — Name of the snapshot.
    - `resources` object — Volume group snapshot resources.
      - `volume_group_reference` VolumeGroupReference — The reference to a volume_group
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
      - `expiration_time_msecs` integer — The time when this snapshot expires and will be garbage collected. If not set, then the snapshot never expires.
  - `api_version` string
  - `metadata` VolumeGroupSnapshotMetadata, required — The volume_group_snapshot kind metadata
    - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when volume_group_snapshot was last updated
    - `kind` string, required — The kind name
    - `uuid` string, UUID — volume_group_snapshot uuid
    - `spec_version` integer — Version number of the latest spec.
    - `creation_time` string, date-time — UTC date and time in RFC-3339 format when volume_group_snapshot was created
    - `spec_hash` string — Hash of the spec. This will be returned from server.
    - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
    - `owner_reference` UserReference — The reference to a user
      - `kind` string, required — The kind name
      - `name` string
      - `uuid` string, UUID, required
    - `categories` object — Categories for the volume_group_snapshot
    - `name` string — volume_group_snapshot name

## Response `202`

Request Accepted

- VolumeGroupSnapshotIntentResponse — Response object for intentful operations on a volume_group_snapshot
  - `status` VolumeGroupSnapshotDefStatus — The output object that defines a volume group snapshot.
    - `state` string — The state of the volume group snapshot.
    - `message_list` MessageResource[] — Any error messages for the volume group snapshot, if in an error state.
      - `message` string, required — If state is ERROR, a message describing the error.
      - `reason` string, required — If state is ERROR, a machine-readable snake-cased string.
      - `details` object — Custom key-value details relevant to the status.
    - `name` string — Name of the snapshot.
    - `resources` object — Volume group snapshot resources.
      - `snapshot_file_list` object[] — Describes the files that are included in the snapshot.
        - `disk_index` integer — Index of the volume disk in the configuration.
        - `snapshot_file_path` string — Path of the snapshot file of the disk.
      - `volume_group_reference` VolumeGroupReference — The reference to a volume_group
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
      - `expiration_time_msecs` integer — The time when this snapshot expires and will be garbage collected. If not set, then the snapshot never expires.
      - `volume_group_spec` VolumeGroupResources — Volume group resources.
        - `flash_mode` string — Flash Mode, if enabled all volume disks of the VG will be pinned to SSD tier.
        - `iscsi_target_name` string — iSCSI target full name
        - `file_system_type` string — File system to be used for volume
        - `size_bytes` integer — The total size of the Volume Group in bytes
        - `sharing_status` string — Whether the volume group can be shared across multiple iSCSI initiators.
        - `attachment_list` AttachmentReference[] — VMs attached to volume group.
          - `vm_reference` Reference — Reference to a kind
            - `kind` string, required
            - `uuid` string, UUID, required
            - `name` string
          - `iscsi_initiator_name` string — Name of the iSCSI initiator of the workload outside Nutanix cluster.
        - `disk_list` VolumeDiskResource[] — Volume group disk specification.
          - `index` integer — Index of the volume disk in the group.
          - `data_source_reference` Reference — Reference to a kind
            - `kind` string, required
            - `uuid` string, UUID, required
            - `name` string
          - `disk_size_mib` integer — Size of the disk in MiB.
          - `disk_size_bytes` integer — Size of the disk in Bytes.
          - `storage_container_uuid` string, UUID — Container UUID on which to create the disk.
        - `size_mib` integer — The total size of the Volume Group in mib
        - `iscsi_target_prefix` string — iSCSI target prefix-name.
  - `spec` VolumeGroupSnapshot — The input object that defines a volume group snapshot.
    - `name` string — Name of the snapshot.
    - `resources` object — Volume group snapshot resources.
      - `volume_group_reference` VolumeGroupReference — The reference to a volume_group
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
      - `expiration_time_msecs` integer — The time when this snapshot expires and will be garbage collected. If not set, then the snapshot never expires.
  - `api_version` string, required
  - `metadata` VolumeGroupSnapshotMetadata, required — The volume_group_snapshot kind metadata
    - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when volume_group_snapshot was last updated
    - `kind` string, required — The kind name
    - `uuid` string, UUID — volume_group_snapshot uuid
    - `spec_version` integer — Version number of the latest spec.
    - `creation_time` string, date-time — UTC date and time in RFC-3339 format when volume_group_snapshot was created
    - `spec_hash` string — Hash of the spec. This will be returned from server.
    - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
    - `owner_reference` UserReference — The reference to a user
      - `kind` string, required — The kind name
      - `name` string
      - `uuid` string, UUID, required
    - `categories` object — Categories for the volume_group_snapshot
    - `name` string — volume_group_snapshot name

## Other responses

- `default` — Internal Error

---

[API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/revisions/40395083ab31/schema)