Sign in
Instances

Query all instances of one or all Apps

get/instances

Request

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

Query parameters

appstring

App to query instances for

versionstring

App version to query instances for

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

Example response

[
  {
    "instanceId": "01ab89ef",
    "instanceName": "Smart home",
    "appKey": {
      "name": "tech.flecs.app-1",
      "version": "1.2.3.4-f1"
    },
    "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.