# System and Platform

#### **Configure ZTP**

| Request URL   | /api/config/ztp                                                                                                                  |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Description   | Configure ZTP enable or disable on the system                                                                                    |
| Method        | POST                                                                                                                             |
| Request Body  | {"ztp\_status": "enable \| disable"}                                                                                             |
| Response Body | NA                                                                                                                               |
| Status Code   | <ul><li>OK(200) if the request completes successfully</li><li>SERVER\_ERROR(500) if there is any error with the server</li></ul> |

#### **Reboot the device**

| Request URL   | /api/config/reboot                                                                                                               |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Description   | API to reboot the system                                                                                                         |
| Method        | POST and PUT                                                                                                                     |
| Request Body  | {"reboot": "yes"}                                                                                                                |
| Response Body | NA                                                                                                                               |
| Status Code   | <ul><li>OK(200) if the request completes successfully</li><li>SERVER\_ERROR(500) if there is any error with the server</li></ul> |

#### **Firmware upgrade**

| Request URL   | /api/config/system                                                                                                                                                                                    |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Description   | API to upgrade the firmware os                                                                                                                                                                        |
| Method        | POST                                                                                                                                                                                                  |
| Request Body  | <p>{</p><p>"action": “firmware-upgrade”</p><p>"protocol":“scp”</p><p>"serverip":"server ip address",</p><p>"firmware\_file":"file name with path",</p><p>"username":"",</p><p>"passwd":"”</p><p>}</p> |
| Response Body | NA                                                                                                                                                                                                    |
| Status Code   | <ul><li>CREATED(201) if the action was completed successfully</li><li>BAD\_REQUEST(400) if the request is invalid</li><li>SERVER\_ERROR(500) if there is any error with the server</li></ul>          |

#### **Set Startup Configuration**

<table data-header-hidden><thead><tr><th></th><th></th><th data-hidden></th></tr></thead><tbody><tr><td>Request URL</td><td>/api/config/system</td><td></td></tr><tr><td>Description</td><td>Apply configuration</td><td></td></tr><tr><td>Method</td><td>POST</td><td></td></tr><tr><td>Request Body</td><td><p>{</p><p>"action": "config_save" or “config_upload”</p><p>"protocol":"tftp" or “scp” or “http”,</p><p>"serverip":"",</p><p>"config_file":"",</p><p>"username":"",</p><p>"passwd":"”<br><br>}</p><ul><li>"config_save" - save running configuration to bootup configuration file</li><li>"upload" Upload file from a server to the startup configuration block and param</li><li>Default action is “config_save”</li></ul></td><td><p></p><p>"action": "config_save" or “config_upload”</p><p>"protocol":"tftp" or “scp” or “http”,</p><p>"serverip":"",</p><p>"config_file":"",</p><p>"username":"",</p><p>"passwd":"”</p></td></tr><tr><td>Response Body</td><td>NA</td><td></td></tr><tr><td>Status Code</td><td><p></p><ul><li>CREATED(201) if the action was completed successfully</li><li>BAD_REQUEST(400) if the request is invalid</li><li>SERVER_ERROR(500) if there is any error with the server</li></ul></td><td>CREATED(201) if the action was completed successfully</td></tr></tbody></table>

#### **Get Startup or running Configuration**

| Request URL   | <p>/api/config/system?cfgblk=\<cfgblk>'</p><p>\<cfgblk>: Configuration blocks. Valid values are "running" and "bootup"</p><p>Running – Read and build from database</p><p>Bootup – config\_db.json</p> |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Description   | Get system configuration                                                                                                                                                                               |
| Method        | GET                                                                                                                                                                                                    |
| Request Body  | NA                                                                                                                                                                                                     |
| Response Body | JSON format                                                                                                                                                                                            |
| Status Code   | <ul><li>OK(200) if the request completes successfully</li><li>SERVER\_ERROR(500) if there is any error with the server</li></ul>                                                                       |

#### **Get Device Information**

| **Request URL**   | /api/info/devices                                                                                                                                                                    |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Description**   | Use this API to get the detailed device information                                                                                                                                  |
| **Method**        | GET                                                                                                                                                                                  |
| **Request Body**  | NA                                                                                                                                                                                   |
| **Response Body** | <p>{</p><p>"mac": "1c:34:da:36:f7:80",</p><p>"hwsku": "ACS-MSN2100",</p><p>"type": "LeafRouter",</p><p>"hostname": "sonic",</p><p>"platform": "x86\_64-mlnx\_msn2100-r0"</p><p>}</p> |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul>                                                     |

#### **Get Platform Environment Information**

| **Request URL**   | /api/info/devenvs                                                                                                                                                                                                                                                                                                                                            |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Description**   | This API is used to retrieve the dev environment information                                                                                                                                                                                                                                                                                                 |
| **Method**        | GET                                                                                                                                                                                                                                                                                                                                                          |
| **Request Body**  | NA                                                                                                                                                                                                                                                                                                                                                           |
| **Response Body** | <p>{</p><p>"Temperature": {</p><p>"Ambient": {},</p><p>"CPU": {</p><p>"Core1": 19.0,</p><p>"Core0": 19.0,</p><p>"Core3": 21.0,</p>                                                                                                                                                                                                                           |
|                   | <p>"Core2": 21.0</p><p>}</p><p>},</p><p>"Platform": {</p><p>"ASIC": "mellanox",</p><p>"SONIC\_KERNEL\_VERSION": "4.9.0-14-2-amd64",</p><p>"Platform": "x86\_64-mlnx\_msn2100-r0",</p><p>"HwSKU": "ACS-MSN2100",</p><p>"SONIC\_DEBIAN\_VERSION": "9.13",</p><p>"SONIC\_VERSION": "SONiC.master.0-dirty-20210401.133254"</p><p>},</p><p>"Fans": {}</p><p>}</p> |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul>                                                                                                                                                                                                                             |

#### **Get Reboot Cause**

| **Request URL**   | /api/info/reboot-cause                                                                                                           |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Description**   | Use the above API to get the last reboot-cause of he system                                                                      |
| **Method**        | GET                                                                                                                              |
| **Request Body**  | NA                                                                                                                               |
| **Response Body** | <p>{</p><p>"reboot-cause": "\rUser issued 'reboot' command \[User: admin, Time: Thu Apr 8 10:47:12 UTC 2021]\r\n\r"</p><p>}</p>  |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul> |

#### **Get ZTP status**

| **Request URL**   | /api/info/ztp-status                                                                                                             |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Description**   | Get the ZTP-status of the system using this API                                                                                  |
| **Method**        | GET                                                                                                                              |
| **Request Body**  | NA                                                                                                                               |
| **Response Body** | <p>{</p><p>"ztp-status": "disabled"</p><p>}</p>                                                                                  |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul> |

#### **Get System Uptime**

| **Request URL**   | /api/info/sysuptime                                                                                                              |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Description**   | Use this GET-API to get the uptime of the system                                                                                 |
| **Method**        | GET/                                                                                                                             |
| **Request Body**  | NA                                                                                                                               |
| **Response Body** | <p>{</p><p>"uptime": "up 35 minutes"</p><p>}</p>                                                                                 |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul> |

#### **Get System Clock information**

| **Request URL**   | /api/info/clock                                                                                                                  |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Description**   | Use this GET-API to get the clock information of the system                                                                      |
| **Method**        | GET                                                                                                                              |
| **Request Body**  | NA                                                                                                                               |
| **Response Body** | <p>{</p><p>"uptime": "\rThuApr 8 12:08:52 UTC 2021\r\n\r"</p><p>}</p>                                                            |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul> |

#### **Get System Boot information**

| **Request URL**   | /api/info/boot                                                                                                                                                                                                     |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Description**   | Use the above GET-API to get the system boot-information                                                                                                                                                           |
| **Method**        | GET                                                                                                                                                                                                                |
| **Request Body**  | NA                                                                                                                                                                                                                 |
| **Response Body** | <p>{</p><p>"BootInfo": "\rCurrent: SONiC-OS-master.0-dirty-20210401.133254\r\nNext: SONiC-OS-master.0-dirty-20210401.133254\r\nAvailable:</p><p>\r\nSONiC-OS-master.0-dirty-20210401.133254\r\n\r\n\r"</p><p>}</p> |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul>                                                                                   |

#### **Get SSD Health information**

| **Request URL**   | /api/info/ssdhealth                                                                                                              |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Description**   | Get SSD health information using this API                                                                                        |
| **Method**        | GET                                                                                                                              |
| **Request Body**  | NA                                                                                                                               |
| **Response Body** | <p>{</p><p>"ssdhealth": "Device Model : M.2 (S42) 3IE3\r\nHealth : 99.510%\r\nTemperature : 30C\r\n"</p><p>}</p>                 |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul> |

#### **Get Memory Utilization**

| **Request URL**   | /api/info/memutil                                                                                                                |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Description**   | Get system memory information using this API                                                                                     |
| **Method**        | GET                                                                                                                              |
| **Request Body**  | NA                                                                                                                               |
| **Response Body** | <p>{</p><p>"%MEM\_Util": "63.5"</p><p>}</p>                                                                                      |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul> |

#### **Get CPU Utilization**

| **Request URL**   | /api/info/cpuutil                                                                                                                |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Description**   | GET system CPU utilzation                                                                                                        |
| **Method**        | GET                                                                                                                              |
| **Request Body**  | NA                                                                                                                               |
| **Response Body** | <p>{</p><p>"%CPU\_Util": "11.25"</p><p>}</p>                                                                                     |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul> |

#### **Get Docker Information**

| **Request URL**   | /api/info/docker/stats                                                                                                                                                                                                                                                                                                                                                                                            |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Description**   | Get docker statistics information                                                                                                                                                                                                                                                                                                                                                                                 |
| **Method**        | GET                                                                                                                                                                                                                                                                                                                                                                                                               |
| **Request Body**  | NA                                                                                                                                                                                                                                                                                                                                                                                                                |
| **Response Body** | <p>{</p><p>"syncd": {</p><p>"CPU%": "0.04",</p><p>"NET\_OUT\_BYTES": "0",</p><p>"BLOCK\_OUT\_BYTES": "168000",</p><p>"MEM%": "0.36",</p><p>"MEM\_BYTES": "3036676096",</p><p>"MEM\_LIMIT\_BYTES": "8336531521536",</p><p>"BLOCK\_IN\_BYTES": "696000",</p><p>"NET\_IN\_BYTES": "0",</p><p>"NAME": "syncd",</p><p>"PIDS": "9"</p><p>},</p><p>"s3helper": {</p><p>"CPU%": "2.96",</p><p>"NET\_OUT\_BYTES": "0",</p> |

|                 | <p>"BLOCK\_OUT\_BYTES": "0",</p><p>"MEM%": "0.67",</p><p>"MEM\_BYTES": "556793856",</p><p>"MEM\_LIMIT\_BYTES": "8336531521536",</p><p>"BLOCK\_IN\_BYTES": "0",</p><p>"NET\_IN\_BYTES": "0",</p><p>"NAME": "s3helper",</p><p>"PIDS": "259"</p><p>},</p><p>"pmon": {</p><p>"CPU%": "1.70",</p><p>"NET\_OUT\_BYTES": "0",</p><p>"BLOCK\_OUT\_BYTES": "131000",</p><p>"MEM%": "0.91",</p><p>"MEM\_BYTES": "7554990080",</p><p>"MEM\_LIMIT\_BYTES": "8336531521536",</p><p>"BLOCK\_IN\_BYTES": "0",</p><p>"NET\_IN\_BYTES": "0",</p><p>"NAME": "pmon",</p><p>"PIDS": "12"</p><p>},</p><p>"null": {</p><p>"lastupdate": "2021-04-07 23:19:00.908929"</p><p>},</p><p>"nagr": {</p><p>"CPU%": "4.95",</p><p>"NET\_OUT\_BYTES": "0",</p><p>"BLOCK\_OUT\_BYTES": "604000000",</p><p>"MEM%": "0.96",</p><p>"MEM\_BYTES": "7973371904",</p><p>"MEM\_LIMIT\_BYTES": "8336531521536",</p><p>"BLOCK\_IN\_BYTES": "712000000",</p><p>"NET\_IN\_BYTES": "0",</p><p>"NAME": "nagr",</p><p>"PIDS": "17"</p><p>},</p><p>"snmp": {</p><p>"CPU%": "0.15",</p><p>"NET\_OUT\_BYTES": "0",</p><p>"BLOCK\_OUT\_BYTES": "983000",</p><p>"MEM%": "0.67",</p><p>"MEM\_BYTES": "5625610240",</p><p>"MEM\_LIMIT\_BYTES": "8336531521536",</p><p>"BLOCK\_IN\_BYTES": "139000",</p><p>"NET\_IN\_BYTES": "0",</p><p>"NAME": "snmp",</p><p>"PIDS": "9"</p><p>},</p><p>"database": {</p><p>"CPU%": "0.28",</p><p>"NET\_OUT\_BYTES": "0",</p><p>"BLOCK\_OUT\_BYTES": "680000",</p><p>"MEM%": "0.43",</p><p>"MEM\_BYTES": "3611295744",</p><p>"MEM\_LIMIT\_BYTES": "8336531521536",</p><p>"BLOCK\_IN\_BYTES": "331000000",</p><p>"NET\_IN\_BYTES": "0",</p><p>"NAME": "database",</p><p>"PIDS": "12"</p><p>},</p> |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|                 | <p>"swss": {</p><p>"CPU%": "0.00",</p><p>"NET\_OUT\_BYTES": "0",</p><p>"BLOCK\_OUT\_BYTES": "0",</p><p>"MEM%": "0.00",</p><p>"MEM\_BYTES": "0",</p><p>"MEM\_LIMIT\_BYTES": "0",</p><p>"BLOCK\_IN\_BYTES": "0",</p><p>"NET\_IN\_BYTES": "0",</p><p>"NAME": "swss",</p><p>"PIDS": "0"</p><p>},</p><p>"lldp": {</p><p>"CPU%": "0.05",</p><p>"NET\_OUT\_BYTES": "0",</p><p>"BLOCK\_OUT\_BYTES": "115000",</p><p>"MEM%": "0.59",</p><p>"MEM\_BYTES": "4893704192",</p><p>"MEM\_LIMIT\_BYTES": "8336531521536",</p><p>"BLOCK\_IN\_BYTES": "612000000",</p><p>"NET\_IN\_BYTES": "0",</p><p>"NAME": "lldp",</p><p>"PIDS": "11"</p><p>},</p><p>"run\_dockers": 9</p><p>}</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| **Status code** | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

#### **Get System Process Statistics**

| **Request URL**   | /api/info/process/stats                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Description**   | Use this API to retrieve the process related information from system                                                                                                                                                                                                                                                                                                                                                                                                                                |
| **Method**        | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **Request Body**  | NA                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **Response Body** | <p>{</p><p>"/usr/bin/python /usr/bin/thermalctld": {</p><p>"TIME": "00:03:57",</p><p>"UID": "0",</p><p>"CMD": "/usr/bin/python /usr/bin/thermalctld",</p><p>"%CPU": "0.1",</p><p>"PPID": "4242",</p><p>"TT": "pts/0",</p><p>"STIME": "Apr06",</p><p>"%MEM": "0.2"</p><p>},</p><p>"\[kworker/1:0H]": {</p><p>"TIME": "00:00:00",</p><p>"UID": "0",</p><p>"CMD": "\[kworker/1:0H]",</p><p>"%CPU": "0.0",</p><p>"PPID": "2",</p><p>"TT": "?",</p><p>"STIME": "Apr05",</p><p>"%MEM": "0.0"</p><p>},</p> |
|                   | <p>"\[bioset]": {</p><p>"TIME": "00:00:00",</p><p>"UID": "0",</p><p>"CMD": "\[bioset]",</p><p>"%CPU": "0.0",</p><p>"PPID": "2",</p><p>"TT": "?",</p><p>"STIME": "Apr05",</p><p>"%MEM": "0.0"</p><p>},</p><p>"/etc/sonic/iscli/iscli\_startup": {</p><p>"TIME": "00:00:00",</p><p>"UID": "0",</p><p>"CMD": "/etc/sonic/iscli/iscli\_startup",</p><p>"%CPU": "0.0",</p><p>"PPID": "1",</p><p>"TT": "?",</p><p>"STIME": "Apr05",</p><p>"%MEM": "0.0"</p><p>},</p>                                      |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul>                                                                                                                                                                                                                                                                                                                                                                    |

#### **Get System memory info**

| **Request URL**   | /api/info/sysmemory                                                                                                              |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Description**   | Use this API to retrieve the memory related information from system                                                              |
| **Method**        | GET                                                                                                                              |
| **Request Body**  | NA                                                                                                                               |
| **Response Body** | {"system\_memory": {"swap": {"total": 0}, "memory": {"total": 7}}}                                                               |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul> |

#### **Get EEPROM Status**

| **Request URL**   | /api/info/eeprom/stats                                                                                                           |                                                                                                                                 |                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                 |                                                                                                                               |                                                                                                                                 |                                                                                                                      |                                                                                                                   |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| **Description**   | Use this API to retrieve the EEPROM information from system                                                                      |                                                                                                                                 |                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                 |                                                                                                                               |                                                                                                                                 |                                                                                                                      |                                                                                                                   |
| **Method**        | GET                                                                                                                              |                                                                                                                                 |                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                 |                                                                                                                               |                                                                                                                                 |                                                                                                                      |                                                                                                                   |
| **Request Body**  | NA                                                                                                                               |                                                                                                                                 |                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                 |                                                                                                                               |                                                                                                                                 |                                                                                                                      |                                                                                                                   |
| **Response Body** | <p>{</p><p>"EEPROM\_INFO                                                                                                         | 0x24": {</p><p>"Value": "1C:34:DA:36:F7:80",</p><p>"Name": "Base MAC Address",</p><p>"Len": "6"</p><p>},</p><p>"EEPROM\_INFO    | State": {</p><p>"Initialized": "1"</p><p>},</p><p>"EEPROM\_INFO                                                 | 0xfd": {</p><p>"Value\_4": "",</p><p>"Value\_1": "",</p><p>"Len\_0": "36",</p><p>"Value\_2": "",</p><p>"Len\_2": "36",</p><p>"Name\_4": "Vendor Extension",</p><p>"Len\_1": "164",</p><p>"Name\_0": "Vendor Extension",</p><p>"Value\_0": "",</p><p>"Name\_2": "Vendor Extension",</p><p>"Name\_3": "Vendor Extension",</p><p>"Num\_vendor\_ext": "5",</p><p>"Len\_3": "36",</p><p>"Len\_4": "36",</p><p>"Value\_3": "",</p><p>"Name\_1": "Vendor Extension"</p><p>},</p><p>"EEPROM\_INFO | 0xfe": {</p><p>"Value": "0x0B12CEA5",</p><p>"Name": "CRC-32",</p><p>"Len": "4"</p><p>},</p><p>"EEPROM\_INFO     | 0x28": {</p><p>"Value": "x86\_64-mlnx\_x86-r0",</p><p>"Name": "Platform Name",</p><p>"Len": "64"</p><p>},</p><p>"EEPROM\_INFO | 0x29": {</p><p>"Value": "2019.08-5.2.0016-115200",</p><p>"Name": "ONIE Version",</p><p>"Len": "23"</p><p>},</p><p>"EEPROM\_INFO | 0x2a": {</p><p>"Value": "128",</p><p>"Name": "MAC Addresses",</p>                                                    |                                                                                                                   |
|                   | <p>"Len": "2"</p><p>},</p><p>"EEPROM\_INFO                                                                                       | 0x25": {</p><p>"Value": "12/17/2019 06:08:31",</p><p>"Name": "Manufacture Date",</p><p>"Len": "19"</p><p>},</p><p>"EEPROM\_INFO | 0x21": {</p><p>"Value": "MSN2100",</p><p>"Name": "Product Name",</p><p>"Len": "64"</p><p>},</p><p>"EEPROM\_INFO | 0x26": {</p><p>"Value": "16",</p><p>"Name": "Device Version",</p><p>"Len": "1"</p><p>},</p><p>"EEPROM\_INFO                                                                                                                                                                                                                                                                                                                                                                               | 0x2b": {</p><p>"Value": "Mellanox",</p><p>"Name": "Manufacturer",</p><p>"Len": "8"</p><p>},</p><p>"EEPROM\_INFO | Checksum": {</p><p>"Valid": "1"</p><p>},</p><p>"EEPROM\_INFO                                                                  | 0x23": {</p><p>"Value": "MT1950X05001",</p><p>"Name": "Serial Number",</p><p>"Len": "24"</p><p>},</p><p>"EEPROM\_INFO           | 0x22": {</p><p>"Value": "MSN2100-CB2FO",</p><p>"Name": "Part Number",</p><p>"Len": "20"</p><p>},</p><p>"EEPROM\_INFO | TlvHeader": {</p><p>"Version": "1",</p><p>"Id String": "TlvInfo",</p><p>"Total Length": "575"</p><p>}</p><p>}</p> |
| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul> |                                                                                                                                 |                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                 |                                                                                                                               |                                                                                                                                 |                                                                                                                      |                                                                                                                   |

#### **Get Syslog**

\| **Request URL**   | <p>/api/info/syslog</p><p>/api/info/syslog?time="matching string"</p><p>/api/info/syslog?severity=info|notice|warning|err</p><p>/api/info/syslog?component="matching string"</p><p><em>Note: Use ‘%23’ instead of ‘#’ in the component match string</em></p><p><em>Eg:/api/info/syslog?component="syncd%23SDK” to search for string “syncd#SDK”</em></p>                                                                                                                   |
\| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
\| **Description**   | Use this API to retrieve the syslogs from system                                                                                                                                                                                                                                                                                                                                                                                                                           |
\| **Method**        | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
\| **Request Body**  | NA                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
\| **Response Body** | <p>{</p><p>"1":{</p><p>"time":"Oct 5 06:22:26.453866"</p><p>"severity":"INFO"</p><p>"component":"syncd#/broadcom\_nagg\_asic.py"</p><p>"msg":"\[nagr]:Stat Poll-Table Handler Key map6 Data{'clear-all': 'false'}"</p><p>},</p><p>"2":{</p><p>"time":"Oct 5 06:22:19.109499"</p><p>"severity":"INFO"</p><p>"component":"syncd#/broadcom\_nagg\_asic.py"</p><p>"msg":"\[nagr]: execute command - bcmcmd 'fp stat set StatId=15 type=Packets val=0x0000'"</p><p>}, ...</p><p>}</p> |
\| **Status code**   | <ul><li>SERVER\_ERROR(500) if there is any error with the server</li><li>OK(200) if the request completes successfully</li></ul>                                                                                                                                                                                                                                                                                                                                            |
