Instances

PreviousConsole NextApps

Last updated 1 month ago

Was this helpful?

Query all instances of one or all Apps

get

Query parameters

appstringoptional

App to query instances for

versionstringoptional

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

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",
  "ports": [
    {
      "container": "8080",
      "host": "18080"
    }
  ],
  "volumes": [
    {
      "name": "var",
      "path": "/var/app"
    }
  ],
  "editors": [
    {
      "name": "Example app user settings",
      "url": "/api/v2/instances/abcd1234/editor/8080"
    }
  ]
}

Success

Delete a single instance

delete

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

Start an App instance

post

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

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

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": "0.0.0.0",
      "subnetMask": "0.0.0.0",
      "gateway": "0.0.0.0"
    }
  ],
  "devices": {
    "usb": [
      {
        "device": "text",
        "pid": 1,
        "port": "text",
        "vendor": "text",
        "vid": 1,
        "active": true,
        "connected": true
      }
    ]
  }
}

Success

Retrieve logs of an Instance

get

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

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

Delete environment of an instance

delete

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

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

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

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

Update or downgrade Instance to another App version

patch

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

Create new instance of an installed App

post

Body

appKeyobjectrequired

instanceNamestringoptional

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' \
  --data '{
    "appKey": {
      "name": "tech.flecs.app-1",
      "version": "1.2.3.4-f1"
    },
    "instanceName": "Smart home"
  }'

202

400

{
  "jobId": 17
}

Accepted

Update configuration of an Instance

post

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": "0.0.0.0",
        "subnetMask": "0.0.0.0",
        "gateway": "0.0.0.0"
      }
    ],
    "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": "0.0.0.0",
      "subnetMask": "0.0.0.0",
      "gateway": "0.0.0.0"
    }
  ],
  "devices": {
    "usb": [
      {
        "device": "text",
        "pid": 1,
        "port": "text",
        "vendor": "text",
        "vid": 1,
        "active": true,
        "connected": true
      }
    ]
  }
}

Success

Modify or create environment of an instance

put

Path parameters

instance_idstringrequired

Body

string[]optional

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 '[
    "text"
  ]'

200

201

400

404

No body

Environment for instance with this instance id is set

Modify or create exposed ports of an instance

put

Path parameters

instance_idstringrequired

Body

string[]optional

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

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

Query all instances of one or all Apps

Obtain details of an App instance

Delete a single instance

Start an App instance

Stop an App instance

Get configuration of an Instance

Retrieve logs of an Instance

Retrieve environment of an instance

Delete environment of an instance

Retrieve exposed ports of an instance

Delete exposed ports of an instance

Access an editor of an app

Update or downgrade Instance to another App version

Create new instance of an installed App

Show child attributes

Update configuration of an Instance

Show child attributes

Show child attributes

Modify or create environment of an instance

Modify or create exposed ports of an instance