Pure Storage Hardware Connectors API

openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Hardware Connectors 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: Hardware Connectors
  description: 'The endpoints are deprecated. Use the endpoints under Network Interfaces instead.

    Manages the port connector attributes on the array. Lane speeds

    and port count attributes can be configured.

    '
paths:
  /api/2.26/hardware-connectors:
    get:
      tags:
      - Hardware Connectors
      summary: Pure Storage GET Hardware-connectors
      description: 'The endpoint is deprecated. Use the `/network-interfaces/connectors` endpoint instead.

        List array connection 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'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HardwareConnectorGetResponse'
    patch:
      tags:
      - Hardware Connectors
      summary: Pure Storage PATCH Hardware-connectors
      description: 'The endpoint is deprecated. Use the `/network-interfaces/connectors` endpoint instead.

        Modify array connection 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: hardware-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/HardwareConnectorResponse'
      x-codegen-request-body-name: hardware-connector
  /api/2.26/hardware-connectors/performance:
    get:
      tags:
      - Hardware Connectors
      summary: Pure Storage GET Hardware-connectors/performance
      description: 'The endpoint is deprecated. Use the `/network-interfaces/connectors/performance`

        endpoint instead.

        Displays network statistics, historical bandwidth, and error reporting for

        all specified hardware 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'
      - $ref: '#/components/parameters/Resolution'
      - $ref: '#/components/parameters/Sort'
      - $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/HardwareConnectorPerformanceGetResponse'
  /api/1.5/hardware-connectors:
    get:
      tags:
      - Hardware Connectors
      summary: Pure Storage Get Hardware Connectors
      description: 'Retrieves information about FlashBlade hardware connectors.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token_2'
      - $ref: '#/components/parameters/Filter_2'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Limit_2'
      - $ref: '#/components/parameters/Names_2'
      - $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
            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/HardwareConnectorGetResponse'
        '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:
  responses:
    Error404:
      description: NOT FOUND
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

            '
          schema:
            type: object
        X-RateLimit-Remaining-second:
          description: 'The number of requests remaining for the organization in that second.

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error500:
      description: INTERNAL SERVER ERROR
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

            '
          schema:
            type: object
        X-RateLimit-Remaining-second:
          description: 'The number of requests remaining for the organization in that second.

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error403:
      description: FORBIDDEN
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorNoContext'
    Error400:
      description: BAD REQUEST
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

            '
          schema:
            type: object
        X-RateLimit-Remaining-second:
          description: 'The number of requests remaining for the organization in that second.

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error429:
      description: TOO MANY REQUESTS
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

            '
          schema:
            type: object
        X-RateLimit-Remaining-second:
          description: 'The number of requests remaining for the organization in that second.

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorNoContext'
  parameters:
    Total_only:
      name: total_only
      in: query
      description: 'If set to `true`, returns the aggregate value of all items after filtering.

        Where it makes more sense, the average value is displayed instead.

        The values are displayed for each name where meaningful.

        If `total_only=true`, the `items` list will be empty.

        '
      schema:
        type: boolean
    Resolution:
      name: resolution
      in: query
      description: 'The desired ms between samples. Available resolutions may

        depend on data type, `start_time` and `end_time`.

        In general `1000`, `30000`, `300000`, `1800000`, `7200000`, and

        `86400000` are possible values.

        '
      schema:
        type: integer
        format: int64
        minimum: 0
      example: 30000
    Filter:
      name: filter
      in: query
      description: 'Narrows down the results to only the response objects

        that satisfy the filter criteria.

        '
      schema:
        type: string
    Offset:
      name: offset
      in: query
      description: 'The offset of the first resource to return from a collection.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Start_time:
      name: start_time
      in: query
      description: 'When the time window starts (in milliseconds since epoch).

        '
      schema:
        type: integer
        format: int64
        minimum: 0
      example: 1514764800000
    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 query has reached its last page when the response does not include a token.

        Pagination requires the `limit` and `continuation_token`

        query parameters.

        '
      schema:
        type: string
    Offset_2:
      name: offset
      in: query
      description: 'The offset of the first resource to return from a collection.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
    Names_2:
      name: names
      in: query
      description: 'A comma-separated list of resource names.

        If there is not at least one resource that matches each `name` element,

        an error is returned.

        Single quotes are required around all strings.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
        x-quoted: true
      x-quoted: true
    XRequestId:
      name: X-Request-ID
      in: header
      description: 'Supplied by client during request or generated by server.

        '
      schema:
        type: string
    Continuation_token_2:
      name: continuation_token
      in: query
      description: 'An opaque token used to iterate over a collection.

        The token to use on the next request is returned in the

        `continuation_token` field of the result.

        Single quotes are required around all strings.

        '
      schema:
        type: string
        x-quoted: true
      x-quoted: true
    Limit_2:
      name: limit
      in: query
      description: 'Limit the size of the response to the specified number of resources.

        A limit of 0 can be used to get the number of resources without getting

        all of the resources. It will be returned in the total_item_count field.

        If a client asks for a page size larger than the maximum number, the request

        is still valid. In that case the server just returns the maximum number of

        items, disregarding the client''s page size request. If not specified, defaults

        to 1000.

        '
      schema:
        type: integer
        format: int32
    Limit:
      name: limit
      in: query
      description: 'Limits the size of the response to the specified number of objects on each page.

        To return the total number of resources, set `limit=0`.

        The total number of resources is returned as a `total_item_count` value.

        If the page size requested is larger than the system maximum limit,

        the server returns the maximum limit, disregarding the requested page size.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Authorization:
      name: Authorization
      in: header
      description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`)

        '
      schema:
        type: string
    Names:
      name: names
      in: query
      description: 'Performs the operation on the unique names specified.

        Enter multiple names in comma-separated format.

        For example, `name01,name02`.


        If there is not at least one resource that matches

        each of the elements of `names`, then an error is returned,

        except when creating new resources.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Sort_2:
      name: sort
      in: query
      description: 'Sort the response by the specified fields (in descending order if ''-''

        is appended to the field name).

        If you provide a sort you will not get a continuation token in

        the response.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          pattern: ^[a-z]+(_[a-z]+)*-?
          type: string
    Ids:
      name: ids
      in: query
      description: 'A comma-separated list of resource IDs.

        If after filtering, there is not at least one resource that matches

        each of the elements of `ids`, then an error is returned.

        This cannot be provided together with the `name` or `names` query parameters.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    End_time:
      name: end_time
      in: query
      description: 'When the time window ends (in milliseconds since epoch).

        '
      schema:
        type: integer
        format: int64
        minimum: 0
      example: 1514764800000
    Ids_2:
      name: ids
      in: query
      description: 'A comma-separated list of resource IDs.

        If there is not at least one resource that matches each `id` element,

        an error is returned.

        Single quotes are required around all strings.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
        x-quoted: true
      x-quoted: true
    Filter_2:
      name: filter
      in: query
      description: 'Exclude resources that don''t match the specified criteria.

        Single quotes are required around all strings inside the filters.

        '
      schema:
        type: string
    Sort:
      name: sort
      in: query
      description: 'Sort the response by the specified fields (in descending order if ''-''

        is appended to the field name).

        NOTE: If you provide a sort you will not get a `continuation_token` in

        the response.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          pattern: ^[a-z]+(_[a-z]+)*-?
          type: string
  schemas:
    HardwareConnector:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - type: object
        properties:
          connector_type:
            description: 'Form-factor of the interface.

              Valid values include QSFP, QSFP+, QSFP28, QSFP56, QSFP-DD, RJ-45, and -.

              '
            type: string
            readOnly: true
            example: QSFP
          lane_speed:
            description: 'Configured speed of each lane in the connector in bits-per-second.

              '
            type: integer
            format: int64
            example: 10000000000
          lanes_per_port:
            description: Configured number of lanes comprising each port in the connector.
            type: integer
            format: int64
            example: 4
          port_count:
            description: 'Configured number of ports in the connector (1/2/4 for QSFP).

              '
            type: integer
            format: int64
            example: 1
          port_speed:
            description: Configured speed of each port in the connector in bits-per-second.
            type: integer
            format: int64
            example: 40000000000
          transceiver_type:
            description: 'Details about the transceiver which is plugged into the connector port.

              Transceiver type will be read-only for pureuser. If nothing is plugged

              into QSFP port, value will be `Unused` and type cannot be auto-detected,

              and internal user has not specified a type - value will be `Unknown`.

              If transceiver is plugged in, and type is auto-detected, and/or type

              has been explicitly set by internal user - that value will be shown.

              Transceiver type is not applicable for RJ-45 connectors.

              '
            type: string
            readOnly: true
            example: 40GBASE-LR4
    HardwareConnectorResponse:
      type: object
      properties:
        items:
          description: A list of connector objects.
          type: array
          items:
            $ref: '#/components/schemas/HardwareConnector'
    HardwareConnectorGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/HardwareConnectorResponse'
    Error:
      type: object
      properties:
        errors:
          description: The list of errors encountered.
          type: array
          items:
            $ref: '#/components/schemas/_errorErrors'
    ErrorNoContext:
      type: object
      properties:
        message:
          type: string
          example: Something was wrong
    _errorErrors:
      type: object
      properties:
        context:
          type: string
          example: Error with ...
        message:
          type: string
          example: Something was wrong
    _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
    HardwareConnectorPerformanceGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - type: object
        properties:
          items:
            description: A list of hardware connector performance objects.
            type: array
            items:
              $ref: '#/components/schemas/HardwareConnectorPerformance'
          total:
            description: 'Total of all records after filtering.

              If `total_only` query param is `true`, then no individual items will be returned.

              '
            type: array
            items:
              $ref: '#/components/schemas/HardwareConnectorPerformance'
    _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
    HardwareConnectorPerformance:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - type: object
        properties:
          link_aggregation_group:
            description: The link aggregation group which this entity belongs to.
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
          other_errors_per_sec:
            description: 'The sum of unspecified reception and transmission errors per second.

              '
            type: integer
            format: int64
            minimum: 0
            readOnly: true
          received_bytes_per_sec:
            description: 'Bytes received per second.

              '
            type: integer
            format: int64
            minimum: 0
            readOnly: true
          received_crc_errors_per_sec:
            description: 'Reception CRC errors per second.

              '
            type: integer
            format: int64
            minimum: 0
            readOnly: true
          received_frame_errors_per_sec:
            description: 'Received packet frame errors per second.

              '
            type: integer
            format: int64
            minimum: 0
            readOnly: true
          received_packets_per_sec:
            description: 'Packets received per second.

              '
            type: integer
            format: int64
            minimum: 0
            readOnly: true
          time:
            description: 'Sample time in milliseconds since UNIX epoch.

              '
            type: integer
            format: int64
            readOnly: true
          total_errors_per_sec:
            description: 'The sum of all reception and transmission errors per second.

              '
            type: integer
            format: int64
            minimum: 0
            readOnly: true
          transmitted_bytes_per_sec:
            description: 'Bytes transmitted per second.

              '
            type: integer
            format: int64
            minimum: 0
            readOnly: true
          transmitted_carrier_errors_per_sec:
            description: 'Transmission carrier errors per second.

              '
            type: integer
            format: int64
            minimum: 0
            readOnly: true
          transmitted_dropped_errors_per_sec:
            description: 'Transmitted packets dropped per second.

              '
            type: integer
            format: int64
            minimum: 0
            readOnly: true
          transmitted_packets_per_sec:
            description: 'Packets transmitted per second.

              '
            type: integer
            format: int64
            minimum: 0
            readOnly: true
        x-readOnly: true
    _fixedReference:
      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
    PageInfo:
      type: object
      properties:
        continuation_token:
          description: 'Continuation token that can be provided in the `continuation_token` query

            param to get the next page of data.

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

            are guaranteed to get all items exactly once regardless of

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

            the pagination then it may or may not be returned.

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

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

            (no sort is specified).

            '
          type: string
        total_item_count:
          description: Total number of items after applying `filter` params.
          type: integer
          format: int32