Skip to main content
POST
Restore an archived app

Authorizations

Authorization
string
header
required

Effective API key. Send Authorization: Bearer sk-eai-...

Path Parameters

appId
string
required

App ID: app- followed by lowercase letters, digits and hyphens, ending in a letter or digit. It is part of the app’s hostname, so your organization’s subdomain and the ID together must fit 63 characters.

Maximum string length: 63
Pattern: ^app-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$

Response

The restored app.

id
string
required

App ID: app- followed by lowercase letters, digits and hyphens, ending in a letter or digit. It is part of the app’s hostname, so your organization’s subdomain and the ID together must fit 63 characters.

Maximum string length: 63
Pattern: ^app-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$
title
string
required

Display title; the ID when no title was set.

description
string | null
required

Catalog description, or null.

iconEmoji
string | null
required

Emoji icon, or null.

iconUrl
string | null
required

Icon image URL, or null.

visibility
enum<string>
required

team lists the app for your organization; private lists it only for people granted access.

Available options:
private,
team
public
boolean
required

True when anyone with the link can open the app without signing in.

managed
boolean
required

True when the app was installed from the app store. A managed app has no source of its own and cannot be deployed from a bundle.

currentDeploymentId
string | null
required

The deployment the app serves now, or null before its first deployment.

url
string<uri> | null
required

Where the app’s interface opens, or null when it has no interface or no deployment yet.

webUrl
string<uri>
required

The app’s page in Effective: activity, access and settings.

source
object | null
required

Where to clone and push the app’s source, when you have build permission; null otherwise and for an app installed from the app store.

permissions
enum<string>[]
required

What you can do with the app. Lists and reads include only apps you can run; a new app may lack it.

run opens and uses the app, build changes its source, publish uploads release bundles and deploys them, manage changes its access and settings.

Available options:
run,
build,
publish,
manage