Pure Storage Pod Replica Links API

Pod replica links are created by associating a source pod with a demoted pod, making the demoted pod the target pod of the source pod. The direction of the replica link is from the promoted source pod to the demoted target pod. Replica links can be created in either direction between the same two FlashArrays. The target pod of a replica link cannot be on the same FlashArray as the source pod.

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-pod-replica-links-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Pod 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: Pod Replica Links
  description: 'Pod replica links are created by associating a source pod with a demoted pod, making

    the demoted pod the target pod of the source pod. The direction of the replica link is from the

    promoted source pod to the demoted target pod. Replica links can be created in either direction

    between the same two FlashArrays. The target pod of a replica link cannot be on the same

    FlashArray as the source pod.

    '
paths:
  /api/2.52/pod-replica-links:
    get:
      tags:
      - Pod Replica Links
      summary: Pure Storage List Pod Replica Links
      description: Displays the list of pod replica links that are configured between arrays.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_pod_ids'
      - $ref: '#/components/parameters/Local_pod_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Remote_array_or_realm_ids'
      - $ref: '#/components/parameters/Remote_array_or_realm_names'
      - $ref: '#/components/parameters/Remote_pod_ids'
      - $ref: '#/components/parameters/Remote_pod_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkGetResponse'
    post:
      tags:
      - Pod Replica Links
      summary: Pure Storage Create Pod Replica Links
      description: Creates pod replica links between two arrays. The `local_pod_names` and `remote_pod_names` are required. Valid values are `replicating`, `baselining`, `paused`, `unhealthy`, `quiescing`, and `quiesced`. A status of `replicating` indicates that the source array is replicating to the target array. A status of `baselining` indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the `baselining` status to recur. A status of `paused ` indicates that data transfer between objects has stopped. A status of `unhealthy` indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of `quiescing` indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of `quiesced` indicates that the source pod has been demoted and all changes have been replicated to the target pod.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Local_pod_ids'
      - $ref: '#/components/parameters/Local_pod_names'
      - $ref: '#/components/parameters/Remote_array_or_realm_ids'
      - $ref: '#/components/parameters/Remote_array_or_realm_names'
      - $ref: '#/components/parameters/Remote_pod_ids'
      - $ref: '#/components/parameters/Remote_pod_names'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkResponse'
    delete:
      tags:
      - Pod Replica Links
      summary: Pure Storage Delete Pod Replica Links
      description: Deletes pod replica links. The `local_pod_names` and `remote_pod_names` are required. Valid values are `replicating`, `baselining`, `paused`, `unhealthy`, `quiescing`, and `quiesced`. A status of `replicating` indicates that the source array is replicating to the target array. A status of `baselining` indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the `baselining` status to recur. A status of `paused ` indicates that data transfer between objects has stopped. A status of `unhealthy` indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of `quiescing` indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of `quiesced` indicates that the source pod has been demoted and all changes have been replicated to the target pod.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Local_pod_ids'
      - $ref: '#/components/parameters/Local_pod_names'
      - $ref: '#/components/parameters/Remote_pod_ids'
      - $ref: '#/components/parameters/Remote_pod_names'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - Pod Replica Links
      summary: Pure Storage Modify Pod Replica Links
      description: Modifies pod replica links. The `local_pod_names` and `remote_pod_names` are required. Valid values are `replicating`, `baselining`, `paused`, `unhealthy`, `quiescing`, and `quiesced`. A status of `replicating` indicates that the source array is replicating to the target array. A status of `baselining` indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the `baselining` status to recur. A status of `paused ` indicates that data transfer between objects has stopped. A status of `unhealthy` indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of `quiescing` indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of `quiesced` indicates that the source pod has been demoted and all changes have been replicated to the target pod.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Local_pod_ids'
      - $ref: '#/components/parameters/Local_pod_names'
      - $ref: '#/components/parameters/Remote_array_or_realm_ids'
      - $ref: '#/components/parameters/Remote_array_or_realm_names'
      - $ref: '#/components/parameters/Remote_pod_ids'
      - $ref: '#/components/parameters/Remote_pod_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PodReplicaLinkPatch'
        required: true
        x-codegen-request-body-name: pod-replica-link
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkResponse'
      x-codegen-request-body-name: pod-replica-link
  /api/2.52/pod-replica-links/lag:
    get:
      tags:
      - Pod Replica Links
      summary: Pure Storage List Pod Replica Link Lag
      description: Displays the lag in milliseconds that the replication target is behind the source. This is the time difference between the current time and the recovery point.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/History_end_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_pod_ids'
      - $ref: '#/components/parameters/Local_pod_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Remote_array_or_realm_ids'
      - $ref: '#/components/parameters/Remote_array_or_realm_names'
      - $ref: '#/components/parameters/Remote_pod_ids'
      - $ref: '#/components/parameters/Remote_pod_names'
      - $ref: '#/components/parameters/History_resolution'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/History_start_time'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkLagGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkLagGetResponse'
  /api/2.52/pod-replica-links/performance/replication:
    get:
      tags:
      - Pod Replica Links
      summary: Pure Storage List Replica Link Performance Data
      description: 'The monitoring interface or metric that provides the total

        number of `bytes` of `replication` data transmitted and

        received `per second`.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/History_end_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_pod_ids'
      - $ref: '#/components/parameters/Local_pod_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Remote_array_or_realm_ids'
      - $ref: '#/components/parameters/Remote_array_or_realm_names'
      - $ref: '#/components/parameters/Remote_pod_ids'
      - $ref: '#/components/parameters/Remote_pod_names'
      - $ref: '#/components/parameters/History_resolution'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/History_start_time'
      - $ref: '#/components/parameters/Total_item_count'
      - $ref: '#/components/parameters/Historical_total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkPerformanceReplicationGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkPerformanceReplicationGetResponse'
  /api/2.52/pod-replica-links/performance/replication/by-array:
    get:
      tags:
      - Pod Replica Links
      summary: Pure Storage List Replica Link Performance Data with Array Details
      description: 'The monitoring interface that provides the total number of `bytes`

        of `replication` data transmitted and received `per second`.

        This data is organized by `array` and further categorized by

        the specific `replica link`, `source array`, and `target array`

        to provide granular visibility into network throughput.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/History_end_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_pod_ids'
      - $ref: '#/components/parameters/Local_pod_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Remote_array_or_realm_ids'
      - $ref: '#/components/parameters/Remote_array_or_realm_names'
      - $ref: '#/components/parameters/Remote_pod_ids'
      - $ref: '#/components/parameters/Remote_pod_names'
      - $ref: '#/components/parameters/History_resolution'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/History_start_time'
      - $ref: '#/components/parameters/Total_item_count'
      - $ref: '#/components/parameters/Historical_total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkPerformanceReplicationArrayGetResponse'
        '207':
          description: 'The status indicating a partial success. While some `resources`

            were successfully returned, specific `errors` occurred during

            the operation that may have prevented the full set of

            requested data from being retrieved.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkPerformanceReplicationArrayGetResponse'
  /api/2.52/pod-replica-links/mappings/policies:
    get:
      tags:
      - Pod Replica Links
      summary: Pure Storage List Policy Mappings
      description: 'Displays a list of policy mappings.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_pod_ids'
      - $ref: '#/components/parameters/Local_pod_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Pod_replica_link_ids'
      - $ref: '#/components/parameters/Remote_array_or_realm_ids'
      - $ref: '#/components/parameters/Remote_array_or_realm_names'
      - $ref: '#/components/parameters/Remote_pod_ids'
      - $ref: '#/components/parameters/Remote_pod_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkMappingPolicyGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkMappingPolicyGetResponse'
    patch:
      tags:
      - Pod Replica Links
      summary: Pure Storage Modify Policy Mappings
      description: 'Modifies policy mappings of a replica link.

        Valid `mapping` values are `connected` and `disconnected`. `connected` indicates that the

        source policy and its attachments will be mirrored on the target pod.

        `disconnected` indicates that the associated policy and its attachments are independent

        from any policy on the remote. This operation can only be performed on

        the target side of a pod replica link.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Local_pod_ids'
      - $ref: '#/components/parameters/Local_pod_names'
      - $ref: '#/components/parameters/Pod_replica_link_ids'
      - $ref: '#/components/parameters/Remote_array_or_realm_ids'
      - $ref: '#/components/parameters/Remote_array_or_realm_names'
      - $ref: '#/components/parameters/Remote_pod_ids'
      - $ref: '#/components/parameters/Remote_pod_names'
      - $ref: '#/components/parameters/Remote_policy_ids'
      - $ref: '#/components/parameters/Remote_policy_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingPolicyPatch'
        required: true
        x-codegen-request-body-name: mapping
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodReplicaLinkMappingPolicyResponse'
      x-codegen-request-body-name: mapping
  /api/1.5/pod-replica-links:
    get:
      tags:
      - Pod Replica Links
      summary: Pure Storage Get Pod Replica Links
      description: 'Retrieves information about pod replica links.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization_2'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token_2'
      - $ref: '#/components/parameters/Filter_2'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Limit_2'
      - $ref: '#/components/parameters/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/PodReplicaLinkGetResponse_2'
        '400':
          $ref: '#/components/responses/Error400'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
components:
  schemas:
    PodReplicaLinkResponse:
      type: object
      properties:
        items:
          description: A list of pod replica link objects.
          type: array
          items:
            $ref: '#/components/schemas/PodReplicaLink'
    _podArrayAndMember:
      allOf:
      - $ref: '#/components/schemas/_referenceWithType'
      - type: object
        properties:
          member:
            description: 'The reference to the member on the array.

              '
            title: ReferenceWithType
            allOf:
            - $ref: '#/components/schemas/_referenceWithType'
        x-readOnly: true
    _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
    _replicaLinkPerformanceReplication:
      allOf:
      - $ref: '#/components/schemas/_replicaLinkPerformanceReplicationBase'
      - type: object
        properties:
          remotes:
            description: The reference to a `remote array`. This uniquely identifies the external or peered storage system involved in data replication, synchronization, or management operations.
            type: array
            readOnly: true
            items:
              $ref: '#/components/schemas/_fixedReferenceWithType'
      x-readOnly: true
    _replicaLinkLag:
      type: object
      properties:
        avg:
          description: 'The average time difference between the current time and `recovery_point` for a period of

            time.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        max:
          description: 'The maximum time difference between the current time and `recovery_point` for a period of

            time.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
      x-readOnly: true
    PodReplicaLinkLagResponse:
      type: object
      properties:
        items:
          description: A list of pod replica link lag objects.
          type: array
          items:
            $ref: '#/components/schemas/PodReplicaLinkLag'
    PodReplicaLinkMappingPolicyGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/PodReplicaLinkMappingPolicyResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    PodReplicaLinkPerformanceReplication:
      allOf:
      - $ref: '#/components/schemas/_builtInRelationship'
      - $ref: '#/components/schemas/_replicaLinkPerformanceReplication'
      - $ref: '#/components/schemas/_context'
    PodReplicaLink:
      allOf:
      - $ref: '#/components/schemas/_builtInRelationship'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          direction:
            description: 'The direction of replication. Valid values include `inbound` and `outbound`.

              '
            type: string
            readOnly: true
          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
          local_pod:
            description: Reference to a local pod.
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
          local_pod_members:
            description: 'A list of arrays or realms that are members of the local pod.

              '
            type: array
            items:
              $ref: '#/components/schemas/_fixedReferenceWithType'
          paused:
            description: 'Returns a value of `true` if the replica link is in a `paused` state.

              Returns a value of `false` if the replica link is not in a `paused` state.

              '
            type: boolean
          recovery_point:
            description: 'Time when the last piece of data was replicated, in milliseconds since the UNIX epoch,

              and the recovery point if the target pod is promoted.

              If the pod is currently baselining, then the value is `null`.

              '
            type: integer
            format: int64
            readOnly: true
            example: 1565034592494
          remote_pod:
            description: Reference to a remote pod.
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
          remotes:
            description: A list of remote arrays or realms that share this pod.
            type: array
            items:
              $ref: '#/components/schemas/_fixedReferenceWithType'
          status:
            description: 'Status of the replica-link. Valid values include `replicating`, `baselining`,

              `paused`, `quiescing`, `quiesced`, `idle`, and `unhealthy`.

              '
            type: string
            readOnly: true
    _errorErrors:
      type: object
      properties:
        context:
          type: string
          example: Error with ...
        message:
          type: string
          example: Something was wrong
    PodReplicaLinkGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/PodReplicaLinkResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    PodReplicaLink_2:
      description: A replica link between two pods.
      allOf:
      - $ref: '#/components/schemas/_replicaLink'
      - description: A replica link between two pods.
        type: object
        properties:
          members:
            description: The union of source and target pods in the replica link.
            type: array
            items:
              $ref: '#/components/schemas/_resourceWithLocations'
          recovery_point:
            description: 'Time when the last piece of data was replicated, in milliseconds since

              the UNIX epoch, and the recovery point if the target pod is promoted.

              If the pod is currently baselining then the value is `null`.

              '
            type: integer
          sources:
            description: The source pods in the replica link.
            type: array
            items:
              $ref: '#/components/schemas/_resourceWithLocations'
          status:
            description: 'Status of the replica link. Values include `replicating`, `idle`,

              `baselining`, `paused`, `quiescing`, `quiesced`, and `unhealthy`.

              '
            type: string
            example: replicating
          targets:
            description: The target pods in the replica link.
            type: array
            items:
              $ref: '#/components/schemas/_resourceWithLocations'
    _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
    _replicaLinkPerformanceReplicationArray:
      allOf:
      - $ref: '#/components/schemas/_replicaLinkPerformanceReplicationBase'
      - type: object
        properties:
          local_pod_array:
            description: 'The `local array` on which the performance metrics were recorded.

              This acts as the source identifier for the collected data.

              '
            title: PodArrayAndMember
            allOf:
            - $ref: '#/components/schemas/_podArrayAndMember'
          remote_pod_array:
            description: 'The `remote array` on which the performance metrics were recorded.

              This acts as the source identifier for data collected from a

              replicated or peered system.

              '
            title: PodArrayAndMember
            allOf:
            - $ref: '#/components/schemas/_podArrayAndMember'
    PodReplicaLinkPerformanceReplicationResponse:
      type: object
      properties:
        items:
          description: A list of pod replica link performance objects.
          type: array
          items:
            $ref: '#/components/schemas/PodReplicaLinkPerformanceReplication'
        total:
          description: 'The aggregate value of all items after filtering.

            For real-time performance, the values are aggregated for the latest timestamp.

            For historical performance, the values are aggregated for each timestamp from

            `start_time` to `end_time`. Where it makes more sense, the average value is

            displayed instead. The values are displayed for each field where meaningful.

            '
          type: array
          items:
            $ref: '#/components/schemas/PodReplicaLinkPerformanceReplication'
    _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
    PodReplicaLinkPerformanceReplicationArray:
      allOf:
      - $ref: '#/components/schemas/_builtInRelationship'
      - $ref: '#/components/schemas/_replicaLinkPerformanceReplicationArray'
      - $ref: '#/components/schemas/_context'
    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
        more_items_remaining:
          description: 'Returns a value of `true` if subsequent items can be retrieved.

            '
          type: boolean
          example: false
        total_item_count:
          description: 'The total number of records after applying all filter query parameters.

            The `total_item_count` will be calculated if and only if the corresponding

            query parameter `total_item_count` is set to `true`. If this query parameter

            is not set or set to `false`, a value of `null` will 

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