Status

The /status URL displays the device's status.

URL

/api/v1/status

HTTP Method

GET

HTTP Response

200 OK

The response includes status fields, as described in the following table:

Field	Description
localTimeStamp	Current date and time
ipAddress	IP address of the device
subnetMask	Subnet mask of the device
defaultGateway	Default gateway of device
productType	Device's product model
versionID	Software version number
protocolType	Protocol type (SIP)
operationalState	Device's operational (administrative) state: ■ "UNLOCKED" ■ "LOCKED"
highAvailability	Indicates if the device is in HA mode: ■ "Not Operational" (standalone) ■ "Operational" (HA)
serialNumber	Device's serial number
macAddress	Device's MAC address
systemUpTime	Duration that the device has been up and running since the last reset
saveNeeded	Indicates if a save operation is required on the device: ■ "false" ■ "true"
resetNeeded	Indicates if the device needs to be reset: ■ "false" ■ "true"
upgradeStatus	Indicates if a software update is in progress: ■ "None" ■ "In Progress" ■ "Hitless-beforeSwitchOver" ■ "Hitless-beforeSwitchBack" ■ "Hitless-WaitRdnReconnect" Note: The "hitless" statuses are applicable only to device's in HA mode.
mcUpgradeStatus	Indicates if a software update for Media Components (MC) is in progress: ■ "None" ■ "In Progress" Note: The field is applicable only to Mediant CE SBC.

Example

■

Request:

GET /api/v1/status HTTP/1.1
Host: 10.4.219.229 

■

Response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "localTimeStamp": "2010-01-17T17:29:15.000Z",
    "ipAddress": "10.4.219.229",
    "subnetMask": "255.255.0.0",
    "defaultGateway": "10.4.0.1",
    "productType": "Mediant SW",
    "versionID": "7.20A.200.014",
    "protocolType": "SIP",
    "operationalState": "UNLOCKED",
    "highAvailability": "Not Operational",
    "serialNumber": "101780235059663",
    "macAddress": "fa163e6e7e1d",
    "systemUpTime": 161446
    "saveNeeded":false
    "resetNeeded":false
    "upgradeStatus":"None"
    "mcUpgradeStatus":"None"
}