Apps

Get an app

One app with the settings of the running version (main_module, allowed_hosts, secrets by name only, schedules, vars with their values, auth, database, fetch_pages), its stored versions and its most recent errors. A deploy that leaves a setting out keeps the value shown here.

get/apps/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/apps/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:read)

Path parameters

idstring uuid required

The id of the app.

Response

The app.

idstring uuid required
namestring required
site_idstring uuid required
urlstring required

The site; the app answers on url + /api.

api_urlstring required

Where the app's /api starts.

mode'live' | 'test' required
status'active' | 'offline' required

offline: Hypamoon took the site offline; the app does not run.

versioninteger required

The version that runs now.

allowed_hostsstring[] required
secretsstring[] required
keptstring[]

Only in the answer to a deploy of an existing app: the settings that were left out and kept from the running version, like "allowed_hosts (20)", "vars (2)", "database", "auth".

warningsstring[]

Only in the answer to a deploy: advice about the app's data, never a block. For example that export and delete per user won't cover the data (no table marked with set_table_owner_column), or tables that look like backups or copies. Tell the user in plain words and offer to fix it.

created_atstring required
updated_atstring required
main_modulestring required

The main module of the running version.

varsobject required

The plain settings in env of the running version, with their values. Secrets are not here: secrets lists only their names.

fetch_pagesboolean required

Whether env.HYPAMOON.fetchPage is on in the running version.

Changes

No recorded changes to this operation across all 1 revision of this API.