Skip to content

Instances

Generated from the gateway schema. Do not edit.

Queries

allBackups

query { allBackups(vmid: Int!): AllBackupsResult! }

Requires: an authenticated member of the tenant

Argument Type Description
vmid Int!

Returns: AllBackupsResult!

allQemuTemplates

query { allQemuTemplates: AllQemuTemplatesResult! }

Requires: an authenticated member of the tenant

Returns: AllQemuTemplatesResult!

allQemus

query { allQemus: AllQemusResult! }

Requires: an authenticated member of the tenant

Returns: AllQemusResult!

allVolumes

query { allVolumes: AllVolumesResult! }

Requires: platform ADMIN

Returns: AllVolumesResult!

networkNode

query { networkNode(id: ID!): NetworkNode! }

Requires: platform ADMIN

Argument Type Description
id ID!

Returns: NetworkNode!

networkNodes

query { networkNodes(list: List): NetworkNodeListResult! }

Requires: platform ADMIN

Argument Type Description
list List

Returns: NetworkNodeListResult!

node

query { node(nodeId: String!): NodeStatus! }

Requires: an authenticated member of the tenant

Argument Type Description
nodeId String!

Returns: NodeStatus!

nodes

query { nodes(list: List): NodeListResult! }

Requires: platform ADMIN

Argument Type Description
list List

Returns: NodeListResult!

postgresBackupsByCluster

query { postgresBackupsByCluster(clusterId: ID!, namespace: String!, clusterName: String!): BackupListResult! }

Requires: an authenticated member of the tenant

Argument Type Description
clusterId ID!
namespace String!
clusterName String!

Returns: BackupListResult!

qemu

query { qemu(id: ID!): Qemu! }

Requires: an authenticated member of the tenant

Argument Type Description
id ID!

Returns: Qemu!

qemuByIpAddress

query { qemuByIpAddress(ipAddress: String!): Qemu }

Requires: platform ADMIN

Argument Type Description
ipAddress String!

Returns: Qemu

qemuCloudInit

query { qemuCloudInit(vmid: Int!): CloudInitConfig }

Requires: an authenticated member of the tenant

Argument Type Description
vmid Int!

Returns: CloudInitConfig

qemuMetrics

Time-series CPU/memory/disk/network for a VM, straight from Proxmox RRD.

query { qemuMetrics(vmid: Int!, timeframe: QemuMetricTimeframe): QemuMetricsResult! }

Requires: an authenticated member of the tenant

Argument Type Description
vmid Int!
timeframe QemuMetricTimeframe

Returns: QemuMetricsResult!

qemus

query { qemus(nodeId: String!): [Qemu!]! }

Requires: an authenticated member of the tenant

Argument Type Description
nodeId String!

Returns: [Qemu!]!

storages

query { storages(nodeId: String!): [Storage!]! }

Requires: an authenticated member of the tenant

Argument Type Description
nodeId String!

Returns: [Storage!]!

Mutations

createQemuBackup

mutation { createQemuBackup(input: CreateQemuBackup!): Boolean! }

Requires: tenant EDITOR

Argument Type Description
input CreateQemuBackup!

Returns: Boolean!

createQemuFromTemplate

mutation { createQemuFromTemplate(input: CreateQemuFromTemplate!): String! }

Requires: tenant EDITOR

Argument Type Description
input CreateQemuFromTemplate!

Returns: String!

deleteQemu

mutation { deleteQemu(vmid: Int!): Boolean! }

Requires: tenant EDITOR

Argument Type Description
vmid Int!

Returns: Boolean!

openQemuConsole

Opens a single-use, proxied noVNC session for this VM.

mutation { openQemuConsole(vmid: Int!): QemuConsoleSession! }

Requires: tenant EDITOR

Argument Type Description
vmid Int!

Returns: QemuConsoleSession!

rebootQemu

mutation { rebootQemu(vmid: Int!): Boolean! }

Requires: tenant EDITOR

Argument Type Description
vmid Int!

Returns: Boolean!

resizeQemu

mutation { resizeQemu(input: ResizeQemu!): Boolean! }

Requires: tenant EDITOR

Argument Type Description
input ResizeQemu!

Returns: Boolean!

resizeQemuDisk

mutation { resizeQemuDisk(input: ResizeQemuDisk!): Boolean! }

Requires: tenant EDITOR

Argument Type Description
input ResizeQemuDisk!

Returns: Boolean!

restoreQemuBackup

mutation { restoreQemuBackup(input: RestoreQemuBackup!): Boolean! }

Requires: tenant EDITOR

Argument Type Description
input RestoreQemuBackup!

Returns: Boolean!

startQemu

mutation { startQemu(vmid: Int!): Boolean! }

Requires: tenant EDITOR

Argument Type Description
vmid Int!

Returns: Boolean!

stopQemu

mutation { stopQemu(vmid: Int!): Boolean! }

Requires: tenant EDITOR

Argument Type Description
vmid Int!

Returns: Boolean!

updateQemuCloudInit

mutation { updateQemuCloudInit(vmid: Int!, config: CloudInitConfigInput!): Boolean! }

Requires: tenant EDITOR

Argument Type Description
vmid Int!
config CloudInitConfigInput!

Returns: Boolean!

Subscriptions

qemuStatusChanged

subscription { qemuStatusChanged(vmid: Int!): Qemu! }

Requires: an authenticated member of the tenant

Argument Type Description
vmid Int!

Returns: Qemu!