Skip to content
SupaCloud Docs
Select themeSelect language

`PUT /api/apps/{id}` -- update name / description / manifest_yaml. Each field is optional; an absent field is left alone. The description field is three-state (see `deserialize_description_field`).

PUT
/api/apps/{id}
curl --request PUT \
  --url https://example.com/api/apps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "manifest_yaml": "example", "name": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
description

Three-state per the service contract:

  • field absent / null -> leave the stored description alone.
  • non-empty string -> overwrite.
  • empty string -> clear.
string | null
manifest_yaml
string | null
name
string | null
Examplegenerated
{
  "description": "example",
  "manifest_yaml": "example",
  "name": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Wire-shape App view returned by every HTTP handler. Mirrors the DB row 1:1; the created_by is included so the UI can show “Created by you” without a second lookup.

object
app_db_resource_id

ADR 0023 v4 / S2c – when set, runs of this App auto-inject SET LOCAL supacloud.app_id against connections to this Resource and the App’s per-App app_<slug> schema is bootstrapped on save.

string | null format: uuid
created_at
required
string format: date-time
created_by
string | null format: uuid
description
string | null
framework
required

ADR 0030 – build framework: plain | react | svelte.

string
id
required
string format: uuid
manifest_yaml
required
string
name
required
string
slug
required
string
updated_at
required
string format: date-time
workspace_id
required
string format: uuid
Examplegenerated
{
  "app_db_resource_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "created_at": "2026-04-15T12:00:00Z",
  "created_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "description": "example",
  "framework": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "manifest_yaml": "example",
  "name": "example",
  "slug": "example",
  "updated_at": "2026-04-15T12:00:00Z",
  "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}