api.md

Shared Types

from hypeman.types import SnapshotCompressionConfig

Health

Types:

from hypeman.types import HealthCheckResponse

Methods:

• client.health.check() -> HealthCheckResponse

Capabilities

Types:

from hypeman.types import (
    Capabilities,
    CapabilitiesDefaultRuntime,
    CapabilitiesHost,
    CapabilitiesImages,
    CapabilitiesNetwork,
    CapabilitiesRuntime,
    CapabilitiesServer,
)

Methods:

• client.capabilities.get() -> Capabilities

Images

Types:

from hypeman.types import Image, ImageListResponse

Methods:

• client.images.create(**params) -> Image
• client.images.list(**params) -> ImageListResponse
• client.images.delete(name) -> None
• client.images.get(name) -> Image

Instances

Types:

from hypeman.types import (
    AutoStandbyPolicy,
    AutoStandbyStatus,
    HealthCheck,
    HealthCheckExec,
    HealthCheckHTTP,
    HealthCheckTcp,
    Instance,
    InstanceHealthStatus,
    InstanceStats,
    PathInfo,
    PortMapping,
    RestartPolicy,
    RestartStatus,
    SetSnapshotScheduleRequest,
    SnapshotPolicy,
    SnapshotSchedule,
    SnapshotScheduleRetention,
    StandbyInstanceRequest,
    VolumeMount,
    WaitForStateResponse,
    InstanceListResponse,
    InstanceLogsResponse,
)

Methods:

• client.instances.create(**params) -> Instance
• client.instances.update(id, **params) -> Instance
• client.instances.list(**params) -> InstanceListResponse
• client.instances.delete(id) -> None
• client.instances.fork(id, **params) -> Instance
• client.instances.get(id) -> Instance
• client.instances.logs(id, **params) -> str
• client.instances.restore(id) -> Instance
• client.instances.standby(id, **params) -> Instance
• client.instances.start(id, **params) -> Instance
• client.instances.stat(id, **params) -> PathInfo
• client.instances.stats(id) -> InstanceStats
• client.instances.stop(id) -> Instance
• client.instances.wait(id, **params) -> WaitForStateResponse

AutoStandby

Methods:

• client.instances.auto_standby.hold(id) -> AutoStandbyStatus
• client.instances.auto_standby.status(id) -> AutoStandbyStatus

Volumes

Methods:

• client.instances.volumes.attach(volume_id, *, id, **params) -> Instance
• client.instances.volumes.detach(volume_id, *, id) -> Instance

Snapshots

Methods:

• client.instances.snapshots.create(id, **params) -> Snapshot
• client.instances.snapshots.restore(snapshot_id, *, id, **params) -> Instance

SnapshotSchedule

Methods:

• client.instances.snapshot_schedule.update(id, **params) -> SnapshotSchedule
• client.instances.snapshot_schedule.delete(id) -> None
• client.instances.snapshot_schedule.get(id) -> SnapshotSchedule

Snapshots

Types:

from hypeman.types import Snapshot, SnapshotKind, SnapshotListResponse

Methods:

• client.snapshots.list(**params) -> SnapshotListResponse
• client.snapshots.delete(snapshot_id) -> None
• client.snapshots.fork(snapshot_id, **params) -> Instance
• client.snapshots.get(snapshot_id) -> Snapshot

Volumes

Types:

from hypeman.types import Volume, VolumeAttachment, VolumeListResponse

Methods:

• client.volumes.create(**params) -> Volume
• client.volumes.list(**params) -> VolumeListResponse
• client.volumes.delete(id) -> None
• client.volumes.create_from_archive(body, **params) -> Volume
• client.volumes.get(id) -> Volume

Devices

Types:

from hypeman.types import (
    AvailableDevice,
    Device,
    DeviceType,
    DeviceListResponse,
    DeviceListAvailableResponse,
)

Methods:

• client.devices.create(**params) -> Device
• client.devices.retrieve(id) -> Device
• client.devices.list(**params) -> DeviceListResponse
• client.devices.delete(id) -> None
• client.devices.list_available() -> DeviceListAvailableResponse

Ingresses

Types:

from hypeman.types import Ingress, IngressMatch, IngressRule, IngressTarget, IngressListResponse

Methods:

• client.ingresses.create(**params) -> Ingress
• client.ingresses.list(**params) -> IngressListResponse
• client.ingresses.delete(id) -> None
• client.ingresses.get(id) -> Ingress

Resources

Types:

from hypeman.types import (
    DiskBreakdown,
    GPUProfile,
    GPUResourceStatus,
    MemoryReclaimAction,
    MemoryReclaimRequest,
    MemoryReclaimResponse,
    PassthroughDevice,
    ResourceAllocation,
    ResourceStatus,
    Resources,
)

Methods:

• client.resources.get() -> Resources
• client.resources.reclaim_memory(**params) -> MemoryReclaimResponse

Builders

Types:

from hypeman.types import Builder, BuilderStatus, BuilderListResponse

Methods:

• client.builders.create(**params) -> Builder
• client.builders.list(**params) -> BuilderListResponse
• client.builders.delete(id) -> None
• client.builders.get(id) -> Builder
• client.builders.prune(id) -> Builder

Builds

Types:

from hypeman.types import (
    Build,
    BuildEvent,
    BuildPolicy,
    BuildProvenance,
    BuildStatus,
    BuildListResponse,
)

Methods:

• client.builds.create(**params) -> Build
• client.builds.list(**params) -> BuildListResponse
• client.builds.cancel(id) -> None
• client.builds.events(id, **params) -> BuildEvent
• client.builds.get(id) -> Build

Pushes

Types:

from hypeman.types import CreatePushRequest, Push, PushCredentials, PushStatus, PushListResponse

Methods:

• client.pushes.create(**params) -> Push
• client.pushes.list() -> PushListResponse
• client.pushes.get(id) -> Push