Codex API (0.12.3)

Download OpenAPI specification:Download

License: Apache 2.0

The purpose of this application is to provide an API that returns event information for a device.

Authentication

basic

Security Scheme Type HTTP
HTTP Authorization Scheme basic

bearer

Security Scheme Type API Key
Header parameter name: bearer

Get Device Events

Get latest events related to a specific device id.

path Parameters
deviceID
required
string

the id of the device known to the xmidt cluster

query Parameters
after
string

create a long poll request to get the events after the state hash provided from a previous request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the best effort status of the device.

path Parameters
deviceID
required
string

deviceID

Responses

Response samples

Content type
application/json
{
  • "deviceid": "1234",
  • "state": "online",
  • "since": "2020-01-29T19:45:39.49854578Z",
  • "now": "2020-01-29T19:52:02.424551903Z",
  • "last_offline_reason": "*no error*:readerror",
  • "partner_ids": null
}