VMs

Get a VM's console log tail

Changed on

Returns the tail of a VM's serial console, capped to a bounded size; a VM with no logs yet answers 200 with found false and a message, not an error. A transient state (no allocation yet, logs temporarily unavailable) answers 200 with found false, so a polling UI renders a state instead of an error. The cap is the one pod logs use, so a long-running console never exceeds the response size orl reads.

Also works for pods: orl vms logs and orl pods logs are the same operation pair with different id params, and orl vms <verb> <pod-id> reaches every other pod lifecycle command.

Requires the compute.read permission. See Permissions for the roles and API key permissions that include it.

get/api/nomad/vms/{vmId}/logs

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/api/nomad/vms/{vmId}/logs
  • Auth
    HTTP bearer

Path parameters

vmIdstring required

Response

OK

contentstring nullable

The console's tail, when found is true.

foundboolean required
messagestring

Present when found is false (or on other soft states); human-readable.

Changes