CollabVM API v2

Here are various endpoints that can be used to pull data from CollabVM

All endpoints can be accessed at https://cvmapi.elijahr.dev

VM List

GET /api/v2/list

Get a list of VMs the bot has access to, and their node IDs.

GET /api/v1/vms/{vm}

Pull some data about the current state of the VM.

Returns the following data, in JSON format:

id: Node ID of the VM
users: Current online users on the VM. Each user is an object with the following properties:
- username: Username of the user
- rank: 0 (Unregistered), 1 (Registered), 2 (Admin), or 3 (Mod)
- country: ISO country code for this user, if available

GET /api/v1/vms/{vm}/screenshot

Grab a screenshot of the VM. Returns it as a WEBP image.

GET /api/v1/chat

Grab chats from the logs. Data goes back to 06/30/2022.

Accepts the following optional query parameters:

vm: Filter to one VM. Formatted as VM{1-8}
username: Filter to one username
from: Filter to messages after the specified timestamp, in ISO format. Times in UTC
to: Filter to messages before the specified timestamp, in ISO format. Times in UTC
limit: Truncate result to n messages. Must be a positive integer. If neither limit, from, or to are set, this defaults to 100.
search: Message search query. Whole words only. Use quotes to search for phrases.

If you do not provide any query parameters it simply returns the last 100 messages logged.

Returns a JSON array with an entry for each message. A message is represented by an object with the following properties: