Sign in
Instances

Obtain details of an App instance

get/instances/{instance_id}

Request

  • Base URL: http://localhost/v2
  • URL: http://localhost/v2/instances/{instance_id}
  • Auth: HTTP bearer

Path parameters

instance_idstring required
Example:01ab89ef

Response

Success

instanceIdstring required
instanceNamestring required

Instance name

status'not created' | 'requested' | 'resources ready' | 'created' | 'stopped' | 'running' | 'orphaned' | 'unknown' required
desired'not created' | 'requested' | 'resources ready' | 'created' | 'stopped' | 'running' | 'orphaned' | 'unknown' required
hostnamestring required

Hostname of an instance

ipAddressstring ipv4 required

IP address of an instance

Example response

{
  "instanceId": "01ab89ef",
  "instanceName": "Smart home",
  "appKey": {
    "name": "tech.flecs.app-1",
    "version": "1.2.3.4-f1"
  },
  "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",
      "path_prefix": "db_admin_dashboard",
      "url": "/api/v2/instances/abcd1234/editor/8080"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.