api.md

Usage

Types:

• MachineComputeUsage
• MachineComputeUsageRow
• MachineStorageUsage
• MachineStorageUsageRow
• OrgUsage

Methods:

• client.usage.retrieve({ ...params }) -> OrgUsage
• client.usage.machineCompute({ ...params }) -> MachineComputeUsage
• client.usage.machineStorage({ ...params }) -> MachineStorageUsage

Machines

Types:

• CreateParams
• LifecycleStatus
• Machine
• MachineList
• MachineListItem
• UpdateParams

Methods:

• client.machines.create({ ...params }) -> Machine
• client.machines.retrieve({ ...params }) -> Machine
• client.machines.update({ ...params }) -> Machine
• client.machines.list({ ...params }) -> MachineListItemsCursorPage
• client.machines.delete({ ...params }) -> Machine
• client.machines.sleep({ ...params }) -> Machine
• client.machines.wake({ ...params }) -> Machine
• client.machines.watch({ ...params }) -> Machine

Artifacts

Types:

• Artifact
• ArtifactList

Methods:

• client.machines.artifacts.retrieve({ ...params }) -> Artifact
• client.machines.artifacts.list({ ...params }) -> ArtifactsCursorPage
• client.machines.artifacts.delete({ ...params }) -> Artifact

Previews

Types:

• Preview
• PreviewCreateParams
• PreviewList

Methods:

• client.machines.previews.create({ ...params }) -> Preview
• client.machines.previews.retrieve({ ...params }) -> Preview
• client.machines.previews.list({ ...params }) -> PreviewsCursorPage
• client.machines.previews.delete({ ...params }) -> Preview

SSH

Types:

• SSHConnection
• SSHHostTrust
• SSHSession
• SSHSessionCreateParams
• SSHSessionList

Methods:

• client.machines.ssh.create({ ...params }) -> SSHSession
• client.machines.ssh.retrieve({ ...params }) -> SSHSession
• client.machines.ssh.list({ ...params }) -> SSHSessionsCursorPage
• client.machines.ssh.delete({ ...params }) -> SSHSession

Executions

Types:

• ArtifactRef
• Execution
• ExecutionCreateParams
• ExecutionEvent
• ExecutionEvents
• ExecutionList
• ExecutionOutput

Methods:

• client.machines.executions.create({ ...params }) -> Execution
• client.machines.executions.retrieve({ ...params }) -> Execution
• client.machines.executions.list({ ...params }) -> ExecutionsCursorPage
• client.machines.executions.delete({ ...params }) -> Execution
• client.machines.executions.events({ ...params }) -> ExecutionEventsCursorPage
• client.machines.executions.output({ ...params }) -> ExecutionOutput

Terminals

Types:

• Terminal
• TerminalClientEvent
• TerminalClosedEvent
• TerminalCreateParams
• TerminalErrorEvent
• TerminalInputEvent
• TerminalList
• TerminalOutputEvent
• TerminalResizeEvent
• TerminalServerEvent

Methods:

• client.machines.terminals.create({ ...params }) -> Terminal
• client.machines.terminals.retrieve({ ...params }) -> Terminal
• client.machines.terminals.list({ ...params }) -> TerminalsCursorPage
• client.machines.terminals.delete({ ...params }) -> Terminal