Networking

Retrieve a Cpe

Work with Cpe.Retrieves the Cpe with the given ID.

get/admin/networking/cpe/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/networking/cpe/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID ofthe desired Cpe.

Response

customer_idnumber

CPE customer ID.

titlestring required

CPE title.

hoststring required

CPE host IP.

api_loginstring

API login.

api_passwordstring

API password.

api_portstring

API port. Default: '8728'.

statusstring

CPE status. Values: 'unknown' for "Unknown", 'error_connection' for "Error connection", 'api_error' for "Api error", 'api_ok' for "Api ok".

change_statusnumber

CPE change status. Default: 1. Values: 0 or 1.

last_statusstring

CPE last status datetime.

last_updatestring

CPE last update datetime.

last_connectstring

CPE last connect datetime.

typestring

CPE type.

signalstring

CPE signal.

gpsstring
service_idnumber

Service ID.

qosnumber

CPE is qos. Default: 1. Values: 0 or 1.

used_date_timestring

CPE used datetime.

cpe_wirelessstring

CPE wireless.

cpe_wireless_interfacesstring

CPE wireless interfaces.

cpe_statusstring

CPE status.

cpe_interfacesstring

CPE interfaces.

connection_errornumber

CPE connection error key.

idnumber

CPE ID.

customer_namestring

CPE customer name.

customer_loginstring

CPE customer login.

partner_idstring

CPE customer partner ID.

location_idstring

CPE customer location ID.

dhcpstring

CPE dhcp.

is_changednumber

CPE is changed. Values: 0 or 1.

is_usednumber

CPE is used. Values: 0 or 1.

qos_targetstring

CPE qos target.

Example response

{
  "customer_id": 76,
  "title": "Office router",
  "host": "10.0.1.1",
  "api_login": "api_user",
  "api_password": "api_password",
  "api_port": "8728",
  "status": "error_connection",
  "change_status": 1,
  "last_status": "2017-01-01 00:00:00",
  "last_update": "2017-01-01 00:00:00",
  "last_connect": "2017-01-01 00:00:00",
  "type": "TypeCpe",
  "signal": "-48",
  "gps": "50.11,8.7253",
  "service_id": 10,
  "qos": 1,
  "used_date_time": "2017-01-01 00:00:00",
  "cpe_wireless": "json string",
  "cpe_wireless_interfaces": "json string",
  "cpe_status": "json string",
  "cpe_interfaces": "json string",
  "connection_error": 9,
  "id": 1,
  "customer_name": "null",
  "customer_login": "null",
  "partner_id": "null",
  "location_id": "null",
  "dhcp": "null",
  "is_changed": 0,
  "is_used": 0,
  "qos_target": "self"
}

Changes

No recorded changes to this operation across all 1 revision of this API.