Analytics Service

PreviousProvisioning Service NextRadio Resource Management Service

Last updated 2 years ago

Was this helpful?

Remove a board

delete

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.

Get basic information about all the devices for a venue.

get

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

Authorizations

Path parameters

idstring · uuidrequired

Query parameters

fromDateintegeroptional

endDateintegeroptional

maxRecordsintegeroptionalDefault: 100

statsOnlybooleanoptionalDefault: false

pointsOnlybooleanoptionalDefault: false

pointsStatsOnlybooleanoptionalDefault: false

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

Authorizations

Path parameters

idstring · uuidrequired

Query parameters

fromDateintegeroptional

endDateintegeroptional

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

Authorizations

Query parameters

ipliststringrequiredExample: 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

Authorizations

Query parameters

fromDateintegeroptional

endDateintegeroptional

offsetintegeroptional

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

limitintegeroptional

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)

Default: false

macFilterstringoptional

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=true&venue=123e4567-e89b-12d3-a456-426614174000' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

Retrieve WiFi client history for debugging purpose

get

Authorizations

Path parameters

clientstringrequiredExample: 112233aabbcc

Query parameters

fromDateintegeroptional

endDateintegeroptional

offsetintegeroptional

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

limitintegeroptional

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

venuestring · uuidrequired

The venue to for the search.

orderBystringoptional

return extended information

Example: serialNumber:a,created:d

orderSpecbooleanoptional

return extended information

Default: false

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

Authorizations

Path parameters

clientstringrequiredExample: 112233aabbcc

Query parameters

venuestring · uuidrequired

The venue to for the search.

fromDateintegeroptional

endDateintegeroptional

macFilterstringoptional

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

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Available options:

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

Retrieve a board

get

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

Authorizations

Path parameters

idstring · uuidrequiredExample: value should be 0 for a post

Body

allOfobjectoptional

venueListobject[]optional

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

Modify a board

put

Authorizations

Path parameters

idstring · uuidrequired

Body

allOfobjectoptional

venueListobject[]optional

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

Perform some system wide commands.

post

Authorizations

Body

one ofoptional

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": [
      {
        "tag": "text",
        "value": "text"
      }
    ]
  }'

200

400

403

404

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

Successful command execution

Remove a board

Get basic information about all the devices for a venue.

retrieve board data for a given time period.

delete board data for a given time period.

Get the country code for an IP address

Retrieve WiFi client history for debugging purpose

Retrieve WiFi client history for debugging purpose

Retrieve WiFi client history for debugging purpose

Retrieve different values from the running service.

Retrieve a board

Create a board

Show child attributes

Show child attributes

Modify a board

Show child attributes

Show child attributes

Perform some system wide commands.

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes