api.md

Machines

Types:

from dedalus_sdk.types import (
    CreateParams,
    LifecycleStatus,
    Machine,
    MachineList,
    MachineListItem,
    UpdateParams,
)

Methods:

• client.machines.create(**params) -> Machine
• client.machines.retrieve(*, machine_id) -> Machine
• client.machines.update(*, machine_id, **params) -> Machine
• client.machines.list(**params) -> SyncCursorPage[MachineListItem]
• client.machines.delete(*, machine_id) -> Machine
• client.machines.sleep(*, machine_id) -> Machine
• client.machines.wake(*, machine_id) -> Machine
• client.machines.watch(*, machine_id) -> Machine

Artifacts

Types:

from dedalus_sdk.types.machines import Artifact, ArtifactList

Methods:

• client.machines.artifacts.retrieve(*, machine_id, artifact_id) -> Artifact
• client.machines.artifacts.list(*, machine_id, **params) -> SyncCursorPage[Artifact]
• client.machines.artifacts.delete(*, machine_id, artifact_id) -> Artifact

Previews

Types:

from dedalus_sdk.types.machines import Preview, PreviewCreateParams, PreviewList

Methods:

• client.machines.previews.create(*, machine_id, **params) -> Preview
• client.machines.previews.retrieve(*, machine_id, preview_id) -> Preview
• client.machines.previews.list(*, machine_id, **params) -> SyncCursorPage[Preview]
• client.machines.previews.delete(*, machine_id, preview_id) -> Preview

SSH

Types:

from dedalus_sdk.types.machines import (
    SSHConnection,
    SSHHostTrust,
    SSHSession,
    SSHSessionCreateParams,
    SSHSessionList,
)

Methods:

• client.machines.ssh.create(*, machine_id, **params) -> SSHSession
• client.machines.ssh.retrieve(*, machine_id, session_id) -> SSHSession
• client.machines.ssh.list(*, machine_id, **params) -> SyncCursorPage[SSHSession]
• client.machines.ssh.delete(*, machine_id, session_id) -> SSHSession

Executions

Types:

from dedalus_sdk.types.machines import (
    ArtifactRef,
    Execution,
    ExecutionCreateParams,
    ExecutionEvent,
    ExecutionEvents,
    ExecutionList,
    ExecutionOutput,
)

Methods:

• client.machines.executions.create(*, machine_id, **params) -> Execution
• client.machines.executions.retrieve(*, machine_id, execution_id) -> Execution
• client.machines.executions.list(*, machine_id, **params) -> SyncCursorPage[Execution]
• client.machines.executions.delete(*, machine_id, execution_id) -> Execution
• client.machines.executions.events(*, machine_id, execution_id, **params) -> SyncCursorPage[ExecutionEvent]
• client.machines.executions.output(*, machine_id, execution_id) -> ExecutionOutput

Terminals

Types:

from dedalus_sdk.types.machines import (
    Terminal,
    TerminalClientEvent,
    TerminalClosedEvent,
    TerminalCreateParams,
    TerminalErrorEvent,
    TerminalInputEvent,
    TerminalList,
    TerminalOutputEvent,
    TerminalResizeEvent,
    TerminalServerEvent,
)

Methods:

• client.machines.terminals.create(*, machine_id, **params) -> Terminal
• client.machines.terminals.retrieve(*, machine_id, terminal_id) -> Terminal
• client.machines.terminals.list(*, machine_id, **params) -> SyncCursorPage[Terminal]
• client.machines.terminals.delete(*, machine_id, terminal_id) -> Terminal