Update snippet

Updates snippet properties. Only provided fields are changed. Dashboards using this snippet will pick up code changes on next run.

PATCH /snippets/{id}

Update snippet

cURL

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

200

{
  "snippet_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

Snippet ID

Required string length: 1 - 54

Body

application/json

name · string

Required string length: 1 - 100

description · string

Maximum string length: 500

code · string

Required string length: 1 - 50000

display_type · enum<string>

Controls how the snippet result is rendered in dashboard widgets

Available options: table, stat, json, logs

visibility · enum<string>

Whether the snippet is reusable workspace state or scoped to an agent session.

Available options: workspace, session

purpose · enum<string>

Available options: general, prepared_action, reactive_read, widget

Response

200

application/json

Snippet updated

snippet_id · string · required