Pure Storage Array Connections API

Manages connections between arrays.

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-array-connections-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Array Connections 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: Array Connections
  description: 'Manages connections between arrays.

    '
paths:
  /api/2.52/array-connections:
    get:
      tags:
      - Array Connections
      summary: Pure Storage List the Connected Arrays
      description: 'Displays a list of connected 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/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Remote_ids'
      - $ref: '#/components/parameters/Remote_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayConnectionGetResponse'
        '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/ArrayConnectionGetResponse'
    post:
      tags:
      - Array Connections
      summary: Pure Storage Create an Array Connection
      description: 'Creates a connection between this array and the specified array.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArrayConnectionPost'
        required: true
        x-codegen-request-body-name: array-connection
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayConnectionResponse'
      x-codegen-request-body-name: array-connection
    delete:
      tags:
      - Array Connections
      summary: Pure Storage Delete an Array Connection
      description: 'Deletes the connection between this array and the specified array.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - Array Connections
      summary: Pure Storage Modify an Array Connection
      description: 'Modifies attributes for an array connection.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Refresh'
      - $ref: '#/components/parameters/Renew_encryption_key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArrayConnectionPatch'
        required: false
        x-codegen-request-body-name: array-connection
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayConnectionResponse'
      x-codegen-request-body-name: array-connection
  /api/2.52/array-connections/connection-key:
    get:
      tags:
      - Array Connections
      summary: Pure Storage List Connection Key
      description: Displays the connection key for the array.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Encrypted'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayConnectionKeyGetResponse'
  /api/2.52/array-connections/path:
    get:
      tags:
      - Array Connections
      summary: Pure Storage List Connection Path
      description: 'Displays the connection path from the array to which the connection was made.

        '
      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/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Remote_ids'
      - $ref: '#/components/parameters/Remote_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayConnectionPathGetResponse'
        '207':
          description: 'Indicates partial success.

            Some resources were returned, but errors may have prevented other resources from being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayConnectionPathGetResponse'
  /api/2.26/array-connections:
    get:
      tags:
      - Array Connections
      summary: Pure Storage GET Array-connections
      description: List connected arrays for 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_2'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Remote_ids'
      - $ref: '#/components/parameters/Remote_names'
      - $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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayConnectionGetResponse'
        '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/ArrayConnectionGetResponse'
    post:
      tags:
      - Array Connections
      summary: Pure Storage POST Array-connections
      description: Create a connection to an array for replication and configure network settings.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArrayConnectionPost_2'
        required: true
        x-codegen-request-body-name: array-connection
      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/ArrayConnectionResponse'
      x-codegen-request-body-name: array-connection
    delete:
      tags:
      - Array Connections
      summary: Pure Storage DELETE Array-connections
      description: Delete a connection to an array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Remote_ids_deprecated'
      - $ref: '#/components/parameters/Remote_names_deprecated'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
    patch:
      tags:
      - Array Connections
      summary: Pure Storage PATCH Array-connections
      description: Modify the configuration of a connected array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Remote_ids_deprecated'
      - $ref: '#/components/parameters/Remote_names_deprecated'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArrayConnection_2'
        required: true
        x-codegen-request-body-name: array-connection
      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/ArrayConnectionResponse'
      x-codegen-request-body-name: array-connection
  /api/2.26/array-connections/connection-key:
    get:
      tags:
      - Array Connections
      summary: Pure Storage GET Array-connections/connection-key
      description: List connection keys used to authenticate the connection from one array to another.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayConnectionKeyGetResponse_2'
    post:
      tags:
      - Array Connections
      summary: Pure Storage POST Array-connections/connection-key
      description: Create an array connection key allowing one array to connect to another for replication.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      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/ArrayConnectionKeyResponse'
  /api/2.26/array-connections/path:
    get:
      tags:
      - Array Connections
      summary: Pure Storage GET Array-connections/path
      description: List network path details of connected arrays.
      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_2'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Remote_ids'
      - $ref: '#/components/parameters/Remote_names'
      - $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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayConnectionPathGetResponse_2'
        '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/ArrayConnectionPathGetResponse_2'
  /api/2.26/array-connections/performance/replication:
    get:
      tags:
      - Array Connections
      summary: Pure Storage GET Array-connections/performance/replication
      description: List performance metrics of file systems or objects being replicated from one array to another.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/End_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Remote_ids'
      - $ref: '#/components/parameters/Remote_names'
      - $ref: '#/components/parameters/Resolution'
      - $ref: '#/components/parameters/Sort_2'
      - $ref: '#/components/parameters/Start_time'
      - $ref: '#/components/parameters/Total_only'
      - $ref: '#/components/parameters/Type_for_performance'
      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/ConnectionRelationshipPerformanceReplicationGetResp'
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
    ArrayConnectionPath_2:
      allOf:
      - $ref: '#/components/schemas/_builtInRelationship'
      - $ref: '#/components/schemas/_context_2'
      - description: 'Path from a source array to a destination array.

          `id` is the `id` of the array connection.

          '
        type: object
        properties:
          destination:
            description: 'IP address with the port of the target array.

              '
            type: string
            readOnly: true
            example: 10.202.101.70:443
          remote:
            description: 'The remote array.

              '
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference_2'
          source:
            description: 'IP address of the source array.

              '
            type: string
            readOnly: true
            example: 10.202.101.70
          status:
            description: 'Status of the connection.

              Valid values are `connected` and `connecting`.

              `connected` - The connection is OK.

              `connecting` - No connection exists and the array is trying to

              reconnect.

              '
            type: string
            readOnly: true
          status_details:
            description: 'Additional information describing any issues encountered when

              connecting, or `null` if the `status` is `connected`.

              '
            type: string
            readOnly: true
          type:
            description: 'The type of path. Valid values include `async-replication` and `fleet-management`.

              '
            type: string
    ArrayConnection:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - $ref: '#/components/schemas/_context'
      - description: 'Connection to a target array. The `name` and `id` values refer to the name and ID of the

          target array.

          '
        type: object
        properties:
          encryption:
            description: 'If `encrypted`, all traffic over this array connection will be encrypted.

              If `unencrypted`, all traffic over this array connection will be unencrypted.

              '
            type: string
            example: encrypted
          encryption_mode:
            description: 'Cryptographic protocol, trust model, and encryption algorithm information.

              Will be `null` if `encrypted` is `false`.

              '
            type: string
            example: TLS-PSK-AES-256
          management_address:
            description: 'Management IP address or FQDN of the target array.

              '
            type: string
            example: 10.202.101.78
          os:
            description: 'The operating system of the connected array.

              '
            type: string
            readOnly: true
          remote:
            description: 'The remote array.

              '
            title: ReferenceWithType
            allOf:
            - $ref: '#/components/schemas/_referenceWithType'
          replication_addresses:
            description: 'IP addresses of the target arrays when `replication_transport` is `ip`.

              WWNs of the target arrays when `replication_transport` is `fc`.

              '
            type: array
            items:
              type: string
              example: 10.202.101.70
          replication_transport:
            description: 'The protocol used to transport data between the local array and the remote array.

              Valid values are `ip` and `fc`. The default value is `ip`.

              '
            type: string
            example: ip
          status:
            description: 'Status of the connection. Valid values include `connected`, `connecting`,

              `partially_connected`, and `unbalanced`.

              A status of `connected` indicates that arrays are communicating.

              A status of `connecting` indicates that the array is trying to establish a connection.

              A status of `partially_connected` indicates that some replication addresses are

              communicating but others are not.

              A status of `unbalanced` indicates that the arrays are communicating, but the set of

              paths is either not redundant or not symmetrical.

              '
            type: string
          throttle:
            $ref: '#/components/schemas/_throttle'
          type:
            description: 'The type of connection. Valid values include `async-replication`, `sync-replication`, and

              `fleet-management`.

              '
            type: string
          version:
            description: The Purity version on the target array.
            type: string
            example: 5.0.0
    ArrayConnectionKeyGetResponse_2:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/ArrayConnectionKeyResponse'
    _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_2'
        message:
          description: A description of the error which occurred.
          type: string
          example: Resource does not exist.
    ArrayConnectionPathResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ArrayConnectionPath'
    _throttle_deprecated:
      type: object
      properties:
        default_limit:
          description: 'Deprecated. Default maximum bandwidth threshold for outbound traffic in bytes. Once

            exceeded, bandwidth throttling occurs.

            '
          type: integer
          format: int64
          example: 1073741824
        window:
          description: Deprecated. The time during which the `window_limit` threshold is in effect.
          title: Time_window
          allOf:
          - $ref: '#/components/schemas/_time_window'
        window_limit:
          description: 'Deprecated. Maximum bandwidth threshold for outbound traffic during the specified

            `window_limit` time range in bytes. Once exceeded, bandwidth throttling

            occurs.

            '
          type: integer
          format: int64
          example: 2097152
    _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'
    ArrayConnectionKey:
      type: object
      properties:
        connection_key:
          description: 'Connection-key used on another array to connect to this array.

            '
          type: string
          readOnly: true
          example: 6207d123-d123-0b5c-5fa1-95fabc5c7123
    _replication_performance:
      type: object
      properties:
        received_bytes_per_sec:
          description: Total bytes received per second.
          type: number
          format: double
          minimum: 0
          readOnly: true
        transmitted_bytes_per_sec:
          description: Total bytes transmitted per second.
          type: number
          format: double
          minimum: 0
          readOnly: true
      x-readOnly: true
    ArrayConnectionKeyResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ArrayConnectionKey_2'
    ArrayConnectionPathGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/ArrayConnectionPathResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    _continuousReplicationPerformance:
      allOf:
      - $ref: '#/components/schemas/_replication_performance'
      - type: object
        properties:
          object_backlog:
            description: 'The total number of pending object operations

              and their size that are currently in the backlog.

              '
            title: ObjectBacklog
            allOf:
            - $ref: '#/components/schemas/_objectBacklog'
        x-readOnly: true
    ArrayConnectionPost_2:
      allOf:
      - $ref: '#/components/schemas/ArrayConnection_2'
      - type: object
        properties:
          connection_key:
            description: 'The connection key of the target array. Settable on POST only.

              '
            type: string
            example: 6207d123-d123-0b5c-5fa1-95fabc5c7123
          encrypted:
            description: 'If this is set to `true`, then all customer data replicated over

              the connection will be sent over an encrypted connection using TLS,

              or will not be sent if a secure connection cannot be

              established.

              If this is set to `false`, then all customer data replicated over

              the connection will be sent over an unencrypted connection.

              Defaults to `false`.

              '
            type: boolean
          throttle:
            $ref: '#/components/schemas/_throttle_2'
    _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
      x-aliases:
      - _referenceWithoutType
    ConnectionRelationshipPerformanceReplication:
      allOf:
      - $ref: '#/components/schemas/_builtInRelationship'
      - type: object
        properties:
          aggregate:
            description: 'Total bytes transmitted or received per second for all types of

              replication.

              '
            title: Replication_performance
            allOf:
            - $ref: '#/components/schemas/_replication_performance'
          continuous:
            description: 'Object backlog information and total bytes transmitted or received

              per second for continuous replication. Continuous replication

              includes object replication.

              '
            title: ContinuousReplicationPerformance
            allOf:
            - $ref: '#/components/schemas/_continuousReplicationPerformance'
          periodic:
            description: 'Total bytes transmitted or received per second for periodic

              replication. Periodic replication includes file system replication,

              which is snapshot based.

              '
            title: Replication_performance
            allOf:
            - $ref: '#/components/schemas/_replication_performance'
          remote:
            description: Reference to a remote array.
            title: FixedReferenceNoResourceType
            allOf:
            - $ref: '#/components/schemas/_fixedReferenceNoResourceType'
          time:
            description: Sample time in milliseconds since UNIX epoch.
            type: integer
            format: int64
            readOnly: true
        x-readOnly: true
    _builtInRelationship:
      type: object
      properties:
        id:
          description: 'A non-modifiable, globally unique ID chosen by the system.

            '
          type: string
          readOnly: true
    _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
    _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: FixedReferenceWithType
          allOf:
          - $ref: '#/components/schemas/_fixedReferenceWithType'
        message:
          description: A description of the error which occurred.
          type: string
          example: Resource does not exist.
      x-aliases:
      - _errorContextResponseErrors
    ArrayConnectionPath:
      allOf:
      - $ref: '#/components/schemas/_builtInResourceNoId'
      - $ref: '#/components/schemas/_context'
      - description: 'Path from the local array to a remote array. The `name` parameter indicates the name of the

          remote array.

          '
        type: object
        properties:
          encryption:
            description: 'If `encrypted`, all traffic over this array connection will be encrypted.

              If `unencrypted`, all traffic over this array connection will be unencrypted.

              '
            type: string
            example: encrypted
          encryption_mode:
            description: 'Cryptographic protocol, trust model, and encryption algorithm information.

              Will be `null` if `encrypted` is `false`.

              '
            type: string
            example: TLS-PSK-AES-256
          id:
            description: 'A globally unique, system-generated ID of an array connection.

              '
            type: string
            readOnly: true
          local_address:
            description: 'IP address or WWN of the local port.

              '
            type: string
            example: 10.202.101.70
          local_port:
            description: 'The local port of the path.

              '
            type: string
            example: ct0.eth0
          remote:
            description: 'The remote array.

              '
            title: ReferenceWithType
            allOf:
            - $ref: '#/components/schemas/_referenceWithType'
          remote_address:
            description: 'IP address or WWN of the remote port.

              '
            type: string
            example: 10.202.101.78
          remote_port:
            description: 'The remote port of the path.

              '
            type: string
            example: ct1.eth0
          replication_transport:
            description: 'The protocol used to transport data between the local array and the remote array.

              Valid values are `ip` and `fc`.

              '
            type: string
          status:
            description: 'Status of the connection.

              Valid values are `connected`, `connecting`, and `quarantined`.

              A status of `connected` indicates that the arrays are communicating.

              A status of `connecting` indicates that the array is trying to establish a connection.

              A status of `quarantined` indicates that the path is unstable and has been temporarily

              embargoed for synchronous replication connections.

              '
            type: string
            readOnly: true
          status_details:
            description: 'Additional information describing any issues encounte

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