Pure Storage File System Snapshots API

A file system snapshot is a point-in-time copy of a file system. Multiple snapshots of a file system can be copied for different points in time. A snapshot policy can also be applied to a file system for automatic creation and retention of snapshots. Additionally, file system snapshots can also be sent from one array to another.

Operations 10

GET /api/2.26/file-system-snapshots Pure Storage GET File-system-snapshots
POST /api/2.26/file-system-snapshots Pure Storage POST File-system-snapshots
DELETE /api/2.26/file-system-snapshots Pure Storage DELETE File-system-snapshots
PATCH /api/2.26/file-system-snapshots Pure Storage PATCH File-system-snapshots
GET /api/2.26/file-system-snapshots/policies Pure Storage GET File-system-snapshots/policies
DELETE /api/2.26/file-system-snapshots/policies Pure Storage DELETE File-system-snapshots/policies
GET /api/2.26/file-system-snapshots/transfer Pure Storage GET File-system-snapshots/transfer
DELETE /api/2.26/file-system-snapshots/transfer Pure Storage DELETE File-system-snapshots/transfer
GET /api/1.5/file-system-snapshots Pure Storage Get FlashBlade File System Snapshots
GET /api/1.5/file-system-snapshots/policies Pure Storage Get FlashBlade File System Snapshot / Policy Pairs

Documentation

Specifications

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-volume-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-host-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-volume-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-file-system-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-bucket-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-array-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-file-system-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-bucket-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-array-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-metric-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-alert-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/pure1-cloud-api-array-structure.json

Other Resources

🔗
SDKs
https://pypi.org/project/py-pure-client/
🔗
SDKs
https://github.com/PureStorage-OpenConnect/PureStorage.Pure1
🔗
SDKs
https://github.com/PureStorage-OpenConnect/powershell-toolkit-3
🔗
SDKs
https://github.com/PureStorage-OpenConnect/rest-client
🔗
Integrations
https://github.com/PureStorage-OpenConnect/terraform-provider-flash
🔗
Integrations
https://github.com/PureStorage-OpenConnect/pure-fa-openmetrics-exporter
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flasharray-rest-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-volume-example.json
🔗
SDKs
https://github.com/PureStorage-OpenConnect/flashblade-powershell
🔗
SDKs
https://github.com/purestorage/purity_fb_python_client
🔗
Integrations
https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter
🔗
Tools
https://github.com/PureStorage-OpenConnect/flashblade-mcp-server
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flashblade-rest-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-file-system-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-bucket-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-pure1-cloud-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/pure1-cloud-api-array-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/pure-storage-file-system-snapshots-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

pure-storage-file-system-snapshots-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: FlashArray REST Active Directory File System 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: File System Snapshots
  description: A file system snapshot is a point-in-time copy of a file system. Multiple snapshots of a file system can be copied for different points in time. A snapshot policy can also be applied to a file system for automatic creation and retention of snapshots. Additionally, file system snapshots can also be sent from one array to another.
paths:
  /api/2.26/file-system-snapshots:
    get:
      tags:
      - File System Snapshots
      summary: Pure Storage GET File-system-snapshots
      description: 'List file system snapshots.

        Note: if more than 150,000 items would be returned in the response, an error will be thrown

        and query parameters must be used to limit the items queried.

        '
      parameters:
      - $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_or_owner_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Owner_ids'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemSnapshotGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemSnapshotGetResponse'
    post:
      tags:
      - File System Snapshots
      summary: Pure Storage POST File-system-snapshots
      description: Create a snapshot for a specified source file system. If a source file system is not specified, creates snapshots for all file systems on the array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Send'
      - $ref: '#/components/parameters/Source_ids'
      - $ref: '#/components/parameters/Source_names'
      - $ref: '#/components/parameters/Targets'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileSystemSnapshotPost'
        required: false
        x-codegen-request-body-name: file-system-snapshot
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemSnapshotResponse'
      x-codegen-request-body-name: file-system-snapshot
    delete:
      tags:
      - File System Snapshots
      summary: Pure Storage DELETE File-system-snapshots
      description: Delete a file system snapshot.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
    patch:
      tags:
      - File System Snapshots
      summary: Pure Storage PATCH File-system-snapshots
      description: Modify file system snapshot attributes.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Latest_replica'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileSystemSnapshot'
        required: true
        x-codegen-request-body-name: file-system-snapshot
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemSnapshotResponse'
      x-codegen-request-body-name: file-system-snapshot
  /api/2.26/file-system-snapshots/policies:
    get:
      tags:
      - File System Snapshots
      summary: Pure Storage GET File-system-snapshots/policies
      description: 'List file system snapshots mapped to snapshot scheduling policies.

        Note: if more than 150,000 items would be returned in the response, an error will be thrown

        and query parameters must be used to limit the items queried.

        '
      parameters:
      - $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/Member_ids'
      - $ref: '#/components/parameters/Member_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Policy_ids'
      - $ref: '#/components/parameters/Policy_names'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyFileSystemSnapshotGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyFileSystemSnapshotGetResponse'
    delete:
      tags:
      - File System Snapshots
      summary: Pure Storage DELETE File-system-snapshots/policies
      description: Remove snapshot scheduling policies from a file system.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Member_ids'
      - $ref: '#/components/parameters/Member_names'
      - $ref: '#/components/parameters/Policy_ids'
      - $ref: '#/components/parameters/Policy_names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
  /api/2.26/file-system-snapshots/transfer:
    get:
      tags:
      - File System Snapshots
      summary: Pure Storage GET File-system-snapshots/transfer
      description: 'List file system snapshot transfers from the source array to the target array.

        Note: if more than 150,000 items would be returned in the response, an error will be thrown

        and query parameters must be used to limit the items queried.

        '
      parameters:
      - $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/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names_or_owner_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemSnapshotGetTransferResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemSnapshotGetTransferResponse'
    delete:
      tags:
      - File System Snapshots
      summary: Pure Storage DELETE File-system-snapshots/transfer
      description: Delete file system snapshot transfers from the source array to the target array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Remote_ids'
      - $ref: '#/components/parameters/Remote_names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
  /api/1.5/file-system-snapshots:
    get:
      tags:
      - File System Snapshots
      summary: Pure Storage Get FlashBlade File System Snapshots
      description: 'Retrieves snapshots of FlashBlade file systems.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $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/FileSystemSnapshotGetResponse_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'
  /api/1.5/file-system-snapshots/policies:
    get:
      tags:
      - File System Snapshots
      summary: Pure Storage Get FlashBlade File System Snapshot / Policy Pairs
      description: 'Retrieves pairs of FlashBlade file system snapshot members and their policies.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token_2'
      - $ref: '#/components/parameters/Filter_2'
      - $ref: '#/components/parameters/Limit_2'
      - $ref: '#/components/parameters/Member_ids_2'
      - $ref: '#/components/parameters/Member_names_2'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Policy_ids_2'
      - $ref: '#/components/parameters/Policy_names_2'
      - $ref: '#/components/parameters/Sort_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/PolicyMembersGetResponse'
        '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:
  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
    _builtIn:
      type: object
      properties:
        id:
          description: 'A non-modifiable, globally unique ID chosen by the system.

            '
          type: string
          readOnly: true
        name:
          description: Name of the object (e.g., a file system or snapshot).
          type: string
          readOnly: true
    Error:
      type: object
      properties:
        errors:
          description: The list of errors encountered.
          type: array
          items:
            $ref: '#/components/schemas/_errorErrors'
    FileSystemSnapshot:
      allOf:
      - $ref: '#/components/schemas/_resource'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          created:
            description: Creation timestamp of the object.
            type: integer
            format: int64
            readOnly: true
          destroyed:
            description: 'Is the file system snapshot destroyed? If not specified, defaults to

              `false`.

              '
            type: boolean
          owner:
            description: 'A reference to the file system that owns this snapshot.

              If the owner is destroyed, this will be destroyed.

              '
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
          owner_destroyed:
            description: Is the owning file system destroyed?
            type: boolean
            readOnly: true
          policies:
            description: An array of references to the associated policies.
            readOnly: true
            type: array
            items:
              $ref: '#/components/schemas/_fixedLocationReference'
          policy:
            description: 'A reference to the associated policy that drives the behavior of the

              snapshot.

              '
            title: FixedLocationReference
            allOf:
            - $ref: '#/components/schemas/_fixedLocationReference'
          source:
            description: 'A reference to the file system that was the source of the data in

              this snapshot. Normally this is the same as the owner, but if

              the snapshot is replicated, the source is the original file system.

              '
            title: FixedLocationReference
            allOf:
            - $ref: '#/components/schemas/_fixedLocationReference'
          suffix:
            description: The suffix of the snapshot, e.g., `snap1`.
            type: string
            readOnly: true
            example: snap1
          time_remaining:
            description: 'Time in milliseconds before the file system snapshot is eradicated.

              `null` if not destroyed.

              '
            type: integer
            format: int64
            readOnly: true
    PolicyFileSystemSnapshotGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/PolicyFileSystemSnapshotResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    FileSystemSnapshot_2:
      description: 'A point-in-time image of the contents of a FlashBlade file system.

        '
      allOf:
      - $ref: '#/components/schemas/_arraysBuiltIn'
      - type: object
        properties:
          created:
            description: Creation time in milliseconds since UNIX epoch.
            type: integer
            format: int64
            example: 1502729489760
          destroyed:
            description: 'Indicates if this snapshot has been destroyed and is pending

              eradication.

              '
            type: boolean
            example: false
          'on':
            $ref: '#/components/schemas/_fixedReferenceFqdn'
          source:
            description: 'A reference to the file system that the snapshot was taken from.

              '
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference_2'
          suffix:
            description: Indicates the suffix of the snapshot.
            type: string
            example: checkpoint_2018_01_01
    FileSystemSnapshotPost:
      type: object
      properties:
        suffix:
          description: The suffix of the snapshot, e.g., `snap1`.
          type: string
    _builtInAsOf:
      description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support

        settings). Some correspond to a piece of software, like an app, or hardware,

        like a controller. Others are created by the system in response to some event

        (e.g., alerts, audit records).


        Typically, a user can''t create, delete or rename a built-in resource. A few

        can be created or deleted, but not renamed because the names are meaningful

        to Purity (e.g., VIFs).


        '
      allOf:
      - $ref: '#/components/schemas/_timeAware'
      - type: object
        properties:
          id:
            description: A non-modifiable, globally unique ID chosen by the system.
            type: string
            readOnly: true
            example: 01c2889a-4124-49ff-8cbd-c33405ede123
          name:
            description: A non-modifiable, locally unique name chosen by the system.
            type: string
            readOnly: true
            example: example_name
    FileSystemSnapshotResponse:
      type: object
      properties:
        items:
          description: A list of file system snapshot objects.
          type: array
          items:
            $ref: '#/components/schemas/FileSystemSnapshot'
    PolicyMember:
      type: object
      properties:
        member:
          description: Reference to the resource the policy is applied to.
          title: FixedReference
          allOf:
          - $ref: '#/components/schemas/_fixedReference'
        policy:
          description: Reference to the policy.
          title: FixedReference
          allOf:
          - $ref: '#/components/schemas/_fixedReference'
    _direction:
      type: string
      description: 'The direction of replication. Valid values are `inbound` and

        `outbound`.

        '
      readOnly: true
      x-read-only: true
    _fixedReferenceNoResourceType:
      type: object
      properties:
        id:
          description: 'A non-modifiable, globally unique ID chosen by the system.

            '
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
      x-readOnly: true
    PolicyMembersResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PolicyMember_2'
    _timeAware:
      type: object
      properties:
        _as_of:
          description: The freshness of the data (timestamp in millis since epoch).
          type: integer
          format: int64
          readOnly: true
          example: 1502729489760
    _resource:
      description: 'An ordinary (as opposed to built-in) resource that can be created, named,

        renamed or deleted by the user. This might be a virtual resource (e.g., a

        file system), or correspond to something in the environment, like a host or a

        server.

        '
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified and cannot refer to another resource.

            '
          type: string
          readOnly: true
        name:
          description: 'A user-specified name.

            The name must be locally unique and can be changed.

            '
          type: string
    _fixedReference_2:
      type: object
      properties:
        id:
          description: The opaque and unique id of this resource.
          type: string
          readOnly: true
          example: 2a989a09-c851-4d52-9ec6-ab728b1c04db
        name:
          description: The name of this resource.
          type: string
          readOnly: true
          example: example_name
        resource_type:
          description: 'The type of this resource represented by the name of its REST endpoint.

            For example, "arrays", "network-interfaces", and "metrics".

            The value may be `null` if the resource is not represented.

            '
          type: string
          readOnly: true
          example: example_resource_type
      x-readOnly: true
    _errorErrors:
      type: object
      properties:
        context:
          type: string
          example: Error with ...
        message:
          type: string
          example: Something was wrong
    PolicyFileSystemSnapshot:
      allOf:
      - $ref: '#/components/schemas/PolicyMember'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          policy:
            description: Reference to the policy. Location can be array or realm.
            title: LocationReference
            allOf:
            - $ref: '#/components/schemas/_locationReference'
    _fixedLocationReference:
      allOf:
      - $ref: '#/components/schemas/_fixedReference'
      - type: object
        properties:
          display_name:
            description: 'Full name of the source with remote array information.

              Response will be same as source name for local file systems and policies.

              '
            type: string
            readOnly: true
            example: irp624-c02:fs1
          is_local:
            description: 'Is the location reference to the local array or somewhere remote?

              '
            type: boolean
            readOnly: true
          location:
            description: 'A reference to the location where the object is defined.

              '
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
    FileSystemSnapshotResponse_2:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/FileSystemSnapshot_2'
    _fixedReferenceFqdn:
      allOf:
      - $ref: '#/components/schemas/_fixedReference_2'
      - type: object
        properties:
          fqdn:
            description: 'The fully qualified domain name of the appliance when `resource_type` is `arrays`,

              `null` otherwise.

              '
            type: string
            readOnly: true
            example: example_name.dc1.example.com
    FileSystemSnapshotTransfer:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          completed:
            description: 'A timestamp at which the replication of the snapshot completed.

              '
            type: integer
            format: int64
            readOnly: true
          data_transferred:
            description: The amount of data transferred to the target, in bytes.
            type: integer
            format: int64
            readOnly: true
          direction:
            $ref: '#/components/schemas/_direction'
          local_snapshot:
            description: 'A reference to the associated local file system snapshot.

              '
            title: FixedReferenceNoResourceType
            allOf:
            - $ref: '#/components/schemas/_fixedReferenceNoResourceType'
          progress:
            description: 'A percentage that indicates

              how much progress has been made on the transfer.

              '
            type: number
            format: double
            minimum: 0
            maximum: 1
            readOnly: true
          remote:
            description: 'The array or realm where the remote file system snapshot is located.

              '
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
          remote_snapshot:
            description: 'A reference to the associated remote file system snapshot.

              '
            title: FixedReferenceNoResourceType
            allOf:
            - $ref: '#/components/schemas/_fixedReferenceNoResourceType'
          started:
            description: 'A timestamp at which the replication of the snapshot started.

              '
            type: integer
            format: int64
            readOnly: true
          status:
            description: 'The status of current replication.

              Valid values are `completed`, `in-progress`, and `queued`.

              '
            type: string
            readOnly: true
    FileSystemSnapshotGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/FileSystemSnapshotResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
      - type: object
        properties:
          total:
            description: 'If `total_only` query param is `true`, then it will be a total of

              all records after filtering and no items will be returned.

              If `total_only` is `false`, then it will be a total of all records

              on this page.

              '
            title: FileSystemSnapshot
            allOf:
            - $ref: '#/components/schemas/FileSystemSnapshot'
    FileSystemSnapshotGetResponse_2:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/FileSystemSnapshotResponse_2'
    PageInfo_2:
      type: object
      properties:
        continuation_token:
          description: 'Continuation token that can be provided in the continuation_token

            query param to get the next page of data.

            If you use the continuation token to page through data you

            are guaranteed to get all items exactly once regardless of

            how items are modified. If an item is added or deleted during

            the pagination then it may or may not be returned.

            The continuation token is generated if the limit is less

            than the remaining number of items, and the default sort is used

            (no sort is specified).

            '
          type: string
          example: MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My
        total_item_count:
          description: Total number of items after applying filter params.
          type: integer
          format: int32
          example: 1
    PolicyMembersGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/PolicyMembersResponse'
    _errorContextResponse:
      type: object
      properties:
        errors:
          description: The list of errors encountered when attempting to perform an operation.
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/_errorContextResponseErrors'
    PageInfo:
      type: object
      properties:
        continuation_token:
          description: 'Continuation token that can be provided in the `continuation_token` query

            param to get the next page of data.

            If you use the `continuation_token` to page through data you

            are guaranteed to get all items exactly once regardless of

            how items are modified. If an item is added or deleted during

            the pagination then it may or may not be returned.

            The `continuation_token` is generated if the `limit` is less

            than the remaining number of items, and the default sort is used

            (no sort is specified).

            '
          type: string
        total_item_count:
          description: Total number of items after applying `filter` params.
          type: integer
          format: int32
    PolicyFileSystemSnapshotResponse:
      type: object
      properties:
        items:
          description: A list of members for policies.
          type: array
          items:
            $ref: '#/components/schemas/PolicyFileSystemSnapshot'
    FileSystemSnapshotTransferResponse:
      type: object
      properties:
        items:
          description: A list of file system snapshot objects.
          type: array
          items:
            $ref: '#/components/schemas/FileSystemSnapshotTransfer'
    _fixedReferenceWithoutType:
      type: object
    

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