Update dashboard

Update dashboard metadata. Widget mutations use the /widgets sub-collection.

PATCH /dashboards/{id}

Update dashboard

cURL

curl --request PATCH \
  --url https://api.akua.dev/v1/dashboards/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'if-match: <if-match>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

200

{
  "dashboard_id": "<string>"
}

Authorizations

Authorization · string · header · required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

if-match · string · required

The etag of the resource version the client last read. Required on writes when the resource exposes an etag field. Mismatch returns 409 ABORTED with the current etag in the error metadata.

Required string length: 1 - 256

Example:

"42"

Path Parameters

id · string · required

Dashboard ID

Required string length: 1 - 55

Body

application/json

name · string

Required string length: 1 - 100

description · string

Maximum string length: 500

Response

200

application/json

Dashboard updated

dashboard_id · string · required