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.

Find out more about Codex

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

200

Content type

application/json

[{"msg_type": 4,
"source": "dns:talaria.xmidt.example.com",
"dest": "event:device-status/event:device-status/mac:ffffffffdae4/online/online",
"transaction_uuid": "546514d4-9cb6-41c9-88ca-ccd4c130c525",
"content_type": "json",
"metadata": {"/boot-time": "1542834188",
"/last-reconnect-reason": "spanish inquisition"
},
"payload": "eyJpZCI6IjUiLCJ0cyI6IjIwMTktMDItMTJUMTE6MTA6MDIuNjE0MTkxNzM1WiIsImJ5dGVzLXNlbnQiOjAsIm1lc3NhZ2VzLXNlbnQiOjEsImJ5dGVzLXJlY2VpdmVkIjowLCJtZXNzYWdlcy1yZWNlaXZlZCI6MH0=",
"birth_date": 1580326503649365800
}
]

Get the best effort status of the device.

path Parameters

deviceID

required

string

deviceID

Responses

Response samples

200

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
}