TypeScript SDK API

Version 0.5.0. Generated source.

Machines

Types:

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

Methods:

• client.machines.create({ ...params }) -> Machine
• client.machines.retrieve({ ...params }) -> MachineRetrieveResponse
• 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

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