Instances

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

200

Success

application/json

get

/instances

GET /v2/instances HTTP/1.1
Host: localhost
Accept: */*

200

Success

[]

Obtain details of an App instance

get

Path parameters

instance_idstringRequiredExample: 01ab89efPattern: ^[0-9a-f]{8}$

Responses

200

Success

application/json

404

No instance with this instance_id found

500

Internal server error

application/json

get

/instances/{instance_id}

GET /v2/instances/{instance_id} HTTP/1.1
Host: localhost
Accept: */*

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

patch

Path parameters

instance_idstringRequiredExample: 01ab89efPattern: ^[0-9a-f]{8}$

Body

tostringRequired

Responses

202

Accepted

application/json

404

No instance with this instance_id found

patch

/instances/{instance_id}

PATCH /v2/instances/{instance_id} HTTP/1.1
Host: localhost
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "to": "text"
}

{
  "jobId": 17
}

Delete a single instance

delete

Path parameters

instance_idstringRequiredExample: 01ab89efPattern: ^[0-9a-f]{8}$

Responses

202

Accepted

application/json

404

No instance with this instance_id found

delete

/instances/{instance_id}

DELETE /v2/instances/{instance_id} HTTP/1.1
Host: localhost
Accept: */*

{
  "jobId": 17
}

Create new instance of an installed App

post

Body

instanceNamestringOptional

Instance name

Example: Smart home

Responses

202

Accepted

application/json

400

Malformed request

application/json

post

/instances/create

POST /v2/instances/create HTTP/1.1
Host: localhost
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "appKey": {
    "name": "tech.flecs.app-1",
    "version": "1.2.3.4-f1"
  },
  "instanceName": "Smart home"
}

{
  "jobId": 17
}

Start an App instance

post

Path parameters

instance_idstringRequiredExample: 01ab89efPattern: ^[0-9a-f]{8}$

Responses

202

Accepted

application/json

404

No instance with this instance_id found

post

/instances/{instance_id}/start

POST /v2/instances/{instance_id}/start HTTP/1.1
Host: localhost
Accept: */*

{
  "jobId": 17
}

Stop an App instance

post

Path parameters

instance_idstringRequired

Instance id to delete

Responses

202

Accepted

application/json

404

No instance with this instance_id found

post

/instances/{instance_id}/stop

POST /v2/instances/{instance_id}/stop HTTP/1.1
Host: localhost
Accept: */*

{
  "jobId": 17
}

Get configuration of an Instance

get

Path parameters

instance_idstringRequired

Responses

200

Success

application/json

404

No instance with this instance_id found

get

/instances/{instance_id}/config

GET /v2/instances/{instance_id}/config HTTP/1.1
Host: localhost
Accept: */*

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

Update configuration of an Instance

post

Path parameters

instance_idstringRequired

Body

Responses

200

Success

application/json

404

No instance with this instance_id found

post

/instances/{instance_id}/config

POST /v2/instances/{instance_id}/config HTTP/1.1
Host: localhost
Content-Type: application/json
Accept: */*
Content-Length: 248

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

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

Retrieve logs of an Instance

get

Path parameters

instance_idstringRequired

Responses

200

Success

application/json

404

No instance with this instance_id found

500

Internal server error

application/json

get

/instances/{instance_id}/logs

GET /v2/instances/{instance_id}/logs HTTP/1.1
Host: localhost
Accept: */*

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

Retrieve environment of an instance

get

Path parameters

instance_idstringRequired

Responses

200

Success

application/json

Responsestring[]

404

No instance with this instance_id found

get

/instances/{instance_id}/config/environment

GET /v2/instances/{instance_id}/config/environment HTTP/1.1
Host: localhost
Accept: */*

[
  "text"
]

Modify or create environment of an instance

put

Path parameters

instance_idstringRequired

Bodystring[]

string[]Optional

Responses

200

Environment for instance with this instance id is set

No content

201

Environment for instance with this instance id was created

400

Malformed request

application/json

404

No instance with this instance_id found

put

/instances/{instance_id}/config/environment

PUT /v2/instances/{instance_id}/config/environment HTTP/1.1
Host: localhost
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

No content

Delete environment of an instance

delete

Path parameters

instance_idstringRequired

Responses

200

Environment of instance with this instance_id was deleted

No content

404

No instance with this instance_id found

delete

/instances/{instance_id}/config/environment

DELETE /v2/instances/{instance_id}/config/environment HTTP/1.1
Host: localhost
Accept: */*

No content

Retrieve exposed ports of an instance

get

Path parameters

instance_idstringRequired

Responses

200

Success

application/json

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

404

No instance with this instance_id found

get

/instances/{instance_id}/config/ports

GET /v2/instances/{instance_id}/config/ports HTTP/1.1
Host: localhost
Accept: */*

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

Delete exposed ports of an instance

delete

Path parameters

instance_idstringRequired

Responses

200

Exposed ports of instance with this instance_id was deleted

No content

404

No instance with this instance_id found

delete

/instances/{instance_id}/config/ports

DELETE /v2/instances/{instance_id}/config/ports HTTP/1.1
Host: localhost
Accept: */*

No content

Access an editor of an app

get

Path parameters

instance_idstringRequiredExample: 01ab89efPattern: ^[0-9a-f]{8}$

portinteger · min: 1 · max: 65535Required

Responses

302

Found

400

Malformed request

application/json

404

Instance id or port not found

application/json

500

Internal server error

application/json

get

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

GET /v2/instances/{instance_id}/editor/{port} HTTP/1.1
Host: localhost
Accept: */*

No content

Modify or create exposed ports of an instance

put

Path parameters

instance_idstringRequired

Bodystring[]

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

Responses

200

Exposed ports for instance with this instance id is set

No content

201

Exposed ports for instance with this instance id was created

400

Malformed request

application/json

404

No instance with this instance_id found

put

/instances/{instance_id}/config/ports

PUT /v2/instances/{instance_id}/config/ports HTTP/1.1
Host: localhost
Content-Type: application/json
Accept: */*
Content-Length: 54

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

No content

PreviousConsole NextApps

Last updated 11 months ago

Was this helpful?

hashtagQuery all instances of one or all Apps

hashtagObtain details of an App instance

hashtagUpdate or downgrade Instance to another App version

hashtagDelete a single instance

hashtagCreate new instance of an installed App

hashtagStart an App instance

hashtagStop an App instance

hashtagGet configuration of an Instance

hashtagUpdate configuration of an Instance

hashtagRetrieve logs of an Instance

hashtagRetrieve environment of an instance

hashtagModify or create environment of an instance

hashtagDelete environment of an instance

hashtagRetrieve exposed ports of an instance

hashtagDelete exposed ports of an instance

hashtagAccess an editor of an app

hashtagModify or create exposed ports of an instance

Query all instances of one or all Apps

Obtain details of an App instance

Update or downgrade Instance to another App version

Delete a single instance

Create new instance of an installed App

Start an App instance

Stop an App instance

Get configuration of an Instance

Update configuration of an Instance

Retrieve logs of an Instance

Retrieve environment of an instance

Modify or create 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

Modify or create exposed ports of an instance