openapi: 3.0.1
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:
    _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
    PolicyFileSystemSnapshotResponse:
      type: object
      properties:
        items:
          description: A list of members for policies.
          type: array
          items:
            $ref: '#/components/schemas/PolicyFileSystemSnapshot'
    FileSystemSnapshotResponse:
      type: object
      properties:
        items:
          description: A list of file system snapshot objects.
          type: array
          items:
            $ref: '#/components/schemas/FileSystemSnapshot'
    _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
    ErrorNoContext:
      type: object
      properties:
        message:
          type: string
          example: Something was wrong
    FileSystemSnapshotResponse_2:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/FileSystemSnapshot_2'
    _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
    _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
    FileSystemSnapshotTransferResponse:
      type: object
      properties:
        items:
          description: A list of file system snapshot objects.
          type: array
          items:
            $ref: '#/components/schemas/FileSystemSnapshotTransfer'
    PolicyMembersGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/PolicyMembersResponse'
    PolicyMembersResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PolicyMember_2'
    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'
    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'
    _locationReference:
      allOf:
      - $ref: '#/components/schemas/_reference'
      - 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: Reference
            allOf:
            - $ref: '#/components/schemas/_reference'
    PolicyFileSystemSnapshotGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/PolicyFileSystemSnapshotResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    _errorErrors:
      type: object
      properties:
        context:
          type: string
          example: Error with ...
        message:
          type: string
          example: Something was wrong
    _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'
    _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
    _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
    FileSystemSnapshotGetTransferResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/FileSystemSnapshotTransferResponse'
      - $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: FileSystemSnapshotTransfer
            allOf:
            - $ref: '#/components/schemas/FileSystemSnapshotTransfer'
    _arraysBuiltIn:
      description: 'A built-in resource that exists on one or multiple arrays.

        '
      allOf:
      - $ref: '#/components/schemas/_builtInAsOf'
      - $ref: '#/components/schemas/_arrays'
    PolicyMember_2:
      description: An association between a policy and a member.
      allOf:
      - $ref: '#/components/schemas/_timeAware'
      - type: object
        properties:
          member:
            $ref: '#/components/schemas/_fixedReference_2'
          policy:
            $ref: '#/components/schemas/_fixedReference_2'
    FileSystemSnapshotGetResponse_2:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/FileSystemSnapshotResponse_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
    _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
    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
    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
    _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'
    Error:
      type: object
      properties:
        errors:
          description: The list of errors encountered.
          type: array
          items:
            $ref: '#/components/schemas/_errorErrors'
    _reference:
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified.

            '
          type: string
        name:
          description: 'The resource name,

            such as volume name, pod name, snapshot name, and so on.

            '
          type: string
        resource_type:
          description: 'Type of the object (full name of the endpoint).

            Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`,

            `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`,

            `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and

            `policies/snapshot`, etc.

            '
          type: string
          readOnly: true
      x-aliases:
      - _referenceWithFixedType
    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'
    _context:
      type: object
      properties:
        context:
          description: 'The context in which the operation was performed.


            Valid values include a reference to any array which is a member of the same fleet

            or to the fleet itself.


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

            are resolved relative to the provided `context`.

            '
          readOnly: true
          title: FixedReference
          allOf:
          - $ref: '#/components/schemas/_fixedReference'
    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
    _errorContextResponseErrors:
      type: object
      properties:
        context:
          description: 'Contains information relating to the cause of this error,

            or the name of the object that was being processed when the error was encountered.

            This may be `null` for more general errors.

            '
          type: string
        location_context:
          description: 'Contains information relating to the context in which the request was executing

            when the error occurred.

            For example, this may be the name of an array in the same fleet.

            This may be `null` for more general errors, or if no explicit `context` parameter

            was provided with the request.

            '
          title: FixedReference
          allOf:
          - $ref: '#/components/schemas/_fixedReference'
        message:
          description: A description of the error which occurred.
          type: string
          example: Resource does not exist.
    _fixedReferenceWithoutType:
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified.

            '
          type: string
          readOnly: true
        name:
          description: 'The resource name, such as volume name, file system name,

            snapshot name, and so on.

            '
          type: string
          readOnly: true
      x-readOnly: true
    FileSystemSnapshotPost:
      type: object
      properties:
        suffix:
          description: The suffix of the snapshot, e.g., `snap1`.
          type: string
    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
    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
    _fixedReference:
      allOf:
      - $ref: '#/components/schemas/_fixedReferenceWithoutType'
      - type: object
        properties:
          resource_type:
            description: 'Type of the object (full name of the endpoint).

              Valid values are the unique part of the resource''s REST endpoint.

              For example, a reference to a file system would have a

              `resource_type` of `file-systems`.

              '
            type: string
            readOnly: true
    _direction:
      type: string
      description: 'The direction of replication. Valid values are `inbound` and

        `outbound`.

        '
      readOnly: true
      x-read-only: true
  responses:
    Error403:
      description: FORBIDDEN
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorNoContext'
    Error400:
      description: BAD REQUEST
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

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

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error429:
      description: TOO MANY REQUESTS
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

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

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorNoContext'
    Error500:
      description: INTERNAL SERVER ERROR
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

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

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error404:
      description: NOT FOUND
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

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

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    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
    Remote_ids:
      name: remote_ids
      in: query
      description: 'A comma-separated list of remote array IDs. If, after filtering, there is not at least one

        resource that matches each of the elements, then an error is returned. This cannot be provided

        together with the `remote_names` query parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    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
    Ids:
      name: ids
      in: query
      description: 'A comma-separated list of resource IDs.

        If after filtering, there is not at least one resource that matches

        each of the elements of `ids`, then an error is returned.

        This cannot be provided together with the `name` or `names` query parameters.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Policy_names_2:
      name: policy_names
      in: query
      description: 'A comma-separated list of policy names.

        If there is not at least one resource that matches each `policy_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
    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
    Sort:
      name: sort
      in: query
      description: 'Sort the response by the specified fields (in descending order if ''-''

        is appended to the field name).

        NOTE: 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
    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
    Policy_ids:
      name: policy_ids
      in: query
      description: 'A comma-separated list of policy IDs.

        If after filtering, there is not at least one resource that matches

        each of the elements of `policy_ids`, then an error is returned.

        This cannot be provided together with the `policy_names` query parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    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
    XRequestId:
      name: X-Request-ID
      in: header
      description: 'Supplied by client during request or generated by server.

        '
      schema:
        type: string
    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
    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
    Targets:
      name: targets
      in: query
      description: 'The target arrays to replicate created snapshots to.

        Only valid when `send` is `true`.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Member_names:
      name: member_names
      in: query
      description: 'A comma-separated list of member names.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          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
    Send:
      name: send
      in: query
      description: 'Whether to replicate created snapshots immediately to other arrays.

        If it''s `false`, created snapshots may still be replicated to other arrays

        according to policy.

        '
      schema:
        type: boolean
    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
    Member_names_2:
      name: member_names
      in: query
      description: 'A comma-separated list of member names.

        If there is not at least one resource that matches each `member_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
    Policy_ids_2:
      name: policy_ids
      in: query
      description: 'A comma-separated list of policy IDs.

        If there is not at least one resource that matches each `policy_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
    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
    Filter:
      name: filter
      in: query
      description: 'Narrows down the results to only the response objects

        that satisfy the filter criteria.

        '
      schema:
        type: string
    Offset:
      name: offset
      in: query
      description: 'The offset of the first resource to return from a collection.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    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
    Policy_names:
      name: policy_names
      in: query
      description: 'A comma-separated list of policy names.

        '
      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
    Names_or_owner_names:
      name: names_or_owner_names
      in: query
      description: 'A comma-separated list of resource names.

        Either the names of the snapshots or the owning file systems.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    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
    Authorization:
      name: Authorization
      in: header
      description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`)

        '
      schema:
        type: string
    Member_ids:
      name: member_ids
      in: query
      description: 'A comma-separated list of member IDs.

        If after filtering, there is not at least one resource that matches

        each of the elements of `member_ids`, then an error is returned.

        This cannot be provided together with the `member_names` query parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Source_names:
      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 of the elements of

        `source_names`, an error is returned.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Source_ids:
      name: source_ids
      in: query
      description: 'A comma-separated list of source file system IDs.

        If after filtering, there is not at least one resource that matches

        each of the elements of `source_ids`, then an error is returned.

        This cannot be provided together with the `names_or_sources` or

        `sources` query parameters.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Remote_names:
      name: remote_names
      in: query
      description: 'A comma-separated list of remote array names. If, after filtering, there is not at least one

        resource that matches each of the elements, then an error is returned. This cannot be provided

        together with the `remote_ids` query parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Member_ids_2:
      name: member_ids
      in: query
      description: 'A comma-separated list of member IDs.

        If there is not at least one resource that matches each `member_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
    Latest_replica:
      name: latest_replica
      in: query
      description: 'Used when destroying a snapshot. If not present or `false`, and the snapshot

        is the latest replicated snapshot, then destroy will fail. If `true` or the

        snapshot is not the latest replicated snapshot, then destroy will be

        successful.

        '
      schema:
        type: boolean
    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
    Owner_ids:
      name: owner_ids
      in: query
      description: 'A comma-separated list of owning file system IDs.

        If after filtering, there is not at least one resource that matches

        each of the elements of owner IDs, then an error is returned.

        This cannot be provided together with the `ids`, `names_or_owner_names`,

        or `names_or_sources` query parameters.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          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
    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
    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