Pure Storage File System Replica Links API

File system replication requires a replica link that connects a source array to a remote target. The configuration of a replica link includes policies, file system names, remote names, and replication status information.

Documentation

Specifications

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-array-schema.json
📊
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-array-structure.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
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-array-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

OpenAPI Specification

pure-storage-file-system-replica-links-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: FlashArray REST Active Directory File System Replica Links 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 Replica Links
  description: File system replication requires a replica link that connects a source array to a remote target. The configuration of a replica link includes policies, file system names, remote names, and replication status information.
paths:
  /api/2.26/file-system-replica-links:
    get:
      tags:
      - File System Replica Links
      summary: Pure Storage GET File-system-replica-links
      description: List file system replication link.
      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/Local_file_system_ids'
      - $ref: '#/components/parameters/Local_file_system_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Remote_file_system_ids'
      - $ref: '#/components/parameters/Remote_file_system_names'
      - $ref: '#/components/parameters/Remote_ids'
      - $ref: '#/components/parameters/Remote_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/FileSystemReplicaLinkGetResponse'
        '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/FileSystemReplicaLinkGetResponse'
    post:
      tags:
      - File System Replica Links
      summary: Pure Storage POST File-system-replica-links
      description: Create a file system replication link.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Local_file_system_ids'
      - $ref: '#/components/parameters/Local_file_system_names'
      - $ref: '#/components/parameters/Remote_default_exports'
      - $ref: '#/components/parameters/Remote_file_system_names'
      - $ref: '#/components/parameters/Remote_ids'
      - $ref: '#/components/parameters/Remote_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileSystemReplicaLink'
        required: true
        x-codegen-request-body-name: file-system-replica-link
      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/FileSystemReplicaLinkResponse'
      x-codegen-request-body-name: file-system-replica-link
    delete:
      tags:
      - File System Replica Links
      summary: Pure Storage DELETE File-system-replica-links
      description: Delete a file system replication link.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Cancel_in_progress_transfers'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Local_file_system_ids'
      - $ref: '#/components/parameters/Local_file_system_names'
      - $ref: '#/components/parameters/Remote_file_system_ids'
      - $ref: '#/components/parameters/Remote_file_system_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: {}
    patch:
      tags:
      - File System Replica Links
      summary: Pure Storage PATCH File-system-replica-links
      description: Update a file system replication link.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Local_file_system_ids'
      - $ref: '#/components/parameters/Local_file_system_names'
      - $ref: '#/components/parameters/Remote_ids'
      - $ref: '#/components/parameters/Remote_names'
      - $ref: '#/components/parameters/Replicate_now'
      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/FileSystemReplicaLinkResponse'
  /api/2.26/file-system-replica-links/policies:
    get:
      tags:
      - File System Replica Links
      summary: Pure Storage GET File-system-replica-links/policies
      description: List file system replication link policies.
      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/Local_file_system_ids'
      - $ref: '#/components/parameters/Local_file_system_names'
      - $ref: '#/components/parameters/Member_ids'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Policy_ids'
      - $ref: '#/components/parameters/Policy_names'
      - $ref: '#/components/parameters/Remote_file_system_ids'
      - $ref: '#/components/parameters/Remote_file_system_names'
      - $ref: '#/components/parameters/Remote_ids'
      - $ref: '#/components/parameters/Remote_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/PolicyMemberWithRemoteGetResponse'
        '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/PolicyMemberWithRemoteGetResponse'
    post:
      tags:
      - File System Replica Links
      summary: Pure Storage POST File-system-replica-links/policies
      description: Add a policy to a file system replication link.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Local_file_system_ids'
      - $ref: '#/components/parameters/Local_file_system_names'
      - $ref: '#/components/parameters/Member_ids'
      - $ref: '#/components/parameters/Policy_ids'
      - $ref: '#/components/parameters/Policy_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:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyMemberWithRemoteResponse'
    delete:
      tags:
      - File System Replica Links
      summary: Pure Storage DELETE File-system-replica-links/policies
      description: Remove a policy from a file system replication link.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Local_file_system_ids'
      - $ref: '#/components/parameters/Local_file_system_names'
      - $ref: '#/components/parameters/Member_ids'
      - $ref: '#/components/parameters/Policy_ids'
      - $ref: '#/components/parameters/Policy_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/2.26/file-system-replica-links/transfer:
    get:
      tags:
      - File System Replica Links
      summary: Pure Storage GET File-system-replica-links/transfer
      description: List the transfer status details for file system replication.
      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/Remote_ids'
      - $ref: '#/components/parameters/Remote_names'
      - $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'
  /api/1.5/file-system-replica-links:
    get:
      tags:
      - File System Replica Links
      summary: Pure Storage Get FlashBlade File System Replica Links
      description: 'Retrieves information about FlashBlade file system replica links.

        '
      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/Member_ids_plus'
      - $ref: '#/components/parameters/Member_names_plus'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      - $ref: '#/components/parameters/Source_ids_plus'
      - $ref: '#/components/parameters/Source_names_plus'
      - $ref: '#/components/parameters/Target_ids_plus'
      - $ref: '#/components/parameters/Target_names_plus'
      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/FileSystemReplicaLinkGetResponse_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-replica-links/policies:
    get:
      tags:
      - File System Replica Links
      summary: Pure Storage Get FlashBlade File System Replica Link / Policy Pairs
      description: 'Retrieves pairs of FlashBlade file system replica link 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'
      - $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
    FileSystemReplicaLinkGetResponse_2:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/FileSystemReplicaLinkResponse_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
    ErrorNoContext:
      type: object
      properties:
        message:
          type: string
          example: Something was wrong
    PolicyMemberWithRemote:
      allOf:
      - $ref: '#/components/schemas/_context'
      - $ref: '#/components/schemas/PolicyFileSystemSnapshot'
      - type: object
        properties:
          link:
            description: 'Only populated if the `member` is a file system replica link. Contains additional

              information about the link.

              '
            title: MemberLink
            allOf:
            - $ref: '#/components/schemas/_memberLink'
    PolicyMemberWithRemoteResponse:
      allOf:
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          items:
            description: A list of members for policies.
            type: array
            items:
              $ref: '#/components/schemas/PolicyMemberWithRemote'
    _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
    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'
    FileSystemReplicaLinkResponse_2:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/FileSystemReplicaLink_2'
    _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'
    _errorErrors:
      type: object
      properties:
        context:
          type: string
          example: Error with ...
        message:
          type: string
          example: Something was wrong
    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'
    FileSystemReplicaLinkGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/FileSystemReplicaLinkResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    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'
    _replicaLinkBuiltIn:
      allOf:
      - $ref: '#/components/schemas/_builtInRelationship'
      - type: object
        properties:
          direction:
            $ref: '#/components/schemas/_direction'
          lag:
            description: 'Duration in milliseconds that represents how far

              behind the replication target is from the source.

              This is the time difference between current time and `recovery_point`.

              '
            type: integer
            format: int64
            readOnly: true
          status_details:
            description: 'Detailed information about the status of the replica link when it is

              unhealthy.

              '
            type: string
            readOnly: true
    _resourceWithLocation:
      description: 'An ordinary resource that exists in one location.

        '
      allOf:
      - $ref: '#/components/schemas/_fixedReference_2'
      - type: object
        properties:
          location:
            $ref: '#/components/schemas/_fixedReferenceFqdn'
    _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
    _builtInRelationship:
      type: object
      properties:
        id:
          description: 'A non-modifiable, globally unique ID chosen by the system.

            '
          type: string
          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
    PolicyMemberWithRemoteGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/PolicyMemberWithRemoteResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    _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'
    FileSystemReplicaLink_2:
      description: A replica link between two FlashBlade file systems.
      allOf:
      - $ref: '#/components/schemas/_replicaLink'
      - description: A replica link between two FlashBlade file systems.
        type: object
        properties:
          members:
            description: 'The union of source and target file systems in the replica link.

              '
            type: array
            items:
              $ref: '#/components/schemas/_resourceWithLocation'
          recovery_point:
            description: 'Time when the last replicated snapshot was created, in milliseconds

              since the UNIX epoch. (i.e. the recovery point if the file system is

              promoted.)

              '
            type: integer
            format: int64
            readOnly: true
            example: 1565034592494
          sources:
            description: The source file systems in the replica link.
            type: array
            items:
              $ref: '#/components/schemas/_resourceWithLocation'
          status_details:
            description: 'Detailed information about the status of the replica link when it is

              `unhealthy`.

              '
            type: string
          targets:
            description: The target file systems in the replica link.
            type: array
            items:
              $ref: '#/components/schemas/_resourceWithLocation'
    FileSystemReplicaLinkResponse:
      type: object
      properties:
        items:
          description: A list of file system replica link objects.
          type: array
          items:
            $ref: '#/components/schemas/FileSystemReplicaLink'
    FileSystemReplicaLink:
      allOf:
      - $ref: '#/components/schemas/_replicaLinkBuiltIn'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          link_type:
            description: 'Type of the replica link.

              Values include `full-replica`, and `partial-replica`.

              '
            type: string
          local_file_system:
            description: Reference to a local file system.
         

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