Skip to content

Set App Status

POST
/apps/{app_id}/status

PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.

Move an app through its lifecycle: draft → published → archived.

suspended is the platform’s kill switch and is NOT settable here — a builder suspending and un-suspending their own app would defeat it entirely.

Authorizations

Parameters

Path Parameters

app_id
required
string

Header Parameters

X-Org-Id
Any of:
string

Request Body required

Mirrors the portal’s setAppStatus(builderOrgId, appId, status).

object
status
required

draft, published, suspended or archived. active is accepted as the legacy spelling of published.

string

Responses

200

Successful Response

object
data
required

One builder-owned app. Mirrors AppDto.

object
app_id
required
string
archived_at
Any of:
string format: date-time
builder_org_id
required
string
created_at
Any of:
string format: date-time
default_hostname
Any of:
string
name
required
string
registered_origins

Https-only origins a browser app token may be presented from.

Array<string>
slug
required
string
source_credential_ref
Any of:
string
source_default_branch
Any of:
string
source_provider
Any of:
string
source_repo_url
Any of:
string
status
required

Lifecycle state: draft, published, suspended or archived. active is accepted on write as a legacy spelling of published.

string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string