Computer

Fetch a computer

get/computer/{computerId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/computer/{computerId}/fetch
  • Auth: HTTP bearer

Path parameters

computerIdstring required

The ID of the computer to retrieve

Response

The computer was retrieved successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

blueprintIdstring nullable

The ID of the blueprint

kind'shell' | 'desktop'

The kind of computer

status'stopped' | 'running'

The last known state of the computer

lastActiveAtstring date-time nullable

When the computer was last started, stopped or provisioned

Changes

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