Get agent workspace state for an instance

Returns the desired agent workspace state for one Digital Twin instance. Requires admin access and institutions.edit RAP for the target instance.

GET /api/admin/institution/{id}/agent

Get agent workspace state for an instance

cURL

curl --request GET \
  --url https://pria.praxislxp.com/api/admin/institution/{id}/agent \
  --header 'x-access-token: <api-key>'

200

{
  "success": true,
  "idempotent": true,
  "agent": {
    "enabled": true,
    "preset": "<string>",
    "manifestYaml": "<string>",
    "manifestDigest": "<string>",
    "preferences": {
      "cpu": 2.125,
      "memoryMb": 4352,
      "storageGb": 52,
      "gui": true,
      "vncResolution": "1280x800"
    },
    "requestedBy": "<string>",
    "requestedAt": "2023-11-07T05:31:56Z",
    "provisionedAt": "2023-11-07T05:31:56Z",
    "lastError": "<string>"
  }
}

Authorizations

x-access-token · string · header · required

JWT token passed in x-access-token header

Path Parameters

id · string · required

Institution ID

Response

200

application/json

Agent workspace state

success · boolean

idempotent · boolean

agent · object

Show child attributes