Instances

Query all instances of one or all Apps

GEThttp://localhost/v2/instances

Query parameters

Response

200

Success

Body

application/json

instanceId*instance_id (string)

Example: "01ab89ef"

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

instanceName*instance_name (string)

Instance name

Example: "Smart home"

appKey*app_key (object)

status*instance_status (enum)

not createdrequestedresources readycreatedstoppedrunningorphanedunknown

desired*instance_status (enum)

not createdrequestedresources readycreatedstoppedrunningorphanedunknown

editorsinstance_editors (array of instance_editor (object))

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "instanceId": "01ab89ef",
    "instanceName": "Smart home",
    "appKey": {
      "name": "tech.flecs.app-1",
      "version": "1.2.3.4-f1"
    },
    "status": "not created",
    "desired": "not created",
    "editors": [
      {
        "name": "Example app user settings",
        "url": "/api/v2/instances/abcd1234/editor/8080"
      }
    ]
  }
]

Obtain details of an App instance

GEThttp://localhost/v2/instances/{instance_id}

Path parameters

instance_id*instance_id (string)

Example: "01ab89ef"

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

Response

200404500

Success

Body

application/json

instanceId*instance_id (string)

Example: "01ab89ef"

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

instanceName*instance_name (string)

Instance name

Example: "Smart home"

appKey*app_key (object)

status*instance_status (enum)

not createdrequestedresources readycreatedstoppedrunningorphanedunknown

desired*instance_status (enum)

not createdrequestedresources readycreatedstoppedrunningorphanedunknown

configFiles*instance_detail_config_files (array of instance_detail_config_file (object))

hostname*instance_detail_hostname (string)

Hostname of an instance

Example: "flecs-01ab89ef"

ipAddress*instance_detail_ip_address (string (ipv4))

IP address of an instance

Example: "172.21.0.3"

ports*array of instance_detail_port (object)

Allocated network ports of an instance

volumes*array of instance_detail_volume (object)

Automatic volumes of an instance

editorsinstance_editors (array of instance_editor (object))

Request

JavaScriptCurlPython

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

Response

200500

{
  "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"
    }
  ]
}

Update or downgrade Instance to another App version

PATCHhttp://localhost/v2/instances/{instance_id}

Path parameters

instance_id*instance_id (string)

Example: "01ab89ef"

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

Body

application/json

to*string

Response

202404

Accepted

Body

application/json

jobId*integer

Example: 17

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/instances/{instance_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "to": "text"
    }),
});
const data = await response.json();

Response

202

{
  "jobId": 17
}

Delete a single instance

DELETEhttp://localhost/v2/instances/{instance_id}

Path parameters

instance_id*instance_id (string)

Example: "01ab89ef"

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

Response

202404

Accepted

Body

application/json

jobId*integer

Example: 17

Request

JavaScriptCurlPython

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

Response

202

{
  "jobId": 17
}

Create new instance of an installed App

POSThttp://localhost/v2/instances/create

Body

application/json

appKey*app_key (object)

instanceNameinstance_name (string)

Instance name

Example: "Smart home"

Response

202400

Accepted

Body

application/json

jobId*integer

Example: 17

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/instances/create', {
    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

202400

{
  "jobId": 17
}

Start an App instance

POSThttp://localhost/v2/instances/{instance_id}/start

Path parameters

instance_id*instance_id (string)

Example: "01ab89ef"

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

Response

202404

Accepted

Body

application/json

jobId*integer

Example: 17

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/instances/{instance_id}/start', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

202

{
  "jobId": 17
}

Stop an App instance

POSThttp://localhost/v2/instances/{instance_id}/stop

Path parameters

instance_id*string

Instance id to delete

Response

202404

Accepted

Body

application/json

jobId*integer

Example: 17

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/instances/{instance_id}/stop', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

202

{
  "jobId": 17
}

Get configuration of an Instance

GEThttp://localhost/v2/instances/{instance_id}/config

Path parameters

instance_id*string

Response

200404

Success

Body

application/json

networkAdapters*array of instance_config_network_adapter (object)

devices*object

Request

JavaScriptCurlPython

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

Response

200

{
  "networkAdapters": [
    {
      "name": "text",
      "active": false,
      "connected": false,
      "ipAddress": "0.0.0.0",
      "subnetMask": "0.0.0.0",
      "gateway": "0.0.0.0"
    }
  ],
  "devices": {
    "usb": [
      {
        "device": "text",
        "pid": 0,
        "port": "text",
        "vendor": "text",
        "vid": 0,
        "active": false,
        "connected": false
      }
    ]
  }
}

Update configuration of an Instance

POSThttp://localhost/v2/instances/{instance_id}/config

Path parameters

instance_id*string

Body

application/json

networkAdapters*array of instance_config_network_adapter (object)

devices*object

Response

200404

Success

Body

application/json

networkAdapters*array of instance_config_network_adapter (object)

devices*object

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/instances/{instance_id}/config', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "networkAdapters": [
        {
          "name": "text",
          "active": false,
          "connected": false
        }
      ],
      "devices": {
        "usb": [
          {
            "device": "text",
            "pid": 0,
            "port": "text",
            "vendor": "text",
            "vid": 0,
            "active": false,
            "connected": false
          }
        ]
      }
    }),
});
const data = await response.json();

Response

200

{
  "networkAdapters": [
    {
      "name": "text",
      "active": false,
      "connected": false,
      "ipAddress": "0.0.0.0",
      "subnetMask": "0.0.0.0",
      "gateway": "0.0.0.0"
    }
  ],
  "devices": {
    "usb": [
      {
        "device": "text",
        "pid": 0,
        "port": "text",
        "vendor": "text",
        "vid": 0,
        "active": false,
        "connected": false
      }
    ]
  }
}

Retrieve logs of an Instance

GEThttp://localhost/v2/instances/{instance_id}/logs

Path parameters

instance_id*string

Response

200404500

Success

Body

application/json

stdout*string

stderr*string

Request

JavaScriptCurlPython

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

Response

200500

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

Retrieve environment of an instance

GEThttp://localhost/v2/instances/{instance_id}/config/environment

Path parameters

instance_id*string

Response

200404

Success

Body

application/json

itemsinstance_environment_variable (string)

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

Request

JavaScriptCurlPython

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

Response

200

[
  "text"
]

Modify or create environment of an instance

PUThttp://localhost/v2/instances/{instance_id}/config/environment

Path parameters

instance_id*string

Body

application/json

itemsinstance_environment_variable (string)

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

Response

200201400404

Environment for instance with this instance id is set

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/instances/{instance_id}/config/environment', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Response

400

{
  "additionalInfo": "text"
}

Delete environment of an instance

DELETEhttp://localhost/v2/instances/{instance_id}/config/environment

Path parameters

instance_id*string

Response

200404

Environment of instance with this instance_id was deleted

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/instances/{instance_id}/config/environment', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retrieve exposed ports of an instance

GEThttp://localhost/v2/instances/{instance_id}/config/ports

Path parameters

instance_id*string

Response

200404

Success

Body

application/json

itemsinstance_port_mapping (string)

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}))?$

Request

JavaScriptCurlPython

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

Response

200

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

Modify or create exposed ports of an instance

PUThttp://localhost/v2/instances/{instance_id}/config/ports

Path parameters

instance_id*string

Body

application/json

itemsinstance_port_mapping (string)

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}))?$

Response

200201400404

Exposed ports for instance with this instance id is set

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/instances/{instance_id}/config/ports', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "8001:8001",
      "5000",
      "5001-5008:6001-6008",
      "6001-6008"
    ]),
});
const data = await response.json();

Response

400

{
  "additionalInfo": "text"
}

Delete exposed ports of an instance

DELETEhttp://localhost/v2/instances/{instance_id}/config/ports

Path parameters

instance_id*string

Response

200404

Exposed ports of instance with this instance_id was deleted

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/instances/{instance_id}/config/ports', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Access an editor of an app

GEThttp://localhost/v2/instances/{instance_id}/editor/{port}

Path parameters

instance_id*instance_id (string)

Example: "01ab89ef"

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

port*port (integer)

Response

302400404500

Found

Headers

Request

JavaScriptCurlPython

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

Response

400404500

{
  "additionalInfo": "text"
}