Instances | FLECS

FLECS

HomeGet started

Query all instances of one or all Apps

get

/instances

Query parameters

appstring

App to query instances for

versionstring

App version to query instances for

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost/v2/instances'

200

[]

Success

Obtain details of an App instance

get

/instances/{instance_id}

Path parameters

instance_idstringrequired

Example: 01ab89ef

Pattern: ^[0-9a-f]{8}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost/v2/instances/{instance_id}'

200

404

500

{
  "instanceId": "01ab89ef",
  "instanceName": "Smart home",
  "appKey": {
    "name": "tech.flecs.app-1",
    "version": "1.2.3.4-f1"
  },
  "status": "not created",
  "desired": "not created",
  "configFiles": [
    {
      "container": "/etc/conf.d/configuration.cfg",
      "host": "/var/lib/flecs/instances/01ab89ef/conf/configuration.cfg"
    }
  ],
  "hostname": "flecs-01ab89ef",
  "ipAddress": "172.21.0.3",
  "editors": [
    {
      "name": "Example app user settings",
      "url": "/api/v2/instances/abcd1234/editor/8080"
    }
  ],
  "ports": [
    {
      "container": "8080",
      "host": "18080"
    }
  ],
  "volumes": [
    {
      "name": "var",
      "path": "/var/app"
    }
  ]
}

Success

Update or downgrade Instance to another App version

patch

/instances/{instance_id}

Path parameters

instance_idstringrequired

Example: 01ab89ef

Pattern: ^[0-9a-f]{8}$

Body

tostringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'http://localhost/v2/instances/{instance_id}' \
  --header 'Content-Type: application/json' \
  --data '{"to":"text"}'

202

404

{
  "jobId": 17
}

Accepted

Delete a single instance

delete

/instances/{instance_id}

Path parameters

instance_idstringrequired

Example: 01ab89ef

Pattern: ^[0-9a-f]{8}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost/v2/instances/{instance_id}'

202

404

{
  "jobId": 17
}

Accepted

Create new instance of an installed App

post

/instances/create

Body

appKeyobjectrequired

instanceNamestring

Instance name

Example: Smart home

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost/v2/instances/create' \
  --header 'Content-Type: application/json'

202

400

{
  "jobId": 17
}

Accepted

Start an App instance

post

/instances/{instance_id}/start

Path parameters

instance_idstringrequired

Example: 01ab89ef

Pattern: ^[0-9a-f]{8}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost/v2/instances/{instance_id}/start'

202

404

{
  "jobId": 17
}

Accepted

Stop an App instance

post

/instances/{instance_id}/stop

Path parameters

instance_idstringrequired

Instance id to delete

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost/v2/instances/{instance_id}/stop'

202

404

{
  "jobId": 17
}

Accepted

Get configuration of an Instance

get

/instances/{instance_id}/config

Path parameters

instance_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost/v2/instances/{instance_id}/config'

200

404

{
  "networkAdapters": [
    {
      "name": "text",
      "active": true,
      "connected": true,
      "ipAddress": "127.0.0.1",
      "subnetMask": "127.0.0.1",
      "gateway": "127.0.0.1"
    }
  ],
  "devices": {
    "usb": [
      {
        "device": "text",
        "pid": 1,
        "port": "text",
        "vendor": "text",
        "vid": 1,
        "active": true,
        "connected": true
      }
    ]
  }
}

Success

Update configuration of an Instance

post

/instances/{instance_id}/config

Path parameters

instance_idstringrequired

Body

networkAdaptersobject[]required

devicesobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost/v2/instances/{instance_id}/config' \
  --header 'Content-Type: application/json' \
  --data '{"networkAdapters":[{"name":"text","active":true,"connected":true,"ipAddress":"127.0.0.1","subnetMask":"127.0.0.1","gateway":"127.0.0.1"}],"devices":{"usb":[{"device":"text","pid":1,"port":"text","vendor":"text","vid":1,"active":true,"connected":true}]}}'

200

404

{
  "networkAdapters": [
    {
      "name": "text",
      "active": true,
      "connected": true,
      "ipAddress": "127.0.0.1",
      "subnetMask": "127.0.0.1",
      "gateway": "127.0.0.1"
    }
  ],
  "devices": {
    "usb": [
      {
        "device": "text",
        "pid": 1,
        "port": "text",
        "vendor": "text",
        "vid": 1,
        "active": true,
        "connected": true
      }
    ]
  }
}

Success

Retrieve logs of an Instance

get

/instances/{instance_id}/logs

Path parameters

instance_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost/v2/instances/{instance_id}/logs'

200

404

500

{
  "stdout": "text",
  "stderr": "text"
}

Success

Retrieve environment of an instance

get

/instances/{instance_id}/config/environment

Path parameters

instance_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost/v2/instances/{instance_id}/config/environment'

200

404

[
  "text"
]

Success

Modify or create environment of an instance

put

/instances/{instance_id}/config/environment

Path parameters

instance_idstringrequired

Body

itemsstring

Pattern: ^[a-zA-Z]+(?:[a-zA-Z0-9_\-\.])*=.+$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost/v2/instances/{instance_id}/config/environment' \
  --header 'Content-Type: application/json' \
  --data '[null]'

200

201

400

404

No body

Environment for instance with this instance id is set

Delete environment of an instance

delete

/instances/{instance_id}/config/environment

Path parameters

instance_idstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost/v2/instances/{instance_id}/config/environment'

200

404

No body

Environment of instance with this instance_id was deleted

Retrieve exposed ports of an instance

get

/instances/{instance_id}/config/ports

Path parameters

instance_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost/v2/instances/{instance_id}/config/ports'

200

404

[
  "8001:8001",
  "5000",
  "5001-5008:6001-6008",
  "6001-6008"
]

Success

Delete exposed ports of an instance

delete

/instances/{instance_id}/config/ports

Path parameters

instance_idstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost/v2/instances/{instance_id}/config/ports'

200

404

No body

Exposed ports of instance with this instance_id was deleted

Access an editor of an app

get

/instances/{instance_id}/editor/{port}

Path parameters

instance_idstringrequired

Example: 01ab89ef

Pattern: ^[0-9a-f]{8}$

portinteger · min: 1 · max: 65535required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost/v2/instances/{instance_id}/editor/{port}'

302

400

404

500

No body

Found

Modify or create exposed ports of an instance

put

/instances/{instance_id}/config/ports

Path parameters

instance_idstringrequired

Body

itemsstring

Pattern:

(?=\d|:)^(?:([6][5][5][3][0-5]|[6][5][5][0-2][0-9]|[6][5][0-4][0-9]{2}|[6][0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3})(?:$|[:-](?=\d))|:)?(?:(?<=-)([6][5][5][3][0-5]|[6][5][5][0-2][0-9]|[6][5][0-4][0-9]{2}|[6][0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3})(?:$|:(?=\d)))?(?:(?<=:)([6][5][5][3][0-5]|[6][5][5][0-2][0-9]|[6][5][0-4][0-9]{2}|[6][0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3})(?:$|-(?=\d)))?(?:(?<=-)([6][5][5][3][0-5]|[6][5][5][0-2][0-9]|[6][5][0-4][0-9]{2}|[6][0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3}))?$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost/v2/instances/{instance_id}/config/ports' \
  --header 'Content-Type: application/json' \
  --data '["8001:8001","5000","5001-5008:6001-6008","6001-6008"]'

200

201

400

404

No body

Exposed ports for instance with this instance id is set