VolumeSnapshot

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "VolumeSnapshot",
  "description": "VolumeSnapshot schema from FlashArray REST API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-volume-snapshot-schema.json",
  "allOf": [
    {
      "description": "An ordinary (as opposed to built-in) resource that can be created, named,\nrenamed or deleted by the user. This might be a virtual resource (e.g., a\nfile system), or correspond to something in the environment, like a host or a\nserver.\n",
      "type": "object",
      "properties": {
        "id": {
          "description": "A globally unique, system-generated ID.\nThe ID cannot be modified and cannot refer to another resource.\n",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "A user-specified name.\nThe name must be locally unique and can be changed.\n",
          "type": "string"
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "created": {
          "description": "The snapshot creation time. Measured in milliseconds since the UNIX epoch.\n",
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "destroyed": {
          "description": "Returns a value of `true` if the snapshot has been destroyed and is pending eradication.\nThe `time_remaining` value displays the amount of time left\nuntil the destroyed volume snapshot is permanently eradicated.\nBefore the `time_remaining` period has elapsed, the destroyed volume snapshot can be recovered\nby setting `destroyed=false`.\nOnce the `time_remaining` period has elapsed,\nthe volume snapshot is permanently eradicated and can no longer be recovered.\n",
          "type": "boolean"
        },
        "pod": {
          "description": "A reference to the pod.\n",
          "title": "FixedReference",
          "allOf": [
            {
              "$ref": "#/components/schemas/_fixedReference"
            }
          ]
        },
        "provisioned": {
          "description": "The provisioned space of the snapshot. Measured in bytes. The minimum size is 1048576 (1MB),\nthe maximum size is 4503599627370496 (4PB)\n",
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "source": {
          "description": "The volume from which this snapshot was taken.\nFor a replicated snapshot being viewed on the target side, the\n`source` is the replica volume.\n",
          "title": "FixedReference",
          "allOf": [
            {
              "$ref": "#/components/schemas/_fixedReference"
            }
          ]
        },
        "suffix": {
          "description": "The suffix that is appended to the `source_name` value to generate the full\nvolume snapshot name in the form `VOL.SUFFIX`.\nIf the suffix is not specified, the system constructs the snapshot name in the form `VOL.NNN`,\nwhere `VOL` is the volume name, and `NNN` is a monotonically increasing number.\n",
          "type": "string"
        },
        "time_remaining": {
          "description": "The amount of time left until the destroyed snapshot is permanently eradicated.\nMeasured in milliseconds.\nBefore the `time_remaining` period has elapsed, the destroyed snapshot can be recovered\nby setting `destroyed=false`.\n",
          "type": "integer",
          "format": "int64",
          "readOnly": true
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "context": {
          "description": "The context in which the operation was performed.\n\nValid values include a reference to any array which is a member of the same fleet\nor to the fleet itself.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n",
          "readOnly": true,
          "title": "FixedReferenceWithType",
          "allOf": [
            {
              "$ref": "#/components/schemas/_fixedReferenceWithType"
            }
          ]
        }
      }
    },
    {
      "description": "A point-in-time image of the contents of the volume.\n",
      "type": "object",
      "properties": {
        "serial": {
          "description": "A serial number generated by the system when the snapshot is created.\nThe serial number is unique across all arrays.\n",
          "type": "string",
          "readOnly": true
        },
        "space": {
          "description": "Displays size and space consumption information.\n",
          "title": "SnapshotSpace",
          "allOf": [
            {
              "$ref": "#/components/schemas/_snapshotSpace"
            }
          ]
        },
        "volume_group": {
          "description": "The volume group to which the volume that is the source of the volume snapshot belongs.\n",
          "title": "FixedReference",
          "allOf": [
            {
              "$ref": "#/components/schemas/_fixedReference"
            }
          ]
        }
      }
    }
  ]
}