Skip to content

List available boards​

GET
/v1/boards

Returns every registered board and its current availability. The device path, the pod it hangs off and the session holding it are admin-only; the anonymous board counts are at /v1/boards/summary.

Authorizations​

BearerAuth

API key (Bearer key_...)

Type
API Key (header: Authorization)

Responses​

OK

application/json
JSON
[
  
{
  
  
"board_type": "string",
  
  
"created_at": "string",
  
  
"current_session_id": "string",
  
  
"device": "string",
  
  
"disabled": true,
  
  
"id": "string",
  
  
"label": "string",
  
  
"pod_id": "string",
  
  
"sled_version": "string",
  
  
"specs": "string",
  
  
"state": "string"
  
}
]

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI