APB Devices

Manage inventory of network devices

Get all the network devices

get

Returns array of all the available network devices.

Responses

200

successful operation

No content

default

Unexpected error

get

/devices

HTTPcURLJavaScriptPython

GET /devices HTTP/1.1
Accept: */*

No content

Add Device

post

Add a new device

Body

application/json

ipstringOptionalExample: 127.0.0.1

usernamestringOptionalExample: admin

passwordstringOptionalExample: password

Responses

200

successful operation

No content

default

unexpected error

post

/devices

HTTPcURLJavaScriptPython

POST /devices HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "ip": "127.0.0.1",
  "username": "admin",
  "password": "password"
}

No content

Get details of a network device

get

Returns details of the specified network device.

Path parameters

deviceIdstringRequired

device identifier

Responses

200

successful operation

No content

default

unexpected error

get

/devices/{deviceId}

HTTPcURLJavaScriptPython

GET /devices/{deviceId} HTTP/1.1
Accept: */*

No content

Update a network device

put

Updates details of the specified network device.

Path parameters

deviceIdstringRequired

device identifier

Body

application/json

ipstringOptionalExample: 127.0.0.1

usernamestringOptionalExample: admin

passwordstringOptionalExample: password

Responses

200

successful operation

No content

default

unexpected error

put

/devices/{deviceId}

HTTPcURLJavaScriptPython

PUT /devices/{deviceId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "ip": "127.0.0.1",
  "username": "admin",
  "password": "password"
}

No content

Delete a network device

delete

Deletes the specified network device.

Path parameters

deviceIdstringRequired

device identifier

Responses

200

successful operation

No content

default

unexpected error

delete

/devices/{deviceId}

HTTPcURLJavaScriptPython

DELETE /devices/{deviceId} HTTP/1.1
Accept: */*

No content

Get device uptime

get

Returns uptime of the specified device

Path parameters

deviceIdstringRequired

device identifier

Responses

200

successful operation

No content

default

unexpected error

get

/devices/{deviceId}/uptime

HTTPcURLJavaScriptPython

GET /devices/{deviceId}/uptime HTTP/1.1
Accept: */*

No content

Get device clock

get

Returns time from the specified device

Path parameters

deviceIdstringRequired

device identifier

Responses

200

successful operation

No content

default

unexpected error

get

/devices/{deviceId}/clock

HTTPcURLJavaScriptPython

GET /devices/{deviceId}/clock HTTP/1.1
Accept: */*

No content

Get memory usage of a network device

get

Returns memory usage details of the specified network device.

Path parameters

deviceIdstringRequired

device identifier

Responses

200

successful operation

No content

default

unexpected error

get

/devices/{deviceId}/memory

HTTPcURLJavaScriptPython

GET /devices/{deviceId}/memory HTTP/1.1
Accept: */*

No content

Get environment details of a network device

get

Returns environment details of the specified network device.

Path parameters

deviceIdstringRequired

device identifier

Responses

200

successful operation

No content

default

unexpected error

get

/devices/{deviceId}/environment

HTTPcURLJavaScriptPython

GET /devices/{deviceId}/environment HTTP/1.1
Accept: */*

No content

Get syslog from device

get

Returns syslogs from the specified device

Path parameters

deviceIdstringRequired

device identifier

Responses

200

successful operation

No content

default

unexpected error

get

/devices/{deviceId}/syslog

HTTPcURLJavaScriptPython

GET /devices/{deviceId}/syslog HTTP/1.1
Accept: */*

No content