---
title: "Onboard Devices"
method: POST
path: "/devices/:onboard"
tags: ["Device"]
---

# Onboard Devices

`POST /devices/:onboard`

Onboard devices for all devices, such as Extreme/Aerohive, EXOS, VOSS, WiNG, Dell, and Digital Twin.
This is asynchronized operation to support massive device onboarding.

## Request body

- XiqOnboardDeviceRequest — The payload to onboard devices
  - `extreme` XiqExtremeDevices — Extreme/Aerohive devices to onboard
    - `sns` string[], required — The serial numbers
  - `exos` XiqExosDevices — ExtremeXOS (EXOS) devices to onboard
    - `sns` string[], required — The serial numbers
  - `voss` XiqVossDevices — VSP Operating System Software (VOSS) devices to onboard
    - `sns` string[], required — The serial numbers
  - `wing` XiqWingDevices — ExtremeWireless (WiNG) devices to onboard
    - `sn_to_mac` object, required — Serial number -> MAC address
  - `dell` XiqDellDevices — Dell devices to onboard
    - `sn_to_st` object, required — Serial number -> Service tag
  - `dt` XiqDigitalTwinDevices — Digital Twin devices to onboard
    - `dts` XiqDigitalTwinDevice[] — The Digital Twin devices to onboard.
      - `make` 'SWITCH_ENGINE' | 'FABRIC_ENGINE', required — The Digital Twin device make.
      - `model` 'DT_5320_16P_4XE' | 'DT_5320_16P_4XE_DC' | 'DT_5320_24P_8XE' | 'DT_5320_24T_8XE' | 'DT_5320_48P_8XE' | 'DT_5320_48T_8XE' | 'DT_5420F_16MW_32P_4XE' | 'DT_5420F_16W_32P_4XE' | 'DT_5420F_24P_4XE' | 'DT_5420F_24S_4XE' | 'DT_5420F_24T_4XE' | 'DT_5420F_48P_4XE' | 'DT_5420F_48P_4XL' | 'DT_5420F_48T_4XE' | 'DT_5420F_8W_16P_4XE' | 'DT_5420M_16MW_32P_4YE' | 'DT_5420M_24T_4YE' | 'DT_5420M_24W_4YE' | 'DT_5420M_48T_4YE' | 'DT_5420M_48W_4YE' | 'DT_5520_12MW_36W' | 'DT_5520_24T' | 'DT_5520_24W' | 'DT_5520_24X' | 'DT_5520_48SE' | 'DT_5520_48T' | 'DT_5520_48W' | 'DT_5520_24T_ACDC' | 'DT_5520_48T_ACDC' | 'DT_5520_24X_ACDC' | 'DT_5520_48SE_ACDC' | 'DT_5720_24MW' | 'DT_5720_24MXW' | 'DT_5720_48MW' | 'DT_5720_48MXW' | 'DT_7520_48YE_8CE' | 'DT_7520_48XT_6C' | 'DT_7520_48Y_8C' | 'DT_7720_32C', required — The Digital Twin device model.
      - `os_type` string — The Digital Twin device OS type.
      - `os_version` string, required — The Digital Twin device OS version.
      - `vim_modules` XiqDigitalTwinVimModule[] — The Digital Twin VIM modules.
      - `feat_licenses` XiqDigitalTwinFeatLicense[] — The Digital Twin feature licenses.

## Response `200`

OK

- XiqOnboardDeviceResponse — The response for onboard devices
  - `success_devices` XiqSuccessOnboardDevice[] — The success devices
    - `serial_number` string, required — The serial number
    - `device_id` integer, required — The device ID
  - `failure_devices` XiqFailureOnboardDevice[] — The failure devices
    - `serial_number` string, required — The serial number
    - `error` 'UNKNOWN' | 'SUCCEED' | 'EXIST_IN_REDIRECT' | 'FAILED_IN_DB' | 'FAILED_STORE_IN_REDIRECT' | 'SN_IS_NOT_RIGHT' | 'PRODUCT_TYPE_NOT_EXIST' | 'REACH_MAX_SIZE' | 'NOT_SUPPORT_DEVICE' | 'SN_EXISTED_IN_HM' | 'DEVICE_EXISTED' | 'NETMASK_IP_NOT_NULL' | 'BRANCH_ID_USED' | 'INVALID_SERVICE_TAG' | 'RADIO_WIFI1_NOT_SUPPORT' | 'RADIO_PROFILE_NOT_EXIST' | 'SDR_PROFILE_NOT_EXIST' | 'ADMIN_STATE_NOT_SUPPORT' | 'WIFI_POWER_NOT_SUPPORT' | 'OPERATION_MODE_NOT_SUPPORT' | 'COUNTRY_CODE_NOT_SUPPORT' | 'WIFI0_CHANNEL_NOT_SUPPORT' | 'WIFI1_CHANNEL_NOT_SUPPORT' | 'COUNTRY_CODE_IS_NEEDED' | 'MAC_ADDR_REQUIRED' | 'WING_AP_INVALID_ONBOARDING_DATA' | 'NOT_DUAL_BOOT_AP' | 'INVALID_CSV_LOCATION' | 'NOT_SUPPORTED_FOR_CONNECT' | 'DEVICE_EXISTED_ANOTHER_ACCOUNT' | 'FAILED_IN_DTIS_SERVICE' | 'FAILED_IN_DTIS_MAX_CONCURRENT_LIMIT_REACHED' | 'FAILED_DTINSTANCE_ALREADY_ASSOCIATED' | 'FAILED_IN_DTIS_MAX_OVERALL_LIMIT_REACHED' | 'FAILED_IN_DTIS_MAX_LICENSE_LIMIT_REACHED' | 'FAILED_DTINSTANCE_RELAUNCHED_RECENTLY' | 'FAILED_COPILOT_DISABLED' | 'FAILED_IN_DTIS_MAX_CONCURRENT_LIMIT_REACHED_BY_BATCH' | 'FAILED_IN_DTIS_MAX_OVERALL_LIMIT_REACHED_BY_BATCH' | 'REACH_MAX_CAP' | 'NETWORK_POLICY_NOT_FOUND' | 'VERSION_NOT_SUPPORTED' | 'VERSION_DEPRECATED' — The onboard error code

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)