Skip to content

Update a board

PATCH
/v1/admin/boards/{id}

Patch board fields such as state, label, specs, or disabled.

Authorizations

BearerAuth

API key (Bearer key_...)

Type
API Key (header: Authorization)

Parameters

Path Parameters

id*

Board ID

Type
string
Required

Request Body

application/json
JSON
{
}

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
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI