SoulFire LogoSoulFire

List instances

Lists all instances the current user has permission to view. Only instances where the user has READ_INSTANCE permission are returned. Returns summary information for each instance.

GET
/v1/instances

Lists all instances the current user has permission to view. Only instances where the user has READ_INSTANCE permission are returned. Returns summary information for each instance.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/instances"
{  "instances": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "friendlyName": "string",      "icon": "string",      "instancePermissions": [        {          "instancePermission": "INSTANCE_COMMAND_EXECUTION",          "granted": true        }      ],      "botSummary": {        "totalBots": 0,        "desiredBots": 0,        "onlineBots": 0,        "startingBots": 0,        "retryingBots": 0,        "failedBots": 0      }    }  ]}

How is this page?

Add instance proxy POST

Adds a proxy to the instance.

Create instance POST

Creates a new instance with the given friendly name.