REST API Rules

This document describes the common rules for the REST API. For integration instructions, start with REST API Overview.

Common Rules

• The current version contains REST APIs only
• All successful 2xx responses return data
• Most error responses omit data; errors may include code-specific remediation details
• message is a human-readable description and must not be used for program branching
• Clients may branch only on HTTP status and code
• Side-effecting device command requests must define idempotency and retry semantics