Skip to content

RipEx2 API

This API allows full access to RipEx2 configuration and diagnostics. All end user interaction with the device is to be done through this API.

  • It is a client-server protocol
  • Must use HTTPS protocol as the transport layer
  • All requests and response bodies must be a valid JSON
  • All communication must be UTF-8 encoded
  • All communication is case-sensitive
  • All requests and responses must contain the header: content-type: application/json
  • All requests may contain the header: content-encoding: gzip and have the body compressed by gzip
  • All requests may contain the header: accept-encoding: gzip to request a response with body compressed by gzip

Request/Response Attributes

Reserved

Attributes marked with 🌄 are not presently implemented, but reserved for use in the sunny future.

Mandatory

Attributes marked with * are mandatory.

Non-mandatory attributes should be omitted if possible. Omitted attributes must be treated as if set to null for all data types. Note, that sometimes omitting an attribute is not possible as, for example, in Condensed Data, where null must be set explicitly (unless it is the last element in the given array).

An empty array and object with no attributes have no special meaning and do not communicate emptiness. To express an empty value the attribute must be omitted or set to null.

Unicode

The API uses some less common unicode characters to allow for more explicit user facing labels. Clients must ensure they can display them (Android, iOS, macOS beware!).

Characters used:

  • U+2B71: upwards triangle-headed arrow to bar (â­±)
  • U+2B72: rightwards triangle-headed arrow to bar (â­²)
  • U+2B73: downwards triangle-headed arrow to bar (â­³)