Pure Storage Realm Connections API

Realm connections enable replication services between different realms in a connected array cluster.

Operations 13

GET /api/2.52/realm-connections Pure Storage List Realm Connections.
POST /api/2.52/realm-connections Pure Storage Create Realm Connection.
DELETE /api/2.52/realm-connections Pure Storage Delete Realm Connections.
PATCH /api/2.52/realm-connections Pure Storage Modify Realm Connections.
GET /api/2.52/realm-connections/connection-keys Pure Storage Get Realm Connection Key Information
POST /api/2.52/realm-connections/connection-keys Pure Storage Create Realm Connection Key
DELETE /api/2.52/realm-connections/connection-keys Pure Storage Delete Realm Connection Keys
GET /api/2.26/realm-connections Pure Storage GET Realm-connections
POST /api/2.26/realm-connections Pure Storage POST Realm-connections
DELETE /api/2.26/realm-connections Pure Storage DELETE Realm-connections
GET /api/2.26/realm-connections/connection-key Pure Storage GET Realm-connections/connection-key
POST /api/2.26/realm-connections/connection-key Pure Storage POST Realm-connections/connection-key
DELETE /api/2.26/realm-connections/connection-key Pure Storage DELETE Realm-connections/connection-key

Documentation

Specifications

Code Examples

Schemas & Data

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

Other Resources

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

Work with this as data

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

MCP server

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

https://apis.io/mcp

Tools for apis

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

Call it yourself

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

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

Get an API key

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

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

OpenAPI Specification

pure-storage-realm-connections-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: FlashArray REST Active Directory Realm 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: Realm Connections
  description: 'Realm connections enable replication services between different realms in a connected

    array cluster.

    '
paths:
  /api/2.52/realm-connections:
    get:
      tags:
      - Realm Connections
      summary: Pure Storage List Realm Connections.
      description: 'Displays a list of configured realm connections.


        '
      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_without_names'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_realm_ids'
      - $ref: '#/components/parameters/Local_realm_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Remote_realm_ids'
      - $ref: '#/components/parameters/Remote_realm_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmConnectionsGetResponse'
        '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/RealmConnectionsGetResponse'
    post:
      tags:
      - Realm Connections
      summary: Pure Storage Create Realm Connection.
      description: 'Creates a new connection between two realms.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Local_realm_ids'
      - $ref: '#/components/parameters/Local_realm_names'
      - $ref: '#/components/parameters/Remote_realm_ids'
      - $ref: '#/components/parameters/Remote_realm_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealmConnectionWithKey'
        required: true
        x-codegen-request-body-name: connection
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmConnectionsResponse'
      x-codegen-request-body-name: connection
    delete:
      tags:
      - Realm Connections
      summary: Pure Storage Delete Realm Connections.
      description: 'Deletes connections between realms.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids_without_names'
      - $ref: '#/components/parameters/Local_realm_ids'
      - $ref: '#/components/parameters/Local_realm_names'
      - $ref: '#/components/parameters/Remote_realm_ids'
      - $ref: '#/components/parameters/Remote_realm_names'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - Realm Connections
      summary: Pure Storage Modify Realm Connections.
      description: 'Modifies the connection type between realms.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Ids_without_names'
      - $ref: '#/components/parameters/Local_realm_ids'
      - $ref: '#/components/parameters/Local_realm_names'
      - $ref: '#/components/parameters/Remote_realm_ids'
      - $ref: '#/components/parameters/Remote_realm_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealmConnectionWithKey'
        required: true
        x-codegen-request-body-name: connection
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmConnectionsResponse'
      x-codegen-request-body-name: connection
  /api/2.52/realm-connections/connection-keys:
    get:
      tags:
      - Realm Connections
      summary: Pure Storage Get Realm Connection Key Information
      description: 'Displays information about existing realm connection keys.

        Secret keys are not displayed, as they are only available at the time of key creation.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Realm_ids'
      - $ref: '#/components/parameters/Realm_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmConnectionKeyGetResponse'
    post:
      tags:
      - Realm Connections
      summary: Pure Storage Create Realm Connection Key
      description: 'Creates a new one-time connection key to allow establishing a connection to the specified realm.

        The key is valid until a successful connection is established or its expiration time is reached.

        Note that this is the only time the connection key is displayed; it cannot be retrieved subsequently.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Realm_ids'
      - $ref: '#/components/parameters/Realm_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealmConnectionKeyPost'
        required: true
        x-codegen-request-body-name: connection_key
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmConnectionKeyPostResponse'
      x-codegen-request-body-name: connection_key
    delete:
      tags:
      - Realm Connections
      summary: Pure Storage Delete Realm Connection Keys
      description: 'Deletes all connection keys for a given realm.

        Note that every realm connection key is a one-time key

        and is deleted automatically upon a successful connection or once it expires.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Realm_ids'
      - $ref: '#/components/parameters/Realm_names'
      responses:
        '200':
          description: OK
          content: {}
  /api/2.26/realm-connections:
    get:
      tags:
      - Realm Connections
      summary: Pure Storage GET Realm-connections
      description: List realm connections.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_realm_ids_2'
      - $ref: '#/components/parameters/Local_realm_names_2'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Remote_realm_ids_2'
      - $ref: '#/components/parameters/Remote_realm_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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmConnectionGetResponse'
    post:
      tags:
      - Realm Connections
      summary: Pure Storage POST Realm-connections
      description: Create a realm connection.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Local_realm_ids_2'
      - $ref: '#/components/parameters/Local_realm_names_2'
      - $ref: '#/components/parameters/Remote_realm_ids_2'
      - $ref: '#/components/parameters/Remote_realm_names_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealmConnectionPost'
        required: true
      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/RealmConnectionResponse'
    delete:
      tags:
      - Realm Connections
      summary: Pure Storage DELETE Realm-connections
      description: Delete realm connection.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Local_realm_ids_2'
      - $ref: '#/components/parameters/Local_realm_names_2'
      - $ref: '#/components/parameters/Remote_realm_ids_2'
      - $ref: '#/components/parameters/Remote_realm_names_2'
      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/realm-connections/connection-key:
    get:
      tags:
      - Realm Connections
      summary: Pure Storage GET Realm-connections/connection-key
      description: List realm connection keys.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Realm_ids_2'
      - $ref: '#/components/parameters/Realm_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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmConnectionKeyGetResponse_2'
    post:
      tags:
      - Realm Connections
      summary: Pure Storage POST Realm-connections/connection-key
      description: Create a realm connection key.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Realm_ids_2'
      - $ref: '#/components/parameters/Realm_names_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/RealmConnectionKeyResponse_2'
    delete:
      tags:
      - Realm Connections
      summary: Pure Storage DELETE Realm-connections/connection-key
      description: Delete a realm connection key.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Realm_ids_2'
      - $ref: '#/components/parameters/Realm_names_2'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
components:
  schemas:
    _fixedReference_2:
      allOf:
      - $ref: '#/components/schemas/_fixedReferenceWithoutType'
      - type: object
        properties:
          resource_type:
            description: 'Type of the object (full name of the endpoint).

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

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

              `resource_type` of `file-systems`.

              '
            type: string
            readOnly: true
    RealmConnectionGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/RealmConnectionResponse'
    RealmConnection:
      allOf:
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          id:
            description: The ID of a realm connection object.
            type: string
            readOnly: true
          local_realm:
            description: 'The local realm side of a connection.

              '
            readOnly: true
            title: ReferenceWithType
            allOf:
            - $ref: '#/components/schemas/_referenceWithType'
          remote_realm:
            description: 'The remote realm side of a connection.

              '
            readOnly: true
            title: ReferenceWithType
            allOf:
            - $ref: '#/components/schemas/_referenceWithType'
          status:
            description: 'The connection status. Values include connected, unreachable, and degraded.

              The connected status means that the connection is alive and data is replicating.

              The unreachable status indicates that the remote realm is not found on any array in the cluster.

              The degraded status indicates that the array connection was downgraded

              to the async-replication type while the realm connection''s type is sync-replication.

              In that case, the realm can use the async replication feature but cannot use sync-replication features.

              '
            type: string
            readOnly: true
          type:
            description: 'Specifies the type of the realm connection. Values include async-replication and sync-replication.

              '
            type: string
    RealmConnectionWithKey:
      allOf:
      - $ref: '#/components/schemas/RealmConnection'
      - type: object
        properties:
          connection_key:
            description: 'Specifies the unique string token used to create or

              update a realm connection to the remote realm associated with the key.

              On update, the key is required only when changing the connection type

              from async-replication to sync-replication.

              '
            type: string
    _referenceWithType:
      allOf:
      - $ref: '#/components/schemas/_reference'
      - type: object
        properties:
          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
      x-aliases:
      - _reference
    _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
    RealmConnectionKeyGetResponse_2:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/RealmConnectionKeyResponse_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
    RealmConnectionKeyPost:
      type: object
      properties:
        type:
          description: 'Specifies the type of realm connection that a key can create.

            Values include async-replication and sync-replication.

            A sync-replication key can also be used to create an async-replication connection.

            '
          type: string
    _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: FixedReferenceWithType
          allOf:
          - $ref: '#/components/schemas/_fixedReferenceWithType'
    _fixedReference:
      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
      x-aliases:
      - _fixedReferenceWithoutType
    RealmConnectionKey:
      allOf:
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          connection_key:
            description: 'Specifies the unique string token used to create or update a realm connection.

              The key is only visible when created.

              The response of the POST operation and any subsequent GET requests hide the key as ****.

              '
            type: string
            readOnly: true
          created:
            description: 'The creation time in milliseconds since the UNIX epoch.

              '
            type: integer
            format: int64
            example: 1706850977000
          expires:
            description: 'The expiration time in milliseconds since the UNIX epoch.

              '
            type: integer
            format: int64
            example: 1706850977000
          realm:
            description: 'The realm to which the connection key is associated.

              '
            title: ReferenceWithType
            allOf:
            - $ref: '#/components/schemas/_referenceWithType'
          type:
            description: 'Specifies the type of realm connection that a key can create.

              Values include async-replication and sync-replication.

              A sync-replication key can also be used to create an async-replication connection.

              '
            type: string
    _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
    RealmConnectionsGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/_errorContextResponse'
      - $ref: '#/components/schemas/RealmConnectionsResponse'
    RealmConnectionResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/RealmConnection_2'
    RealmConnectionKeyResponse_2:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/RealmConnectionKey_2'
    RealmConnectionKeyGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/_errorContextResponse'
      - $ref: '#/components/schemas/RealmConnectionKeyResponse'
    PageInfo_2:
      type: object
      properties:
        continuation_token:
          description: 'Continuation token that can be provided in the `continuation_token` query

            param to get the next page of data.

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

            are guaranteed to get all items exactly once regardless of

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

            the pagination then it may or may not be returned.

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

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

            (no sort is specified).

            '
          type: string
        total_item_count:
          description: Total number of items after applying `filter` params.
          type: integer
          format: int32
    RealmConnectionKeyResponse:
      type: object
      properties:
        items:
          description: A list of realm connection key objects.
          type: array
          items:
            $ref: '#/components/schemas/RealmConnectionKey'
    RealmConnectionKey_2:
      type: object
      properties:
        connection_key:
          description: 'Connection-key, used to establish connection between two realms

            After creation, listing will only show ****.

            '
          type: string
          readOnly: true
          example: '"6207d123-d123-0b5c-5fa1-95fabc5c7123" or "****"'
        created:
          description: Creation time in milliseconds since UNIX epoch.
          type: integer
          format: int64
          example: 1742221735
          readOnly: true
        expires:
          description: Expiration time in milliseconds since UNIX epoch.
          type: integer
          format: int64
          example: 1742228935
          readOnly: true
        realm:
          description: Realm for which the key was generated.
          title: FixedReference
          allOf:
          - $ref: '#/components/schemas/_fixedReference_2'
      x-readOnly: true
    _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'
    RealmConnectionsResponse:
      type: object
      properties:
        items:
          description: A list of realm connection objects.
          type: array
          items:
            $ref: '#/components/schemas/RealmConnection'
    _builtInRelationship:
      type: object
      properties:
        id:
          description: 'A non-modifiable, globally unique ID chosen by the system.

            '
          type: string
          readOnly: true
    RealmConnectionKeyPostResponse:
      type: object
      properties:
        items:
          description: A list of realm connection keys.
          type: array
          items:
            $ref: '#/components/schemas/RealmConnectionKey'
    RealmConnection_2:
      allOf:
      - $ref: '#/components/schemas/_builtInRelationship'
      - type: object
        properties:
          local_realm:
            description: Realm on the local cluster connected to the remote realm.
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference_2'
            readOnly: true
          remote_realm:
            description: Realm on the remote cluster connected to the local realm.
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference_2'
            readOnly: true
          status:
            description: 'Status of the realm connection.

              Values include `CONNECTING`, `CONNECTED`, `DISCONNECTED` and `UNREACHABLE`.

              '
            type: string
            readOnly: true
    _fixedReferenceWithType:
      allOf:
      - $ref: '#/components/schemas/_fixedReference'
      - type: object
        properties:
          resource_type:
            description: 'Type of the object (full name of the endpoint).

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

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

              `resource_type` of `file-systems`.

              '
            type: string
            readOnly: true
      x-aliases:
      - _fixedReference
    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 be returned.

            '
          type: integer
          format: int32
    RealmConnectionPost:
      allOf:
      - $ref: '#/components/schemas/RealmConnection_2'
      - type: object
        properties:
          connection_key:
            description: 'The connection key for the remote realm. Settable on POST only.

              '
            type: string
  parameters:
    Realm_names:
      name: realm_names
      in: query
      description: 'Performs the operation on the specified unique resource names.

        Enter multiple resource names in comma-separated format.

        The realm_names and realm_ids parameters cannot be set together.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Context_names_get:
      name: context_names
      in: query
      description: 'Performs the operation on the unique contexts specified.


        If specified, each context name must be the name of an array in the same fleet or

        the name of the fleet itself.


        If not specified, the context will default to the array that received this request.


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

        are resolved relative to the provided `context`.


        Enter multiple names in comma-separated format.

        For example, `name01,name02`.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Allow_errors:
      name: allow_errors
      in: query
      description: 'If set to `true`, the API will allow the operation to continue even if there are errors.

        Any errors will be returned in the `errors` field of the response.

        If set to `false`, the operation will fail if there are any errors.

        '
      schema:
        type: boolean
        default: false
    Remote_realm_ids_2:
      name: remote_realm_ids
      in: query
      description: 'A comma-separated list of remote realm IDs. If, after filtering,

        there is not at least one resource that matches each of the elements,

        then an error is returned. This cannot be provided together with the

        `remote_realm_names` query parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Offset:
      name: offset
      in: query
      description: 'The starting position based on the results of the query

        in relation to the full set of response objects returned.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Realm_ids_2:
      name: realm_ids
      in: query
      description: 'A comma-separated list of realm IDs. If, after filtering,

        there is not at least one resource that matches each of the elements,

        then an error is returned. This cannot be provided together with the

        `realm_names` query parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Realm_names_2:
      name: realm_names
      in: query
      description: 'A comma-separated list of realm names. If there is not

        at least one resource that matches each of the elements, then an error

        is returned. This cannot be provided together with `realm_ids`

        query parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Local_realm_ids:
      name: local_realm_ids
      in: query
      description: 'Performs the operation on the specified unique resource IDs.

        Enter multiple resource IDs in comma-separated format.

        The local_realm_ids and local_realm_names parameters cannot be set together.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Continuation_token:
      name: continuation_token
      in: query
      description: 'A token used to retrieve the next page of data

        with some consistency guaranteed.

        The token is a Base64 encoded value.

        Set `continuation_token` to the system-generated token taken from the `x-next-token`

        header field of the response.

        A qu

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