Pure Storage

Pure Storage Network Interfaces API

Manages the interfaces and the network connection attributes of the array.

GitHub OpenAPI

Operations 20

GET /api/2.52/network-interfaces Pure Storage List Network Interfaces
POST /api/2.52/network-interfaces Pure Storage Create Network Interface
DELETE /api/2.52/network-interfaces Pure Storage Delete Network Interface
PATCH /api/2.52/network-interfaces Pure Storage Modify Network Interface
GET /api/2.52/network-interfaces/neighbors Pure Storage List Network Interface Neighbors
GET /api/2.52/network-interfaces/performance Pure Storage List Network Performance Statistics
GET /api/2.52/network-interfaces/port-details Pure Storage List SFP Port Details
GET /api/2.26/network-interfaces Pure Storage GET Network-interfaces
POST /api/2.26/network-interfaces Pure Storage POST Network-interfaces
DELETE /api/2.26/network-interfaces Pure Storage DELETE Network-interfaces
PATCH /api/2.26/network-interfaces Pure Storage PATCH Network-interfaces
GET /api/2.26/network-interfaces/ping Pure Storage GET Network-interfaces/ping
GET /api/2.26/network-interfaces/trace Pure Storage GET Network-interfaces/trace
GET /api/2.26/network-interfaces/connectors Pure Storage GET Network-interfaces/connectors
PATCH /api/2.26/network-interfaces/connectors Pure Storage PATCH Network-interfaces/connectors
GET /api/2.26/network-interfaces/connectors/performance Pure Storage GET Network Connectors Performance Statistics
GET /api/2.26/network-interfaces/connectors/settings Pure Storage GET Global Network Settings for Network Connectors
GET /api/2.26/network-interfaces/network-connection-statistics Pure Storage GET Network-interfaces/network-connection-statistics
GET /api/2.26/network-interfaces/neighbors Pure Storage List Network Interface Neighbors
GET /api/1.5/network-interfaces Pure Storage Get Network Interfaces

Documentation

📖
APIReference
https://code.purestorage.com/swagger
📖
Documentation
https://code.purestorage.com
📖
APIReference
https://static.pure1.purestorage.com/api-swagger/index.html
📖
Documentation
https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-network-interfaces-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/PureStorage-OpenConnect/ansible-playbook-examples
💻
CodeExamples
https://github.com/PureStorage-OpenConnect/python-scripts
💻
CodeExamples
https://github.com/PureStorage-OpenConnect/sqlserver-scripts
💻
CodeExamples
https://github.com/PureStorage-OpenConnect/oracle-scripts
💻
CodeExamples
https://github.com/PureStorage-OpenConnect/VMware-Scripts

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-network-interfaces-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.

GitHub Google LinkedIn

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

OpenAPI Specification

pure-storage-network-interfaces-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: FlashArray REST Active Directory Network Interfaces 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: Network Interfaces
  description: 'Manages the interfaces and the network connection attributes of the array.

    '
paths:
  /api/2.52/network-interfaces:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage List Network Interfaces
      description: Displays all network interfaces for all controllers on the array.
      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/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceGetResponse'
        '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/NetworkInterfaceGetResponse'
    post:
      tags:
      - Network Interfaces
      summary: Pure Storage Create Network Interface
      description: Creates a network interface on a controller on the array.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkInterfacePost'
        required: true
        x-codegen-request-body-name: network
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceResponse'
      x-codegen-request-body-name: network
    delete:
      tags:
      - Network Interfaces
      summary: Pure Storage Delete Network Interface
      description: Deletes a network interface on a controller.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - Network Interfaces
      summary: Pure Storage Modify Network Interface
      description: Modifies a network interface on a controller.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkInterfacePatch'
        required: true
        x-codegen-request-body-name: network
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceResponse'
      x-codegen-request-body-name: network
  /api/2.52/network-interfaces/neighbors:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage List Network Interface Neighbors
      description: Displays all neighbors for all network interfaces on the array.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_port_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceNeighborGetResponse'
  /api/2.52/network-interfaces/performance:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage List Network Performance Statistics
      description: 'Displays network statistics, historical bandwidth, and error reporting for all

        specified network interfaces.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/History_end_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/History_resolution'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/History_start_time'
      - $ref: '#/components/parameters/Total_item_count'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacePerformanceGetResponse'
  /api/2.52/network-interfaces/port-details:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage List SFP Port Details
      description: 'Displays Ethernet and Fibre Channel SFP details.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacesPortDetailsGetResponse'
  /api/2.26/network-interfaces:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network-interfaces
      description: List network interfaces and their attributes.
      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/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/NetworkInterfaceGetResponse_2'
    post:
      tags:
      - Network Interfaces
      summary: Pure Storage POST Network-interfaces
      description: Create a VIP to export data or perform replication.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names_required'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkInterface_2'
        required: true
        x-codegen-request-body-name: network-interface
      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/NetworkInterfaceResponse_2'
      x-codegen-request-body-name: network-interface
    delete:
      tags:
      - Network Interfaces
      summary: Pure Storage DELETE Network-interfaces
      description: Remove a VIP. Once a data VIP is removed, any clients connected through the data VIP will lose their connection to the file system or bucket.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
    patch:
      tags:
      - Network Interfaces
      summary: Pure Storage PATCH Network-interfaces
      description: Modify the attributes of a VIP.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkInterfacePatch_2'
        required: true
        x-codegen-request-body-name: network-interface
      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/NetworkInterfaceResponse_2'
      x-codegen-request-body-name: network-interface
  /api/2.26/network-interfaces/ping:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network-interfaces/ping
      description: 'Display network interface ping result.

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ping_trace_component'
      - $ref: '#/components/parameters/Ping_count'
      - $ref: '#/components/parameters/Ping_trace_destination'
      - $ref: '#/components/parameters/Packet_size'
      - $ref: '#/components/parameters/Print_latency'
      - $ref: '#/components/parameters/Resolve_hostname'
      - $ref: '#/components/parameters/Ping_trace_source'
      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/NetworkInterfacePingGetResponse'
  /api/2.26/network-interfaces/trace:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network-interfaces/trace
      description: 'Display network interface trace result.

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ping_trace_component'
      - $ref: '#/components/parameters/Ping_trace_destination'
      - $ref: '#/components/parameters/Mtu'
      - $ref: '#/components/parameters/Fragment_packet'
      - $ref: '#/components/parameters/Method'
      - $ref: '#/components/parameters/Port'
      - $ref: '#/components/parameters/Resolve_hostname'
      - $ref: '#/components/parameters/Ping_trace_source'
      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/NetworkInterfaceTraceGetResponse'
  /api/2.26/network-interfaces/connectors:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network-interfaces/connectors
      description: List network connector information
      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/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/NetworkInterfacesConnectorsGetResponse'
    patch:
      tags:
      - Network Interfaces
      summary: Pure Storage PATCH Network-interfaces/connectors
      description: Modify network connector information.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HardwareConnector'
        required: true
        x-codegen-request-body-name: network-connector
      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/NetworkInterfacesConnectorsResponse'
      x-codegen-request-body-name: network-connector
  /api/2.26/network-interfaces/connectors/performance:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network Connectors Performance Statistics
      description: 'Displays network statistics, historical bandwidth, and error reporting for

        all specified network connectors.

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/End_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Resolution'
      - $ref: '#/components/parameters/Sort_2'
      - $ref: '#/components/parameters/Start_time'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacesConnectorsPerformanceGetResponse'
  /api/2.26/network-interfaces/connectors/settings:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Global Network Settings for Network Connectors
      description: Display the global network settings for network connectors.
      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/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/NetworkInterfacesConnectorsSettingsGetResponse'
  /api/2.26/network-interfaces/network-connection-statistics:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network-interfaces/network-connection-statistics
      description: 'Display network interface status

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/NetworkConnectionStatisticsCurrent_state'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/NetworkConnectionStatisticsLocal_host'
      - $ref: '#/components/parameters/NetworkConnectionStatisticsLocal_port'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/NetworkConnectionStatisticsRemote_host'
      - $ref: '#/components/parameters/NetworkConnectionStatisticsRemote_port'
      - $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/NetworkConnectionStatisticsGetResponse'
  /api/2.26/network-interfaces/neighbors:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage List Network Interface Neighbors
      description: Displays all neighbors for all network interfaces on the array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_port_names_2'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      - $ref: '#/components/parameters/Total_item_count'
      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/NetworkInterfaceNeighborGetResponse'
  /api/1.5/network-interfaces:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage Get Network Interfaces
      description: 'Retrieves information about physical and virtual network interface objects.

        '
      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/Names_2'
      - $ref: '#/components/parameters/Offset_3'
      - $ref: '#/components/parameters/Sort_3'
      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/NetworkInterfaceGetResponse_3'
        '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:
    _arrays:
      type: object
      properties:
        arrays:
          description: 'The list of arrays where this resource exists. Many resources are on a single array, but

            some resources, such as pods, can be shared across multiple arrays.

            '
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/_fixedReferenceFqdn'
      x-readOnly: true
    _networkInterfacePortDetailsTx_power:
      type: object
      properties:
        channel:
          description: 'The channel number if the transceiver is a multilane transceiver.

            If not specified, defaults to `null`.

            '
          type: integer
          example: 0
        measurement:
          description: 'Tx output power in mW.

            '
          type: number
          format: double
        status:
          description: 'Indicates whether the measurement is outside the high alarm, low alarm, high warning,

            or low warning thresholds for Tx output power.

            Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`.

            '
          type: string
          example: ok
    _referenceWithoutType:
      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
    _networkInterfacePortDetailsStaticTemperatureThresholds:
      description: 'The alarm low, warn low, warn high, alarm high thresholds for temperature in degrees

        Celsius.

        '
      type: object
      properties:
        alarm_high:
          description: The alarm high threshold for temperature in degrees Celsius.
          type: number
          format: double
        alarm_low:
          description: The alarm low threshold for temperature in degrees Celsius.
          type: number
          format: double
        warn_high:
          description: The warn high threshold for temperature in degrees Celsius.
          type: number
          format: double
        warn_low:
          description: The warn low threshold for temperature in degrees Celsius.
          type: number
          format: double
    NetworkInterfacePingResponse:
      type: object
      properties:
        items:
          description: A list of network ping run result.
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterfacePing'
    NetworkInterfaceNeighborResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterfaceNeighbor'
    _builtIn:
      type: object
      properties:
        id:
          description: 'A non-modifiable, globally unique ID chosen by the system.

            '
          type: string
          readOnly: true
        name:
          description: Name of the object (e.g., a file system or snapshot).
          type: string
          readOnly: true
    Error:
      type: object
      properties:
        errors:
          description: The list of errors encountered.
          type: array
          items:
            $ref: '#/components/schemas/_errorErrors'
    NetworkInterfacesConnectorsGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/NetworkInterfacesConnectorsResponse'
    _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
    NetworkInterfaceGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/NetworkInterfaceResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    _networkInterfacePortDetailsStaticTxPowerThresholds:
      description: 'The alarm low, warn low, warn high, alarm high thresholds for Tx output power in mW.

        '
      type: object
      properties:
        alarm_high:
          description: The alarm high threshold for Tx output power in mW.
          type: number
          format: double
        alarm_low:
          description: The alarm low threshold for Tx output power in mW.
          type: number
          format: double
        warn_high:
          description: The warn high threshold for Tx output power in mW.
          type: number
          format: double
        warn_low:
          description: The warn low threshold for Tx output power in mW.
          type: number
          format: double
    NetworkConnectionStatisticsGetResponse:
      allOf:
      - $ref: '#/components/schemas/NetworkConnectionStatisticsResponse'
    NetworkInterfaceGetResponse_2:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/NetworkInterfaceResponse_2'
    _networkInterfacePortDetailsStaticRxPowerThresholds:
      description: 'The alarm low, warn low, warn high, alarm high thresholds for Rx input power in mW.

        '
      type: object
      properties:
        alarm_high:
          description: The alarm high threshold for Rx input power in mW.
          type: number
          format: double
        alarm_low:
          description: The alarm low threshold for Rx input power in mW.
          type: number
          format: double
        warn_high:
          description: The warn high threshold for Rx input power in mW.
          type: number
          format: double
        warn_low:
          description: The warn low threshold for Rx input power in mW.
          type: number
          format: double
    _networkInterfacePortDetailsRx_los:
      type: object
      properties:
        channel:
          description: 'The channel number if the transceiver is a multilane transceiver.

            If not specified, defaults to `null`.

            '
          type: integer
          example: 0
        flag:
          description: A value of `true` indicates Rx Loss-of-Signal.
          type: boolean
    _networkInterfacePortDetailsVoltage:
      type: object
      properties:
        channel:
          description: 'The channel number if the diagnostic has an associated channel number.

            If not specified, defaults to `null`.

            '
          type: integer
          example: 0
        measurement:
          description: 'Supply voltage in volts.

            '
          type: number
          format: double
        status:
          description: 'Indicates whether the measurement is outside the high alarm, low alarm, high warning,

            or low warning thresholds for supply voltage.

            Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`.

            '
          type: string
          example: ok
    NetworkInterfacesConnectorsSettingsGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - type: object
        properties:
          items:
            description: A list of global network settings for network connectors.
            type: array
            items:
              $ref: '#/components/schemas/NetworkInterfacesConnectorsSetting'
    _builtInResourceNoId:
      description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support

        settings). Some correspond to a piece of software, like an app, or hardware,

        like a controller. Others are created by the system in response to some event

        (e.g., alerts, audit records).


        Typically, a user can''t create, delete or rename a built-in resource. A few

        can be created or deleted, but not renamed because the names are meaningful

        to Purity (e.g., VIFs, file systems, file system snapshots, volume snapshot).

        '
      type: object
      properties:
        name:
          description: 'A locally unique, system-generated name. The name cannot be modified.

            '
          type: string
          readOnly: true
    NetworkInterfacesConnectorsSettingRocePfc:
      description: 'Default PFC(Priority Flow Control) configuration for network connectors.

        '
      allOf:
      - type: object
        properties:
          port_buffer:
            description: 'The buffer size in bytes reserved to absorb in-flight packets after XOFF threshold

              is reached.

              '
            type: integer
            format: int32
            readOnly: true
          xoff_threshold:
            description: 'The PFC XOFF threshold value in bytes. When the buffer for a particular traffic class

              reaches this threshold, the pause frame(XOFF) will be transimitted to the sender,

              requesting it to stop sending packets for that class.

              '
            type: integer
            format: int32
            readOnly: true
          xon_threshold:
            description: 'The PFC XON threshold value in bytes. When the buffer for a particular traffic class

              drops below this threshold, the un-pause frame(XON) will be transmitted to the sender,

              requesting it to resume sending packets for that class.

              '
            type: integer
            format: int32
            readOnly: true
    NetworkInterfacesConnectorsSettingRoceEcn:
      description: 'Default ECN(Explicit Network Notification) configuration for network connectors.

        '
      allOf:
      - type: object
        properties:
          marking_probability:
            description: 'The ECN marking probability when min ECN marked threshold is reached.

              '
            type: number
            format: float
            readOnly: true
          max_ecn_marked_threshold:
            description: 'The maximum threshold value in bytes at which the packets start being marked with ECN

              at the highest probability or dropped.

              '
            type: integer
            format: int32
            readOnly: true
          min_ecn_marked_threshold:
            description: 'The minimum threshold value in bytes at which th

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