Pure Storage Volume Snapshots API

openapi: 3.2.0
info:
  title: FlashArray REST Active Directory Volume Snapshots API
  version: '2.52'
  description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos

    or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by

    mapping identities across the NFS and SMB protocols by using LDAP queries.

    '
servers:
- url: /
tags:
- name: Volume Snapshots
  description: 'Volume snapshots are immutable, point-in-time images of the contents of one or more volumes.

    There are two types of volume snapshots: volume snapshots and protection group volume

    snapshots. A volume snapshot is a snapshot that captures the contents of a single volume.

    A protection group volume snapshot is a volume snapshot that is created from a group of

    volumes that are part of the same protection group. All of the volume snapshots created from a

    protection group snapshot are point-in-time consistent with each other.

    '
paths:
  /api/2.52/volume-snapshots:
    get:
      tags:
      - Volume Snapshots
      summary: Pure Storage List Volume Snapshots
      description: 'Displays a list of volume snapshots, including those pending eradication.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Destroyed'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Source_ids'
      - $ref: '#/components/parameters/Source_names'
      - $ref: '#/components/parameters/Total_item_count'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeSnapshotGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeSnapshotGetResponse'
    post:
      tags:
      - Volume Snapshots
      summary: Pure Storage Create a Volume Snapshot and Tags
      description: 'Creates a point-in-time snapshot of the contents of a volume.

        The `source_ids` or `source_names` parameter is required, but they cannot be set together.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_throttle_snapshot'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/OnSingle'
      - $ref: '#/components/parameters/Source_ids'
      - $ref: '#/components/parameters/Source_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VolumeSnapshotPost'
        required: true
        x-codegen-request-body-name: volume-snapshot
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeSnapshotResponse'
      x-codegen-request-body-name: volume-snapshot
    delete:
      tags:
      - Volume Snapshots
      summary: Pure Storage Delete a Volume Snapshot
      description: 'Deletes a volume snapshot that has been destroyed and is pending eradication.

        Eradicated volume snapshots cannot be recovered.

        Volume snapshots are destroyed by using the `PATCH` method.

        The `ids` or `names` parameter is required, but they cannot be set together.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Replication_snapshot'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - Volume Snapshots
      summary: Pure Storage Modify a Volume Snapshot
      description: 'Modifies a volume snapshot by renaming, destroying, or recovering it.

        To rename the suffix of a volume snapshot, set `name` to the new suffix name.

        To recover a volume snapshot that has been destroyed and is pending eradication,

        set `destroyed=true`.

        The `ids` or `names` parameter is required, but they cannot be set together.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Replication_snapshot'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VolumeSnapshotPatch'
        required: true
        x-codegen-request-body-name: volume-snapshot
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeSnapshotResponse'
      x-codegen-request-body-name: volume-snapshot
  /api/2.52/volume-snapshots/batch:
    post:
      tags:
      - Volume Snapshots
      summary: Pure Storage Create Volume Snapshots and Create Tags.
      description: 'Creates point-in-time snapshots of the contents of volumes.

        The destroyed parameter, suffixes, and tags can be different for each snapshot.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_throttle_snapshot'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/OnSingle'
      requestBody:
        description: 'The list of volume snapshots to be created.

          '
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/VolumeSnapshotBatchPost'
        required: true
        x-codegen-request-body-name: volume-snapshot
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeSnapshotBatchResponse'
      x-codegen-request-body-name: volume-snapshot
  /api/2.52/volume-snapshots/transfer:
    get:
      tags:
      - Volume Snapshots
      summary: Pure Storage List Volume Snapshots with Transfer Statistics
      description: 'Displays a list of volume snapshots and their transfer statistics.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Destroyed'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Source_ids'
      - $ref: '#/components/parameters/Source_names'
      - $ref: '#/components/parameters/Total_item_count'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeSnapshotTransferGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeSnapshotTransferGetResponse'
  /api/2.52/volume-snapshots/tags:
    get:
      tags:
      - Volume Snapshots
      summary: Pure Storage List Tags
      description: Displays the list of tags.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Namespaces'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Resource_destroyed'
      - $ref: '#/components/parameters/Resource_ids'
      - $ref: '#/components/parameters/Resource_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagGetResponse'
    delete:
      tags:
      - Volume Snapshots
      summary: Pure Storage Delete Tags
      description: Deletes specified tags.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Keys'
      - $ref: '#/components/parameters/Namespaces_delete'
      - $ref: '#/components/parameters/Resource_ids'
      - $ref: '#/components/parameters/Resource_names'
      responses:
        '200':
          description: OK
          content: {}
  /api/2.52/volume-snapshots/tags/batch:
    put:
      tags:
      - Volume Snapshots
      summary: Pure Storage Update Tags
      description: 'Updates tags.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Resource_ids'
      - $ref: '#/components/parameters/Resource_names'
      requestBody:
        description: A list of tags to be created or modified.
        content:
          application/json:
            schema:
              maxItems: 30
              minItems: 1
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/TagBatch'
        required: true
        x-codegen-request-body-name: tag
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagResponse'
      x-codegen-request-body-name: tag
  /api/2.52/volume-snapshots/test:
    post:
      tags:
      - Volume Snapshots
      summary: Pure Storage Create the Volume Snapshot Path
      description: 'Creates the volume snapshot path without actually taking a volume snapshot.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_throttle_snapshot'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/OnSingle'
      - $ref: '#/components/parameters/Source_ids'
      - $ref: '#/components/parameters/Source_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VolumeSnapshotPost'
        required: true
        x-codegen-request-body-name: volume-snapshot
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultWithResourcePostResponse'
      x-codegen-request-body-name: volume-snapshot
  /api/1.5/volume-snapshots:
    get:
      tags:
      - Volume Snapshots
      summary: Pure Storage Get Volume Snapshots
      description: 'Retrieves information about snapshots of volumes.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization_2'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token_2'
      - $ref: '#/components/parameters/Filter_2'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Limit_2'
      - $ref: '#/components/parameters/Names_2'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      - $ref: '#/components/parameters/Source_ids_2'
      - $ref: '#/components/parameters/Source_names_2'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
            X-RateLimit-Remaining-second:
              description: 'The number of requests remaining for the organization in that second.

                '
              schema:
                type: integer
            X-RateLimit-Remaining-minute:
              description: 'The number of requests remaining for the organization in that minute.

                '
              schema:
                type: integer
            X-RateLimit-Limit-second:
              description: The number of requests available per second.
              schema:
                type: integer
            X-RateLimit-Limit-minute:
              description: The number of requests available per minute.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeSnapshotGetResponse_2'
        '400':
          $ref: '#/components/responses/Error400'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
components:
  parameters:
    OnSingle:
      name: 'on'
      in: query
      description: 'Performs the operation on the target name specified.

        For example, `targetName01`.

        '
      schema:
        type: string
    Names:
      name: names
      in: query
      description: 'Performs the operation on the unique names specified.

        Enter multiple names in comma-separated format.

        For example, `name01,name02`.


        If there is not at least one resource that matches

        each of the elements of `names`, then an error is returned,

        except when creating new resources.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Destroyed:
      name: destroyed
      in: query
      description: 'If set to `true`, lists only destroyed objects that are in the eradication pending state.

        If set to `false`, lists only objects that are not destroyed.

        If not set, lists both objects that are destroyed and those that are not destroyed.


        For destroyed objects, the time remaining is displayed in milliseconds.


        If object name(s) or id(s) are specified, then each object referenced must exist.

        If `destroyed` is set to `true`, then each object referenced must also be destroyed.

        If `destroyed` is set to `false`, then each object referenced must also not be destroyed.

        An error is returned if any of these conditions are not met.

        '
      schema:
        type: boolean
    Filter_2:
      name: filter
      in: query
      description: 'Exclude resources that don''t match the specified criteria.

        Single quotes are required around all strings inside the filters.

        '
      schema:
        type: string
    Names_2:
      name: names
      in: query
      description: 'A comma-separated list of resource names.

        If there is not at least one resource that matches each `name` element,

        an error is returned.

        Single quotes are required around all strings.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
        x-quoted: true
      x-quoted: true
    Source_names_2:
      name: source_names
      in: query
      description: 'A comma-separated list of names for the source of the object.

        If there is not at least one resource that matches each `source_name` element,

        an error is returned.

        Single quotes are required around all strings.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
        x-quoted: true
      x-quoted: true
    Allow_throttle_snapshot:
      name: allow_throttle
      in: query
      description: 'If set to `true`, allows snapshot to fail if array health is not optimal.

        '
      schema:
        type: boolean
    Resource_names:
      name: resource_names
      in: query
      description: 'A comma-separated list of resource names.

        The `resource_ids` or `resource_names` parameter is required, but they cannot be set together.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Source_ids_2:
      name: source_ids
      in: query
      description: 'A comma-separated list of ids for the source of the object.

        If there is not at least one resource that matches each `source_id` element,

        an error is returned.

        Single quotes are required around all strings.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
        x-quoted: true
      x-quoted: true
    Continuation_token_2:
      name: continuation_token
      in: query
      description: 'An opaque token used to iterate over a collection.

        The token to use on the next request is returned in the

        `continuation_token` field of the result.

        Single quotes are required around all strings.

        '
      schema:
        type: string
        x-quoted: true
      x-quoted: true
    Resource_destroyed:
      name: resource_destroyed
      in: query
      description: 'If set to `true`, returns only objects from destroyed resources. Returns an error if

        the name of a live resource is specified in the `resource_names` query parameter.

        If set to `false`, returns only objects from live resources. Returns an error if the

        name of a destroyed resource is specified in the `resource_names` query parameter.

        '
      schema:
        type: boolean
    Namespaces:
      name: namespaces
      in: query
      description: 'A comma-separated list of namespaces.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Ids_2:
      name: ids
      in: query
      description: 'A comma-separated list of resource IDs.

        If there is not at least one resource that matches each `id` element,

        an error is returned.

        Single quotes are required around all strings.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
        x-quoted: true
      x-quoted: true
    Total_item_count:
      name: total_item_count
      in: query
      description: 'If set to `true`, the `total_item_count` matching the

        specified query parameters is calculated and returned in

        the response. If set to `false`, the `total_item_count`

        is `null` in the response. This may speed up queries

        where the `total_item_count` is large. If not specified,

        defaults to `false`.

        '
      schema:
        type: boolean
    Source_ids:
      name: source_ids
      in: query
      description: 'Performs the operation on the source ID specified.

        Enter multiple source IDs in comma-separated format.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Namespaces_delete:
      name: namespaces
      in: query
      description: 'A comma-separated list of namespaces. Only one namespace is allowed per delete request.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Allow_errors:
      name: allow_errors
      in: query
      description: 'If set to `true`, the API will allow the operation to continue even if there are errors.

        Any errors will be returned in the `errors` field of the response.

        If set to `false`, the operation will fail if there are any errors.

        '
      schema:
        type: boolean
        default: false
    Source_names:
      name: source_names
      in: query
      description: 'Performs the operation on the source name specified.

        Enter multiple source names in comma-separated format. For example, `name01,name02`.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Total_only:
      name: total_only
      in: query
      description: 'If set to `true`, returns the aggregate value of all items after filtering.

        Where it makes more sense, the average value is displayed instead.

        The values are displayed for each name where meaningful.

        If `total_only=true`, the `items` list will be empty.

        '
      schema:
        type: boolean
    Limit_2:
      name: limit
      in: query
      description: 'Limit the size of the response to the specified number of resources.

        A limit of 0 can be used to get the number of resources without getting

        all of the resources. It will be returned in the total_item_count field.

        If a client asks for a page size larger than the maximum number, the request

        is still valid. In that case the server just returns the maximum number of

        items, disregarding the client''s page size request. If not specified, defaults

        to 1000.

        '
      schema:
        type: integer
        format: int32
    Keys:
      name: keys
      in: query
      description: 'A comma-separated list of tag keys.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Ids:
      name: ids
      in: query
      description: "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n  if ids or names is not provided, but it cannot be used together with name or names.\n"
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Offset_2:
      name: offset
      in: query
      description: 'The offset of the first resource to return from a collection.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
    Resource_ids:
      name: resource_ids
      in: query
      description: 'A comma-separated list of resource IDs.

        The `resource_ids` or `resource_names` parameter is required, but they cannot be set together.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Context_names:
      name: context_names
      in: query
      description: 'Performs the operation on the context specified.


        If specified, the context names must be an array of size 1, and the single element

        must be the name of an array in the same fleet or the name of the fleet itself. If

        not specified, the context will default to the array that received this request.


        Other parameters provided with the request, such as names of volumes or snapshots,

        are resolved relative to the provided `context`.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Filter:
      name: filter
      in: query
      description: 'Narrows down the results to only the response objects

        that satisfy the filter criteria.

        '
      schema:
        type: string
    Authorization:
      name: Authorization
      in: header
      description: 'Access token (in JWT format) required to use any API

        endpoint (except `/oauth2`, `/login`, and `/logout`)

        '
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: 'Limits the size of the response to the specified number of objects on each page.

        To return the total number of resources, set `limit=0`.

        The total number of resources is returned as a `total_item_count` value.

        If the page size requested is larger than the system maximum limit,

        the server returns the maximum limit, disregarding the requested page size.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    XRequestId:
      name: X-Request-ID
      in: header
      description: 'Supplied by client during request or generated by server.

        '
      schema:
        type: string
    Context_names_get:
      name: context_names
      in: query
      description: 'Performs the operation on the unique contexts specified.


        If specified, each context name must be the name of an array in the same fleet or

        the name of the fleet itself.


        If not specified, the context will default to the array that received this request.


        Other parameters provided with the request, such as names of volumes or snapshots,

        are resolved relative to the provided `context`.


        Enter multiple names in comma-separated format.

        For example, `name01,name02`.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Offset:
      name: offset
      in: query
      description: 'The starting position based on the results of the query

        in relation to the full set of response objects returned.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Continuation_token:
      name: continuation_token
      in: query
      description: 'A token used to retrieve the next page of data

        with some consistency guaranteed.

        The token is a Base64 encoded value.

        Set `continuation_token` to the system-generated token taken from the `x-next-token`

        header field of the response.

        A query has reached its last page when the response does not include a token.

        Pagination requires the `limit` and `continuation_token`

        query parameters.

        '
      schema:
        type: string
    Replication_snapshot:
      name: replication_snapshot
      in: query
      description: 'If set to `true`, allow destruction/eradication of snapshots in use by replication.

        If set to `false`, allow destruction/eradication of snapshots not in use by replication.

        If not specified, defaults to `false`.

        '
      schema:
        type: boolean
    Authorization_2:
      name: Authorization
      in: header
      description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`)

        '
      schema:
        type: string
    Sort_2:
      name: sort
      in: query
      description: 'Sort the response by the specified fields (in descending order if ''-''

        is appended to the field name).

        If you provide a sort you will not get a continuation token in

        the response.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          pattern: ^[a-z]+(_[a-z]+)*-?
          type: string
    Sort:
      name: sort
      in: query
      description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
      style: form
      explode: false
      schema:
        type: array
        items:
          pattern: ^[a-z]+(_[a-z]+)*-?
          type: string
  schemas:
    _arrays:
      type: object
      properties:
        arrays:
          description: 'The list of arrays where this resource exists. Many resources are on a single array, but

            some resources, such as pods, can be shared across multiple arrays.

            '
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/_fixedReferenceFqdn'
      x-readOnly: true
    _space:
      type: object
      properties:
        data_reduction:
          description: 'The ratio of mapped sectors within a volume versus

            the amount of physical space the data occupies after data compression and deduplication.

            The data reduction ratio does not include thin provisioning savings.

            For example, a data reduction ratio of 5:1 means that

            for every 5 MB the host writes to the array, 1 MB is stored on the array''s flash modules.

            '
          type: number
          format: float
          readOnly: true
        footprint:
          description: 'The maximum amount of physical space the container consumes on an array,

            ignoring any data shared outside the container, measured in bytes.

            On Evergreen//One arrays, this is the maximum amount of effective used space.

            The footprint metric is mostly used for capacity planning.

            This field will be null in non-container contexts.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        shared:
          description: 'The physical space occupied by deduplicated data, meaning that the space is shared with other

            volumes and snapshots as a result of data deduplication.

            Measured in bytes.

            On Evergreen//One arrays, this is the effective space contributed by data that is not unique

            to a specific volume, managed directory, or snapshot, measured in bytes.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
          example: 111863360624
        snapshots:
          description: 'The physical space occupied by data unique to one or more snapshots.

            Measured in bytes.

            On Evergreen//One arrays, this is the effective space contributed by data unique to one or

            more snapshots, measured in bytes.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        system:
          description: 'The physical space occupied by internal array metadata. Measured in bytes.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        thin_provisioning:
          description: 'The percentage of volume sectors that do not contain host-written data

        

# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-volume-snapshots-api-openapi.yml