Endpoint Error Matrix

Lists the HTTP status codes and error codes each endpoint may return. Use it as a reference when implementing client-side error branching.

Create Access Token

• 400 INVALID_REQUEST
• 401 AUTH_INVALID
• 429 RATE_LIMITED
• 500 INTERNAL_ERROR

Create WebSocket Ticket

• 400 INVALID_REQUEST
• 401 AUTH_REQUIRED
• 401 AUTH_INVALID
• 401 AUTH_EXPIRED
• 429 RATE_LIMITED
• 500 INTERNAL_ERROR

List Devices

• 400 INVALID_REQUEST
• 401 AUTH_REQUIRED
• 401 AUTH_INVALID
• 401 AUTH_EXPIRED
• 403 AUTH_SCOPE_DENIED
• 429 RATE_LIMITED
• 500 INTERNAL_ERROR

Get Device

• 400 INVALID_REQUEST
• 401 AUTH_REQUIRED
• 401 AUTH_INVALID
• 401 AUTH_EXPIRED
• 403 AUTH_SCOPE_DENIED
• 404 DEVICE_NOT_FOUND
• 429 RATE_LIMITED
• 500 INTERNAL_ERROR

List Device Type Definitions

• 400 INVALID_REQUEST
• 401 AUTH_REQUIRED
• 401 AUTH_INVALID
• 401 AUTH_EXPIRED
• 403 AUTH_SCOPE_DENIED
• 429 RATE_LIMITED
• 500 INTERNAL_ERROR

Execute Device Operation (Relay Command)

• 400 INVALID_REQUEST
• 401 AUTH_REQUIRED
• 401 AUTH_INVALID
• 401 AUTH_EXPIRED
• 403 AUTH_SCOPE_DENIED
• 404 DEVICE_NOT_FOUND
• 409 IDEMPOTENCY_CONFLICT
• 422 COMMAND_REJECTED
• 422 DEVICE_OFFLINE
• 429 RATE_LIMITED
• 500 INTERNAL_ERROR

Set Relay Jog Duration

• 400 INVALID_REQUEST
• 401 AUTH_REQUIRED
• 401 AUTH_INVALID
• 401 AUTH_EXPIRED
• 403 AUTH_SCOPE_DENIED
• 404 DEVICE_NOT_FOUND
• 422 COMMAND_REJECTED
• 422 DEVICE_OFFLINE
• 429 RATE_LIMITED
• 500 INTERNAL_ERROR

Get Command Result

• 400 INVALID_REQUEST
• 401 AUTH_REQUIRED
• 401 AUTH_INVALID
• 401 AUTH_EXPIRED
• 403 AUTH_SCOPE_DENIED
• 404 COMMAND_NOT_FOUND
• 429 RATE_LIMITED
• 500 INTERNAL_ERROR