hypeman

package module

Go to main page

Versions in this module

v0

v0.18.0

Apr 17, 2026

Changes in this version

type InstanceStandbyParams

+ StandbyInstanceRequest StandbyInstanceRequestParam

type SnapshotPolicy

+ StandbyCompressionDelay string

type SnapshotPolicyParam

+ StandbyCompressionDelay param.Opt[string]

+ type StandbyInstanceRequestParam struct

+ Compression shared.SnapshotCompressionConfigParam

+ CompressionDelay param.Opt[string]

+ func (r *StandbyInstanceRequestParam) UnmarshalJSON(data []byte) error

+ func (r StandbyInstanceRequestParam) MarshalJSON() (data []byte, err error)

v0.17.0

Apr 8, 2026

Changes in this version

+ type AutoStandbyPolicy struct

+ Enabled bool

+ IdleTimeout string

+ IgnoreDestinationPorts []int64

+ IgnoreSourceCidrs []string

+ JSON struct{ ... }

+ func (r *AutoStandbyPolicy) UnmarshalJSON(data []byte) error

+ func (r AutoStandbyPolicy) RawJSON() string

+ func (r AutoStandbyPolicy) ToParam() AutoStandbyPolicyParam

+ type AutoStandbyPolicyParam struct

+ Enabled param.Opt[bool]

+ IdleTimeout param.Opt[string]

+ IgnoreDestinationPorts []int64

+ IgnoreSourceCidrs []string

+ func (r *AutoStandbyPolicyParam) UnmarshalJSON(data []byte) error

+ func (r AutoStandbyPolicyParam) MarshalJSON() (data []byte, err error)

+ type AutoStandbyStatus struct

+ ActiveInboundConnections int64

+ Configured bool

+ CountdownRemaining string

+ Eligible bool

+ Enabled bool

+ IdleSince time.Time

+ IdleTimeout string

+ JSON struct{ ... }

+ LastInboundActivityAt time.Time

+ NextStandbyAt time.Time

+ Reason AutoStandbyStatusReason

+ Status AutoStandbyStatusStatus

+ Supported bool

+ TrackingMode string

+ func (r *AutoStandbyStatus) UnmarshalJSON(data []byte) error

+ func (r AutoStandbyStatus) RawJSON() string

+ type AutoStandbyStatusReason string

+ const AutoStandbyStatusReasonActiveInboundConnections

+ const AutoStandbyStatusReasonHasVgpu

+ const AutoStandbyStatusReasonIdleTimeoutNotElapsed

+ const AutoStandbyStatusReasonInstanceNotRunning

+ const AutoStandbyStatusReasonMissingIP

+ const AutoStandbyStatusReasonNetworkDisabled

+ const AutoStandbyStatusReasonObserverError

+ const AutoStandbyStatusReasonPolicyDisabled

+ const AutoStandbyStatusReasonPolicyMissing

+ const AutoStandbyStatusReasonReadyForStandby

+ const AutoStandbyStatusReasonUnsupportedPlatform

+ type AutoStandbyStatusStatus string

+ const AutoStandbyStatusStatusActive

+ const AutoStandbyStatusStatusDisabled

+ const AutoStandbyStatusStatusError

+ const AutoStandbyStatusStatusIdleCountdown

+ const AutoStandbyStatusStatusIneligible

+ const AutoStandbyStatusStatusReadyForStandby

+ const AutoStandbyStatusStatusStandbyRequested

+ const AutoStandbyStatusStatusUnsupported

type Instance

+ AutoStandby AutoStandbyPolicy

+ type InstanceAutoStandbyService struct

+ Options []option.RequestOption

+ func NewInstanceAutoStandbyService(opts ...option.RequestOption) (r InstanceAutoStandbyService)

+ func (r *InstanceAutoStandbyService) Status(ctx context.Context, id string, opts ...option.RequestOption) (res *AutoStandbyStatus, err error)

type InstanceNewParams

+ AutoStandby AutoStandbyPolicyParam

type InstanceService

+ AutoStandby InstanceAutoStandbyService

+ SnapshotSchedule InstanceSnapshotScheduleService

+ func (r *InstanceService) Wait(ctx context.Context, id string, query InstanceWaitParams, ...) (res *WaitForStateResponse, err error)

+ type InstanceSnapshotScheduleService struct

+ Options []option.RequestOption

+ func NewInstanceSnapshotScheduleService(opts ...option.RequestOption) (r InstanceSnapshotScheduleService)

+ func (r *InstanceSnapshotScheduleService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)

+ func (r *InstanceSnapshotScheduleService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *SnapshotSchedule, err error)

+ func (r *InstanceSnapshotScheduleService) Update(ctx context.Context, id string, body InstanceSnapshotScheduleUpdateParams, ...) (res *SnapshotSchedule, err error)

+ type InstanceSnapshotScheduleUpdateParams struct

+ SetSnapshotScheduleRequest SetSnapshotScheduleRequestParam

+ func (r *InstanceSnapshotScheduleUpdateParams) UnmarshalJSON(data []byte) error

+ func (r InstanceSnapshotScheduleUpdateParams) MarshalJSON() (data []byte, err error)

type InstanceUpdateParams

+ AutoStandby AutoStandbyPolicyParam

+ type InstanceWaitParams struct

+ State InstanceWaitParamsState

+ Timeout param.Opt[string]

+ func (r InstanceWaitParams) URLQuery() (v url.Values, err error)

+ type InstanceWaitParamsState string

+ const InstanceWaitParamsStateCreated

+ const InstanceWaitParamsStateInitializing

+ const InstanceWaitParamsStatePaused

+ const InstanceWaitParamsStateRunning

+ const InstanceWaitParamsStateShutdown

+ const InstanceWaitParamsStateStandby

+ const InstanceWaitParamsStateStopped

+ const InstanceWaitParamsStateUnknown

+ type SetSnapshotScheduleRequestParam struct

+ Interval string

+ Metadata map[string]string

+ NamePrefix param.Opt[string]

+ Retention SnapshotScheduleRetentionParam

+ func (r *SetSnapshotScheduleRequestParam) UnmarshalJSON(data []byte) error

+ func (r SetSnapshotScheduleRequestParam) MarshalJSON() (data []byte, err error)

+ type SnapshotSchedule struct

+ CreatedAt time.Time

+ InstanceID string

+ Interval string

+ JSON struct{ ... }

+ LastError string

+ LastRunAt time.Time

+ LastSnapshotID string

+ Metadata map[string]string

+ NamePrefix string

+ NextRunAt time.Time

+ Retention SnapshotScheduleRetention

+ UpdatedAt time.Time

+ func (r *SnapshotSchedule) UnmarshalJSON(data []byte) error

+ func (r SnapshotSchedule) RawJSON() string

+ type SnapshotScheduleRetention struct

+ JSON struct{ ... }

+ MaxAge string

+ MaxCount int64

+ func (r *SnapshotScheduleRetention) UnmarshalJSON(data []byte) error

+ func (r SnapshotScheduleRetention) RawJSON() string

+ func (r SnapshotScheduleRetention) ToParam() SnapshotScheduleRetentionParam

+ type SnapshotScheduleRetentionParam struct

+ MaxAge param.Opt[string]

+ MaxCount param.Opt[int64]

+ func (r *SnapshotScheduleRetentionParam) UnmarshalJSON(data []byte) error

+ func (r SnapshotScheduleRetentionParam) MarshalJSON() (data []byte, err error)

+ type WaitForStateResponse struct

+ JSON struct{ ... }

+ State WaitForStateResponseState

+ StateError string

+ TimedOut bool

+ func (r *WaitForStateResponse) UnmarshalJSON(data []byte) error

+ func (r WaitForStateResponse) RawJSON() string

+ type WaitForStateResponseState string

+ const WaitForStateResponseStateCreated

+ const WaitForStateResponseStateInitializing

+ const WaitForStateResponseStatePaused

+ const WaitForStateResponseStateRunning

+ const WaitForStateResponseStateShutdown

+ const WaitForStateResponseStateStandby

+ const WaitForStateResponseStateStopped

+ const WaitForStateResponseStateUnknown

v0.16.0

Mar 23, 2026

Changes in this version

+ const SnapshotCompressionConfigAlgorithmLz4

+ const SnapshotCompressionConfigAlgorithmZstd

type Build

+ Tags map[string]string

+ type BuildListParams struct

+ Tags map[string]string

+ func (r BuildListParams) URLQuery() (v url.Values, err error)

type BuildNewParams

+ Tags param.Opt[string]

type Client

+ Snapshots SnapshotService

type Device

+ Tags map[string]string

+ type DeviceListParams struct

+ Tags map[string]string

+ func (r DeviceListParams) URLQuery() (v url.Values, err error)

type DeviceNewParams

+ Tags map[string]string

type Image

+ Tags map[string]string

+ type ImageListParams struct

+ Tags map[string]string

+ func (r ImageListParams) URLQuery() (v url.Values, err error)

type ImageNewParams

+ Tags map[string]string

type Ingress

+ Tags map[string]string

+ type IngressListParams struct

+ Tags map[string]string

+ func (r IngressListParams) URLQuery() (v url.Values, err error)

type IngressNewParams

+ Tags map[string]string

type Instance

+ SnapshotPolicy SnapshotPolicy

+ Tags map[string]string

type InstanceListParams

+ Tags map[string]string

type InstanceListParamsState

+ const InstanceListParamsStateInitializing

type InstanceNewParams

+ Credentials map[string]InstanceNewParamsCredential

+ SnapshotPolicy SnapshotPolicyParam

+ Tags map[string]string

+ type InstanceNewParamsCredential struct

+ Inject []InstanceNewParamsCredentialInject

+ Source InstanceNewParamsCredentialSource

+ func (r *InstanceNewParamsCredential) UnmarshalJSON(data []byte) error

+ func (r InstanceNewParamsCredential) MarshalJSON() (data []byte, err error)

+ type InstanceNewParamsCredentialInject struct

+ As InstanceNewParamsCredentialInjectAs

+ Hosts []string

+ func (r *InstanceNewParamsCredentialInject) UnmarshalJSON(data []byte) error

+ func (r InstanceNewParamsCredentialInject) MarshalJSON() (data []byte, err error)

+ type InstanceNewParamsCredentialInjectAs struct

+ Format string

+ Header string

+ func (r *InstanceNewParamsCredentialInjectAs) UnmarshalJSON(data []byte) error

+ func (r InstanceNewParamsCredentialInjectAs) MarshalJSON() (data []byte, err error)

+ type InstanceNewParamsCredentialSource struct

+ Env string

+ func (r *InstanceNewParamsCredentialSource) UnmarshalJSON(data []byte) error

+ func (r InstanceNewParamsCredentialSource) MarshalJSON() (data []byte, err error)

type InstanceNewParamsNetwork

+ Egress InstanceNewParamsNetworkEgress

+ type InstanceNewParamsNetworkEgress struct

+ Enabled param.Opt[bool]

+ Enforcement InstanceNewParamsNetworkEgressEnforcement

+ func (r *InstanceNewParamsNetworkEgress) UnmarshalJSON(data []byte) error

+ func (r InstanceNewParamsNetworkEgress) MarshalJSON() (data []byte, err error)

+ type InstanceNewParamsNetworkEgressEnforcement struct

+ Mode string

+ func (r *InstanceNewParamsNetworkEgressEnforcement) UnmarshalJSON(data []byte) error

+ func (r InstanceNewParamsNetworkEgressEnforcement) MarshalJSON() (data []byte, err error)

type InstanceService

+ Snapshots InstanceSnapshotService

+ func (r *InstanceService) Update(ctx context.Context, id string, body InstanceUpdateParams, ...) (res *Instance, err error)

+ type InstanceSnapshotNewParams struct

+ Compression shared.SnapshotCompressionConfigParam

+ Kind SnapshotKind

+ Name param.Opt[string]

+ Tags map[string]string

+ func (r *InstanceSnapshotNewParams) UnmarshalJSON(data []byte) error

+ func (r InstanceSnapshotNewParams) MarshalJSON() (data []byte, err error)

+ type InstanceSnapshotRestoreParams struct

+ ID string

+ TargetHypervisor InstanceSnapshotRestoreParamsTargetHypervisor

+ TargetState InstanceSnapshotRestoreParamsTargetState

+ func (r *InstanceSnapshotRestoreParams) UnmarshalJSON(data []byte) error

+ func (r InstanceSnapshotRestoreParams) MarshalJSON() (data []byte, err error)

+ type InstanceSnapshotRestoreParamsTargetHypervisor string

+ const InstanceSnapshotRestoreParamsTargetHypervisorCloudHypervisor

+ const InstanceSnapshotRestoreParamsTargetHypervisorFirecracker

+ const InstanceSnapshotRestoreParamsTargetHypervisorQemu

+ const InstanceSnapshotRestoreParamsTargetHypervisorVz

+ type InstanceSnapshotRestoreParamsTargetState string

+ const InstanceSnapshotRestoreParamsTargetStateRunning

+ const InstanceSnapshotRestoreParamsTargetStateStandby

+ const InstanceSnapshotRestoreParamsTargetStateStopped

+ type InstanceSnapshotService struct

+ Options []option.RequestOption

+ func NewInstanceSnapshotService(opts ...option.RequestOption) (r InstanceSnapshotService)

+ func (r *InstanceSnapshotService) New(ctx context.Context, id string, body InstanceSnapshotNewParams, ...) (res *Snapshot, err error)

+ func (r *InstanceSnapshotService) Restore(ctx context.Context, snapshotID string, params InstanceSnapshotRestoreParams, ...) (res *Instance, err error)

+ type InstanceStandbyParams struct

+ Compression shared.SnapshotCompressionConfigParam

+ func (r *InstanceStandbyParams) UnmarshalJSON(data []byte) error

+ func (r InstanceStandbyParams) MarshalJSON() (data []byte, err error)

type InstanceState

+ const InstanceStateInitializing

+ type InstanceUpdateParams struct

+ Env map[string]string

+ func (r *InstanceUpdateParams) UnmarshalJSON(data []byte) error

+ func (r InstanceUpdateParams) MarshalJSON() (data []byte, err error)

+ type MemoryReclaimAction struct

+ AppliedReclaimBytes int64

+ AssignedMemoryBytes int64

+ Error string

+ Hypervisor MemoryReclaimActionHypervisor

+ InstanceID string

+ InstanceName string

+ JSON struct{ ... }

+ PlannedTargetGuestMemoryBytes int64

+ PreviousTargetGuestMemoryBytes int64

+ ProtectedFloorBytes int64

+ Status string

+ TargetGuestMemoryBytes int64

+ func (r *MemoryReclaimAction) UnmarshalJSON(data []byte) error

+ func (r MemoryReclaimAction) RawJSON() string

+ type MemoryReclaimActionHypervisor string

+ const MemoryReclaimActionHypervisorCloudHypervisor

+ const MemoryReclaimActionHypervisorFirecracker

+ const MemoryReclaimActionHypervisorQemu

+ const MemoryReclaimActionHypervisorVz

+ type MemoryReclaimRequestParam struct

+ DryRun param.Opt[bool]

+ HoldFor param.Opt[string]

+ Reason param.Opt[string]

+ ReclaimBytes int64

+ func (r *MemoryReclaimRequestParam) UnmarshalJSON(data []byte) error

+ func (r MemoryReclaimRequestParam) MarshalJSON() (data []byte, err error)

+ type MemoryReclaimResponse struct

+ Actions []MemoryReclaimAction

+ AppliedReclaimBytes int64

+ HoldUntil time.Time

+ HostAvailableBytes int64

+ HostPressureState MemoryReclaimResponseHostPressureState

+ JSON struct{ ... }

+ PlannedReclaimBytes int64

+ RequestedReclaimBytes int64

+ func (r *MemoryReclaimResponse) UnmarshalJSON(data []byte) error

+ func (r MemoryReclaimResponse) RawJSON() string

+ type MemoryReclaimResponseHostPressureState string

+ const MemoryReclaimResponseHostPressureStateHealthy

+ const MemoryReclaimResponseHostPressureStatePressure

+ type ResourceReclaimMemoryParams struct

+ MemoryReclaimRequest MemoryReclaimRequestParam

+ func (r *ResourceReclaimMemoryParams) UnmarshalJSON(data []byte) error

+ func (r ResourceReclaimMemoryParams) MarshalJSON() (data []byte, err error)

type ResourceService

+ func (r *ResourceService) ReclaimMemory(ctx context.Context, body ResourceReclaimMemoryParams, ...) (res *MemoryReclaimResponse, err error)

+ type Snapshot struct

+ CompressedSizeBytes int64

+ Compression shared.SnapshotCompressionConfig

+ CompressionError string

+ CompressionState SnapshotCompressionState

+ CreatedAt time.Time

+ ID string

+ JSON struct{ ... }

+ Kind SnapshotKind

+ Name string

+ SizeBytes int64

+ SourceHypervisor SnapshotSourceHypervisor

+ SourceInstanceID string

+ SourceInstanceName string

+ Tags map[string]string

+ UncompressedSizeBytes int64

+ func (r *Snapshot) UnmarshalJSON(data []byte) error

+ func (r Snapshot) RawJSON() string

+ type SnapshotCompressionConfig = shared.SnapshotCompressionConfig

+ type SnapshotCompressionConfigAlgorithm = shared.SnapshotCompressionConfigAlgorithm

+ type SnapshotCompressionConfigParam = shared.SnapshotCompressionConfigParam

+ type SnapshotCompressionState string

+ const SnapshotCompressionStateCompressed

+ const SnapshotCompressionStateCompressing

+ const SnapshotCompressionStateError

+ const SnapshotCompressionStateNone

+ type SnapshotForkParams struct

+ Name string

+ TargetHypervisor SnapshotForkParamsTargetHypervisor

+ TargetState SnapshotForkParamsTargetState

+ func (r *SnapshotForkParams) UnmarshalJSON(data []byte) error

+ func (r SnapshotForkParams) MarshalJSON() (data []byte, err error)

+ type SnapshotForkParamsTargetHypervisor string

+ const SnapshotForkParamsTargetHypervisorCloudHypervisor

+ const SnapshotForkParamsTargetHypervisorFirecracker

+ const SnapshotForkParamsTargetHypervisorQemu

+ const SnapshotForkParamsTargetHypervisorVz

+ type SnapshotForkParamsTargetState string

+ const SnapshotForkParamsTargetStateRunning

+ const SnapshotForkParamsTargetStateStandby

+ const SnapshotForkParamsTargetStateStopped

+ type SnapshotKind string

+ const SnapshotKindStandby

+ const SnapshotKindStopped

+ type SnapshotListParams struct

+ Kind SnapshotKind

+ Name param.Opt[string]

+ SourceInstanceID param.Opt[string]

+ Tags map[string]string

+ func (r SnapshotListParams) URLQuery() (v url.Values, err error)

+ type SnapshotPolicy struct

+ Compression shared.SnapshotCompressionConfig

+ JSON struct{ ... }

+ func (r *SnapshotPolicy) UnmarshalJSON(data []byte) error

+ func (r SnapshotPolicy) RawJSON() string

+ func (r SnapshotPolicy) ToParam() SnapshotPolicyParam

+ type SnapshotPolicyParam struct

+ Compression shared.SnapshotCompressionConfigParam

+ func (r *SnapshotPolicyParam) UnmarshalJSON(data []byte) error

+ func (r SnapshotPolicyParam) MarshalJSON() (data []byte, err error)

+ type SnapshotService struct

+ Options []option.RequestOption

+ func NewSnapshotService(opts ...option.RequestOption) (r SnapshotService)

+ func (r *SnapshotService) Delete(ctx context.Context, snapshotID string, opts ...option.RequestOption) (err error)

+ func (r *SnapshotService) Fork(ctx context.Context, snapshotID string, body SnapshotForkParams, ...) (res *Instance, err error)

+ func (r *SnapshotService) Get(ctx context.Context, snapshotID string, opts ...option.RequestOption) (res *Snapshot, err error)

+ func (r *SnapshotService) List(ctx context.Context, query SnapshotListParams, opts ...option.RequestOption) (res *[]Snapshot, err error)

+ type SnapshotSourceHypervisor string

+ const SnapshotSourceHypervisorCloudHypervisor

+ const SnapshotSourceHypervisorFirecracker

+ const SnapshotSourceHypervisorQemu

+ const SnapshotSourceHypervisorVz

type Volume

+ Tags map[string]string

+ type VolumeListParams struct

+ Tags map[string]string

+ func (r VolumeListParams) URLQuery() (v url.Values, err error)

type VolumeNewFromArchiveParams

+ Tags map[string]string

type VolumeNewParams

+ Tags map[string]string

v0.15.0

Mar 4, 2026

Changes in this version

+ type InstanceForkParams struct

+ FromRunning param.Opt[bool]

+ Name string

+ TargetState InstanceForkParamsTargetState

+ func (r *InstanceForkParams) UnmarshalJSON(data []byte) error

+ func (r InstanceForkParams) MarshalJSON() (data []byte, err error)

+ type InstanceForkParamsTargetState string

+ const InstanceForkParamsTargetStateRunning

+ const InstanceForkParamsTargetStateStandby

+ const InstanceForkParamsTargetStateStopped

type InstanceService

+ func (r *InstanceService) Fork(ctx context.Context, id string, body InstanceForkParams, ...) (res *Instance, err error)

+ func (r *InstanceService) Stats(ctx context.Context, id string, opts ...option.RequestOption) (res *InstanceStats, err error)

+ type InstanceStats struct

+ AllocatedMemoryBytes int64

+ AllocatedVcpus int64

+ CPUSeconds float64

+ InstanceID string

+ InstanceName string

+ JSON struct{ ... }

+ MemoryRssBytes int64

+ MemoryUtilizationRatio float64

+ MemoryVmsBytes int64

+ NetworkRxBytes int64

+ NetworkTxBytes int64

+ func (r *InstanceStats) UnmarshalJSON(data []byte) error

+ func (r InstanceStats) RawJSON() string

v0.14.0

Mar 2, 2026

Changes in this version

type InstanceHypervisor

+ const InstanceHypervisorFirecracker

type InstanceNewParamsHypervisor

+ const InstanceNewParamsHypervisorFirecracker

v0.13.0

Feb 26, 2026

Changes in this version

type BuildNewParams

+ CPUs param.Opt[int64]

+ MemoryMB param.Opt[int64]

v0.12.0

Feb 26, 2026

Changes in this version

+ type InstanceListParams struct

+ Metadata map[string]string

+ State InstanceListParamsState

+ func (r InstanceListParams) URLQuery() (v url.Values, err error)

+ type InstanceListParamsState string

+ const InstanceListParamsStateCreated

+ const InstanceListParamsStatePaused

+ const InstanceListParamsStateRunning

+ const InstanceListParamsStateShutdown

+ const InstanceListParamsStateStandby

+ const InstanceListParamsStateStopped

+ const InstanceListParamsStateUnknown

v0.11.1

Feb 18, 2026

v0.11.0

Feb 15, 2026

Changes in this version

type BuildNewParams

+ ImageName param.Opt[string]

v0.10.0

Feb 13, 2026

Changes in this version

type Instance

+ ExitCode int64

+ ExitMessage string

+ Metadata map[string]string

type InstanceNewParams

+ Cmd []string

+ Entrypoint []string

+ Metadata map[string]string

+ type InstanceStartParams struct

+ Cmd []string

+ Entrypoint []string

+ func (r *InstanceStartParams) UnmarshalJSON(data []byte) error

+ func (r InstanceStartParams) MarshalJSON() (data []byte, err error)

v0.9.8

Feb 11, 2026

v0.9.7

Feb 11, 2026

Changes in this version

type InstanceHypervisor

+ const InstanceHypervisorVz

type InstanceNewParamsHypervisor

+ const InstanceNewParamsHypervisorVz

v0.9.6

Jan 30, 2026

Changes in this version

type ResourceAllocation

+ DiskIoBps int64

type Resources

+ DiskIo ResourceStatus

+ type VolumeNewFromArchiveParams struct

+ ID param.Opt[string]

+ Name string

+ SizeGB int64

+ func (r VolumeNewFromArchiveParams) MarshalMultipart() (data []byte, contentType string, err error)

+ func (r VolumeNewFromArchiveParams) URLQuery() (v url.Values, err error)

type VolumeService

+ func (r *VolumeService) NewFromArchive(ctx context.Context, body io.Reader, params VolumeNewFromArchiveParams, ...) (res *Volume, err error)

v0.9.5

Jan 29, 2026

Changes in this version

type Build

+ BuilderInstanceID string

type BuildNewParams

+ GlobalCacheKey param.Opt[string]

+ IsAdminBuild param.Opt[string]

v0.9.4

Jan 23, 2026

Changes in this version

type InstanceNewParams

+ SkipGuestAgent param.Opt[bool]

+ SkipKernelHeaders param.Opt[bool]

v0.9.3

Jan 20, 2026

Changes in this version

+ type Build struct

+ CompletedAt time.Time

+ CreatedAt time.Time

+ DurationMs int64

+ Error string

+ ID string

+ ImageDigest string

+ ImageRef string

+ JSON struct{ ... }

+ Provenance BuildProvenance

+ QueuePosition int64

+ StartedAt time.Time

+ Status BuildStatus

+ func (r *Build) UnmarshalJSON(data []byte) error

+ func (r Build) RawJSON() string

+ type BuildEvent struct

+ Content string

+ JSON struct{ ... }

+ Status BuildStatus

+ Timestamp time.Time

+ Type BuildEventType

+ func (r *BuildEvent) UnmarshalJSON(data []byte) error

+ func (r BuildEvent) RawJSON() string

+ type BuildEventType string

+ const BuildEventTypeHeartbeat

+ const BuildEventTypeLog

+ const BuildEventTypeStatus

+ type BuildEventsParams struct

+ Follow param.Opt[bool]

+ func (r BuildEventsParams) URLQuery() (v url.Values, err error)

+ type BuildNewParams struct

+ BaseImageDigest param.Opt[string]

+ CacheScope param.Opt[string]

+ Dockerfile param.Opt[string]

+ Secrets param.Opt[string]

+ Source io.Reader

+ TimeoutSeconds param.Opt[int64]

+ func (r BuildNewParams) MarshalMultipart() (data []byte, contentType string, err error)

+ type BuildProvenance struct

+ BaseImageDigest string

+ BuildkitVersion string

+ JSON struct{ ... }

+ LockfileHashes map[string]string

+ SourceHash string

+ Timestamp time.Time

+ func (r *BuildProvenance) UnmarshalJSON(data []byte) error

+ func (r BuildProvenance) RawJSON() string

+ type BuildService struct

+ Options []option.RequestOption

+ func NewBuildService(opts ...option.RequestOption) (r BuildService)

+ func (r *BuildService) Cancel(ctx context.Context, id string, opts ...option.RequestOption) (err error)

+ func (r *BuildService) EventsStreaming(ctx context.Context, id string, query BuildEventsParams, ...) (stream *ssestream.Stream[BuildEvent])

+ func (r *BuildService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Build, err error)

+ func (r *BuildService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Build, err error)

+ func (r *BuildService) New(ctx context.Context, body BuildNewParams, opts ...option.RequestOption) (res *Build, err error)

+ type BuildStatus string

+ const BuildStatusBuilding

+ const BuildStatusCancelled

+ const BuildStatusFailed

+ const BuildStatusPushing

+ const BuildStatusQueued

+ const BuildStatusReady

type Client

+ Builds BuildService

+ Resources ResourceService

+ type DiskBreakdown struct

+ ImagesBytes int64

+ JSON struct{ ... }

+ OciCacheBytes int64

+ OverlaysBytes int64

+ VolumesBytes int64

+ func (r *DiskBreakdown) UnmarshalJSON(data []byte) error

+ func (r DiskBreakdown) RawJSON() string

+ type GPUProfile struct

+ Available int64

+ FramebufferMB int64

+ JSON struct{ ... }

+ Name string

+ func (r *GPUProfile) UnmarshalJSON(data []byte) error

+ func (r GPUProfile) RawJSON() string

+ type GPUResourceStatus struct

+ Devices []PassthroughDevice

+ JSON struct{ ... }

+ Mode GPUResourceStatusMode

+ Profiles []GPUProfile

+ TotalSlots int64

+ UsedSlots int64

+ func (r *GPUResourceStatus) UnmarshalJSON(data []byte) error

+ func (r GPUResourceStatus) RawJSON() string

+ type GPUResourceStatusMode string

+ const GPUResourceStatusModePassthrough

+ const GPUResourceStatusModeVgpu

+ type PassthroughDevice struct

+ Available bool

+ JSON struct{ ... }

+ Name string

+ func (r *PassthroughDevice) UnmarshalJSON(data []byte) error

+ func (r PassthroughDevice) RawJSON() string

+ type ResourceAllocation struct

+ CPU int64

+ DiskBytes int64

+ InstanceID string

+ InstanceName string

+ JSON struct{ ... }

+ MemoryBytes int64

+ NetworkDownloadBps int64

+ NetworkUploadBps int64

+ func (r *ResourceAllocation) UnmarshalJSON(data []byte) error

+ func (r ResourceAllocation) RawJSON() string

+ type ResourceService struct

+ Options []option.RequestOption

+ func NewResourceService(opts ...option.RequestOption) (r ResourceService)

+ func (r *ResourceService) Get(ctx context.Context, opts ...option.RequestOption) (res *Resources, err error)

+ type ResourceStatus struct

+ Allocated int64

+ Available int64

+ Capacity int64

+ EffectiveLimit int64

+ JSON struct{ ... }

+ OversubRatio float64

+ Source string

+ Type string

+ func (r *ResourceStatus) UnmarshalJSON(data []byte) error

+ func (r ResourceStatus) RawJSON() string

+ type Resources struct

+ Allocations []ResourceAllocation

+ CPU ResourceStatus

+ Disk ResourceStatus

+ DiskBreakdown DiskBreakdown

+ GPU GPUResourceStatus

+ JSON struct{ ... }

+ Memory ResourceStatus

+ Network ResourceStatus

+ func (r *Resources) UnmarshalJSON(data []byte) error

+ func (r Resources) RawJSON() string

v0.9.2

Jan 20, 2026

Changes in this version

type Instance

+ DiskIoBps string

+ GPU InstanceGPU

+ Hypervisor InstanceHypervisor

+ type InstanceGPU struct

+ JSON struct{ ... }

+ MdevUuid string

+ Profile string

+ func (r *InstanceGPU) UnmarshalJSON(data []byte) error

+ func (r InstanceGPU) RawJSON() string

+ type InstanceHypervisor string

+ const InstanceHypervisorCloudHypervisor

+ const InstanceHypervisorQemu

type InstanceNetwork

+ BandwidthDownload string

+ BandwidthUpload string

type InstanceNewParams

+ DiskIoBps param.Opt[string]

+ GPU InstanceNewParamsGPU

+ Hypervisor InstanceNewParamsHypervisor

+ type InstanceNewParamsGPU struct

+ Profile param.Opt[string]

+ func (r *InstanceNewParamsGPU) UnmarshalJSON(data []byte) error

+ func (r InstanceNewParamsGPU) MarshalJSON() (data []byte, err error)

+ type InstanceNewParamsHypervisor string

+ const InstanceNewParamsHypervisorCloudHypervisor

+ const InstanceNewParamsHypervisorQemu

type InstanceNewParamsNetwork

+ BandwidthDownload param.Opt[string]

+ BandwidthUpload param.Opt[string]

v0.9.1

Jan 14, 2026

v0.9.0

Jan 14, 2026

Changes in this version

+ func Bool(b bool) param.Opt[bool]

+ func BoolPtr(v bool) *bool

+ func DefaultClientOptions() []option.RequestOption

+ func File(rdr io.Reader, filename string, contentType string) file

+ func Float(f float64) param.Opt[float64]

+ func FloatPtr(v float64) *float64

+ func Int(i int64) param.Opt[int64]

+ func IntPtr(v int64) *int64

+ func Opt[T comparable](v T) param.Opt[T]

+ func Ptr[T any](v T) *T

+ func String(s string) param.Opt[string]

+ func StringPtr(v string) *string

+ func Time(t time.Time) param.Opt[time.Time]

+ func TimePtr(v time.Time) *time.Time

+ type AvailableDevice struct

+ CurrentDriver string

+ DeviceID string

+ DeviceName string

+ IommuGroup int64

+ JSON struct{ ... }

+ PciAddress string

+ VendorID string

+ VendorName string

+ func (r *AvailableDevice) UnmarshalJSON(data []byte) error

+ func (r AvailableDevice) RawJSON() string

+ type Client struct

+ Devices DeviceService

+ Health HealthService

+ Images ImageService

+ Ingresses IngressService

+ Instances InstanceService

+ Options []option.RequestOption

+ Volumes VolumeService

+ func NewClient(opts ...option.RequestOption) (r Client)

+ func (r *Client) Delete(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, ...) error

+ func (r *Client) Get(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Patch(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Post(ctx context.Context, path string, params any, res any, ...) error

+ func (r *Client) Put(ctx context.Context, path string, params any, res any, ...) error

+ type Device struct

+ AttachedTo string

+ BoundToVfio bool

+ CreatedAt time.Time

+ DeviceID string

+ ID string

+ IommuGroup int64

+ JSON struct{ ... }

+ Name string

+ PciAddress string

+ Type DeviceType

+ VendorID string

+ func (r *Device) UnmarshalJSON(data []byte) error

+ func (r Device) RawJSON() string

+ type DeviceNewParams struct

+ Name param.Opt[string]

+ PciAddress string

+ func (r *DeviceNewParams) UnmarshalJSON(data []byte) error

+ func (r DeviceNewParams) MarshalJSON() (data []byte, err error)

+ type DeviceService struct

+ Options []option.RequestOption

+ func NewDeviceService(opts ...option.RequestOption) (r DeviceService)

+ func (r *DeviceService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)

+ func (r *DeviceService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Device, err error)

+ func (r *DeviceService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Device, err error)

+ func (r *DeviceService) ListAvailable(ctx context.Context, opts ...option.RequestOption) (res *[]AvailableDevice, err error)

+ func (r *DeviceService) New(ctx context.Context, body DeviceNewParams, opts ...option.RequestOption) (res *Device, err error)

+ type DeviceType string

+ const DeviceTypeGPU

+ const DeviceTypePci

+ type Error = apierror.Error

+ type HealthCheckResponse struct

+ JSON struct{ ... }

+ Status HealthCheckResponseStatus

+ func (r *HealthCheckResponse) UnmarshalJSON(data []byte) error

+ func (r HealthCheckResponse) RawJSON() string

+ type HealthCheckResponseStatus string

+ const HealthCheckResponseStatusOk

+ type HealthService struct

+ Options []option.RequestOption

+ func NewHealthService(opts ...option.RequestOption) (r HealthService)

+ func (r *HealthService) Check(ctx context.Context, opts ...option.RequestOption) (res *HealthCheckResponse, err error)

+ type Image struct

+ Cmd []string

+ CreatedAt time.Time

+ Digest string

+ Entrypoint []string

+ Env map[string]string

+ Error string

+ JSON struct{ ... }

+ Name string

+ QueuePosition int64

+ SizeBytes int64

+ Status ImageStatus

+ WorkingDir string

+ func (r *Image) UnmarshalJSON(data []byte) error

+ func (r Image) RawJSON() string

+ type ImageNewParams struct

+ Name string

+ func (r *ImageNewParams) UnmarshalJSON(data []byte) error

+ func (r ImageNewParams) MarshalJSON() (data []byte, err error)

+ type ImageService struct

+ Options []option.RequestOption

+ func NewImageService(opts ...option.RequestOption) (r ImageService)

+ func (r *ImageService) Delete(ctx context.Context, name string, opts ...option.RequestOption) (err error)

+ func (r *ImageService) Get(ctx context.Context, name string, opts ...option.RequestOption) (res *Image, err error)

+ func (r *ImageService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Image, err error)

+ func (r *ImageService) New(ctx context.Context, body ImageNewParams, opts ...option.RequestOption) (res *Image, err error)

+ type ImageStatus string

+ const ImageStatusConverting

+ const ImageStatusFailed

+ const ImageStatusPending

+ const ImageStatusPulling

+ const ImageStatusReady

+ type Ingress struct

+ CreatedAt time.Time

+ ID string

+ JSON struct{ ... }

+ Name string

+ Rules []IngressRule

+ func (r *Ingress) UnmarshalJSON(data []byte) error

+ func (r Ingress) RawJSON() string

+ type IngressMatch struct

+ Hostname string

+ JSON struct{ ... }

+ Port int64

+ func (r *IngressMatch) UnmarshalJSON(data []byte) error

+ func (r IngressMatch) RawJSON() string

+ func (r IngressMatch) ToParam() IngressMatchParam

+ type IngressMatchParam struct

+ Hostname string

+ Port param.Opt[int64]

+ func (r *IngressMatchParam) UnmarshalJSON(data []byte) error

+ func (r IngressMatchParam) MarshalJSON() (data []byte, err error)

+ type IngressNewParams struct

+ Name string

+ Rules []IngressRuleParam

+ func (r *IngressNewParams) UnmarshalJSON(data []byte) error

+ func (r IngressNewParams) MarshalJSON() (data []byte, err error)

+ type IngressRule struct

+ JSON struct{ ... }

+ Match IngressMatch

+ RedirectHTTP bool

+ Target IngressTarget

+ Tls bool

+ func (r *IngressRule) UnmarshalJSON(data []byte) error

+ func (r IngressRule) RawJSON() string

+ func (r IngressRule) ToParam() IngressRuleParam

+ type IngressRuleParam struct

+ Match IngressMatchParam

+ RedirectHTTP param.Opt[bool]

+ Target IngressTargetParam

+ Tls param.Opt[bool]

+ func (r *IngressRuleParam) UnmarshalJSON(data []byte) error

+ func (r IngressRuleParam) MarshalJSON() (data []byte, err error)

+ type IngressService struct

+ Options []option.RequestOption

+ func NewIngressService(opts ...option.RequestOption) (r IngressService)

+ func (r *IngressService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)

+ func (r *IngressService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Ingress, err error)

+ func (r *IngressService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Ingress, err error)

+ func (r *IngressService) New(ctx context.Context, body IngressNewParams, opts ...option.RequestOption) (res *Ingress, err error)

+ type IngressTarget struct

+ Instance string

+ JSON struct{ ... }

+ Port int64

+ func (r *IngressTarget) UnmarshalJSON(data []byte) error

+ func (r IngressTarget) RawJSON() string

+ func (r IngressTarget) ToParam() IngressTargetParam

+ type IngressTargetParam struct

+ Instance string

+ Port int64

+ func (r *IngressTargetParam) UnmarshalJSON(data []byte) error

+ func (r IngressTargetParam) MarshalJSON() (data []byte, err error)

+ type Instance struct

+ CreatedAt time.Time

+ Env map[string]string

+ HasSnapshot bool

+ HotplugSize string

+ ID string

+ Image string

+ JSON struct{ ... }

+ Name string

+ Network InstanceNetwork

+ OverlaySize string

+ Size string

+ StartedAt time.Time

+ State InstanceState

+ StateError string

+ StoppedAt time.Time

+ Vcpus int64

+ Volumes []VolumeMount

+ func (r *Instance) UnmarshalJSON(data []byte) error

+ func (r Instance) RawJSON() string

+ type InstanceLogsParams struct

+ Follow param.Opt[bool]

+ Source InstanceLogsParamsSource

+ Tail param.Opt[int64]

+ func (r InstanceLogsParams) URLQuery() (v url.Values, err error)

+ type InstanceLogsParamsSource string

+ const InstanceLogsParamsSourceApp

+ const InstanceLogsParamsSourceHypeman

+ const InstanceLogsParamsSourceVmm

+ type InstanceNetwork struct

+ Enabled bool

+ IP string

+ JSON struct{ ... }

+ Mac string

+ Name string

+ func (r *InstanceNetwork) UnmarshalJSON(data []byte) error

+ func (r InstanceNetwork) RawJSON() string

+ type InstanceNewParams struct

+ Devices []string

+ Env map[string]string

+ HotplugSize param.Opt[string]

+ Image string

+ Name string

+ Network InstanceNewParamsNetwork

+ OverlaySize param.Opt[string]

+ Size param.Opt[string]

+ Vcpus param.Opt[int64]

+ Volumes []VolumeMountParam

+ func (r *InstanceNewParams) UnmarshalJSON(data []byte) error

+ func (r InstanceNewParams) MarshalJSON() (data []byte, err error)

+ type InstanceNewParamsNetwork struct

+ Enabled param.Opt[bool]

+ func (r *InstanceNewParamsNetwork) UnmarshalJSON(data []byte) error

+ func (r InstanceNewParamsNetwork) MarshalJSON() (data []byte, err error)

+ type InstanceService struct

+ Options []option.RequestOption

+ Volumes InstanceVolumeService

+ func NewInstanceService(opts ...option.RequestOption) (r InstanceService)

+ func (r *InstanceService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)

+ func (r *InstanceService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Instance, err error)

+ func (r *InstanceService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Instance, err error)

+ func (r *InstanceService) LogsStreaming(ctx context.Context, id string, query InstanceLogsParams, ...) (stream *ssestream.Stream[string])

+ func (r *InstanceService) New(ctx context.Context, body InstanceNewParams, opts ...option.RequestOption) (res *Instance, err error)

+ func (r *InstanceService) Restore(ctx context.Context, id string, opts ...option.RequestOption) (res *Instance, err error)

+ func (r *InstanceService) Standby(ctx context.Context, id string, opts ...option.RequestOption) (res *Instance, err error)

+ func (r *InstanceService) Start(ctx context.Context, id string, opts ...option.RequestOption) (res *Instance, err error)

+ func (r *InstanceService) Stat(ctx context.Context, id string, query InstanceStatParams, ...) (res *PathInfo, err error)

+ func (r *InstanceService) Stop(ctx context.Context, id string, opts ...option.RequestOption) (res *Instance, err error)

+ type InstanceStatParams struct

+ FollowLinks param.Opt[bool]

+ Path string

+ func (r InstanceStatParams) URLQuery() (v url.Values, err error)

+ type InstanceState string

+ const InstanceStateCreated

+ const InstanceStatePaused

+ const InstanceStateRunning

+ const InstanceStateShutdown

+ const InstanceStateStandby

+ const InstanceStateStopped

+ const InstanceStateUnknown

+ type InstanceVolumeAttachParams struct

+ ID string

+ MountPath string

+ Readonly param.Opt[bool]

+ func (r *InstanceVolumeAttachParams) UnmarshalJSON(data []byte) error

+ func (r InstanceVolumeAttachParams) MarshalJSON() (data []byte, err error)

+ type InstanceVolumeDetachParams struct

+ ID string

+ type InstanceVolumeService struct

+ Options []option.RequestOption

+ func NewInstanceVolumeService(opts ...option.RequestOption) (r InstanceVolumeService)

+ func (r *InstanceVolumeService) Attach(ctx context.Context, volumeID string, params InstanceVolumeAttachParams, ...) (res *Instance, err error)

+ func (r *InstanceVolumeService) Detach(ctx context.Context, volumeID string, body InstanceVolumeDetachParams, ...) (res *Instance, err error)

+ type PathInfo struct

+ Error string

+ Exists bool

+ IsDir bool

+ IsFile bool

+ IsSymlink bool

+ JSON struct{ ... }

+ LinkTarget string

+ Mode int64

+ Size int64

+ func (r *PathInfo) UnmarshalJSON(data []byte) error

+ func (r PathInfo) RawJSON() string

+ type Volume struct

+ Attachments []VolumeAttachment

+ CreatedAt time.Time

+ ID string

+ JSON struct{ ... }

+ Name string

+ SizeGB int64

+ func (r *Volume) UnmarshalJSON(data []byte) error

+ func (r Volume) RawJSON() string

+ type VolumeAttachment struct

+ InstanceID string

+ JSON struct{ ... }

+ MountPath string

+ Readonly bool

+ func (r *VolumeAttachment) UnmarshalJSON(data []byte) error

+ func (r VolumeAttachment) RawJSON() string

+ type VolumeMount struct

+ JSON struct{ ... }

+ MountPath string

+ Overlay bool

+ OverlaySize string

+ Readonly bool

+ VolumeID string

+ func (r *VolumeMount) UnmarshalJSON(data []byte) error

+ func (r VolumeMount) RawJSON() string

+ func (r VolumeMount) ToParam() VolumeMountParam

+ type VolumeMountParam struct

+ MountPath string

+ Overlay param.Opt[bool]

+ OverlaySize param.Opt[string]

+ Readonly param.Opt[bool]

+ VolumeID string

+ func (r *VolumeMountParam) UnmarshalJSON(data []byte) error

+ func (r VolumeMountParam) MarshalJSON() (data []byte, err error)

+ type VolumeNewParams struct

+ ID param.Opt[string]

+ Name string

+ SizeGB int64

+ func (r *VolumeNewParams) UnmarshalJSON(data []byte) error

+ func (r VolumeNewParams) MarshalJSON() (data []byte, err error)

+ type VolumeService struct

+ Options []option.RequestOption

+ func NewVolumeService(opts ...option.RequestOption) (r VolumeService)

+ func (r *VolumeService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)

+ func (r *VolumeService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Volume, err error)

+ func (r *VolumeService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Volume, err error)

+ func (r *VolumeService) New(ctx context.Context, body VolumeNewParams, opts ...option.RequestOption) (res *Volume, err error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL