Analytics Service

PreviousProvisioning Service NextRadio Resource Management Service

Was this helpful?

Retrieve a board

get

/board/{id}

Authorizations

Path parameters

idstring uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16009/api/v1/board/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "venueList": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "retention": 1,
      "interval": 1,
      "monitorSubVenues": true
    }
  ]
}

Return a list of boards

Create a board

post

/board/{id}

Authorizations

Path parameters

idstring uuidrequired

Example: value should be 0 for a post

Body

allOfobject

venueListobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16009/api/v1/board/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"allOf":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"text","description":"text","notes":[{"created":1,"createdBy":"text","note":"text"}],"created":1,"modified":1,"tags":[1]},"venueList":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"text","description":"text","retention":1,"interval":1,"monitorSubVenues":true}]}'

200

400

403

404

No body

Remove a board

delete

/board/{id}

Authorizations

Path parameters

idstring uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16009/api/v1/board/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Modify a board

put

/board/{id}

Authorizations

Path parameters

idstring uuidrequired

Body

allOfobject

venueListobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16009/api/v1/board/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"allOf":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"text","description":"text","notes":[{"created":1,"createdBy":"text","note":"text"}],"created":1,"modified":1,"tags":[1]},"venueList":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"text","description":"text","retention":1,"interval":1,"monitorSubVenues":true}]}'

200

400

403

404

No body

Get basic information about all the devices for a venue.

get

/board/{id}/devices

Authorizations

Path parameters

idstring uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16009/api/v1/board/{id}/devices' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

No body

retrieve board data for a given time period.

get

/board/{id}/timepoints

Authorizations

Path parameters

idstring uuidrequired

Query parameters

fromDateinteger

endDateinteger

maxRecordsinteger

statsOnlyboolean

pointsOnlyboolean

pointsStatsOnlyboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16009/api/v1/board/{id}/timepoints' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

No body

delete board data for a given time period.

delete

/board/{id}/timepoints

Authorizations

Path parameters

idstring uuidrequired

Query parameters

fromDateinteger

endDateinteger

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16009/api/v1/board/{id}/timepoints' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Get the country code for an IP address

get

/iptocountry

Authorizations

Query parameters

ipliststringrequired

Example: 10.2.2.2,10.3.4.3

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16009/api/v1/iptocountry?iplist=10.2.2.2%2C10.3.4.3' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

{
  "enabled": true,
  "countryCodes": [
    "text"
  ]
}

List of country codes.

Retrieve WiFi client history for debugging purpose

get

/wifiClientHistory

Authorizations

Query parameters

fromDateinteger

endDateinteger

offsetinteger

Pagination start (starts at 1. If not specified, 1 is assumed)

limitinteger

Maximum number of entries to return (if absent, no limit is assumed)

macsOnlybooleanrequired

Maximum number of entries to return (if absent, no limit is assumed)

macFilterstring

Maximum number of entries to return (if absent, no limit is assumed)

Example: 112233445566, 11223344*, *5566

venuestring uuidrequired

The venue to for the search.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16009/api/v1/wifiClientHistory?macsOnly=false&venue=123e4567-e89b-12d3-a456-426614174000' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

Retrieve WiFi client history for debugging purpose

get

/wifiClientHistory/{client}

Authorizations

Path parameters

clientstringrequired

Example: 112233aabbcc

Query parameters

fromDateinteger

endDateinteger

offsetinteger

Pagination start (starts at 1. If not specified, 1 is assumed)

limitinteger

Maximum number of entries to return (if absent, no limit is assumed)

venuestring uuidrequired

The venue to for the search.

orderBystring

return extended information

Example: serialNumber:a,created:d

orderSpecboolean

return extended information

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16009/api/v1/wifiClientHistory/{client}?venue=123e4567-e89b-12d3-a456-426614174000' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

Retrieve WiFi client history for debugging purpose

delete

/wifiClientHistory/{client}

Authorizations

Path parameters

clientstringrequired

Example: 112233aabbcc

Query parameters

venuestring uuidrequired

The venue to for the search.

fromDateinteger

endDateinteger

macFilterstring

Maximum number of entries to return (if absent, no limit is assumed)

Example: 112233445566, 11223344*, *5566

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16009/api/v1/wifiClientHistory/{client}?venue=123e4567-e89b-12d3-a456-426614174000' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Retrieve different values from the running service.

get

/system

Authorizations

Query parameters

commandenumrequired

Get a value

Options: info

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16009/api/v1/system?command=info' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

{
  "version": "text",
  "uptime": 1,
  "start": 1,
  "os": "text",
  "processors": 1,
  "hostname": "text",
  "certificates": [
    {
      "filename": "text",
      "expires": 1
    }
  ]
}

Successful command execution

Perform some system wide commands.

post

/system

Authorizations

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16009/api/v1/system' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"command":"setloglevel","subsystems":[{}]}'

200

400

403

404

{
  "taglist": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}

Successful command execution