FLECS
HomeMarketplaceRessourcesGet started
Engineering
Engineering
  • API Docs
    • FLECS Console API
      • Welcome!
      • Quick Start
      • API Reference
        • Authentication
        • Users
        • Products
        • Device
        • Apps
    • FLECS Core API
      • API Reference
        • System
        • Device
        • Console
        • Instances
        • Apps
        • Jobs
  • App Publishing Guide
    • 💡Overview
    • 🪛How to create a FLECS app
    • 🚀How to release a FLECS app
    • 🧳App Publishing Packages
    • 📶Network
  • FLECS Core
    • Install FLECS Core Using Docker
  • White Labeling
    • Integrate views
    • On-premise hosting of apps
Powered by GitBook
On this page

Was this helpful?

  1. API Docs
  2. FLECS Core API
  3. API Reference

Apps

PreviousInstancesNextJobs

Last updated 3 months ago

Was this helpful?

Query installed Apps

get
Responses
200
Success
application/json
get
GET /v2/apps HTTP/1.1
Host: localhost
Accept: */*
200

Success

[]

Query all versions or specific versions of an App

get
Path parameters
appstringRequired

App to query

Query parameters
versionstringOptional

App version to query

Responses
200
Success
application/json
404
No such app or app/version combination
get
GET /v2/apps/{app} HTTP/1.1
Host: localhost
Accept: */*
[]

Uninstall one or all versions an App

delete
Path parameters
appstringRequired

App to uninstall

Query parameters
versionstringOptional

App version to uninstall

Responses
202
Accepted
application/json
404
No such app or app/version combination
delete
DELETE /v2/apps/{app} HTTP/1.1
Host: localhost
Accept: */*
{
  "jobId": 17
}
  • GETQuery installed Apps
  • GETQuery all versions or specific versions of an App
  • DELETEUninstall one or all versions an App
  • POSTInstall an App from the FLECS marketplace
  • POSTSideload an App from its manifest

Install an App from the FLECS marketplace

post
Body
Responses
202
Accepted
application/json
400
Malformed request
application/json
500
Internal server error
application/json
post
POST /v2/apps/install HTTP/1.1
Host: localhost
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "appKey": {
    "name": "tech.flecs.app-1",
    "version": "1.2.3.4-f1"
  }
}
{
  "jobId": 17
}

Sideload an App from its manifest

post
Body
manifeststringRequired
Responses
202
Accepted
application/json
400
Malformed request
application/json
post
POST /v2/apps/sideload HTTP/1.1
Host: localhost
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "manifest": "text"
}
{
  "jobId": 17
}