Status

This endpoint returns all known information about a managed instance.

Request

The request must be made via POST and has a single required parameter.

| Name | Type | Description | | ---- | ---- | ----------- | | id | string | the name of the instance

Response

Upon successful validation of the request, the console returns the following:

{
  "id": "1",
  "archived": false,
  "deleted": false,
  "metadata": {
    "db": {
      "bender": {
        "id": "db-dfe",
        "host": "localhost",
        "port": 3306,
        "username": "ud342aeace774e4f",
        "password": "68e0f3477c0894fe0c83b2385f6e1a8bcc8ffd75",
        "driver": "mysql",
        "default-database-name": "",
        "database": "bender",
        "charset": "utf8",
        "collation": "utf8_unicode_ci",
        "prefix": "",
        "db-server-id": "db-dfe"
      }
    },
    "env": {
      "cluster-id": "cluster-dfe",
      "instance-id": "bender",
      "default-domain": "dfe.3wipes.com",
      "signature-method": "sha256",
      "storage-root": "/data/storage",
      "console-api-url": "http://console.dfe.3wipes.com/api/v1/ops",
      "console-api-key": "NjY0MDdiMmY0ZmI2M2YwMjEzY2FhZGZjODAxNTRiNTVkNTQ3Y2Y2Mjc2MjMyM2JhNzA0ZWFmOTM3NGNhODcwMA",
      "client-id": "3a44d0f6bd4765911f8d86f59cc3e35b01d00b7370da466ab41705cd7a3f2b44",
      "client-secret": "b39474fdd0963c29c6a0f370ee1d1a893f5023c471d75acce3ad0f94d6d52777"
      "audit-host": "lps-east-1.fabric.dreamfactory.com",
      "audit-port": 12202,
      "audit-message-format": 0
    },
    "paths": {
      "storage-root": "/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0",
      "storage-path": "/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0/bender",
      "private-path": "/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0/bender/.private",
      "owner-private-path": "/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0/.private",
      "snapshot-path": "/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0/.private/snapshots",
      "trash-path": "/data/trash"
    },
    "storage-map": {
      "zone": "local",
      "partition": "1e",
      "root-hash": "1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0"
    },
    "audit": {
      "user-id": 1,
      "owner-email-address": "[email protected]",
      "instance-id": "bender",
      "cluster-id": "cluster-dfe",
      "web-server-id": "web-dfe",
      "db-server-id": "db-dfe",
      "app-server-id": "app-dfe"
    },
    "limits": {
      "api": []
    },
    "_custodian": [],
    "_operations": []
  },
  "root-storage-path": "/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0",
  "storage-path": "/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0/bender",
  "owner-private-path": "/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0/.private",
  "private-path": "/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0/bender/.private",
  "home-links": {
    "instance": [
      {
        "name": "Welcome",
        "href": "//www.dreamfactory.com/in_product_welcome.html",
        "attributes": []
      },
      {
        "name": "Resources",
        "href": "//www.dreamfactory.com/in_product_resources.html",
        "attributes": []
      },
      {
        "name": "Download",
        "href": "//www.dreamfactory.com/in_product_downloads.html",
        "attributes": []
      }
    ],
    "console": [
      {
        "name": "Welcome",
        "href": "//www.dreamfactory.com/enterprise_welcome.html",
        "attributes": []
      },
      {
        "name": "Resources",
        "href": "//www.dreamfactory.com/enterprise_resources.html",
        "attributes": []
      },
      {
        "name": "Support",
        "href": "//www.dreamfactory.com/enterprise_support.html",
        "attributes": []
      }
    ],
    "dashboard": [
      {
        "name": "Welcome",
        "href": "//www.dreamfactory.com/dfe-dashboard-welcome.html",
        "attributes": []
      }
    ]
  },
  "instance-id": "bender",
  "vendor-instance-id": "bender",
  "instance-name": "bender",
  "instance-state": 2,
  "vendor-state": null,
  "vendor-state-name": null,
  "start-date": "2015-10-18 15:27:18",
  "create-date": "2015-10-18 15:27:18",
  "instance_name_text": "bender",
  "instance_id_text": "bender",
  "state_nbr": 2,
  "vendor_state_nbr": null,
  "vendor_state_text": null,
  "provision_ind": true,
  "trial_instance_ind": true,
  "deprovision_ind": false,
  "start_date": "2015-10-18 15:27:18",
  "create_date": "2015-10-18 15:27:18",
  "instanceName": "bender",
  "instanceId": "1",
  "vendorInstanceId": "bender",
  "instanceState": 2,
  "vendorState": null,
  "vendorStateName": null,
  "provisioned": true,
  "trial": true,
  "deprovisioned": false,
  "startDate": "2015-10-18 15:27:18",
  "createDate": "2015-10-18 15:27:18"
}

Notes

The reason for the data being repeated in various forms is to allow an easier transition of the existing hosted system to use this new console without having to change any DSP code. Only the endpoint needs to change and this is in a configuration file. Once the original hosted system is dismantled, the result of this API call will be consolidated and all duplicates will be removed.

The `metadata` property contains the original information supplied and/or created when the instance was provisioned. This data is stored in the `instance_data_text` column of the Instance table.

All paths, such as `storage-path` and `private-path` are relative to the server's currently configured `storage root`. This value may be found in `metadata.env.storage-root`. Thus, the storage path's `/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0/bender` absolute location is `/data/storage/local/1e/1ecaec8d73e038910b69b810ec54441c6262436c89905ad10554bbfd6bf3d3d0/bender`.

The `metadata.audit` is intended to be sent verbatim to the Managed class for reporting purposes.