#Apps

Server apps are custom mini-applications that run inside a server. They can be HTML pages, zip bundles, or external URL proxies.

#List apps

const apps = await client.listApps('server-id')

apps = client.list_apps("server-id")

#Get homepage app

Returns the app designated as the server homepage.

const homepage = await client.getHomepageApp('server-id')

homepage = client.get_homepage_app("server-id")

#Get app

Supports lookup by UUID or slug.

const app = await client.getApp('server-id', 'app-id')

app = client.get_app("server-id", "app-id")

#Create app

Requires server admin permission.

const app = await client.createApp('server-id', {
  name: 'Dashboard',
  slug: 'dashboard',
  type: 'html',
  htmlContent: '<h1>Hello</h1>',
})

app = client.create_app("server-id",
    name="Dashboard",
    slug="dashboard",
    type="html",
    htmlContent="<h1>Hello</h1>",
)

#Update app

await client.updateApp('server-id', 'app-id', { name: 'New Name' })

client.update_app("server-id", "app-id", name="New Name")

#Delete app

await client.deleteApp('server-id', 'app-id')

client.delete_app("server-id", "app-id")

#Publish from workspace

Publishes workspace files as an app. Requires admin permission.

const app = await client.publishApp('server-id', {
  name: 'My App',
  slug: 'my-app',
  folderId: 'workspace-folder-id',
})

app = client.publish_app("server-id",
    name="My App",
    slug="my-app",
    folderId="workspace-folder-id",
)

#Serve app content

Serves the app's static content. For URL-type apps, use the proxy endpoint:

These endpoints are public and do not require authentication.