Apps

Query installed Apps

GEThttp://localhost/v2/apps

Response

200

Success

Body

application/json

appKey*app_key (object)

status*app_status (enum)

not installedmanifest downloadedtoken acquiredimage downloadedinstalledremovedpurgedorphanedunknown

desired*app_status (enum)

not installedmanifest downloadedtoken acquiredimage downloadedinstalledremovedpurgedorphanedunknown

installedSize*integer

Example: 10485760

multiInstance*boolean

editors*array of app_editor (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/apps', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "appKey": {
      "name": "tech.flecs.app-1",
      "version": "1.2.3.4-f1"
    },
    "status": "not installed",
    "desired": "not installed",
    "installedSize": 10485760,
    "multiInstance": false,
    "editors": [
      {
        "name": "text",
        "port": 0,
        "supportsReverseProxy": true
      }
    ]
  }
]

Query all versions or specific versions of an App

GEThttp://localhost/v2/apps/{app}

Path parameters

app*string

App to query

Query parameters

Response

200404

Success

Body

application/json

appKey*app_key (object)

status*app_status (enum)

not installedmanifest downloadedtoken acquiredimage downloadedinstalledremovedpurgedorphanedunknown

desired*app_status (enum)

not installedmanifest downloadedtoken acquiredimage downloadedinstalledremovedpurgedorphanedunknown

installedSize*integer

Example: 10485760

multiInstance*boolean

editors*array of app_editor (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/apps/{app}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "appKey": {
      "name": "tech.flecs.app-1",
      "version": "1.2.3.4-f1"
    },
    "status": "not installed",
    "desired": "not installed",
    "installedSize": 10485760,
    "multiInstance": false,
    "editors": [
      {
        "name": "text",
        "port": 0,
        "supportsReverseProxy": true
      }
    ]
  }
]

Uninstall one or all versions an App

DELETEhttp://localhost/v2/apps/{app}

Path parameters

app*string

App to uninstall

Query parameters

Response

202404

Accepted

Body

application/json

jobId*integer

Example: 17

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/apps/{app}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

202

{
  "jobId": 17
}

Install an App from the FLECS marketplace

POSThttp://localhost/v2/apps/install

Body

application/json

appKey*app_key (object)

Response

202400500

Accepted

Body

application/json

jobId*integer

Example: 17

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/apps/install', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "appKey": {
        "name": "tech.flecs.app-1",
        "version": "1.2.3.4-f1"
      }
    }),
});
const data = await response.json();

Response

202400500

{
  "jobId": 17
}

Sideload an App from its manifest

POSThttp://localhost/v2/apps/sideload

Body

application/json

manifest*string

Response

202400

Accepted

Body

application/json

jobId*integer

Example: 17

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/apps/sideload', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "manifest": "text"
    }),
});
const data = await response.json();

Response

202400

{
  "jobId": 17
}