Skip to content

XMiDT API

Weston Schmidt edited this page Dec 19, 2017 · 2 revisions

Current Version

The current version of the api is v2.

Schema

All API access is over HTTPS (unless otherwise configured). All data is sent and received as one of three different types:

  • application/json
  • application/msgpack
  • application/octet-stream

The response is returned in the same schema as the request is made.

Endpoint

/api/v2/device

POST a JSON, MsgPack or HTTP header encoded WRP message to be sent to the specified destination in the WRP.

HTTP Verbs Supported
POST

Responses

Status Description
200 Request successful
403 Forbidden
404 Device Not Found
500 The XMiDT cloud had an issue
503 A XMiDT cloud component did not respond in the allowed time
504 The device did not respond in the allowed time
599 If XMiDT was able to transfer the request and response but the device reported a non-2xx status (see WRP.status_code in message or header)
Clone this wiki locally