api.md

Shared

Types:

• SnapshotCompressionConfig

Health

Types:

• HealthCheckResponse

Methods:

• client.health.check() -> HealthCheckResponse

Images

Types:

• Image
• ImageListResponse

Methods:

• client.images.create({ ...params }) -> Image
• client.images.list({ ...params }) -> ImageListResponse
• client.images.delete(name) -> void
• client.images.get(name) -> Image

Instances

Types:

• AutoStandbyPolicy
• AutoStandbyStatus
• Instance
• InstanceStats
• PathInfo
• PortMapping
• SetSnapshotScheduleRequest
• SnapshotPolicy
• SnapshotSchedule
• SnapshotScheduleRetention
• 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) -> void
• client.instances.fork(id, { ...params }) -> Instance
• client.instances.get(id) -> Instance
• client.instances.logs(id, { ...params }) -> string
• 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.autoStandby.status(id) -> AutoStandbyStatus

Volumes

Methods:

• client.instances.volumes.attach(volumeID, { ...params }) -> Instance
• client.instances.volumes.detach(volumeID, { ...params }) -> Instance

Snapshots

Methods:

• client.instances.snapshots.create(id, { ...params }) -> Snapshot
• client.instances.snapshots.restore(snapshotID, { ...params }) -> Instance

SnapshotSchedule

Methods:

• client.instances.snapshotSchedule.update(id, { ...params }) -> SnapshotSchedule
• client.instances.snapshotSchedule.delete(id) -> void
• client.instances.snapshotSchedule.get(id) -> SnapshotSchedule

Snapshots

Types:

• Snapshot
• SnapshotKind
• SnapshotListResponse

Methods:

• client.snapshots.list({ ...params }) -> SnapshotListResponse
• client.snapshots.delete(snapshotID) -> void
• client.snapshots.fork(snapshotID, { ...params }) -> Instance
• client.snapshots.get(snapshotID) -> Snapshot

Volumes

Types:

• Volume
• VolumeAttachment
• VolumeListResponse

Methods:

• client.volumes.create({ ...params }) -> Volume
• client.volumes.list({ ...params }) -> VolumeListResponse
• client.volumes.delete(id) -> void
• client.volumes.createFromArchive(body, { ...params }) -> Volume
• client.volumes.get(id) -> Volume

Devices

Types:

• 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) -> void
• client.devices.listAvailable() -> DeviceListAvailableResponse

Ingresses

Types:

• Ingress
• IngressMatch
• IngressRule
• IngressTarget
• IngressListResponse

Methods:

• client.ingresses.create({ ...params }) -> Ingress
• client.ingresses.list({ ...params }) -> IngressListResponse
• client.ingresses.delete(id) -> void
• client.ingresses.get(id) -> Ingress

Resources

Types:

• DiskBreakdown
• GPUProfile
• GPUResourceStatus
• MemoryReclaimAction
• MemoryReclaimRequest
• MemoryReclaimResponse
• PassthroughDevice
• ResourceAllocation
• ResourceStatus
• Resources

Methods:

• client.resources.get() -> Resources
• client.resources.reclaimMemory({ ...params }) -> MemoryReclaimResponse

Builds

Types:

• Build
• BuildEvent
• BuildPolicy
• BuildProvenance
• BuildStatus
• BuildListResponse

Methods:

• client.builds.create({ ...params }) -> Build
• client.builds.list({ ...params }) -> BuildListResponse
• client.builds.cancel(id) -> void
• client.builds.events(id, { ...params }) -> BuildEvent
• client.builds.get(id) -> Build