XSKY network-interfaces API

NetworkInterfaceController Network Interface Management

Operations 3

GET /network-interfaces/ #
GET /network-interfaces/{network_interface_id} #
GET /network-interfaces/{network_interface_id}/samples #

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/xsky-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.

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

OpenAPI Specification

xsky-network-interfaces-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: XMS is the controller of distributed storage system
  version: SDS_4.2.000.0.200302
  title: XMS access-paths Network Interfaces API
  contact: {}
  license:
    name: Commercial
servers:
- url: /v1
tags:
- name: network-interfaces
  description: 'NetworkInterfaceController Network Interface Management

    '
paths:
  /network-interfaces/:
    get:
      tags:
      - network-interfaces
      description: List network interfaces
      operationId: ListNetworkInterfaces
      parameters:
      - name: limit
        in: query
        description: paging param
        required: false
        x-exportParamName: Limit
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: paging param
        required: false
        x-exportParamName: Offset
        schema:
          type: integer
          format: int64
      - name: master_network_interface_id
        in: query
        description: master network interface id
        required: false
        x-exportParamName: MasterNetworkInterfaceId
        schema:
          type: integer
          format: int64
      - name: host_id
        in: query
        description: host id
        required: false
        x-exportParamName: HostId
        schema:
          type: integer
          format: int64
      - name: role
        in: query
        description: network interface role
        required: false
        x-exportParamName: Role
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacesResp'
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
  /network-interfaces/{network_interface_id}:
    get:
      tags:
      - network-interfaces
      description: Get a network interface
      operationId: GetNetworkInterface
      parameters:
      - name: network_interface_id
        in: path
        description: network interface id
        required: true
        x-exportParamName: NetworkInterfaceId
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceResp'
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInHeader: []
      - tokenInQuery: []
  /network-interfaces/{network_interface_id}/samples:
    get:
      tags:
      - network-interfaces
      description: get a network interface's Samples
      operationId: GetNetworkInterfaceSamples
      parameters:
      - name: network_interface_id
        in: path
        description: network interface id
        required: true
        x-exportParamName: NetworkInterfaceId
        schema:
          type: integer
          format: int64
      - name: duration_begin
        in: query
        description: duration begin timestamp
        required: false
        x-exportParamName: DurationBegin
        schema:
          type: string
      - name: duration_end
        in: query
        description: duration end timestamp
        required: false
        x-exportParamName: DurationEnd
        schema:
          type: string
      - name: period
        in: query
        description: samples period
        required: false
        x-exportParamName: Period
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceSamplesResp'
        400:
          description: BadRequest
        404:
          description: NotFound
        500:
          description: InternalServerError
      security:
      - tokenInQuery: []
      - tokenInHeader: []
components:
  schemas:
    NetworkInterface_Nestview:
      type: object
      properties:
        id:
          type: integer
          format: int64
        mac_address:
          type: string
        name:
          type: string
      title: NetworkInterface_Nestview
      example:
        mac_address: mac_address
        name: name
        id: 1
    NetworkInterfaceResp:
      type: object
      properties:
        network_interface:
          description: network interface record
          $ref: '#/components/schemas/NetworkInterfaceRecord'
      title: NetworkInterfaceResp
      example:
        network_interface: ''
    NetworkInterface:
      type: object
      properties:
        bonding_mode:
          type: string
        create:
          type: string
          format: date-time
        host:
          $ref: '#/components/schemas/Host_Nestview'
        id:
          type: integer
          format: int64
        link_detected:
          type: boolean
        mac_address:
          type: string
        master_network_interface:
          $ref: '#/components/schemas/NetworkInterface_Nestview'
        megabits:
          type: integer
          format: int64
        name:
          type: string
        operstate:
          type: string
        type:
          type: string
          description: ethernet or bond
        update:
          type: string
          format: date-time
      title: NetworkInterface
      description: NetworkInterface defines model of network interface @grpc-models-proto
    NetworkInterfaceSamplesResp:
      type: object
      properties:
        network_interface_samples:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterfaceStat'
      title: NetworkInterfaceSamplesResp
      example:
        network_interface_samples:
        - tx_pps: 2.027123023002322
          tx_bandwidth_kbyte: 7.061401241503109
          error_pps: 6.027456183070403
          rx_bandwidth_kbyte: 1.4658129805029452
          create: '2000-01-23T04:56:07.000+00:00'
          rx_drop_pps: 5.962133916683182
          rx_error_pps: 5.637376656633329
          rx_pps: 2.3021358869347655
          tx_error_pps: 3.616076749251911
          drop_pps: 0.8008281904610115
          tx_drop_pps: 9.301444243932576
        - tx_pps: 2.027123023002322
          tx_bandwidth_kbyte: 7.061401241503109
          error_pps: 6.027456183070403
          rx_bandwidth_kbyte: 1.4658129805029452
          create: '2000-01-23T04:56:07.000+00:00'
          rx_drop_pps: 5.962133916683182
          rx_error_pps: 5.637376656633329
          rx_pps: 2.3021358869347655
          tx_error_pps: 3.616076749251911
          drop_pps: 0.8008281904610115
          tx_drop_pps: 9.301444243932576
    NetworkInterfaceStat:
      type: object
      properties:
        create:
          type: string
          format: date-time
        drop_pps:
          type: number
          format: double
        error_pps:
          type: number
          format: double
        rx_bandwidth_kbyte:
          type: number
          format: double
        rx_drop_pps:
          type: number
          format: double
        rx_error_pps:
          type: number
          format: double
        rx_pps:
          type: number
          format: double
        tx_bandwidth_kbyte:
          type: number
          format: double
        tx_drop_pps:
          type: number
          format: double
        tx_error_pps:
          type: number
          format: double
        tx_pps:
          type: number
          format: double
      title: NetworkInterfaceStat
      description: NetworkInterfaceStat define the statistics of network interface
      example:
        tx_pps: 2.027123023002322
        tx_bandwidth_kbyte: 7.061401241503109
        error_pps: 6.027456183070403
        rx_bandwidth_kbyte: 1.4658129805029452
        create: '2000-01-23T04:56:07.000+00:00'
        rx_drop_pps: 5.962133916683182
        rx_error_pps: 5.637376656633329
        rx_pps: 2.3021358869347655
        tx_error_pps: 3.616076749251911
        drop_pps: 0.8008281904610115
        tx_drop_pps: 9.301444243932576
    NetworkInterfacesResp:
      type: object
      properties:
        network_interfaces:
          type: array
          description: network interface records
          items:
            $ref: '#/components/schemas/NetworkInterfaceRecord'
      title: NetworkInterfacesResp
      example:
        network_interfaces:
        - ''
        - ''
    Host_Nestview:
      type: object
      required:
      - admin_ip
      properties:
        admin_ip:
          type: string
        id:
          type: integer
          format: int64
        name:
          type: string
      title: Host_Nestview
      example:
        name: name
        admin_ip: admin_ip
        id: 0
    NetworkInterfaceRecord:
      title: NetworkInterfaceRecord
      allOf:
      - $ref: '#/components/schemas/NetworkInterface'
      - properties:
          samples:
            type: array
            items:
              $ref: '#/components/schemas/NetworkInterfaceStat'
      description: 'NetworkInterfaceRecord combine NetworkInterface and NetworkInterfaceStat as API

        response'
  securitySchemes:
    tokenInHeader:
      description: auth by token
      type: apiKey
      name: Xms-Auth-Token
      in: header
    tokenInQuery:
      description: auth by token
      type: apiKey
      name: token
      in: query