info: description: Generated from https://pve.proxmox.com/pve-docs/api-viewer/apidoc.js on 2026-07-03T18:01:00Z. Paths/params are best-effort; regenerate after upgrades. title: Proxmox VE API (generated from apidoc.js) version: generated openapi: 3.0.3 paths: /access: get: operationId: get_access responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: Directory index. /access/acl: get: operationId: get_access_acl responses: "200": content: application/json: schema: items: properties: path: description: Access control path type: string propagate: description: Allow to propagate (inherit) permissions. type: boolean roleid: type: string type: enum: - user - group - token type: string ugid: type: string type: object type: array description: OK summary: Get Access Control List (ACLs). put: operationId: put_access_acl parameters: - description: Remove permissions (instead of adding it). in: query name: delete required: false schema: description: Remove permissions (instead of adding it). type: boolean - description: List of groups. in: query name: groups required: false schema: description: List of groups. format: pve-groupid-list type: string - description: Access control path in: query name: path required: false schema: description: Access control path type: string - description: Allow to propagate (inherit) permissions. in: query name: propagate required: false schema: description: Allow to propagate (inherit) permissions. type: boolean - description: List of roles. in: query name: roles required: false schema: description: List of roles. format: pve-roleid-list type: string - description: List of API tokens. in: query name: tokens required: false schema: description: List of API tokens. format: pve-tokenid-list type: string - description: List of users. in: query name: users required: false schema: description: List of users. format: pve-userid-list type: string requestBody: content: application/json: schema: properties: delete: description: Remove permissions (instead of adding it). type: boolean groups: description: List of groups. format: pve-groupid-list type: string path: description: Access control path type: string propagate: description: Allow to propagate (inherit) permissions. type: boolean roles: description: List of roles. format: pve-roleid-list type: string tokens: description: List of API tokens. format: pve-tokenid-list type: string users: description: List of users. format: pve-userid-list type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update Access Control List (add or remove permissions). /access/domains: get: operationId: get_access_domains responses: "200": content: application/json: schema: items: properties: comment: description: A comment. The GUI use this text when you select a domain (Realm) on the login window. type: string realm: type: string tfa: description: Two-factor authentication provider. enum: - yubico - oath type: string type: type: string type: object type: array description: OK summary: Authentication domain index. post: operationId: post_access_domains parameters: - description: Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. in: query name: acr-values required: false schema: description: Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. type: string - description: A list of audiences that the OpenID Issuer may include that are accepted in addition to 'client-id'. in: query name: audiences required: false schema: description: A list of audiences that the OpenID Issuer may include that are accepted in addition to 'client-id'. type: string - description: Automatically create users if they do not exist. in: query name: autocreate required: false schema: description: Automatically create users if they do not exist. type: boolean - description: LDAP base domain name in: query name: base_dn required: false schema: description: LDAP base domain name type: string - description: LDAP bind domain name in: query name: bind_dn required: false schema: description: LDAP bind domain name type: string - description: Path to the CA certificate store in: query name: capath required: false schema: description: Path to the CA certificate store type: string - description: username is case-sensitive in: query name: case-sensitive required: false schema: description: username is case-sensitive type: boolean - description: Path to the client certificate in: query name: cert required: false schema: description: Path to the client certificate type: string - description: Path to the client certificate key in: query name: certkey required: false schema: description: Path to the client certificate key type: string - description: Check bind connection to the server. in: query name: check-connection required: false schema: description: Check bind connection to the server. type: boolean - description: OpenID Client ID in: query name: client-id required: false schema: description: OpenID Client ID type: string - description: OpenID Client Key in: query name: client-key required: false schema: description: OpenID Client Key type: string - description: Description. in: query name: comment required: false schema: description: Description. type: string - description: Use this as default realm in: query name: default required: false schema: description: Use this as default realm type: boolean - description: AD domain name in: query name: domain required: false schema: description: AD domain name type: string - description: LDAP filter for user sync. in: query name: filter required: false schema: description: LDAP filter for user sync. type: string - description: The objectclasses for groups. in: query name: group_classes required: false schema: description: The objectclasses for groups. format: ldap-simple-attr-list type: string - description: LDAP base domain name for group sync. If not set, the base_dn will be used. in: query name: group_dn required: false schema: description: LDAP base domain name for group sync. If not set, the base_dn will be used. type: string - description: LDAP filter for group sync. in: query name: group_filter required: false schema: description: LDAP filter for group sync. type: string - description: LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. in: query name: group_name_attr required: false schema: description: LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. format: ldap-simple-attr type: string - description: Automatically create groups if they do not exist. in: query name: groups-autocreate required: false schema: description: Automatically create groups if they do not exist. type: boolean - description: OpenID claim used to retrieve groups with. in: query name: groups-claim required: false schema: description: OpenID claim used to retrieve groups with. type: string - description: All groups will be overwritten for the user on login. in: query name: groups-overwrite required: false schema: description: All groups will be overwritten for the user on login. type: boolean - description: OpenID Issuer Url in: query name: issuer-url required: false schema: description: OpenID Issuer Url type: string - description: LDAP protocol mode. in: query name: mode required: false schema: description: LDAP protocol mode. enum: - ldap - ldaps - ldap+starttls type: string - description: LDAP bind password. Will be stored in '/etc/pve/priv/realm/.pw'. in: query name: password required: false schema: description: LDAP bind password. Will be stored in '/etc/pve/priv/realm/.pw'. type: string - description: Server port. in: query name: port required: false schema: description: Server port. type: integer - description: Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. in: query name: prompt required: false schema: description: Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. type: string - description: Enables querying the userinfo endpoint for claims values. in: query name: query-userinfo required: false schema: description: Enables querying the userinfo endpoint for claims values. type: boolean - description: Authentication domain ID in: query name: realm required: false schema: description: Authentication domain ID format: pve-realm type: string - description: Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. in: query name: scopes required: false schema: description: Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. type: string - description: 'Use secure LDAPS protocol. DEPRECATED: use ''mode'' instead.' in: query name: secure required: false schema: description: 'Use secure LDAPS protocol. DEPRECATED: use ''mode'' instead.' type: boolean - description: Server IP address (or DNS name) in: query name: server1 required: false schema: description: Server IP address (or DNS name) format: address type: string - description: Fallback Server IP address (or DNS name) in: query name: server2 required: false schema: description: Fallback Server IP address (or DNS name) format: address type: string - description: LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! in: query name: sslversion required: false schema: description: LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! enum: - tlsv1 - tlsv1_1 - tlsv1_2 - tlsv1_3 type: string - description: The default options for behavior of synchronizations. in: query name: sync-defaults-options required: false schema: description: The default options for behavior of synchronizations. format: realm-sync-options type: string - description: Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. in: query name: sync_attributes required: false schema: description: Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. type: string - description: Use Two-factor authentication. in: query name: tfa required: false schema: description: Use Two-factor authentication. format: pve-tfa-config type: string - description: Realm type. in: query name: type required: false schema: description: Realm type. enum: - ad - ldap - openid - pam - pve type: string - description: LDAP user attribute name in: query name: user_attr required: false schema: description: LDAP user attribute name type: string - description: The objectclasses for users. in: query name: user_classes required: false schema: description: The objectclasses for users. format: ldap-simple-attr-list type: string - description: OpenID claim used to generate the unique username. in: query name: username-claim required: false schema: description: OpenID claim used to generate the unique username. type: string - description: Verify the server's SSL certificate in: query name: verify required: false schema: description: Verify the server's SSL certificate type: boolean requestBody: content: application/json: schema: properties: acr-values: description: Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. type: string audiences: description: A list of audiences that the OpenID Issuer may include that are accepted in addition to 'client-id'. type: string autocreate: description: Automatically create users if they do not exist. type: boolean base_dn: description: LDAP base domain name type: string bind_dn: description: LDAP bind domain name type: string capath: description: Path to the CA certificate store type: string case-sensitive: description: username is case-sensitive type: boolean cert: description: Path to the client certificate type: string certkey: description: Path to the client certificate key type: string check-connection: description: Check bind connection to the server. type: boolean client-id: description: OpenID Client ID type: string client-key: description: OpenID Client Key type: string comment: description: Description. type: string default: description: Use this as default realm type: boolean domain: description: AD domain name type: string filter: description: LDAP filter for user sync. type: string group_classes: description: The objectclasses for groups. format: ldap-simple-attr-list type: string group_dn: description: LDAP base domain name for group sync. If not set, the base_dn will be used. type: string group_filter: description: LDAP filter for group sync. type: string group_name_attr: description: LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. format: ldap-simple-attr type: string groups-autocreate: description: Automatically create groups if they do not exist. type: boolean groups-claim: description: OpenID claim used to retrieve groups with. type: string groups-overwrite: description: All groups will be overwritten for the user on login. type: boolean issuer-url: description: OpenID Issuer Url type: string mode: description: LDAP protocol mode. enum: - ldap - ldaps - ldap+starttls type: string password: description: LDAP bind password. Will be stored in '/etc/pve/priv/realm/.pw'. type: string port: description: Server port. type: integer prompt: description: Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. type: string query-userinfo: description: Enables querying the userinfo endpoint for claims values. type: boolean realm: description: Authentication domain ID format: pve-realm type: string scopes: description: Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. type: string secure: description: 'Use secure LDAPS protocol. DEPRECATED: use ''mode'' instead.' type: boolean server1: description: Server IP address (or DNS name) format: address type: string server2: description: Fallback Server IP address (or DNS name) format: address type: string sslversion: description: LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! enum: - tlsv1 - tlsv1_1 - tlsv1_2 - tlsv1_3 type: string sync-defaults-options: description: The default options for behavior of synchronizations. format: realm-sync-options type: string sync_attributes: description: Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. type: string tfa: description: Use Two-factor authentication. format: pve-tfa-config type: string type: description: Realm type. enum: - ad - ldap - openid - pam - pve type: string user_attr: description: LDAP user attribute name type: string user_classes: description: The objectclasses for users. format: ldap-simple-attr-list type: string username-claim: description: OpenID claim used to generate the unique username. type: string verify: description: Verify the server's SSL certificate type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add an authentication server. /access/domains/{realm}: delete: operationId: delete_access_domains_realm parameters: - description: Authentication domain ID in: path name: realm required: true schema: description: Authentication domain ID format: pve-realm type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete an authentication server. get: operationId: get_access_domains_realm parameters: - description: Authentication domain ID in: path name: realm required: true schema: description: Authentication domain ID format: pve-realm type: string responses: "200": content: application/json: schema: type: object description: OK summary: Get auth server configuration. put: operationId: put_access_domains_realm parameters: - description: Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. in: query name: acr-values required: false schema: description: Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. type: string - description: A list of audiences that the OpenID Issuer may include that are accepted in addition to 'client-id'. in: query name: audiences required: false schema: description: A list of audiences that the OpenID Issuer may include that are accepted in addition to 'client-id'. type: string - description: Automatically create users if they do not exist. in: query name: autocreate required: false schema: description: Automatically create users if they do not exist. type: boolean - description: LDAP base domain name in: query name: base_dn required: false schema: description: LDAP base domain name type: string - description: LDAP bind domain name in: query name: bind_dn required: false schema: description: LDAP bind domain name type: string - description: Path to the CA certificate store in: query name: capath required: false schema: description: Path to the CA certificate store type: string - description: username is case-sensitive in: query name: case-sensitive required: false schema: description: username is case-sensitive type: boolean - description: Path to the client certificate in: query name: cert required: false schema: description: Path to the client certificate type: string - description: Path to the client certificate key in: query name: certkey required: false schema: description: Path to the client certificate key type: string - description: Check bind connection to the server. in: query name: check-connection required: false schema: description: Check bind connection to the server. type: boolean - description: OpenID Client ID in: query name: client-id required: false schema: description: OpenID Client ID type: string - description: OpenID Client Key in: query name: client-key required: false schema: description: OpenID Client Key type: string - description: Description. in: query name: comment required: false schema: description: Description. type: string - description: Use this as default realm in: query name: default required: false schema: description: Use this as default realm type: boolean - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: AD domain name in: query name: domain required: false schema: description: AD domain name type: string - description: LDAP filter for user sync. in: query name: filter required: false schema: description: LDAP filter for user sync. type: string - description: The objectclasses for groups. in: query name: group_classes required: false schema: description: The objectclasses for groups. format: ldap-simple-attr-list type: string - description: LDAP base domain name for group sync. If not set, the base_dn will be used. in: query name: group_dn required: false schema: description: LDAP base domain name for group sync. If not set, the base_dn will be used. type: string - description: LDAP filter for group sync. in: query name: group_filter required: false schema: description: LDAP filter for group sync. type: string - description: LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. in: query name: group_name_attr required: false schema: description: LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. format: ldap-simple-attr type: string - description: Automatically create groups if they do not exist. in: query name: groups-autocreate required: false schema: description: Automatically create groups if they do not exist. type: boolean - description: OpenID claim used to retrieve groups with. in: query name: groups-claim required: false schema: description: OpenID claim used to retrieve groups with. type: string - description: All groups will be overwritten for the user on login. in: query name: groups-overwrite required: false schema: description: All groups will be overwritten for the user on login. type: boolean - description: OpenID Issuer Url in: query name: issuer-url required: false schema: description: OpenID Issuer Url type: string - description: LDAP protocol mode. in: query name: mode required: false schema: description: LDAP protocol mode. enum: - ldap - ldaps - ldap+starttls type: string - description: LDAP bind password. Will be stored in '/etc/pve/priv/realm/.pw'. in: query name: password required: false schema: description: LDAP bind password. Will be stored in '/etc/pve/priv/realm/.pw'. type: string - description: Server port. in: query name: port required: false schema: description: Server port. type: integer - description: Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. in: query name: prompt required: false schema: description: Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. type: string - description: Enables querying the userinfo endpoint for claims values. in: query name: query-userinfo required: false schema: description: Enables querying the userinfo endpoint for claims values. type: boolean - description: Authentication domain ID in: path name: realm required: true schema: description: Authentication domain ID format: pve-realm type: string - description: Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. in: query name: scopes required: false schema: description: Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. type: string - description: 'Use secure LDAPS protocol. DEPRECATED: use ''mode'' instead.' in: query name: secure required: false schema: description: 'Use secure LDAPS protocol. DEPRECATED: use ''mode'' instead.' type: boolean - description: Server IP address (or DNS name) in: query name: server1 required: false schema: description: Server IP address (or DNS name) format: address type: string - description: Fallback Server IP address (or DNS name) in: query name: server2 required: false schema: description: Fallback Server IP address (or DNS name) format: address type: string - description: LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! in: query name: sslversion required: false schema: description: LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! enum: - tlsv1 - tlsv1_1 - tlsv1_2 - tlsv1_3 type: string - description: The default options for behavior of synchronizations. in: query name: sync-defaults-options required: false schema: description: The default options for behavior of synchronizations. format: realm-sync-options type: string - description: Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. in: query name: sync_attributes required: false schema: description: Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. type: string - description: Use Two-factor authentication. in: query name: tfa required: false schema: description: Use Two-factor authentication. format: pve-tfa-config type: string - description: LDAP user attribute name in: query name: user_attr required: false schema: description: LDAP user attribute name type: string - description: The objectclasses for users. in: query name: user_classes required: false schema: description: The objectclasses for users. format: ldap-simple-attr-list type: string - description: Verify the server's SSL certificate in: query name: verify required: false schema: description: Verify the server's SSL certificate type: boolean requestBody: content: application/json: schema: properties: acr-values: description: Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. type: string audiences: description: A list of audiences that the OpenID Issuer may include that are accepted in addition to 'client-id'. type: string autocreate: description: Automatically create users if they do not exist. type: boolean base_dn: description: LDAP base domain name type: string bind_dn: description: LDAP bind domain name type: string capath: description: Path to the CA certificate store type: string case-sensitive: description: username is case-sensitive type: boolean cert: description: Path to the client certificate type: string certkey: description: Path to the client certificate key type: string check-connection: description: Check bind connection to the server. type: boolean client-id: description: OpenID Client ID type: string client-key: description: OpenID Client Key type: string comment: description: Description. type: string default: description: Use this as default realm type: boolean delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string domain: description: AD domain name type: string filter: description: LDAP filter for user sync. type: string group_classes: description: The objectclasses for groups. format: ldap-simple-attr-list type: string group_dn: description: LDAP base domain name for group sync. If not set, the base_dn will be used. type: string group_filter: description: LDAP filter for group sync. type: string group_name_attr: description: LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. format: ldap-simple-attr type: string groups-autocreate: description: Automatically create groups if they do not exist. type: boolean groups-claim: description: OpenID claim used to retrieve groups with. type: string groups-overwrite: description: All groups will be overwritten for the user on login. type: boolean issuer-url: description: OpenID Issuer Url type: string mode: description: LDAP protocol mode. enum: - ldap - ldaps - ldap+starttls type: string password: description: LDAP bind password. Will be stored in '/etc/pve/priv/realm/.pw'. type: string port: description: Server port. type: integer prompt: description: Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. type: string query-userinfo: description: Enables querying the userinfo endpoint for claims values. type: boolean realm: description: Authentication domain ID format: pve-realm type: string scopes: description: Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. type: string secure: description: 'Use secure LDAPS protocol. DEPRECATED: use ''mode'' instead.' type: boolean server1: description: Server IP address (or DNS name) format: address type: string server2: description: Fallback Server IP address (or DNS name) format: address type: string sslversion: description: LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! enum: - tlsv1 - tlsv1_1 - tlsv1_2 - tlsv1_3 type: string sync-defaults-options: description: The default options for behavior of synchronizations. format: realm-sync-options type: string sync_attributes: description: Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. type: string tfa: description: Use Two-factor authentication. format: pve-tfa-config type: string user_attr: description: LDAP user attribute name type: string user_classes: description: The objectclasses for users. format: ldap-simple-attr-list type: string verify: description: Verify the server's SSL certificate type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update authentication server settings. /access/domains/{realm}/sync: post: operationId: post_access_domains_realm_sync parameters: - description: If set, does not write anything. in: query name: dry-run required: false schema: description: If set, does not write anything. type: boolean - description: Enable newly synced users immediately. in: query name: enable-new required: false schema: description: Enable newly synced users immediately. type: boolean - description: 'DEPRECATED: use ''remove-vanished'' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else.' in: query name: full required: false schema: description: 'DEPRECATED: use ''remove-vanished'' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else.' type: boolean - description: 'DEPRECATED: use ''remove-vanished'' instead. Remove ACLs for users or groups which were removed from the config during a sync.' in: query name: purge required: false schema: description: 'DEPRECATED: use ''remove-vanished'' instead. Remove ACLs for users or groups which were removed from the config during a sync.' type: boolean - description: Authentication domain ID in: path name: realm required: true schema: description: Authentication domain ID format: pve-realm type: string - description: 'A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ''entry'' removes the user/group when not returned from the sync. ''properties'' removes the set properties on existing user/group that do not appear in the source (even custom ones). ''acl'' removes acls when the user/group is not returned from the sync. Instead of a list it also can be ''none'' (the default).' in: query name: remove-vanished required: false schema: description: 'A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ''entry'' removes the user/group when not returned from the sync. ''properties'' removes the set properties on existing user/group that do not appear in the source (even custom ones). ''acl'' removes acls when the user/group is not returned from the sync. Instead of a list it also can be ''none'' (the default).' type: string - description: Select what to sync. in: query name: scope required: false schema: description: Select what to sync. enum: - users - groups - both type: string requestBody: content: application/json: schema: properties: dry-run: description: If set, does not write anything. type: boolean enable-new: description: Enable newly synced users immediately. type: boolean full: description: 'DEPRECATED: use ''remove-vanished'' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else.' type: boolean purge: description: 'DEPRECATED: use ''remove-vanished'' instead. Remove ACLs for users or groups which were removed from the config during a sync.' type: boolean realm: description: Authentication domain ID format: pve-realm type: string remove-vanished: description: 'A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ''entry'' removes the user/group when not returned from the sync. ''properties'' removes the set properties on existing user/group that do not appear in the source (even custom ones). ''acl'' removes acls when the user/group is not returned from the sync. Instead of a list it also can be ''none'' (the default).' type: string scope: description: Select what to sync. enum: - users - groups - both type: string type: object responses: "200": content: application/json: schema: description: Worker Task-UPID type: string description: OK summary: 'Syncs users and/or groups from the configured LDAP to user.cfg. NOTE: Synced groups will have the name ''name-$realm'', so make sure those groups do not exist to prevent overwriting.' /access/groups: get: operationId: get_access_groups responses: "200": content: application/json: schema: items: properties: comment: type: string groupid: format: pve-groupid type: string users: description: list of users which form this group format: pve-userid-list type: string type: object type: array description: OK summary: Group index. post: operationId: post_access_groups parameters: - description: "" in: query name: comment required: false schema: type: string - description: "" in: query name: groupid required: false schema: format: pve-groupid type: string requestBody: content: application/json: schema: properties: comment: type: string groupid: format: pve-groupid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new group. /access/groups/{groupid}: delete: operationId: delete_access_groups_groupid parameters: - description: "" in: path name: groupid required: true schema: format: pve-groupid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete group. get: operationId: get_access_groups_groupid parameters: - description: "" in: path name: groupid required: true schema: format: pve-groupid type: string responses: "200": content: application/json: schema: properties: comment: type: string members: items: description: Full User ID, in the `name@realm` format. format: pve-userid type: string type: array type: object description: OK summary: Get group configuration. put: operationId: put_access_groups_groupid parameters: - description: "" in: query name: comment required: false schema: type: string - description: "" in: path name: groupid required: true schema: format: pve-groupid type: string requestBody: content: application/json: schema: properties: comment: type: string groupid: format: pve-groupid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update group data. /access/openid: get: operationId: get_access_openid responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: Directory index. /access/openid/auth-url: post: operationId: post_access_openid_auth_url parameters: - description: Authentication domain ID in: query name: realm required: false schema: description: Authentication domain ID format: pve-realm type: string - description: Redirection Url. The client should set this to the used server url (location.origin). in: query name: redirect-url required: false schema: description: Redirection Url. The client should set this to the used server url (location.origin). type: string requestBody: content: application/json: schema: properties: realm: description: Authentication domain ID format: pve-realm type: string redirect-url: description: Redirection Url. The client should set this to the used server url (location.origin). type: string type: object responses: "200": content: application/json: schema: description: Redirection URL. type: string description: OK summary: Get the OpenId Authorization Url for the specified realm. /access/openid/login: post: operationId: post_access_openid_login parameters: - description: OpenId authorization code. in: query name: code required: false schema: description: OpenId authorization code. type: string - description: Redirection Url. The client should set this to the used server url (location.origin). in: query name: redirect-url required: false schema: description: Redirection Url. The client should set this to the used server url (location.origin). type: string - description: OpenId state. in: query name: state required: false schema: description: OpenId state. type: string requestBody: content: application/json: schema: properties: code: description: OpenId authorization code. type: string redirect-url: description: Redirection Url. The client should set this to the used server url (location.origin). type: string state: description: OpenId state. type: string type: object responses: "200": content: application/json: schema: properties: CSRFPreventionToken: type: string cap: type: object clustername: type: string ticket: type: string username: type: string type: object description: OK summary: ' Verify OpenID authorization code and create a ticket.' /access/password: put: operationId: put_access_password parameters: - description: The current password of the user performing the change. in: query name: confirmation-password required: false schema: description: The current password of the user performing the change. type: string - description: The new password. in: query name: password required: false schema: description: The new password. type: string - description: Full User ID, in the `name@realm` format. in: query name: userid required: false schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string requestBody: content: application/json: schema: properties: confirmation-password: description: The current password of the user performing the change. type: string password: description: The new password. type: string userid: description: Full User ID, in the `name@realm` format. format: pve-userid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Change user password. /access/permissions: get: operationId: get_access_permissions parameters: - description: Only dump this specific path, not the whole tree. in: query name: path required: false schema: description: Only dump this specific path, not the whole tree. type: string - description: User ID or full API token ID in: query name: userid required: false schema: description: User ID or full API token ID type: string responses: "200": content: application/json: schema: description: Map of "path" => (Map of "privilege" => "propagate boolean"). type: object description: OK summary: Retrieve effective permissions of given user/token. /access/roles: get: operationId: get_access_roles responses: "200": content: application/json: schema: items: properties: privs: format: pve-priv-list type: string roleid: format: pve-roleid type: string special: type: boolean type: object type: array description: OK summary: Role index. post: operationId: post_access_roles parameters: - description: "" in: query name: privs required: false schema: format: pve-priv-list type: string - description: "" in: query name: roleid required: false schema: format: pve-roleid type: string requestBody: content: application/json: schema: properties: privs: format: pve-priv-list type: string roleid: format: pve-roleid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new role. /access/roles/{roleid}: delete: operationId: delete_access_roles_roleid parameters: - description: "" in: path name: roleid required: true schema: format: pve-roleid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete role. get: operationId: get_access_roles_roleid parameters: - description: "" in: path name: roleid required: true schema: format: pve-roleid type: string responses: "200": content: application/json: schema: properties: Datastore.Allocate: type: boolean Datastore.AllocateSpace: type: boolean Datastore.AllocateTemplate: type: boolean Datastore.Audit: type: boolean Group.Allocate: type: boolean Mapping.Audit: type: boolean Mapping.Modify: type: boolean Mapping.Use: type: boolean Permissions.Modify: type: boolean Pool.Allocate: type: boolean Pool.Audit: type: boolean Realm.Allocate: type: boolean Realm.AllocateUser: type: boolean SDN.Allocate: type: boolean SDN.Audit: type: boolean SDN.Use: type: boolean Sys.AccessNetwork: type: boolean Sys.Audit: type: boolean Sys.Console: type: boolean Sys.Incoming: type: boolean Sys.Modify: type: boolean Sys.PowerMgmt: type: boolean Sys.Syslog: type: boolean User.Modify: type: boolean VM.Allocate: type: boolean VM.Audit: type: boolean VM.Backup: type: boolean VM.Clone: type: boolean VM.Config.CDROM: type: boolean VM.Config.CPU: type: boolean VM.Config.Cloudinit: type: boolean VM.Config.Disk: type: boolean VM.Config.HWType: type: boolean VM.Config.Memory: type: boolean VM.Config.Network: type: boolean VM.Config.Options: type: boolean VM.Console: type: boolean VM.GuestAgent.Audit: type: boolean VM.GuestAgent.FileRead: type: boolean VM.GuestAgent.FileSystemMgmt: type: boolean VM.GuestAgent.FileWrite: type: boolean VM.GuestAgent.Unrestricted: type: boolean VM.Migrate: type: boolean VM.PowerMgmt: type: boolean VM.Replicate: type: boolean VM.Snapshot: type: boolean VM.Snapshot.Rollback: type: boolean type: object description: OK summary: Get role configuration. put: operationId: put_access_roles_roleid parameters: - description: "" in: query name: append required: false schema: type: boolean - description: "" in: query name: privs required: false schema: format: pve-priv-list type: string - description: "" in: path name: roleid required: true schema: format: pve-roleid type: string requestBody: content: application/json: schema: properties: append: type: boolean privs: format: pve-priv-list type: string roleid: format: pve-roleid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update an existing role. /access/tfa: get: operationId: get_access_tfa responses: "200": content: application/json: schema: description: The list tuples of user and TFA entries. items: properties: entries: items: description: TFA Entry. properties: created: description: Creation time of this entry as unix epoch. type: integer description: description: User chosen description for this entry. type: string enable: description: Whether this TFA entry is currently enabled. type: boolean id: description: The id used to reference this entry. type: string type: description: TFA Entry Type. enum: - totp - u2f - webauthn - recovery - yubico type: string type: object type: array tfa-locked-until: description: Contains a timestamp until when a user is locked out of 2nd factors. type: integer totp-locked: description: True if the user is currently locked out of TOTP factors. type: boolean userid: description: User this entry belongs to. type: string type: object type: array description: OK summary: List TFA configurations of users. /access/tfa/{userid}: get: operationId: get_access_tfa_userid parameters: - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string responses: "200": content: application/json: schema: description: A list of the user's TFA entries. items: description: TFA Entry. properties: created: description: Creation time of this entry as unix epoch. type: integer description: description: User chosen description for this entry. type: string enable: description: Whether this TFA entry is currently enabled. type: boolean id: description: The id used to reference this entry. type: string type: description: TFA Entry Type. enum: - totp - u2f - webauthn - recovery - yubico type: string type: object type: array description: OK summary: List TFA configurations of users. post: operationId: post_access_tfa_userid parameters: - description: 'When responding to a u2f challenge: the original challenge string' in: query name: challenge required: false schema: description: 'When responding to a u2f challenge: the original challenge string' type: string - description: A description to distinguish multiple entries from one another in: query name: description required: false schema: description: A description to distinguish multiple entries from one another type: string - description: The current password of the user performing the change. in: query name: password required: false schema: description: The current password of the user performing the change. type: string - description: A totp URI. in: query name: totp required: false schema: description: A totp URI. type: string - description: TFA Entry Type. in: query name: type required: false schema: description: TFA Entry Type. enum: - totp - u2f - webauthn - recovery - yubico type: string - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string - description: The current value for the provided totp URI, or a Webauthn/U2F challenge response in: query name: value required: false schema: description: The current value for the provided totp URI, or a Webauthn/U2F challenge response type: string requestBody: content: application/json: schema: properties: challenge: description: 'When responding to a u2f challenge: the original challenge string' type: string description: description: A description to distinguish multiple entries from one another type: string password: description: The current password of the user performing the change. type: string totp: description: A totp URI. type: string type: description: TFA Entry Type. enum: - totp - u2f - webauthn - recovery - yubico type: string userid: description: Full User ID, in the `name@realm` format. format: pve-userid type: string value: description: The current value for the provided totp URI, or a Webauthn/U2F challenge response type: string type: object responses: "200": content: application/json: schema: properties: challenge: description: When adding u2f entries, this contains a challenge the user must respond to in order to finish the registration. type: string id: description: The id of a newly added TFA entry. type: string recovery: description: When adding recovery codes, this contains the list of codes to be displayed to the user items: description: A recovery entry. type: string type: array type: object description: OK summary: Add a TFA entry for a user. /access/tfa/{userid}/{id}: delete: operationId: delete_access_tfa_userid_id parameters: - description: A TFA entry id. in: path name: id required: true schema: description: A TFA entry id. type: string - description: The current password of the user performing the change. in: query name: password required: false schema: description: The current password of the user performing the change. type: string - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete a TFA entry by ID. get: operationId: get_access_tfa_userid_id parameters: - description: A TFA entry id. in: path name: id required: true schema: description: A TFA entry id. type: string - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string responses: "200": content: application/json: schema: description: TFA Entry. properties: created: description: Creation time of this entry as unix epoch. type: integer description: description: User chosen description for this entry. type: string enable: description: Whether this TFA entry is currently enabled. type: boolean id: description: The id used to reference this entry. type: string type: description: TFA Entry Type. enum: - totp - u2f - webauthn - recovery - yubico type: string type: object description: OK summary: Fetch a requested TFA entry if present. put: operationId: put_access_tfa_userid_id parameters: - description: A description to distinguish multiple entries from one another in: query name: description required: false schema: description: A description to distinguish multiple entries from one another type: string - description: Whether the entry should be enabled for login. in: query name: enable required: false schema: description: Whether the entry should be enabled for login. type: boolean - description: A TFA entry id. in: path name: id required: true schema: description: A TFA entry id. type: string - description: The current password of the user performing the change. in: query name: password required: false schema: description: The current password of the user performing the change. type: string - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string requestBody: content: application/json: schema: properties: description: description: A description to distinguish multiple entries from one another type: string enable: description: Whether the entry should be enabled for login. type: boolean id: description: A TFA entry id. type: string password: description: The current password of the user performing the change. type: string userid: description: Full User ID, in the `name@realm` format. format: pve-userid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add a TFA entry for a user. /access/ticket: get: operationId: get_access_ticket responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Dummy. Useful for formatters which want to provide a login page. post: operationId: post_access_ticket parameters: - description: This parameter is now ignored and assumed to be 1. in: query name: new-format required: false schema: description: This parameter is now ignored and assumed to be 1. type: boolean - description: One-time password for Two-factor authentication. in: query name: otp required: false schema: description: One-time password for Two-factor authentication. type: string - description: The secret password. This can also be a valid ticket. in: query name: password required: false schema: description: The secret password. This can also be a valid ticket. type: string - description: Verify ticket, and check if user have access 'privs' on 'path' in: query name: path required: false schema: description: Verify ticket, and check if user have access 'privs' on 'path' type: string - description: Verify ticket, and check if user have access 'privs' on 'path' in: query name: privs required: false schema: description: Verify ticket, and check if user have access 'privs' on 'path' format: pve-priv-list type: string - description: You can optionally pass the realm using this parameter. Normally the realm is simply added to the username @. in: query name: realm required: false schema: description: You can optionally pass the realm using this parameter. Normally the realm is simply added to the username @. format: pve-realm type: string - description: The signed TFA challenge string the user wants to respond to. in: query name: tfa-challenge required: false schema: description: The signed TFA challenge string the user wants to respond to. type: string - description: User name in: query name: username required: false schema: description: User name type: string requestBody: content: application/json: schema: properties: new-format: description: This parameter is now ignored and assumed to be 1. type: boolean otp: description: One-time password for Two-factor authentication. type: string password: description: The secret password. This can also be a valid ticket. type: string path: description: Verify ticket, and check if user have access 'privs' on 'path' type: string privs: description: Verify ticket, and check if user have access 'privs' on 'path' format: pve-priv-list type: string realm: description: You can optionally pass the realm using this parameter. Normally the realm is simply added to the username @. format: pve-realm type: string tfa-challenge: description: The signed TFA challenge string the user wants to respond to. type: string username: description: User name type: string type: object responses: "200": content: application/json: schema: properties: CSRFPreventionToken: type: string clustername: type: string ticket: type: string username: type: string type: object description: OK summary: Create or verify authentication ticket. /access/users: get: operationId: get_access_users parameters: - description: Optional filter for enable property. in: query name: enabled required: false schema: description: Optional filter for enable property. type: boolean - description: Include group and token information. in: query name: full required: false schema: description: Include group and token information. type: boolean responses: "200": content: application/json: schema: items: properties: comment: type: string email: format: email-opt type: string enable: description: Enable the account (default). You can set this to '0' to disable the account type: boolean expire: description: Account expiration date (seconds since epoch). '0' means no expiration date. type: integer firstname: type: string groups: format: pve-groupid-list type: string keys: description: Keys for two factor auth (yubico). type: string lastname: type: string realm-type: description: The type of the users realm format: pve-realm type: string tfa-locked-until: description: Contains a timestamp until when a user is locked out of 2nd factors. type: integer tokens: items: properties: comment: type: string expire: description: API token expiration date (seconds since epoch). '0' means no expiration date. type: integer privsep: description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. type: boolean tokenid: description: User-specific token identifier. type: string type: object type: array totp-locked: description: True if the user is currently locked out of TOTP factors. type: boolean userid: description: Full User ID, in the `name@realm` format. format: pve-userid type: string type: object type: array description: OK summary: User index. post: operationId: post_access_users parameters: - description: "" in: query name: comment required: false schema: type: string - description: "" in: query name: email required: false schema: format: email-opt type: string - description: Enable the account (default). You can set this to '0' to disable the account in: query name: enable required: false schema: description: Enable the account (default). You can set this to '0' to disable the account type: boolean - description: Account expiration date (seconds since epoch). '0' means no expiration date. in: query name: expire required: false schema: description: Account expiration date (seconds since epoch). '0' means no expiration date. type: integer - description: "" in: query name: firstname required: false schema: type: string - description: "" in: query name: groups required: false schema: format: pve-groupid-list type: string - description: Keys for two factor auth (yubico). in: query name: keys required: false schema: description: Keys for two factor auth (yubico). type: string - description: "" in: query name: lastname required: false schema: type: string - description: Initial password. in: query name: password required: false schema: description: Initial password. type: string - description: Full User ID, in the `name@realm` format. in: query name: userid required: false schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string requestBody: content: application/json: schema: properties: comment: type: string email: format: email-opt type: string enable: description: Enable the account (default). You can set this to '0' to disable the account type: boolean expire: description: Account expiration date (seconds since epoch). '0' means no expiration date. type: integer firstname: type: string groups: format: pve-groupid-list type: string keys: description: Keys for two factor auth (yubico). type: string lastname: type: string password: description: Initial password. type: string userid: description: Full User ID, in the `name@realm` format. format: pve-userid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new user. /access/users/{userid}: delete: operationId: delete_access_users_userid parameters: - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete user. get: operationId: get_access_users_userid parameters: - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string responses: "200": content: application/json: schema: properties: comment: type: string email: format: email-opt type: string enable: description: Enable the account (default). You can set this to '0' to disable the account type: boolean expire: description: Account expiration date (seconds since epoch). '0' means no expiration date. type: integer firstname: type: string groups: items: format: pve-groupid type: string type: array keys: description: Keys for two factor auth (yubico). type: string lastname: type: string tokens: type: object type: object description: OK summary: Get user configuration. put: operationId: put_access_users_userid parameters: - description: "" in: query name: append required: false schema: type: boolean - description: "" in: query name: comment required: false schema: type: string - description: "" in: query name: email required: false schema: format: email-opt type: string - description: Enable the account (default). You can set this to '0' to disable the account in: query name: enable required: false schema: description: Enable the account (default). You can set this to '0' to disable the account type: boolean - description: Account expiration date (seconds since epoch). '0' means no expiration date. in: query name: expire required: false schema: description: Account expiration date (seconds since epoch). '0' means no expiration date. type: integer - description: "" in: query name: firstname required: false schema: type: string - description: "" in: query name: groups required: false schema: format: pve-groupid-list type: string - description: Keys for two factor auth (yubico). in: query name: keys required: false schema: description: Keys for two factor auth (yubico). type: string - description: "" in: query name: lastname required: false schema: type: string - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string requestBody: content: application/json: schema: properties: append: type: boolean comment: type: string email: format: email-opt type: string enable: description: Enable the account (default). You can set this to '0' to disable the account type: boolean expire: description: Account expiration date (seconds since epoch). '0' means no expiration date. type: integer firstname: type: string groups: format: pve-groupid-list type: string keys: description: Keys for two factor auth (yubico). type: string lastname: type: string userid: description: Full User ID, in the `name@realm` format. format: pve-userid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update user configuration. /access/users/{userid}/tfa: get: operationId: get_access_users_userid_tfa parameters: - description: Request all entries as an array. in: query name: multiple required: false schema: description: Request all entries as an array. type: boolean - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string responses: "200": content: application/json: schema: properties: realm: description: The type of TFA the users realm has set, if any. enum: - oath - yubico type: string types: description: Array of the user configured TFA types, if any. Only available if 'multiple' was not passed. items: description: A TFA type. enum: - totp - u2f - yubico - webauthn - recovedry type: string type: array user: description: The type of TFA the user has set, if any. Only set if 'multiple' was not passed. enum: - oath - u2f type: string type: object description: OK summary: Get user TFA types (Personal and Realm). /access/users/{userid}/token: get: operationId: get_access_users_userid_token parameters: - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string responses: "200": content: application/json: schema: items: properties: comment: type: string expire: description: API token expiration date (seconds since epoch). '0' means no expiration date. type: integer privsep: description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. type: boolean tokenid: description: User-specific token identifier. type: string type: object type: array description: OK summary: Get user API tokens. /access/users/{userid}/token/{tokenid}: delete: operationId: delete_access_users_userid_token_tokenid parameters: - description: User-specific token identifier. in: path name: tokenid required: true schema: description: User-specific token identifier. type: string - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove API token for a specific user. get: operationId: get_access_users_userid_token_tokenid parameters: - description: User-specific token identifier. in: path name: tokenid required: true schema: description: User-specific token identifier. type: string - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string responses: "200": content: application/json: schema: properties: comment: type: string expire: description: API token expiration date (seconds since epoch). '0' means no expiration date. type: integer privsep: description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. type: boolean type: object description: OK summary: Get specific API token information. post: operationId: post_access_users_userid_token_tokenid parameters: - description: "" in: query name: comment required: false schema: type: string - description: API token expiration date (seconds since epoch). '0' means no expiration date. in: query name: expire required: false schema: description: API token expiration date (seconds since epoch). '0' means no expiration date. type: integer - description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. in: query name: privsep required: false schema: description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. type: boolean - description: User-specific token identifier. in: path name: tokenid required: true schema: description: User-specific token identifier. type: string - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string requestBody: content: application/json: schema: properties: comment: type: string expire: description: API token expiration date (seconds since epoch). '0' means no expiration date. type: integer privsep: description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. type: boolean tokenid: description: User-specific token identifier. type: string userid: description: Full User ID, in the `name@realm` format. format: pve-userid type: string type: object responses: "200": content: application/json: schema: properties: full-tokenid: description: The full token id. type: string info: properties: comment: type: string expire: description: API token expiration date (seconds since epoch). '0' means no expiration date. type: integer privsep: description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. type: boolean type: object value: description: API token value used for authentication. type: string type: object description: OK summary: 'Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards!' put: operationId: put_access_users_userid_token_tokenid parameters: - description: "" in: query name: comment required: false schema: type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: API token expiration date (seconds since epoch). '0' means no expiration date. in: query name: expire required: false schema: description: API token expiration date (seconds since epoch). '0' means no expiration date. type: integer - description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. in: query name: privsep required: false schema: description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. type: boolean - description: Regenerate the token's secret value. All users of the previous secret will lose access after this operation. in: query name: regenerate required: false schema: description: Regenerate the token's secret value. All users of the previous secret will lose access after this operation. type: boolean - description: User-specific token identifier. in: path name: tokenid required: true schema: description: User-specific token identifier. type: string - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string requestBody: content: application/json: schema: properties: comment: type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string expire: description: API token expiration date (seconds since epoch). '0' means no expiration date. type: integer privsep: description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. type: boolean regenerate: description: Regenerate the token's secret value. All users of the previous secret will lose access after this operation. type: boolean tokenid: description: User-specific token identifier. type: string userid: description: Full User ID, in the `name@realm` format. format: pve-userid type: string type: object responses: "200": content: application/json: schema: properties: comment: type: string expire: description: API token expiration date (seconds since epoch). '0' means no expiration date. type: integer full-tokenid: description: The full token id. Only set when 'regenerate' was set. type: string privsep: description: Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. type: boolean value: description: API token value used for authentication. Only set when 'regenerate' was set. type: string type: object description: OK summary: 'Update API token for a specific user. NOTE: when ''regenerate'' is set, the returned token value needs to be stored as it cannot be retrieved afterwards!' /access/users/{userid}/unlock-tfa: put: operationId: put_access_users_userid_unlock_tfa parameters: - description: Full User ID, in the `name@realm` format. in: path name: userid required: true schema: description: Full User ID, in the `name@realm` format. format: pve-userid type: string requestBody: content: application/json: schema: properties: userid: description: Full User ID, in the `name@realm` format. format: pve-userid type: string type: object responses: "200": content: application/json: schema: type: boolean description: OK summary: Unlock a user's TFA authentication. /access/vncticket: post: operationId: post_access_vncticket parameters: - description: UserId or token in: query name: authid required: false schema: description: UserId or token type: string - description: Verify ticket, and check if user have access 'privs' on 'path' in: query name: path required: false schema: description: Verify ticket, and check if user have access 'privs' on 'path' type: string - description: Verify that the ticket is valid for this port. in: query name: port required: false schema: description: Verify that the ticket is valid for this port. type: integer - description: Verify ticket, and check if user have access 'privs' on 'path' in: query name: privs required: false schema: description: Verify ticket, and check if user have access 'privs' on 'path' format: pve-priv-list type: string - description: The VNC ticket. in: query name: vncticket required: false schema: description: The VNC ticket. type: string requestBody: content: application/json: schema: properties: authid: description: UserId or token type: string path: description: Verify ticket, and check if user have access 'privs' on 'path' type: string port: description: Verify that the ticket is valid for this port. type: integer privs: description: Verify ticket, and check if user have access 'privs' on 'path' format: pve-priv-list type: string vncticket: description: The VNC ticket. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: verify VNC authentication ticket. /cluster: get: operationId: get_cluster responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Cluster index. /cluster/acme: get: operationId: get_cluster_acme responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: ACMEAccount index. /cluster/acme/account: get: operationId: get_cluster_acme_account responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: ACMEAccount index. post: operationId: post_cluster_acme_account parameters: - description: Contact email addresses. in: query name: contact required: false schema: description: Contact email addresses. format: email-list type: string - description: URL of ACME CA directory endpoint. in: query name: directory required: false schema: description: URL of ACME CA directory endpoint. type: string - description: HMAC key for External Account Binding. in: query name: eab-hmac-key required: false schema: description: HMAC key for External Account Binding. type: string - description: Key Identifier for External Account Binding. in: query name: eab-kid required: false schema: description: Key Identifier for External Account Binding. type: string - description: ACME account config file name. in: query name: name required: false schema: description: ACME account config file name. format: pve-configid type: string - description: URL of CA TermsOfService - setting this indicates agreement. in: query name: tos_url required: false schema: description: URL of CA TermsOfService - setting this indicates agreement. type: string requestBody: content: application/json: schema: properties: contact: description: Contact email addresses. format: email-list type: string directory: description: URL of ACME CA directory endpoint. type: string eab-hmac-key: description: HMAC key for External Account Binding. type: string eab-kid: description: Key Identifier for External Account Binding. type: string name: description: ACME account config file name. format: pve-configid type: string tos_url: description: URL of CA TermsOfService - setting this indicates agreement. type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Register a new ACME account with CA. /cluster/acme/account/{name}: delete: operationId: delete_cluster_acme_account_name parameters: - description: ACME account config file name. in: path name: name required: true schema: description: ACME account config file name. format: pve-configid type: string responses: "200": content: application/json: schema: type: string description: OK summary: Deactivate existing ACME account at CA. get: operationId: get_cluster_acme_account_name parameters: - description: ACME account config file name. in: path name: name required: true schema: description: ACME account config file name. format: pve-configid type: string responses: "200": content: application/json: schema: properties: account: type: object directory: description: URL of ACME CA directory endpoint. type: string location: type: string tos: type: string type: object description: OK summary: Return existing ACME account information. put: operationId: put_cluster_acme_account_name parameters: - description: Contact email addresses. in: query name: contact required: false schema: description: Contact email addresses. format: email-list type: string - description: ACME account config file name. in: path name: name required: true schema: description: ACME account config file name. format: pve-configid type: string requestBody: content: application/json: schema: properties: contact: description: Contact email addresses. format: email-list type: string name: description: ACME account config file name. format: pve-configid type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: 'Update existing ACME account information with CA. Note: not specifying any new account information triggers a refresh.' /cluster/acme/challenge-schema: get: operationId: get_cluster_acme_challenge_schema responses: "200": content: application/json: schema: items: properties: id: type: string name: description: Human readable name, falls back to id type: string schema: type: object type: type: string type: object type: array description: OK summary: Get schema of ACME challenge types. /cluster/acme/directories: get: operationId: get_cluster_acme_directories responses: "200": content: application/json: schema: items: properties: name: type: string url: description: URL of ACME CA directory endpoint. type: string type: object type: array description: OK summary: Get named known ACME directory endpoints. /cluster/acme/meta: get: operationId: get_cluster_acme_meta parameters: - description: URL of ACME CA directory endpoint. in: query name: directory required: false schema: description: URL of ACME CA directory endpoint. type: string responses: "200": content: application/json: schema: properties: caaIdentities: description: Hostnames referring to the ACME servers. items: type: string type: array externalAccountRequired: description: EAB Required type: boolean termsOfService: description: ACME TermsOfService URL. type: string website: description: URL to more information about the ACME server. type: string type: object description: OK summary: Retrieve ACME Directory Meta Information /cluster/acme/plugins: get: operationId: get_cluster_acme_plugins parameters: - description: Only list ACME plugins of a specific type in: query name: type required: false schema: description: Only list ACME plugins of a specific type enum: - dns - standalone type: string responses: "200": content: application/json: schema: items: properties: api: description: API plugin name enum: - 1984hosting - acmedns - acmeproxy - active24 - ad - ali - alviy - anx - artfiles - arvan - aurora - autodns - aws - azion - azure - beget - bookmyname - bunny - cf - clouddns - cloudns - cn - conoha - constellix - cpanel - curanet - cyon - da - ddnss - desec - df - dgon - dnsexit - dnshome - dnsimple - dnsservices - doapi - domeneshop - dp - dpi - dreamhost - duckdns - durabledns - dyn - dynu - dynv6 - easydns - edgecenter - edgedns - euserv - exoscale - fornex - freedns - freemyip - gandi_livedns - gcloud - gcore - gd - geoscaling - googledomains - he - he_ddns - hetzner - hetznercloud - hexonet - hostingde - huaweicloud - infoblox - infomaniak - internetbs - inwx - ionos - ionos_cloud - ipv64 - ispconfig - jd - joker - kappernet - kas - kinghost - knot - la - leaseweb - lexicon - limacity - linode - linode_v4 - loopia - lua - maradns - me - miab - mijnhost - misaka - myapi - mydevil - mydnsjp - mythic_beasts - namecheap - namecom - namesilo - nanelo - nederhost - neodigit - netcup - netlify - nic - njalla - nm - nsd - nsone - nsupdate - nw - oci - omglol - one - online - openprovider - openprovider_rest - openstack - opnsense - ovh - pdns - pleskxml - pointhq - porkbun - rackcorp - rackspace - rage4 - rcode0 - regru - scaleway - schlundtech - selectel - selfhost - servercow - simply - spaceship - technitium - tele3 - tencent - timeweb - transip - udr - ultra - unoeuro - variomedia - veesp - vercel - vscale - vultr - websupport - west_cn - world4you - yandex360 - yc - zilore - zone - zoneedit - zonomi type: string data: description: DNS plugin data. (base64 encoded) type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Flag to disable the config. type: boolean nodes: description: List of cluster node names. format: pve-node-list type: string plugin: description: Unique identifier for ACME plugin instance. format: pve-configid type: string type: description: ACME challenge type. enum: - dns - standalone type: string validation-delay: description: Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. type: integer type: object type: array description: OK summary: ACME plugin index. post: operationId: post_cluster_acme_plugins parameters: - description: API plugin name in: query name: api required: false schema: description: API plugin name enum: - 1984hosting - acmedns - acmeproxy - active24 - ad - ali - alviy - anx - artfiles - arvan - aurora - autodns - aws - azion - azure - beget - bookmyname - bunny - cf - clouddns - cloudns - cn - conoha - constellix - cpanel - curanet - cyon - da - ddnss - desec - df - dgon - dnsexit - dnshome - dnsimple - dnsservices - doapi - domeneshop - dp - dpi - dreamhost - duckdns - durabledns - dyn - dynu - dynv6 - easydns - edgecenter - edgedns - euserv - exoscale - fornex - freedns - freemyip - gandi_livedns - gcloud - gcore - gd - geoscaling - googledomains - he - he_ddns - hetzner - hetznercloud - hexonet - hostingde - huaweicloud - infoblox - infomaniak - internetbs - inwx - ionos - ionos_cloud - ipv64 - ispconfig - jd - joker - kappernet - kas - kinghost - knot - la - leaseweb - lexicon - limacity - linode - linode_v4 - loopia - lua - maradns - me - miab - mijnhost - misaka - myapi - mydevil - mydnsjp - mythic_beasts - namecheap - namecom - namesilo - nanelo - nederhost - neodigit - netcup - netlify - nic - njalla - nm - nsd - nsone - nsupdate - nw - oci - omglol - one - online - openprovider - openprovider_rest - openstack - opnsense - ovh - pdns - pleskxml - pointhq - porkbun - rackcorp - rackspace - rage4 - rcode0 - regru - scaleway - schlundtech - selectel - selfhost - servercow - simply - spaceship - technitium - tele3 - tencent - timeweb - transip - udr - ultra - unoeuro - variomedia - veesp - vercel - vscale - vultr - websupport - west_cn - world4you - yandex360 - yc - zilore - zone - zoneedit - zonomi type: string - description: DNS plugin data. (base64 encoded) in: query name: data required: false schema: description: DNS plugin data. (base64 encoded) type: string - description: Flag to disable the config. in: query name: disable required: false schema: description: Flag to disable the config. type: boolean - description: ACME Plugin ID name in: query name: id required: false schema: description: ACME Plugin ID name format: pve-configid type: string - description: List of cluster node names. in: query name: nodes required: false schema: description: List of cluster node names. format: pve-node-list type: string - description: ACME challenge type. in: query name: type required: false schema: description: ACME challenge type. enum: - dns - standalone type: string - description: Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. in: query name: validation-delay required: false schema: description: Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. type: integer requestBody: content: application/json: schema: properties: api: description: API plugin name enum: - 1984hosting - acmedns - acmeproxy - active24 - ad - ali - alviy - anx - artfiles - arvan - aurora - autodns - aws - azion - azure - beget - bookmyname - bunny - cf - clouddns - cloudns - cn - conoha - constellix - cpanel - curanet - cyon - da - ddnss - desec - df - dgon - dnsexit - dnshome - dnsimple - dnsservices - doapi - domeneshop - dp - dpi - dreamhost - duckdns - durabledns - dyn - dynu - dynv6 - easydns - edgecenter - edgedns - euserv - exoscale - fornex - freedns - freemyip - gandi_livedns - gcloud - gcore - gd - geoscaling - googledomains - he - he_ddns - hetzner - hetznercloud - hexonet - hostingde - huaweicloud - infoblox - infomaniak - internetbs - inwx - ionos - ionos_cloud - ipv64 - ispconfig - jd - joker - kappernet - kas - kinghost - knot - la - leaseweb - lexicon - limacity - linode - linode_v4 - loopia - lua - maradns - me - miab - mijnhost - misaka - myapi - mydevil - mydnsjp - mythic_beasts - namecheap - namecom - namesilo - nanelo - nederhost - neodigit - netcup - netlify - nic - njalla - nm - nsd - nsone - nsupdate - nw - oci - omglol - one - online - openprovider - openprovider_rest - openstack - opnsense - ovh - pdns - pleskxml - pointhq - porkbun - rackcorp - rackspace - rage4 - rcode0 - regru - scaleway - schlundtech - selectel - selfhost - servercow - simply - spaceship - technitium - tele3 - tencent - timeweb - transip - udr - ultra - unoeuro - variomedia - veesp - vercel - vscale - vultr - websupport - west_cn - world4you - yandex360 - yc - zilore - zone - zoneedit - zonomi type: string data: description: DNS plugin data. (base64 encoded) type: string disable: description: Flag to disable the config. type: boolean id: description: ACME Plugin ID name format: pve-configid type: string nodes: description: List of cluster node names. format: pve-node-list type: string type: description: ACME challenge type. enum: - dns - standalone type: string validation-delay: description: Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add ACME plugin configuration. /cluster/acme/plugins/{id}: delete: operationId: delete_cluster_acme_plugins_id parameters: - description: Unique identifier for ACME plugin instance. in: path name: id required: true schema: description: Unique identifier for ACME plugin instance. format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete ACME plugin configuration. get: operationId: get_cluster_acme_plugins_id parameters: - description: Unique identifier for ACME plugin instance. in: path name: id required: true schema: description: Unique identifier for ACME plugin instance. format: pve-configid type: string responses: "200": content: application/json: schema: properties: api: description: API plugin name enum: - 1984hosting - acmedns - acmeproxy - active24 - ad - ali - alviy - anx - artfiles - arvan - aurora - autodns - aws - azion - azure - beget - bookmyname - bunny - cf - clouddns - cloudns - cn - conoha - constellix - cpanel - curanet - cyon - da - ddnss - desec - df - dgon - dnsexit - dnshome - dnsimple - dnsservices - doapi - domeneshop - dp - dpi - dreamhost - duckdns - durabledns - dyn - dynu - dynv6 - easydns - edgecenter - edgedns - euserv - exoscale - fornex - freedns - freemyip - gandi_livedns - gcloud - gcore - gd - geoscaling - googledomains - he - he_ddns - hetzner - hetznercloud - hexonet - hostingde - huaweicloud - infoblox - infomaniak - internetbs - inwx - ionos - ionos_cloud - ipv64 - ispconfig - jd - joker - kappernet - kas - kinghost - knot - la - leaseweb - lexicon - limacity - linode - linode_v4 - loopia - lua - maradns - me - miab - mijnhost - misaka - myapi - mydevil - mydnsjp - mythic_beasts - namecheap - namecom - namesilo - nanelo - nederhost - neodigit - netcup - netlify - nic - njalla - nm - nsd - nsone - nsupdate - nw - oci - omglol - one - online - openprovider - openprovider_rest - openstack - opnsense - ovh - pdns - pleskxml - pointhq - porkbun - rackcorp - rackspace - rage4 - rcode0 - regru - scaleway - schlundtech - selectel - selfhost - servercow - simply - spaceship - technitium - tele3 - tencent - timeweb - transip - udr - ultra - unoeuro - variomedia - veesp - vercel - vscale - vultr - websupport - west_cn - world4you - yandex360 - yc - zilore - zone - zoneedit - zonomi type: string data: description: DNS plugin data. (base64 encoded) type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Flag to disable the config. type: boolean nodes: description: List of cluster node names. format: pve-node-list type: string plugin: description: Unique identifier for ACME plugin instance. format: pve-configid type: string type: description: ACME challenge type. enum: - dns - standalone type: string validation-delay: description: Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. type: integer type: object description: OK summary: Get ACME plugin configuration. put: operationId: put_cluster_acme_plugins_id parameters: - description: API plugin name in: query name: api required: false schema: description: API plugin name enum: - 1984hosting - acmedns - acmeproxy - active24 - ad - ali - alviy - anx - artfiles - arvan - aurora - autodns - aws - azion - azure - beget - bookmyname - bunny - cf - clouddns - cloudns - cn - conoha - constellix - cpanel - curanet - cyon - da - ddnss - desec - df - dgon - dnsexit - dnshome - dnsimple - dnsservices - doapi - domeneshop - dp - dpi - dreamhost - duckdns - durabledns - dyn - dynu - dynv6 - easydns - edgecenter - edgedns - euserv - exoscale - fornex - freedns - freemyip - gandi_livedns - gcloud - gcore - gd - geoscaling - googledomains - he - he_ddns - hetzner - hetznercloud - hexonet - hostingde - huaweicloud - infoblox - infomaniak - internetbs - inwx - ionos - ionos_cloud - ipv64 - ispconfig - jd - joker - kappernet - kas - kinghost - knot - la - leaseweb - lexicon - limacity - linode - linode_v4 - loopia - lua - maradns - me - miab - mijnhost - misaka - myapi - mydevil - mydnsjp - mythic_beasts - namecheap - namecom - namesilo - nanelo - nederhost - neodigit - netcup - netlify - nic - njalla - nm - nsd - nsone - nsupdate - nw - oci - omglol - one - online - openprovider - openprovider_rest - openstack - opnsense - ovh - pdns - pleskxml - pointhq - porkbun - rackcorp - rackspace - rage4 - rcode0 - regru - scaleway - schlundtech - selectel - selfhost - servercow - simply - spaceship - technitium - tele3 - tencent - timeweb - transip - udr - ultra - unoeuro - variomedia - veesp - vercel - vscale - vultr - websupport - west_cn - world4you - yandex360 - yc - zilore - zone - zoneedit - zonomi type: string - description: DNS plugin data. (base64 encoded) in: query name: data required: false schema: description: DNS plugin data. (base64 encoded) type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Flag to disable the config. in: query name: disable required: false schema: description: Flag to disable the config. type: boolean - description: ACME Plugin ID name in: path name: id required: true schema: description: ACME Plugin ID name format: pve-configid type: string - description: List of cluster node names. in: query name: nodes required: false schema: description: List of cluster node names. format: pve-node-list type: string - description: Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. in: query name: validation-delay required: false schema: description: Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. type: integer requestBody: content: application/json: schema: properties: api: description: API plugin name enum: - 1984hosting - acmedns - acmeproxy - active24 - ad - ali - alviy - anx - artfiles - arvan - aurora - autodns - aws - azion - azure - beget - bookmyname - bunny - cf - clouddns - cloudns - cn - conoha - constellix - cpanel - curanet - cyon - da - ddnss - desec - df - dgon - dnsexit - dnshome - dnsimple - dnsservices - doapi - domeneshop - dp - dpi - dreamhost - duckdns - durabledns - dyn - dynu - dynv6 - easydns - edgecenter - edgedns - euserv - exoscale - fornex - freedns - freemyip - gandi_livedns - gcloud - gcore - gd - geoscaling - googledomains - he - he_ddns - hetzner - hetznercloud - hexonet - hostingde - huaweicloud - infoblox - infomaniak - internetbs - inwx - ionos - ionos_cloud - ipv64 - ispconfig - jd - joker - kappernet - kas - kinghost - knot - la - leaseweb - lexicon - limacity - linode - linode_v4 - loopia - lua - maradns - me - miab - mijnhost - misaka - myapi - mydevil - mydnsjp - mythic_beasts - namecheap - namecom - namesilo - nanelo - nederhost - neodigit - netcup - netlify - nic - njalla - nm - nsd - nsone - nsupdate - nw - oci - omglol - one - online - openprovider - openprovider_rest - openstack - opnsense - ovh - pdns - pleskxml - pointhq - porkbun - rackcorp - rackspace - rage4 - rcode0 - regru - scaleway - schlundtech - selectel - selfhost - servercow - simply - spaceship - technitium - tele3 - tencent - timeweb - transip - udr - ultra - unoeuro - variomedia - veesp - vercel - vscale - vultr - websupport - west_cn - world4you - yandex360 - yc - zilore - zone - zoneedit - zonomi type: string data: description: DNS plugin data. (base64 encoded) type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Flag to disable the config. type: boolean id: description: ACME Plugin ID name format: pve-configid type: string nodes: description: List of cluster node names. format: pve-node-list type: string validation-delay: description: Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update ACME plugin configuration. /cluster/acme/tos: get: operationId: get_cluster_acme_tos parameters: - description: URL of ACME CA directory endpoint. in: query name: directory required: false schema: description: URL of ACME CA directory endpoint. type: string responses: "200": content: application/json: schema: description: ACME TermsOfService URL. type: string description: OK summary: Retrieve ACME TermsOfService URL from CA. Deprecated, please use /cluster/acme/meta. /cluster/backup: get: operationId: get_cluster_backup responses: "200": content: application/json: schema: items: properties: all: description: Backup all known guest systems on this host. type: boolean bwlimit: description: Limit I/O bandwidth (in KiB/s). type: integer comment: description: Description for the Job. type: string compress: description: Compress dump file. enum: - "0" - "1" - gzip - lzo - zstd type: string dumpdir: description: Store resulting files to specified directory. type: string enabled: description: Enable or disable the job. type: boolean exclude: description: Exclude specified guest systems (assumes --all) format: pve-vmid-list type: string exclude-path: description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. items: type: string type: array fleecing: description: Options for backup fleecing (VM only). properties: enabled: description: Enable backup fleecing. Cache backup data from blocks where new guest writes happen on specified storage instead of copying them directly to the backup target. This can help guest IO performance and even prevent hangs, at the cost of requiring more storage space. type: boolean storage: description: Use this storage to storage fleecing images. For efficient space usage, it's best to use a local storage that supports discard and either thin provisioning or sparse files. format: pve-storage-id type: string type: object id: description: The job ID. type: string ionice: description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. type: integer lockwait: description: Maximal time to wait for the global lock (minutes). type: integer mailnotification: description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' enum: - always - failure type: string mailto: description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' format: email-or-username-list type: string mode: description: Backup mode. enum: - snapshot - suspend - stop type: string next-run: description: UNIX timestamp when this backup job will be executed next type: integer node: description: Only run if executed on this node. format: pve-node type: string notes-template: description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. type: string notification-mode: description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. enum: - auto - legacy-sendmail - notification-system type: string pbs-change-detection-mode: description: PBS mode used to detect file changes and switch encoding format for container backups. enum: - legacy - data - metadata type: string performance: description: Other performance-related settings. properties: max-workers: description: Applies to VMs. Allow up to this many IO workers at the same time. type: integer pbs-entries-max: description: Applies to container backups sent to PBS. Limits the number of entries allowed in memory at a given time to avoid unintended OOM situations. Increase it to enable backups of containers with a large amount of files. type: integer type: object pigz: description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. type: integer pool: description: Backup all known guest systems included in the specified pool. type: string protected: description: If true, mark backup(s) as protected. type: boolean prune-backups: description: Use these retention options instead of those from the storage configuration. properties: keep-all: description: Keep all backups. Conflicts with the other options when true. type: boolean keep-daily: description: Keep backups for the last different days. If there is morethan one backup for a single day, only the latest one is kept. type: integer keep-hourly: description: Keep backups for the last different hours. If there is morethan one backup for a single hour, only the latest one is kept. type: integer keep-last: description: Keep the last backups. type: integer keep-monthly: description: Keep backups for the last different months. If there is morethan one backup for a single month, only the latest one is kept. type: integer keep-weekly: description: Keep backups for the last different weeks. If there is morethan one backup for a single week, only the latest one is kept. type: integer keep-yearly: description: Keep backups for the last different years. If there is morethan one backup for a single year, only the latest one is kept. type: integer type: object quiet: description: Be quiet. type: boolean remove: description: Prune older backups according to 'prune-backups'. type: boolean repeat-missed: description: If true, the job will be run as soon as possible if it was missed while the scheduler was not running. type: boolean schedule: description: Backup schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string script: description: Use specified hook script. type: string stdexcludes: description: Exclude temporary files and logs. type: boolean stop: description: Stop running backup jobs on this host. type: boolean stopwait: description: Maximal time to wait until a guest system is stopped (minutes). type: integer storage: description: Store resulting file to this storage. format: pve-storage-id type: string tmpdir: description: Store temporary files to specified directory. type: string vmid: description: The ID of the guest system you want to backup. format: pve-vmid-list type: string zstd: description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. type: integer type: object type: array description: OK summary: List vzdump backup schedule. post: operationId: post_cluster_backup parameters: - description: Backup all known guest systems on this host. in: query name: all required: false schema: description: Backup all known guest systems on this host. type: boolean - description: Limit I/O bandwidth (in KiB/s). in: query name: bwlimit required: false schema: description: Limit I/O bandwidth (in KiB/s). type: integer - description: Description for the Job. in: query name: comment required: false schema: description: Description for the Job. type: string - description: Compress dump file. in: query name: compress required: false schema: description: Compress dump file. enum: - "0" - "1" - gzip - lzo - zstd type: string - description: 'Deprecated: Use ''schedule'' instead. Day of week selection. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' in: query name: dow required: false schema: description: 'Deprecated: Use ''schedule'' instead. Day of week selection. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' format: pve-day-of-week-list type: string - description: Store resulting files to specified directory. in: query name: dumpdir required: false schema: description: Store resulting files to specified directory. type: string - description: Enable or disable the job. in: query name: enabled required: false schema: description: Enable or disable the job. type: boolean - description: Exclude specified guest systems (assumes --all) in: query name: exclude required: false schema: description: Exclude specified guest systems (assumes --all) format: pve-vmid-list type: string - description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. in: query name: exclude-path required: false schema: description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. items: type: string type: array - description: Options for backup fleecing (VM only). in: query name: fleecing required: false schema: description: Options for backup fleecing (VM only). format: backup-fleecing type: string - description: Job ID (will be autogenerated). in: query name: id required: false schema: description: Job ID (will be autogenerated). format: pve-configid type: string - description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. in: query name: ionice required: false schema: description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. type: integer - description: Maximal time to wait for the global lock (minutes). in: query name: lockwait required: false schema: description: Maximal time to wait for the global lock (minutes). type: integer - description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' in: query name: mailnotification required: false schema: description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' enum: - always - failure type: string - description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' in: query name: mailto required: false schema: description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' format: email-or-username-list type: string - description: Backup mode. in: query name: mode required: false schema: description: Backup mode. enum: - snapshot - suspend - stop type: string - description: Only run if executed on this node. in: query name: node required: false schema: description: Only run if executed on this node. format: pve-node type: string - description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. in: query name: notes-template required: false schema: description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. type: string - description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. in: query name: notification-mode required: false schema: description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. enum: - auto - legacy-sendmail - notification-system type: string - description: PBS mode used to detect file changes and switch encoding format for container backups. in: query name: pbs-change-detection-mode required: false schema: description: PBS mode used to detect file changes and switch encoding format for container backups. enum: - legacy - data - metadata type: string - description: Other performance-related settings. in: query name: performance required: false schema: description: Other performance-related settings. format: backup-performance type: string - description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. in: query name: pigz required: false schema: description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. type: integer - description: Backup all known guest systems included in the specified pool. in: query name: pool required: false schema: description: Backup all known guest systems included in the specified pool. type: string - description: If true, mark backup(s) as protected. in: query name: protected required: false schema: description: If true, mark backup(s) as protected. type: boolean - description: Use these retention options instead of those from the storage configuration. in: query name: prune-backups required: false schema: description: Use these retention options instead of those from the storage configuration. format: prune-backups type: string - description: Be quiet. in: query name: quiet required: false schema: description: Be quiet. type: boolean - description: Prune older backups according to 'prune-backups'. in: query name: remove required: false schema: description: Prune older backups according to 'prune-backups'. type: boolean - description: If true, the job will be run as soon as possible if it was missed while the scheduler was not running. in: query name: repeat-missed required: false schema: description: If true, the job will be run as soon as possible if it was missed while the scheduler was not running. type: boolean - description: Backup schedule. The format is a subset of `systemd` calendar events. in: query name: schedule required: false schema: description: Backup schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string - description: Use specified hook script. in: query name: script required: false schema: description: Use specified hook script. type: string - description: 'Deprecated: Use ''schedule'' instead. Job Start time. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' in: query name: starttime required: false schema: description: 'Deprecated: Use ''schedule'' instead. Job Start time. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' type: string - description: Exclude temporary files and logs. in: query name: stdexcludes required: false schema: description: Exclude temporary files and logs. type: boolean - description: Stop running backup jobs on this host. in: query name: stop required: false schema: description: Stop running backup jobs on this host. type: boolean - description: Maximal time to wait until a guest system is stopped (minutes). in: query name: stopwait required: false schema: description: Maximal time to wait until a guest system is stopped (minutes). type: integer - description: Store resulting file to this storage. in: query name: storage required: false schema: description: Store resulting file to this storage. format: pve-storage-id type: string - description: Store temporary files to specified directory. in: query name: tmpdir required: false schema: description: Store temporary files to specified directory. type: string - description: The ID of the guest system you want to backup. in: query name: vmid required: false schema: description: The ID of the guest system you want to backup. format: pve-vmid-list type: string - description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. in: query name: zstd required: false schema: description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. type: integer requestBody: content: application/json: schema: properties: all: description: Backup all known guest systems on this host. type: boolean bwlimit: description: Limit I/O bandwidth (in KiB/s). type: integer comment: description: Description for the Job. type: string compress: description: Compress dump file. enum: - "0" - "1" - gzip - lzo - zstd type: string dow: description: 'Deprecated: Use ''schedule'' instead. Day of week selection. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' format: pve-day-of-week-list type: string dumpdir: description: Store resulting files to specified directory. type: string enabled: description: Enable or disable the job. type: boolean exclude: description: Exclude specified guest systems (assumes --all) format: pve-vmid-list type: string exclude-path: description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. items: type: string type: array fleecing: description: Options for backup fleecing (VM only). format: backup-fleecing type: string id: description: Job ID (will be autogenerated). format: pve-configid type: string ionice: description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. type: integer lockwait: description: Maximal time to wait for the global lock (minutes). type: integer mailnotification: description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' enum: - always - failure type: string mailto: description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' format: email-or-username-list type: string mode: description: Backup mode. enum: - snapshot - suspend - stop type: string node: description: Only run if executed on this node. format: pve-node type: string notes-template: description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. type: string notification-mode: description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. enum: - auto - legacy-sendmail - notification-system type: string pbs-change-detection-mode: description: PBS mode used to detect file changes and switch encoding format for container backups. enum: - legacy - data - metadata type: string performance: description: Other performance-related settings. format: backup-performance type: string pigz: description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. type: integer pool: description: Backup all known guest systems included in the specified pool. type: string protected: description: If true, mark backup(s) as protected. type: boolean prune-backups: description: Use these retention options instead of those from the storage configuration. format: prune-backups type: string quiet: description: Be quiet. type: boolean remove: description: Prune older backups according to 'prune-backups'. type: boolean repeat-missed: description: If true, the job will be run as soon as possible if it was missed while the scheduler was not running. type: boolean schedule: description: Backup schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string script: description: Use specified hook script. type: string starttime: description: 'Deprecated: Use ''schedule'' instead. Job Start time. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' type: string stdexcludes: description: Exclude temporary files and logs. type: boolean stop: description: Stop running backup jobs on this host. type: boolean stopwait: description: Maximal time to wait until a guest system is stopped (minutes). type: integer storage: description: Store resulting file to this storage. format: pve-storage-id type: string tmpdir: description: Store temporary files to specified directory. type: string vmid: description: The ID of the guest system you want to backup. format: pve-vmid-list type: string zstd: description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new vzdump backup job. /cluster/backup-info: get: operationId: get_cluster_backup_info responses: "200": content: application/json: schema: description: Directory index. items: properties: subdir: description: API sub-directory endpoint type: string type: object type: array description: OK summary: Index for backup info related endpoints /cluster/backup-info/not-backed-up: get: operationId: get_cluster_backup_info_not_backed_up responses: "200": content: application/json: schema: description: Contains the guest objects. items: properties: name: description: Name of the guest type: string type: description: Type of the guest. enum: - qemu - lxc type: string vmid: description: VMID of the guest. type: integer type: object type: array description: OK summary: Shows all guests which are not covered by any backup job. /cluster/backup/{id}: delete: operationId: delete_cluster_backup_id parameters: - description: The job ID. in: path name: id required: true schema: description: The job ID. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete vzdump backup job definition. get: operationId: get_cluster_backup_id parameters: - description: The job ID. in: path name: id required: true schema: description: The job ID. type: string responses: "200": content: application/json: schema: properties: all: description: Backup all known guest systems on this host. type: boolean bwlimit: description: Limit I/O bandwidth (in KiB/s). type: integer comment: description: Description for the Job. type: string compress: description: Compress dump file. enum: - "0" - "1" - gzip - lzo - zstd type: string dumpdir: description: Store resulting files to specified directory. type: string enabled: description: Enable or disable the job. type: boolean exclude: description: Exclude specified guest systems (assumes --all) format: pve-vmid-list type: string exclude-path: description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. items: type: string type: array fleecing: description: Options for backup fleecing (VM only). properties: enabled: description: Enable backup fleecing. Cache backup data from blocks where new guest writes happen on specified storage instead of copying them directly to the backup target. This can help guest IO performance and even prevent hangs, at the cost of requiring more storage space. type: boolean storage: description: Use this storage to storage fleecing images. For efficient space usage, it's best to use a local storage that supports discard and either thin provisioning or sparse files. format: pve-storage-id type: string type: object id: description: The job ID. type: string ionice: description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. type: integer lockwait: description: Maximal time to wait for the global lock (minutes). type: integer mailnotification: description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' enum: - always - failure type: string mailto: description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' format: email-or-username-list type: string mode: description: Backup mode. enum: - snapshot - suspend - stop type: string next-run: description: UNIX timestamp when this backup job will be executed next type: integer node: description: Only run if executed on this node. format: pve-node type: string notes-template: description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. type: string notification-mode: description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. enum: - auto - legacy-sendmail - notification-system type: string pbs-change-detection-mode: description: PBS mode used to detect file changes and switch encoding format for container backups. enum: - legacy - data - metadata type: string performance: description: Other performance-related settings. properties: max-workers: description: Applies to VMs. Allow up to this many IO workers at the same time. type: integer pbs-entries-max: description: Applies to container backups sent to PBS. Limits the number of entries allowed in memory at a given time to avoid unintended OOM situations. Increase it to enable backups of containers with a large amount of files. type: integer type: object pigz: description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. type: integer pool: description: Backup all known guest systems included in the specified pool. type: string protected: description: If true, mark backup(s) as protected. type: boolean prune-backups: description: Use these retention options instead of those from the storage configuration. properties: keep-all: description: Keep all backups. Conflicts with the other options when true. type: boolean keep-daily: description: Keep backups for the last different days. If there is morethan one backup for a single day, only the latest one is kept. type: integer keep-hourly: description: Keep backups for the last different hours. If there is morethan one backup for a single hour, only the latest one is kept. type: integer keep-last: description: Keep the last backups. type: integer keep-monthly: description: Keep backups for the last different months. If there is morethan one backup for a single month, only the latest one is kept. type: integer keep-weekly: description: Keep backups for the last different weeks. If there is morethan one backup for a single week, only the latest one is kept. type: integer keep-yearly: description: Keep backups for the last different years. If there is morethan one backup for a single year, only the latest one is kept. type: integer type: object quiet: description: Be quiet. type: boolean remove: description: Prune older backups according to 'prune-backups'. type: boolean repeat-missed: description: If true, the job will be run as soon as possible if it was missed while the scheduler was not running. type: boolean schedule: description: Backup schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string script: description: Use specified hook script. type: string stdexcludes: description: Exclude temporary files and logs. type: boolean stop: description: Stop running backup jobs on this host. type: boolean stopwait: description: Maximal time to wait until a guest system is stopped (minutes). type: integer storage: description: Store resulting file to this storage. format: pve-storage-id type: string tmpdir: description: Store temporary files to specified directory. type: string vmid: description: The ID of the guest system you want to backup. format: pve-vmid-list type: string zstd: description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. type: integer type: object description: OK summary: Read vzdump backup job definition. put: operationId: put_cluster_backup_id parameters: - description: Backup all known guest systems on this host. in: query name: all required: false schema: description: Backup all known guest systems on this host. type: boolean - description: Limit I/O bandwidth (in KiB/s). in: query name: bwlimit required: false schema: description: Limit I/O bandwidth (in KiB/s). type: integer - description: Description for the Job. in: query name: comment required: false schema: description: Description for the Job. type: string - description: Compress dump file. in: query name: compress required: false schema: description: Compress dump file. enum: - "0" - "1" - gzip - lzo - zstd type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: 'Deprecated: Use ''schedule'' instead. Day of week selection. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' in: query name: dow required: false schema: description: 'Deprecated: Use ''schedule'' instead. Day of week selection. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' format: pve-day-of-week-list type: string - description: Store resulting files to specified directory. in: query name: dumpdir required: false schema: description: Store resulting files to specified directory. type: string - description: Enable or disable the job. in: query name: enabled required: false schema: description: Enable or disable the job. type: boolean - description: Exclude specified guest systems (assumes --all) in: query name: exclude required: false schema: description: Exclude specified guest systems (assumes --all) format: pve-vmid-list type: string - description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. in: query name: exclude-path required: false schema: description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. items: type: string type: array - description: Options for backup fleecing (VM only). in: query name: fleecing required: false schema: description: Options for backup fleecing (VM only). format: backup-fleecing type: string - description: The job ID. in: path name: id required: true schema: description: The job ID. type: string - description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. in: query name: ionice required: false schema: description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. type: integer - description: Maximal time to wait for the global lock (minutes). in: query name: lockwait required: false schema: description: Maximal time to wait for the global lock (minutes). type: integer - description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' in: query name: mailnotification required: false schema: description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' enum: - always - failure type: string - description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' in: query name: mailto required: false schema: description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' format: email-or-username-list type: string - description: Backup mode. in: query name: mode required: false schema: description: Backup mode. enum: - snapshot - suspend - stop type: string - description: Only run if executed on this node. in: query name: node required: false schema: description: Only run if executed on this node. format: pve-node type: string - description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. in: query name: notes-template required: false schema: description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. type: string - description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. in: query name: notification-mode required: false schema: description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. enum: - auto - legacy-sendmail - notification-system type: string - description: PBS mode used to detect file changes and switch encoding format for container backups. in: query name: pbs-change-detection-mode required: false schema: description: PBS mode used to detect file changes and switch encoding format for container backups. enum: - legacy - data - metadata type: string - description: Other performance-related settings. in: query name: performance required: false schema: description: Other performance-related settings. format: backup-performance type: string - description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. in: query name: pigz required: false schema: description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. type: integer - description: Backup all known guest systems included in the specified pool. in: query name: pool required: false schema: description: Backup all known guest systems included in the specified pool. type: string - description: If true, mark backup(s) as protected. in: query name: protected required: false schema: description: If true, mark backup(s) as protected. type: boolean - description: Use these retention options instead of those from the storage configuration. in: query name: prune-backups required: false schema: description: Use these retention options instead of those from the storage configuration. format: prune-backups type: string - description: Be quiet. in: query name: quiet required: false schema: description: Be quiet. type: boolean - description: Prune older backups according to 'prune-backups'. in: query name: remove required: false schema: description: Prune older backups according to 'prune-backups'. type: boolean - description: If true, the job will be run as soon as possible if it was missed while the scheduler was not running. in: query name: repeat-missed required: false schema: description: If true, the job will be run as soon as possible if it was missed while the scheduler was not running. type: boolean - description: Backup schedule. The format is a subset of `systemd` calendar events. in: query name: schedule required: false schema: description: Backup schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string - description: Use specified hook script. in: query name: script required: false schema: description: Use specified hook script. type: string - description: 'Deprecated: Use ''schedule'' instead. Job Start time. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' in: query name: starttime required: false schema: description: 'Deprecated: Use ''schedule'' instead. Job Start time. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' type: string - description: Exclude temporary files and logs. in: query name: stdexcludes required: false schema: description: Exclude temporary files and logs. type: boolean - description: Stop running backup jobs on this host. in: query name: stop required: false schema: description: Stop running backup jobs on this host. type: boolean - description: Maximal time to wait until a guest system is stopped (minutes). in: query name: stopwait required: false schema: description: Maximal time to wait until a guest system is stopped (minutes). type: integer - description: Store resulting file to this storage. in: query name: storage required: false schema: description: Store resulting file to this storage. format: pve-storage-id type: string - description: Store temporary files to specified directory. in: query name: tmpdir required: false schema: description: Store temporary files to specified directory. type: string - description: The ID of the guest system you want to backup. in: query name: vmid required: false schema: description: The ID of the guest system you want to backup. format: pve-vmid-list type: string - description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. in: query name: zstd required: false schema: description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. type: integer requestBody: content: application/json: schema: properties: all: description: Backup all known guest systems on this host. type: boolean bwlimit: description: Limit I/O bandwidth (in KiB/s). type: integer comment: description: Description for the Job. type: string compress: description: Compress dump file. enum: - "0" - "1" - gzip - lzo - zstd type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string dow: description: 'Deprecated: Use ''schedule'' instead. Day of week selection. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' format: pve-day-of-week-list type: string dumpdir: description: Store resulting files to specified directory. type: string enabled: description: Enable or disable the job. type: boolean exclude: description: Exclude specified guest systems (assumes --all) format: pve-vmid-list type: string exclude-path: description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. items: type: string type: array fleecing: description: Options for backup fleecing (VM only). format: backup-fleecing type: string id: description: The job ID. type: string ionice: description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. type: integer lockwait: description: Maximal time to wait for the global lock (minutes). type: integer mailnotification: description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' enum: - always - failure type: string mailto: description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' format: email-or-username-list type: string mode: description: Backup mode. enum: - snapshot - suspend - stop type: string node: description: Only run if executed on this node. format: pve-node type: string notes-template: description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. type: string notification-mode: description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. enum: - auto - legacy-sendmail - notification-system type: string pbs-change-detection-mode: description: PBS mode used to detect file changes and switch encoding format for container backups. enum: - legacy - data - metadata type: string performance: description: Other performance-related settings. format: backup-performance type: string pigz: description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. type: integer pool: description: Backup all known guest systems included in the specified pool. type: string protected: description: If true, mark backup(s) as protected. type: boolean prune-backups: description: Use these retention options instead of those from the storage configuration. format: prune-backups type: string quiet: description: Be quiet. type: boolean remove: description: Prune older backups according to 'prune-backups'. type: boolean repeat-missed: description: If true, the job will be run as soon as possible if it was missed while the scheduler was not running. type: boolean schedule: description: Backup schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string script: description: Use specified hook script. type: string starttime: description: 'Deprecated: Use ''schedule'' instead. Job Start time. ''starttime'' and ''dow'' will be converted into ''schedule'' if used.' type: string stdexcludes: description: Exclude temporary files and logs. type: boolean stop: description: Stop running backup jobs on this host. type: boolean stopwait: description: Maximal time to wait until a guest system is stopped (minutes). type: integer storage: description: Store resulting file to this storage. format: pve-storage-id type: string tmpdir: description: Store temporary files to specified directory. type: string vmid: description: The ID of the guest system you want to backup. format: pve-vmid-list type: string zstd: description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update vzdump backup job definition. /cluster/backup/{id}/included_volumes: get: operationId: get_cluster_backup_id_included_volumes parameters: - description: The job ID. in: path name: id required: true schema: description: The job ID. type: string responses: "200": content: application/json: schema: description: Root node of the tree object. Children represent guests, grandchildren represent volumes of that guest. properties: children: items: properties: children: description: The volumes of the guest with the information if they will be included in backups. items: properties: id: description: Configuration key of the volume. type: string included: description: Whether the volume is included in the backup or not. type: boolean name: description: Name of the volume. type: string reason: description: The reason why the volume is included (or excluded). type: string type: object type: array id: description: VMID of the guest. type: integer name: description: Name of the guest type: string type: description: Type of the guest, VM, CT or unknown for removed but not purged guests. enum: - qemu - lxc - unknown type: string type: object type: array type: object description: OK summary: Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views. /cluster/bulk-action: get: operationId: get_cluster_bulk_action responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: List resource types. /cluster/bulk-action/guest: get: operationId: get_cluster_bulk_action_guest responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Bulk action index. /cluster/bulk-action/guest/migrate: post: operationId: post_cluster_bulk_action_guest_migrate parameters: - description: Defines the maximum number of tasks running concurrently. in: query name: max-workers required: false schema: description: Defines the maximum number of tasks running concurrently. type: integer - description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. in: query name: maxworkers required: false schema: description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. type: integer - description: Enable live migration for VMs and restart migration for CTs. in: query name: online required: false schema: description: Enable live migration for VMs and restart migration for CTs. type: boolean - description: Target node. in: query name: target required: false schema: description: Target node. format: pve-node type: string - description: Only consider guests from this list of VMIDs. in: query name: vms required: false schema: description: Only consider guests from this list of VMIDs. items: description: The (unique) ID of the VM. format: pve-vmid type: integer type: array - description: Enable live storage migration for local disk in: query name: with-local-disks required: false schema: description: Enable live storage migration for local disk type: boolean requestBody: content: application/json: schema: properties: max-workers: description: Defines the maximum number of tasks running concurrently. type: integer maxworkers: description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. type: integer online: description: Enable live migration for VMs and restart migration for CTs. type: boolean target: description: Target node. format: pve-node type: string vms: description: Only consider guests from this list of VMIDs. items: description: The (unique) ID of the VM. format: pve-vmid type: integer type: array with-local-disks: description: Enable live storage migration for local disk type: boolean type: object responses: "200": content: application/json: schema: description: UPID of the worker type: string description: OK summary: Bulk migrate all guests on the cluster. /cluster/bulk-action/guest/shutdown: post: operationId: post_cluster_bulk_action_guest_shutdown parameters: - description: Makes sure the Guest stops after the timeout. in: query name: force-stop required: false schema: description: Makes sure the Guest stops after the timeout. type: boolean - description: Defines the maximum number of tasks running concurrently. in: query name: max-workers required: false schema: description: Defines the maximum number of tasks running concurrently. type: integer - description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. in: query name: maxworkers required: false schema: description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. type: integer - description: Default shutdown timeout in seconds if none is configured for the guest. in: query name: timeout required: false schema: description: Default shutdown timeout in seconds if none is configured for the guest. type: integer - description: Only consider guests from this list of VMIDs. in: query name: vms required: false schema: description: Only consider guests from this list of VMIDs. items: description: The (unique) ID of the VM. format: pve-vmid type: integer type: array requestBody: content: application/json: schema: properties: force-stop: description: Makes sure the Guest stops after the timeout. type: boolean max-workers: description: Defines the maximum number of tasks running concurrently. type: integer maxworkers: description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. type: integer timeout: description: Default shutdown timeout in seconds if none is configured for the guest. type: integer vms: description: Only consider guests from this list of VMIDs. items: description: The (unique) ID of the VM. format: pve-vmid type: integer type: array type: object responses: "200": content: application/json: schema: description: UPID of the worker type: string description: OK summary: Bulk shutdown all guests on the cluster. /cluster/bulk-action/guest/start: post: operationId: post_cluster_bulk_action_guest_start parameters: - description: Defines the maximum number of tasks running concurrently. in: query name: max-workers required: false schema: description: Defines the maximum number of tasks running concurrently. type: integer - description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. in: query name: maxworkers required: false schema: description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. type: integer - description: Default start timeout in seconds. Only valid for VMs. (default depends on the guest configuration). in: query name: timeout required: false schema: description: Default start timeout in seconds. Only valid for VMs. (default depends on the guest configuration). type: integer - description: Only consider guests from this list of VMIDs. in: query name: vms required: false schema: description: Only consider guests from this list of VMIDs. items: description: The (unique) ID of the VM. format: pve-vmid type: integer type: array requestBody: content: application/json: schema: properties: max-workers: description: Defines the maximum number of tasks running concurrently. type: integer maxworkers: description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. type: integer timeout: description: Default start timeout in seconds. Only valid for VMs. (default depends on the guest configuration). type: integer vms: description: Only consider guests from this list of VMIDs. items: description: The (unique) ID of the VM. format: pve-vmid type: integer type: array type: object responses: "200": content: application/json: schema: description: UPID of the worker type: string description: OK summary: Bulk start or resume all guests on the cluster. /cluster/bulk-action/guest/suspend: post: operationId: post_cluster_bulk_action_guest_suspend parameters: - description: Defines the maximum number of tasks running concurrently. in: query name: max-workers required: false schema: description: Defines the maximum number of tasks running concurrently. type: integer - description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. in: query name: maxworkers required: false schema: description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. type: integer - description: The storage for the VM state. in: query name: statestorage required: false schema: description: The storage for the VM state. format: pve-storage-id type: string - description: If set, suspends the guests to disk. Will be resumed on next start. in: query name: to-disk required: false schema: description: If set, suspends the guests to disk. Will be resumed on next start. type: boolean - description: Only consider guests from this list of VMIDs. in: query name: vms required: false schema: description: Only consider guests from this list of VMIDs. items: description: The (unique) ID of the VM. format: pve-vmid type: integer type: array requestBody: content: application/json: schema: properties: max-workers: description: Defines the maximum number of tasks running concurrently. type: integer maxworkers: description: Defines the maximum number of tasks running concurrently. Deprecated, use 'max-workers' instead. type: integer statestorage: description: The storage for the VM state. format: pve-storage-id type: string to-disk: description: If set, suspends the guests to disk. Will be resumed on next start. type: boolean vms: description: Only consider guests from this list of VMIDs. items: description: The (unique) ID of the VM. format: pve-vmid type: integer type: array type: object responses: "200": content: application/json: schema: description: UPID of the worker type: string description: OK summary: Bulk suspend all guests on the cluster. /cluster/ceph: get: operationId: get_cluster_ceph responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Cluster ceph index. /cluster/ceph/flags: get: operationId: get_cluster_ceph_flags responses: "200": content: application/json: schema: items: properties: description: description: Flag description. type: string name: description: Flag name. enum: - nobackfill - nodeep-scrub - nodown - noin - noout - norebalance - norecover - noscrub - notieragent - noup - pause type: string value: description: Flag value. type: boolean type: object type: array description: OK summary: get the status of all ceph flags put: operationId: put_cluster_ceph_flags parameters: - description: Backfilling of PGs is suspended. in: query name: nobackfill required: false schema: description: Backfilling of PGs is suspended. type: boolean - description: Deep Scrubbing is disabled. in: query name: nodeep-scrub required: false schema: description: Deep Scrubbing is disabled. type: boolean - description: OSD failure reports are being ignored, such that the monitors will not mark OSDs down. in: query name: nodown required: false schema: description: OSD failure reports are being ignored, such that the monitors will not mark OSDs down. type: boolean - description: OSDs that were previously marked out will not be marked back in when they start. in: query name: noin required: false schema: description: OSDs that were previously marked out will not be marked back in when they start. type: boolean - description: OSDs will not automatically be marked out after the configured interval. in: query name: noout required: false schema: description: OSDs will not automatically be marked out after the configured interval. type: boolean - description: Rebalancing of PGs is suspended. in: query name: norebalance required: false schema: description: Rebalancing of PGs is suspended. type: boolean - description: Recovery of PGs is suspended. in: query name: norecover required: false schema: description: Recovery of PGs is suspended. type: boolean - description: Scrubbing is disabled. in: query name: noscrub required: false schema: description: Scrubbing is disabled. type: boolean - description: Cache tiering activity is suspended. in: query name: notieragent required: false schema: description: Cache tiering activity is suspended. type: boolean - description: OSDs are not allowed to start. in: query name: noup required: false schema: description: OSDs are not allowed to start. type: boolean - description: Pauses read and writes. in: query name: pause required: false schema: description: Pauses read and writes. type: boolean requestBody: content: application/json: schema: properties: nobackfill: description: Backfilling of PGs is suspended. type: boolean nodeep-scrub: description: Deep Scrubbing is disabled. type: boolean nodown: description: OSD failure reports are being ignored, such that the monitors will not mark OSDs down. type: boolean noin: description: OSDs that were previously marked out will not be marked back in when they start. type: boolean noout: description: OSDs will not automatically be marked out after the configured interval. type: boolean norebalance: description: Rebalancing of PGs is suspended. type: boolean norecover: description: Recovery of PGs is suspended. type: boolean noscrub: description: Scrubbing is disabled. type: boolean notieragent: description: Cache tiering activity is suspended. type: boolean noup: description: OSDs are not allowed to start. type: boolean pause: description: Pauses read and writes. type: boolean type: object responses: "200": content: application/json: schema: type: string description: OK summary: 'Set/Unset multiple Ceph flags at once. Each flag is a top-level optional boolean: passing true sets the flag, false unsets it, omitting it leaves the current state untouched. Runs as a worker task; returns a UPID to follow.' /cluster/ceph/flags/{flag}: get: operationId: get_cluster_ceph_flags_flag parameters: - description: The name of the flag name to get. in: path name: flag required: true schema: description: The name of the flag name to get. enum: - nobackfill - nodeep-scrub - nodown - noin - noout - norebalance - norecover - noscrub - notieragent - noup - pause type: string responses: "200": content: application/json: schema: type: boolean description: OK summary: Get the status of a specific ceph flag. put: operationId: put_cluster_ceph_flags_flag parameters: - description: The ceph flag to update in: path name: flag required: true schema: description: The ceph flag to update enum: - nobackfill - nodeep-scrub - nodown - noin - noout - norebalance - norecover - noscrub - notieragent - noup - pause type: string - description: The new value of the flag in: query name: value required: false schema: description: The new value of the flag type: boolean requestBody: content: application/json: schema: properties: flag: description: The ceph flag to update enum: - nobackfill - nodeep-scrub - nodown - noin - noout - norebalance - norecover - noscrub - notieragent - noup - pause type: string value: description: The new value of the flag type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set or clear (unset) a specific Ceph flag. Runs synchronously (unlike the bulk PUT /cluster/ceph/flags endpoint, which forks a worker task). /cluster/ceph/metadata: get: operationId: get_cluster_ceph_metadata parameters: - description: 'Which metadata facet to return: ''all'' enriches the per-daemon metadata with the PVE-side service state (presence of unit, data directory), ''versions'' collects only per-node Ceph binary version data.' in: query name: scope required: false schema: description: 'Which metadata facet to return: ''all'' enriches the per-daemon metadata with the PVE-side service state (presence of unit, data directory), ''versions'' collects only per-node Ceph binary version data.' enum: - all - versions type: string responses: "200": content: application/json: schema: description: Items for each type of service containing objects for each instance. properties: mds: description: Metadata servers configured in the cluster and their properties, keyed by '@'. type: object mgr: description: Managers configured in the cluster and their properties, keyed by '@'. type: object mon: description: Monitors configured in the cluster and their properties, keyed by '@'. type: object node: description: Ceph version installed on the nodes, keyed by node name. type: object osd: description: OSDs configured in the cluster and their properties. items: description: Useful properties are listed, but not the full list. properties: back_addr: description: Bind addresses and ports for backend inter OSD traffic. type: string ceph_release: description: Ceph release codename currently used. type: string ceph_version: description: Version info currently used by the service. type: string ceph_version_short: description: Short version (numerical) info currently used by the service. type: string device_ids: description: Comma-joined list of device identifiers (e.g. 'sdb=,sdc='). type: string device_paths: description: Comma-joined list of /dev/disk/by-path entries for the underlying devices. type: string devices: description: Comma-joined list of underlying device names (e.g. 'sdb,sdc'). type: string front_addr: description: Bind addresses and ports for frontend traffic to OSDs. type: string hostname: description: Hostname on which the service is running. type: string id: description: OSD ID. type: integer mem_swap_kb: description: Memory of the service currently in swap. type: integer mem_total_kb: description: Memory consumption of the service. type: integer osd_data: description: Path to the OSD data directory. type: string osd_objectstore: description: OSD objectstore type. type: string type: object type: array type: object description: OK summary: Get ceph metadata. /cluster/ceph/status: get: operationId: get_cluster_ceph_status responses: "200": content: application/json: schema: type: object description: OK summary: Get ceph status. /cluster/config: get: operationId: get_cluster_config responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Directory index. post: operationId: post_cluster_config parameters: - description: The name of the cluster. in: query name: clustername required: false schema: description: The name of the cluster. format: pve-node type: string - description: Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) in: query name: link[n] required: false schema: description: Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) type: string - description: Node id for this node. in: query name: nodeid required: false schema: description: Node id for this node. type: integer - description: Coefficient used to determine Corosync's token timeout. See the corosync.conf(5) manual for more details. in: query name: token-coefficient required: false schema: description: Coefficient used to determine Corosync's token timeout. See the corosync.conf(5) manual for more details. type: integer - description: Number of votes for this node. in: query name: votes required: false schema: description: Number of votes for this node. type: integer requestBody: content: application/json: schema: properties: clustername: description: The name of the cluster. format: pve-node type: string link[n]: description: Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) type: string nodeid: description: Node id for this node. type: integer token-coefficient: description: Coefficient used to determine Corosync's token timeout. See the corosync.conf(5) manual for more details. type: integer votes: description: Number of votes for this node. type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Generate new cluster configuration. If no links given, default to local IP address as link0. /cluster/config/apiversion: get: operationId: get_cluster_config_apiversion responses: "200": content: application/json: schema: description: Cluster Join API version, currently 1 type: integer description: OK summary: Return the version of the cluster join API available on this node. /cluster/config/join: get: operationId: get_cluster_config_join parameters: - description: 'The node for which the joinee gets the nodeinfo. ' in: query name: node required: false schema: description: 'The node for which the joinee gets the nodeinfo. ' format: pve-node type: string responses: "200": content: application/json: schema: properties: config_digest: type: string nodelist: items: properties: name: description: The cluster node name. format: pve-node type: string nodeid: description: Node id for this node. type: integer pve_addr: format: ip type: string pve_fp: description: Certificate SHA 256 fingerprint. type: string quorum_votes: type: integer ring0_addr: description: Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) type: string type: object type: array preferred_node: description: The cluster node name. format: pve-node type: string totem: type: object type: object description: OK summary: Get information needed to join this cluster over the connected node. post: operationId: post_cluster_config_join parameters: - description: Certificate SHA 256 fingerprint. in: query name: fingerprint required: false schema: description: Certificate SHA 256 fingerprint. type: string - description: Do not throw error if node already exists. in: query name: force required: false schema: description: Do not throw error if node already exists. type: boolean - description: Hostname (or IP) of an existing cluster member. in: query name: hostname required: false schema: description: Hostname (or IP) of an existing cluster member. type: string - description: Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) in: query name: link[n] required: false schema: description: Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) type: string - description: Node id for this node. in: query name: nodeid required: false schema: description: Node id for this node. type: integer - description: Superuser (root) password of peer node. in: query name: password required: false schema: description: Superuser (root) password of peer node. type: string - description: Number of votes for this node in: query name: votes required: false schema: description: Number of votes for this node type: integer requestBody: content: application/json: schema: properties: fingerprint: description: Certificate SHA 256 fingerprint. type: string force: description: Do not throw error if node already exists. type: boolean hostname: description: Hostname (or IP) of an existing cluster member. type: string link[n]: description: Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) type: string nodeid: description: Node id for this node. type: integer password: description: Superuser (root) password of peer node. type: string votes: description: Number of votes for this node type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Joins this node into an existing cluster. If no links are given, default to IP resolved by node's hostname on single link (fallback fails for clusters with multiple links). /cluster/config/nodes: get: operationId: get_cluster_config_nodes responses: "200": content: application/json: schema: items: properties: node: type: string type: object type: array description: OK summary: Corosync node list. /cluster/config/nodes/{node}: delete: operationId: delete_cluster_config_nodes_node parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Removes a node from the cluster configuration. post: operationId: post_cluster_config_nodes_node parameters: - description: The JOIN_API_VERSION of the new node. in: query name: apiversion required: false schema: description: The JOIN_API_VERSION of the new node. type: integer - description: Do not throw error if node already exists. in: query name: force required: false schema: description: Do not throw error if node already exists. type: boolean - description: Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) in: query name: link[n] required: false schema: description: Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) type: string - description: IP Address of node to add. Used as fallback if no links are given. in: query name: new_node_ip required: false schema: description: IP Address of node to add. Used as fallback if no links are given. format: ip type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Node id for this node. in: query name: nodeid required: false schema: description: Node id for this node. type: integer - description: Number of votes for this node in: query name: votes required: false schema: description: Number of votes for this node type: integer requestBody: content: application/json: schema: properties: apiversion: description: The JOIN_API_VERSION of the new node. type: integer force: description: Do not throw error if node already exists. type: boolean link[n]: description: Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) type: string new_node_ip: description: IP Address of node to add. Used as fallback if no links are given. format: ip type: string node: description: The cluster node name. format: pve-node type: string nodeid: description: Node id for this node. type: integer votes: description: Number of votes for this node type: integer type: object responses: "200": content: application/json: schema: properties: corosync_authkey: type: string corosync_conf: type: string warnings: items: type: string type: array type: object description: OK summary: Adds a node to the cluster configuration. This call is for internal use. /cluster/config/qdevice: get: operationId: get_cluster_config_qdevice responses: "200": content: application/json: schema: type: object description: OK summary: Get QDevice status /cluster/config/totem: get: operationId: get_cluster_config_totem responses: "200": content: application/json: schema: type: object description: OK summary: Get corosync totem protocol settings. /cluster/firewall: get: operationId: get_cluster_firewall responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Directory index. /cluster/firewall/aliases: get: operationId: get_cluster_firewall_aliases responses: "200": content: application/json: schema: items: properties: cidr: type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: type: string type: object type: array description: OK summary: List aliases post: operationId: post_cluster_firewall_aliases parameters: - description: Network/IP specification in CIDR format. in: query name: cidr required: false schema: description: Network/IP specification in CIDR format. format: IPorCIDR type: string - description: "" in: query name: comment required: false schema: type: string - description: Alias name. in: query name: name required: false schema: description: Alias name. type: string requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDR type: string comment: type: string name: description: Alias name. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create IP or Network Alias. /cluster/firewall/aliases/{name}: delete: operationId: delete_cluster_firewall_aliases_name parameters: - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Alias name. in: path name: name required: true schema: description: Alias name. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove IP or Network alias. get: operationId: get_cluster_firewall_aliases_name parameters: - description: Alias name. in: path name: name required: true schema: description: Alias name. type: string responses: "200": content: application/json: schema: type: object description: OK summary: Read alias. put: operationId: put_cluster_firewall_aliases_name parameters: - description: Network/IP specification in CIDR format. in: query name: cidr required: false schema: description: Network/IP specification in CIDR format. format: IPorCIDR type: string - description: "" in: query name: comment required: false schema: type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Alias name. in: path name: name required: true schema: description: Alias name. type: string - description: Rename an existing alias. in: query name: rename required: false schema: description: Rename an existing alias. type: string requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDR type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: Alias name. type: string rename: description: Rename an existing alias. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update IP or Network alias. /cluster/firewall/groups: get: operationId: get_cluster_firewall_groups responses: "200": content: application/json: schema: items: properties: comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string group: description: Security Group name. type: string type: object type: array description: OK summary: List security groups. post: operationId: post_cluster_firewall_groups parameters: - description: "" in: query name: comment required: false schema: type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Security Group name. in: query name: group required: false schema: description: Security Group name. type: string - description: Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group. in: query name: rename required: false schema: description: Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group. type: string requestBody: content: application/json: schema: properties: comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string group: description: Security Group name. type: string rename: description: Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new security group. /cluster/firewall/groups/{group}: delete: operationId: delete_cluster_firewall_groups_group parameters: - description: Security Group name. in: path name: group required: true schema: description: Security Group name. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete security group. get: operationId: get_cluster_firewall_groups_group parameters: - description: Security Group name. in: path name: group required: true schema: description: Security Group name. type: string responses: "200": content: application/json: schema: items: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object type: array description: OK summary: List rules. post: operationId: post_cluster_firewall_groups_group parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: true schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Security Group name. in: path name: group required: true schema: description: Security Group name. type: string - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: Update rule at position . in: query name: pos required: false schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: true schema: description: Rule type. enum: - in - out - forward - group type: string requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer group: description: Security Group name. type: string icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string required: - action - type type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new rule. /cluster/firewall/groups/{group}/{pos}: delete: operationId: delete_cluster_firewall_groups_group_pos parameters: - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Security Group name. in: path name: group required: true schema: description: Security Group name. type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete rule. get: operationId: get_cluster_firewall_groups_group_pos parameters: - description: Security Group name. in: path name: group required: true schema: description: Security Group name. type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer responses: "200": content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object description: OK summary: Get single rule data. put: operationId: put_cluster_firewall_groups_group_pos parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: false schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Security Group name. in: path name: group required: true schema: description: Security Group name. type: string - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: Move rule to new position . Other arguments are ignored. in: query name: moveto required: false schema: description: Move rule to new position . Other arguments are ignored. type: integer - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: false schema: description: Rule type. enum: - in - out - forward - group type: string requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer group: description: Security Group name. type: string icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string moveto: description: Move rule to new position . Other arguments are ignored. type: integer pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Modify rule data. /cluster/firewall/ipset: get: operationId: get_cluster_firewall_ipset responses: "200": content: application/json: schema: items: properties: comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: IP set name. type: string type: object type: array description: OK summary: List IPSets post: operationId: post_cluster_firewall_ipset parameters: - description: "" in: query name: comment required: false schema: type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: IP set name. in: query name: name required: false schema: description: IP set name. type: string - description: Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. in: query name: rename required: false schema: description: Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. type: string requestBody: content: application/json: schema: properties: comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: IP set name. type: string rename: description: Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new IPSet /cluster/firewall/ipset/{name}: delete: operationId: delete_cluster_firewall_ipset_name parameters: - description: Delete all members of the IPSet, if there are any. in: query name: force required: false schema: description: Delete all members of the IPSet, if there are any. type: boolean - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete IPSet get: operationId: get_cluster_firewall_ipset_name parameters: - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string responses: "200": content: application/json: schema: items: properties: cidr: type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string nomatch: type: boolean type: object type: array description: OK summary: List IPSet content post: operationId: post_cluster_firewall_ipset_name parameters: - description: Network/IP specification in CIDR format. in: query name: cidr required: false schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: "" in: query name: comment required: false schema: type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: "" in: query name: nomatch required: false schema: type: boolean requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string comment: type: string name: description: IP set name. type: string nomatch: type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add IP or Network to IPSet. /cluster/firewall/ipset/{name}/{cidr}: delete: operationId: delete_cluster_firewall_ipset_name_cidr parameters: - description: Network/IP specification in CIDR format. in: path name: cidr required: true schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove IP or Network from IPSet. get: operationId: get_cluster_firewall_ipset_name_cidr parameters: - description: Network/IP specification in CIDR format. in: path name: cidr required: true schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string responses: "200": content: application/json: schema: type: object description: OK summary: Read IP or Network settings from IPSet. put: operationId: put_cluster_firewall_ipset_name_cidr parameters: - description: Network/IP specification in CIDR format. in: path name: cidr required: true schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: "" in: query name: comment required: false schema: type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: "" in: query name: nomatch required: false schema: type: boolean requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: IP set name. type: string nomatch: type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update IP or Network settings /cluster/firewall/macros: get: operationId: get_cluster_firewall_macros responses: "200": content: application/json: schema: items: properties: descr: description: More verbose description (if available). type: string macro: description: Macro name. type: string type: object type: array description: OK summary: List available macros /cluster/firewall/options: get: operationId: get_cluster_firewall_options responses: "200": content: application/json: schema: properties: ebtables: description: Enable ebtables rules cluster wide. type: boolean enable: description: Enable or disable the firewall cluster wide. type: integer log_ratelimit: description: Log ratelimiting settings type: string policy_forward: description: Forward policy. enum: - ACCEPT - DROP type: string policy_in: description: Input policy. enum: - ACCEPT - REJECT - DROP type: string policy_out: description: Output policy. enum: - ACCEPT - REJECT - DROP type: string type: object description: OK summary: Get Firewall options. put: operationId: put_cluster_firewall_options parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Enable ebtables rules cluster wide. in: query name: ebtables required: false schema: description: Enable ebtables rules cluster wide. type: boolean - description: Enable or disable the firewall cluster wide. in: query name: enable required: false schema: description: Enable or disable the firewall cluster wide. type: integer - description: Log ratelimiting settings in: query name: log_ratelimit required: false schema: description: Log ratelimiting settings type: string - description: Forward policy. in: query name: policy_forward required: false schema: description: Forward policy. enum: - ACCEPT - DROP type: string - description: Input policy. in: query name: policy_in required: false schema: description: Input policy. enum: - ACCEPT - REJECT - DROP type: string - description: Output policy. in: query name: policy_out required: false schema: description: Output policy. enum: - ACCEPT - REJECT - DROP type: string requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string ebtables: description: Enable ebtables rules cluster wide. type: boolean enable: description: Enable or disable the firewall cluster wide. type: integer log_ratelimit: description: Log ratelimiting settings type: string policy_forward: description: Forward policy. enum: - ACCEPT - DROP type: string policy_in: description: Input policy. enum: - ACCEPT - REJECT - DROP type: string policy_out: description: Output policy. enum: - ACCEPT - REJECT - DROP type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set Firewall options. /cluster/firewall/refs: get: operationId: get_cluster_firewall_refs parameters: - description: Only list references of specified type. in: query name: type required: false schema: description: Only list references of specified type. enum: - alias - ipset type: string responses: "200": content: application/json: schema: items: properties: comment: type: string name: type: string ref: type: string scope: type: string type: enum: - alias - ipset type: string type: object type: array description: OK summary: Lists possible IPSet/Alias reference which are allowed in source/dest properties. /cluster/firewall/rules: get: operationId: get_cluster_firewall_rules responses: "200": content: application/json: schema: items: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object type: array description: OK summary: List rules. post: operationId: post_cluster_firewall_rules parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: true schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: Update rule at position . in: query name: pos required: false schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: true schema: description: Rule type. enum: - in - out - forward - group type: string requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string required: - type - action type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new rule. /cluster/firewall/rules/{pos}: delete: operationId: delete_cluster_firewall_rules_pos parameters: - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete rule. get: operationId: get_cluster_firewall_rules_pos parameters: - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer responses: "200": content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object description: OK summary: Get single rule data. put: operationId: put_cluster_firewall_rules_pos parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: false schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: Move rule to new position . Other arguments are ignored. in: query name: moveto required: false schema: description: Move rule to new position . Other arguments are ignored. type: integer - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: false schema: description: Rule type. enum: - in - out - forward - group type: string requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string moveto: description: Move rule to new position . Other arguments are ignored. type: integer pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Modify rule data. /cluster/ha: get: operationId: get_cluster_ha responses: "200": content: application/json: schema: items: properties: id: type: string type: object type: array description: OK summary: Directory index. /cluster/ha/groups: get: operationId: get_cluster_ha_groups responses: "200": content: application/json: schema: items: properties: group: type: string type: object type: array description: OK summary: Get HA groups. (deprecated in favor of HA rules) post: operationId: post_cluster_ha_groups parameters: - description: Description. in: query name: comment required: false schema: description: Description. type: string - description: The HA group identifier. in: query name: group required: false schema: description: The HA group identifier. format: pve-configid type: string - description: List of cluster node names with optional priority. in: query name: nodes required: true schema: description: List of cluster node names with optional priority. format: pve-ha-node-list type: string - description: The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior. in: query name: nofailback required: false schema: description: The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior. type: boolean - description: Resources bound to restricted groups may only run on nodes defined by the group. in: query name: restricted required: false schema: description: Resources bound to restricted groups may only run on nodes defined by the group. type: boolean - description: Group type. in: query name: type required: false schema: description: Group type. enum: - group type: string requestBody: content: application/json: schema: properties: comment: description: Description. type: string group: description: The HA group identifier. format: pve-configid type: string nodes: description: List of cluster node names with optional priority. format: pve-ha-node-list type: string nofailback: description: The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior. type: boolean restricted: description: Resources bound to restricted groups may only run on nodes defined by the group. type: boolean type: description: Group type. enum: - group type: string required: - nodes type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new HA group. (deprecated in favor of HA rules) /cluster/ha/groups/{group}: delete: operationId: delete_cluster_ha_groups_group parameters: - description: The HA group identifier. in: path name: group required: true schema: description: The HA group identifier. format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete ha group configuration. (deprecated in favor of HA rules) get: operationId: get_cluster_ha_groups_group parameters: - description: The HA group identifier. in: path name: group required: true schema: description: The HA group identifier. format: pve-configid type: string responses: "200": content: application/json: schema: type: object description: OK summary: Read ha group configuration. (deprecated in favor of HA rules) put: operationId: put_cluster_ha_groups_group parameters: - description: Description. in: query name: comment required: false schema: description: Description. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The HA group identifier. in: path name: group required: true schema: description: The HA group identifier. format: pve-configid type: string - description: List of cluster node names with optional priority. in: query name: nodes required: false schema: description: List of cluster node names with optional priority. format: pve-ha-node-list type: string - description: The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior. in: query name: nofailback required: false schema: description: The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior. type: boolean - description: Resources bound to restricted groups may only run on nodes defined by the group. in: query name: restricted required: false schema: description: Resources bound to restricted groups may only run on nodes defined by the group. type: boolean requestBody: content: application/json: schema: properties: comment: description: Description. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string group: description: The HA group identifier. format: pve-configid type: string nodes: description: List of cluster node names with optional priority. format: pve-ha-node-list type: string nofailback: description: The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior. type: boolean restricted: description: Resources bound to restricted groups may only run on nodes defined by the group. type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update ha group configuration. (deprecated in favor of HA rules) /cluster/ha/resources: get: operationId: get_cluster_ha_resources parameters: - description: Only list resources of specific type in: query name: type required: false schema: description: Only list resources of specific type enum: - ct - vm type: string responses: "200": content: application/json: schema: items: properties: sid: type: string type: object type: array description: OK summary: List HA resources. post: operationId: post_cluster_ha_resources parameters: - description: HA resource may be migrated during automatic rebalancing in: query name: auto-rebalance required: false schema: description: HA resource may be migrated during automatic rebalancing type: boolean - description: Description. in: query name: comment required: false schema: description: Description. type: string - description: Automatically migrate HA resource to the node with the highest priority according to their node affinity rules, if a node with a higher priority than the current node comes online. in: query name: failback required: false schema: description: Automatically migrate HA resource to the node with the highest priority according to their node affinity rules, if a node with a higher priority than the current node comes online. type: boolean - description: The HA group identifier. in: query name: group required: false schema: description: The HA group identifier. format: pve-configid type: string - description: Maximal number of resource relocate tries when a resource fails to start. in: query name: max_relocate required: false schema: description: Maximal number of resource relocate tries when a resource fails to start. type: integer - description: Maximal number of tries to restart the resource on a node after its start failed. When reached, the HA manager will try to relocate the resource to an eligible node. in: query name: max_restart required: false schema: description: Maximal number of tries to restart the resource on a node after its start failed. When reached, the HA manager will try to relocate the resource to an eligible node. type: integer - description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' in: query name: sid required: false schema: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string - description: Requested resource state. in: query name: state required: false schema: description: Requested resource state. enum: - started - stopped - enabled - disabled - ignored type: string - description: Resource type. in: query name: type required: false schema: description: Resource type. enum: - ct - vm type: string requestBody: content: application/json: schema: properties: auto-rebalance: description: HA resource may be migrated during automatic rebalancing type: boolean comment: description: Description. type: string failback: description: Automatically migrate HA resource to the node with the highest priority according to their node affinity rules, if a node with a higher priority than the current node comes online. type: boolean group: description: The HA group identifier. format: pve-configid type: string max_relocate: description: Maximal number of resource relocate tries when a resource fails to start. type: integer max_restart: description: Maximal number of tries to restart the resource on a node after its start failed. When reached, the HA manager will try to relocate the resource to an eligible node. type: integer sid: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string state: description: Requested resource state. enum: - started - stopped - enabled - disabled - ignored type: string type: description: Resource type. enum: - ct - vm type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new HA resource. /cluster/ha/resources/{sid}: delete: operationId: delete_cluster_ha_resources_sid parameters: - description: Remove this resource from rules that reference it, deleting the rule if this resource is the only resource in the rule in: query name: purge required: false schema: description: Remove this resource from rules that reference it, deleting the rule if this resource is the only resource in the rule type: boolean - description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' in: path name: sid required: true schema: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete resource configuration. get: operationId: get_cluster_ha_resources_sid parameters: - description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' in: path name: sid required: true schema: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string responses: "200": content: application/json: schema: properties: auto-rebalance: description: HA resource may be migrated during automatic rebalancing. type: boolean comment: description: Description. type: string digest: description: Can be used to prevent concurrent modifications. type: string failback: description: The HA resource is automatically migrated to the node with the highest priority according to their node affinity rule, if a node with a higher priority than the current node comes online. type: boolean group: description: The HA group identifier. format: pve-configid type: string max_relocate: description: Maximal number of service relocate tries when a service fails to start. type: integer max_restart: description: Maximal number of tries to restart the service on a node after its start failed. type: integer sid: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string state: description: Requested resource state. enum: - started - stopped - enabled - disabled - ignored type: string type: description: The type of the resources. type: string type: object description: OK summary: Read resource configuration. put: operationId: put_cluster_ha_resources_sid parameters: - description: HA resource may be migrated during automatic rebalancing in: query name: auto-rebalance required: false schema: description: HA resource may be migrated during automatic rebalancing type: boolean - description: Description. in: query name: comment required: false schema: description: Description. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Automatically migrate HA resource to the node with the highest priority according to their node affinity rules, if a node with a higher priority than the current node comes online. in: query name: failback required: false schema: description: Automatically migrate HA resource to the node with the highest priority according to their node affinity rules, if a node with a higher priority than the current node comes online. type: boolean - description: The HA group identifier. in: query name: group required: false schema: description: The HA group identifier. format: pve-configid type: string - description: Maximal number of resource relocate tries when a resource fails to start. in: query name: max_relocate required: false schema: description: Maximal number of resource relocate tries when a resource fails to start. type: integer - description: Maximal number of tries to restart the resource on a node after its start failed. When reached, the HA manager will try to relocate the resource to an eligible node. in: query name: max_restart required: false schema: description: Maximal number of tries to restart the resource on a node after its start failed. When reached, the HA manager will try to relocate the resource to an eligible node. type: integer - description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' in: path name: sid required: true schema: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string - description: Requested resource state. in: query name: state required: false schema: description: Requested resource state. enum: - started - stopped - enabled - disabled - ignored type: string requestBody: content: application/json: schema: properties: auto-rebalance: description: HA resource may be migrated during automatic rebalancing type: boolean comment: description: Description. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string failback: description: Automatically migrate HA resource to the node with the highest priority according to their node affinity rules, if a node with a higher priority than the current node comes online. type: boolean group: description: The HA group identifier. format: pve-configid type: string max_relocate: description: Maximal number of resource relocate tries when a resource fails to start. type: integer max_restart: description: Maximal number of tries to restart the resource on a node after its start failed. When reached, the HA manager will try to relocate the resource to an eligible node. type: integer sid: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string state: description: Requested resource state. enum: - started - stopped - enabled - disabled - ignored type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update resource configuration. /cluster/ha/resources/{sid}/migrate: post: operationId: post_cluster_ha_resources_sid_migrate parameters: - description: Target node. in: query name: node required: false schema: description: Target node. format: pve-node type: string - description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' in: path name: sid required: true schema: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string requestBody: content: application/json: schema: properties: node: description: Target node. format: pve-node type: string sid: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string type: object responses: "200": content: application/json: schema: properties: blocking-resources: description: HA resources, which are blocking the given HA resource from being migrated to the requested target node. items: description: A blocking HA resource properties: cause: description: The reason why the HA resource is blocking the migration. enum: - node-affinity - resource-affinity type: string sid: description: The blocking HA resource id type: string type: object type: array comigrated-resources: description: HA resources, which are migrated to the same requested target node as the given HA resource, because these are in positive affinity with the HA resource. type: array requested-node: description: Node, which was requested to be migrated to. type: string sid: description: HA resource, which is requested to be migrated. type: string type: object description: OK summary: Request resource migration (online) to another node. /cluster/ha/resources/{sid}/relocate: post: operationId: post_cluster_ha_resources_sid_relocate parameters: - description: Target node. in: query name: node required: false schema: description: Target node. format: pve-node type: string - description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' in: path name: sid required: true schema: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string requestBody: content: application/json: schema: properties: node: description: Target node. format: pve-node type: string sid: description: 'HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).' format: pve-ha-resource-or-vm-id type: string type: object responses: "200": content: application/json: schema: properties: blocking-resources: description: HA resources, which are blocking the given HA resource from being relocated to the requested target node. items: description: A blocking HA resource properties: cause: description: The reason why the HA resource is blocking the relocation. enum: - node-affinity - resource-affinity type: string sid: description: The blocking HA resource id type: string type: object type: array comigrated-resources: description: HA resources, which are relocated to the same requested target node as the given HA resource, because these are in positive affinity with the HA resource. items: description: A comigrated HA resource type: string type: array requested-node: description: Node, which was requested to be relocated to. type: string sid: description: HA resource, which is requested to be relocated. type: string type: object description: OK summary: Request resource relocation to another node. This stops the service on the old node, and restarts it on the target node. /cluster/ha/rules: get: operationId: get_cluster_ha_rules parameters: - description: Limit the returned list to rules affecting the specified resource. in: query name: resource required: false schema: description: Limit the returned list to rules affecting the specified resource. type: string - description: Limit the returned list to the specified rule type. in: query name: type required: false schema: description: Limit the returned list to the specified rule type. enum: - node-affinity - resource-affinity type: string responses: "200": content: application/json: schema: items: properties: rule: type: string type: object type: array description: OK summary: Get HA rules. post: operationId: post_cluster_ha_rules parameters: - description: Describes whether the HA resources are supposed to be kept on the same node ('positive'), or are supposed to be kept on separate nodes ('negative'). in: query name: affinity required: false schema: description: Describes whether the HA resources are supposed to be kept on the same node ('positive'), or are supposed to be kept on separate nodes ('negative'). enum: - positive - negative type: string - description: HA rule description. in: query name: comment required: false schema: description: HA rule description. type: string - description: Whether the HA rule is disabled. in: query name: disable required: false schema: description: Whether the HA rule is disabled. type: boolean - description: List of cluster node names with optional priority. in: query name: nodes required: false schema: description: List of cluster node names with optional priority. format: pve-ha-node-list type: string - description: 'List of HA resource IDs. This consists of a list of resource types followed by a resource specific name separated with a colon (example: vm:100,ct:101).' in: query name: resources required: true schema: description: 'List of HA resource IDs. This consists of a list of resource types followed by a resource specific name separated with a colon (example: vm:100,ct:101).' format: pve-ha-resource-id-list type: string - description: HA rule identifier. in: query name: rule required: true schema: description: HA rule identifier. format: pve-configid type: string - description: Describes whether the node affinity rule is strict or non-strict. in: query name: strict required: false schema: description: Describes whether the node affinity rule is strict or non-strict. type: boolean - description: HA rule type. in: query name: type required: false schema: description: HA rule type. enum: - node-affinity - resource-affinity type: string requestBody: content: application/json: schema: properties: affinity: description: Describes whether the HA resources are supposed to be kept on the same node ('positive'), or are supposed to be kept on separate nodes ('negative'). enum: - positive - negative type: string comment: description: HA rule description. type: string disable: description: Whether the HA rule is disabled. type: boolean nodes: description: List of cluster node names with optional priority. format: pve-ha-node-list type: string resources: description: 'List of HA resource IDs. This consists of a list of resource types followed by a resource specific name separated with a colon (example: vm:100,ct:101).' format: pve-ha-resource-id-list type: string rule: description: HA rule identifier. format: pve-configid type: string strict: description: Describes whether the node affinity rule is strict or non-strict. type: boolean type: description: HA rule type. enum: - node-affinity - resource-affinity type: string required: - rule - resources type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create HA rule. /cluster/ha/rules/{rule}: delete: operationId: delete_cluster_ha_rules_rule parameters: - description: HA rule identifier. in: path name: rule required: true schema: description: HA rule identifier. format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete HA rule. get: operationId: get_cluster_ha_rules_rule parameters: - description: HA rule identifier. in: path name: rule required: true schema: description: HA rule identifier. format: pve-configid type: string responses: "200": content: application/json: schema: properties: rule: description: HA rule identifier. format: pve-configid type: string type: description: HA rule type. enum: - node-affinity - resource-affinity type: string type: object description: OK summary: Read HA rule. put: operationId: put_cluster_ha_rules_rule parameters: - description: Describes whether the HA resources are supposed to be kept on the same node ('positive'), or are supposed to be kept on separate nodes ('negative'). in: query name: affinity required: false schema: description: Describes whether the HA resources are supposed to be kept on the same node ('positive'), or are supposed to be kept on separate nodes ('negative'). enum: - positive - negative type: string - description: HA rule description. in: query name: comment required: false schema: description: HA rule description. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Whether the HA rule is disabled. in: query name: disable required: false schema: description: Whether the HA rule is disabled. type: boolean - description: List of cluster node names with optional priority. in: query name: nodes required: false schema: description: List of cluster node names with optional priority. format: pve-ha-node-list type: string - description: 'List of HA resource IDs. This consists of a list of resource types followed by a resource specific name separated with a colon (example: vm:100,ct:101).' in: query name: resources required: false schema: description: 'List of HA resource IDs. This consists of a list of resource types followed by a resource specific name separated with a colon (example: vm:100,ct:101).' format: pve-ha-resource-id-list type: string - description: HA rule identifier. in: path name: rule required: true schema: description: HA rule identifier. format: pve-configid type: string - description: Describes whether the node affinity rule is strict or non-strict. in: query name: strict required: false schema: description: Describes whether the node affinity rule is strict or non-strict. type: boolean - description: HA rule type. in: query name: type required: false schema: description: HA rule type. enum: - node-affinity - resource-affinity type: string requestBody: content: application/json: schema: properties: affinity: description: Describes whether the HA resources are supposed to be kept on the same node ('positive'), or are supposed to be kept on separate nodes ('negative'). enum: - positive - negative type: string comment: description: HA rule description. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Whether the HA rule is disabled. type: boolean nodes: description: List of cluster node names with optional priority. format: pve-ha-node-list type: string resources: description: 'List of HA resource IDs. This consists of a list of resource types followed by a resource specific name separated with a colon (example: vm:100,ct:101).' format: pve-ha-resource-id-list type: string rule: description: HA rule identifier. format: pve-configid type: string strict: description: Describes whether the node affinity rule is strict or non-strict. type: boolean type: description: HA rule type. enum: - node-affinity - resource-affinity type: string required: - rule type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update HA rule. /cluster/ha/status: get: operationId: get_cluster_ha_status responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Directory index. /cluster/ha/status/arm-ha: post: operationId: post_cluster_ha_status_arm_ha responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Request re-arming the HA stack after it was disarmed. /cluster/ha/status/current: get: operationId: get_cluster_ha_status_current responses: "200": content: application/json: schema: items: properties: armed-state: description: For type 'fencing'. Whether HA is armed, on standby, disarming or disarmed. enum: - armed - standby - disarming - disarmed type: string auto-rebalance: description: HA resource may be migrated during automatic rebalancing. type: boolean crm_state: description: For type 'service'. Service state as seen by the CRM. type: string failback: description: The HA resource is automatically migrated to the node with the highest priority according to their node affinity rule, if a node with a higher priority than the current node comes online. type: boolean id: description: Status entry ID (quorum, master, lrm:, service:). type: string max_relocate: description: For type 'service'. type: integer max_restart: description: For type 'service'. type: integer node: description: Node associated to status entry. type: string quorate: description: For type 'quorum'. Whether the cluster is quorate or not. type: boolean request_state: description: For type 'service'. Requested service state. type: string resource_mode: description: For type 'fencing'. How resources are handled while disarmed. enum: - freeze - ignore type: string sid: description: For type 'service'. Service ID. type: string state: description: For type 'service'. Verbose service state. type: string status: description: Status of the entry (value depends on type). type: string timestamp: description: For type 'lrm','master'. Timestamp of the status information. type: integer type: description: Type of status entry. enum: - quorum - master - lrm - service - fencing type: object type: array description: OK summary: Get HA manager status. /cluster/ha/status/disarm-ha: post: operationId: post_cluster_ha_status_disarm_ha parameters: - description: 'Controls how HA managed resources are handled while disarmed. The current state of resources is not affected. ''freeze'': new commands and state changes are not applied. ''ignore'': resources are removed from HA tracking and can be managed as if they were not HA managed.' in: query name: resource-mode required: false schema: description: 'Controls how HA managed resources are handled while disarmed. The current state of resources is not affected. ''freeze'': new commands and state changes are not applied. ''ignore'': resources are removed from HA tracking and can be managed as if they were not HA managed.' enum: - freeze - ignore type: string requestBody: content: application/json: schema: properties: resource-mode: description: 'Controls how HA managed resources are handled while disarmed. The current state of resources is not affected. ''freeze'': new commands and state changes are not applied. ''ignore'': resources are removed from HA tracking and can be managed as if they were not HA managed.' enum: - freeze - ignore type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Request disarming the HA stack, releasing all watchdogs cluster-wide. /cluster/ha/status/manager_status: get: operationId: get_cluster_ha_status_manager_status responses: "200": content: application/json: schema: type: object description: OK summary: Get full HA manager status, including LRM status. /cluster/jobs: get: operationId: get_cluster_jobs responses: "200": content: application/json: schema: description: Directory index. items: properties: subdir: description: API sub-directory endpoint type: string type: object type: array description: OK summary: Index for jobs related endpoints. /cluster/jobs/realm-sync: get: operationId: get_cluster_jobs_realm_sync responses: "200": content: application/json: schema: items: properties: comment: description: A comment for the job. type: string enabled: description: If the job is enabled or not. type: boolean id: description: The ID of the entry. type: string last-run: description: Last execution time of the job in seconds since the beginning of the UNIX epoch type: integer next-run: description: Next planned execution time of the job in seconds since the beginning of the UNIX epoch. type: integer realm: description: Authentication domain ID format: pve-realm type: string remove-vanished: description: 'A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ''entry'' removes the user/group when not returned from the sync. ''properties'' removes the set properties on existing user/group that do not appear in the source (even custom ones). ''acl'' removes acls when the user/group is not returned from the sync. Instead of a list it also can be ''none'' (the default).' type: string schedule: description: The configured sync schedule. type: string scope: description: Select what to sync. enum: - users - groups - both type: string type: object type: array description: OK summary: List configured realm-sync-jobs. /cluster/jobs/realm-sync/{id}: delete: operationId: delete_cluster_jobs_realm_sync_id parameters: - description: "" in: path name: id required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete realm-sync job definition. get: operationId: get_cluster_jobs_realm_sync_id parameters: - description: "" in: path name: id required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: type: object description: OK summary: Read realm-sync job definition. post: operationId: post_cluster_jobs_realm_sync_id parameters: - description: Description for the Job. in: query name: comment required: false schema: description: Description for the Job. type: string - description: Enable newly synced users immediately. in: query name: enable-new required: false schema: description: Enable newly synced users immediately. type: boolean - description: Determines if the job is enabled. in: query name: enabled required: false schema: description: Determines if the job is enabled. type: boolean - description: The ID of the job. in: path name: id required: true schema: description: The ID of the job. format: pve-configid type: string - description: Authentication domain ID in: query name: realm required: false schema: description: Authentication domain ID format: pve-realm type: string - description: 'A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ''entry'' removes the user/group when not returned from the sync. ''properties'' removes the set properties on existing user/group that do not appear in the source (even custom ones). ''acl'' removes acls when the user/group is not returned from the sync. Instead of a list it also can be ''none'' (the default).' in: query name: remove-vanished required: false schema: description: 'A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ''entry'' removes the user/group when not returned from the sync. ''properties'' removes the set properties on existing user/group that do not appear in the source (even custom ones). ''acl'' removes acls when the user/group is not returned from the sync. Instead of a list it also can be ''none'' (the default).' type: string - description: Backup schedule. The format is a subset of `systemd` calendar events. in: query name: schedule required: false schema: description: Backup schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string - description: Select what to sync. in: query name: scope required: false schema: description: Select what to sync. enum: - users - groups - both type: string requestBody: content: application/json: schema: properties: comment: description: Description for the Job. type: string enable-new: description: Enable newly synced users immediately. type: boolean enabled: description: Determines if the job is enabled. type: boolean id: description: The ID of the job. format: pve-configid type: string realm: description: Authentication domain ID format: pve-realm type: string remove-vanished: description: 'A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ''entry'' removes the user/group when not returned from the sync. ''properties'' removes the set properties on existing user/group that do not appear in the source (even custom ones). ''acl'' removes acls when the user/group is not returned from the sync. Instead of a list it also can be ''none'' (the default).' type: string schedule: description: Backup schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string scope: description: Select what to sync. enum: - users - groups - both type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new realm-sync job. put: operationId: put_cluster_jobs_realm_sync_id parameters: - description: Description for the Job. in: query name: comment required: false schema: description: Description for the Job. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Enable newly synced users immediately. in: query name: enable-new required: false schema: description: Enable newly synced users immediately. type: boolean - description: Determines if the job is enabled. in: query name: enabled required: false schema: description: Determines if the job is enabled. type: boolean - description: The ID of the job. in: path name: id required: true schema: description: The ID of the job. format: pve-configid type: string - description: 'A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ''entry'' removes the user/group when not returned from the sync. ''properties'' removes the set properties on existing user/group that do not appear in the source (even custom ones). ''acl'' removes acls when the user/group is not returned from the sync. Instead of a list it also can be ''none'' (the default).' in: query name: remove-vanished required: false schema: description: 'A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ''entry'' removes the user/group when not returned from the sync. ''properties'' removes the set properties on existing user/group that do not appear in the source (even custom ones). ''acl'' removes acls when the user/group is not returned from the sync. Instead of a list it also can be ''none'' (the default).' type: string - description: Backup schedule. The format is a subset of `systemd` calendar events. in: query name: schedule required: false schema: description: Backup schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string - description: Select what to sync. in: query name: scope required: false schema: description: Select what to sync. enum: - users - groups - both type: string requestBody: content: application/json: schema: properties: comment: description: Description for the Job. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string enable-new: description: Enable newly synced users immediately. type: boolean enabled: description: Determines if the job is enabled. type: boolean id: description: The ID of the job. format: pve-configid type: string remove-vanished: description: 'A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: ''entry'' removes the user/group when not returned from the sync. ''properties'' removes the set properties on existing user/group that do not appear in the source (even custom ones). ''acl'' removes acls when the user/group is not returned from the sync. Instead of a list it also can be ''none'' (the default).' type: string schedule: description: Backup schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string scope: description: Select what to sync. enum: - users - groups - both type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update realm-sync job definition. /cluster/jobs/schedule-analyze: get: operationId: get_cluster_jobs_schedule_analyze parameters: - description: Number of event-iteration to simulate and return. in: query name: iterations required: false schema: description: Number of event-iteration to simulate and return. type: integer - description: Job schedule. The format is a subset of `systemd` calendar events. in: query name: schedule required: false schema: description: Job schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string - description: UNIX timestamp to start the calculation from. Defaults to the current time. in: query name: starttime required: false schema: description: UNIX timestamp to start the calculation from. Defaults to the current time. type: integer responses: "200": content: application/json: schema: description: An array of the next events since . items: properties: timestamp: description: UNIX timestamp for the run. type: integer utc: description: UTC timestamp for the run. type: string type: object type: array description: OK summary: Returns a list of future schedule runtimes. /cluster/log: get: operationId: get_cluster_log parameters: - description: Maximum number of entries. in: query name: max required: false schema: description: Maximum number of entries. type: integer responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Read cluster log /cluster/mapping: get: operationId: get_cluster_mapping responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: List resource types. /cluster/mapping/dir: get: operationId: get_cluster_mapping_dir parameters: - description: If given, checks the configurations on the given node for correctness, and adds relevant diagnostics for the directory to the response. in: query name: check-node required: false schema: description: If given, checks the configurations on the given node for correctness, and adds relevant diagnostics for the directory to the response. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: checks: description: A list of checks, only present if 'check-node' is set. items: properties: message: description: The message of the error type: string severity: description: The severity of the error enum: - warning - error type: string type: object type: array description: description: A description of the logical mapping. type: string id: description: The logical ID of the mapping. type: string map: description: The entries of the mapping. items: description: A mapping for a node. type: string type: array type: object type: array description: OK summary: List directory mapping post: operationId: post_cluster_mapping_dir parameters: - description: Description of the directory mapping in: query name: description required: false schema: description: Description of the directory mapping type: string - description: The ID of the directory mapping in: query name: id required: false schema: description: The ID of the directory mapping format: pve-configid type: string - description: A list of maps for the cluster nodes. in: query name: map required: true schema: description: A list of maps for the cluster nodes. items: type: string type: array requestBody: content: application/json: schema: properties: description: description: Description of the directory mapping type: string id: description: The ID of the directory mapping format: pve-configid type: string map: description: A list of maps for the cluster nodes. items: type: string type: array required: - map type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new directory mapping. /cluster/mapping/dir/{id}: delete: operationId: delete_cluster_mapping_dir_id parameters: - description: "" in: path name: id required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove directory mapping. get: operationId: get_cluster_mapping_dir_id parameters: - description: "" in: path name: id required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: type: object description: OK summary: Get directory mapping. put: operationId: put_cluster_mapping_dir_id parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Description of the directory mapping in: query name: description required: false schema: description: Description of the directory mapping type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The ID of the directory mapping in: path name: id required: true schema: description: The ID of the directory mapping format: pve-configid type: string - description: A list of maps for the cluster nodes. in: query name: map required: false schema: description: A list of maps for the cluster nodes. items: type: string type: array requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string description: description: Description of the directory mapping type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string id: description: The ID of the directory mapping format: pve-configid type: string map: description: A list of maps for the cluster nodes. items: type: string type: array type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update a directory mapping. /cluster/mapping/pci: get: operationId: get_cluster_mapping_pci parameters: - description: If given, checks the configurations on the given node for correctness, and adds relevant diagnostics for the devices to the response. in: query name: check-node required: false schema: description: If given, checks the configurations on the given node for correctness, and adds relevant diagnostics for the devices to the response. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: checks: description: A list of checks, only present if 'check_node' is set. items: properties: message: description: The message of the error type: string severity: description: The severity of the error enum: - warning - error type: string type: object type: array description: description: A description of the logical mapping. type: string id: description: The logical ID of the mapping. type: string map: description: The entries of the mapping. items: description: A mapping for a node. type: string type: array type: object type: array description: OK summary: List PCI Hardware Mapping post: operationId: post_cluster_mapping_pci parameters: - description: Description of the logical PCI device. in: query name: description required: false schema: description: Description of the logical PCI device. type: string - description: The ID of the logical PCI mapping. in: query name: id required: false schema: description: The ID of the logical PCI mapping. format: pve-configid type: string - description: Marks the device(s) as being able to be live-migrated (Experimental). This needs hardware and driver support to work. in: query name: live-migration-capable required: false schema: description: Marks the device(s) as being able to be live-migrated (Experimental). This needs hardware and driver support to work. type: boolean - description: A list of maps for the cluster nodes. in: query name: map required: true schema: description: A list of maps for the cluster nodes. items: type: string type: array - description: Marks the device(s) as being capable of providing mediated devices. in: query name: mdev required: false schema: description: Marks the device(s) as being capable of providing mediated devices. type: boolean requestBody: content: application/json: schema: properties: description: description: Description of the logical PCI device. type: string id: description: The ID of the logical PCI mapping. format: pve-configid type: string live-migration-capable: description: Marks the device(s) as being able to be live-migrated (Experimental). This needs hardware and driver support to work. type: boolean map: description: A list of maps for the cluster nodes. items: type: string type: array mdev: description: Marks the device(s) as being capable of providing mediated devices. type: boolean required: - map type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new hardware mapping. /cluster/mapping/pci/{id}: delete: operationId: delete_cluster_mapping_pci_id parameters: - description: "" in: path name: id required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove Hardware Mapping. get: operationId: get_cluster_mapping_pci_id parameters: - description: "" in: path name: id required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: type: object description: OK summary: Get PCI Mapping. put: operationId: put_cluster_mapping_pci_id parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Description of the logical PCI device. in: query name: description required: false schema: description: Description of the logical PCI device. type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The ID of the logical PCI mapping. in: path name: id required: true schema: description: The ID of the logical PCI mapping. format: pve-configid type: string - description: Marks the device(s) as being able to be live-migrated (Experimental). This needs hardware and driver support to work. in: query name: live-migration-capable required: false schema: description: Marks the device(s) as being able to be live-migrated (Experimental). This needs hardware and driver support to work. type: boolean - description: A list of maps for the cluster nodes. in: query name: map required: false schema: description: A list of maps for the cluster nodes. items: type: string type: array - description: Marks the device(s) as being capable of providing mediated devices. in: query name: mdev required: false schema: description: Marks the device(s) as being capable of providing mediated devices. type: boolean requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string description: description: Description of the logical PCI device. type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string id: description: The ID of the logical PCI mapping. format: pve-configid type: string live-migration-capable: description: Marks the device(s) as being able to be live-migrated (Experimental). This needs hardware and driver support to work. type: boolean map: description: A list of maps for the cluster nodes. items: type: string type: array mdev: description: Marks the device(s) as being capable of providing mediated devices. type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update a hardware mapping. /cluster/mapping/usb: get: operationId: get_cluster_mapping_usb parameters: - description: If given, checks the configurations on the given node for correctness, and adds relevant errors to the devices. in: query name: check-node required: false schema: description: If given, checks the configurations on the given node for correctness, and adds relevant errors to the devices. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: description: description: A description of the logical mapping. type: string error: description: A list of errors when 'check_node' is given. items: properties: message: description: The message of the error type: string severity: description: The severity of the error type: string type: object id: description: The logical ID of the mapping. type: string map: description: The entries of the mapping. items: description: A mapping for a node. type: string type: array type: object type: array description: OK summary: List USB Hardware Mappings post: operationId: post_cluster_mapping_usb parameters: - description: Description of the logical USB device. in: query name: description required: false schema: description: Description of the logical USB device. type: string - description: The ID of the logical USB mapping. in: query name: id required: false schema: description: The ID of the logical USB mapping. format: pve-configid type: string - description: A list of maps for the cluster nodes. in: query name: map required: false schema: description: A list of maps for the cluster nodes. items: type: string type: array requestBody: content: application/json: schema: properties: description: description: Description of the logical USB device. type: string id: description: The ID of the logical USB mapping. format: pve-configid type: string map: description: A list of maps for the cluster nodes. items: type: string type: array type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new hardware mapping. /cluster/mapping/usb/{id}: delete: operationId: delete_cluster_mapping_usb_id parameters: - description: "" in: path name: id required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove Hardware Mapping. get: operationId: get_cluster_mapping_usb_id parameters: - description: "" in: path name: id required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: type: object description: OK summary: Get USB Mapping. put: operationId: put_cluster_mapping_usb_id parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Description of the logical USB device. in: query name: description required: false schema: description: Description of the logical USB device. type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The ID of the logical USB mapping. in: path name: id required: true schema: description: The ID of the logical USB mapping. format: pve-configid type: string - description: A list of maps for the cluster nodes. in: query name: map required: false schema: description: A list of maps for the cluster nodes. items: type: string type: array requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string description: description: Description of the logical USB device. type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string id: description: The ID of the logical USB mapping. format: pve-configid type: string map: description: A list of maps for the cluster nodes. items: type: string type: array type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update a hardware mapping. /cluster/metrics: get: operationId: get_cluster_metrics responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Metrics index. /cluster/metrics/export: get: operationId: get_cluster_metrics_export parameters: - description: Also return historic values. Returns full available metric history unless `start-time` is also set in: query name: history required: false schema: description: Also return historic values. Returns full available metric history unless `start-time` is also set type: boolean - description: Only return metrics for the current node instead of the whole cluster in: query name: local-only required: false schema: description: Only return metrics for the current node instead of the whole cluster type: boolean - description: Only return metrics from nodes passed as comma-separated list in: query name: node-list required: false schema: description: Only return metrics from nodes passed as comma-separated list type: string - description: Only include metrics with a timestamp > start-time. in: query name: start-time required: false schema: description: Only include metrics with a timestamp > start-time. type: integer responses: "200": content: application/json: schema: properties: data: description: Array of system metrics. Metrics are sorted by their timestamp. items: properties: id: description: Unique identifier for this metric object, for instance 'node/' or 'qemu/'. type: string metric: description: Name of the metric. type: string timestamp: description: Time at which this metric was observed type: integer type: description: Type of the metric. enum: - gauge - counter - derive type: string value: description: Metric value. type: number type: object type: array type: object description: OK summary: Retrieve metrics of the cluster. /cluster/metrics/server: get: operationId: get_cluster_metrics_server responses: "200": content: application/json: schema: items: properties: disable: description: Flag to disable the plugin. type: boolean id: description: The ID of the entry. type: string port: description: Server network port type: integer server: description: Server dns name or IP address type: string type: description: Plugin type. type: string type: object type: array description: OK summary: List configured metric servers. /cluster/metrics/server/{id}: delete: operationId: delete_cluster_metrics_server_id parameters: - description: "" in: path name: id required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove Metric server. get: operationId: get_cluster_metrics_server_id parameters: - description: "" in: path name: id required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: type: object description: OK summary: Read metric server configuration. post: operationId: post_cluster_metrics_server_id parameters: - description: An API path prefix inserted between ':/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. in: query name: api-path-prefix required: false schema: description: An API path prefix inserted between ':/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. type: string - description: The InfluxDB bucket/db. Only necessary when using the http v2 api. in: query name: bucket required: false schema: description: The InfluxDB bucket/db. Only necessary when using the http v2 api. type: string - description: Flag to disable the plugin. in: query name: disable required: false schema: description: Flag to disable the plugin. type: boolean - description: The ID of the entry. in: path name: id required: true schema: description: The ID of the entry. format: pve-configid type: string - description: "" in: query name: influxdbproto required: false schema: enum: - udp - http - https type: string - description: InfluxDB max-body-size in bytes. Requests are batched up to this size. in: query name: max-body-size required: false schema: description: InfluxDB max-body-size in bytes. Requests are batched up to this size. type: integer - description: MTU for metrics transmission over UDP in: query name: mtu required: false schema: description: MTU for metrics transmission over UDP type: integer - description: The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. in: query name: organization required: false schema: description: The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. type: string - description: Compression algorithm for requests in: query name: otel-compression required: false schema: description: Compression algorithm for requests enum: - none - gzip type: string - description: Custom HTTP headers (JSON format, base64 encoded) in: query name: otel-headers required: false schema: description: Custom HTTP headers (JSON format, base64 encoded) type: string - description: Maximum request body size in bytes in: query name: otel-max-body-size required: false schema: description: Maximum request body size in bytes type: integer - description: OTLP endpoint path in: query name: otel-path required: false schema: description: OTLP endpoint path type: string - description: HTTP protocol in: query name: otel-protocol required: false schema: description: HTTP protocol enum: - http - https type: string - description: Additional resource attributes as JSON, base64 encoded in: query name: otel-resource-attributes required: false schema: description: Additional resource attributes as JSON, base64 encoded type: string - description: HTTP request timeout in seconds in: query name: otel-timeout required: false schema: description: HTTP request timeout in seconds type: integer - description: Verify SSL certificates in: query name: otel-verify-ssl required: false schema: description: Verify SSL certificates type: boolean - description: 'root graphite path (ex: proxmox.mycluster.mykey)' in: query name: path required: false schema: description: 'root graphite path (ex: proxmox.mycluster.mykey)' format: graphite-path type: string - description: server network port in: query name: port required: false schema: description: server network port type: integer - description: Protocol to send graphite data. TCP or UDP (default) in: query name: proto required: false schema: description: Protocol to send graphite data. TCP or UDP (default) enum: - udp - tcp type: string - description: server dns name or IP address in: query name: server required: false schema: description: server dns name or IP address format: address type: string - description: graphite TCP socket timeout (default=1) in: query name: timeout required: false schema: description: graphite TCP socket timeout (default=1) type: integer - description: The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user:password' instead. in: query name: token required: false schema: description: The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user:password' instead. type: string - description: Plugin type. in: query name: type required: false schema: description: Plugin type. enum: - graphite - influxdb - opentelemetry format: pve-configid type: string - description: Set to 0 to disable certificate verification for https endpoints. in: query name: verify-certificate required: false schema: description: Set to 0 to disable certificate verification for https endpoints. type: boolean requestBody: content: application/json: schema: properties: api-path-prefix: description: An API path prefix inserted between ':/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. type: string bucket: description: The InfluxDB bucket/db. Only necessary when using the http v2 api. type: string disable: description: Flag to disable the plugin. type: boolean id: description: The ID of the entry. format: pve-configid type: string influxdbproto: enum: - udp - http - https type: string max-body-size: description: InfluxDB max-body-size in bytes. Requests are batched up to this size. type: integer mtu: description: MTU for metrics transmission over UDP type: integer organization: description: The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. type: string otel-compression: description: Compression algorithm for requests enum: - none - gzip type: string otel-headers: description: Custom HTTP headers (JSON format, base64 encoded) type: string otel-max-body-size: description: Maximum request body size in bytes type: integer otel-path: description: OTLP endpoint path type: string otel-protocol: description: HTTP protocol enum: - http - https type: string otel-resource-attributes: description: Additional resource attributes as JSON, base64 encoded type: string otel-timeout: description: HTTP request timeout in seconds type: integer otel-verify-ssl: description: Verify SSL certificates type: boolean path: description: 'root graphite path (ex: proxmox.mycluster.mykey)' format: graphite-path type: string port: description: server network port type: integer proto: description: Protocol to send graphite data. TCP or UDP (default) enum: - udp - tcp type: string server: description: server dns name or IP address format: address type: string timeout: description: graphite TCP socket timeout (default=1) type: integer token: description: The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user:password' instead. type: string type: description: Plugin type. enum: - graphite - influxdb - opentelemetry format: pve-configid type: string verify-certificate: description: Set to 0 to disable certificate verification for https endpoints. type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new external metric server config put: operationId: put_cluster_metrics_server_id parameters: - description: An API path prefix inserted between ':/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. in: query name: api-path-prefix required: false schema: description: An API path prefix inserted between ':/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. type: string - description: The InfluxDB bucket/db. Only necessary when using the http v2 api. in: query name: bucket required: false schema: description: The InfluxDB bucket/db. Only necessary when using the http v2 api. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Flag to disable the plugin. in: query name: disable required: false schema: description: Flag to disable the plugin. type: boolean - description: The ID of the entry. in: path name: id required: true schema: description: The ID of the entry. format: pve-configid type: string - description: "" in: query name: influxdbproto required: false schema: enum: - udp - http - https type: string - description: InfluxDB max-body-size in bytes. Requests are batched up to this size. in: query name: max-body-size required: false schema: description: InfluxDB max-body-size in bytes. Requests are batched up to this size. type: integer - description: MTU for metrics transmission over UDP in: query name: mtu required: false schema: description: MTU for metrics transmission over UDP type: integer - description: The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. in: query name: organization required: false schema: description: The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. type: string - description: Compression algorithm for requests in: query name: otel-compression required: false schema: description: Compression algorithm for requests enum: - none - gzip type: string - description: Custom HTTP headers (JSON format, base64 encoded) in: query name: otel-headers required: false schema: description: Custom HTTP headers (JSON format, base64 encoded) type: string - description: Maximum request body size in bytes in: query name: otel-max-body-size required: false schema: description: Maximum request body size in bytes type: integer - description: OTLP endpoint path in: query name: otel-path required: false schema: description: OTLP endpoint path type: string - description: HTTP protocol in: query name: otel-protocol required: false schema: description: HTTP protocol enum: - http - https type: string - description: Additional resource attributes as JSON, base64 encoded in: query name: otel-resource-attributes required: false schema: description: Additional resource attributes as JSON, base64 encoded type: string - description: HTTP request timeout in seconds in: query name: otel-timeout required: false schema: description: HTTP request timeout in seconds type: integer - description: Verify SSL certificates in: query name: otel-verify-ssl required: false schema: description: Verify SSL certificates type: boolean - description: 'root graphite path (ex: proxmox.mycluster.mykey)' in: query name: path required: false schema: description: 'root graphite path (ex: proxmox.mycluster.mykey)' format: graphite-path type: string - description: server network port in: query name: port required: false schema: description: server network port type: integer - description: Protocol to send graphite data. TCP or UDP (default) in: query name: proto required: false schema: description: Protocol to send graphite data. TCP or UDP (default) enum: - udp - tcp type: string - description: server dns name or IP address in: query name: server required: false schema: description: server dns name or IP address format: address type: string - description: graphite TCP socket timeout (default=1) in: query name: timeout required: false schema: description: graphite TCP socket timeout (default=1) type: integer - description: The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user:password' instead. in: query name: token required: false schema: description: The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user:password' instead. type: string - description: Set to 0 to disable certificate verification for https endpoints. in: query name: verify-certificate required: false schema: description: Set to 0 to disable certificate verification for https endpoints. type: boolean requestBody: content: application/json: schema: properties: api-path-prefix: description: An API path prefix inserted between ':/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. type: string bucket: description: The InfluxDB bucket/db. Only necessary when using the http v2 api. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Flag to disable the plugin. type: boolean id: description: The ID of the entry. format: pve-configid type: string influxdbproto: enum: - udp - http - https type: string max-body-size: description: InfluxDB max-body-size in bytes. Requests are batched up to this size. type: integer mtu: description: MTU for metrics transmission over UDP type: integer organization: description: The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. type: string otel-compression: description: Compression algorithm for requests enum: - none - gzip type: string otel-headers: description: Custom HTTP headers (JSON format, base64 encoded) type: string otel-max-body-size: description: Maximum request body size in bytes type: integer otel-path: description: OTLP endpoint path type: string otel-protocol: description: HTTP protocol enum: - http - https type: string otel-resource-attributes: description: Additional resource attributes as JSON, base64 encoded type: string otel-timeout: description: HTTP request timeout in seconds type: integer otel-verify-ssl: description: Verify SSL certificates type: boolean path: description: 'root graphite path (ex: proxmox.mycluster.mykey)' format: graphite-path type: string port: description: server network port type: integer proto: description: Protocol to send graphite data. TCP or UDP (default) enum: - udp - tcp type: string server: description: server dns name or IP address format: address type: string timeout: description: graphite TCP socket timeout (default=1) type: integer token: description: The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user:password' instead. type: string verify-certificate: description: Set to 0 to disable certificate verification for https endpoints. type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update metric server configuration. /cluster/nextid: get: operationId: get_cluster_nextid parameters: - description: The (unique) ID of the VM. in: query name: vmid required: false schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: The next free VMID. type: integer description: OK summary: Get next free VMID. Pass a VMID to assert that its free (at time of check). /cluster/notifications: get: operationId: get_cluster_notifications responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Index for notification-related API endpoints. /cluster/notifications/endpoints: get: operationId: get_cluster_notifications_endpoints responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Index for all available endpoint types. /cluster/notifications/endpoints/gotify: get: operationId: get_cluster_notifications_endpoints_gotify responses: "200": content: application/json: schema: items: properties: comment: description: Comment type: string disable: description: Disable this target type: boolean name: description: The name of the endpoint. format: pve-configid type: string origin: description: Show if this entry was created by a user or was built-in enum: - user-created - builtin - modified-builtin type: string server: description: Server URL type: string type: object type: array description: OK summary: Returns a list of all gotify endpoints post: operationId: post_cluster_notifications_endpoints_gotify parameters: - description: Comment in: query name: comment required: false schema: description: Comment type: string - description: Disable this target in: query name: disable required: false schema: description: Disable this target type: boolean - description: The name of the endpoint. in: query name: name required: false schema: description: The name of the endpoint. format: pve-configid type: string - description: Server URL in: query name: server required: false schema: description: Server URL type: string - description: Secret token in: query name: token required: false schema: description: Secret token type: string requestBody: content: application/json: schema: properties: comment: description: Comment type: string disable: description: Disable this target type: boolean name: description: The name of the endpoint. format: pve-configid type: string server: description: Server URL type: string token: description: Secret token type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new gotify endpoint /cluster/notifications/endpoints/gotify/{name}: delete: operationId: delete_cluster_notifications_endpoints_gotify_name parameters: - description: "" in: path name: name required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove gotify endpoint get: operationId: get_cluster_notifications_endpoints_gotify_name parameters: - description: Name of the endpoint. in: path name: name required: true schema: description: Name of the endpoint. format: pve-configid type: string responses: "200": content: application/json: schema: properties: comment: description: Comment type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Disable this target type: boolean name: description: The name of the endpoint. format: pve-configid type: string server: description: Server URL type: string type: object description: OK summary: Return a specific gotify endpoint put: operationId: put_cluster_notifications_endpoints_gotify_name parameters: - description: Comment in: query name: comment required: false schema: description: Comment type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. items: format: pve-configid type: string type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Disable this target in: query name: disable required: false schema: description: Disable this target type: boolean - description: The name of the endpoint. in: path name: name required: true schema: description: The name of the endpoint. format: pve-configid type: string - description: Server URL in: query name: server required: false schema: description: Server URL type: string - description: Secret token in: query name: token required: false schema: description: Secret token type: string requestBody: content: application/json: schema: properties: comment: description: Comment type: string delete: description: A list of settings you want to delete. items: format: pve-configid type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Disable this target type: boolean name: description: The name of the endpoint. format: pve-configid type: string server: description: Server URL type: string token: description: Secret token type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update existing gotify endpoint /cluster/notifications/endpoints/sendmail: get: operationId: get_cluster_notifications_endpoints_sendmail responses: "200": content: application/json: schema: items: properties: author: description: Author of the mail type: string comment: description: Comment type: string disable: description: Disable this target type: boolean from-address: description: '`From` address for the mail' type: string mailto: description: List of email recipients items: format: email-or-username type: string type: array mailto-user: description: List of users items: format: pve-userid type: string type: array name: description: The name of the endpoint. format: pve-configid type: string origin: description: Show if this entry was created by a user or was built-in enum: - user-created - builtin - modified-builtin type: string type: object type: array description: OK summary: Returns a list of all sendmail endpoints post: operationId: post_cluster_notifications_endpoints_sendmail parameters: - description: Author of the mail in: query name: author required: false schema: description: Author of the mail type: string - description: Comment in: query name: comment required: false schema: description: Comment type: string - description: Disable this target in: query name: disable required: false schema: description: Disable this target type: boolean - description: '`From` address for the mail' in: query name: from-address required: false schema: description: '`From` address for the mail' type: string - description: List of email recipients in: query name: mailto required: false schema: description: List of email recipients items: format: email-or-username type: string type: array - description: List of users in: query name: mailto-user required: false schema: description: List of users items: format: pve-userid type: string type: array - description: The name of the endpoint. in: query name: name required: false schema: description: The name of the endpoint. format: pve-configid type: string requestBody: content: application/json: schema: properties: author: description: Author of the mail type: string comment: description: Comment type: string disable: description: Disable this target type: boolean from-address: description: '`From` address for the mail' type: string mailto: description: List of email recipients items: format: email-or-username type: string type: array mailto-user: description: List of users items: format: pve-userid type: string type: array name: description: The name of the endpoint. format: pve-configid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new sendmail endpoint /cluster/notifications/endpoints/sendmail/{name}: delete: operationId: delete_cluster_notifications_endpoints_sendmail_name parameters: - description: "" in: path name: name required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove sendmail endpoint get: operationId: get_cluster_notifications_endpoints_sendmail_name parameters: - description: "" in: path name: name required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: properties: author: description: Author of the mail type: string comment: description: Comment type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Disable this target type: boolean from-address: description: '`From` address for the mail' type: string mailto: description: List of email recipients items: format: email-or-username type: string type: array mailto-user: description: List of users items: format: pve-userid type: string type: array name: description: The name of the endpoint. format: pve-configid type: string type: object description: OK summary: Return a specific sendmail endpoint put: operationId: put_cluster_notifications_endpoints_sendmail_name parameters: - description: Author of the mail in: query name: author required: false schema: description: Author of the mail type: string - description: Comment in: query name: comment required: false schema: description: Comment type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. items: format: pve-configid type: string type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Disable this target in: query name: disable required: false schema: description: Disable this target type: boolean - description: '`From` address for the mail' in: query name: from-address required: false schema: description: '`From` address for the mail' type: string - description: List of email recipients in: query name: mailto required: false schema: description: List of email recipients items: format: email-or-username type: string type: array - description: List of users in: query name: mailto-user required: false schema: description: List of users items: format: pve-userid type: string type: array - description: The name of the endpoint. in: path name: name required: true schema: description: The name of the endpoint. format: pve-configid type: string requestBody: content: application/json: schema: properties: author: description: Author of the mail type: string comment: description: Comment type: string delete: description: A list of settings you want to delete. items: format: pve-configid type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Disable this target type: boolean from-address: description: '`From` address for the mail' type: string mailto: description: List of email recipients items: format: email-or-username type: string type: array mailto-user: description: List of users items: format: pve-userid type: string type: array name: description: The name of the endpoint. format: pve-configid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update existing sendmail endpoint /cluster/notifications/endpoints/smtp: get: operationId: get_cluster_notifications_endpoints_smtp responses: "200": content: application/json: schema: items: properties: author: description: Author of the mail. Defaults to 'Proxmox VE'. type: string comment: description: Comment type: string disable: description: Disable this target type: boolean from-address: description: '`From` address for the mail' type: string mailto: description: List of email recipients items: format: email-or-username type: string type: array mailto-user: description: List of users items: format: pve-userid type: string type: array mode: description: Determine which encryption method shall be used for the connection. enum: - insecure - starttls - tls type: string name: description: The name of the endpoint. format: pve-configid type: string origin: description: Show if this entry was created by a user or was built-in enum: - user-created - builtin - modified-builtin type: string port: description: The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. type: integer server: description: The address of the SMTP server. type: string username: description: Username for SMTP authentication type: string type: object type: array description: OK summary: Returns a list of all smtp endpoints post: operationId: post_cluster_notifications_endpoints_smtp parameters: - description: Author of the mail. Defaults to 'Proxmox VE'. in: query name: author required: false schema: description: Author of the mail. Defaults to 'Proxmox VE'. type: string - description: Comment in: query name: comment required: false schema: description: Comment type: string - description: Disable this target in: query name: disable required: false schema: description: Disable this target type: boolean - description: '`From` address for the mail' in: query name: from-address required: false schema: description: '`From` address for the mail' type: string - description: List of email recipients in: query name: mailto required: false schema: description: List of email recipients items: format: email-or-username type: string type: array - description: List of users in: query name: mailto-user required: false schema: description: List of users items: format: pve-userid type: string type: array - description: Determine which encryption method shall be used for the connection. in: query name: mode required: false schema: description: Determine which encryption method shall be used for the connection. enum: - insecure - starttls - tls type: string - description: The name of the endpoint. in: query name: name required: false schema: description: The name of the endpoint. format: pve-configid type: string - description: Password for SMTP authentication in: query name: password required: false schema: description: Password for SMTP authentication type: string - description: The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. in: query name: port required: false schema: description: The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. type: integer - description: The address of the SMTP server. in: query name: server required: false schema: description: The address of the SMTP server. type: string - description: Username for SMTP authentication in: query name: username required: false schema: description: Username for SMTP authentication type: string requestBody: content: application/json: schema: properties: author: description: Author of the mail. Defaults to 'Proxmox VE'. type: string comment: description: Comment type: string disable: description: Disable this target type: boolean from-address: description: '`From` address for the mail' type: string mailto: description: List of email recipients items: format: email-or-username type: string type: array mailto-user: description: List of users items: format: pve-userid type: string type: array mode: description: Determine which encryption method shall be used for the connection. enum: - insecure - starttls - tls type: string name: description: The name of the endpoint. format: pve-configid type: string password: description: Password for SMTP authentication type: string port: description: The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. type: integer server: description: The address of the SMTP server. type: string username: description: Username for SMTP authentication type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new smtp endpoint /cluster/notifications/endpoints/smtp/{name}: delete: operationId: delete_cluster_notifications_endpoints_smtp_name parameters: - description: "" in: path name: name required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove smtp endpoint get: operationId: get_cluster_notifications_endpoints_smtp_name parameters: - description: "" in: path name: name required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: properties: author: description: Author of the mail. Defaults to 'Proxmox VE'. type: string comment: description: Comment type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Disable this target type: boolean from-address: description: '`From` address for the mail' type: string mailto: description: List of email recipients items: format: email-or-username type: string type: array mailto-user: description: List of users items: format: pve-userid type: string type: array mode: description: Determine which encryption method shall be used for the connection. enum: - insecure - starttls - tls type: string name: description: The name of the endpoint. format: pve-configid type: string port: description: The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. type: integer server: description: The address of the SMTP server. type: string username: description: Username for SMTP authentication type: string type: object description: OK summary: Return a specific smtp endpoint put: operationId: put_cluster_notifications_endpoints_smtp_name parameters: - description: Author of the mail. Defaults to 'Proxmox VE'. in: query name: author required: false schema: description: Author of the mail. Defaults to 'Proxmox VE'. type: string - description: Comment in: query name: comment required: false schema: description: Comment type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. items: format: pve-configid type: string type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Disable this target in: query name: disable required: false schema: description: Disable this target type: boolean - description: '`From` address for the mail' in: query name: from-address required: false schema: description: '`From` address for the mail' type: string - description: List of email recipients in: query name: mailto required: false schema: description: List of email recipients items: format: email-or-username type: string type: array - description: List of users in: query name: mailto-user required: false schema: description: List of users items: format: pve-userid type: string type: array - description: Determine which encryption method shall be used for the connection. in: query name: mode required: false schema: description: Determine which encryption method shall be used for the connection. enum: - insecure - starttls - tls type: string - description: The name of the endpoint. in: path name: name required: true schema: description: The name of the endpoint. format: pve-configid type: string - description: Password for SMTP authentication in: query name: password required: false schema: description: Password for SMTP authentication type: string - description: The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. in: query name: port required: false schema: description: The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. type: integer - description: The address of the SMTP server. in: query name: server required: false schema: description: The address of the SMTP server. type: string - description: Username for SMTP authentication in: query name: username required: false schema: description: Username for SMTP authentication type: string requestBody: content: application/json: schema: properties: author: description: Author of the mail. Defaults to 'Proxmox VE'. type: string comment: description: Comment type: string delete: description: A list of settings you want to delete. items: format: pve-configid type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Disable this target type: boolean from-address: description: '`From` address for the mail' type: string mailto: description: List of email recipients items: format: email-or-username type: string type: array mailto-user: description: List of users items: format: pve-userid type: string type: array mode: description: Determine which encryption method shall be used for the connection. enum: - insecure - starttls - tls type: string name: description: The name of the endpoint. format: pve-configid type: string password: description: Password for SMTP authentication type: string port: description: The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. type: integer server: description: The address of the SMTP server. type: string username: description: Username for SMTP authentication type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update existing smtp endpoint /cluster/notifications/endpoints/webhook: get: operationId: get_cluster_notifications_endpoints_webhook responses: "200": content: application/json: schema: items: properties: body: description: HTTP body, base64 encoded type: string comment: description: Comment type: string disable: description: Disable this target type: boolean header: description: HTTP headers to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array method: description: HTTP method enum: - post - put - get type: string name: description: The name of the endpoint. format: pve-configid type: string origin: description: Show if this entry was created by a user or was built-in enum: - user-created - builtin - modified-builtin type: string secret: description: Secrets to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array url: description: Server URL type: string type: object type: array description: OK summary: Returns a list of all webhook endpoints post: operationId: post_cluster_notifications_endpoints_webhook parameters: - description: HTTP body, base64 encoded in: query name: body required: false schema: description: HTTP body, base64 encoded type: string - description: Comment in: query name: comment required: false schema: description: Comment type: string - description: Disable this target in: query name: disable required: false schema: description: Disable this target type: boolean - description: HTTP headers to set. These have to be formatted as a property string in the format name=,value= in: query name: header required: false schema: description: HTTP headers to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array - description: HTTP method in: query name: method required: false schema: description: HTTP method enum: - post - put - get type: string - description: The name of the endpoint. in: query name: name required: false schema: description: The name of the endpoint. format: pve-configid type: string - description: Secrets to set. These have to be formatted as a property string in the format name=,value= in: query name: secret required: false schema: description: Secrets to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array - description: Server URL in: query name: url required: false schema: description: Server URL type: string requestBody: content: application/json: schema: properties: body: description: HTTP body, base64 encoded type: string comment: description: Comment type: string disable: description: Disable this target type: boolean header: description: HTTP headers to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array method: description: HTTP method enum: - post - put - get type: string name: description: The name of the endpoint. format: pve-configid type: string secret: description: Secrets to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array url: description: Server URL type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new webhook endpoint /cluster/notifications/endpoints/webhook/{name}: delete: operationId: delete_cluster_notifications_endpoints_webhook_name parameters: - description: "" in: path name: name required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove webhook endpoint get: operationId: get_cluster_notifications_endpoints_webhook_name parameters: - description: Name of the endpoint. in: path name: name required: true schema: description: Name of the endpoint. format: pve-configid type: string responses: "200": content: application/json: schema: properties: body: description: HTTP body, base64 encoded type: string comment: description: Comment type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Disable this target type: boolean header: description: HTTP headers to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array method: description: HTTP method enum: - post - put - get type: string name: description: The name of the endpoint. format: pve-configid type: string secret: description: Secrets to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array url: description: Server URL type: string type: object description: OK summary: Return a specific webhook endpoint put: operationId: put_cluster_notifications_endpoints_webhook_name parameters: - description: HTTP body, base64 encoded in: query name: body required: false schema: description: HTTP body, base64 encoded type: string - description: Comment in: query name: comment required: false schema: description: Comment type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. items: format: pve-configid type: string type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Disable this target in: query name: disable required: false schema: description: Disable this target type: boolean - description: HTTP headers to set. These have to be formatted as a property string in the format name=,value= in: query name: header required: false schema: description: HTTP headers to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array - description: HTTP method in: query name: method required: false schema: description: HTTP method enum: - post - put - get type: string - description: The name of the endpoint. in: path name: name required: true schema: description: The name of the endpoint. format: pve-configid type: string - description: Secrets to set. These have to be formatted as a property string in the format name=,value= in: query name: secret required: false schema: description: Secrets to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array - description: Server URL in: query name: url required: false schema: description: Server URL type: string requestBody: content: application/json: schema: properties: body: description: HTTP body, base64 encoded type: string comment: description: Comment type: string delete: description: A list of settings you want to delete. items: format: pve-configid type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Disable this target type: boolean header: description: HTTP headers to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array method: description: HTTP method enum: - post - put - get type: string name: description: The name of the endpoint. format: pve-configid type: string secret: description: Secrets to set. These have to be formatted as a property string in the format name=,value= items: type: string type: array url: description: Server URL type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update existing webhook endpoint /cluster/notifications/matcher-field-values: get: operationId: get_cluster_notifications_matcher_field_values responses: "200": content: application/json: schema: items: properties: comment: description: Additional comment for this value. type: string field: description: Field this value belongs to. type: string value: description: Notification metadata value known by the system. type: string type: object type: array description: OK summary: Returns known notification metadata fields and their known values /cluster/notifications/matcher-fields: get: operationId: get_cluster_notifications_matcher_fields responses: "200": content: application/json: schema: items: properties: name: description: Name of the field. type: string type: object type: array description: OK summary: Returns known notification metadata fields /cluster/notifications/matchers: get: operationId: get_cluster_notifications_matchers responses: "200": content: application/json: schema: items: properties: comment: description: Comment type: string disable: description: Disable this matcher type: boolean invert-match: description: Invert match of the whole matcher type: boolean match-calendar: description: Match notification timestamp items: type: string type: array match-field: description: Metadata fields to match (regex or exact match). Must be in the form (regex|exact):= items: type: string type: array match-severity: description: Notification severities to match items: type: string type: array mode: description: Choose between 'all' and 'any' for when multiple properties are specified enum: - all - any type: string name: description: Name of the matcher. format: pve-configid type: string origin: description: Show if this entry was created by a user or was built-in enum: - user-created - builtin - modified-builtin type: string target: description: Targets to notify on match items: format: pve-configid type: string type: array type: object type: array description: OK summary: Returns a list of all matchers post: operationId: post_cluster_notifications_matchers parameters: - description: Comment in: query name: comment required: false schema: description: Comment type: string - description: Disable this matcher in: query name: disable required: false schema: description: Disable this matcher type: boolean - description: Invert match of the whole matcher in: query name: invert-match required: false schema: description: Invert match of the whole matcher type: boolean - description: Match notification timestamp in: query name: match-calendar required: false schema: description: Match notification timestamp items: type: string type: array - description: Metadata fields to match (regex or exact match). Must be in the form (regex|exact):= in: query name: match-field required: false schema: description: Metadata fields to match (regex or exact match). Must be in the form (regex|exact):= items: type: string type: array - description: Notification severities to match in: query name: match-severity required: false schema: description: Notification severities to match items: type: string type: array - description: Choose between 'all' and 'any' for when multiple properties are specified in: query name: mode required: false schema: description: Choose between 'all' and 'any' for when multiple properties are specified enum: - all - any type: string - description: Name of the matcher. in: query name: name required: false schema: description: Name of the matcher. format: pve-configid type: string - description: Targets to notify on match in: query name: target required: false schema: description: Targets to notify on match items: format: pve-configid type: string type: array requestBody: content: application/json: schema: properties: comment: description: Comment type: string disable: description: Disable this matcher type: boolean invert-match: description: Invert match of the whole matcher type: boolean match-calendar: description: Match notification timestamp items: type: string type: array match-field: description: Metadata fields to match (regex or exact match). Must be in the form (regex|exact):= items: type: string type: array match-severity: description: Notification severities to match items: type: string type: array mode: description: Choose between 'all' and 'any' for when multiple properties are specified enum: - all - any type: string name: description: Name of the matcher. format: pve-configid type: string target: description: Targets to notify on match items: format: pve-configid type: string type: array type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new matcher /cluster/notifications/matchers/{name}: delete: operationId: delete_cluster_notifications_matchers_name parameters: - description: "" in: path name: name required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove matcher get: operationId: get_cluster_notifications_matchers_name parameters: - description: "" in: path name: name required: true schema: format: pve-configid type: string responses: "200": content: application/json: schema: properties: comment: description: Comment type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Disable this matcher type: boolean invert-match: description: Invert match of the whole matcher type: boolean match-calendar: description: Match notification timestamp items: type: string type: array match-field: description: Metadata fields to match (regex or exact match). Must be in the form (regex|exact):= items: type: string type: array match-severity: description: Notification severities to match items: type: string type: array mode: description: Choose between 'all' and 'any' for when multiple properties are specified enum: - all - any type: string name: description: Name of the matcher. format: pve-configid type: string target: description: Targets to notify on match items: format: pve-configid type: string type: array type: object description: OK summary: Return a specific matcher put: operationId: put_cluster_notifications_matchers_name parameters: - description: Comment in: query name: comment required: false schema: description: Comment type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. items: format: pve-configid type: string type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Disable this matcher in: query name: disable required: false schema: description: Disable this matcher type: boolean - description: Invert match of the whole matcher in: query name: invert-match required: false schema: description: Invert match of the whole matcher type: boolean - description: Match notification timestamp in: query name: match-calendar required: false schema: description: Match notification timestamp items: type: string type: array - description: Metadata fields to match (regex or exact match). Must be in the form (regex|exact):= in: query name: match-field required: false schema: description: Metadata fields to match (regex or exact match). Must be in the form (regex|exact):= items: type: string type: array - description: Notification severities to match in: query name: match-severity required: false schema: description: Notification severities to match items: type: string type: array - description: Choose between 'all' and 'any' for when multiple properties are specified in: query name: mode required: false schema: description: Choose between 'all' and 'any' for when multiple properties are specified enum: - all - any type: string - description: Name of the matcher. in: path name: name required: true schema: description: Name of the matcher. format: pve-configid type: string - description: Targets to notify on match in: query name: target required: false schema: description: Targets to notify on match items: format: pve-configid type: string type: array requestBody: content: application/json: schema: properties: comment: description: Comment type: string delete: description: A list of settings you want to delete. items: format: pve-configid type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Disable this matcher type: boolean invert-match: description: Invert match of the whole matcher type: boolean match-calendar: description: Match notification timestamp items: type: string type: array match-field: description: Metadata fields to match (regex or exact match). Must be in the form (regex|exact):= items: type: string type: array match-severity: description: Notification severities to match items: type: string type: array mode: description: Choose between 'all' and 'any' for when multiple properties are specified enum: - all - any type: string name: description: Name of the matcher. format: pve-configid type: string target: description: Targets to notify on match items: format: pve-configid type: string type: array type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update existing matcher /cluster/notifications/targets: get: operationId: get_cluster_notifications_targets responses: "200": content: application/json: schema: items: properties: comment: description: Comment type: string disable: description: Show if this target is disabled type: boolean name: description: Name of the target. format: pve-configid type: string origin: description: Show if this entry was created by a user or was built-in enum: - user-created - builtin - modified-builtin type: string type: description: Type of the target. enum: - sendmail - gotify - smtp - webhook type: string type: object type: array description: OK summary: Returns a list of all entities that can be used as notification targets. /cluster/notifications/targets/{name}/test: post: operationId: post_cluster_notifications_targets_name_test parameters: - description: Name of the target. in: path name: name required: true schema: description: Name of the target. format: pve-configid type: string requestBody: content: application/json: schema: properties: name: description: Name of the target. format: pve-configid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Send a test notification to a provided target. /cluster/options: get: operationId: get_cluster_options responses: "200": content: application/json: schema: type: object description: OK summary: Get datacenter options. Without 'Sys.Audit' on '/' not all options are returned. put: operationId: put_cluster_options parameters: - description: Set I/O bandwidth limit for various operations (in KiB/s). in: query name: bwlimit required: false schema: description: Set I/O bandwidth limit for various operations (in KiB/s). type: string - description: Consent text that is displayed before logging in. in: query name: consent-text required: false schema: description: Consent text that is displayed before logging in. type: string - description: Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC. in: query name: console required: false schema: description: Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC. enum: - applet - vv - html5 - xtermjs type: string - description: Cluster resource scheduling settings. in: query name: crs required: false schema: description: Cluster resource scheduling settings. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file. in: query name: description required: false schema: description: Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file. type: string - description: Specify email address to send notification from (default is root@$hostname) in: query name: email_from required: false schema: description: Specify email address to send notification from (default is root@$hostname) format: email-opt type: string - description: |- Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used. WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP in: query name: fencing required: false schema: description: |- Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used. WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP enum: - watchdog - hardware - both type: string - description: Cluster wide HA settings. in: query name: ha required: false schema: description: Cluster wide HA settings. type: string - description: 'Specify external http proxy which is used for downloads (example: ''http://username:password@host:port/'')' in: query name: http_proxy required: false schema: description: 'Specify external http proxy which is used for downloads (example: ''http://username:password@host:port/'')' type: string - description: Default keybord layout for vnc server. in: query name: keyboard required: false schema: description: Default keybord layout for vnc server. enum: - de - de-ch - da - en-gb - en-us - es - fi - fr - fr-be - fr-ca - fr-ch - hu - is - it - ja - lt - mk - nl - "no" - pl - pt - pt-br - sv - sl - tr type: string - description: Default GUI language. in: query name: language required: false schema: description: Default GUI language. enum: - ar - ca - da - de - en - es - eu - fa - fr - hr - he - it - ja - ka - kr - nb - nl - nn - pl - pt_BR - ru - sl - sv - tr - ukr - zh_CN - zh_TW type: string - description: The location of the cluster. in: query name: location required: false schema: description: The location of the cluster. type: string - description: Prefix for the auto-generated MAC addresses of virtual guests. The default 'BC:24:11' is the OUI assigned by the IEEE to Proxmox Server Solutions GmbH for a 24-bit large MAC block. You're allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or behind NAT). in: query name: mac_prefix required: false schema: description: Prefix for the auto-generated MAC addresses of virtual guests. The default 'BC:24:11' is the OUI assigned by the IEEE to Proxmox Server Solutions GmbH for a 24-bit large MAC block. You're allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or behind NAT). format: mac-prefix type: string - description: Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager. in: query name: max_workers required: false schema: description: Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager. type: integer - description: For cluster wide migration settings. in: query name: migration required: false schema: description: For cluster wide migration settings. type: string - description: Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead! in: query name: migration_unsecure required: false schema: description: Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead! type: boolean - description: Control the range for the free VMID auto-selection pool. in: query name: next-id required: false schema: description: Control the range for the free VMID auto-selection pool. type: string - description: Cluster-wide notification settings. in: query name: notify required: false schema: description: Cluster-wide notification settings. type: string - description: A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`. in: query name: registered-tags required: false schema: description: A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`. type: string - description: For cluster wide replication settings. in: query name: replication required: false schema: description: For cluster wide replication settings. type: string - description: Tag style options. in: query name: tag-style required: false schema: description: Tag style options. type: string - description: u2f in: query name: u2f required: false schema: description: u2f type: string - description: Privilege options for user-settable tags in: query name: user-tag-access required: false schema: description: Privilege options for user-settable tags type: string - description: webauthn configuration in: query name: webauthn required: false schema: description: webauthn configuration type: string requestBody: content: application/json: schema: properties: bwlimit: description: Set I/O bandwidth limit for various operations (in KiB/s). type: string consent-text: description: Consent text that is displayed before logging in. type: string console: description: Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC. enum: - applet - vv - html5 - xtermjs type: string crs: description: Cluster resource scheduling settings. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string description: description: Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file. type: string email_from: description: Specify email address to send notification from (default is root@$hostname) format: email-opt type: string fencing: description: |- Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used. WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP enum: - watchdog - hardware - both type: string ha: description: Cluster wide HA settings. type: string http_proxy: description: 'Specify external http proxy which is used for downloads (example: ''http://username:password@host:port/'')' type: string keyboard: description: Default keybord layout for vnc server. enum: - de - de-ch - da - en-gb - en-us - es - fi - fr - fr-be - fr-ca - fr-ch - hu - is - it - ja - lt - mk - nl - "no" - pl - pt - pt-br - sv - sl - tr type: string language: description: Default GUI language. enum: - ar - ca - da - de - en - es - eu - fa - fr - hr - he - it - ja - ka - kr - nb - nl - nn - pl - pt_BR - ru - sl - sv - tr - ukr - zh_CN - zh_TW type: string location: description: The location of the cluster. type: string mac_prefix: description: Prefix for the auto-generated MAC addresses of virtual guests. The default 'BC:24:11' is the OUI assigned by the IEEE to Proxmox Server Solutions GmbH for a 24-bit large MAC block. You're allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or behind NAT). format: mac-prefix type: string max_workers: description: Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager. type: integer migration: description: For cluster wide migration settings. type: string migration_unsecure: description: Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead! type: boolean next-id: description: Control the range for the free VMID auto-selection pool. type: string notify: description: Cluster-wide notification settings. type: string registered-tags: description: A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`. type: string replication: description: For cluster wide replication settings. type: string tag-style: description: Tag style options. type: string u2f: description: u2f type: string user-tag-access: description: Privilege options for user-settable tags type: string webauthn: description: webauthn configuration type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set datacenter options. /cluster/qemu: get: operationId: get_cluster_qemu responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Cluster-wide QEMU index /cluster/qemu/cpu-flags: get: operationId: get_cluster_qemu_cpu_flags parameters: - description: Acceleration type to check node compatibility for. in: query name: accel required: false schema: description: Acceleration type to check node compatibility for. enum: - kvm - tcg type: string - description: Virtual processor architecture. Defaults to the host architecture. in: query name: arch required: false schema: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string responses: "200": content: application/json: schema: items: properties: description: description: Description of the CPU flag. type: string name: description: Name of the CPU flag. type: string supported-on: description: List of nodes supporting the flag with the selected acceleration type ("accel"). items: description: The cluster node name. format: pve-node type: string type: array type: object type: array description: OK summary: List of available CPU flags. Currently only implemented for x86_64, returns an empty list for aarch64. /cluster/qemu/custom-cpu-models: get: operationId: get_cluster_qemu_custom_cpu_models responses: "200": content: application/json: schema: items: properties: cputype: description: Emulated CPU type. Can be default or custom name (custom model names must be prefixed with 'custom-'). type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string flags: description: 'List of additional CPU flags separated by '';''. Use ''+FLAG'' to enable, ''-FLAG'' to disable a flag. There is a special ''nested-virt'' shorthand which controls nested virtualization for the current CPU (''svm'' for AMD and ''vmx'' for Intel). Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: aes, amd-no-ssb, amd-ssbd, hv-evmcs, hv-tlbflush, ibpb, md-clear, nested-virt, pcid, pdpe1gb, spec-ctrl, ssbd, virt-ssbd' type: string guest-phys-bits: description: Number of physical address bits available to the guest. type: integer hidden: description: Do not identify as a KVM virtual machine. Only affects vCPUs with x86-64 architecture. type: boolean hv-vendor-id: description: The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID. type: string level: description: Maximum input value for the basic CPUID leaves the guest can query - that is the vendor (leaf 0), family/model/stepping and feature bits (leaf 1), cache and topology info (leaves 4 and B), and so on. Higher-numbered leaves are hidden. Setting '30' is a common workaround for Hyper-V boot failures on Windows guests running on recent Intel hosts. Only applies when the vCPU architecture is x86_64. type: integer phys-bits: description: The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values. format: pve-phys-bits type: string reported-model: description: CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS. enum: - "486" - a64fx - athlon - Broadwell - Broadwell-IBRS - Broadwell-noTSX - Broadwell-noTSX-IBRS - Cascadelake-Server - Cascadelake-Server-noTSX - Cascadelake-Server-v2 - Cascadelake-Server-v4 - Cascadelake-Server-v5 - ClearwaterForest - ClearwaterForest-v2 - ClearwaterForest-v3 - Conroe - Cooperlake - Cooperlake-v2 - core2duo - coreduo - cortex-a35 - cortex-a53 - cortex-a55 - cortex-a57 - cortex-a710 - cortex-a72 - cortex-a76 - cortex-a78ae - DiamondRapids - EPYC - EPYC-Genoa - EPYC-Genoa-v2 - EPYC-IBPB - EPYC-Milan - EPYC-Milan-v2 - EPYC-Milan-v3 - EPYC-Rome - EPYC-Rome-v2 - EPYC-Rome-v3 - EPYC-Rome-v4 - EPYC-Rome-v5 - EPYC-Turin - EPYC-v3 - EPYC-v4 - EPYC-v5 - GraniteRapids - GraniteRapids-v2 - GraniteRapids-v3 - GraniteRapids-v4 - GraniteRapids-v5 - Haswell - Haswell-IBRS - Haswell-noTSX - Haswell-noTSX-IBRS - host - Icelake-Client - Icelake-Client-noTSX - Icelake-Server - Icelake-Server-noTSX - Icelake-Server-v3 - Icelake-Server-v4 - Icelake-Server-v5 - Icelake-Server-v6 - Icelake-Server-v7 - IvyBridge - IvyBridge-IBRS - KnightsMill - kvm32 - kvm64 - max - Nehalem - Nehalem-IBRS - neoverse-n1 - neoverse-n2 - neoverse-v1 - Opteron_G1 - Opteron_G2 - Opteron_G3 - Opteron_G4 - Opteron_G5 - Penryn - pentium - pentium2 - pentium3 - phenom - qemu32 - qemu64 - SandyBridge - SandyBridge-IBRS - SapphireRapids - SapphireRapids-v2 - SapphireRapids-v3 - SapphireRapids-v4 - SapphireRapids-v5 - SapphireRapids-v6 - SierraForest - SierraForest-v2 - SierraForest-v3 - SierraForest-v4 - SierraForest-v5 - Skylake-Client - Skylake-Client-IBRS - Skylake-Client-noTSX-IBRS - Skylake-Client-v4 - Skylake-Server - Skylake-Server-IBRS - Skylake-Server-noTSX-IBRS - Skylake-Server-v4 - Skylake-Server-v5 - Westmere - Westmere-IBRS type: string type: object type: array description: OK summary: List all custom CPU model definitions visible to the user. post: operationId: post_cluster_qemu_custom_cpu_models parameters: - description: Name for the custom CPU model. The 'custom-' prefix is optional. in: query name: cputype required: false schema: description: Name for the custom CPU model. The 'custom-' prefix is optional. format: pve-configid type: string - description: 'List of additional CPU flags separated by '';''. Use ''+FLAG'' to enable, ''-FLAG'' to disable a flag. There is a special ''nested-virt'' shorthand which controls nested virtualization for the current CPU (''svm'' for AMD and ''vmx'' for Intel). Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: aes, amd-no-ssb, amd-ssbd, hv-evmcs, hv-tlbflush, ibpb, md-clear, nested-virt, pcid, pdpe1gb, spec-ctrl, ssbd, virt-ssbd' in: query name: flags required: false schema: description: 'List of additional CPU flags separated by '';''. Use ''+FLAG'' to enable, ''-FLAG'' to disable a flag. There is a special ''nested-virt'' shorthand which controls nested virtualization for the current CPU (''svm'' for AMD and ''vmx'' for Intel). Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: aes, amd-no-ssb, amd-ssbd, hv-evmcs, hv-tlbflush, ibpb, md-clear, nested-virt, pcid, pdpe1gb, spec-ctrl, ssbd, virt-ssbd' type: string - description: Number of physical address bits available to the guest. in: query name: guest-phys-bits required: false schema: description: Number of physical address bits available to the guest. type: integer - description: Do not identify as a KVM virtual machine. Only affects vCPUs with x86-64 architecture. in: query name: hidden required: false schema: description: Do not identify as a KVM virtual machine. Only affects vCPUs with x86-64 architecture. type: boolean - description: The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID. in: query name: hv-vendor-id required: false schema: description: The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID. type: string - description: Maximum input value for the basic CPUID leaves the guest can query - that is the vendor (leaf 0), family/model/stepping and feature bits (leaf 1), cache and topology info (leaves 4 and B), and so on. Higher-numbered leaves are hidden. Setting '30' is a common workaround for Hyper-V boot failures on Windows guests running on recent Intel hosts. Only applies when the vCPU architecture is x86_64. in: query name: level required: false schema: description: Maximum input value for the basic CPUID leaves the guest can query - that is the vendor (leaf 0), family/model/stepping and feature bits (leaf 1), cache and topology info (leaves 4 and B), and so on. Higher-numbered leaves are hidden. Setting '30' is a common workaround for Hyper-V boot failures on Windows guests running on recent Intel hosts. Only applies when the vCPU architecture is x86_64. type: integer - description: The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values. in: query name: phys-bits required: false schema: description: The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values. format: pve-phys-bits type: string - description: CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS. in: query name: reported-model required: true schema: description: CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS. enum: - "486" - a64fx - athlon - Broadwell - Broadwell-IBRS - Broadwell-noTSX - Broadwell-noTSX-IBRS - Cascadelake-Server - Cascadelake-Server-noTSX - Cascadelake-Server-v2 - Cascadelake-Server-v4 - Cascadelake-Server-v5 - ClearwaterForest - ClearwaterForest-v2 - ClearwaterForest-v3 - Conroe - Cooperlake - Cooperlake-v2 - core2duo - coreduo - cortex-a35 - cortex-a53 - cortex-a55 - cortex-a57 - cortex-a710 - cortex-a72 - cortex-a76 - cortex-a78ae - DiamondRapids - EPYC - EPYC-Genoa - EPYC-Genoa-v2 - EPYC-IBPB - EPYC-Milan - EPYC-Milan-v2 - EPYC-Milan-v3 - EPYC-Rome - EPYC-Rome-v2 - EPYC-Rome-v3 - EPYC-Rome-v4 - EPYC-Rome-v5 - EPYC-Turin - EPYC-v3 - EPYC-v4 - EPYC-v5 - GraniteRapids - GraniteRapids-v2 - GraniteRapids-v3 - GraniteRapids-v4 - GraniteRapids-v5 - Haswell - Haswell-IBRS - Haswell-noTSX - Haswell-noTSX-IBRS - host - Icelake-Client - Icelake-Client-noTSX - Icelake-Server - Icelake-Server-noTSX - Icelake-Server-v3 - Icelake-Server-v4 - Icelake-Server-v5 - Icelake-Server-v6 - Icelake-Server-v7 - IvyBridge - IvyBridge-IBRS - KnightsMill - kvm32 - kvm64 - max - Nehalem - Nehalem-IBRS - neoverse-n1 - neoverse-n2 - neoverse-v1 - Opteron_G1 - Opteron_G2 - Opteron_G3 - Opteron_G4 - Opteron_G5 - Penryn - pentium - pentium2 - pentium3 - phenom - qemu32 - qemu64 - SandyBridge - SandyBridge-IBRS - SapphireRapids - SapphireRapids-v2 - SapphireRapids-v3 - SapphireRapids-v4 - SapphireRapids-v5 - SapphireRapids-v6 - SierraForest - SierraForest-v2 - SierraForest-v3 - SierraForest-v4 - SierraForest-v5 - Skylake-Client - Skylake-Client-IBRS - Skylake-Client-noTSX-IBRS - Skylake-Client-v4 - Skylake-Server - Skylake-Server-IBRS - Skylake-Server-noTSX-IBRS - Skylake-Server-v4 - Skylake-Server-v5 - Westmere - Westmere-IBRS type: string requestBody: content: application/json: schema: properties: cputype: description: Name for the custom CPU model. The 'custom-' prefix is optional. format: pve-configid type: string flags: description: 'List of additional CPU flags separated by '';''. Use ''+FLAG'' to enable, ''-FLAG'' to disable a flag. There is a special ''nested-virt'' shorthand which controls nested virtualization for the current CPU (''svm'' for AMD and ''vmx'' for Intel). Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: aes, amd-no-ssb, amd-ssbd, hv-evmcs, hv-tlbflush, ibpb, md-clear, nested-virt, pcid, pdpe1gb, spec-ctrl, ssbd, virt-ssbd' type: string guest-phys-bits: description: Number of physical address bits available to the guest. type: integer hidden: description: Do not identify as a KVM virtual machine. Only affects vCPUs with x86-64 architecture. type: boolean hv-vendor-id: description: The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID. type: string level: description: Maximum input value for the basic CPUID leaves the guest can query - that is the vendor (leaf 0), family/model/stepping and feature bits (leaf 1), cache and topology info (leaves 4 and B), and so on. Higher-numbered leaves are hidden. Setting '30' is a common workaround for Hyper-V boot failures on Windows guests running on recent Intel hosts. Only applies when the vCPU architecture is x86_64. type: integer phys-bits: description: The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values. format: pve-phys-bits type: string reported-model: description: CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS. enum: - "486" - a64fx - athlon - Broadwell - Broadwell-IBRS - Broadwell-noTSX - Broadwell-noTSX-IBRS - Cascadelake-Server - Cascadelake-Server-noTSX - Cascadelake-Server-v2 - Cascadelake-Server-v4 - Cascadelake-Server-v5 - ClearwaterForest - ClearwaterForest-v2 - ClearwaterForest-v3 - Conroe - Cooperlake - Cooperlake-v2 - core2duo - coreduo - cortex-a35 - cortex-a53 - cortex-a55 - cortex-a57 - cortex-a710 - cortex-a72 - cortex-a76 - cortex-a78ae - DiamondRapids - EPYC - EPYC-Genoa - EPYC-Genoa-v2 - EPYC-IBPB - EPYC-Milan - EPYC-Milan-v2 - EPYC-Milan-v3 - EPYC-Rome - EPYC-Rome-v2 - EPYC-Rome-v3 - EPYC-Rome-v4 - EPYC-Rome-v5 - EPYC-Turin - EPYC-v3 - EPYC-v4 - EPYC-v5 - GraniteRapids - GraniteRapids-v2 - GraniteRapids-v3 - GraniteRapids-v4 - GraniteRapids-v5 - Haswell - Haswell-IBRS - Haswell-noTSX - Haswell-noTSX-IBRS - host - Icelake-Client - Icelake-Client-noTSX - Icelake-Server - Icelake-Server-noTSX - Icelake-Server-v3 - Icelake-Server-v4 - Icelake-Server-v5 - Icelake-Server-v6 - Icelake-Server-v7 - IvyBridge - IvyBridge-IBRS - KnightsMill - kvm32 - kvm64 - max - Nehalem - Nehalem-IBRS - neoverse-n1 - neoverse-n2 - neoverse-v1 - Opteron_G1 - Opteron_G2 - Opteron_G3 - Opteron_G4 - Opteron_G5 - Penryn - pentium - pentium2 - pentium3 - phenom - qemu32 - qemu64 - SandyBridge - SandyBridge-IBRS - SapphireRapids - SapphireRapids-v2 - SapphireRapids-v3 - SapphireRapids-v4 - SapphireRapids-v5 - SapphireRapids-v6 - SierraForest - SierraForest-v2 - SierraForest-v3 - SierraForest-v4 - SierraForest-v5 - Skylake-Client - Skylake-Client-IBRS - Skylake-Client-noTSX-IBRS - Skylake-Client-v4 - Skylake-Server - Skylake-Server-IBRS - Skylake-Server-noTSX-IBRS - Skylake-Server-v4 - Skylake-Server-v5 - Westmere - Westmere-IBRS type: string required: - reported-model type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add a custom CPU model definition. /cluster/qemu/custom-cpu-models/{cputype}: delete: operationId: delete_cluster_qemu_custom_cpu_models_cputype parameters: - description: The custom model to delete. The 'custom-' prefix is optional. in: path name: cputype required: true schema: description: The custom model to delete. The 'custom-' prefix is optional. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete a custom CPU model definition. get: operationId: get_cluster_qemu_custom_cpu_models_cputype parameters: - description: Name of the CPU model to query. The 'custom-' prefix is optional. in: path name: cputype required: true schema: description: Name of the CPU model to query. The 'custom-' prefix is optional. type: string responses: "200": content: application/json: schema: properties: cputype: description: Emulated CPU type. Can be default or custom name (custom model names must be prefixed with 'custom-'). type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string flags: description: 'List of additional CPU flags separated by '';''. Use ''+FLAG'' to enable, ''-FLAG'' to disable a flag. There is a special ''nested-virt'' shorthand which controls nested virtualization for the current CPU (''svm'' for AMD and ''vmx'' for Intel). Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: aes, amd-no-ssb, amd-ssbd, hv-evmcs, hv-tlbflush, ibpb, md-clear, nested-virt, pcid, pdpe1gb, spec-ctrl, ssbd, virt-ssbd' type: string guest-phys-bits: description: Number of physical address bits available to the guest. type: integer hidden: description: Do not identify as a KVM virtual machine. Only affects vCPUs with x86-64 architecture. type: boolean hv-vendor-id: description: The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID. type: string level: description: Maximum input value for the basic CPUID leaves the guest can query - that is the vendor (leaf 0), family/model/stepping and feature bits (leaf 1), cache and topology info (leaves 4 and B), and so on. Higher-numbered leaves are hidden. Setting '30' is a common workaround for Hyper-V boot failures on Windows guests running on recent Intel hosts. Only applies when the vCPU architecture is x86_64. type: integer phys-bits: description: The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values. format: pve-phys-bits type: string reported-model: description: CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS. enum: - "486" - a64fx - athlon - Broadwell - Broadwell-IBRS - Broadwell-noTSX - Broadwell-noTSX-IBRS - Cascadelake-Server - Cascadelake-Server-noTSX - Cascadelake-Server-v2 - Cascadelake-Server-v4 - Cascadelake-Server-v5 - ClearwaterForest - ClearwaterForest-v2 - ClearwaterForest-v3 - Conroe - Cooperlake - Cooperlake-v2 - core2duo - coreduo - cortex-a35 - cortex-a53 - cortex-a55 - cortex-a57 - cortex-a710 - cortex-a72 - cortex-a76 - cortex-a78ae - DiamondRapids - EPYC - EPYC-Genoa - EPYC-Genoa-v2 - EPYC-IBPB - EPYC-Milan - EPYC-Milan-v2 - EPYC-Milan-v3 - EPYC-Rome - EPYC-Rome-v2 - EPYC-Rome-v3 - EPYC-Rome-v4 - EPYC-Rome-v5 - EPYC-Turin - EPYC-v3 - EPYC-v4 - EPYC-v5 - GraniteRapids - GraniteRapids-v2 - GraniteRapids-v3 - GraniteRapids-v4 - GraniteRapids-v5 - Haswell - Haswell-IBRS - Haswell-noTSX - Haswell-noTSX-IBRS - host - Icelake-Client - Icelake-Client-noTSX - Icelake-Server - Icelake-Server-noTSX - Icelake-Server-v3 - Icelake-Server-v4 - Icelake-Server-v5 - Icelake-Server-v6 - Icelake-Server-v7 - IvyBridge - IvyBridge-IBRS - KnightsMill - kvm32 - kvm64 - max - Nehalem - Nehalem-IBRS - neoverse-n1 - neoverse-n2 - neoverse-v1 - Opteron_G1 - Opteron_G2 - Opteron_G3 - Opteron_G4 - Opteron_G5 - Penryn - pentium - pentium2 - pentium3 - phenom - qemu32 - qemu64 - SandyBridge - SandyBridge-IBRS - SapphireRapids - SapphireRapids-v2 - SapphireRapids-v3 - SapphireRapids-v4 - SapphireRapids-v5 - SapphireRapids-v6 - SierraForest - SierraForest-v2 - SierraForest-v3 - SierraForest-v4 - SierraForest-v5 - Skylake-Client - Skylake-Client-IBRS - Skylake-Client-noTSX-IBRS - Skylake-Client-v4 - Skylake-Server - Skylake-Server-IBRS - Skylake-Server-noTSX-IBRS - Skylake-Server-v4 - Skylake-Server-v5 - Westmere - Westmere-IBRS type: string type: object description: OK summary: Retrieve details about a specific custom CPU model. put: operationId: put_cluster_qemu_custom_cpu_models_cputype parameters: - description: Name for the custom CPU model. The 'custom-' prefix is optional. in: path name: cputype required: true schema: description: Name for the custom CPU model. The 'custom-' prefix is optional. format: pve-configid type: string - description: A list of properties to delete. in: query name: delete required: false schema: description: A list of properties to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: 'List of additional CPU flags separated by '';''. Use ''+FLAG'' to enable, ''-FLAG'' to disable a flag. There is a special ''nested-virt'' shorthand which controls nested virtualization for the current CPU (''svm'' for AMD and ''vmx'' for Intel). Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: aes, amd-no-ssb, amd-ssbd, hv-evmcs, hv-tlbflush, ibpb, md-clear, nested-virt, pcid, pdpe1gb, spec-ctrl, ssbd, virt-ssbd' in: query name: flags required: false schema: description: 'List of additional CPU flags separated by '';''. Use ''+FLAG'' to enable, ''-FLAG'' to disable a flag. There is a special ''nested-virt'' shorthand which controls nested virtualization for the current CPU (''svm'' for AMD and ''vmx'' for Intel). Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: aes, amd-no-ssb, amd-ssbd, hv-evmcs, hv-tlbflush, ibpb, md-clear, nested-virt, pcid, pdpe1gb, spec-ctrl, ssbd, virt-ssbd' type: string - description: Number of physical address bits available to the guest. in: query name: guest-phys-bits required: false schema: description: Number of physical address bits available to the guest. type: integer - description: Do not identify as a KVM virtual machine. Only affects vCPUs with x86-64 architecture. in: query name: hidden required: false schema: description: Do not identify as a KVM virtual machine. Only affects vCPUs with x86-64 architecture. type: boolean - description: The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID. in: query name: hv-vendor-id required: false schema: description: The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID. type: string - description: Maximum input value for the basic CPUID leaves the guest can query - that is the vendor (leaf 0), family/model/stepping and feature bits (leaf 1), cache and topology info (leaves 4 and B), and so on. Higher-numbered leaves are hidden. Setting '30' is a common workaround for Hyper-V boot failures on Windows guests running on recent Intel hosts. Only applies when the vCPU architecture is x86_64. in: query name: level required: false schema: description: Maximum input value for the basic CPUID leaves the guest can query - that is the vendor (leaf 0), family/model/stepping and feature bits (leaf 1), cache and topology info (leaves 4 and B), and so on. Higher-numbered leaves are hidden. Setting '30' is a common workaround for Hyper-V boot failures on Windows guests running on recent Intel hosts. Only applies when the vCPU architecture is x86_64. type: integer - description: The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values. in: query name: phys-bits required: false schema: description: The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values. format: pve-phys-bits type: string - description: CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS. in: query name: reported-model required: false schema: description: CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS. enum: - "486" - a64fx - athlon - Broadwell - Broadwell-IBRS - Broadwell-noTSX - Broadwell-noTSX-IBRS - Cascadelake-Server - Cascadelake-Server-noTSX - Cascadelake-Server-v2 - Cascadelake-Server-v4 - Cascadelake-Server-v5 - ClearwaterForest - ClearwaterForest-v2 - ClearwaterForest-v3 - Conroe - Cooperlake - Cooperlake-v2 - core2duo - coreduo - cortex-a35 - cortex-a53 - cortex-a55 - cortex-a57 - cortex-a710 - cortex-a72 - cortex-a76 - cortex-a78ae - DiamondRapids - EPYC - EPYC-Genoa - EPYC-Genoa-v2 - EPYC-IBPB - EPYC-Milan - EPYC-Milan-v2 - EPYC-Milan-v3 - EPYC-Rome - EPYC-Rome-v2 - EPYC-Rome-v3 - EPYC-Rome-v4 - EPYC-Rome-v5 - EPYC-Turin - EPYC-v3 - EPYC-v4 - EPYC-v5 - GraniteRapids - GraniteRapids-v2 - GraniteRapids-v3 - GraniteRapids-v4 - GraniteRapids-v5 - Haswell - Haswell-IBRS - Haswell-noTSX - Haswell-noTSX-IBRS - host - Icelake-Client - Icelake-Client-noTSX - Icelake-Server - Icelake-Server-noTSX - Icelake-Server-v3 - Icelake-Server-v4 - Icelake-Server-v5 - Icelake-Server-v6 - Icelake-Server-v7 - IvyBridge - IvyBridge-IBRS - KnightsMill - kvm32 - kvm64 - max - Nehalem - Nehalem-IBRS - neoverse-n1 - neoverse-n2 - neoverse-v1 - Opteron_G1 - Opteron_G2 - Opteron_G3 - Opteron_G4 - Opteron_G5 - Penryn - pentium - pentium2 - pentium3 - phenom - qemu32 - qemu64 - SandyBridge - SandyBridge-IBRS - SapphireRapids - SapphireRapids-v2 - SapphireRapids-v3 - SapphireRapids-v4 - SapphireRapids-v5 - SapphireRapids-v6 - SierraForest - SierraForest-v2 - SierraForest-v3 - SierraForest-v4 - SierraForest-v5 - Skylake-Client - Skylake-Client-IBRS - Skylake-Client-noTSX-IBRS - Skylake-Client-v4 - Skylake-Server - Skylake-Server-IBRS - Skylake-Server-noTSX-IBRS - Skylake-Server-v4 - Skylake-Server-v5 - Westmere - Westmere-IBRS type: string requestBody: content: application/json: schema: properties: cputype: description: Name for the custom CPU model. The 'custom-' prefix is optional. format: pve-configid type: string delete: description: A list of properties to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string flags: description: 'List of additional CPU flags separated by '';''. Use ''+FLAG'' to enable, ''-FLAG'' to disable a flag. There is a special ''nested-virt'' shorthand which controls nested virtualization for the current CPU (''svm'' for AMD and ''vmx'' for Intel). Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: aes, amd-no-ssb, amd-ssbd, hv-evmcs, hv-tlbflush, ibpb, md-clear, nested-virt, pcid, pdpe1gb, spec-ctrl, ssbd, virt-ssbd' type: string guest-phys-bits: description: Number of physical address bits available to the guest. type: integer hidden: description: Do not identify as a KVM virtual machine. Only affects vCPUs with x86-64 architecture. type: boolean hv-vendor-id: description: The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID. type: string level: description: Maximum input value for the basic CPUID leaves the guest can query - that is the vendor (leaf 0), family/model/stepping and feature bits (leaf 1), cache and topology info (leaves 4 and B), and so on. Higher-numbered leaves are hidden. Setting '30' is a common workaround for Hyper-V boot failures on Windows guests running on recent Intel hosts. Only applies when the vCPU architecture is x86_64. type: integer phys-bits: description: The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values. format: pve-phys-bits type: string reported-model: description: CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS. enum: - "486" - a64fx - athlon - Broadwell - Broadwell-IBRS - Broadwell-noTSX - Broadwell-noTSX-IBRS - Cascadelake-Server - Cascadelake-Server-noTSX - Cascadelake-Server-v2 - Cascadelake-Server-v4 - Cascadelake-Server-v5 - ClearwaterForest - ClearwaterForest-v2 - ClearwaterForest-v3 - Conroe - Cooperlake - Cooperlake-v2 - core2duo - coreduo - cortex-a35 - cortex-a53 - cortex-a55 - cortex-a57 - cortex-a710 - cortex-a72 - cortex-a76 - cortex-a78ae - DiamondRapids - EPYC - EPYC-Genoa - EPYC-Genoa-v2 - EPYC-IBPB - EPYC-Milan - EPYC-Milan-v2 - EPYC-Milan-v3 - EPYC-Rome - EPYC-Rome-v2 - EPYC-Rome-v3 - EPYC-Rome-v4 - EPYC-Rome-v5 - EPYC-Turin - EPYC-v3 - EPYC-v4 - EPYC-v5 - GraniteRapids - GraniteRapids-v2 - GraniteRapids-v3 - GraniteRapids-v4 - GraniteRapids-v5 - Haswell - Haswell-IBRS - Haswell-noTSX - Haswell-noTSX-IBRS - host - Icelake-Client - Icelake-Client-noTSX - Icelake-Server - Icelake-Server-noTSX - Icelake-Server-v3 - Icelake-Server-v4 - Icelake-Server-v5 - Icelake-Server-v6 - Icelake-Server-v7 - IvyBridge - IvyBridge-IBRS - KnightsMill - kvm32 - kvm64 - max - Nehalem - Nehalem-IBRS - neoverse-n1 - neoverse-n2 - neoverse-v1 - Opteron_G1 - Opteron_G2 - Opteron_G3 - Opteron_G4 - Opteron_G5 - Penryn - pentium - pentium2 - pentium3 - phenom - qemu32 - qemu64 - SandyBridge - SandyBridge-IBRS - SapphireRapids - SapphireRapids-v2 - SapphireRapids-v3 - SapphireRapids-v4 - SapphireRapids-v5 - SapphireRapids-v6 - SierraForest - SierraForest-v2 - SierraForest-v3 - SierraForest-v4 - SierraForest-v5 - Skylake-Client - Skylake-Client-IBRS - Skylake-Client-noTSX-IBRS - Skylake-Client-v4 - Skylake-Server - Skylake-Server-IBRS - Skylake-Server-noTSX-IBRS - Skylake-Server-v4 - Skylake-Server-v5 - Westmere - Westmere-IBRS type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update a custom CPU model definition. /cluster/replication: get: operationId: get_cluster_replication responses: "200": content: application/json: schema: items: properties: comment: description: Description. type: string disable: description: Flag to disable/deactivate the entry. type: boolean guest: description: Guest ID. type: integer id: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string jobnum: description: Unique, sequential ID assigned to each job. type: integer rate: description: Rate limit in mbps (megabytes per second) as floating point number. type: number remove_job: description: Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. enum: - local - full type: string schedule: description: Storage replication schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string source: description: For internal use, to detect if the guest was stolen. format: pve-node type: string target: description: Target node. format: pve-node type: string type: description: Section type. enum: - local type: string type: object type: array description: OK summary: List replication jobs. post: operationId: post_cluster_replication parameters: - description: Description. in: query name: comment required: false schema: description: Description. type: string - description: Flag to disable/deactivate the entry. in: query name: disable required: false schema: description: Flag to disable/deactivate the entry. type: boolean - description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. in: query name: id required: false schema: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string - description: Rate limit in mbps (megabytes per second) as floating point number. in: query name: rate required: false schema: description: Rate limit in mbps (megabytes per second) as floating point number. type: number - description: Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. in: query name: remove_job required: false schema: description: Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. enum: - local - full type: string - description: Storage replication schedule. The format is a subset of `systemd` calendar events. in: query name: schedule required: false schema: description: Storage replication schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string - description: For internal use, to detect if the guest was stolen. in: query name: source required: false schema: description: For internal use, to detect if the guest was stolen. format: pve-node type: string - description: Target node. in: query name: target required: true schema: description: Target node. format: pve-node type: string - description: Section type. in: query name: type required: false schema: description: Section type. enum: - local type: string requestBody: content: application/json: schema: properties: comment: description: Description. type: string disable: description: Flag to disable/deactivate the entry. type: boolean id: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string rate: description: Rate limit in mbps (megabytes per second) as floating point number. type: number remove_job: description: Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. enum: - local - full type: string schedule: description: Storage replication schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string source: description: For internal use, to detect if the guest was stolen. format: pve-node type: string target: description: Target node. format: pve-node type: string type: description: Section type. enum: - local type: string required: - target type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new replication job /cluster/replication/{id}: delete: operationId: delete_cluster_replication_id parameters: - description: Will remove the jobconfig entry, but will not cleanup. in: query name: force required: false schema: description: Will remove the jobconfig entry, but will not cleanup. type: boolean - description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. in: path name: id required: true schema: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string - description: Keep replicated data at target (do not remove). in: query name: keep required: false schema: description: Keep replicated data at target (do not remove). type: boolean responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Mark replication job for removal. get: operationId: get_cluster_replication_id parameters: - description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. in: path name: id required: true schema: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string responses: "200": content: application/json: schema: properties: comment: description: Description. type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Flag to disable/deactivate the entry. type: boolean guest: description: Guest ID. type: integer id: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string jobnum: description: Unique, sequential ID assigned to each job. type: integer rate: description: Rate limit in mbps (megabytes per second) as floating point number. type: number remove_job: description: Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. enum: - local - full type: string schedule: description: Storage replication schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string source: description: For internal use, to detect if the guest was stolen. format: pve-node type: string target: description: Target node. format: pve-node type: string type: description: Section type. enum: - local type: string type: object description: OK summary: Read replication job configuration. put: operationId: put_cluster_replication_id parameters: - description: Description. in: query name: comment required: false schema: description: Description. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Flag to disable/deactivate the entry. in: query name: disable required: false schema: description: Flag to disable/deactivate the entry. type: boolean - description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. in: path name: id required: true schema: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string - description: Rate limit in mbps (megabytes per second) as floating point number. in: query name: rate required: false schema: description: Rate limit in mbps (megabytes per second) as floating point number. type: number - description: Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. in: query name: remove_job required: false schema: description: Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. enum: - local - full type: string - description: Storage replication schedule. The format is a subset of `systemd` calendar events. in: query name: schedule required: false schema: description: Storage replication schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string - description: For internal use, to detect if the guest was stolen. in: query name: source required: false schema: description: For internal use, to detect if the guest was stolen. format: pve-node type: string requestBody: content: application/json: schema: properties: comment: description: Description. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Flag to disable/deactivate the entry. type: boolean id: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string rate: description: Rate limit in mbps (megabytes per second) as floating point number. type: number remove_job: description: Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. enum: - local - full type: string schedule: description: Storage replication schedule. The format is a subset of `systemd` calendar events. format: pve-calendar-event type: string source: description: For internal use, to detect if the guest was stolen. format: pve-node type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update replication job configuration. /cluster/resources: get: operationId: get_cluster_resources parameters: - description: Resource type. in: query name: type required: false schema: description: Resource type. enum: - vm - storage - node - sdn type: string responses: "200": content: application/json: schema: items: properties: cgroup-mode: description: The cgroup mode the node operates under (for type 'node'). type: integer content: description: Allowed storage content types (for type 'storage'). format: pve-storage-content-list type: string cpu: description: CPU utilization (for types 'node', 'qemu' and 'lxc'). type: number disk: description: Used disk space in bytes (for type 'storage'), used root image space for VMs (for types 'qemu' and 'lxc'). type: integer diskread: description: The number of bytes the guest read from its block devices since the guest was started. This info is not available for all storage types. (for types 'qemu' and 'lxc') type: integer diskwrite: description: The number of bytes the guest wrote to its block devices since the guest was started. This info is not available for all storage types. (for types 'qemu' and 'lxc') type: integer hastate: description: HA service status (for HA managed VMs). type: string host-arch: description: The node's CPU architecture. (for type 'node'). enum: - x86_64 - aarch64 type: string id: description: Resource id. type: string level: description: Support level (for type 'node'). type: string lock: description: The guest's current config lock (for types 'qemu' and 'lxc') type: string maxcpu: description: Number of available CPUs (for types 'node', 'qemu' and 'lxc'). type: number maxdisk: description: Storage size in bytes (for type 'storage'), root image size for VMs (for types 'qemu' and 'lxc'). type: integer maxmem: description: Number of available memory in bytes (for types 'node', 'qemu' and 'lxc'). type: integer mem: description: Used memory in bytes (for types 'node', 'qemu' and 'lxc'). type: integer memhost: description: Used memory in bytes from the point of view of the host (for types 'qemu'). type: integer name: description: Name of the resource. type: string netin: description: The amount of traffic in bytes that was sent to the guest over the network since it was started. (for types 'qemu' and 'lxc') type: integer netout: description: The amount of traffic in bytes that was sent from the guest over the network since it was started. (for types 'qemu' and 'lxc') type: integer network: description: The name of a Network entity (for type 'network'). type: string network-type: description: The type of network resource (for type 'network'). enum: - fabric - zone type: string node: description: The cluster node name (for types 'node', 'storage', 'qemu', and 'lxc'). format: pve-node type: string plugintype: description: More specific type, if available. type: string pool: description: The pool name (for types 'pool', 'qemu' and 'lxc'). type: string protocol: description: The protocol of a fabric (for type 'network', network-type 'fabric'). type: string sdn: description: The name of an SDN entity (for type 'sdn') type: string shared: description: Determines whether the storage is shared type: boolean status: description: Resource type dependent status. type: string storage: description: The storage identifier (for type 'storage'). format: pve-storage-id type: string tags: description: The guest's tags (for types 'qemu' and 'lxc') type: string template: description: Determines if the guest is a template. (for types 'qemu' and 'lxc') type: boolean type: description: Resource type. enum: - node - storage - pool - qemu - lxc - openvz - sdn - network type: string uptime: description: Uptime of node or virtual guest in seconds (for types 'node', 'qemu' and 'lxc'). type: integer vmid: description: The numerical vmid (for types 'qemu' and 'lxc'). format: pve-vmid type: integer zone-type: description: The type of an SDN zone (for type 'sdn'). type: string type: object type: array description: OK summary: Resources index (cluster wide). /cluster/sdn: get: operationId: get_cluster_sdn responses: "200": content: application/json: schema: items: properties: id: type: string type: object type: array description: OK summary: Directory index. put: operationId: put_cluster_sdn parameters: - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: When lock-token has been provided and configuration successfully committed, release the lock automatically afterwards in: query name: release-lock required: false schema: description: When lock-token has been provided and configuration successfully committed, release the lock automatically afterwards type: boolean requestBody: content: application/json: schema: properties: lock-token: description: the token for unlocking the global SDN configuration type: string release-lock: description: When lock-token has been provided and configuration successfully committed, release the lock automatically afterwards type: boolean type: object responses: "200": content: application/json: schema: type: string description: OK summary: Apply sdn controller changes && reload. /cluster/sdn/controllers: get: operationId: get_cluster_sdn_controllers parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean - description: Only list sdn controllers of specific type in: query name: type required: false schema: description: Only list sdn controllers of specific type enum: - bgp - evpn - faucet - isis type: string responses: "200": content: application/json: schema: items: properties: asn: description: The local ASN of the controller. BGP & EVPN only. type: integer bgp-mode: description: Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. enum: - auto - external - internal type: string bgp-multipath-as-relax: description: Consider different AS paths of equal length for multipath computation. BGP only. type: boolean controller: description: Name of the controller. type: string digest: description: Digest of the controller section. type: string ebgp: description: Enable eBGP (remote-as external). BGP only. type: boolean ebgp-multihop: description: Set maximum amount of hops for eBGP peers. Needs ebgp set to 1. BGP only. type: integer isis-domain: description: Name of the IS-IS domain. IS-IS only. type: string isis-ifaces: description: Comma-separated list of interfaces where IS-IS should be active. IS-IS only. format: pve-iface-list type: string isis-net: description: Network Entity title for this node in the IS-IS network. IS-IS only. format: pve-sdn-isis-net type: string loopback: description: Name of the loopback/dummy interface that provides the Router-IP. BGP only. type: string node: description: Node(s) where this controller is active. type: string nodes: description: List of cluster node names. format: pve-node-list type: string peer-group-name: description: Name of the peer group for this EVPN controller type: string peers: description: Comma-separated list of the peers IP addresses. type: string pending: description: Changes that have not yet been applied to the running configuration. properties: asn: description: The local ASN of the controller. BGP & EVPN only. type: integer bgp-mode: description: Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. enum: - auto - external - internal type: string bgp-multipath-as-relax: description: Consider different AS paths of equal length for multipath computation. BGP only. type: boolean ebgp: description: Enable eBGP (remote-as external). BGP only. type: boolean ebgp-multihop: description: Set maximum amount of hops for eBGP peers. Needs ebgp set to 1. BGP only. type: integer isis-domain: description: Name of the IS-IS domain. IS-IS only. type: string isis-ifaces: description: Comma-separated list of interfaces where IS-IS should be active. IS-IS only. format: pve-iface-list type: string isis-net: description: Network Entity title for this node in the IS-IS network. IS-IS only. format: pve-sdn-isis-net type: string loopback: description: Name of the loopback/dummy interface that provides the Router-IP. BGP only. type: string node: description: Node(s) where this controller is active. type: string nodes: description: List of cluster node names. format: pve-node-list type: string peer-group-name: description: Name of the peer group for this EVPN controller type: string peers: description: Comma-separated list of the peers IP addresses. type: string type: object state: description: State of the SDN configuration object. enum: - new - changed - deleted type: string type: description: Type of the controller enum: - bgp - evpn - faucet - isis type: string type: object type: array description: OK summary: SDN controllers index. post: operationId: post_cluster_sdn_controllers parameters: - description: autonomous system number in: query name: asn required: false schema: description: autonomous system number type: integer - description: Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. in: query name: bgp-mode required: false schema: description: Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. enum: - auto - external - internal type: string - description: Consider different AS paths of equal length for multipath computation. in: query name: bgp-multipath-as-path-relax required: false schema: description: Consider different AS paths of equal length for multipath computation. type: boolean - description: The SDN controller object identifier. in: query name: controller required: false schema: description: The SDN controller object identifier. type: string - description: Enable eBGP (remote-as external). in: query name: ebgp required: false schema: description: Enable eBGP (remote-as external). type: boolean - description: Set maximum amount of hops for eBGP peers. in: query name: ebgp-multihop required: false schema: description: Set maximum amount of hops for eBGP peers. type: integer - description: SDN fabric to use as underlay for this EVPN controller. in: query name: fabric required: false schema: description: SDN fabric to use as underlay for this EVPN controller. format: pve-sdn-fabric-id type: string - description: Name of the IS-IS domain. in: query name: isis-domain required: false schema: description: Name of the IS-IS domain. type: string - description: Comma-separated list of interfaces where IS-IS should be active. in: query name: isis-ifaces required: false schema: description: Comma-separated list of interfaces where IS-IS should be active. format: pve-iface-list type: string - description: Network Entity title for this node in the IS-IS network. in: query name: isis-net required: false schema: description: Network Entity title for this node in the IS-IS network. format: pve-sdn-isis-net type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: Name of the loopback/dummy interface that provides the Router-IP. in: query name: loopback required: false schema: description: Name of the loopback/dummy interface that provides the Router-IP. type: string - description: The cluster node name. in: query name: node required: false schema: description: The cluster node name. format: pve-node type: string - description: List of cluster node names. in: query name: nodes required: false schema: description: List of cluster node names. format: pve-node-list type: string - description: Name of the peer group for this EVPN controller in: query name: peer-group-name required: false schema: description: Name of the peer group for this EVPN controller format: pve-configid type: string - description: peers address list. in: query name: peers required: false schema: description: peers address list. format: ip-list type: string - description: Route Map that should be applied for incoming routes in: query name: route-map-in required: false schema: description: Route Map that should be applied for incoming routes format: pve-sdn-route-map-id type: string - description: Route Map that should be applied for outgoing routes in: query name: route-map-out required: false schema: description: Route Map that should be applied for outgoing routes format: pve-sdn-route-map-id type: string - description: Plugin type. in: query name: type required: false schema: description: Plugin type. enum: - bgp - evpn - faucet - isis format: pve-configid type: string requestBody: content: application/json: schema: properties: asn: description: autonomous system number type: integer bgp-mode: description: Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. enum: - auto - external - internal type: string bgp-multipath-as-path-relax: description: Consider different AS paths of equal length for multipath computation. type: boolean controller: description: The SDN controller object identifier. type: string ebgp: description: Enable eBGP (remote-as external). type: boolean ebgp-multihop: description: Set maximum amount of hops for eBGP peers. type: integer fabric: description: SDN fabric to use as underlay for this EVPN controller. format: pve-sdn-fabric-id type: string isis-domain: description: Name of the IS-IS domain. type: string isis-ifaces: description: Comma-separated list of interfaces where IS-IS should be active. format: pve-iface-list type: string isis-net: description: Network Entity title for this node in the IS-IS network. format: pve-sdn-isis-net type: string lock-token: description: the token for unlocking the global SDN configuration type: string loopback: description: Name of the loopback/dummy interface that provides the Router-IP. type: string node: description: The cluster node name. format: pve-node type: string nodes: description: List of cluster node names. format: pve-node-list type: string peer-group-name: description: Name of the peer group for this EVPN controller format: pve-configid type: string peers: description: peers address list. format: ip-list type: string route-map-in: description: Route Map that should be applied for incoming routes format: pve-sdn-route-map-id type: string route-map-out: description: Route Map that should be applied for outgoing routes format: pve-sdn-route-map-id type: string type: description: Plugin type. enum: - bgp - evpn - faucet - isis format: pve-configid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new sdn controller object. /cluster/sdn/controllers/{controller}: delete: operationId: delete_cluster_sdn_controllers_controller parameters: - description: The SDN controller object identifier. in: path name: controller required: true schema: description: The SDN controller object identifier. type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete sdn controller object configuration. get: operationId: get_cluster_sdn_controllers_controller parameters: - description: The SDN controller object identifier. in: path name: controller required: true schema: description: The SDN controller object identifier. type: string - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean responses: "200": content: application/json: schema: properties: asn: description: The local ASN of the controller. BGP & EVPN only. type: integer bgp-mode: description: Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. enum: - auto - external - internal type: string bgp-multipath-as-relax: description: Consider different AS paths of equal length for multipath computation. BGP only. type: boolean controller: description: Name of the controller. type: string digest: description: Digest of the controller section. type: string ebgp: description: Enable eBGP (remote-as external). BGP only. type: boolean ebgp-multihop: description: Set maximum amount of hops for eBGP peers. Needs ebgp set to 1. BGP only. type: integer isis-domain: description: Name of the IS-IS domain. IS-IS only. type: string isis-ifaces: description: Comma-separated list of interfaces where IS-IS should be active. IS-IS only. format: pve-iface-list type: string isis-net: description: Network Entity title for this node in the IS-IS network. IS-IS only. format: pve-sdn-isis-net type: string loopback: description: Name of the loopback/dummy interface that provides the Router-IP. BGP only. type: string node: description: Node(s) where this controller is active. type: string nodes: description: List of cluster node names. format: pve-node-list type: string peer-group-name: description: Name of the peer group for this EVPN controller type: string peers: description: Comma-separated list of the peers IP addresses. type: string pending: description: Changes that have not yet been applied to the running configuration. properties: asn: description: The local ASN of the controller. BGP & EVPN only. type: integer bgp-mode: description: Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. enum: - auto - external - internal type: string bgp-multipath-as-relax: description: Consider different AS paths of equal length for multipath computation. BGP only. type: boolean ebgp: description: Enable eBGP (remote-as external). BGP only. type: boolean ebgp-multihop: description: Set maximum amount of hops for eBGP peers. Needs ebgp set to 1. BGP only. type: integer isis-domain: description: Name of the IS-IS domain. IS-IS only. type: string isis-ifaces: description: Comma-separated list of interfaces where IS-IS should be active. IS-IS only. format: pve-iface-list type: string isis-net: description: Network Entity title for this node in the IS-IS network. IS-IS only. format: pve-sdn-isis-net type: string loopback: description: Name of the loopback/dummy interface that provides the Router-IP. BGP only. type: string node: description: Node(s) where this controller is active. type: string nodes: description: List of cluster node names. format: pve-node-list type: string peer-group-name: description: Name of the peer group for this EVPN controller type: string peers: description: Comma-separated list of the peers IP addresses. type: string type: object state: description: State of the SDN configuration object. enum: - new - changed - deleted type: string type: description: Type of the controller enum: - bgp - evpn - faucet - isis type: string type: object description: OK summary: Read sdn controller configuration. put: operationId: put_cluster_sdn_controllers_controller parameters: - description: autonomous system number in: query name: asn required: false schema: description: autonomous system number type: integer - description: Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. in: query name: bgp-mode required: false schema: description: Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. enum: - auto - external - internal type: string - description: Consider different AS paths of equal length for multipath computation. in: query name: bgp-multipath-as-path-relax required: false schema: description: Consider different AS paths of equal length for multipath computation. type: boolean - description: The SDN controller object identifier. in: path name: controller required: true schema: description: The SDN controller object identifier. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Enable eBGP (remote-as external). in: query name: ebgp required: false schema: description: Enable eBGP (remote-as external). type: boolean - description: Set maximum amount of hops for eBGP peers. in: query name: ebgp-multihop required: false schema: description: Set maximum amount of hops for eBGP peers. type: integer - description: SDN fabric to use as underlay for this EVPN controller. in: query name: fabric required: false schema: description: SDN fabric to use as underlay for this EVPN controller. format: pve-sdn-fabric-id type: string - description: Name of the IS-IS domain. in: query name: isis-domain required: false schema: description: Name of the IS-IS domain. type: string - description: Comma-separated list of interfaces where IS-IS should be active. in: query name: isis-ifaces required: false schema: description: Comma-separated list of interfaces where IS-IS should be active. format: pve-iface-list type: string - description: Network Entity title for this node in the IS-IS network. in: query name: isis-net required: false schema: description: Network Entity title for this node in the IS-IS network. format: pve-sdn-isis-net type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: Name of the loopback/dummy interface that provides the Router-IP. in: query name: loopback required: false schema: description: Name of the loopback/dummy interface that provides the Router-IP. type: string - description: The cluster node name. in: query name: node required: false schema: description: The cluster node name. format: pve-node type: string - description: List of cluster node names. in: query name: nodes required: false schema: description: List of cluster node names. format: pve-node-list type: string - description: Name of the peer group for this EVPN controller in: query name: peer-group-name required: false schema: description: Name of the peer group for this EVPN controller format: pve-configid type: string - description: peers address list. in: query name: peers required: false schema: description: peers address list. format: ip-list type: string - description: Route Map that should be applied for incoming routes in: query name: route-map-in required: false schema: description: Route Map that should be applied for incoming routes format: pve-sdn-route-map-id type: string - description: Route Map that should be applied for outgoing routes in: query name: route-map-out required: false schema: description: Route Map that should be applied for outgoing routes format: pve-sdn-route-map-id type: string requestBody: content: application/json: schema: properties: asn: description: autonomous system number type: integer bgp-mode: description: Whether to use eBGP or iBGP. Auto mode chooses depending on BGP controller or falls back to iBGP. enum: - auto - external - internal type: string bgp-multipath-as-path-relax: description: Consider different AS paths of equal length for multipath computation. type: boolean controller: description: The SDN controller object identifier. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string ebgp: description: Enable eBGP (remote-as external). type: boolean ebgp-multihop: description: Set maximum amount of hops for eBGP peers. type: integer fabric: description: SDN fabric to use as underlay for this EVPN controller. format: pve-sdn-fabric-id type: string isis-domain: description: Name of the IS-IS domain. type: string isis-ifaces: description: Comma-separated list of interfaces where IS-IS should be active. format: pve-iface-list type: string isis-net: description: Network Entity title for this node in the IS-IS network. format: pve-sdn-isis-net type: string lock-token: description: the token for unlocking the global SDN configuration type: string loopback: description: Name of the loopback/dummy interface that provides the Router-IP. type: string node: description: The cluster node name. format: pve-node type: string nodes: description: List of cluster node names. format: pve-node-list type: string peer-group-name: description: Name of the peer group for this EVPN controller format: pve-configid type: string peers: description: peers address list. format: ip-list type: string route-map-in: description: Route Map that should be applied for incoming routes format: pve-sdn-route-map-id type: string route-map-out: description: Route Map that should be applied for outgoing routes format: pve-sdn-route-map-id type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update sdn controller object configuration. /cluster/sdn/dns: get: operationId: get_cluster_sdn_dns parameters: - description: Only list sdn dns of specific type in: query name: type required: false schema: description: Only list sdn dns of specific type enum: - powerdns type: string responses: "200": content: application/json: schema: items: properties: dns: type: string type: type: string type: object type: array description: OK summary: SDN dns index. post: operationId: post_cluster_sdn_dns parameters: - description: The SDN dns object identifier. in: query name: dns required: false schema: description: The SDN dns object identifier. type: string - description: Certificate SHA 256 fingerprint. in: query name: fingerprint required: false schema: description: Certificate SHA 256 fingerprint. type: string - description: "" in: query name: key required: true schema: type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: "" in: query name: reversemaskv6 required: false schema: type: integer - description: "" in: query name: reversev6mask required: false schema: type: integer - description: "" in: query name: ttl required: false schema: type: integer - description: Plugin type. in: query name: type required: false schema: description: Plugin type. enum: - powerdns format: pve-configid type: string - description: "" in: query name: url required: true schema: type: string requestBody: content: application/json: schema: properties: dns: description: The SDN dns object identifier. type: string fingerprint: description: Certificate SHA 256 fingerprint. type: string key: type: string lock-token: description: the token for unlocking the global SDN configuration type: string reversemaskv6: type: integer reversev6mask: type: integer ttl: type: integer type: description: Plugin type. enum: - powerdns format: pve-configid type: string url: type: string required: - url - key type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new sdn dns object. /cluster/sdn/dns/{dns}: delete: operationId: delete_cluster_sdn_dns_dns parameters: - description: The SDN dns object identifier. in: path name: dns required: true schema: description: The SDN dns object identifier. type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete sdn dns object configuration. get: operationId: get_cluster_sdn_dns_dns parameters: - description: The SDN dns object identifier. in: path name: dns required: true schema: description: The SDN dns object identifier. type: string responses: "200": content: application/json: schema: type: object description: OK summary: Read sdn dns configuration. put: operationId: put_cluster_sdn_dns_dns parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The SDN dns object identifier. in: path name: dns required: true schema: description: The SDN dns object identifier. type: string - description: Certificate SHA 256 fingerprint. in: query name: fingerprint required: false schema: description: Certificate SHA 256 fingerprint. type: string - description: "" in: query name: key required: false schema: type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: "" in: query name: reversemaskv6 required: false schema: type: integer - description: "" in: query name: ttl required: false schema: type: integer - description: "" in: query name: url required: false schema: type: string requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dns: description: The SDN dns object identifier. type: string fingerprint: description: Certificate SHA 256 fingerprint. type: string key: type: string lock-token: description: the token for unlocking the global SDN configuration type: string reversemaskv6: type: integer ttl: type: integer url: type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update sdn dns object configuration. /cluster/sdn/dry-run: get: operationId: get_cluster_sdn_dry_run parameters: - description: The cluster node name. in: query name: node required: false schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: frr-diff: description: The difference between the current and pending FRR configuration. type: string interfaces-diff: description: The difference between the current and pending /etc/network/interfaces.d/sdn configuration. type: string type: object description: OK summary: Dry-run the SDN apply action and return the difference between the current configuration and the pending configuration /cluster/sdn/fabrics: get: operationId: get_cluster_sdn_fabrics responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: SDN Fabrics Index /cluster/sdn/fabrics/all: get: operationId: get_cluster_sdn_fabrics_all parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean responses: "200": content: application/json: schema: properties: fabrics: items: properties: area: description: OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. type: string csnp_interval: description: The csnp_interval property for Openfabric type: number digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string hello_interval: description: The hello_interval property for Openfabric type: number id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string ip_prefix: description: The IP prefix for Node IPs format: CIDR type: string ip6_prefix: description: The IP prefix for Node IPs format: CIDR type: string lock-token: description: the token for unlocking the global SDN configuration type: string persistent_keepalive: description: A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from another node, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. If unset or set to 0, it is turned off type: number protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string redistribute: type: array route_filter: description: A prefix list that should be used for filtering routes that are to be installed into the kernel routing table format: pve-sdn-prefix-list-id type: string type: object type: array nodes: items: properties: allowed_ips: description: A list of IPs that are routable via this node in the WireGuard fabric. items: format: FullRangeCIDR type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string endpoint: description: The endpoint used for connecting to this node. type: string fabric_id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string interfaces: type: array ip: description: IPv4 address for this node format: ipv4 type: string ip6: description: IPv6 address for this node format: ipv6 type: string lock-token: description: the token for unlocking the global SDN configuration type: string node_id: description: Identifier for nodes in an SDN fabric format: pve-node type: string peers: items: type: string type: array protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string public_key: description: The public key for the external node. type: string role: description: The role of this node in the WireGuard fabric. enum: - internal - external type: string type: object type: array type: object description: OK summary: SDN Fabrics Index /cluster/sdn/fabrics/fabric: get: operationId: get_cluster_sdn_fabrics_fabric parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean responses: "200": content: application/json: schema: items: properties: area: description: OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. type: string csnp_interval: description: The csnp_interval property for Openfabric type: number digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string hello_interval: description: The hello_interval property for Openfabric type: number id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string ip_prefix: description: The IP prefix for Node IPs format: CIDR type: string ip6_prefix: description: The IP prefix for Node IPs format: CIDR type: string lock-token: description: the token for unlocking the global SDN configuration type: string persistent_keepalive: description: A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from another node, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. If unset or set to 0, it is turned off type: number protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string redistribute: type: array route_filter: description: A prefix list that should be used for filtering routes that are to be installed into the kernel routing table format: pve-sdn-prefix-list-id type: string type: object type: array description: OK summary: SDN Fabrics Index post: operationId: post_cluster_sdn_fabrics_fabric parameters: - description: OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. in: query name: area required: false schema: description: OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. type: string - description: The csnp_interval property for Openfabric in: query name: csnp_interval required: false schema: description: The csnp_interval property for Openfabric type: number - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The hello_interval property for Openfabric in: query name: hello_interval required: false schema: description: The hello_interval property for Openfabric type: number - description: Identifier for SDN fabrics in: query name: id required: false schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: The IP prefix for Node IPs in: query name: ip6_prefix required: false schema: description: The IP prefix for Node IPs format: CIDR type: string - description: The IP prefix for Node IPs in: query name: ip_prefix required: false schema: description: The IP prefix for Node IPs format: CIDR type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from another node, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. If unset or set to 0, it is turned off in: query name: persistent_keepalive required: false schema: description: A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from another node, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. If unset or set to 0, it is turned off type: number - description: Type of configuration entry in an SDN Fabric section config in: query name: protocol required: false schema: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string - description: "" in: query name: redistribute required: false schema: type: array - description: A prefix list that should be used for filtering routes that are to be installed into the kernel routing table in: query name: route_filter required: false schema: description: A prefix list that should be used for filtering routes that are to be installed into the kernel routing table format: pve-sdn-prefix-list-id type: string requestBody: content: application/json: schema: properties: area: description: OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. type: string csnp_interval: description: The csnp_interval property for Openfabric type: number digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string hello_interval: description: The hello_interval property for Openfabric type: number id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string ip_prefix: description: The IP prefix for Node IPs format: CIDR type: string ip6_prefix: description: The IP prefix for Node IPs format: CIDR type: string lock-token: description: the token for unlocking the global SDN configuration type: string persistent_keepalive: description: A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from another node, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. If unset or set to 0, it is turned off type: number protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string redistribute: type: array route_filter: description: A prefix list that should be used for filtering routes that are to be installed into the kernel routing table format: pve-sdn-prefix-list-id type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add a fabric /cluster/sdn/fabrics/fabric/{id}: delete: operationId: delete_cluster_sdn_fabrics_fabric_id parameters: - description: Identifier for SDN fabrics in: path name: id required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add a fabric get: operationId: get_cluster_sdn_fabrics_fabric_id parameters: - description: Identifier for SDN fabrics in: path name: id required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string responses: "200": content: application/json: schema: properties: area: description: OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. type: string csnp_interval: description: The csnp_interval property for Openfabric type: number digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string hello_interval: description: The hello_interval property for Openfabric type: number id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string ip_prefix: description: The IP prefix for Node IPs format: CIDR type: string ip6_prefix: description: The IP prefix for Node IPs format: CIDR type: string lock-token: description: the token for unlocking the global SDN configuration type: string persistent_keepalive: description: A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from another node, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. If unset or set to 0, it is turned off type: number protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string redistribute: type: array route_filter: description: A prefix list that should be used for filtering routes that are to be installed into the kernel routing table format: pve-sdn-prefix-list-id type: string type: object description: OK summary: Update a fabric put: operationId: put_cluster_sdn_fabrics_fabric_id parameters: - description: OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. in: query name: area required: false schema: description: OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. type: string - description: The csnp_interval property for Openfabric in: query name: csnp_interval required: false schema: description: The csnp_interval property for Openfabric type: number - description: "" in: query name: delete required: false schema: type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The hello_interval property for Openfabric in: query name: hello_interval required: false schema: description: The hello_interval property for Openfabric type: number - description: Identifier for SDN fabrics in: path name: id required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: The IP prefix for Node IPs in: query name: ip6_prefix required: false schema: description: The IP prefix for Node IPs format: CIDR type: string - description: The IP prefix for Node IPs in: query name: ip_prefix required: false schema: description: The IP prefix for Node IPs format: CIDR type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from another node, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. If unset or set to 0, it is turned off in: query name: persistent_keepalive required: false schema: description: A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from another node, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. If unset or set to 0, it is turned off type: number - description: Type of configuration entry in an SDN Fabric section config in: query name: protocol required: false schema: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string - description: "" in: query name: redistribute required: false schema: type: array - description: A prefix list that should be used for filtering routes that are to be installed into the kernel routing table in: query name: route_filter required: false schema: description: A prefix list that should be used for filtering routes that are to be installed into the kernel routing table format: pve-sdn-prefix-list-id type: string requestBody: content: application/json: schema: properties: area: description: OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. type: string csnp_interval: description: The csnp_interval property for Openfabric type: number delete: type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string hello_interval: description: The hello_interval property for Openfabric type: number id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string ip_prefix: description: The IP prefix for Node IPs format: CIDR type: string ip6_prefix: description: The IP prefix for Node IPs format: CIDR type: string lock-token: description: the token for unlocking the global SDN configuration type: string persistent_keepalive: description: A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from another node, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. If unset or set to 0, it is turned off type: number protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string redistribute: type: array route_filter: description: A prefix list that should be used for filtering routes that are to be installed into the kernel routing table format: pve-sdn-prefix-list-id type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update a fabric /cluster/sdn/fabrics/node: get: operationId: get_cluster_sdn_fabrics_node parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean responses: "200": content: application/json: schema: items: properties: allowed_ips: description: A list of IPs that are routable via this node in the WireGuard fabric. items: format: FullRangeCIDR type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string endpoint: description: The endpoint used for connecting to this node. type: string fabric_id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string interfaces: type: array ip: description: IPv4 address for this node format: ipv4 type: string ip6: description: IPv6 address for this node format: ipv6 type: string lock-token: description: the token for unlocking the global SDN configuration type: string node_id: description: Identifier for nodes in an SDN fabric format: pve-node type: string peers: items: type: string type: array protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string public_key: description: The public key for the external node. type: string role: description: The role of this node in the WireGuard fabric. enum: - internal - external type: string type: object type: array description: OK summary: SDN Fabrics Index /cluster/sdn/fabrics/node/{fabric_id}: get: operationId: get_cluster_sdn_fabrics_node_fabric_id parameters: - description: Identifier for SDN fabrics in: path name: fabric_id required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean responses: "200": content: application/json: schema: items: properties: allowed_ips: description: A list of IPs that are routable via this node in the WireGuard fabric. items: format: FullRangeCIDR type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string endpoint: description: The endpoint used for connecting to this node. type: string fabric_id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string interfaces: type: array ip: description: IPv4 address for this node format: ipv4 type: string ip6: description: IPv6 address for this node format: ipv6 type: string lock-token: description: the token for unlocking the global SDN configuration type: string node_id: description: Identifier for nodes in an SDN fabric format: pve-node type: string peers: items: type: string type: array protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string public_key: description: The public key for the external node. type: string role: description: The role of this node in the WireGuard fabric. enum: - internal - external type: string type: object type: array description: OK summary: SDN Fabrics Index post: operationId: post_cluster_sdn_fabrics_node_fabric_id parameters: - description: A list of IPs that are routable via this node in the WireGuard fabric. in: query name: allowed_ips required: false schema: description: A list of IPs that are routable via this node in the WireGuard fabric. items: format: FullRangeCIDR type: string type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The endpoint used for connecting to this node. in: query name: endpoint required: false schema: description: The endpoint used for connecting to this node. type: string - description: Identifier for SDN fabrics in: path name: fabric_id required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: "" in: query name: interfaces required: false schema: type: array - description: IPv4 address for this node in: query name: ip required: false schema: description: IPv4 address for this node format: ipv4 type: string - description: IPv6 address for this node in: query name: ip6 required: false schema: description: IPv6 address for this node format: ipv6 type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: Identifier for nodes in an SDN fabric in: query name: node_id required: false schema: description: Identifier for nodes in an SDN fabric format: pve-node type: string - description: "" in: query name: peers required: false schema: items: type: string type: array - description: Type of configuration entry in an SDN Fabric section config in: query name: protocol required: false schema: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string - description: The public key for the external node. in: query name: public_key required: false schema: description: The public key for the external node. type: string - description: The role of this node in the WireGuard fabric. in: query name: role required: false schema: description: The role of this node in the WireGuard fabric. enum: - internal - external type: string requestBody: content: application/json: schema: properties: allowed_ips: description: A list of IPs that are routable via this node in the WireGuard fabric. items: format: FullRangeCIDR type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string endpoint: description: The endpoint used for connecting to this node. type: string fabric_id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string interfaces: type: array ip: description: IPv4 address for this node format: ipv4 type: string ip6: description: IPv6 address for this node format: ipv6 type: string lock-token: description: the token for unlocking the global SDN configuration type: string node_id: description: Identifier for nodes in an SDN fabric format: pve-node type: string peers: items: type: string type: array protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string public_key: description: The public key for the external node. type: string role: description: The role of this node in the WireGuard fabric. enum: - internal - external type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add a node /cluster/sdn/fabrics/node/{fabric_id}/{node_id}: delete: operationId: delete_cluster_sdn_fabrics_node_fabric_id_node_id parameters: - description: Identifier for SDN fabrics in: path name: fabric_id required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: Identifier for nodes in an SDN fabric in: path name: node_id required: true schema: description: Identifier for nodes in an SDN fabric format: pve-node type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add a node get: operationId: get_cluster_sdn_fabrics_node_fabric_id_node_id parameters: - description: Identifier for SDN fabrics in: path name: fabric_id required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: Identifier for nodes in an SDN fabric in: path name: node_id required: true schema: description: Identifier for nodes in an SDN fabric format: pve-node type: string responses: "200": content: application/json: schema: properties: allowed_ips: description: A list of IPs that are routable via this node in the WireGuard fabric. items: format: FullRangeCIDR type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string endpoint: description: The endpoint used for connecting to this node. type: string fabric_id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string interfaces: type: array ip: description: IPv4 address for this node format: ipv4 type: string ip6: description: IPv6 address for this node format: ipv6 type: string lock-token: description: the token for unlocking the global SDN configuration type: string node_id: description: Identifier for nodes in an SDN fabric format: pve-node type: string peers: items: type: string type: array protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string public_key: description: The public key for the external node. type: string role: description: The role of this node in the WireGuard fabric. enum: - internal - external type: string type: object description: OK summary: Get a node put: operationId: put_cluster_sdn_fabrics_node_fabric_id_node_id parameters: - description: A list of IPs that are routable via this node in the WireGuard fabric. in: query name: allowed_ips required: false schema: description: A list of IPs that are routable via this node in the WireGuard fabric. items: format: FullRangeCIDR type: string type: array - description: "" in: query name: delete required: false schema: type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The endpoint used for connecting to this node. in: query name: endpoint required: false schema: description: The endpoint used for connecting to this node. type: string - description: Identifier for SDN fabrics in: path name: fabric_id required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: "" in: query name: interfaces required: false schema: type: array - description: IPv4 address for this node in: query name: ip required: false schema: description: IPv4 address for this node format: ipv4 type: string - description: IPv6 address for this node in: query name: ip6 required: false schema: description: IPv6 address for this node format: ipv6 type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: Identifier for nodes in an SDN fabric in: path name: node_id required: true schema: description: Identifier for nodes in an SDN fabric format: pve-node type: string - description: "" in: query name: peers required: false schema: items: type: string type: array - description: Type of configuration entry in an SDN Fabric section config in: query name: protocol required: false schema: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string - description: The public key for the external node. in: query name: public_key required: false schema: description: The public key for the external node. type: string - description: The role of this node in the WireGuard fabric. in: query name: role required: false schema: description: The role of this node in the WireGuard fabric. enum: - internal - external type: string requestBody: content: application/json: schema: properties: allowed_ips: description: A list of IPs that are routable via this node in the WireGuard fabric. items: format: FullRangeCIDR type: string type: array delete: type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string endpoint: description: The endpoint used for connecting to this node. type: string fabric_id: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string interfaces: type: array ip: description: IPv4 address for this node format: ipv4 type: string ip6: description: IPv6 address for this node format: ipv6 type: string lock-token: description: the token for unlocking the global SDN configuration type: string node_id: description: Identifier for nodes in an SDN fabric format: pve-node type: string peers: items: type: string type: array protocol: description: Type of configuration entry in an SDN Fabric section config enum: - openfabric - ospf - wireguard - bgp type: string public_key: description: The public key for the external node. type: string role: description: The role of this node in the WireGuard fabric. enum: - internal - external type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update a node /cluster/sdn/ipams: get: operationId: get_cluster_sdn_ipams parameters: - description: Only list sdn ipams of specific type in: query name: type required: false schema: description: Only list sdn ipams of specific type enum: - netbox - phpipam - pve type: string responses: "200": content: application/json: schema: items: properties: ipam: type: string type: type: string type: object type: array description: OK summary: SDN ipams index. post: operationId: post_cluster_sdn_ipams parameters: - description: Certificate SHA 256 fingerprint. in: query name: fingerprint required: false schema: description: Certificate SHA 256 fingerprint. type: string - description: The SDN ipam object identifier. in: query name: ipam required: false schema: description: The SDN ipam object identifier. type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: "" in: query name: section required: false schema: type: integer - description: "" in: query name: token required: false schema: type: string - description: Plugin type. in: query name: type required: false schema: description: Plugin type. enum: - netbox - phpipam - pve format: pve-configid type: string - description: "" in: query name: url required: false schema: type: string requestBody: content: application/json: schema: properties: fingerprint: description: Certificate SHA 256 fingerprint. type: string ipam: description: The SDN ipam object identifier. type: string lock-token: description: the token for unlocking the global SDN configuration type: string section: type: integer token: type: string type: description: Plugin type. enum: - netbox - phpipam - pve format: pve-configid type: string url: type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new sdn ipam object. /cluster/sdn/ipams/{ipam}: delete: operationId: delete_cluster_sdn_ipams_ipam parameters: - description: The SDN ipam object identifier. in: path name: ipam required: true schema: description: The SDN ipam object identifier. type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete sdn ipam object configuration. get: operationId: get_cluster_sdn_ipams_ipam parameters: - description: The SDN ipam object identifier. in: path name: ipam required: true schema: description: The SDN ipam object identifier. type: string responses: "200": content: application/json: schema: type: object description: OK summary: Read sdn ipam configuration. put: operationId: put_cluster_sdn_ipams_ipam parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Certificate SHA 256 fingerprint. in: query name: fingerprint required: false schema: description: Certificate SHA 256 fingerprint. type: string - description: The SDN ipam object identifier. in: path name: ipam required: true schema: description: The SDN ipam object identifier. type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: "" in: query name: section required: false schema: type: integer - description: "" in: query name: token required: false schema: type: string - description: "" in: query name: url required: false schema: type: string requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string fingerprint: description: Certificate SHA 256 fingerprint. type: string ipam: description: The SDN ipam object identifier. type: string lock-token: description: the token for unlocking the global SDN configuration type: string section: type: integer token: type: string url: type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update sdn ipam object configuration. /cluster/sdn/ipams/{ipam}/status: get: operationId: get_cluster_sdn_ipams_ipam_status parameters: - description: The SDN ipam object identifier. in: path name: ipam required: true schema: description: The SDN ipam object identifier. type: string responses: "200": content: application/json: schema: type: array description: OK summary: List PVE IPAM Entries /cluster/sdn/lock: delete: operationId: delete_cluster_sdn_lock parameters: - description: if true, allow releasing lock without providing the token in: query name: force required: false schema: description: if true, allow releasing lock without providing the token type: boolean - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Release global lock for SDN configuration post: operationId: post_cluster_sdn_lock parameters: - description: if true, allow acquiring lock even though there are pending changes in: query name: allow-pending required: false schema: description: if true, allow acquiring lock even though there are pending changes type: boolean requestBody: content: application/json: schema: properties: allow-pending: description: if true, allow acquiring lock even though there are pending changes type: boolean type: object responses: "200": content: application/json: schema: type: string description: OK summary: Acquire global lock for SDN configuration /cluster/sdn/prefix-lists: get: operationId: get_cluster_sdn_prefix_lists parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean - description: If 0, only returns id - otherwise returns all properties. in: query name: verbose required: false schema: description: If 0, only returns id - otherwise returns all properties. type: boolean responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: List Prefix Lists post: operationId: post_cluster_sdn_prefix_lists parameters: - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: "" in: query name: entries required: false schema: items: type: string type: array - description: The SDN prefix list identifier in: query name: id required: false schema: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string requestBody: content: application/json: schema: properties: digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string entries: items: type: string type: array id: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string lock-token: description: the token for unlocking the global SDN configuration type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create Prefix List /cluster/sdn/prefix-lists/{id}: delete: operationId: delete_cluster_sdn_prefix_lists_id parameters: - description: The SDN prefix list identifier in: path name: id required: true schema: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete Prefix List get: operationId: get_cluster_sdn_prefix_lists_id parameters: - description: The SDN prefix list identifier in: path name: id required: true schema: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string responses: "200": content: application/json: schema: type: object description: OK summary: Get Prefix List put: operationId: put_cluster_sdn_prefix_lists_id parameters: - description: "" in: query name: delete required: false schema: items: enum: - entries type: string type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: "" in: query name: entries required: false schema: items: type: string type: array - description: The SDN prefix list identifier in: path name: id required: true schema: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string requestBody: content: application/json: schema: properties: delete: items: enum: - entries type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string entries: items: type: string type: array id: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string lock-token: description: the token for unlocking the global SDN configuration type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update Prefix List /cluster/sdn/prefix-lists/{id}/entries: get: operationId: get_cluster_sdn_prefix_lists_id_entries parameters: - description: The SDN prefix list identifier in: path name: id required: true schema: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: List Prefix List Entries post: operationId: post_cluster_sdn_prefix_lists_id_entries parameters: - description: "" in: query name: action required: true schema: enum: - permit - deny type: string - description: "" in: query name: ge required: false schema: type: integer - description: The SDN prefix list identifier in: path name: id required: true schema: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string - description: "" in: query name: le required: false schema: type: integer - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: "" in: query name: prefix required: true schema: format: FullRangeCIDR type: string - description: "" in: query name: seq required: false schema: type: integer requestBody: content: application/json: schema: properties: action: enum: - permit - deny type: string ge: type: integer id: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string le: type: integer lock-token: description: the token for unlocking the global SDN configuration type: string prefix: format: FullRangeCIDR type: string seq: type: integer required: - prefix - action type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create Prefix List Entry /cluster/sdn/prefix-lists/{id}/entries/{url_seq}: delete: operationId: delete_cluster_sdn_prefix_lists_id_entries_url_seq parameters: - description: The SDN prefix list identifier in: path name: id required: true schema: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete Prefix List Entry get: operationId: get_cluster_sdn_prefix_lists_id_entries_url_seq parameters: - description: The SDN prefix list identifier in: path name: id required: true schema: description: The SDN prefix list identifier format: pve-sdn-prefix-list-id type: string responses: "200": content: application/json: schema: type: object description: OK summary: Get Prefix List Entry put: operationId: put_cluster_sdn_prefix_lists_id_entries_url_seq parameters: - description: "" in: query name: action required: false schema: enum: - permit - deny type: string - description: "" in: query name: delete required: false schema: items: enum: - le - ge - seq type: string type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: "" in: query name: ge required: false schema: type: integer - description: "" in: query name: le required: false schema: type: integer - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: "" in: query name: prefix required: false schema: format: FullRangeCIDR type: string - description: "" in: query name: seq required: false schema: type: integer requestBody: content: application/json: schema: properties: action: enum: - permit - deny type: string delete: items: enum: - le - ge - seq type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string ge: type: integer le: type: integer lock-token: description: the token for unlocking the global SDN configuration type: string prefix: format: FullRangeCIDR type: string seq: type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update Prefix List Entry /cluster/sdn/rollback: post: operationId: post_cluster_sdn_rollback parameters: - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: When lock-token has been provided and configuration successfully rollbacked, release the lock automatically afterwards in: query name: release-lock required: false schema: description: When lock-token has been provided and configuration successfully rollbacked, release the lock automatically afterwards type: boolean requestBody: content: application/json: schema: properties: lock-token: description: the token for unlocking the global SDN configuration type: string release-lock: description: When lock-token has been provided and configuration successfully rollbacked, release the lock automatically afterwards type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Rollback pending changes to SDN configuration /cluster/sdn/route-maps: get: operationId: get_cluster_sdn_route_maps parameters: - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean responses: "200": content: application/json: schema: items: properties: id: description: The SDN route map identifier format: pve-sdn-route-map-id type: string type: object type: array description: OK summary: List Route Maps /cluster/sdn/route-maps/entries: get: operationId: get_cluster_sdn_route_maps_entries parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean responses: "200": content: application/json: schema: items: properties: action: description: Matching policy of a route map entry. enum: - permit - deny type: string call: description: The SDN route map identifier format: pve-sdn-route-map-id type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string exit-action: type: string match: items: type: string type: array order: description: The index of this route map entry type: integer route-map-id: description: The SDN route map identifier format: pve-sdn-route-map-id type: string set: items: type: string type: array type: object type: array description: OK summary: Lists all route map entries. post: operationId: post_cluster_sdn_route_maps_entries parameters: - description: Matching policy of a route map entry. in: query name: action required: true schema: description: Matching policy of a route map entry. enum: - permit - deny type: string - description: The SDN route map identifier in: query name: call required: false schema: description: The SDN route map identifier format: pve-sdn-route-map-id type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: "" in: query name: exit-action required: false schema: type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: "" in: query name: match required: false schema: items: type: string type: array - description: The index of this route map entry in: query name: order required: false schema: description: The index of this route map entry type: integer - description: The SDN route map identifier in: query name: route-map-id required: false schema: description: The SDN route map identifier format: pve-sdn-route-map-id type: string - description: "" in: query name: set required: false schema: items: type: string type: array requestBody: content: application/json: schema: properties: action: description: Matching policy of a route map entry. enum: - permit - deny type: string call: description: The SDN route map identifier format: pve-sdn-route-map-id type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string exit-action: type: string lock-token: description: the token for unlocking the global SDN configuration type: string match: items: type: string type: array order: description: The index of this route map entry type: integer route-map-id: description: The SDN route map identifier format: pve-sdn-route-map-id type: string set: items: type: string type: array required: - action type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create Route Map entry /cluster/sdn/route-maps/entries/{route-map-id}: get: operationId: get_cluster_sdn_route_maps_entries_route_map_id parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: The SDN route map identifier in: path name: route-map-id required: true schema: description: The SDN route map identifier format: pve-sdn-route-map-id type: string - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean responses: "200": content: application/json: schema: items: properties: action: description: Matching policy of a route map entry. enum: - permit - deny type: string call: description: The SDN route map identifier format: pve-sdn-route-map-id type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string exit-action: type: string match: items: type: string type: array order: description: The index of this route map entry type: integer route-map-id: description: The SDN route map identifier format: pve-sdn-route-map-id type: string set: items: type: string type: array type: object type: array description: OK summary: List all entries for a given Route Map /cluster/sdn/route-maps/entries/{route-map-id}/entry/{order}: delete: operationId: delete_cluster_sdn_route_maps_entries_route_map_id_entry_order parameters: - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: The index of this route map entry in: path name: order required: true schema: description: The index of this route map entry type: integer - description: The SDN route map identifier in: path name: route-map-id required: true schema: description: The SDN route map identifier format: pve-sdn-route-map-id type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete Route Map Entry get: operationId: get_cluster_sdn_route_maps_entries_route_map_id_entry_order parameters: - description: The index of this route map entry in: path name: order required: true schema: description: The index of this route map entry type: integer - description: The SDN route map identifier in: path name: route-map-id required: true schema: description: The SDN route map identifier format: pve-sdn-route-map-id type: string responses: "200": content: application/json: schema: properties: action: description: Matching policy of a route map entry. enum: - permit - deny type: string call: description: The SDN route map identifier format: pve-sdn-route-map-id type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string exit-action: type: string match: items: type: string type: array order: description: The index of this route map entry type: integer route-map-id: description: The SDN route map identifier format: pve-sdn-route-map-id type: string set: items: type: string type: array type: object description: OK summary: Get Route Map Entry put: operationId: put_cluster_sdn_route_maps_entries_route_map_id_entry_order parameters: - description: Matching policy of a route map entry. in: query name: action required: false schema: description: Matching policy of a route map entry. enum: - permit - deny type: string - description: The SDN route map identifier in: query name: call required: false schema: description: The SDN route map identifier format: pve-sdn-route-map-id type: string - description: "" in: query name: delete required: false schema: items: enum: - set - match - call - exit-action type: string type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: "" in: query name: exit-action required: false schema: type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: "" in: query name: match required: false schema: items: type: string type: array - description: The index of this route map entry in: path name: order required: true schema: description: The index of this route map entry type: integer - description: The SDN route map identifier in: path name: route-map-id required: true schema: description: The SDN route map identifier format: pve-sdn-route-map-id type: string - description: "" in: query name: set required: false schema: items: type: string type: array requestBody: content: application/json: schema: properties: action: description: Matching policy of a route map entry. enum: - permit - deny type: string call: description: The SDN route map identifier format: pve-sdn-route-map-id type: string delete: items: enum: - set - match - call - exit-action type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string exit-action: type: string lock-token: description: the token for unlocking the global SDN configuration type: string match: items: type: string type: array order: description: The index of this route map entry type: integer route-map-id: description: The SDN route map identifier format: pve-sdn-route-map-id type: string set: items: type: string type: array type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update Route Map Entry /cluster/sdn/vnets: get: operationId: get_cluster_sdn_vnets parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean responses: "200": content: application/json: schema: items: properties: alias: description: Alias name of the VNet. type: string digest: description: Digest of the VNet section. type: string isolate-ports: description: If true, sets the isolated property for all interfaces on the bridge of this VNet. type: boolean pending: description: Changes that have not yet been applied to the running configuration. properties: alias: description: Alias name of the VNet. type: string isolate-ports: description: If true, sets the isolated property for all interfaces on the bridge of this VNet. type: boolean tag: description: VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). type: integer vlanaware: description: Allow VLANs to pass through this VNet. type: boolean zone: description: Name of the zone this VNet belongs to. type: string type: object state: description: State of the SDN configuration object. enum: - new - changed - deleted type: string tag: description: VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). type: integer type: description: Type of the VNet. enum: - vnet type: string vlanaware: description: Allow VLANs to pass through this VNet. type: boolean vnet: description: Name of the VNet. type: string zone: description: Name of the zone this VNet belongs to. type: string type: object type: array description: OK summary: SDN vnets index. post: operationId: post_cluster_sdn_vnets parameters: - description: Alias name of the VNet. in: query name: alias required: false schema: description: Alias name of the VNet. type: string - description: If true, sets the isolated property for all interfaces on the bridge of this VNet. in: query name: isolate-ports required: false schema: description: If true, sets the isolated property for all interfaces on the bridge of this VNet. type: boolean - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). in: query name: tag required: false schema: description: VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). type: integer - description: Type of the VNet. in: query name: type required: false schema: description: Type of the VNet. enum: - vnet type: string - description: Allow VLANs to pass through this vnet. in: query name: vlanaware required: false schema: description: Allow VLANs to pass through this vnet. type: boolean - description: The SDN vnet object identifier. in: query name: vnet required: false schema: description: The SDN vnet object identifier. type: string - description: Name of the zone this VNet belongs to. in: query name: zone required: true schema: description: Name of the zone this VNet belongs to. type: string requestBody: content: application/json: schema: properties: alias: description: Alias name of the VNet. type: string isolate-ports: description: If true, sets the isolated property for all interfaces on the bridge of this VNet. type: boolean lock-token: description: the token for unlocking the global SDN configuration type: string tag: description: VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). type: integer type: description: Type of the VNet. enum: - vnet type: string vlanaware: description: Allow VLANs to pass through this vnet. type: boolean vnet: description: The SDN vnet object identifier. type: string zone: description: Name of the zone this VNet belongs to. type: string required: - zone type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new sdn vnet object. /cluster/sdn/vnets/{vnet}: delete: operationId: delete_cluster_sdn_vnets_vnet parameters: - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete sdn vnet object configuration. get: operationId: get_cluster_sdn_vnets_vnet parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: properties: alias: description: Alias name of the VNet. type: string digest: description: Digest of the VNet section. type: string isolate-ports: description: If true, sets the isolated property for all interfaces on the bridge of this VNet. type: boolean pending: description: Changes that have not yet been applied to the running configuration. properties: alias: description: Alias name of the VNet. type: string isolate-ports: description: If true, sets the isolated property for all interfaces on the bridge of this VNet. type: boolean tag: description: VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). type: integer vlanaware: description: Allow VLANs to pass through this VNet. type: boolean zone: description: Name of the zone this VNet belongs to. type: string type: object state: description: State of the SDN configuration object. enum: - new - changed - deleted type: string tag: description: VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). type: integer type: description: Type of the VNet. enum: - vnet type: string vlanaware: description: Allow VLANs to pass through this VNet. type: boolean vnet: description: Name of the VNet. type: string zone: description: Name of the zone this VNet belongs to. type: string type: object description: OK summary: Read sdn vnet configuration. put: operationId: put_cluster_sdn_vnets_vnet parameters: - description: Alias name of the VNet. in: query name: alias required: false schema: description: Alias name of the VNet. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: If true, sets the isolated property for all interfaces on the bridge of this VNet. in: query name: isolate-ports required: false schema: description: If true, sets the isolated property for all interfaces on the bridge of this VNet. type: boolean - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). in: query name: tag required: false schema: description: VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). type: integer - description: Allow VLANs to pass through this vnet. in: query name: vlanaware required: false schema: description: Allow VLANs to pass through this vnet. type: boolean - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string - description: Name of the zone this VNet belongs to. in: query name: zone required: false schema: description: Name of the zone this VNet belongs to. type: string requestBody: content: application/json: schema: properties: alias: description: Alias name of the VNet. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string isolate-ports: description: If true, sets the isolated property for all interfaces on the bridge of this VNet. type: boolean lock-token: description: the token for unlocking the global SDN configuration type: string tag: description: VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). type: integer vlanaware: description: Allow VLANs to pass through this vnet. type: boolean vnet: description: The SDN vnet object identifier. type: string zone: description: Name of the zone this VNet belongs to. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update sdn vnet object configuration. /cluster/sdn/vnets/{vnet}/firewall: get: operationId: get_cluster_sdn_vnets_vnet_firewall parameters: - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Directory index. /cluster/sdn/vnets/{vnet}/firewall/options: get: operationId: get_cluster_sdn_vnets_vnet_firewall_options parameters: - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: properties: enable: description: Enable/disable firewall rules. type: boolean log_level_forward: description: Log level for forwarded traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string policy_forward: description: Forward policy. enum: - ACCEPT - DROP type: string type: object description: OK summary: Get vnet firewall options. put: operationId: put_cluster_sdn_vnets_vnet_firewall_options parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Enable/disable firewall rules. in: query name: enable required: false schema: description: Enable/disable firewall rules. type: boolean - description: Log level for forwarded traffic. in: query name: log_level_forward required: false schema: description: Log level for forwarded traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Forward policy. in: query name: policy_forward required: false schema: description: Forward policy. enum: - ACCEPT - DROP type: string - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string enable: description: Enable/disable firewall rules. type: boolean log_level_forward: description: Log level for forwarded traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string policy_forward: description: Forward policy. enum: - ACCEPT - DROP type: string vnet: description: The SDN vnet object identifier. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set Firewall options. /cluster/sdn/vnets/{vnet}/firewall/rules: get: operationId: get_cluster_sdn_vnets_vnet_firewall_rules parameters: - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: items: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object type: array description: OK summary: List rules. post: operationId: post_cluster_sdn_vnets_vnet_firewall_rules parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: true schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: Update rule at position . in: query name: pos required: false schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: true schema: description: Rule type. enum: - in - out - forward - group type: string - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string vnet: description: The SDN vnet object identifier. type: string required: - action - type type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new rule. /cluster/sdn/vnets/{vnet}/firewall/rules/{pos}: delete: operationId: delete_cluster_sdn_vnets_vnet_firewall_rules_pos parameters: - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete rule. get: operationId: get_cluster_sdn_vnets_vnet_firewall_rules_pos parameters: - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object description: OK summary: Get single rule data. put: operationId: put_cluster_sdn_vnets_vnet_firewall_rules_pos parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: false schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: Move rule to new position . Other arguments are ignored. in: query name: moveto required: false schema: description: Move rule to new position . Other arguments are ignored. type: integer - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: false schema: description: Rule type. enum: - in - out - forward - group type: string - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string moveto: description: Move rule to new position . Other arguments are ignored. type: integer pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string vnet: description: The SDN vnet object identifier. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Modify rule data. /cluster/sdn/vnets/{vnet}/ips: delete: operationId: delete_cluster_sdn_vnets_vnet_ips parameters: - description: The IP address to delete in: query name: ip required: false schema: description: The IP address to delete format: ip type: string - description: Unicast MAC address. in: query name: mac required: false schema: description: Unicast MAC address. format: mac-addr type: string - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string - description: The SDN zone object identifier. in: query name: zone required: false schema: description: The SDN zone object identifier. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete IP Mappings in a VNet post: operationId: post_cluster_sdn_vnets_vnet_ips parameters: - description: The IP address to associate with the given MAC address in: query name: ip required: false schema: description: The IP address to associate with the given MAC address format: ip type: string - description: Unicast MAC address. in: query name: mac required: false schema: description: Unicast MAC address. format: mac-addr type: string - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string - description: The SDN zone object identifier. in: query name: zone required: false schema: description: The SDN zone object identifier. type: string requestBody: content: application/json: schema: properties: ip: description: The IP address to associate with the given MAC address format: ip type: string mac: description: Unicast MAC address. format: mac-addr type: string vnet: description: The SDN vnet object identifier. type: string zone: description: The SDN zone object identifier. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create IP Mapping in a VNet put: operationId: put_cluster_sdn_vnets_vnet_ips parameters: - description: The IP address to associate with the given MAC address in: query name: ip required: false schema: description: The IP address to associate with the given MAC address format: ip type: string - description: Unicast MAC address. in: query name: mac required: false schema: description: Unicast MAC address. format: mac-addr type: string - description: The (unique) ID of the VM. in: query name: vmid required: false schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string - description: The SDN zone object identifier. in: query name: zone required: false schema: description: The SDN zone object identifier. type: string requestBody: content: application/json: schema: properties: ip: description: The IP address to associate with the given MAC address format: ip type: string mac: description: Unicast MAC address. format: mac-addr type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer vnet: description: The SDN vnet object identifier. type: string zone: description: The SDN zone object identifier. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update IP Mapping in a VNet /cluster/sdn/vnets/{vnet}/subnets: get: operationId: get_cluster_sdn_vnets_vnet_subnets parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: SDN subnets index. post: operationId: post_cluster_sdn_vnets_vnet_subnets parameters: - description: IP address for the DNS server in: query name: dhcp-dns-server required: false schema: description: IP address for the DNS server format: ip type: string - description: A list of DHCP ranges for this subnet in: query name: dhcp-range required: false schema: description: A list of DHCP ranges for this subnet items: format: pve-sdn-dhcp-range type: string type: array - description: 'dns domain zone prefix ex: ''adm'' -> .adm.mydomain.com' in: query name: dnszoneprefix required: false schema: description: 'dns domain zone prefix ex: ''adm'' -> .adm.mydomain.com' format: dns-name type: string - description: 'Subnet Gateway: Will be assign on vnet for layer3 zones' in: query name: gateway required: false schema: description: 'Subnet Gateway: Will be assign on vnet for layer3 zones' format: ip type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: enable masquerade for this subnet if pve-firewall in: query name: snat required: false schema: description: enable masquerade for this subnet if pve-firewall type: boolean - description: The SDN subnet object identifier. in: query name: subnet required: false schema: description: The SDN subnet object identifier. format: pve-sdn-subnet-id type: string - description: "" in: query name: type required: false schema: enum: - subnet type: string - description: associated vnet in: path name: vnet required: true schema: description: associated vnet type: string requestBody: content: application/json: schema: properties: dhcp-dns-server: description: IP address for the DNS server format: ip type: string dhcp-range: description: A list of DHCP ranges for this subnet items: format: pve-sdn-dhcp-range type: string type: array dnszoneprefix: description: 'dns domain zone prefix ex: ''adm'' -> .adm.mydomain.com' format: dns-name type: string gateway: description: 'Subnet Gateway: Will be assign on vnet for layer3 zones' format: ip type: string lock-token: description: the token for unlocking the global SDN configuration type: string snat: description: enable masquerade for this subnet if pve-firewall type: boolean subnet: description: The SDN subnet object identifier. format: pve-sdn-subnet-id type: string type: enum: - subnet type: string vnet: description: associated vnet type: string required: - vnet type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new sdn subnet object. /cluster/sdn/vnets/{vnet}/subnets/{subnet}: delete: operationId: delete_cluster_sdn_vnets_vnet_subnets_subnet parameters: - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: The SDN subnet object identifier. in: path name: subnet required: true schema: description: The SDN subnet object identifier. format: pve-sdn-subnet-id type: string - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete sdn subnet object configuration. get: operationId: get_cluster_sdn_vnets_vnet_subnets_subnet parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean - description: The SDN subnet object identifier. in: path name: subnet required: true schema: description: The SDN subnet object identifier. format: pve-sdn-subnet-id type: string - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: type: object description: OK summary: Read sdn subnet configuration. put: operationId: put_cluster_sdn_vnets_vnet_subnets_subnet parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: IP address for the DNS server in: query name: dhcp-dns-server required: false schema: description: IP address for the DNS server format: ip type: string - description: A list of DHCP ranges for this subnet in: query name: dhcp-range required: false schema: description: A list of DHCP ranges for this subnet items: format: pve-sdn-dhcp-range type: string type: array - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: 'dns domain zone prefix ex: ''adm'' -> .adm.mydomain.com' in: query name: dnszoneprefix required: false schema: description: 'dns domain zone prefix ex: ''adm'' -> .adm.mydomain.com' format: dns-name type: string - description: 'Subnet Gateway: Will be assign on vnet for layer3 zones' in: query name: gateway required: false schema: description: 'Subnet Gateway: Will be assign on vnet for layer3 zones' format: ip type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: enable masquerade for this subnet if pve-firewall in: query name: snat required: false schema: description: enable masquerade for this subnet if pve-firewall type: boolean - description: The SDN subnet object identifier. in: path name: subnet required: true schema: description: The SDN subnet object identifier. format: pve-sdn-subnet-id type: string - description: associated vnet in: path name: vnet required: true schema: description: associated vnet type: string requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string dhcp-dns-server: description: IP address for the DNS server format: ip type: string dhcp-range: description: A list of DHCP ranges for this subnet items: format: pve-sdn-dhcp-range type: string type: array digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dnszoneprefix: description: 'dns domain zone prefix ex: ''adm'' -> .adm.mydomain.com' format: dns-name type: string gateway: description: 'Subnet Gateway: Will be assign on vnet for layer3 zones' format: ip type: string lock-token: description: the token for unlocking the global SDN configuration type: string snat: description: enable masquerade for this subnet if pve-firewall type: boolean subnet: description: The SDN subnet object identifier. format: pve-sdn-subnet-id type: string vnet: description: associated vnet type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update sdn subnet object configuration. /cluster/sdn/zones: get: operationId: get_cluster_sdn_zones parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean - description: Only list SDN zones of specific type in: query name: type required: false schema: description: Only list SDN zones of specific type enum: - evpn - faucet - qinq - simple - vlan - vxlan type: string responses: "200": content: application/json: schema: items: properties: advertise-subnets: description: Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). EVPN zone only. type: boolean bridge: description: the bridge for which VLANs should be managed. VLAN & QinQ zone only. type: string bridge-disable-mac-learning: description: Disable auto mac learning. VLAN zone only. type: boolean controller: description: ID of the controller for this zone. EVPN zone only. type: string dhcp: description: Name of DHCP server backend for this zone. enum: - dnsmasq type: string digest: description: Digest of the controller section. type: string disable-arp-nd-suppression: description: Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. EVPN zone only. type: boolean dns: description: ID of the DNS server for this zone. type: string dnszone: description: Domain name for this zone. type: string exitnodes: description: List of PVE Nodes that should act as exit node for this zone. EVPN zone only. format: pve-node-list type: string exitnodes-local-routing: description: Create routes on the exit nodes, so they can connect to EVPN guests. EVPN zone only. type: boolean exitnodes-primary: description: Force traffic through this exitnode first. EVPN zone only. format: pve-node type: string ipam: description: ID of the IPAM for this zone. type: string mac: description: MAC address of the anycast router for this zone. type: string mtu: description: MTU of the zone, will be used for the created VNet bridges. type: integer nodes: description: Nodes where this zone should be created. type: string peers: description: Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. VXLAN zone only. format: ip-list type: string pending: description: Changes that have not yet been applied to the running configuration. properties: advertise-subnets: description: Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). EVPN zone only. type: boolean bridge: description: the bridge for which VLANs should be managed. VLAN & QinQ zone only. type: string bridge-disable-mac-learning: description: Disable auto mac learning. VLAN zone only. type: boolean controller: description: ID of the controller for this zone. EVPN zone only. type: string dhcp: description: Name of DHCP server backend for this zone. enum: - dnsmasq type: string disable-arp-nd-suppression: description: Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. EVPN zone only. type: boolean dns: description: ID of the DNS server for this zone. type: string dnszone: description: Domain name for this zone. type: string exitnodes: description: List of PVE Nodes that should act as exit node for this zone. EVPN zone only. format: pve-node-list type: string exitnodes-local-routing: description: Create routes on the exit nodes, so they can connect to EVPN guests. EVPN zone only. type: boolean exitnodes-primary: description: Force traffic through this exitnode first. EVPN zone only. format: pve-node type: string ipam: description: ID of the IPAM for this zone. type: string mac: description: MAC address of the anycast router for this zone. type: string mtu: description: MTU of the zone, will be used for the created VNet bridges. type: integer nodes: description: Nodes where this zone should be created. type: string peers: description: Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. VXLAN zone only. format: ip-list type: string reversedns: description: ID of the reverse DNS server for this zone. type: string rt-import: description: Route-Targets that should be imported into the VRF of this zone via BGP. EVPN zone only. format: pve-sdn-bgp-rt-list type: string secondary-controllers: description: Additional controllers. items: description: Controller ID. type: string type: array tag: description: Service-VLAN Tag (outer VLAN). QinQ zone only type: integer vlan-protocol: description: VLAN protocol for the creation of the QinQ zone. QinQ zone only. enum: - 802.1q - 802.1ad type: string vrf-vxlan: description: VNI for the zone VRF. EVPN zone only. type: integer vxlan-port: description: UDP port that should be used for the VXLAN tunnel (default 4789). VXLAN zone only. type: integer type: object reversedns: description: ID of the reverse DNS server for this zone. type: string rt-import: description: Route-Targets that should be imported into the VRF of this zone via BGP. EVPN zone only. format: pve-sdn-bgp-rt-list type: string secondary-controllers: description: Additional controllers. items: description: Controller ID. type: string type: array state: description: State of the SDN configuration object. enum: - new - changed - deleted type: string tag: description: Service-VLAN Tag (outer VLAN). QinQ zone only type: integer type: description: Type of the zone. enum: - evpn - faucet - qinq - simple - vlan - vxlan type: string vlan-protocol: description: VLAN protocol for the creation of the QinQ zone. QinQ zone only. enum: - 802.1q - 802.1ad type: string vrf-vxlan: description: VNI for the zone VRF. EVPN zone only. type: integer vxlan-port: description: UDP port that should be used for the VXLAN tunnel (default 4789). VXLAN zone only. type: integer zone: description: Name of the zone. type: string type: object type: array description: OK summary: SDN zones index. post: operationId: post_cluster_sdn_zones parameters: - description: Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). in: query name: advertise-subnets required: false schema: description: Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). type: boolean - description: The bridge for which VLANs should be managed. in: query name: bridge required: false schema: description: The bridge for which VLANs should be managed. type: string - description: Disable auto mac learning. in: query name: bridge-disable-mac-learning required: false schema: description: Disable auto mac learning. type: boolean - description: Controller for this zone. in: query name: controller required: false schema: description: Controller for this zone. type: string - description: Type of the DHCP backend for this zone in: query name: dhcp required: false schema: description: Type of the DHCP backend for this zone enum: - dnsmasq type: string - description: Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. in: query name: disable-arp-nd-suppression required: false schema: description: Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. type: boolean - description: dns api server in: query name: dns required: false schema: description: dns api server type: string - description: 'dns domain zone ex: mydomain.com' in: query name: dnszone required: false schema: description: 'dns domain zone ex: mydomain.com' format: dns-name type: string - description: Faucet dataplane id in: query name: dp-id required: false schema: description: Faucet dataplane id type: integer - description: List of cluster node names. in: query name: exitnodes required: false schema: description: List of cluster node names. format: pve-node-list type: string - description: Allow exitnodes to connect to EVPN guests. in: query name: exitnodes-local-routing required: false schema: description: Allow exitnodes to connect to EVPN guests. type: boolean - description: Force traffic through this exitnode first. in: query name: exitnodes-primary required: false schema: description: Force traffic through this exitnode first. format: pve-node type: string - description: SDN fabric to use as underlay for this VXLAN zone. in: query name: fabric required: false schema: description: SDN fabric to use as underlay for this VXLAN zone. format: pve-sdn-fabric-id type: string - description: use a specific ipam in: query name: ipam required: false schema: description: use a specific ipam type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: Anycast logical router mac address. in: query name: mac required: false schema: description: Anycast logical router mac address. format: mac-addr type: string - description: MTU of the zone, will be used for the created VNet bridges. in: query name: mtu required: false schema: description: MTU of the zone, will be used for the created VNet bridges. type: integer - description: List of cluster node names. in: query name: nodes required: false schema: description: List of cluster node names. format: pve-node-list type: string - description: Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. in: query name: peers required: false schema: description: Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. format: ip-list type: string - description: reverse dns api server in: query name: reversedns required: false schema: description: reverse dns api server type: string - description: List of Route Targets that should be imported into the VRF of the zone. in: query name: rt-import required: false schema: description: List of Route Targets that should be imported into the VRF of the zone. format: pve-sdn-bgp-rt-list type: string - description: Additional controllers. in: query name: secondary-controllers required: false schema: description: Additional controllers. items: description: Controller ID. type: string type: array - description: Service-VLAN Tag (outer VLAN) in: query name: tag required: false schema: description: Service-VLAN Tag (outer VLAN) type: integer - description: Plugin type. in: query name: type required: false schema: description: Plugin type. enum: - evpn - faucet - qinq - simple - vlan - vxlan format: pve-configid type: string - description: Which VLAN protocol should be used for the creation of the QinQ zone. in: query name: vlan-protocol required: false schema: description: Which VLAN protocol should be used for the creation of the QinQ zone. enum: - 802.1q - 802.1ad type: string - description: VNI for the zone VRF. in: query name: vrf-vxlan required: false schema: description: VNI for the zone VRF. type: integer - description: UDP port that should be used for the VXLAN tunnel (default 4789). in: query name: vxlan-port required: false schema: description: UDP port that should be used for the VXLAN tunnel (default 4789). type: integer - description: The SDN zone object identifier. in: query name: zone required: false schema: description: The SDN zone object identifier. type: string requestBody: content: application/json: schema: properties: advertise-subnets: description: Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). type: boolean bridge: description: The bridge for which VLANs should be managed. type: string bridge-disable-mac-learning: description: Disable auto mac learning. type: boolean controller: description: Controller for this zone. type: string dhcp: description: Type of the DHCP backend for this zone enum: - dnsmasq type: string disable-arp-nd-suppression: description: Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. type: boolean dns: description: dns api server type: string dnszone: description: 'dns domain zone ex: mydomain.com' format: dns-name type: string dp-id: description: Faucet dataplane id type: integer exitnodes: description: List of cluster node names. format: pve-node-list type: string exitnodes-local-routing: description: Allow exitnodes to connect to EVPN guests. type: boolean exitnodes-primary: description: Force traffic through this exitnode first. format: pve-node type: string fabric: description: SDN fabric to use as underlay for this VXLAN zone. format: pve-sdn-fabric-id type: string ipam: description: use a specific ipam type: string lock-token: description: the token for unlocking the global SDN configuration type: string mac: description: Anycast logical router mac address. format: mac-addr type: string mtu: description: MTU of the zone, will be used for the created VNet bridges. type: integer nodes: description: List of cluster node names. format: pve-node-list type: string peers: description: Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. format: ip-list type: string reversedns: description: reverse dns api server type: string rt-import: description: List of Route Targets that should be imported into the VRF of the zone. format: pve-sdn-bgp-rt-list type: string secondary-controllers: description: Additional controllers. items: description: Controller ID. type: string type: array tag: description: Service-VLAN Tag (outer VLAN) type: integer type: description: Plugin type. enum: - evpn - faucet - qinq - simple - vlan - vxlan format: pve-configid type: string vlan-protocol: description: Which VLAN protocol should be used for the creation of the QinQ zone. enum: - 802.1q - 802.1ad type: string vrf-vxlan: description: VNI for the zone VRF. type: integer vxlan-port: description: UDP port that should be used for the VXLAN tunnel (default 4789). type: integer zone: description: The SDN zone object identifier. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a new sdn zone object. /cluster/sdn/zones/{zone}: delete: operationId: delete_cluster_sdn_zones_zone parameters: - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: The SDN zone object identifier. in: path name: zone required: true schema: description: The SDN zone object identifier. type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete sdn zone object configuration. get: operationId: get_cluster_sdn_zones_zone parameters: - description: Display pending config. in: query name: pending required: false schema: description: Display pending config. type: boolean - description: Display running config. in: query name: running required: false schema: description: Display running config. type: boolean - description: The SDN zone object identifier. in: path name: zone required: true schema: description: The SDN zone object identifier. type: string responses: "200": content: application/json: schema: properties: advertise-subnets: description: Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). EVPN zone only. type: boolean bridge: description: the bridge for which VLANs should be managed. VLAN & QinQ zone only. type: string bridge-disable-mac-learning: description: Disable auto mac learning. VLAN zone only. type: boolean controller: description: ID of the controller for this zone. EVPN zone only. type: string dhcp: description: Name of DHCP server backend for this zone. enum: - dnsmasq type: string digest: description: Digest of the controller section. type: string disable-arp-nd-suppression: description: Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. EVPN zone only. type: boolean dns: description: ID of the DNS server for this zone. type: string dnszone: description: Domain name for this zone. type: string exitnodes: description: List of PVE Nodes that should act as exit node for this zone. EVPN zone only. format: pve-node-list type: string exitnodes-local-routing: description: Create routes on the exit nodes, so they can connect to EVPN guests. EVPN zone only. type: boolean exitnodes-primary: description: Force traffic through this exitnode first. EVPN zone only. format: pve-node type: string ipam: description: ID of the IPAM for this zone. type: string mac: description: MAC address of the anycast router for this zone. type: string mtu: description: MTU of the zone, will be used for the created VNet bridges. type: integer nodes: description: Nodes where this zone should be created. type: string peers: description: Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. VXLAN zone only. format: ip-list type: string pending: description: Changes that have not yet been applied to the running configuration. properties: advertise-subnets: description: Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). EVPN zone only. type: boolean bridge: description: the bridge for which VLANs should be managed. VLAN & QinQ zone only. type: string bridge-disable-mac-learning: description: Disable auto mac learning. VLAN zone only. type: boolean controller: description: ID of the controller for this zone. EVPN zone only. type: string dhcp: description: Name of DHCP server backend for this zone. enum: - dnsmasq type: string disable-arp-nd-suppression: description: Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. EVPN zone only. type: boolean dns: description: ID of the DNS server for this zone. type: string dnszone: description: Domain name for this zone. type: string exitnodes: description: List of PVE Nodes that should act as exit node for this zone. EVPN zone only. format: pve-node-list type: string exitnodes-local-routing: description: Create routes on the exit nodes, so they can connect to EVPN guests. EVPN zone only. type: boolean exitnodes-primary: description: Force traffic through this exitnode first. EVPN zone only. format: pve-node type: string ipam: description: ID of the IPAM for this zone. type: string mac: description: MAC address of the anycast router for this zone. type: string mtu: description: MTU of the zone, will be used for the created VNet bridges. type: integer nodes: description: Nodes where this zone should be created. type: string peers: description: Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. VXLAN zone only. format: ip-list type: string reversedns: description: ID of the reverse DNS server for this zone. type: string rt-import: description: Route-Targets that should be imported into the VRF of this zone via BGP. EVPN zone only. format: pve-sdn-bgp-rt-list type: string secondary-controllers: description: Additional controllers. items: description: Controller ID. type: string type: array tag: description: Service-VLAN Tag (outer VLAN). QinQ zone only type: integer vlan-protocol: description: VLAN protocol for the creation of the QinQ zone. QinQ zone only. enum: - 802.1q - 802.1ad type: string vrf-vxlan: description: VNI for the zone VRF. EVPN zone only. type: integer vxlan-port: description: UDP port that should be used for the VXLAN tunnel (default 4789). VXLAN zone only. type: integer type: object reversedns: description: ID of the reverse DNS server for this zone. type: string rt-import: description: Route-Targets that should be imported into the VRF of this zone via BGP. EVPN zone only. format: pve-sdn-bgp-rt-list type: string secondary-controllers: description: Additional controllers. items: description: Controller ID. type: string type: array state: description: State of the SDN configuration object. enum: - new - changed - deleted type: string tag: description: Service-VLAN Tag (outer VLAN). QinQ zone only type: integer type: description: Type of the zone. enum: - evpn - faucet - qinq - simple - vlan - vxlan type: string vlan-protocol: description: VLAN protocol for the creation of the QinQ zone. QinQ zone only. enum: - 802.1q - 802.1ad type: string vrf-vxlan: description: VNI for the zone VRF. EVPN zone only. type: integer vxlan-port: description: UDP port that should be used for the VXLAN tunnel (default 4789). VXLAN zone only. type: integer zone: description: Name of the zone. type: string type: object description: OK summary: Read sdn zone configuration. put: operationId: put_cluster_sdn_zones_zone parameters: - description: Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). in: query name: advertise-subnets required: false schema: description: Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). type: boolean - description: The bridge for which VLANs should be managed. in: query name: bridge required: false schema: description: The bridge for which VLANs should be managed. type: string - description: Disable auto mac learning. in: query name: bridge-disable-mac-learning required: false schema: description: Disable auto mac learning. type: boolean - description: Controller for this zone. in: query name: controller required: false schema: description: Controller for this zone. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Type of the DHCP backend for this zone in: query name: dhcp required: false schema: description: Type of the DHCP backend for this zone enum: - dnsmasq type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. in: query name: disable-arp-nd-suppression required: false schema: description: Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. type: boolean - description: dns api server in: query name: dns required: false schema: description: dns api server type: string - description: 'dns domain zone ex: mydomain.com' in: query name: dnszone required: false schema: description: 'dns domain zone ex: mydomain.com' format: dns-name type: string - description: Faucet dataplane id in: query name: dp-id required: false schema: description: Faucet dataplane id type: integer - description: List of cluster node names. in: query name: exitnodes required: false schema: description: List of cluster node names. format: pve-node-list type: string - description: Allow exitnodes to connect to EVPN guests. in: query name: exitnodes-local-routing required: false schema: description: Allow exitnodes to connect to EVPN guests. type: boolean - description: Force traffic through this exitnode first. in: query name: exitnodes-primary required: false schema: description: Force traffic through this exitnode first. format: pve-node type: string - description: SDN fabric to use as underlay for this VXLAN zone. in: query name: fabric required: false schema: description: SDN fabric to use as underlay for this VXLAN zone. format: pve-sdn-fabric-id type: string - description: use a specific ipam in: query name: ipam required: false schema: description: use a specific ipam type: string - description: the token for unlocking the global SDN configuration in: query name: lock-token required: false schema: description: the token for unlocking the global SDN configuration type: string - description: Anycast logical router mac address. in: query name: mac required: false schema: description: Anycast logical router mac address. format: mac-addr type: string - description: MTU of the zone, will be used for the created VNet bridges. in: query name: mtu required: false schema: description: MTU of the zone, will be used for the created VNet bridges. type: integer - description: List of cluster node names. in: query name: nodes required: false schema: description: List of cluster node names. format: pve-node-list type: string - description: Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. in: query name: peers required: false schema: description: Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. format: ip-list type: string - description: reverse dns api server in: query name: reversedns required: false schema: description: reverse dns api server type: string - description: List of Route Targets that should be imported into the VRF of the zone. in: query name: rt-import required: false schema: description: List of Route Targets that should be imported into the VRF of the zone. format: pve-sdn-bgp-rt-list type: string - description: Additional controllers. in: query name: secondary-controllers required: false schema: description: Additional controllers. items: description: Controller ID. type: string type: array - description: Service-VLAN Tag (outer VLAN) in: query name: tag required: false schema: description: Service-VLAN Tag (outer VLAN) type: integer - description: Which VLAN protocol should be used for the creation of the QinQ zone. in: query name: vlan-protocol required: false schema: description: Which VLAN protocol should be used for the creation of the QinQ zone. enum: - 802.1q - 802.1ad type: string - description: VNI for the zone VRF. in: query name: vrf-vxlan required: false schema: description: VNI for the zone VRF. type: integer - description: UDP port that should be used for the VXLAN tunnel (default 4789). in: query name: vxlan-port required: false schema: description: UDP port that should be used for the VXLAN tunnel (default 4789). type: integer - description: The SDN zone object identifier. in: path name: zone required: true schema: description: The SDN zone object identifier. type: string requestBody: content: application/json: schema: properties: advertise-subnets: description: Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). type: boolean bridge: description: The bridge for which VLANs should be managed. type: string bridge-disable-mac-learning: description: Disable auto mac learning. type: boolean controller: description: Controller for this zone. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string dhcp: description: Type of the DHCP backend for this zone enum: - dnsmasq type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable-arp-nd-suppression: description: Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. type: boolean dns: description: dns api server type: string dnszone: description: 'dns domain zone ex: mydomain.com' format: dns-name type: string dp-id: description: Faucet dataplane id type: integer exitnodes: description: List of cluster node names. format: pve-node-list type: string exitnodes-local-routing: description: Allow exitnodes to connect to EVPN guests. type: boolean exitnodes-primary: description: Force traffic through this exitnode first. format: pve-node type: string fabric: description: SDN fabric to use as underlay for this VXLAN zone. format: pve-sdn-fabric-id type: string ipam: description: use a specific ipam type: string lock-token: description: the token for unlocking the global SDN configuration type: string mac: description: Anycast logical router mac address. format: mac-addr type: string mtu: description: MTU of the zone, will be used for the created VNet bridges. type: integer nodes: description: List of cluster node names. format: pve-node-list type: string peers: description: Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. format: ip-list type: string reversedns: description: reverse dns api server type: string rt-import: description: List of Route Targets that should be imported into the VRF of the zone. format: pve-sdn-bgp-rt-list type: string secondary-controllers: description: Additional controllers. items: description: Controller ID. type: string type: array tag: description: Service-VLAN Tag (outer VLAN) type: integer vlan-protocol: description: Which VLAN protocol should be used for the creation of the QinQ zone. enum: - 802.1q - 802.1ad type: string vrf-vxlan: description: VNI for the zone VRF. type: integer vxlan-port: description: UDP port that should be used for the VXLAN tunnel (default 4789). type: integer zone: description: The SDN zone object identifier. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update sdn zone object configuration. /cluster/status: get: operationId: get_cluster_status responses: "200": content: application/json: schema: items: properties: id: type: string ip: description: '[node] IP of the resolved nodename.' type: string level: description: '[node] Proxmox VE Subscription level, indicates if eligible for enterprise support as well as access to the stable Proxmox VE Enterprise Repository.' type: string local: description: '[node] Indicates if this is the responding node.' type: boolean name: type: string nodeid: description: '[node] ID of the node from the corosync configuration.' type: integer nodes: description: '[cluster] Nodes count, including offline nodes.' type: integer online: description: '[node] Indicates if the node is online or offline.' type: boolean quorate: description: '[cluster] Indicates if there is a majority of nodes online to make decisions' type: boolean type: description: Indicates the type, either cluster or node. The type defines the object properties e.g. quorate available for type cluster. enum: - cluster - node type: string version: description: '[cluster] Current version of the corosync configuration file.' type: integer type: object type: array description: OK summary: Get cluster status information. /cluster/tasks: get: operationId: get_cluster_tasks responses: "200": content: application/json: schema: items: properties: upid: type: string type: object type: array description: OK summary: List recent tasks (cluster wide). /nodes: get: operationId: get_nodes responses: "200": content: application/json: schema: items: properties: cpu: description: CPU utilization. type: number level: description: Support level. type: string maxcpu: description: Number of available CPUs. type: integer maxmem: description: Number of available memory in bytes. type: integer mem: description: Used memory in bytes. type: integer node: description: The cluster node name. format: pve-node type: string ssl_fingerprint: description: The SSL fingerprint for the node certificate. type: string status: description: Node status. enum: - unknown - online - offline type: string uptime: description: Node uptime in seconds. type: integer type: object type: array description: OK summary: Cluster node index. /nodes/{node}: get: operationId: get_nodes_node parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Node index. /nodes/{node}/aplinfo: get: operationId: get_nodes_node_aplinfo parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Get list of appliances. post: operationId: post_nodes_node_aplinfo parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage where the template will be stored in: query name: storage required: false schema: description: The storage where the template will be stored format: pve-storage-id type: string - description: The template which will downloaded in: query name: template required: false schema: description: The template which will downloaded type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string storage: description: The storage where the template will be stored format: pve-storage-id type: string template: description: The template which will downloaded type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Download appliance templates. /nodes/{node}/apt: get: operationId: get_nodes_node_apt parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: id: type: string type: object type: array description: OK summary: Directory index for apt (Advanced Package Tool). /nodes/{node}/apt/changelog: get: operationId: get_nodes_node_apt_changelog parameters: - description: Package name. in: query name: name required: false schema: description: Package name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Package version. in: query name: version required: false schema: description: Package version. type: string responses: "200": content: application/json: schema: type: string description: OK summary: Get package changelogs. /nodes/{node}/apt/repositories: get: operationId: get_nodes_node_apt_repositories parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: description: Result from parsing the APT repository files in /etc/apt/. properties: digest: description: Common digest of all files. type: string errors: description: List of problematic repository files. items: properties: error: description: The error message type: string path: description: Path to the problematic file. type: string type: object type: array files: description: List of parsed repository files. items: properties: digest: description: Digest of the file as bytes. items: type: integer type: array file-type: description: Format of the file. enum: - list - sources type: string path: description: Path to the problematic file. type: string repositories: description: The parsed repositories. items: properties: Comment: description: Associated comment type: string Components: description: List of repository components items: type: string type: array Enabled: description: Whether the repository is enabled or not type: boolean FileType: description: Format of the defining file. enum: - list - sources type: string Options: description: Additional options items: properties: Key: type: string Values: items: type: string type: array type: object type: array Suites: description: List of package distribuitions items: type: string type: array Types: description: List of package types. items: enum: - deb - deb-src type: string type: array URIs: description: List of repository URIs. items: type: string type: array type: object type: array type: object type: array infos: description: Additional information/warnings for APT repositories. items: properties: index: description: Index of the associated repository within the file. type: string kind: description: Kind of the information (e.g. warning). type: string message: description: Information message. type: string path: description: Path to the associated file. type: string property: description: Property from which the info originates. type: string type: object type: array standard-repos: description: List of standard repositories and their configuration status items: properties: handle: description: Handle to identify the repository. type: string name: description: Full name of the repository. type: string status: description: Indicating enabled/disabled status, if the repository is configured. type: boolean type: object type: array type: object description: OK summary: Get APT repository information. post: operationId: post_nodes_node_apt_repositories parameters: - description: Digest to detect modifications. in: query name: digest required: false schema: description: Digest to detect modifications. type: string - description: Whether the repository should be enabled or not. in: query name: enabled required: false schema: description: Whether the repository should be enabled or not. type: boolean - description: Index within the file (starting from 0). in: query name: index required: false schema: description: Index within the file (starting from 0). type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Path to the containing file. in: query name: path required: false schema: description: Path to the containing file. type: string requestBody: content: application/json: schema: properties: digest: description: Digest to detect modifications. type: string enabled: description: Whether the repository should be enabled or not. type: boolean index: description: Index within the file (starting from 0). type: integer node: description: The cluster node name. format: pve-node type: string path: description: Path to the containing file. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Change the properties of a repository. Currently only allows enabling/disabling. put: operationId: put_nodes_node_apt_repositories parameters: - description: Digest to detect modifications. in: query name: digest required: false schema: description: Digest to detect modifications. type: string - description: Handle that identifies a repository. in: query name: handle required: false schema: description: Handle that identifies a repository. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: digest: description: Digest to detect modifications. type: string handle: description: Handle that identifies a repository. type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add a standard repository to the configuration /nodes/{node}/apt/update: get: operationId: get_nodes_node_apt_update parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: Arch: description: Package Architecture. enum: - armhf - arm64 - amd64 - ppc64el - risc64 - s390x - all type: string Description: description: Package description. type: string NotifyStatus: description: Version for which PVE has already sent an update notification for. type: string OldVersion: description: Old version currently installed. type: string Origin: description: Package origin, e.g., 'Proxmox' or 'Debian'. type: string Package: description: Package name. type: string Priority: description: Package priority. type: string Section: description: Package section. type: string Title: description: Package title. type: string Version: description: New version to be updated to. type: string type: object type: array description: OK summary: List available updates. post: operationId: post_nodes_node_apt_update parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Send notification about new packages. in: query name: notify required: false schema: description: Send notification about new packages. type: boolean - description: Only produces output suitable for logging, omitting progress indicators. in: query name: quiet required: false schema: description: Only produces output suitable for logging, omitting progress indicators. type: boolean requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string notify: description: Send notification about new packages. type: boolean quiet: description: Only produces output suitable for logging, omitting progress indicators. type: boolean type: object responses: "200": content: application/json: schema: type: string description: OK summary: This is used to resynchronize the package index files from their sources (apt-get update). /nodes/{node}/apt/versions: get: operationId: get_nodes_node_apt_versions parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: Arch: description: Package Architecture. enum: - armhf - arm64 - amd64 - ppc64el - risc64 - s390x - all type: string CurrentState: description: Current state of the package installed on the system. enum: - Installed - NotInstalled - UnPacked - HalfConfigured - HalfInstalled - ConfigFiles type: string Description: description: Package description. type: string ManagerVersion: description: Version of the currently running pve-manager API server. type: string NotifyStatus: description: Version for which PVE has already sent an update notification for. type: string OldVersion: description: Old version currently installed. type: string Origin: description: Package origin, e.g., 'Proxmox' or 'Debian'. type: string Package: description: Package name. type: string Priority: description: Package priority. type: string RunningKernel: description: Kernel release, only for package 'proxmox-ve'. type: string Section: description: Package section. type: string Title: description: Package title. type: string Version: description: New version to be updated to. type: string type: object type: array description: OK summary: Get package information for important Proxmox packages. /nodes/{node}/capabilities: get: operationId: get_nodes_node_capabilities parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Node capabilities index. /nodes/{node}/capabilities/qemu: get: operationId: get_nodes_node_capabilities_qemu parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: QEMU capabilities index. /nodes/{node}/capabilities/qemu/cpu: get: operationId: get_nodes_node_capabilities_qemu_cpu parameters: - description: Virtual processor architecture. Defaults to the host architecture. in: query name: arch required: false schema: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: abstract: description: True for PVE-internal abstract profiles like x86-64-v2, -v3, -v4. These do not correspond to a QEMU CPU type and cannot be used as a custom model's 'reported-model'. type: boolean custom: description: True if this is a custom CPU model. type: boolean name: description: Name of the CPU model. Identifies it for subsequent API calls. Prefixed with 'custom-' for custom models. type: string vendor: description: CPU vendor visible to the guest when this model is selected. Vendor of 'reported-model' in case of custom models. type: string type: object type: array description: OK summary: List all custom and default CPU models. /nodes/{node}/capabilities/qemu/cpu-flags: get: operationId: get_nodes_node_capabilities_qemu_cpu_flags parameters: - description: Acceleration type to check node compatibility for. in: query name: accel required: false schema: description: Acceleration type to check node compatibility for. enum: - kvm - tcg type: string - description: Virtual processor architecture. Defaults to the host architecture. in: query name: arch required: false schema: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: description: description: Description of the CPU flag. type: string name: description: Name of the CPU flag. type: string supported-on: description: List of nodes supporting the CPU flag with the selected acceleration type ("accel"). items: description: The cluster node name. format: pve-node type: string type: array type: object type: array description: OK summary: List of available VM-specific CPU flags. Returns an empty list for 'aarch64' as no VM-specific flags are defined for it yet. /nodes/{node}/capabilities/qemu/machines: get: operationId: get_nodes_node_capabilities_qemu_machines parameters: - description: Virtual processor architecture. Defaults to the host architecture. in: query name: arch required: false schema: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: changes: description: Notable changes of a version, currently only set for +pveX versions. type: string id: description: Full name of machine type and version. type: string type: description: The machine type. enum: - q35 - i440fx type: string version: description: The machine version. type: string type: object type: array description: OK summary: Get available QEMU/KVM machine types. /nodes/{node}/capabilities/qemu/migration: get: operationId: get_nodes_node_capabilities_qemu_migration parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: has-dbus-vmstate: description: Whether the host supports live-migrating additional VM state via the dbus-vmstate helper. type: boolean type: object description: OK summary: Get node-specific QEMU migration capabilities of the node. Requires the 'Sys.Audit' permission on '/nodes/'. /nodes/{node}/ceph: get: operationId: get_nodes_node_ceph parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Directory index. /nodes/{node}/ceph/cfg: get: operationId: get_nodes_node_ceph_cfg parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Directory index. /nodes/{node}/ceph/cfg/db: get: operationId: get_nodes_node_ceph_cfg_db parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: can_update_at_runtime: description: Set if the value can be changed at runtime without restarting the affected daemons. Emitted as the integer 1/0 to match the existing PVE wire convention. type: boolean level: description: 'Config level the entry is exposed at: ''basic'' for operator-visible settings, ''advanced'' for tuning parameters, ''dev'' for developer-only knobs.' enum: - basic - advanced - dev type: string mask: description: 'Match expression restricting the entry''s scope; empty when the entry has no mask. Examples: ''host:foo'', ''class:ssd''.' type: string name: description: Config key name. type: string section: description: 'Ceph config section the entry applies to: ''global'', a daemon type (''mon'', ''osd'', ''mgr'', ''mds'', ''client''), or a specific daemon (e.g. ''osd.0'', ''mon.'').' type: string value: description: Configured value for the key (always serialised as a string by Ceph, regardless of the option's underlying type). type: string type: object type: array description: OK summary: Get the Ceph configuration database. /nodes/{node}/ceph/cfg/raw: get: operationId: get_nodes_node_ceph_cfg_raw parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: string description: OK summary: Get the Ceph configuration file. /nodes/{node}/ceph/cfg/value: get: operationId: get_nodes_node_ceph_cfg_value parameters: - description: List of
: items separated by semicolon, comma or space. in: query name: config-keys required: false schema: description: List of
: items separated by semicolon, comma or space. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: description: Two-level map of {section} -> {key} -> value. Underscores in section and key names are normalised to hyphens. type: object description: OK summary: Get configured values from either ceph.conf or the mon config DB. Underscores in section and key names are normalised to hyphens in the response, regardless of how they're written in the source. /nodes/{node}/ceph/cmd-safety: get: operationId: get_nodes_node_ceph_cmd_safety parameters: - description: Action to check in: query name: action required: false schema: description: Action to check enum: - stop - destroy type: string - description: ID of the service in: query name: id required: false schema: description: ID of the service type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Service type in: query name: service required: false schema: description: Service type enum: - osd - mon - mds type: string responses: "200": content: application/json: schema: properties: safe: description: True if Ceph reports the requested action is safe. type: boolean status: description: Human-readable status message from Ceph (typically the reason an action is not safe); absent when Ceph returned no message. type: string type: object description: OK summary: Heuristical check if it is safe to perform an action. /nodes/{node}/ceph/crush: get: operationId: get_nodes_node_ceph_crush parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: string description: OK summary: Get OSD crush map /nodes/{node}/ceph/fs: get: operationId: get_nodes_node_ceph_fs parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: data_pool: description: Name of the filesystem's first data pool. A CephFS can have more than one data pool; consumers interested in the full set should read 'data_pools' instead. Kept for backwards compatibility. type: string data_pool_ids: description: Numeric ids of the data pools. items: description: Data pool id. type: integer type: array data_pools: description: Names of all data pools assigned to the filesystem; a CephFS can have multiple data pools (e.g. replicated metadata plus EC data, or multiple device-class-specific data pools). items: description: Data pool name. type: string type: array metadata_pool: description: Name of the metadata pool. type: string metadata_pool_id: description: Numeric id of the metadata pool. type: integer name: description: The ceph filesystem name. type: string type: object type: array description: OK summary: Directory index. /nodes/{node}/ceph/fs/{name}: delete: operationId: delete_nodes_node_ceph_fs_name parameters: - description: The Ceph filesystem name. in: path name: name required: true schema: description: The Ceph filesystem name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Remove the metadata and data pools used by this filesystem. in: query name: remove-pools required: false schema: description: Remove the metadata and data pools used by this filesystem. type: boolean - description: Remove pveceph-managed storages configured for this filesystem. in: query name: remove-storages required: false schema: description: Remove pveceph-managed storages configured for this filesystem. type: boolean responses: "200": content: application/json: schema: type: string description: OK summary: Destroy a Ceph filesystem. Refuses if any PVE storage entry of type 'cephfs' still references the filesystem and is not disabled. Optionally also removes the storage entries and/or the underlying metadata and data pools. post: operationId: post_nodes_node_ceph_fs_name parameters: - description: Configure the created CephFS as storage for this cluster. in: query name: add-storage required: false schema: description: Configure the created CephFS as storage for this cluster. type: boolean - description: The ceph filesystem name. in: path name: name required: true schema: description: The ceph filesystem name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. in: query name: pg_num required: false schema: description: Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. type: integer requestBody: content: application/json: schema: properties: add-storage: description: Configure the created CephFS as storage for this cluster. type: boolean name: description: The ceph filesystem name. type: string node: description: The cluster node name. format: pve-node type: string pg_num: description: Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create a Ceph filesystem /nodes/{node}/ceph/init: post: operationId: post_nodes_node_ceph_init parameters: - description: Declare a separate cluster network, OSDs will route heartbeat, object replication and recovery traffic over it in: query name: cluster-network required: false schema: description: Declare a separate cluster network, OSDs will route heartbeat, object replication and recovery traffic over it format: CIDR type: string - description: |- Disable cephx authentication. WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private! in: query name: disable_cephx required: false schema: description: |- Disable cephx authentication. WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private! type: boolean - description: Minimum number of available replicas per object to allow I/O in: query name: min_size required: false schema: description: Minimum number of available replicas per object to allow I/O type: integer - description: Use specific network for all ceph related traffic in: query name: network required: false schema: description: Use specific network for all ceph related traffic format: CIDR type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: |- Placement group bits, used to specify the default number of placement groups. Depreacted. This setting was deprecated in recent Ceph versions. in: query name: pg_bits required: false schema: description: |- Placement group bits, used to specify the default number of placement groups. Depreacted. This setting was deprecated in recent Ceph versions. type: integer - description: Targeted number of replicas per object in: query name: size required: false schema: description: Targeted number of replicas per object type: integer requestBody: content: application/json: schema: properties: cluster-network: description: Declare a separate cluster network, OSDs will route heartbeat, object replication and recovery traffic over it format: CIDR type: string disable_cephx: description: |- Disable cephx authentication. WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private! type: boolean min_size: description: Minimum number of available replicas per object to allow I/O type: integer network: description: Use specific network for all ceph related traffic format: CIDR type: string node: description: The cluster node name. format: pve-node type: string pg_bits: description: |- Placement group bits, used to specify the default number of placement groups. Depreacted. This setting was deprecated in recent Ceph versions. type: integer size: description: Targeted number of replicas per object type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: 'Create the initial Ceph default configuration and set up symlinks. Idempotent on re-call: if a [global] section already exists in ceph.conf, the existing fsid / auth / pool defaults are preserved and most parameters are silently ignored.' /nodes/{node}/ceph/log: get: operationId: get_nodes_node_ceph_log parameters: - description: Maximum number of log lines to return. Defaults to the dump_logfile limit (typically 50) when omitted. in: query name: limit required: false schema: description: Maximum number of log lines to return. Defaults to the dump_logfile limit (typically 50) when omitted. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Offset of the first log line to return (0-based). in: query name: start required: false schema: description: Offset of the first log line to return (0-based). type: integer responses: "200": content: application/json: schema: items: properties: "n": description: Log-file line number (1-based). type: integer t: description: Log line text. type: string type: object type: array description: OK summary: Read ceph log /nodes/{node}/ceph/mds: get: operationId: get_nodes_node_ceph_mds parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: addr: description: Address as advertised by the MDS; Ceph-formatted (typically 'IP:PORT/NONCE'). type: string ceph_version: description: Full Ceph version string of the MDS daemon. type: string ceph_version_short: description: Short Ceph version string of the MDS daemon (e.g. '19.2.0'). type: string direxists: description: Set when the MDS's data directory exists on this node. type: boolean fs_name: description: Name of the CephFS this MDS is bound to; absent or null for standby MDSes not currently serving a rank. type: string host: description: Host the MDS runs on. type: string name: description: The name (ID) for the MDS. type: string rank: description: MDS rank within the file system; -1 for standby MDSes not currently bound to a rank. type: integer service: description: Set if a ceph-mds@ systemd unit is enabled on the hosting node; absent otherwise. type: boolean standby_replay: description: If true, the standby MDS is polling the active MDS for faster recovery (hot standby). type: boolean state: description: 'MDS state: Ceph-reported run state (e.g. ''up:active'', ''up:standby'', ''up:standby-replay'') for daemons known to the cluster; ''stopped'' or ''unknown'' for configured daemons not visible to the cluster.' type: string type: object type: array description: OK summary: MDS directory index. /nodes/{node}/ceph/mds/{name}: delete: operationId: delete_nodes_node_ceph_mds_name parameters: - description: The name (ID) of the mds in: path name: name required: true schema: description: The name (ID) of the mds type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: string description: OK summary: Destroy Ceph Metadata Server post: operationId: post_nodes_node_ceph_mds_name parameters: - description: Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources. in: query name: hotstandby required: false schema: description: Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources. type: boolean - description: The ID for the mds, when omitted the same as the nodename in: path name: name required: true schema: description: The ID for the mds, when omitted the same as the nodename type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: hotstandby: description: Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources. type: boolean name: description: The ID for the mds, when omitted the same as the nodename type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create Ceph Metadata Server (MDS) /nodes/{node}/ceph/mgr: get: operationId: get_nodes_node_ceph_mgr parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: addr: description: Address as advertised by the manager; Ceph-formatted (typically 'IP:PORT/NONCE'). type: string ceph_version: description: Full Ceph version string of the manager daemon. type: string ceph_version_short: description: Short Ceph version string of the manager daemon (e.g. '19.2.0'). type: string direxists: description: Set when the manager's data directory exists on this node. type: boolean host: description: Host the manager runs on. type: string name: description: The name (ID) for the MGR. type: string service: description: Set if a ceph-mgr@ systemd unit is enabled on the hosting node; absent otherwise. type: boolean state: description: 'Manager state: ''active'' or ''standby'' for daemons visible to the mgr cluster, ''stopped'' or ''unknown'' for configured daemons not currently visible.' type: string type: object type: array description: OK summary: MGR directory index. /nodes/{node}/ceph/mgr/{id}: delete: operationId: delete_nodes_node_ceph_mgr_id parameters: - description: The ID of the manager in: path name: id required: true schema: description: The ID of the manager type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: string description: OK summary: Destroy Ceph Manager. post: operationId: post_nodes_node_ceph_mgr_id parameters: - description: The ID for the manager, when omitted the same as the nodename. in: path name: id required: true schema: description: The ID for the manager, when omitted the same as the nodename. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: id: description: The ID for the manager, when omitted the same as the nodename. type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create Ceph Manager /nodes/{node}/ceph/mon: get: operationId: get_nodes_node_ceph_mon parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: addr: description: Address as advertised by the monitor; Ceph-formatted (typically 'IP:PORT/NONCE', possibly as a messenger-v2 vector depending on Ceph version and ceph.conf shape). type: string ceph_version: description: Full Ceph version string of the monitor daemon. type: string ceph_version_short: description: Short Ceph version string of the monitor daemon (e.g. '19.2.0'). type: string direxists: description: Set when the monitor's data directory exists on this node. type: boolean host: description: Host the monitor runs on. type: string name: description: Monitor id (typically the hostname). type: string quorum: description: Set when the monitor is part of the current quorum. type: boolean rank: description: Rank of the monitor within the mon map. type: integer service: description: Set if a ceph-mon@ systemd unit is enabled on the hosting node; absent otherwise. type: boolean state: description: 'Run state of the monitor: ''running'' (in quorum), ''stopped'' (systemd unit configured but daemon not visible to the cluster), or ''unknown'' (no rados access).' type: string type: object type: array description: OK summary: Get Ceph monitor list. /nodes/{node}/ceph/mon/{monid}: delete: operationId: delete_nodes_node_ceph_mon_monid parameters: - description: Monitor ID in: path name: monid required: true schema: description: Monitor ID type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: string description: OK summary: Destroy a Ceph Monitor. Refuses to remove the last monitor of the cluster. Does not destroy any Manager on the same node; use /nodes/{node}/ceph/mgr/{id} for that. post: operationId: post_nodes_node_ceph_mon_monid parameters: - description: Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph. in: query name: mon-address required: false schema: description: Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph. format: ip-list type: string - description: The ID for the monitor, when omitted the same as the nodename. in: path name: monid required: true schema: description: The ID for the monitor, when omitted the same as the nodename. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: mon-address: description: Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph. format: ip-list type: string monid: description: The ID for the monitor, when omitted the same as the nodename. type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create a Ceph Monitor. Also auto-creates a Manager for the first monitor. /nodes/{node}/ceph/osd: get: operationId: get_nodes_node_ceph_osd parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: flags: description: Comma-joined list of currently-set OSD flags; absent when no flags are set on the cluster. type: string root: description: Top-level CRUSH bucket; recursive structure with 'children' lists holding nested buckets and OSD leaves. Per-node properties (status, weight, in, usage, latencies, etc.) vary by node type and are not statically typed here. type: object type: object description: OK summary: Get Ceph osd list/tree. post: operationId: post_nodes_node_ceph_osd parameters: - description: Set the device class of the OSD in crush. in: query name: crush-device-class required: false schema: description: Set the device class of the OSD in crush. type: string - description: Block device name for block.db. in: query name: db_dev required: false schema: description: Block device name for block.db. type: string - description: Size in GiB for block.db. in: query name: db_dev_size required: false schema: description: Size in GiB for block.db. type: number - description: Block device name. in: query name: dev required: false schema: description: Block device name. type: string - description: Enables encryption of the OSD. in: query name: encrypted required: false schema: description: Enables encryption of the OSD. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: OSD services per physical device. Only useful for fast NVMe devices to utilize their performance better. Mutually exclusive with 'db_dev' and 'wal_dev'. in: query name: osds-per-device required: false schema: description: OSD services per physical device. Only useful for fast NVMe devices to utilize their performance better. Mutually exclusive with 'db_dev' and 'wal_dev'. type: integer - description: Block device name for block.wal. in: query name: wal_dev required: false schema: description: Block device name for block.wal. type: string - description: Size in GiB for block.wal. in: query name: wal_dev_size required: false schema: description: Size in GiB for block.wal. type: number requestBody: content: application/json: schema: properties: crush-device-class: description: Set the device class of the OSD in crush. type: string db_dev: description: Block device name for block.db. type: string db_dev_size: description: Size in GiB for block.db. type: number dev: description: Block device name. type: string encrypted: description: Enables encryption of the OSD. type: boolean node: description: The cluster node name. format: pve-node type: string osds-per-device: description: OSD services per physical device. Only useful for fast NVMe devices to utilize their performance better. Mutually exclusive with 'db_dev' and 'wal_dev'. type: integer wal_dev: description: Block device name for block.wal. type: string wal_dev_size: description: Size in GiB for block.wal. type: number type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create OSD /nodes/{node}/ceph/osd/{osdid}: delete: operationId: delete_nodes_node_ceph_osd_osdid parameters: - description: If set, also destroy the underlying logical volumes via 'ceph-volume lvm zap --destroy', remove the volume group's physical volume with pvremove, and wipe any journal/block.db/block.wal partitions left over from filestore OSDs. Without this flag the LVs and partitions are left intact for inspection. in: query name: cleanup required: false schema: description: If set, also destroy the underlying logical volumes via 'ceph-volume lvm zap --destroy', remove the volume group's physical volume with pvremove, and wipe any journal/block.db/block.wal partitions left over from filestore OSDs. Without this flag the LVs and partitions are left intact for inspection. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: OSD ID in: path name: osdid required: true schema: description: OSD ID type: integer responses: "200": content: application/json: schema: type: string description: OK summary: Destroy OSD get: operationId: get_nodes_node_ceph_osd_osdid parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: OSD ID in: path name: osdid required: true schema: description: OSD ID type: integer responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: OSD index. /nodes/{node}/ceph/osd/{osdid}/in: post: operationId: post_nodes_node_ceph_osd_osdid_in parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: OSD ID in: path name: osdid required: true schema: description: OSD ID type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string osdid: description: OSD ID type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: ceph osd in /nodes/{node}/ceph/osd/{osdid}/lv-info: get: operationId: get_nodes_node_ceph_osd_osdid_lv_info parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: OSD ID in: path name: osdid required: true schema: description: OSD ID type: integer - description: OSD device type in: query name: type required: false schema: description: OSD device type enum: - block - db - wal type: string responses: "200": content: application/json: schema: properties: creation_time: description: Creation time as reported by `lvs`. type: string lv_name: description: Name of the logical volume (LV). type: string lv_path: description: Path to the logical volume (LV). type: string lv_size: description: Size of the logical volume (LV). type: integer lv_uuid: description: UUID of the logical volume (LV). type: string vg_name: description: Name of the volume group (VG). type: string type: object description: OK summary: Get OSD volume details /nodes/{node}/ceph/osd/{osdid}/metadata: get: operationId: get_nodes_node_ceph_osd_osdid_metadata parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: OSD ID in: path name: osdid required: true schema: description: OSD ID type: integer responses: "200": content: application/json: schema: properties: devices: description: Array containing data about devices items: properties: dev_node: description: Device node type: string device: description: Kind of OSD device enum: - block - db - wal type: string physical_device: description: Underlying physical device(s) used by this OSD device (comma- or space-joined when multiple). type: string size: description: Size of the OSD device in bytes. type: integer support_discard: description: Whether the underlying physical device supports discard/TRIM. type: boolean type: description: Type of device. For example, hdd or ssd type: string type: object type: array osd: description: General information about the OSD properties: back_addr: description: Address and port used to talk to other OSDs. type: string encrypted: description: Whether the OSD is encrypted with LUKS via dm-crypt. type: boolean front_addr: description: Address and port used to talk to clients and monitors. type: string hb_back_addr: description: Heartbeat address and port for other OSDs. type: string hb_front_addr: description: Heartbeat address and port for clients and monitors. type: string hostname: description: Name of the host containing the OSD. type: string id: description: ID of the OSD. type: integer mem_usage: description: Proportional set size (PSS) memory usage of the OSD daemon process in bytes; 0 when the process is not running. type: integer osd_data: description: Path to the OSD's data directory. type: string osd_objectstore: description: The type of object store used. type: string pid: description: OSD process ID; absent if the systemd unit for this OSD is not currently running. type: integer version: description: Ceph version of the OSD service. type: string type: object type: object description: OK summary: Get OSD details /nodes/{node}/ceph/osd/{osdid}/out: post: operationId: post_nodes_node_ceph_osd_osdid_out parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: OSD ID in: path name: osdid required: true schema: description: OSD ID type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string osdid: description: OSD ID type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: ceph osd out /nodes/{node}/ceph/osd/{osdid}/scrub: post: operationId: post_nodes_node_ceph_osd_osdid_scrub parameters: - description: If set, instructs a deep scrub instead of a normal one. in: query name: deep required: false schema: description: If set, instructs a deep scrub instead of a normal one. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: OSD ID in: path name: osdid required: true schema: description: OSD ID type: integer requestBody: content: application/json: schema: properties: deep: description: If set, instructs a deep scrub instead of a normal one. type: boolean node: description: The cluster node name. format: pve-node type: string osdid: description: OSD ID type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Instruct the OSD to scrub. /nodes/{node}/ceph/pool: get: operationId: get_nodes_node_ceph_pool parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: application_metadata: description: Application tags attached to the pool (mapping of application name to its metadata object). type: object autoscale_status: description: Raw pg_autoscaler status object for this pool; shape varies between Ceph releases. type: object bytes_used: description: Bytes currently used in the pool; absent if no usage statistics are reported. type: integer crush_rule: description: Numeric id of the CRUSH rule used by this pool. type: integer crush_rule_name: description: Human-readable name of the CRUSH rule used by this pool; absent if the rule id is not in the current CRUSH map. type: string min_size: description: Minimum number of replicas required to accept writes. type: integer percent_used: description: Percentage of pool capacity currently used; absent if no usage statistics are reported. type: number pg_autoscale_mode: description: Placement-group autoscaler mode ('on', 'warn' or 'off'). type: string pg_num: description: Current placement-group count. type: integer pg_num_final: description: Optimal placement-group count computed by pg_autoscaler. type: integer pg_num_min: description: Minimum placement-group count the pg_autoscaler may choose. type: integer pool: description: Numeric pool id assigned by Ceph. type: integer pool_name: description: Operator-visible name of the pool. type: string size: description: Replication factor (target number of object replicas). type: integer target_size: description: Operator-supplied target size in bytes; hints the pg_autoscaler. type: integer target_size_ratio: description: Operator-supplied target ratio of total pool capacity; hints the pg_autoscaler. type: number type: description: 'Pool type: ''replicated'' for n-way replication, ''erasure'' for an erasure-coded pool, ''unknown'' for types PVE does not yet map.' enum: - replicated - erasure - unknown type: string type: object type: array description: OK summary: List all pools and their settings (which are settable by the POST/PUT endpoints). post: operationId: post_nodes_node_ceph_pool parameters: - description: Configure VM and CT storage using the new pool. Defaults to false for replicated pools and to true for erasure-coded pools (since EC pools are typically only useful when wired up to storage). in: query name: add_storages required: false schema: description: Configure VM and CT storage using the new pool. Defaults to false for replicated pools and to true for erasure-coded pools (since EC pools are typically only useful when wired up to storage). type: boolean - description: The application of the pool. in: query name: application required: false schema: description: The application of the pool. enum: - rbd - cephfs - rgw type: string - description: The rule to use for mapping object placement in the cluster. in: query name: crush_rule required: false schema: description: The rule to use for mapping object placement in the cluster. type: string - description: Create an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool. in: query name: erasure-coding required: false schema: description: Create an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool. type: string - description: Minimum number of replicas per object in: query name: min_size required: false schema: description: Minimum number of replicas per object type: integer - description: The name of the pool. It must be unique. in: query name: name required: false schema: description: The name of the pool. It must be unique. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The automatic PG scaling mode of the pool. in: query name: pg_autoscale_mode required: false schema: description: The automatic PG scaling mode of the pool. enum: - "on" - "off" - warn type: string - description: Number of placement groups. in: query name: pg_num required: false schema: description: Number of placement groups. type: integer - description: Minimal number of placement groups. in: query name: pg_num_min required: false schema: description: Minimal number of placement groups. type: integer - description: Number of replicas per object in: query name: size required: false schema: description: Number of replicas per object type: integer - description: The estimated target size of the pool for the PG autoscaler. in: query name: target_size required: false schema: description: The estimated target size of the pool for the PG autoscaler. type: string - description: The estimated target ratio of the pool for the PG autoscaler. in: query name: target_size_ratio required: false schema: description: The estimated target ratio of the pool for the PG autoscaler. type: number requestBody: content: application/json: schema: properties: add_storages: description: Configure VM and CT storage using the new pool. Defaults to false for replicated pools and to true for erasure-coded pools (since EC pools are typically only useful when wired up to storage). type: boolean application: description: The application of the pool. enum: - rbd - cephfs - rgw type: string crush_rule: description: The rule to use for mapping object placement in the cluster. type: string erasure-coding: description: Create an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool. type: string min_size: description: Minimum number of replicas per object type: integer name: description: The name of the pool. It must be unique. type: string node: description: The cluster node name. format: pve-node type: string pg_autoscale_mode: description: The automatic PG scaling mode of the pool. enum: - "on" - "off" - warn type: string pg_num: description: Number of placement groups. type: integer pg_num_min: description: Minimal number of placement groups. type: integer size: description: Number of replicas per object type: integer target_size: description: The estimated target size of the pool for the PG autoscaler. type: string target_size_ratio: description: The estimated target ratio of the pool for the PG autoscaler. type: number type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create Ceph pool /nodes/{node}/ceph/pool/{name}: delete: operationId: delete_nodes_node_ceph_pool_name parameters: - description: If true, destroys pool even if in use in: query name: force required: false schema: description: If true, destroys pool even if in use type: boolean - description: The name of the pool. It must be unique. in: path name: name required: true schema: description: The name of the pool. It must be unique. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Remove the erasure code profile. Defaults to true, if applicable. in: query name: remove_ecprofile required: false schema: description: Remove the erasure code profile. Defaults to true, if applicable. type: boolean - description: Remove all pveceph-managed storages configured for this pool in: query name: remove_storages required: false schema: description: Remove all pveceph-managed storages configured for this pool type: boolean responses: "200": content: application/json: schema: type: string description: OK summary: Destroy pool get: operationId: get_nodes_node_ceph_pool_name parameters: - description: The name of the pool. in: path name: name required: true schema: description: The name of the pool. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Pool index. put: operationId: put_nodes_node_ceph_pool_name parameters: - description: The application of the pool. in: query name: application required: false schema: description: The application of the pool. enum: - rbd - cephfs - rgw type: string - description: The rule to use for mapping object placement in the cluster. in: query name: crush_rule required: false schema: description: The rule to use for mapping object placement in the cluster. type: string - description: Minimum number of replicas per object in: query name: min_size required: false schema: description: Minimum number of replicas per object type: integer - description: The name of the pool. It must be unique. in: path name: name required: true schema: description: The name of the pool. It must be unique. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The automatic PG scaling mode of the pool. in: query name: pg_autoscale_mode required: false schema: description: The automatic PG scaling mode of the pool. enum: - "on" - "off" - warn type: string - description: Number of placement groups. in: query name: pg_num required: false schema: description: Number of placement groups. type: integer - description: Minimal number of placement groups. in: query name: pg_num_min required: false schema: description: Minimal number of placement groups. type: integer - description: Number of replicas per object in: query name: size required: false schema: description: Number of replicas per object type: integer - description: The estimated target size of the pool for the PG autoscaler. in: query name: target_size required: false schema: description: The estimated target size of the pool for the PG autoscaler. type: string - description: The estimated target ratio of the pool for the PG autoscaler. in: query name: target_size_ratio required: false schema: description: The estimated target ratio of the pool for the PG autoscaler. type: number requestBody: content: application/json: schema: properties: application: description: The application of the pool. enum: - rbd - cephfs - rgw type: string crush_rule: description: The rule to use for mapping object placement in the cluster. type: string min_size: description: Minimum number of replicas per object type: integer name: description: The name of the pool. It must be unique. type: string node: description: The cluster node name. format: pve-node type: string pg_autoscale_mode: description: The automatic PG scaling mode of the pool. enum: - "on" - "off" - warn type: string pg_num: description: Number of placement groups. type: integer pg_num_min: description: Minimal number of placement groups. type: integer size: description: Number of replicas per object type: integer target_size: description: The estimated target size of the pool for the PG autoscaler. type: string target_size_ratio: description: The estimated target ratio of the pool for the PG autoscaler. type: number type: object responses: "200": content: application/json: schema: type: string description: OK summary: Change POOL settings /nodes/{node}/ceph/pool/{name}/status: get: operationId: get_nodes_node_ceph_pool_name_status parameters: - description: The name of the pool. It must be unique. in: path name: name required: true schema: description: The name of the pool. It must be unique. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: If enabled, will display additional data(eg. statistics). in: query name: verbose required: false schema: description: If enabled, will display additional data(eg. statistics). type: boolean responses: "200": content: application/json: schema: properties: application: description: The application of the pool. enum: - rbd - cephfs - rgw type: string application_list: description: Names of applications currently associated with the pool. items: description: Application name (e.g. 'rbd', 'cephfs', 'rgw'). type: string type: array autoscale_status: description: Raw pg_autoscaler status object for this pool; shape varies between Ceph releases. type: object crush_rule: description: The rule to use for mapping object placement in the cluster. type: string fast_read: description: Set if the pool uses fast-read for erasure-coded reads. type: boolean hashpspool: description: Set if the pool hashes pool id into its CRUSH placement-seed. type: boolean id: description: Numeric pool id assigned by Ceph. type: integer min_size: description: Minimum number of replicas per object type: integer name: description: The name of the pool. It must be unique. type: string nodeep-scrub: description: Set if deep-scrubbing is disabled for this pool. type: boolean nodelete: description: Set if pool delete is blocked. type: boolean nopgchange: description: Set if changing the placement-group count is blocked. type: boolean noscrub: description: Set if scrubbing is disabled for this pool. type: boolean nosizechange: description: Set if changing the replication size is blocked. type: boolean pg_autoscale_mode: description: The automatic PG scaling mode of the pool. enum: - "on" - "off" - warn type: string pg_num: description: Number of placement groups. type: integer pg_num_min: description: Minimal number of placement groups. type: integer pgp_num: description: Placement-group-for-placement count. type: integer size: description: Number of replicas per object type: integer statistics: description: Optional pool usage and IO statistics (only present when verbose=1 is requested). type: object target_size: description: The estimated target size of the pool for the PG autoscaler. type: string target_size_ratio: description: The estimated target ratio of the pool for the PG autoscaler. type: number use_gmt_hitset: description: Set if hitsets use GMT timestamps (for cache-tier pools). type: boolean write_fadvise_dontneed: description: Set if the pool sets the FADV_DONTNEED hint on writes. type: boolean type: object description: OK summary: Show the current pool status. /nodes/{node}/ceph/restart: post: operationId: post_nodes_node_ceph_restart parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Ceph service name. in: query name: service required: false schema: description: Ceph service name. type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string service: description: Ceph service name. type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Restart ceph services. /nodes/{node}/ceph/rules: get: operationId: get_nodes_node_ceph_rules parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: name: description: Name of the CRUSH rule. type: string type: object type: array description: OK summary: List ceph rules. /nodes/{node}/ceph/start: post: operationId: post_nodes_node_ceph_start parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Ceph service name. in: query name: service required: false schema: description: Ceph service name. type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string service: description: Ceph service name. type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Start ceph services. /nodes/{node}/ceph/status: get: operationId: get_nodes_node_ceph_status parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: object description: OK summary: Get the Ceph cluster status (raw 'ceph status' output). The response is cluster-wide and identical to /cluster/ceph/status; this node-level alias exists for operator convenience. /nodes/{node}/ceph/stop: post: operationId: post_nodes_node_ceph_stop parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Ceph service name. in: query name: service required: false schema: description: Ceph service name. type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string service: description: Ceph service name. type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Stop ceph services. /nodes/{node}/certificates: get: operationId: get_nodes_node_certificates parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Node index. /nodes/{node}/certificates/acme: get: operationId: get_nodes_node_certificates_acme parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: ACME index. /nodes/{node}/certificates/acme/certificate: delete: operationId: delete_nodes_node_certificates_acme_certificate parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: string description: OK summary: Revoke existing certificate from CA. post: operationId: post_nodes_node_certificates_acme_certificate parameters: - description: Overwrite existing custom certificate. in: query name: force required: false schema: description: Overwrite existing custom certificate. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: force: description: Overwrite existing custom certificate. type: boolean node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Order a new certificate from ACME-compatible CA. put: operationId: put_nodes_node_certificates_acme_certificate parameters: - description: Force renewal even if expiry is more than 30 days away. in: query name: force required: false schema: description: Force renewal even if expiry is more than 30 days away. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: force: description: Force renewal even if expiry is more than 30 days away. type: boolean node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Renew existing certificate from CA. /nodes/{node}/certificates/custom: delete: operationId: delete_nodes_node_certificates_custom parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Restart pveproxy. in: query name: restart required: false schema: description: Restart pveproxy. type: boolean responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: DELETE custom certificate chain and key. post: operationId: post_nodes_node_certificates_custom parameters: - description: PEM encoded certificate (chain). in: query name: certificates required: false schema: description: PEM encoded certificate (chain). format: pem-certificate-chain type: string - description: Overwrite existing custom or ACME certificate files. in: query name: force required: false schema: description: Overwrite existing custom or ACME certificate files. type: boolean - description: PEM encoded private key. in: query name: key required: false schema: description: PEM encoded private key. format: pem-string type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Restart pveproxy. in: query name: restart required: false schema: description: Restart pveproxy. type: boolean requestBody: content: application/json: schema: properties: certificates: description: PEM encoded certificate (chain). format: pem-certificate-chain type: string force: description: Overwrite existing custom or ACME certificate files. type: boolean key: description: PEM encoded private key. format: pem-string type: string node: description: The cluster node name. format: pve-node type: string restart: description: Restart pveproxy. type: boolean type: object responses: "200": content: application/json: schema: properties: filename: type: string fingerprint: description: Certificate SHA 256 fingerprint. type: string issuer: description: Certificate issuer name. type: string notafter: description: Certificate's notAfter timestamp (UNIX epoch). type: integer notbefore: description: Certificate's notBefore timestamp (UNIX epoch). type: integer pem: description: Certificate in PEM format format: pem-certificate type: string public-key-bits: description: Certificate's public key size type: integer public-key-type: description: Certificate's public key algorithm type: string san: description: List of Certificate's SubjectAlternativeName entries. items: type: string type: array subject: description: Certificate subject name. type: string type: object description: OK summary: Upload or update custom certificate chain and key. /nodes/{node}/certificates/info: get: operationId: get_nodes_node_certificates_info parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: filename: type: string fingerprint: description: Certificate SHA 256 fingerprint. type: string issuer: description: Certificate issuer name. type: string notafter: description: Certificate's notAfter timestamp (UNIX epoch). type: integer notbefore: description: Certificate's notBefore timestamp (UNIX epoch). type: integer pem: description: Certificate in PEM format format: pem-certificate type: string public-key-bits: description: Certificate's public key size type: integer public-key-type: description: Certificate's public key algorithm type: string san: description: List of Certificate's SubjectAlternativeName entries. items: type: string type: array subject: description: Certificate subject name. type: string type: object type: array description: OK summary: Get information about node's certificates. /nodes/{node}/config: get: operationId: get_nodes_node_config parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Return only a specific property from the node configuration. in: query name: property required: false schema: description: Return only a specific property from the node configuration. enum: - acme - acmedomain0 - acmedomain1 - acmedomain2 - acmedomain3 - acmedomain4 - acmedomain5 - ballooning-target - description - location - startall-onboot-delay - wakeonlan type: string responses: "200": content: application/json: schema: properties: acme: description: Node specific ACME settings. type: string acmedomain[n]: description: ACME domain and validation plugin type: string ballooning-target: description: RAM usage target for ballooning (in percent of total memory) type: integer description: description: Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. type: string digest: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string location: description: The location of the node. Overrides the default from the datacenter config. type: string startall-onboot-delay: description: Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. type: integer wakeonlan: description: Node specific wake on LAN settings. type: string type: object description: OK summary: Get node configuration options. put: operationId: put_nodes_node_config parameters: - description: Node specific ACME settings. in: query name: acme required: false schema: description: Node specific ACME settings. type: string - description: ACME domain and validation plugin in: query name: acmedomain[n] required: false schema: description: ACME domain and validation plugin type: string - description: RAM usage target for ballooning (in percent of total memory) in: query name: ballooning-target required: false schema: description: RAM usage target for ballooning (in percent of total memory) type: integer - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. in: query name: description required: false schema: description: Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. type: string - description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string - description: The location of the node. Overrides the default from the datacenter config. in: query name: location required: false schema: description: The location of the node. Overrides the default from the datacenter config. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. in: query name: startall-onboot-delay required: false schema: description: Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. type: integer - description: Node specific wake on LAN settings. in: query name: wakeonlan required: false schema: description: Node specific wake on LAN settings. type: string requestBody: content: application/json: schema: properties: acme: description: Node specific ACME settings. type: string acmedomain[n]: description: ACME domain and validation plugin type: string ballooning-target: description: RAM usage target for ballooning (in percent of total memory) type: integer delete: description: A list of settings you want to delete. format: pve-configid-list type: string description: description: Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. type: string digest: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string location: description: The location of the node. Overrides the default from the datacenter config. type: string node: description: The cluster node name. format: pve-node type: string startall-onboot-delay: description: Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. type: integer wakeonlan: description: Node specific wake on LAN settings. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set node configuration options. /nodes/{node}/disks: get: operationId: get_nodes_node_disks parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Node index. /nodes/{node}/disks/directory: get: operationId: get_nodes_node_disks_directory parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: device: description: The mounted device. type: string options: description: The mount options. type: string path: description: The mount path. type: string type: description: The filesystem type. type: string unitfile: description: The path of the mount unit. type: string type: object type: array description: OK summary: PVE Managed Directory storages. post: operationId: post_nodes_node_disks_directory parameters: - description: Configure storage using the directory. in: query name: add_storage required: false schema: description: Configure storage using the directory. type: boolean - description: The block device you want to create the filesystem on. in: query name: device required: false schema: description: The block device you want to create the filesystem on. type: string - description: The desired filesystem. in: query name: filesystem required: false schema: description: The desired filesystem. enum: - ext4 - xfs type: string - description: The storage identifier. in: query name: name required: false schema: description: The storage identifier. format: pve-storage-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: add_storage: description: Configure storage using the directory. type: boolean device: description: The block device you want to create the filesystem on. type: string filesystem: description: The desired filesystem. enum: - ext4 - xfs type: string name: description: The storage identifier. format: pve-storage-id type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create a Filesystem on an unused disk. Will be mounted under '/mnt/pve/NAME'. /nodes/{node}/disks/directory/{name}: delete: operationId: delete_nodes_node_disks_directory_name parameters: - description: Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). in: query name: cleanup-config required: false schema: description: Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). type: boolean - description: Also wipe disk so it can be repurposed afterwards. in: query name: cleanup-disks required: false schema: description: Also wipe disk so it can be repurposed afterwards. type: boolean - description: The storage identifier. in: path name: name required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: string description: OK summary: Unmounts the storage and removes the mount unit. /nodes/{node}/disks/initgpt: post: operationId: post_nodes_node_disks_initgpt parameters: - description: Block device name in: query name: disk required: false schema: description: Block device name type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: UUID for the GPT table in: query name: uuid required: false schema: description: UUID for the GPT table type: string requestBody: content: application/json: schema: properties: disk: description: Block device name type: string node: description: The cluster node name. format: pve-node type: string uuid: description: UUID for the GPT table type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Initialize Disk with GPT /nodes/{node}/disks/list: get: operationId: get_nodes_node_disks_list parameters: - description: Also include partitions. in: query name: include-partitions required: false schema: description: Also include partitions. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Skip smart checks. in: query name: skipsmart required: false schema: description: Skip smart checks. type: boolean - description: Only list specific types of disks. in: query name: type required: false schema: description: Only list specific types of disks. enum: - unused - journal_disks type: string responses: "200": content: application/json: schema: items: properties: devpath: description: The device path type: string gpt: type: boolean health: type: string model: type: string mounted: type: boolean osdid: type: integer osdid-list: items: type: integer type: array parent: description: For partitions only. The device path of the disk the partition resides on. type: string serial: type: string size: type: integer used: type: string vendor: type: string wwn: type: string type: object type: array description: OK summary: List local disks. /nodes/{node}/disks/lvm: get: operationId: get_nodes_node_disks_lvm parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: children: items: properties: children: description: The underlying physical volumes items: properties: free: description: The free bytes in the physical volume type: integer leaf: type: boolean name: description: The name of the physical volume type: string size: description: The size of the physical volume in bytes type: integer type: object type: array free: description: The free bytes in the volume group type: integer leaf: type: boolean name: description: The name of the volume group type: string size: description: The size of the volume group in bytes type: integer type: object type: array leaf: type: boolean type: object description: OK summary: List LVM Volume Groups post: operationId: post_nodes_node_disks_lvm parameters: - description: Configure storage using the Volume Group in: query name: add_storage required: false schema: description: Configure storage using the Volume Group type: boolean - description: The block device you want to create the volume group on in: query name: device required: false schema: description: The block device you want to create the volume group on type: string - description: The storage identifier. in: query name: name required: false schema: description: The storage identifier. format: pve-storage-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: add_storage: description: Configure storage using the Volume Group type: boolean device: description: The block device you want to create the volume group on type: string name: description: The storage identifier. format: pve-storage-id type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create an LVM Volume Group /nodes/{node}/disks/lvm/{name}: delete: operationId: delete_nodes_node_disks_lvm_name parameters: - description: Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). in: query name: cleanup-config required: false schema: description: Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). type: boolean - description: Also wipe disks so they can be repurposed afterwards. in: query name: cleanup-disks required: false schema: description: Also wipe disks so they can be repurposed afterwards. type: boolean - description: The storage identifier. in: path name: name required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: string description: OK summary: Remove an LVM Volume Group. /nodes/{node}/disks/lvmthin: get: operationId: get_nodes_node_disks_lvmthin parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: lv: description: The name of the thinpool. type: string lv_size: description: The size of the thinpool in bytes. type: integer metadata_size: description: The size of the metadata lv in bytes. type: integer metadata_used: description: The used bytes of the metadata lv. type: integer used: description: The used bytes of the thinpool. type: integer vg: description: The associated volume group. type: string type: object type: array description: OK summary: List LVM thinpools post: operationId: post_nodes_node_disks_lvmthin parameters: - description: Configure storage using the thinpool. in: query name: add_storage required: false schema: description: Configure storage using the thinpool. type: boolean - description: The block device you want to create the thinpool on. in: query name: device required: false schema: description: The block device you want to create the thinpool on. type: string - description: The storage identifier. in: query name: name required: false schema: description: The storage identifier. format: pve-storage-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: add_storage: description: Configure storage using the thinpool. type: boolean device: description: The block device you want to create the thinpool on. type: string name: description: The storage identifier. format: pve-storage-id type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create an LVM thinpool /nodes/{node}/disks/lvmthin/{name}: delete: operationId: delete_nodes_node_disks_lvmthin_name parameters: - description: Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). in: query name: cleanup-config required: false schema: description: Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). type: boolean - description: Also wipe disks so they can be repurposed afterwards. in: query name: cleanup-disks required: false schema: description: Also wipe disks so they can be repurposed afterwards. type: boolean - description: The storage identifier. in: path name: name required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: query name: volume-group required: false schema: description: The storage identifier. format: pve-storage-id type: string responses: "200": content: application/json: schema: type: string description: OK summary: Remove an LVM thin pool. /nodes/{node}/disks/smart: get: operationId: get_nodes_node_disks_smart parameters: - description: Block device name in: query name: disk required: false schema: description: Block device name type: string - description: If true returns only the health status in: query name: healthonly required: false schema: description: If true returns only the health status type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: attributes: type: array health: type: string text: type: string type: type: string type: object description: OK summary: Get SMART Health of a disk. /nodes/{node}/disks/wipedisk: put: operationId: put_nodes_node_disks_wipedisk parameters: - description: Block device name in: query name: disk required: false schema: description: Block device name type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: disk: description: Block device name type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Wipe a disk or partition. /nodes/{node}/disks/zfs: get: operationId: get_nodes_node_disks_zfs parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: alloc: type: integer dedup: type: number frag: type: integer free: type: integer health: type: string name: type: string size: type: integer type: object type: array description: OK summary: List Zpools. post: operationId: post_nodes_node_disks_zfs parameters: - description: Configure storage using the zpool. in: query name: add_storage required: false schema: description: Configure storage using the zpool. type: boolean - description: Pool sector size exponent. in: query name: ashift required: false schema: description: Pool sector size exponent. type: integer - description: The compression algorithm to use. in: query name: compression required: false schema: description: The compression algorithm to use. enum: - "on" - "off" - gzip - lz4 - lzjb - zle - zstd type: string - description: The block devices you want to create the zpool on. in: query name: devices required: false schema: description: The block devices you want to create the zpool on. format: string-list type: string - description: "" in: query name: draid-config required: false schema: type: string - description: The storage identifier. in: query name: name required: false schema: description: The storage identifier. format: pve-storage-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The RAID level to use. in: query name: raidlevel required: false schema: description: The RAID level to use. enum: - single - mirror - raid10 - raidz - raidz2 - raidz3 - draid - draid2 - draid3 type: string requestBody: content: application/json: schema: properties: add_storage: description: Configure storage using the zpool. type: boolean ashift: description: Pool sector size exponent. type: integer compression: description: The compression algorithm to use. enum: - "on" - "off" - gzip - lz4 - lzjb - zle - zstd type: string devices: description: The block devices you want to create the zpool on. format: string-list type: string draid-config: type: string name: description: The storage identifier. format: pve-storage-id type: string node: description: The cluster node name. format: pve-node type: string raidlevel: description: The RAID level to use. enum: - single - mirror - raid10 - raidz - raidz2 - raidz3 - draid - draid2 - draid3 type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create a ZFS pool. /nodes/{node}/disks/zfs/{name}: delete: operationId: delete_nodes_node_disks_zfs_name parameters: - description: Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). in: query name: cleanup-config required: false schema: description: Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). type: boolean - description: Also wipe disks so they can be repurposed afterwards. in: query name: cleanup-disks required: false schema: description: Also wipe disks so they can be repurposed afterwards. type: boolean - description: The storage identifier. in: path name: name required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: string description: OK summary: Destroy a ZFS pool. get: operationId: get_nodes_node_disks_zfs_name parameters: - description: The storage identifier. in: path name: name required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: action: description: Information about the recommended action to fix the state. type: string children: description: The pool configuration information, including the vdevs for each section (e.g. spares, cache), may be nested. items: properties: cksum: type: number msg: description: An optional message about the vdev. type: string name: description: The name of the vdev or section. type: string read: type: number state: description: The state of the vdev. type: string write: type: number type: object type: array errors: description: Information about the errors on the zpool. type: string name: description: The name of the zpool. type: string scan: description: Information about the last/current scrub. type: string state: description: The state of the zpool. type: string status: description: Information about the state of the zpool. type: string type: object description: OK summary: Get details about a zpool. /nodes/{node}/dns: get: operationId: get_nodes_node_dns parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: dns1: description: First name server IP address. type: string dns2: description: Second name server IP address. type: string dns3: description: Third name server IP address. type: string search: description: Search domain for host-name lookup. type: string type: object description: OK summary: Read DNS settings. put: operationId: put_nodes_node_dns parameters: - description: First name server IP address. in: query name: dns1 required: false schema: description: First name server IP address. format: ip type: string - description: Second name server IP address. in: query name: dns2 required: false schema: description: Second name server IP address. format: ip type: string - description: Third name server IP address. in: query name: dns3 required: false schema: description: Third name server IP address. format: ip type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Search domain for host-name lookup. in: query name: search required: false schema: description: Search domain for host-name lookup. type: string requestBody: content: application/json: schema: properties: dns1: description: First name server IP address. format: ip type: string dns2: description: Second name server IP address. format: ip type: string dns3: description: Third name server IP address. format: ip type: string node: description: The cluster node name. format: pve-node type: string search: description: Search domain for host-name lookup. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Write DNS settings. /nodes/{node}/execute: post: operationId: post_nodes_node_execute parameters: - description: JSON encoded array of commands. in: query name: commands required: false schema: description: JSON encoded array of commands. format: pve-command-batch type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: commands: description: JSON encoded array of commands. format: pve-command-batch type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Execute multiple commands in order, root only. /nodes/{node}/firewall: get: operationId: get_nodes_node_firewall parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Directory index. /nodes/{node}/firewall/log: get: operationId: get_nodes_node_firewall_log parameters: - description: "" in: query name: limit required: false schema: type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Display log since this UNIX epoch. in: query name: since required: false schema: description: Display log since this UNIX epoch. type: integer - description: "" in: query name: start required: false schema: type: integer - description: Display log until this UNIX epoch. in: query name: until required: false schema: description: Display log until this UNIX epoch. type: integer responses: "200": content: application/json: schema: items: properties: "n": description: Line number type: integer t: description: Line text type: string type: object type: array description: OK summary: Read firewall log /nodes/{node}/firewall/options: get: operationId: get_nodes_node_firewall_options parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: enable: description: Enable host firewall rules. type: boolean log_level_forward: description: Log level for forwarded traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string log_level_in: description: Log level for incoming traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string log_level_out: description: Log level for outgoing traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string log_nf_conntrack: description: Enable logging of conntrack information. type: boolean ndp: description: Enable NDP (Neighbor Discovery Protocol). type: boolean nf_conntrack_allow_invalid: description: Allow invalid packets on connection tracking. type: boolean nf_conntrack_helpers: description: 'Enable conntrack helpers for specific protocols. Supported protocols: amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp' format: pve-fw-conntrack-helper type: string nf_conntrack_max: description: Maximum number of tracked connections. type: integer nf_conntrack_tcp_timeout_established: description: Conntrack established timeout. type: integer nf_conntrack_tcp_timeout_syn_recv: description: Conntrack syn recv timeout. type: integer nftables: description: Enable nftables based firewall (tech preview) type: boolean nosmurfs: description: Enable SMURFS filter. type: boolean protection_synflood: description: Enable synflood protection type: boolean protection_synflood_burst: description: Synflood protection rate burst by ip src. type: integer protection_synflood_rate: description: Synflood protection rate syn/sec by ip src. type: integer smurf_log_level: description: Log level for SMURFS filter. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string tcp_flags_log_level: description: Log level for illegal tcp flags filter. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string tcpflags: description: Filter illegal combinations of TCP flags. type: boolean type: object description: OK summary: Get host firewall options. put: operationId: put_nodes_node_firewall_options parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Enable host firewall rules. in: query name: enable required: false schema: description: Enable host firewall rules. type: boolean - description: Log level for forwarded traffic. in: query name: log_level_forward required: false schema: description: Log level for forwarded traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Log level for incoming traffic. in: query name: log_level_in required: false schema: description: Log level for incoming traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Log level for outgoing traffic. in: query name: log_level_out required: false schema: description: Log level for outgoing traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Enable logging of conntrack information. in: query name: log_nf_conntrack required: false schema: description: Enable logging of conntrack information. type: boolean - description: Enable NDP (Neighbor Discovery Protocol). in: query name: ndp required: false schema: description: Enable NDP (Neighbor Discovery Protocol). type: boolean - description: Allow invalid packets on connection tracking. in: query name: nf_conntrack_allow_invalid required: false schema: description: Allow invalid packets on connection tracking. type: boolean - description: 'Enable conntrack helpers for specific protocols. Supported protocols: amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp' in: query name: nf_conntrack_helpers required: false schema: description: 'Enable conntrack helpers for specific protocols. Supported protocols: amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp' format: pve-fw-conntrack-helper type: string - description: Maximum number of tracked connections. in: query name: nf_conntrack_max required: false schema: description: Maximum number of tracked connections. type: integer - description: Conntrack established timeout. in: query name: nf_conntrack_tcp_timeout_established required: false schema: description: Conntrack established timeout. type: integer - description: Conntrack syn recv timeout. in: query name: nf_conntrack_tcp_timeout_syn_recv required: false schema: description: Conntrack syn recv timeout. type: integer - description: Enable nftables based firewall (tech preview) in: query name: nftables required: false schema: description: Enable nftables based firewall (tech preview) type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Enable SMURFS filter. in: query name: nosmurfs required: false schema: description: Enable SMURFS filter. type: boolean - description: Enable synflood protection in: query name: protection_synflood required: false schema: description: Enable synflood protection type: boolean - description: Synflood protection rate burst by ip src. in: query name: protection_synflood_burst required: false schema: description: Synflood protection rate burst by ip src. type: integer - description: Synflood protection rate syn/sec by ip src. in: query name: protection_synflood_rate required: false schema: description: Synflood protection rate syn/sec by ip src. type: integer - description: Log level for SMURFS filter. in: query name: smurf_log_level required: false schema: description: Log level for SMURFS filter. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Log level for illegal tcp flags filter. in: query name: tcp_flags_log_level required: false schema: description: Log level for illegal tcp flags filter. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Filter illegal combinations of TCP flags. in: query name: tcpflags required: false schema: description: Filter illegal combinations of TCP flags. type: boolean requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string enable: description: Enable host firewall rules. type: boolean log_level_forward: description: Log level for forwarded traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string log_level_in: description: Log level for incoming traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string log_level_out: description: Log level for outgoing traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string log_nf_conntrack: description: Enable logging of conntrack information. type: boolean ndp: description: Enable NDP (Neighbor Discovery Protocol). type: boolean nf_conntrack_allow_invalid: description: Allow invalid packets on connection tracking. type: boolean nf_conntrack_helpers: description: 'Enable conntrack helpers for specific protocols. Supported protocols: amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp' format: pve-fw-conntrack-helper type: string nf_conntrack_max: description: Maximum number of tracked connections. type: integer nf_conntrack_tcp_timeout_established: description: Conntrack established timeout. type: integer nf_conntrack_tcp_timeout_syn_recv: description: Conntrack syn recv timeout. type: integer nftables: description: Enable nftables based firewall (tech preview) type: boolean node: description: The cluster node name. format: pve-node type: string nosmurfs: description: Enable SMURFS filter. type: boolean protection_synflood: description: Enable synflood protection type: boolean protection_synflood_burst: description: Synflood protection rate burst by ip src. type: integer protection_synflood_rate: description: Synflood protection rate syn/sec by ip src. type: integer smurf_log_level: description: Log level for SMURFS filter. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string tcp_flags_log_level: description: Log level for illegal tcp flags filter. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string tcpflags: description: Filter illegal combinations of TCP flags. type: boolean type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set Firewall options. /nodes/{node}/firewall/rules: get: operationId: get_nodes_node_firewall_rules parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object type: array description: OK summary: List rules. post: operationId: post_nodes_node_firewall_rules parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: true schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: query name: pos required: false schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: true schema: description: Rule type. enum: - in - out - forward - group type: string requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string node: description: The cluster node name. format: pve-node type: string pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string required: - type - action type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new rule. /nodes/{node}/firewall/rules/{pos}: delete: operationId: delete_nodes_node_firewall_rules_pos parameters: - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete rule. get: operationId: get_nodes_node_firewall_rules_pos parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer responses: "200": content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object description: OK summary: Get single rule data. put: operationId: put_nodes_node_firewall_rules_pos parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: false schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: Move rule to new position . Other arguments are ignored. in: query name: moveto required: false schema: description: Move rule to new position . Other arguments are ignored. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: false schema: description: Rule type. enum: - in - out - forward - group type: string requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string moveto: description: Move rule to new position . Other arguments are ignored. type: integer node: description: The cluster node name. format: pve-node type: string pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Modify rule data. /nodes/{node}/hardware: get: operationId: get_nodes_node_hardware parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: type: type: string type: object type: array description: OK summary: Index of hardware types /nodes/{node}/hardware/pci: get: operationId: get_nodes_node_hardware_pci parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: 'A list of blacklisted PCI classes, which will not be returned. Following are filtered by default: Memory Controller (05), Bridge (06) and Processor (0b).' in: query name: pci-class-blacklist required: false schema: description: 'A list of blacklisted PCI classes, which will not be returned. Following are filtered by default: Memory Controller (05), Bridge (06) and Processor (0b).' format: string-list type: string - description: If disabled, does only print the PCI IDs. Otherwise, additional information like vendor and device will be returned. in: query name: verbose required: false schema: description: If disabled, does only print the PCI IDs. Otherwise, additional information like vendor and device will be returned. type: boolean responses: "200": content: application/json: schema: items: properties: class: description: The PCI Class of the device. type: string device: description: The Device ID. type: string device_name: type: string id: description: The PCI ID. type: string iommugroup: description: The IOMMU group in which the device is in. If no IOMMU group is detected, it is set to -1. type: integer mdev: description: If set, marks that the device is capable of creating mediated devices. type: boolean subsystem_device: description: The Subsystem Device ID. type: string subsystem_device_name: type: string subsystem_vendor: description: The Subsystem Vendor ID. type: string subsystem_vendor_name: type: string vendor: description: The Vendor ID. type: string vendor_name: type: string type: object type: array description: OK summary: List local PCI devices. /nodes/{node}/hardware/pci/{pci-id-or-mapping}: get: operationId: get_nodes_node_hardware_pci_pci_id_or_mapping parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: "" in: path name: pci-id-or-mapping required: true schema: type: string responses: "200": content: application/json: schema: items: properties: method: type: string type: object type: array description: OK summary: Index of available pci methods /nodes/{node}/hardware/pci/{pci-id-or-mapping}/mdev: get: operationId: get_nodes_node_hardware_pci_pci_id_or_mapping_mdev parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The PCI ID or mapping to list the mdev types for. in: path name: pci-id-or-mapping required: true schema: description: The PCI ID or mapping to list the mdev types for. type: string responses: "200": content: application/json: schema: items: properties: available: description: The number of still available instances of this type. type: integer description: description: Additional description of the type. type: string name: description: A human readable name for the type. type: string type: description: The name of the mdev type. type: string type: object type: array description: OK summary: List mediated device types for given PCI device. /nodes/{node}/hardware/usb: get: operationId: get_nodes_node_hardware_usb parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: busnum: type: integer class: type: integer devnum: type: integer level: type: integer manufacturer: type: string port: type: integer prodid: type: string product: type: string serial: type: string speed: type: string usbpath: type: string vendid: type: string type: object type: array description: OK summary: List local USB devices. /nodes/{node}/hosts: get: operationId: get_nodes_node_hosts parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: data: description: The content of /etc/hosts. type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string type: object description: OK summary: Get the content of /etc/hosts. post: operationId: post_nodes_node_hosts parameters: - description: The target content of /etc/hosts. in: query name: data required: false schema: description: The target content of /etc/hosts. type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: data: description: The target content of /etc/hosts. type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Write /etc/hosts. /nodes/{node}/journal: get: operationId: get_nodes_node_journal parameters: - description: End before the given Cursor. Conflicts with 'until' in: query name: endcursor required: false schema: description: End before the given Cursor. Conflicts with 'until' type: string - description: Limit to the last X lines. Conflicts with a range. in: query name: lastentries required: false schema: description: Limit to the last X lines. Conflicts with a range. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Display all log since this UNIX epoch. Conflicts with 'startcursor'. in: query name: since required: false schema: description: Display all log since this UNIX epoch. Conflicts with 'startcursor'. type: integer - description: Start after the given Cursor. Conflicts with 'since' in: query name: startcursor required: false schema: description: Start after the given Cursor. Conflicts with 'since' type: string - description: Display all log until this UNIX epoch. Conflicts with 'endcursor'. in: query name: until required: false schema: description: Display all log until this UNIX epoch. Conflicts with 'endcursor'. type: integer responses: "200": content: application/json: schema: items: type: string type: array description: OK summary: Read Journal /nodes/{node}/lxc: get: operationId: get_nodes_node_lxc parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: cpu: description: Current CPU usage. type: number cpus: description: Maximum usable CPUs. type: number disk: description: Root disk image space-usage in bytes. type: integer diskread: description: 'The amount of bytes the guest read from it''s block devices since the guest was started. (Note: This info is not available for all storage types.)' type: integer diskwrite: description: 'The amount of bytes the guest wrote from it''s block devices since the guest was started. (Note: This info is not available for all storage types.)' type: integer lock: description: The current config lock, if any. type: string maxdisk: description: Root disk image size in bytes. type: integer maxmem: description: Maximum memory in bytes. type: integer maxswap: description: Maximum SWAP memory in bytes. type: integer mem: description: Currently used memory in bytes. type: integer name: description: Container name. type: string netin: description: The amount of traffic in bytes that was sent to the guest over the network since it was started. type: integer netout: description: The amount of traffic in bytes that was sent from the guest over the network since it was started. type: integer pressurecpusome: description: CPU Some pressure stall average over the last 10 seconds. type: number pressureiofull: description: IO Full pressure stall average over the last 10 seconds. type: number pressureiosome: description: IO Some pressure stall average over the last 10 seconds. type: number pressurememoryfull: description: Memory Full pressure stall average over the last 10 seconds. type: number pressurememorysome: description: Memory Some pressure stall average over the last 10 seconds. type: number status: description: LXC Container status. enum: - stopped - running type: string tags: description: The current configured tags, if any. type: string template: description: Determines if the guest is a template. type: boolean uptime: description: Uptime in seconds. type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object type: array description: OK summary: LXC container index (per node). post: operationId: post_nodes_node_lxc parameters: - description: OS architecture type. in: query name: arch required: false schema: description: OS architecture type. enum: - amd64 - i386 - arm64 - armhf - riscv32 - riscv64 type: string - description: Override I/O bandwidth limit (in KiB/s). in: query name: bwlimit required: false schema: description: Override I/O bandwidth limit (in KiB/s). type: number - description: Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). in: query name: cmode required: false schema: description: Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). enum: - shell - console - tty type: string - description: Attach a console device (/dev/console) to the container. in: query name: console required: false schema: description: Attach a console device (/dev/console) to the container. type: boolean - description: The number of cores assigned to the container. A container can use all available cores by default. in: query name: cores required: false schema: description: The number of cores assigned to the container. A container can use all available cores by default. type: integer - description: |- Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. in: query name: cpulimit required: false schema: description: |- Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. type: number - description: CPU weight for a container, will be clamped to [1, 10000] in cgroup v2. in: query name: cpuunits required: false schema: description: CPU weight for a container, will be clamped to [1, 10000] in cgroup v2. type: integer - description: Try to be more verbose. For now this only enables debug log-level on start. in: query name: debug required: false schema: description: Try to be more verbose. For now this only enables debug log-level on start. type: boolean - description: Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. in: query name: description required: false schema: description: Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. type: string - description: Device to pass through to the container in: query name: dev[n] required: false schema: description: Device to pass through to the container type: string - description: Command to run as init, optionally with arguments; may start with an absolute path, relative path, or a binary in $PATH. in: query name: entrypoint required: false schema: description: Command to run as init, optionally with arguments; may start with an absolute path, relative path, or a binary in $PATH. type: string - description: The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config. in: query name: env required: false schema: description: The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config. type: string - description: Allow containers access to advanced features. in: query name: features required: false schema: description: Allow containers access to advanced features. type: string - description: Allow to overwrite existing container. in: query name: force required: false schema: description: Allow to overwrite existing container. type: boolean - description: Add the CT as a HA resource after it was created. in: query name: ha-managed required: false schema: description: Add the CT as a HA resource after it was created. type: boolean - description: Script that will be executed during various steps in the containers lifetime. in: query name: hookscript required: false schema: description: Script that will be executed during various steps in the containers lifetime. format: pve-volume-id type: string - description: Set a host name for the container. in: query name: hostname required: false schema: description: Set a host name for the container. format: dns-name type: string - description: Ignore errors when extracting the template. in: query name: ignore-unpack-errors required: false schema: description: Ignore errors when extracting the template. type: boolean - description: Lock/unlock the container. in: query name: lock required: false schema: description: Lock/unlock the container. enum: - backup - create - destroyed - disk - fstrim - migrate - mounted - rollback - snapshot - snapshot-delete type: string - description: Amount of RAM for the container in MB. in: query name: memory required: false schema: description: Amount of RAM for the container in MB. type: integer - description: Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. in: query name: mp[n] required: false schema: description: Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. type: string - description: Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. in: query name: nameserver required: false schema: description: Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. format: lxc-ip-with-ll-iface-list type: string - description: Specifies network interfaces for the container. in: query name: net[n] required: false schema: description: Specifies network interfaces for the container. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Specifies whether a container will be started during system bootup. in: query name: onboot required: false schema: description: Specifies whether a container will be started during system bootup. type: boolean - description: The OS template or backup file. in: query name: ostemplate required: false schema: description: The OS template or backup file. type: string - description: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. in: query name: ostype required: false schema: description: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. enum: - debian - devuan - ubuntu - centos - fedora - opensuse - archlinux - alpine - gentoo - nixos - unmanaged type: string - description: Sets root password inside container. in: query name: password required: false schema: description: Sets root password inside container. type: string - description: Add the VM to the specified pool. in: query name: pool required: false schema: description: Add the VM to the specified pool. format: pve-poolid type: string - description: Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. in: query name: protection required: false schema: description: Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. type: boolean - description: Mark this as restore task. in: query name: restore required: false schema: description: Mark this as restore task. type: boolean - description: Use volume as container root. in: query name: rootfs required: false schema: description: Use volume as container root. type: string - description: Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. in: query name: searchdomain required: false schema: description: Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. format: dns-name-list type: string - description: Setup public SSH keys (one key per line, OpenSSH format). in: query name: ssh-public-keys required: false schema: description: Setup public SSH keys (one key per line, OpenSSH format). type: string - description: Start the CT after its creation finished successfully. in: query name: start required: false schema: description: Start the CT after its creation finished successfully. type: boolean - description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. in: query name: startup required: false schema: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string - description: Default Storage. in: query name: storage required: false schema: description: Default Storage. format: pve-storage-id type: string - description: Amount of SWAP for the container in MB. in: query name: swap required: false schema: description: Amount of SWAP for the container in MB. type: integer - description: Tags of the Container. This is only meta information. in: query name: tags required: false schema: description: Tags of the Container. This is only meta information. format: pve-tag-list type: string - description: Enable/disable Template. in: query name: template required: false schema: description: Enable/disable Template. type: boolean - description: Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab in: query name: timezone required: false schema: description: Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab format: pve-ct-timezone type: string - description: Specify the number of tty available to the container in: query name: tty required: false schema: description: Specify the number of tty available to the container type: integer - description: Assign a unique random ethernet address. in: query name: unique required: false schema: description: Assign a unique random ethernet address. type: boolean - description: Makes the container run as unprivileged user. For creation, the default is 1. For restore, the default is the value from the backup. (Should not be modified manually.) in: query name: unprivileged required: false schema: description: Makes the container run as unprivileged user. For creation, the default is 1. For restore, the default is the value from the backup. (Should not be modified manually.) type: boolean - description: Reference to unused volumes. This is used internally, and should not be modified manually. in: query name: unused[n] required: false schema: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string - description: The (unique) ID of the VM. in: query name: vmid required: false schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: arch: description: OS architecture type. enum: - amd64 - i386 - arm64 - armhf - riscv32 - riscv64 type: string bwlimit: description: Override I/O bandwidth limit (in KiB/s). type: number cmode: description: Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). enum: - shell - console - tty type: string console: description: Attach a console device (/dev/console) to the container. type: boolean cores: description: The number of cores assigned to the container. A container can use all available cores by default. type: integer cpulimit: description: |- Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. type: number cpuunits: description: CPU weight for a container, will be clamped to [1, 10000] in cgroup v2. type: integer debug: description: Try to be more verbose. For now this only enables debug log-level on start. type: boolean description: description: Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. type: string dev[n]: description: Device to pass through to the container type: string entrypoint: description: Command to run as init, optionally with arguments; may start with an absolute path, relative path, or a binary in $PATH. type: string env: description: The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config. type: string features: description: Allow containers access to advanced features. type: string force: description: Allow to overwrite existing container. type: boolean ha-managed: description: Add the CT as a HA resource after it was created. type: boolean hookscript: description: Script that will be executed during various steps in the containers lifetime. format: pve-volume-id type: string hostname: description: Set a host name for the container. format: dns-name type: string ignore-unpack-errors: description: Ignore errors when extracting the template. type: boolean lock: description: Lock/unlock the container. enum: - backup - create - destroyed - disk - fstrim - migrate - mounted - rollback - snapshot - snapshot-delete type: string memory: description: Amount of RAM for the container in MB. type: integer mp[n]: description: Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. type: string nameserver: description: Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. format: lxc-ip-with-ll-iface-list type: string net[n]: description: Specifies network interfaces for the container. type: string node: description: The cluster node name. format: pve-node type: string onboot: description: Specifies whether a container will be started during system bootup. type: boolean ostemplate: description: The OS template or backup file. type: string ostype: description: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. enum: - debian - devuan - ubuntu - centos - fedora - opensuse - archlinux - alpine - gentoo - nixos - unmanaged type: string password: description: Sets root password inside container. type: string pool: description: Add the VM to the specified pool. format: pve-poolid type: string protection: description: Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. type: boolean restore: description: Mark this as restore task. type: boolean rootfs: description: Use volume as container root. type: string searchdomain: description: Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. format: dns-name-list type: string ssh-public-keys: description: Setup public SSH keys (one key per line, OpenSSH format). type: string start: description: Start the CT after its creation finished successfully. type: boolean startup: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string storage: description: Default Storage. format: pve-storage-id type: string swap: description: Amount of SWAP for the container in MB. type: integer tags: description: Tags of the Container. This is only meta information. format: pve-tag-list type: string template: description: Enable/disable Template. type: boolean timezone: description: Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab format: pve-ct-timezone type: string tty: description: Specify the number of tty available to the container type: integer unique: description: Assign a unique random ethernet address. type: boolean unprivileged: description: Makes the container run as unprivileged user. For creation, the default is 1. For restore, the default is the value from the backup. (Should not be modified manually.) type: boolean unused[n]: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create or restore a container. /nodes/{node}/lxc/{vmid}: delete: operationId: delete_nodes_node_lxc_vmid parameters: - description: If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. in: query name: destroy-unreferenced-disks required: false schema: description: If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. type: boolean - description: Force destroy, even if running. in: query name: force required: false schema: description: Force destroy, even if running. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed. in: query name: purge required: false schema: description: Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: type: string description: OK summary: Destroy the container (also delete all uses files). get: operationId: get_nodes_node_lxc_vmid parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: Directory index /nodes/{node}/lxc/{vmid}/clone: post: operationId: post_nodes_node_lxc_vmid_clone parameters: - description: Override I/O bandwidth limit (in KiB/s). in: query name: bwlimit required: false schema: description: Override I/O bandwidth limit (in KiB/s). type: number - description: Description for the new CT. in: query name: description required: false schema: description: Description for the new CT. type: string - description: Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. in: query name: full required: false schema: description: Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. type: boolean - description: Set a hostname for the new CT. in: query name: hostname required: false schema: description: Set a hostname for the new CT. format: dns-name type: string - description: VMID for the clone. in: query name: newid required: false schema: description: VMID for the clone. format: pve-vmid type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Add the new CT to the specified pool. in: query name: pool required: false schema: description: Add the new CT to the specified pool. format: pve-poolid type: string - description: The name of the snapshot. in: query name: snapname required: false schema: description: The name of the snapshot. format: pve-configid type: string - description: Target storage for full clone. in: query name: storage required: false schema: description: Target storage for full clone. format: pve-storage-id type: string - description: Target node. Only allowed if the original VM is on shared storage. in: query name: target required: false schema: description: Target node. Only allowed if the original VM is on shared storage. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: bwlimit: description: Override I/O bandwidth limit (in KiB/s). type: number description: description: Description for the new CT. type: string full: description: Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. type: boolean hostname: description: Set a hostname for the new CT. format: dns-name type: string newid: description: VMID for the clone. format: pve-vmid type: integer node: description: The cluster node name. format: pve-node type: string pool: description: Add the new CT to the specified pool. format: pve-poolid type: string snapname: description: The name of the snapshot. format: pve-configid type: string storage: description: Target storage for full clone. format: pve-storage-id type: string target: description: Target node. Only allowed if the original VM is on shared storage. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create a container clone/copy /nodes/{node}/lxc/{vmid}/config: get: operationId: get_nodes_node_lxc_vmid_config parameters: - description: Get current values (instead of pending values). in: query name: current required: false schema: description: Get current values (instead of pending values). type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Fetch config values from given snapshot. in: query name: snapshot required: false schema: description: Fetch config values from given snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: arch: description: OS architecture type. enum: - amd64 - i386 - arm64 - armhf - riscv32 - riscv64 type: string cmode: description: Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). enum: - shell - console - tty type: string console: description: Attach a console device (/dev/console) to the container. type: boolean cores: description: The number of cores assigned to the container. A container can use all available cores by default. type: integer cpulimit: description: |- Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. type: number cpuunits: description: CPU weight for a container, will be clamped to [1, 10000] in cgroup v2. type: integer debug: description: Try to be more verbose. For now this only enables debug log-level on start. type: boolean description: description: Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. type: string dev[n]: description: Device to pass through to the container type: string digest: description: SHA1 digest of configuration file. This can be used to prevent concurrent modifications. type: string entrypoint: description: Command to run as init, optionally with arguments; may start with an absolute path, relative path, or a binary in $PATH. type: string env: description: The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config. type: string features: description: Allow containers access to advanced features. type: string hookscript: description: Script that will be executed during various steps in the containers lifetime. format: pve-volume-id type: string hostname: description: Set a host name for the container. format: dns-name type: string lock: description: Lock/unlock the container. enum: - backup - create - destroyed - disk - fstrim - migrate - mounted - rollback - snapshot - snapshot-delete type: string lxc: description: Array of lxc low-level configurations ([[key1, value1], [key2, value2] ...]). items: items: type: string type: array type: array memory: description: Amount of RAM for the container in MB. type: integer mp[n]: description: Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. type: string nameserver: description: Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. format: lxc-ip-with-ll-iface-list type: string net[n]: description: Specifies network interfaces for the container. type: string onboot: description: Specifies whether a container will be started during system bootup. type: boolean ostype: description: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. enum: - debian - devuan - ubuntu - centos - fedora - opensuse - archlinux - alpine - gentoo - nixos - unmanaged type: string protection: description: Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. type: boolean rootfs: description: Use volume as container root. type: string searchdomain: description: Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. format: dns-name-list type: string startup: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string swap: description: Amount of SWAP for the container in MB. type: integer tags: description: Tags of the Container. This is only meta information. format: pve-tag-list type: string template: description: Enable/disable Template. type: boolean timezone: description: Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab format: pve-ct-timezone type: string tty: description: Specify the number of tty available to the container type: integer unprivileged: description: Makes the container run as unprivileged user. For creation, the default is 1. For restore, the default is the value from the backup. (Should not be modified manually.) type: boolean unused[n]: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string type: object description: OK summary: Get container configuration. put: operationId: put_nodes_node_lxc_vmid_config parameters: - description: OS architecture type. in: query name: arch required: false schema: description: OS architecture type. enum: - amd64 - i386 - arm64 - armhf - riscv32 - riscv64 type: string - description: Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). in: query name: cmode required: false schema: description: Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). enum: - shell - console - tty type: string - description: Attach a console device (/dev/console) to the container. in: query name: console required: false schema: description: Attach a console device (/dev/console) to the container. type: boolean - description: The number of cores assigned to the container. A container can use all available cores by default. in: query name: cores required: false schema: description: The number of cores assigned to the container. A container can use all available cores by default. type: integer - description: |- Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. in: query name: cpulimit required: false schema: description: |- Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. type: number - description: CPU weight for a container, will be clamped to [1, 10000] in cgroup v2. in: query name: cpuunits required: false schema: description: CPU weight for a container, will be clamped to [1, 10000] in cgroup v2. type: integer - description: Try to be more verbose. For now this only enables debug log-level on start. in: query name: debug required: false schema: description: Try to be more verbose. For now this only enables debug log-level on start. type: boolean - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. in: query name: description required: false schema: description: Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. type: string - description: Device to pass through to the container in: query name: dev[n] required: false schema: description: Device to pass through to the container type: string - description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string - description: Command to run as init, optionally with arguments; may start with an absolute path, relative path, or a binary in $PATH. in: query name: entrypoint required: false schema: description: Command to run as init, optionally with arguments; may start with an absolute path, relative path, or a binary in $PATH. type: string - description: The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config. in: query name: env required: false schema: description: The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config. type: string - description: Allow containers access to advanced features. in: query name: features required: false schema: description: Allow containers access to advanced features. type: string - description: Script that will be executed during various steps in the containers lifetime. in: query name: hookscript required: false schema: description: Script that will be executed during various steps in the containers lifetime. format: pve-volume-id type: string - description: Set a host name for the container. in: query name: hostname required: false schema: description: Set a host name for the container. format: dns-name type: string - description: Lock/unlock the container. in: query name: lock required: false schema: description: Lock/unlock the container. enum: - backup - create - destroyed - disk - fstrim - migrate - mounted - rollback - snapshot - snapshot-delete type: string - description: Amount of RAM for the container in MB. in: query name: memory required: false schema: description: Amount of RAM for the container in MB. type: integer - description: Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. in: query name: mp[n] required: false schema: description: Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. type: string - description: Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. in: query name: nameserver required: false schema: description: Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. format: lxc-ip-with-ll-iface-list type: string - description: Specifies network interfaces for the container. in: query name: net[n] required: false schema: description: Specifies network interfaces for the container. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Specifies whether a container will be started during system bootup. in: query name: onboot required: false schema: description: Specifies whether a container will be started during system bootup. type: boolean - description: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. in: query name: ostype required: false schema: description: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. enum: - debian - devuan - ubuntu - centos - fedora - opensuse - archlinux - alpine - gentoo - nixos - unmanaged type: string - description: Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. in: query name: protection required: false schema: description: Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. type: boolean - description: Revert a pending change. in: query name: revert required: false schema: description: Revert a pending change. format: pve-configid-list type: string - description: Use volume as container root. in: query name: rootfs required: false schema: description: Use volume as container root. type: string - description: Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. in: query name: searchdomain required: false schema: description: Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. format: dns-name-list type: string - description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. in: query name: startup required: false schema: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string - description: Amount of SWAP for the container in MB. in: query name: swap required: false schema: description: Amount of SWAP for the container in MB. type: integer - description: Tags of the Container. This is only meta information. in: query name: tags required: false schema: description: Tags of the Container. This is only meta information. format: pve-tag-list type: string - description: Enable/disable Template. in: query name: template required: false schema: description: Enable/disable Template. type: boolean - description: Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab in: query name: timezone required: false schema: description: Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab format: pve-ct-timezone type: string - description: Specify the number of tty available to the container in: query name: tty required: false schema: description: Specify the number of tty available to the container type: integer - description: Makes the container run as unprivileged user. For creation, the default is 1. For restore, the default is the value from the backup. (Should not be modified manually.) in: query name: unprivileged required: false schema: description: Makes the container run as unprivileged user. For creation, the default is 1. For restore, the default is the value from the backup. (Should not be modified manually.) type: boolean - description: Reference to unused volumes. This is used internally, and should not be modified manually. in: query name: unused[n] required: false schema: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: arch: description: OS architecture type. enum: - amd64 - i386 - arm64 - armhf - riscv32 - riscv64 type: string cmode: description: Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). enum: - shell - console - tty type: string console: description: Attach a console device (/dev/console) to the container. type: boolean cores: description: The number of cores assigned to the container. A container can use all available cores by default. type: integer cpulimit: description: |- Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. type: number cpuunits: description: CPU weight for a container, will be clamped to [1, 10000] in cgroup v2. type: integer debug: description: Try to be more verbose. For now this only enables debug log-level on start. type: boolean delete: description: A list of settings you want to delete. format: pve-configid-list type: string description: description: Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. type: string dev[n]: description: Device to pass through to the container type: string digest: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string entrypoint: description: Command to run as init, optionally with arguments; may start with an absolute path, relative path, or a binary in $PATH. type: string env: description: The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config. type: string features: description: Allow containers access to advanced features. type: string hookscript: description: Script that will be executed during various steps in the containers lifetime. format: pve-volume-id type: string hostname: description: Set a host name for the container. format: dns-name type: string lock: description: Lock/unlock the container. enum: - backup - create - destroyed - disk - fstrim - migrate - mounted - rollback - snapshot - snapshot-delete type: string memory: description: Amount of RAM for the container in MB. type: integer mp[n]: description: Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. type: string nameserver: description: Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. format: lxc-ip-with-ll-iface-list type: string net[n]: description: Specifies network interfaces for the container. type: string node: description: The cluster node name. format: pve-node type: string onboot: description: Specifies whether a container will be started during system bootup. type: boolean ostype: description: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. enum: - debian - devuan - ubuntu - centos - fedora - opensuse - archlinux - alpine - gentoo - nixos - unmanaged type: string protection: description: Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. type: boolean revert: description: Revert a pending change. format: pve-configid-list type: string rootfs: description: Use volume as container root. type: string searchdomain: description: Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. format: dns-name-list type: string startup: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string swap: description: Amount of SWAP for the container in MB. type: integer tags: description: Tags of the Container. This is only meta information. format: pve-tag-list type: string template: description: Enable/disable Template. type: boolean timezone: description: Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab format: pve-ct-timezone type: string tty: description: Specify the number of tty available to the container type: integer unprivileged: description: Makes the container run as unprivileged user. For creation, the default is 1. For restore, the default is the value from the backup. (Should not be modified manually.) type: boolean unused[n]: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set container options. /nodes/{node}/lxc/{vmid}/feature: get: operationId: get_nodes_node_lxc_vmid_feature parameters: - description: Feature to check. in: query name: feature required: false schema: description: Feature to check. enum: - snapshot - clone - copy type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: query name: snapname required: false schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: hasFeature: type: boolean type: object description: OK summary: Check if feature for virtual machine is available. /nodes/{node}/lxc/{vmid}/firewall: get: operationId: get_nodes_node_lxc_vmid_firewall parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Directory index. /nodes/{node}/lxc/{vmid}/firewall/aliases: get: operationId: get_nodes_node_lxc_vmid_firewall_aliases parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: cidr: type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: type: string type: object type: array description: OK summary: List aliases post: operationId: post_nodes_node_lxc_vmid_firewall_aliases parameters: - description: Network/IP specification in CIDR format. in: query name: cidr required: false schema: description: Network/IP specification in CIDR format. format: IPorCIDR type: string - description: "" in: query name: comment required: false schema: type: string - description: Alias name. in: query name: name required: false schema: description: Alias name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDR type: string comment: type: string name: description: Alias name. type: string node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create IP or Network Alias. /nodes/{node}/lxc/{vmid}/firewall/aliases/{name}: delete: operationId: delete_nodes_node_lxc_vmid_firewall_aliases_name parameters: - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Alias name. in: path name: name required: true schema: description: Alias name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove IP or Network alias. get: operationId: get_nodes_node_lxc_vmid_firewall_aliases_name parameters: - description: Alias name. in: path name: name required: true schema: description: Alias name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: type: object description: OK summary: Read alias. put: operationId: put_nodes_node_lxc_vmid_firewall_aliases_name parameters: - description: Network/IP specification in CIDR format. in: query name: cidr required: false schema: description: Network/IP specification in CIDR format. format: IPorCIDR type: string - description: "" in: query name: comment required: false schema: type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Alias name. in: path name: name required: true schema: description: Alias name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Rename an existing alias. in: query name: rename required: false schema: description: Rename an existing alias. type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDR type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: Alias name. type: string node: description: The cluster node name. format: pve-node type: string rename: description: Rename an existing alias. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update IP or Network alias. /nodes/{node}/lxc/{vmid}/firewall/ipset: get: operationId: get_nodes_node_lxc_vmid_firewall_ipset parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: IP set name. type: string type: object type: array description: OK summary: List IPSets post: operationId: post_nodes_node_lxc_vmid_firewall_ipset parameters: - description: "" in: query name: comment required: false schema: type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: IP set name. in: query name: name required: false schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. in: query name: rename required: false schema: description: Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: IP set name. type: string node: description: The cluster node name. format: pve-node type: string rename: description: Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new IPSet /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}: delete: operationId: delete_nodes_node_lxc_vmid_firewall_ipset_name parameters: - description: Delete all members of the IPSet, if there are any. in: query name: force required: false schema: description: Delete all members of the IPSet, if there are any. type: boolean - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete IPSet get: operationId: get_nodes_node_lxc_vmid_firewall_ipset_name parameters: - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: cidr: type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string nomatch: type: boolean type: object type: array description: OK summary: List IPSet content post: operationId: post_nodes_node_lxc_vmid_firewall_ipset_name parameters: - description: Network/IP specification in CIDR format. in: query name: cidr required: false schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: "" in: query name: comment required: false schema: type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: "" in: query name: nomatch required: false schema: type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string comment: type: string name: description: IP set name. type: string node: description: The cluster node name. format: pve-node type: string nomatch: type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add IP or Network to IPSet. /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}: delete: operationId: delete_nodes_node_lxc_vmid_firewall_ipset_name_cidr parameters: - description: Network/IP specification in CIDR format. in: path name: cidr required: true schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove IP or Network from IPSet. get: operationId: get_nodes_node_lxc_vmid_firewall_ipset_name_cidr parameters: - description: Network/IP specification in CIDR format. in: path name: cidr required: true schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: type: object description: OK summary: Read IP or Network settings from IPSet. put: operationId: put_nodes_node_lxc_vmid_firewall_ipset_name_cidr parameters: - description: Network/IP specification in CIDR format. in: path name: cidr required: true schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: "" in: query name: comment required: false schema: type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: "" in: query name: nomatch required: false schema: type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: IP set name. type: string node: description: The cluster node name. format: pve-node type: string nomatch: type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update IP or Network settings /nodes/{node}/lxc/{vmid}/firewall/log: get: operationId: get_nodes_node_lxc_vmid_firewall_log parameters: - description: "" in: query name: limit required: false schema: type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Display log since this UNIX epoch. in: query name: since required: false schema: description: Display log since this UNIX epoch. type: integer - description: "" in: query name: start required: false schema: type: integer - description: Display log until this UNIX epoch. in: query name: until required: false schema: description: Display log until this UNIX epoch. type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: "n": description: Line number type: integer t: description: Line text type: string type: object type: array description: OK summary: Read firewall log /nodes/{node}/lxc/{vmid}/firewall/options: get: operationId: get_nodes_node_lxc_vmid_firewall_options parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: dhcp: description: Enable DHCP. type: boolean enable: description: Enable/disable firewall rules. type: boolean ipfilter: description: Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. type: boolean log_level_in: description: Log level for incoming traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string log_level_out: description: Log level for outgoing traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macfilter: description: Enable/disable MAC address filter. type: boolean ndp: description: Enable NDP (Neighbor Discovery Protocol). type: boolean policy_in: description: Input policy. enum: - ACCEPT - REJECT - DROP type: string policy_out: description: Output policy. enum: - ACCEPT - REJECT - DROP type: string radv: description: Allow sending Router Advertisement. type: boolean type: object description: OK summary: Get VM firewall options. put: operationId: put_nodes_node_lxc_vmid_firewall_options parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Enable DHCP. in: query name: dhcp required: false schema: description: Enable DHCP. type: boolean - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Enable/disable firewall rules. in: query name: enable required: false schema: description: Enable/disable firewall rules. type: boolean - description: Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. in: query name: ipfilter required: false schema: description: Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. type: boolean - description: Log level for incoming traffic. in: query name: log_level_in required: false schema: description: Log level for incoming traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Log level for outgoing traffic. in: query name: log_level_out required: false schema: description: Log level for outgoing traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Enable/disable MAC address filter. in: query name: macfilter required: false schema: description: Enable/disable MAC address filter. type: boolean - description: Enable NDP (Neighbor Discovery Protocol). in: query name: ndp required: false schema: description: Enable NDP (Neighbor Discovery Protocol). type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Input policy. in: query name: policy_in required: false schema: description: Input policy. enum: - ACCEPT - REJECT - DROP type: string - description: Output policy. in: query name: policy_out required: false schema: description: Output policy. enum: - ACCEPT - REJECT - DROP type: string - description: Allow sending Router Advertisement. in: query name: radv required: false schema: description: Allow sending Router Advertisement. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string dhcp: description: Enable DHCP. type: boolean digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string enable: description: Enable/disable firewall rules. type: boolean ipfilter: description: Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. type: boolean log_level_in: description: Log level for incoming traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string log_level_out: description: Log level for outgoing traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macfilter: description: Enable/disable MAC address filter. type: boolean ndp: description: Enable NDP (Neighbor Discovery Protocol). type: boolean node: description: The cluster node name. format: pve-node type: string policy_in: description: Input policy. enum: - ACCEPT - REJECT - DROP type: string policy_out: description: Output policy. enum: - ACCEPT - REJECT - DROP type: string radv: description: Allow sending Router Advertisement. type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set Firewall options. /nodes/{node}/lxc/{vmid}/firewall/refs: get: operationId: get_nodes_node_lxc_vmid_firewall_refs parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Only list references of specified type. in: query name: type required: false schema: description: Only list references of specified type. enum: - alias - ipset type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: comment: type: string name: type: string ref: type: string scope: type: string type: enum: - alias - ipset type: string type: object type: array description: OK summary: Lists possible IPSet/Alias reference which are allowed in source/dest properties. /nodes/{node}/lxc/{vmid}/firewall/rules: get: operationId: get_nodes_node_lxc_vmid_firewall_rules parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object type: array description: OK summary: List rules. post: operationId: post_nodes_node_lxc_vmid_firewall_rules parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: true schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: query name: pos required: false schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: true schema: description: Rule type. enum: - in - out - forward - group type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string node: description: The cluster node name. format: pve-node type: string pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer required: - action - type type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new rule. /nodes/{node}/lxc/{vmid}/firewall/rules/{pos}: delete: operationId: delete_nodes_node_lxc_vmid_firewall_rules_pos parameters: - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete rule. get: operationId: get_nodes_node_lxc_vmid_firewall_rules_pos parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object description: OK summary: Get single rule data. put: operationId: put_nodes_node_lxc_vmid_firewall_rules_pos parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: false schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: Move rule to new position . Other arguments are ignored. in: query name: moveto required: false schema: description: Move rule to new position . Other arguments are ignored. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: false schema: description: Rule type. enum: - in - out - forward - group type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string moveto: description: Move rule to new position . Other arguments are ignored. type: integer node: description: The cluster node name. format: pve-node type: string pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Modify rule data. /nodes/{node}/lxc/{vmid}/interfaces: get: operationId: get_nodes_node_lxc_vmid_interfaces parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: hardware-address: description: The MAC address of the interface type: string hwaddr: description: The MAC address of the interface type: string inet: description: The IPv4 address of the interface type: string inet6: description: The IPv6 address of the interface type: string ip-addresses: description: The addresses of the interface items: properties: ip-address: description: IP-Address type: string ip-address-type: description: IP-Family type: string prefix: description: IP-Prefix type: integer type: object type: array name: description: The name of the interface type: string type: object type: array description: OK summary: Get IP addresses of the specified container interface. /nodes/{node}/lxc/{vmid}/migrate: get: operationId: get_nodes_node_lxc_vmid_migrate parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Target node. in: query name: target required: false schema: description: Target node. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: allowed-nodes: description: List of nodes allowed for migration. items: description: An allowed node type: string type: array dependent-ha-resources: description: HA resources, which will be migrated to the same target node as the VM, because these are in positive affinity with the VM. items: description: The ':' resource IDs of a HA resource with a positive affinity rule to this CT. type: string type: array not-allowed-nodes: description: List of not allowed nodes with additional information. properties: blocking-ha-resources: description: HA resources, which are blocking the container from being migrated to the node. items: description: A blocking HA resource properties: cause: description: The reason why the HA resource is blocking the migration. enum: - node-affinity - resource-affinity type: string sid: description: The blocking HA resource id type: string type: object type: array type: object running: description: Determines if the container is running. type: boolean type: object description: OK summary: Get preconditions for migration. post: operationId: post_nodes_node_lxc_vmid_migrate parameters: - description: Override I/O bandwidth limit (in KiB/s). in: query name: bwlimit required: false schema: description: Override I/O bandwidth limit (in KiB/s). type: number - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Use online/live migration. in: query name: online required: false schema: description: Use online/live migration. type: boolean - description: Use restart migration in: query name: restart required: false schema: description: Use restart migration type: boolean - description: Target node. in: query name: target required: false schema: description: Target node. format: pve-node type: string - description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. in: query name: target-storage required: false schema: description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. format: storage-pair-list type: string - description: Timeout in seconds for shutdown for restart migration in: query name: timeout required: false schema: description: Timeout in seconds for shutdown for restart migration type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: bwlimit: description: Override I/O bandwidth limit (in KiB/s). type: number node: description: The cluster node name. format: pve-node type: string online: description: Use online/live migration. type: boolean restart: description: Use restart migration type: boolean target: description: Target node. format: pve-node type: string target-storage: description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. format: storage-pair-list type: string timeout: description: Timeout in seconds for shutdown for restart migration type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Migrate the container to another node. Creates a new migration task. /nodes/{node}/lxc/{vmid}/move_volume: post: operationId: post_nodes_node_lxc_vmid_move_volume parameters: - description: Override I/O bandwidth limit (in KiB/s). in: query name: bwlimit required: false schema: description: Override I/O bandwidth limit (in KiB/s). type: number - description: Delete the original volume after successful copy. By default the original is kept as an unused volume entry. in: query name: delete required: false schema: description: Delete the original volume after successful copy. By default the original is kept as an unused volume entry. type: boolean - description: |- Prevent changes if current configuration file has different SHA1 " . "digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: |- Prevent changes if current configuration file has different SHA1 " . "digest. This can be used to prevent concurrent modifications. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Target Storage. in: query name: storage required: false schema: description: Target Storage. format: pve-storage-id type: string - description: |- Prevent changes if current configuration file of the target " . "container has a different SHA1 digest. This can be used to prevent " . "concurrent modifications. in: query name: target-digest required: false schema: description: |- Prevent changes if current configuration file of the target " . "container has a different SHA1 digest. This can be used to prevent " . "concurrent modifications. type: string - description: The (unique) ID of the VM. in: query name: target-vmid required: false schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: The config key the volume will be moved to. Default is the source volume key. in: query name: target-volume required: false schema: description: The config key the volume will be moved to. Default is the source volume key. enum: - rootfs - mp0 - mp1 - mp2 - mp3 - mp4 - mp5 - mp6 - mp7 - mp8 - mp9 - mp10 - mp11 - mp12 - mp13 - mp14 - mp15 - mp16 - mp17 - mp18 - mp19 - mp20 - mp21 - mp22 - mp23 - mp24 - mp25 - mp26 - mp27 - mp28 - mp29 - mp30 - mp31 - mp32 - mp33 - mp34 - mp35 - mp36 - mp37 - mp38 - mp39 - mp40 - mp41 - mp42 - mp43 - mp44 - mp45 - mp46 - mp47 - mp48 - mp49 - mp50 - mp51 - mp52 - mp53 - mp54 - mp55 - mp56 - mp57 - mp58 - mp59 - mp60 - mp61 - mp62 - mp63 - mp64 - mp65 - mp66 - mp67 - mp68 - mp69 - mp70 - mp71 - mp72 - mp73 - mp74 - mp75 - mp76 - mp77 - mp78 - mp79 - mp80 - mp81 - mp82 - mp83 - mp84 - mp85 - mp86 - mp87 - mp88 - mp89 - mp90 - mp91 - mp92 - mp93 - mp94 - mp95 - mp96 - mp97 - mp98 - mp99 - mp100 - mp101 - mp102 - mp103 - mp104 - mp105 - mp106 - mp107 - mp108 - mp109 - mp110 - mp111 - mp112 - mp113 - mp114 - mp115 - mp116 - mp117 - mp118 - mp119 - mp120 - mp121 - mp122 - mp123 - mp124 - mp125 - mp126 - mp127 - mp128 - mp129 - mp130 - mp131 - mp132 - mp133 - mp134 - mp135 - mp136 - mp137 - mp138 - mp139 - mp140 - mp141 - mp142 - mp143 - mp144 - mp145 - mp146 - mp147 - mp148 - mp149 - mp150 - mp151 - mp152 - mp153 - mp154 - mp155 - mp156 - mp157 - mp158 - mp159 - mp160 - mp161 - mp162 - mp163 - mp164 - mp165 - mp166 - mp167 - mp168 - mp169 - mp170 - mp171 - mp172 - mp173 - mp174 - mp175 - mp176 - mp177 - mp178 - mp179 - mp180 - mp181 - mp182 - mp183 - mp184 - mp185 - mp186 - mp187 - mp188 - mp189 - mp190 - mp191 - mp192 - mp193 - mp194 - mp195 - mp196 - mp197 - mp198 - mp199 - mp200 - mp201 - mp202 - mp203 - mp204 - mp205 - mp206 - mp207 - mp208 - mp209 - mp210 - mp211 - mp212 - mp213 - mp214 - mp215 - mp216 - mp217 - mp218 - mp219 - mp220 - mp221 - mp222 - mp223 - mp224 - mp225 - mp226 - mp227 - mp228 - mp229 - mp230 - mp231 - mp232 - mp233 - mp234 - mp235 - mp236 - mp237 - mp238 - mp239 - mp240 - mp241 - mp242 - mp243 - mp244 - mp245 - mp246 - mp247 - mp248 - mp249 - mp250 - mp251 - mp252 - mp253 - mp254 - mp255 - unused0 - unused1 - unused2 - unused3 - unused4 - unused5 - unused6 - unused7 - unused8 - unused9 - unused10 - unused11 - unused12 - unused13 - unused14 - unused15 - unused16 - unused17 - unused18 - unused19 - unused20 - unused21 - unused22 - unused23 - unused24 - unused25 - unused26 - unused27 - unused28 - unused29 - unused30 - unused31 - unused32 - unused33 - unused34 - unused35 - unused36 - unused37 - unused38 - unused39 - unused40 - unused41 - unused42 - unused43 - unused44 - unused45 - unused46 - unused47 - unused48 - unused49 - unused50 - unused51 - unused52 - unused53 - unused54 - unused55 - unused56 - unused57 - unused58 - unused59 - unused60 - unused61 - unused62 - unused63 - unused64 - unused65 - unused66 - unused67 - unused68 - unused69 - unused70 - unused71 - unused72 - unused73 - unused74 - unused75 - unused76 - unused77 - unused78 - unused79 - unused80 - unused81 - unused82 - unused83 - unused84 - unused85 - unused86 - unused87 - unused88 - unused89 - unused90 - unused91 - unused92 - unused93 - unused94 - unused95 - unused96 - unused97 - unused98 - unused99 - unused100 - unused101 - unused102 - unused103 - unused104 - unused105 - unused106 - unused107 - unused108 - unused109 - unused110 - unused111 - unused112 - unused113 - unused114 - unused115 - unused116 - unused117 - unused118 - unused119 - unused120 - unused121 - unused122 - unused123 - unused124 - unused125 - unused126 - unused127 - unused128 - unused129 - unused130 - unused131 - unused132 - unused133 - unused134 - unused135 - unused136 - unused137 - unused138 - unused139 - unused140 - unused141 - unused142 - unused143 - unused144 - unused145 - unused146 - unused147 - unused148 - unused149 - unused150 - unused151 - unused152 - unused153 - unused154 - unused155 - unused156 - unused157 - unused158 - unused159 - unused160 - unused161 - unused162 - unused163 - unused164 - unused165 - unused166 - unused167 - unused168 - unused169 - unused170 - unused171 - unused172 - unused173 - unused174 - unused175 - unused176 - unused177 - unused178 - unused179 - unused180 - unused181 - unused182 - unused183 - unused184 - unused185 - unused186 - unused187 - unused188 - unused189 - unused190 - unused191 - unused192 - unused193 - unused194 - unused195 - unused196 - unused197 - unused198 - unused199 - unused200 - unused201 - unused202 - unused203 - unused204 - unused205 - unused206 - unused207 - unused208 - unused209 - unused210 - unused211 - unused212 - unused213 - unused214 - unused215 - unused216 - unused217 - unused218 - unused219 - unused220 - unused221 - unused222 - unused223 - unused224 - unused225 - unused226 - unused227 - unused228 - unused229 - unused230 - unused231 - unused232 - unused233 - unused234 - unused235 - unused236 - unused237 - unused238 - unused239 - unused240 - unused241 - unused242 - unused243 - unused244 - unused245 - unused246 - unused247 - unused248 - unused249 - unused250 - unused251 - unused252 - unused253 - unused254 - unused255 type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Volume which will be moved. in: query name: volume required: false schema: description: Volume which will be moved. enum: - rootfs - mp0 - mp1 - mp2 - mp3 - mp4 - mp5 - mp6 - mp7 - mp8 - mp9 - mp10 - mp11 - mp12 - mp13 - mp14 - mp15 - mp16 - mp17 - mp18 - mp19 - mp20 - mp21 - mp22 - mp23 - mp24 - mp25 - mp26 - mp27 - mp28 - mp29 - mp30 - mp31 - mp32 - mp33 - mp34 - mp35 - mp36 - mp37 - mp38 - mp39 - mp40 - mp41 - mp42 - mp43 - mp44 - mp45 - mp46 - mp47 - mp48 - mp49 - mp50 - mp51 - mp52 - mp53 - mp54 - mp55 - mp56 - mp57 - mp58 - mp59 - mp60 - mp61 - mp62 - mp63 - mp64 - mp65 - mp66 - mp67 - mp68 - mp69 - mp70 - mp71 - mp72 - mp73 - mp74 - mp75 - mp76 - mp77 - mp78 - mp79 - mp80 - mp81 - mp82 - mp83 - mp84 - mp85 - mp86 - mp87 - mp88 - mp89 - mp90 - mp91 - mp92 - mp93 - mp94 - mp95 - mp96 - mp97 - mp98 - mp99 - mp100 - mp101 - mp102 - mp103 - mp104 - mp105 - mp106 - mp107 - mp108 - mp109 - mp110 - mp111 - mp112 - mp113 - mp114 - mp115 - mp116 - mp117 - mp118 - mp119 - mp120 - mp121 - mp122 - mp123 - mp124 - mp125 - mp126 - mp127 - mp128 - mp129 - mp130 - mp131 - mp132 - mp133 - mp134 - mp135 - mp136 - mp137 - mp138 - mp139 - mp140 - mp141 - mp142 - mp143 - mp144 - mp145 - mp146 - mp147 - mp148 - mp149 - mp150 - mp151 - mp152 - mp153 - mp154 - mp155 - mp156 - mp157 - mp158 - mp159 - mp160 - mp161 - mp162 - mp163 - mp164 - mp165 - mp166 - mp167 - mp168 - mp169 - mp170 - mp171 - mp172 - mp173 - mp174 - mp175 - mp176 - mp177 - mp178 - mp179 - mp180 - mp181 - mp182 - mp183 - mp184 - mp185 - mp186 - mp187 - mp188 - mp189 - mp190 - mp191 - mp192 - mp193 - mp194 - mp195 - mp196 - mp197 - mp198 - mp199 - mp200 - mp201 - mp202 - mp203 - mp204 - mp205 - mp206 - mp207 - mp208 - mp209 - mp210 - mp211 - mp212 - mp213 - mp214 - mp215 - mp216 - mp217 - mp218 - mp219 - mp220 - mp221 - mp222 - mp223 - mp224 - mp225 - mp226 - mp227 - mp228 - mp229 - mp230 - mp231 - mp232 - mp233 - mp234 - mp235 - mp236 - mp237 - mp238 - mp239 - mp240 - mp241 - mp242 - mp243 - mp244 - mp245 - mp246 - mp247 - mp248 - mp249 - mp250 - mp251 - mp252 - mp253 - mp254 - mp255 - unused0 - unused1 - unused2 - unused3 - unused4 - unused5 - unused6 - unused7 - unused8 - unused9 - unused10 - unused11 - unused12 - unused13 - unused14 - unused15 - unused16 - unused17 - unused18 - unused19 - unused20 - unused21 - unused22 - unused23 - unused24 - unused25 - unused26 - unused27 - unused28 - unused29 - unused30 - unused31 - unused32 - unused33 - unused34 - unused35 - unused36 - unused37 - unused38 - unused39 - unused40 - unused41 - unused42 - unused43 - unused44 - unused45 - unused46 - unused47 - unused48 - unused49 - unused50 - unused51 - unused52 - unused53 - unused54 - unused55 - unused56 - unused57 - unused58 - unused59 - unused60 - unused61 - unused62 - unused63 - unused64 - unused65 - unused66 - unused67 - unused68 - unused69 - unused70 - unused71 - unused72 - unused73 - unused74 - unused75 - unused76 - unused77 - unused78 - unused79 - unused80 - unused81 - unused82 - unused83 - unused84 - unused85 - unused86 - unused87 - unused88 - unused89 - unused90 - unused91 - unused92 - unused93 - unused94 - unused95 - unused96 - unused97 - unused98 - unused99 - unused100 - unused101 - unused102 - unused103 - unused104 - unused105 - unused106 - unused107 - unused108 - unused109 - unused110 - unused111 - unused112 - unused113 - unused114 - unused115 - unused116 - unused117 - unused118 - unused119 - unused120 - unused121 - unused122 - unused123 - unused124 - unused125 - unused126 - unused127 - unused128 - unused129 - unused130 - unused131 - unused132 - unused133 - unused134 - unused135 - unused136 - unused137 - unused138 - unused139 - unused140 - unused141 - unused142 - unused143 - unused144 - unused145 - unused146 - unused147 - unused148 - unused149 - unused150 - unused151 - unused152 - unused153 - unused154 - unused155 - unused156 - unused157 - unused158 - unused159 - unused160 - unused161 - unused162 - unused163 - unused164 - unused165 - unused166 - unused167 - unused168 - unused169 - unused170 - unused171 - unused172 - unused173 - unused174 - unused175 - unused176 - unused177 - unused178 - unused179 - unused180 - unused181 - unused182 - unused183 - unused184 - unused185 - unused186 - unused187 - unused188 - unused189 - unused190 - unused191 - unused192 - unused193 - unused194 - unused195 - unused196 - unused197 - unused198 - unused199 - unused200 - unused201 - unused202 - unused203 - unused204 - unused205 - unused206 - unused207 - unused208 - unused209 - unused210 - unused211 - unused212 - unused213 - unused214 - unused215 - unused216 - unused217 - unused218 - unused219 - unused220 - unused221 - unused222 - unused223 - unused224 - unused225 - unused226 - unused227 - unused228 - unused229 - unused230 - unused231 - unused232 - unused233 - unused234 - unused235 - unused236 - unused237 - unused238 - unused239 - unused240 - unused241 - unused242 - unused243 - unused244 - unused245 - unused246 - unused247 - unused248 - unused249 - unused250 - unused251 - unused252 - unused253 - unused254 - unused255 type: string requestBody: content: application/json: schema: properties: bwlimit: description: Override I/O bandwidth limit (in KiB/s). type: number delete: description: Delete the original volume after successful copy. By default the original is kept as an unused volume entry. type: boolean digest: description: |- Prevent changes if current configuration file has different SHA1 " . "digest. This can be used to prevent concurrent modifications. type: string node: description: The cluster node name. format: pve-node type: string storage: description: Target Storage. format: pve-storage-id type: string target-digest: description: |- Prevent changes if current configuration file of the target " . "container has a different SHA1 digest. This can be used to prevent " . "concurrent modifications. type: string target-vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer target-volume: description: The config key the volume will be moved to. Default is the source volume key. enum: - rootfs - mp0 - mp1 - mp2 - mp3 - mp4 - mp5 - mp6 - mp7 - mp8 - mp9 - mp10 - mp11 - mp12 - mp13 - mp14 - mp15 - mp16 - mp17 - mp18 - mp19 - mp20 - mp21 - mp22 - mp23 - mp24 - mp25 - mp26 - mp27 - mp28 - mp29 - mp30 - mp31 - mp32 - mp33 - mp34 - mp35 - mp36 - mp37 - mp38 - mp39 - mp40 - mp41 - mp42 - mp43 - mp44 - mp45 - mp46 - mp47 - mp48 - mp49 - mp50 - mp51 - mp52 - mp53 - mp54 - mp55 - mp56 - mp57 - mp58 - mp59 - mp60 - mp61 - mp62 - mp63 - mp64 - mp65 - mp66 - mp67 - mp68 - mp69 - mp70 - mp71 - mp72 - mp73 - mp74 - mp75 - mp76 - mp77 - mp78 - mp79 - mp80 - mp81 - mp82 - mp83 - mp84 - mp85 - mp86 - mp87 - mp88 - mp89 - mp90 - mp91 - mp92 - mp93 - mp94 - mp95 - mp96 - mp97 - mp98 - mp99 - mp100 - mp101 - mp102 - mp103 - mp104 - mp105 - mp106 - mp107 - mp108 - mp109 - mp110 - mp111 - mp112 - mp113 - mp114 - mp115 - mp116 - mp117 - mp118 - mp119 - mp120 - mp121 - mp122 - mp123 - mp124 - mp125 - mp126 - mp127 - mp128 - mp129 - mp130 - mp131 - mp132 - mp133 - mp134 - mp135 - mp136 - mp137 - mp138 - mp139 - mp140 - mp141 - mp142 - mp143 - mp144 - mp145 - mp146 - mp147 - mp148 - mp149 - mp150 - mp151 - mp152 - mp153 - mp154 - mp155 - mp156 - mp157 - mp158 - mp159 - mp160 - mp161 - mp162 - mp163 - mp164 - mp165 - mp166 - mp167 - mp168 - mp169 - mp170 - mp171 - mp172 - mp173 - mp174 - mp175 - mp176 - mp177 - mp178 - mp179 - mp180 - mp181 - mp182 - mp183 - mp184 - mp185 - mp186 - mp187 - mp188 - mp189 - mp190 - mp191 - mp192 - mp193 - mp194 - mp195 - mp196 - mp197 - mp198 - mp199 - mp200 - mp201 - mp202 - mp203 - mp204 - mp205 - mp206 - mp207 - mp208 - mp209 - mp210 - mp211 - mp212 - mp213 - mp214 - mp215 - mp216 - mp217 - mp218 - mp219 - mp220 - mp221 - mp222 - mp223 - mp224 - mp225 - mp226 - mp227 - mp228 - mp229 - mp230 - mp231 - mp232 - mp233 - mp234 - mp235 - mp236 - mp237 - mp238 - mp239 - mp240 - mp241 - mp242 - mp243 - mp244 - mp245 - mp246 - mp247 - mp248 - mp249 - mp250 - mp251 - mp252 - mp253 - mp254 - mp255 - unused0 - unused1 - unused2 - unused3 - unused4 - unused5 - unused6 - unused7 - unused8 - unused9 - unused10 - unused11 - unused12 - unused13 - unused14 - unused15 - unused16 - unused17 - unused18 - unused19 - unused20 - unused21 - unused22 - unused23 - unused24 - unused25 - unused26 - unused27 - unused28 - unused29 - unused30 - unused31 - unused32 - unused33 - unused34 - unused35 - unused36 - unused37 - unused38 - unused39 - unused40 - unused41 - unused42 - unused43 - unused44 - unused45 - unused46 - unused47 - unused48 - unused49 - unused50 - unused51 - unused52 - unused53 - unused54 - unused55 - unused56 - unused57 - unused58 - unused59 - unused60 - unused61 - unused62 - unused63 - unused64 - unused65 - unused66 - unused67 - unused68 - unused69 - unused70 - unused71 - unused72 - unused73 - unused74 - unused75 - unused76 - unused77 - unused78 - unused79 - unused80 - unused81 - unused82 - unused83 - unused84 - unused85 - unused86 - unused87 - unused88 - unused89 - unused90 - unused91 - unused92 - unused93 - unused94 - unused95 - unused96 - unused97 - unused98 - unused99 - unused100 - unused101 - unused102 - unused103 - unused104 - unused105 - unused106 - unused107 - unused108 - unused109 - unused110 - unused111 - unused112 - unused113 - unused114 - unused115 - unused116 - unused117 - unused118 - unused119 - unused120 - unused121 - unused122 - unused123 - unused124 - unused125 - unused126 - unused127 - unused128 - unused129 - unused130 - unused131 - unused132 - unused133 - unused134 - unused135 - unused136 - unused137 - unused138 - unused139 - unused140 - unused141 - unused142 - unused143 - unused144 - unused145 - unused146 - unused147 - unused148 - unused149 - unused150 - unused151 - unused152 - unused153 - unused154 - unused155 - unused156 - unused157 - unused158 - unused159 - unused160 - unused161 - unused162 - unused163 - unused164 - unused165 - unused166 - unused167 - unused168 - unused169 - unused170 - unused171 - unused172 - unused173 - unused174 - unused175 - unused176 - unused177 - unused178 - unused179 - unused180 - unused181 - unused182 - unused183 - unused184 - unused185 - unused186 - unused187 - unused188 - unused189 - unused190 - unused191 - unused192 - unused193 - unused194 - unused195 - unused196 - unused197 - unused198 - unused199 - unused200 - unused201 - unused202 - unused203 - unused204 - unused205 - unused206 - unused207 - unused208 - unused209 - unused210 - unused211 - unused212 - unused213 - unused214 - unused215 - unused216 - unused217 - unused218 - unused219 - unused220 - unused221 - unused222 - unused223 - unused224 - unused225 - unused226 - unused227 - unused228 - unused229 - unused230 - unused231 - unused232 - unused233 - unused234 - unused235 - unused236 - unused237 - unused238 - unused239 - unused240 - unused241 - unused242 - unused243 - unused244 - unused245 - unused246 - unused247 - unused248 - unused249 - unused250 - unused251 - unused252 - unused253 - unused254 - unused255 type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer volume: description: Volume which will be moved. enum: - rootfs - mp0 - mp1 - mp2 - mp3 - mp4 - mp5 - mp6 - mp7 - mp8 - mp9 - mp10 - mp11 - mp12 - mp13 - mp14 - mp15 - mp16 - mp17 - mp18 - mp19 - mp20 - mp21 - mp22 - mp23 - mp24 - mp25 - mp26 - mp27 - mp28 - mp29 - mp30 - mp31 - mp32 - mp33 - mp34 - mp35 - mp36 - mp37 - mp38 - mp39 - mp40 - mp41 - mp42 - mp43 - mp44 - mp45 - mp46 - mp47 - mp48 - mp49 - mp50 - mp51 - mp52 - mp53 - mp54 - mp55 - mp56 - mp57 - mp58 - mp59 - mp60 - mp61 - mp62 - mp63 - mp64 - mp65 - mp66 - mp67 - mp68 - mp69 - mp70 - mp71 - mp72 - mp73 - mp74 - mp75 - mp76 - mp77 - mp78 - mp79 - mp80 - mp81 - mp82 - mp83 - mp84 - mp85 - mp86 - mp87 - mp88 - mp89 - mp90 - mp91 - mp92 - mp93 - mp94 - mp95 - mp96 - mp97 - mp98 - mp99 - mp100 - mp101 - mp102 - mp103 - mp104 - mp105 - mp106 - mp107 - mp108 - mp109 - mp110 - mp111 - mp112 - mp113 - mp114 - mp115 - mp116 - mp117 - mp118 - mp119 - mp120 - mp121 - mp122 - mp123 - mp124 - mp125 - mp126 - mp127 - mp128 - mp129 - mp130 - mp131 - mp132 - mp133 - mp134 - mp135 - mp136 - mp137 - mp138 - mp139 - mp140 - mp141 - mp142 - mp143 - mp144 - mp145 - mp146 - mp147 - mp148 - mp149 - mp150 - mp151 - mp152 - mp153 - mp154 - mp155 - mp156 - mp157 - mp158 - mp159 - mp160 - mp161 - mp162 - mp163 - mp164 - mp165 - mp166 - mp167 - mp168 - mp169 - mp170 - mp171 - mp172 - mp173 - mp174 - mp175 - mp176 - mp177 - mp178 - mp179 - mp180 - mp181 - mp182 - mp183 - mp184 - mp185 - mp186 - mp187 - mp188 - mp189 - mp190 - mp191 - mp192 - mp193 - mp194 - mp195 - mp196 - mp197 - mp198 - mp199 - mp200 - mp201 - mp202 - mp203 - mp204 - mp205 - mp206 - mp207 - mp208 - mp209 - mp210 - mp211 - mp212 - mp213 - mp214 - mp215 - mp216 - mp217 - mp218 - mp219 - mp220 - mp221 - mp222 - mp223 - mp224 - mp225 - mp226 - mp227 - mp228 - mp229 - mp230 - mp231 - mp232 - mp233 - mp234 - mp235 - mp236 - mp237 - mp238 - mp239 - mp240 - mp241 - mp242 - mp243 - mp244 - mp245 - mp246 - mp247 - mp248 - mp249 - mp250 - mp251 - mp252 - mp253 - mp254 - mp255 - unused0 - unused1 - unused2 - unused3 - unused4 - unused5 - unused6 - unused7 - unused8 - unused9 - unused10 - unused11 - unused12 - unused13 - unused14 - unused15 - unused16 - unused17 - unused18 - unused19 - unused20 - unused21 - unused22 - unused23 - unused24 - unused25 - unused26 - unused27 - unused28 - unused29 - unused30 - unused31 - unused32 - unused33 - unused34 - unused35 - unused36 - unused37 - unused38 - unused39 - unused40 - unused41 - unused42 - unused43 - unused44 - unused45 - unused46 - unused47 - unused48 - unused49 - unused50 - unused51 - unused52 - unused53 - unused54 - unused55 - unused56 - unused57 - unused58 - unused59 - unused60 - unused61 - unused62 - unused63 - unused64 - unused65 - unused66 - unused67 - unused68 - unused69 - unused70 - unused71 - unused72 - unused73 - unused74 - unused75 - unused76 - unused77 - unused78 - unused79 - unused80 - unused81 - unused82 - unused83 - unused84 - unused85 - unused86 - unused87 - unused88 - unused89 - unused90 - unused91 - unused92 - unused93 - unused94 - unused95 - unused96 - unused97 - unused98 - unused99 - unused100 - unused101 - unused102 - unused103 - unused104 - unused105 - unused106 - unused107 - unused108 - unused109 - unused110 - unused111 - unused112 - unused113 - unused114 - unused115 - unused116 - unused117 - unused118 - unused119 - unused120 - unused121 - unused122 - unused123 - unused124 - unused125 - unused126 - unused127 - unused128 - unused129 - unused130 - unused131 - unused132 - unused133 - unused134 - unused135 - unused136 - unused137 - unused138 - unused139 - unused140 - unused141 - unused142 - unused143 - unused144 - unused145 - unused146 - unused147 - unused148 - unused149 - unused150 - unused151 - unused152 - unused153 - unused154 - unused155 - unused156 - unused157 - unused158 - unused159 - unused160 - unused161 - unused162 - unused163 - unused164 - unused165 - unused166 - unused167 - unused168 - unused169 - unused170 - unused171 - unused172 - unused173 - unused174 - unused175 - unused176 - unused177 - unused178 - unused179 - unused180 - unused181 - unused182 - unused183 - unused184 - unused185 - unused186 - unused187 - unused188 - unused189 - unused190 - unused191 - unused192 - unused193 - unused194 - unused195 - unused196 - unused197 - unused198 - unused199 - unused200 - unused201 - unused202 - unused203 - unused204 - unused205 - unused206 - unused207 - unused208 - unused209 - unused210 - unused211 - unused212 - unused213 - unused214 - unused215 - unused216 - unused217 - unused218 - unused219 - unused220 - unused221 - unused222 - unused223 - unused224 - unused225 - unused226 - unused227 - unused228 - unused229 - unused230 - unused231 - unused232 - unused233 - unused234 - unused235 - unused236 - unused237 - unused238 - unused239 - unused240 - unused241 - unused242 - unused243 - unused244 - unused245 - unused246 - unused247 - unused248 - unused249 - unused250 - unused251 - unused252 - unused253 - unused254 - unused255 type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Move a rootfs-/mp-volume to a different storage or to a different container. /nodes/{node}/lxc/{vmid}/mtunnel: post: operationId: post_nodes_node_lxc_vmid_mtunnel parameters: - description: List of network bridges to check availability. Will be checked again for actually used bridges during migration. in: query name: bridges required: false schema: description: List of network bridges to check availability. Will be checked again for actually used bridges during migration. format: pve-bridge-id-list type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: List of storages to check permission and availability. Will be checked again for all actually used storages during migration. in: query name: storages required: false schema: description: List of storages to check permission and availability. Will be checked again for all actually used storages during migration. format: pve-storage-id-list type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: bridges: description: List of network bridges to check availability. Will be checked again for actually used bridges during migration. format: pve-bridge-id-list type: string node: description: The cluster node name. format: pve-node type: string storages: description: List of storages to check permission and availability. Will be checked again for all actually used storages during migration. format: pve-storage-id-list type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: properties: socket: type: string ticket: type: string upid: type: string type: object description: OK summary: Migration tunnel endpoint - only for internal use by CT migration. /nodes/{node}/lxc/{vmid}/mtunnelwebsocket: get: operationId: get_nodes_node_lxc_vmid_mtunnelwebsocket parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: unix socket to forward to in: query name: socket required: false schema: description: unix socket to forward to type: string - description: ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command in: query name: ticket required: false schema: description: ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: port: type: string socket: type: string type: object description: OK summary: Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration. /nodes/{node}/lxc/{vmid}/pending: get: operationId: get_nodes_node_lxc_vmid_pending parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: delete: description: Indicates a pending delete request if present and not 0. type: integer key: description: Configuration option name. type: string pending: description: Pending value. type: string value: description: Current value. type: string type: object type: array description: OK summary: Get container configuration, including pending changes. /nodes/{node}/lxc/{vmid}/remote_migrate: post: operationId: post_nodes_node_lxc_vmid_remote_migrate parameters: - description: Override I/O bandwidth limit (in KiB/s). in: query name: bwlimit required: false schema: description: Override I/O bandwidth limit (in KiB/s). type: number - description: Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state. in: query name: delete required: false schema: description: Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Use online/live migration. in: query name: online required: false schema: description: Use online/live migration. type: boolean - description: Use restart migration in: query name: restart required: false schema: description: Use restart migration type: boolean - description: Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. in: query name: target-bridge required: false schema: description: Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. format: bridge-pair-list type: string - description: Remote target endpoint in: query name: target-endpoint required: false schema: description: Remote target endpoint format: proxmox-remote type: string - description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. in: query name: target-storage required: true schema: description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. format: storage-pair-list type: string - description: The (unique) ID of the VM. in: query name: target-vmid required: false schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Timeout in seconds for shutdown for restart migration in: query name: timeout required: false schema: description: Timeout in seconds for shutdown for restart migration type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: bwlimit: description: Override I/O bandwidth limit (in KiB/s). type: number delete: description: Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state. type: boolean node: description: The cluster node name. format: pve-node type: string online: description: Use online/live migration. type: boolean restart: description: Use restart migration type: boolean target-bridge: description: Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. format: bridge-pair-list type: string target-endpoint: description: Remote target endpoint format: proxmox-remote type: string target-storage: description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. format: storage-pair-list type: string target-vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer timeout: description: Timeout in seconds for shutdown for restart migration type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer required: - target-storage type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Migrate the container to another cluster. Creates a new migration task. EXPERIMENTAL feature! /nodes/{node}/lxc/{vmid}/resize: put: operationId: put_nodes_node_lxc_vmid_resize parameters: - description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string - description: The disk you want to resize. in: query name: disk required: false schema: description: The disk you want to resize. enum: - rootfs - mp0 - mp1 - mp2 - mp3 - mp4 - mp5 - mp6 - mp7 - mp8 - mp9 - mp10 - mp11 - mp12 - mp13 - mp14 - mp15 - mp16 - mp17 - mp18 - mp19 - mp20 - mp21 - mp22 - mp23 - mp24 - mp25 - mp26 - mp27 - mp28 - mp29 - mp30 - mp31 - mp32 - mp33 - mp34 - mp35 - mp36 - mp37 - mp38 - mp39 - mp40 - mp41 - mp42 - mp43 - mp44 - mp45 - mp46 - mp47 - mp48 - mp49 - mp50 - mp51 - mp52 - mp53 - mp54 - mp55 - mp56 - mp57 - mp58 - mp59 - mp60 - mp61 - mp62 - mp63 - mp64 - mp65 - mp66 - mp67 - mp68 - mp69 - mp70 - mp71 - mp72 - mp73 - mp74 - mp75 - mp76 - mp77 - mp78 - mp79 - mp80 - mp81 - mp82 - mp83 - mp84 - mp85 - mp86 - mp87 - mp88 - mp89 - mp90 - mp91 - mp92 - mp93 - mp94 - mp95 - mp96 - mp97 - mp98 - mp99 - mp100 - mp101 - mp102 - mp103 - mp104 - mp105 - mp106 - mp107 - mp108 - mp109 - mp110 - mp111 - mp112 - mp113 - mp114 - mp115 - mp116 - mp117 - mp118 - mp119 - mp120 - mp121 - mp122 - mp123 - mp124 - mp125 - mp126 - mp127 - mp128 - mp129 - mp130 - mp131 - mp132 - mp133 - mp134 - mp135 - mp136 - mp137 - mp138 - mp139 - mp140 - mp141 - mp142 - mp143 - mp144 - mp145 - mp146 - mp147 - mp148 - mp149 - mp150 - mp151 - mp152 - mp153 - mp154 - mp155 - mp156 - mp157 - mp158 - mp159 - mp160 - mp161 - mp162 - mp163 - mp164 - mp165 - mp166 - mp167 - mp168 - mp169 - mp170 - mp171 - mp172 - mp173 - mp174 - mp175 - mp176 - mp177 - mp178 - mp179 - mp180 - mp181 - mp182 - mp183 - mp184 - mp185 - mp186 - mp187 - mp188 - mp189 - mp190 - mp191 - mp192 - mp193 - mp194 - mp195 - mp196 - mp197 - mp198 - mp199 - mp200 - mp201 - mp202 - mp203 - mp204 - mp205 - mp206 - mp207 - mp208 - mp209 - mp210 - mp211 - mp212 - mp213 - mp214 - mp215 - mp216 - mp217 - mp218 - mp219 - mp220 - mp221 - mp222 - mp223 - mp224 - mp225 - mp226 - mp227 - mp228 - mp229 - mp230 - mp231 - mp232 - mp233 - mp234 - mp235 - mp236 - mp237 - mp238 - mp239 - mp240 - mp241 - mp242 - mp243 - mp244 - mp245 - mp246 - mp247 - mp248 - mp249 - mp250 - mp251 - mp252 - mp253 - mp254 - mp255 type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. in: query name: size required: false schema: description: The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: digest: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string disk: description: The disk you want to resize. enum: - rootfs - mp0 - mp1 - mp2 - mp3 - mp4 - mp5 - mp6 - mp7 - mp8 - mp9 - mp10 - mp11 - mp12 - mp13 - mp14 - mp15 - mp16 - mp17 - mp18 - mp19 - mp20 - mp21 - mp22 - mp23 - mp24 - mp25 - mp26 - mp27 - mp28 - mp29 - mp30 - mp31 - mp32 - mp33 - mp34 - mp35 - mp36 - mp37 - mp38 - mp39 - mp40 - mp41 - mp42 - mp43 - mp44 - mp45 - mp46 - mp47 - mp48 - mp49 - mp50 - mp51 - mp52 - mp53 - mp54 - mp55 - mp56 - mp57 - mp58 - mp59 - mp60 - mp61 - mp62 - mp63 - mp64 - mp65 - mp66 - mp67 - mp68 - mp69 - mp70 - mp71 - mp72 - mp73 - mp74 - mp75 - mp76 - mp77 - mp78 - mp79 - mp80 - mp81 - mp82 - mp83 - mp84 - mp85 - mp86 - mp87 - mp88 - mp89 - mp90 - mp91 - mp92 - mp93 - mp94 - mp95 - mp96 - mp97 - mp98 - mp99 - mp100 - mp101 - mp102 - mp103 - mp104 - mp105 - mp106 - mp107 - mp108 - mp109 - mp110 - mp111 - mp112 - mp113 - mp114 - mp115 - mp116 - mp117 - mp118 - mp119 - mp120 - mp121 - mp122 - mp123 - mp124 - mp125 - mp126 - mp127 - mp128 - mp129 - mp130 - mp131 - mp132 - mp133 - mp134 - mp135 - mp136 - mp137 - mp138 - mp139 - mp140 - mp141 - mp142 - mp143 - mp144 - mp145 - mp146 - mp147 - mp148 - mp149 - mp150 - mp151 - mp152 - mp153 - mp154 - mp155 - mp156 - mp157 - mp158 - mp159 - mp160 - mp161 - mp162 - mp163 - mp164 - mp165 - mp166 - mp167 - mp168 - mp169 - mp170 - mp171 - mp172 - mp173 - mp174 - mp175 - mp176 - mp177 - mp178 - mp179 - mp180 - mp181 - mp182 - mp183 - mp184 - mp185 - mp186 - mp187 - mp188 - mp189 - mp190 - mp191 - mp192 - mp193 - mp194 - mp195 - mp196 - mp197 - mp198 - mp199 - mp200 - mp201 - mp202 - mp203 - mp204 - mp205 - mp206 - mp207 - mp208 - mp209 - mp210 - mp211 - mp212 - mp213 - mp214 - mp215 - mp216 - mp217 - mp218 - mp219 - mp220 - mp221 - mp222 - mp223 - mp224 - mp225 - mp226 - mp227 - mp228 - mp229 - mp230 - mp231 - mp232 - mp233 - mp234 - mp235 - mp236 - mp237 - mp238 - mp239 - mp240 - mp241 - mp242 - mp243 - mp244 - mp245 - mp246 - mp247 - mp248 - mp249 - mp250 - mp251 - mp252 - mp253 - mp254 - mp255 type: string node: description: The cluster node name. format: pve-node type: string size: description: The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Resize a container mount point. /nodes/{node}/lxc/{vmid}/rrd: get: operationId: get_nodes_node_lxc_vmid_rrd parameters: - description: The RRD consolidation function in: query name: cf required: false schema: description: The RRD consolidation function enum: - AVERAGE - MAX type: string - description: The list of datasources you want to display. in: query name: ds required: false schema: description: The list of datasources you want to display. format: pve-configid-list type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Specify the time frame you are interested in. in: query name: timeframe required: false schema: description: Specify the time frame you are interested in. enum: - hour - day - week - month - year type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: filename: type: string type: object description: OK summary: Read VM RRD statistics (returns PNG) /nodes/{node}/lxc/{vmid}/rrddata: get: operationId: get_nodes_node_lxc_vmid_rrddata parameters: - description: The RRD consolidation function in: query name: cf required: false schema: description: The RRD consolidation function enum: - AVERAGE - MAX type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Specify the time frame you are interested in. in: query name: timeframe required: false schema: description: Specify the time frame you are interested in. enum: - hour - day - week - month - year type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Read VM RRD statistics /nodes/{node}/lxc/{vmid}/snapshot: get: operationId: get_nodes_node_lxc_vmid_snapshot parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: description: description: Snapshot description. type: string name: description: Snapshot identifier. Value 'current' identifies the current VM. type: string parent: description: Parent snapshot identifier. type: string snaptime: description: Snapshot creation time type: integer type: object type: array description: OK summary: List all snapshots. post: operationId: post_nodes_node_lxc_vmid_snapshot parameters: - description: A textual description or comment. in: query name: description required: false schema: description: A textual description or comment. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: query name: snapname required: false schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: description: description: A textual description or comment. type: string node: description: The cluster node name. format: pve-node type: string snapname: description: The name of the snapshot. format: pve-configid type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Snapshot a container. /nodes/{node}/lxc/{vmid}/snapshot/{snapname}: delete: operationId: delete_nodes_node_lxc_vmid_snapshot_snapname parameters: - description: For removal from config file, even if removing disk snapshots fails. in: query name: force required: false schema: description: For removal from config file, even if removing disk snapshots fails. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: path name: snapname required: true schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Delete a LXC snapshot. get: operationId: get_nodes_node_lxc_vmid_snapshot_snapname parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: path name: snapname required: true schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: "" /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config: get: operationId: get_nodes_node_lxc_vmid_snapshot_snapname_config parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: path name: snapname required: true schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: type: object description: OK summary: Get snapshot configuration put: operationId: put_nodes_node_lxc_vmid_snapshot_snapname_config parameters: - description: A textual description or comment. in: query name: description required: false schema: description: A textual description or comment. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: path name: snapname required: true schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: description: description: A textual description or comment. type: string node: description: The cluster node name. format: pve-node type: string snapname: description: The name of the snapshot. format: pve-configid type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update snapshot metadata. /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback: post: operationId: post_nodes_node_lxc_vmid_snapshot_snapname_rollback parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: path name: snapname required: true schema: description: The name of the snapshot. format: pve-configid type: string - description: Whether the container should get started after rolling back successfully in: query name: start required: false schema: description: Whether the container should get started after rolling back successfully type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string snapname: description: The name of the snapshot. format: pve-configid type: string start: description: Whether the container should get started after rolling back successfully type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Rollback LXC state to specified snapshot. /nodes/{node}/lxc/{vmid}/spiceproxy: post: operationId: post_nodes_node_lxc_vmid_spiceproxy parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). in: query name: proxy required: false schema: description: SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). format: address type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string proxy: description: SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). format: address type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returned values can be directly passed to the 'remote-viewer' application. properties: host: type: string password: type: string proxy: type: string tls-port: type: integer type: type: string type: object description: OK summary: Returns a SPICE configuration to connect to the CT. /nodes/{node}/lxc/{vmid}/status: get: operationId: get_nodes_node_lxc_vmid_status parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: Directory index /nodes/{node}/lxc/{vmid}/status/current: get: operationId: get_nodes_node_lxc_vmid_status_current parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: cpu: description: Current CPU usage. type: number cpus: description: Maximum usable CPUs. type: number disk: description: Root disk image space-usage in bytes. type: integer diskread: description: 'The amount of bytes the guest read from it''s block devices since the guest was started. (Note: This info is not available for all storage types.)' type: integer diskwrite: description: 'The amount of bytes the guest wrote from it''s block devices since the guest was started. (Note: This info is not available for all storage types.)' type: integer ha: description: HA manager service status. type: object lock: description: The current config lock, if any. type: string maxdisk: description: Root disk image size in bytes. type: integer maxmem: description: Maximum memory in bytes. type: integer maxswap: description: Maximum SWAP memory in bytes. type: integer mem: description: Currently used memory in bytes. type: integer name: description: Container name. type: string netin: description: The amount of traffic in bytes that was sent to the guest over the network since it was started. type: integer netout: description: The amount of traffic in bytes that was sent from the guest over the network since it was started. type: integer pressurecpusome: description: CPU Some pressure stall average over the last 10 seconds. type: number pressureiofull: description: IO Full pressure stall average over the last 10 seconds. type: number pressureiosome: description: IO Some pressure stall average over the last 10 seconds. type: number pressurememoryfull: description: Memory Full pressure stall average over the last 10 seconds. type: number pressurememorysome: description: Memory Some pressure stall average over the last 10 seconds. type: number status: description: LXC Container status. enum: - stopped - running type: string tags: description: The current configured tags, if any. type: string template: description: Determines if the guest is a template. type: boolean uptime: description: Uptime in seconds. type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object description: OK summary: Get virtual machine status. /nodes/{node}/lxc/{vmid}/status/reboot: post: operationId: post_nodes_node_lxc_vmid_status_reboot parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Wait maximal timeout seconds for the shutdown. in: query name: timeout required: false schema: description: Wait maximal timeout seconds for the shutdown. type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string timeout: description: Wait maximal timeout seconds for the shutdown. type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Reboot the container by shutting it down, and starting it again. Applies pending changes. /nodes/{node}/lxc/{vmid}/status/resume: post: operationId: post_nodes_node_lxc_vmid_status_resume parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Resume the container. /nodes/{node}/lxc/{vmid}/status/shutdown: post: operationId: post_nodes_node_lxc_vmid_status_shutdown parameters: - description: Make sure the Container stops. in: query name: forceStop required: false schema: description: Make sure the Container stops. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Wait maximal timeout seconds. in: query name: timeout required: false schema: description: Wait maximal timeout seconds. type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: forceStop: description: Make sure the Container stops. type: boolean node: description: The cluster node name. format: pve-node type: string timeout: description: Wait maximal timeout seconds. type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details. /nodes/{node}/lxc/{vmid}/status/start: post: operationId: post_nodes_node_lxc_vmid_status_start parameters: - description: If set, enables very verbose debug log-level on start. in: query name: debug required: false schema: description: If set, enables very verbose debug log-level on start. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: debug: description: If set, enables very verbose debug log-level on start. type: boolean node: description: The cluster node name. format: pve-node type: string skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Start the container. /nodes/{node}/lxc/{vmid}/status/stop: post: operationId: post_nodes_node_lxc_vmid_status_stop parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Try to abort active 'vzshutdown' tasks before stopping. in: query name: overrule-shutdown required: false schema: description: Try to abort active 'vzshutdown' tasks before stopping. type: boolean - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string overrule-shutdown: description: Try to abort active 'vzshutdown' tasks before stopping. type: boolean skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Stop the container. This will abruptly stop all processes running in the container. /nodes/{node}/lxc/{vmid}/status/suspend: post: operationId: post_nodes_node_lxc_vmid_status_suspend parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Suspend the container. This is experimental. /nodes/{node}/lxc/{vmid}/template: post: operationId: post_nodes_node_lxc_vmid_template parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create a Template. /nodes/{node}/lxc/{vmid}/termproxy: post: operationId: post_nodes_node_lxc_vmid_termproxy parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: properties: port: type: integer ticket: type: string upid: type: string user: type: string type: object description: OK summary: Creates a TCP proxy connection. /nodes/{node}/lxc/{vmid}/vncproxy: post: operationId: post_nodes_node_lxc_vmid_vncproxy parameters: - description: sets the height of the console in pixels. in: query name: height required: false schema: description: sets the height of the console in pixels. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: use websocket instead of standard VNC. in: query name: websocket required: false schema: description: use websocket instead of standard VNC. type: boolean - description: sets the width of the console in pixels. in: query name: width required: false schema: description: sets the width of the console in pixels. type: integer requestBody: content: application/json: schema: properties: height: description: sets the height of the console in pixels. type: integer node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer websocket: description: use websocket instead of standard VNC. type: boolean width: description: sets the width of the console in pixels. type: integer type: object responses: "200": content: application/json: schema: properties: cert: type: string password: description: Password used for authentication within the VNC protocol. Consists of printable ASCII characters ('!' .. '~'). type: string port: type: integer ticket: type: string upid: type: string user: type: string type: object description: OK summary: Creates a TCP VNC proxy connections. /nodes/{node}/lxc/{vmid}/vncwebsocket: get: operationId: get_nodes_node_lxc_vmid_vncwebsocket parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Port number returned by previous vncproxy call. in: query name: port required: false schema: description: Port number returned by previous vncproxy call. type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Ticket from previous call to vncproxy. in: query name: vncticket required: false schema: description: Ticket from previous call to vncproxy. type: string responses: "200": content: application/json: schema: properties: port: type: string type: object description: OK summary: Opens a websocket for VNC traffic. /nodes/{node}/migrateall: post: operationId: post_nodes_node_migrateall parameters: - description: Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set! in: query name: max-workers required: false schema: description: Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set! type: integer - description: Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set!Deprecated, use 'max-workers' instead. in: query name: maxworkers required: false schema: description: Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set!Deprecated, use 'max-workers' instead. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Target node. in: query name: target required: false schema: description: Target node. format: pve-node type: string - description: Only consider Guests with these IDs. in: query name: vms required: false schema: description: Only consider Guests with these IDs. format: pve-vmid-list type: string - description: Enable live storage migration for local disk in: query name: with-local-disks required: false schema: description: Enable live storage migration for local disk type: boolean requestBody: content: application/json: schema: properties: max-workers: description: Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set! type: integer maxworkers: description: Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set!Deprecated, use 'max-workers' instead. type: integer node: description: The cluster node name. format: pve-node type: string target: description: Target node. format: pve-node type: string vms: description: Only consider Guests with these IDs. format: pve-vmid-list type: string with-local-disks: description: Enable live storage migration for local disk type: boolean type: object responses: "200": content: application/json: schema: type: string description: OK summary: Migrate all VMs and Containers. /nodes/{node}/netstat: get: operationId: get_nodes_node_netstat parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Read tap/vm network device interface counters /nodes/{node}/network: delete: operationId: delete_nodes_node_network parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Revert network configuration changes. get: operationId: get_nodes_node_network parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Only list specific interface types. in: query name: type required: false schema: description: Only list specific interface types. enum: - bridge - bond - eth - alias - vlan - fabric - OVSBridge - OVSBond - OVSPort - OVSIntPort - vnet - any_bridge - any_local_bridge - include_sdn type: string responses: "200": content: application/json: schema: items: properties: active: description: Set to true if the interface is active. type: boolean address: description: IP address. format: ipv4 type: string address6: description: IP address. format: ipv6 type: string autostart: description: Automatically start interface on boot. type: boolean bond-primary: description: Specify the primary interface for active-backup bond. format: pve-iface type: string bond_mode: description: Bonding mode. enum: - balance-rr - active-backup - balance-xor - broadcast - 802.3ad - balance-tlb - balance-alb - balance-slb - lacp-balance-slb - lacp-balance-tcp type: string bond_xmit_hash_policy: description: Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. enum: - layer2 - layer2+3 - layer3+4 type: string bridge-access: description: The bridge port access VLAN. type: integer bridge-arp-nd-suppress: description: Bridge port ARP/ND suppress flag. type: boolean bridge-learning: description: Bridge port learning flag. type: boolean bridge-multicast-flood: description: Bridge port multicast flood flag. type: boolean bridge-unicast-flood: description: Bridge port unicast flood flag. type: boolean bridge_ports: description: Specify the interfaces you want to add to your bridge. format: pve-iface-list type: string bridge_vids: description: 'Specify the allowed VLANs. For example: ''2 4 100-200''. Only used if the bridge is VLAN aware.' format: pve-vlan-id-or-range-list type: string bridge_vlan_aware: description: Enable bridge vlan support. type: boolean cidr: description: IPv4 CIDR. format: CIDRv4 type: string cidr6: description: IPv6 CIDR. format: CIDRv6 type: string comments: description: Comments type: string comments6: description: Comments type: string exists: description: Set to true if the interface physically exists. type: boolean families: description: The network families. items: description: A network family. enum: - inet - inet6 type: string type: array gateway: description: Default gateway address. format: ipv4 type: string gateway6: description: Default ipv6 gateway address. format: ipv6 type: string iface: description: Network interface name. format: pve-iface type: string link-type: description: The link type. type: string method: description: The network configuration method for IPv4. enum: - loopback - dhcp - manual - static - auto type: string method6: description: The network configuration method for IPv6. enum: - loopback - dhcp - manual - static - auto type: string mtu: description: MTU. type: integer netmask: description: Network mask. format: ipv4mask type: string netmask6: description: Network mask. type: integer options: description: A list of additional interface options for IPv4. items: description: An interface property. type: string type: array options6: description: A list of additional interface options for IPv6. items: description: An interface property. type: string type: array ovs_bonds: description: Specify the interfaces used by the bonding device. format: pve-iface-list type: string ovs_bridge: description: The OVS bridge associated with a OVS port. This is required when you create an OVS port. format: pve-iface type: string ovs_options: description: OVS interface options. type: string ovs_ports: description: Specify the interfaces you want to add to your bridge. format: pve-iface-list type: string ovs_tag: description: Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) type: integer priority: description: The order of the interface. type: integer slaves: description: Specify the interfaces used by the bonding device. format: pve-iface-list type: string type: description: Network interface type enum: - bridge - bond - eth - alias - vlan - fabric - OVSBridge - OVSBond - OVSPort - OVSIntPort - vnet - unknown type: string uplink-id: description: The uplink ID. type: string vlan-id: description: vlan-id for a custom named vlan interface (ifupdown2 only). type: integer vlan-protocol: description: The VLAN protocol. enum: - 802.1ad - 802.1q type: string vlan-raw-device: description: Specify the raw interface for the vlan interface. format: pve-iface type: string vxlan-id: description: The VXLAN ID. type: integer vxlan-local-tunnelip: description: The VXLAN local tunnel IP. type: string vxlan-physdev: description: The physical device for the VXLAN tunnel. type: string vxlan-svcnodeip: description: The VXLAN SVC node IP. type: string type: object type: array description: OK summary: List available networks post: operationId: post_nodes_node_network parameters: - description: IP address. in: query name: address required: false schema: description: IP address. format: ipv4 type: string - description: IP address. in: query name: address6 required: false schema: description: IP address. format: ipv6 type: string - description: Automatically start interface on boot. in: query name: autostart required: false schema: description: Automatically start interface on boot. type: boolean - description: Specify the primary interface for active-backup bond. in: query name: bond-primary required: false schema: description: Specify the primary interface for active-backup bond. format: pve-iface type: string - description: Bonding mode. in: query name: bond_mode required: false schema: description: Bonding mode. enum: - balance-rr - active-backup - balance-xor - broadcast - 802.3ad - balance-tlb - balance-alb - balance-slb - lacp-balance-slb - lacp-balance-tcp type: string - description: Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. in: query name: bond_xmit_hash_policy required: false schema: description: Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. enum: - layer2 - layer2+3 - layer3+4 type: string - description: Specify the interfaces you want to add to your bridge. in: query name: bridge_ports required: false schema: description: Specify the interfaces you want to add to your bridge. format: pve-iface-list type: string - description: 'Specify the allowed VLANs. For example: ''2 4 100-200''. Only used if the bridge is VLAN aware.' in: query name: bridge_vids required: false schema: description: 'Specify the allowed VLANs. For example: ''2 4 100-200''. Only used if the bridge is VLAN aware.' format: pve-vlan-id-or-range-list type: string - description: Enable bridge vlan support. in: query name: bridge_vlan_aware required: false schema: description: Enable bridge vlan support. type: boolean - description: IPv4 CIDR. in: query name: cidr required: false schema: description: IPv4 CIDR. format: CIDRv4 type: string - description: IPv6 CIDR. in: query name: cidr6 required: false schema: description: IPv6 CIDR. format: CIDRv6 type: string - description: Comments in: query name: comments required: false schema: description: Comments type: string - description: Comments in: query name: comments6 required: false schema: description: Comments type: string - description: Default gateway address. in: query name: gateway required: false schema: description: Default gateway address. format: ipv4 type: string - description: Default ipv6 gateway address. in: query name: gateway6 required: false schema: description: Default ipv6 gateway address. format: ipv6 type: string - description: Network interface name. in: query name: iface required: false schema: description: Network interface name. format: pve-iface type: string - description: MTU. in: query name: mtu required: false schema: description: MTU. type: integer - description: Network mask. in: query name: netmask required: false schema: description: Network mask. format: ipv4mask type: string - description: Network mask. in: query name: netmask6 required: false schema: description: Network mask. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Specify the interfaces used by the bonding device. in: query name: ovs_bonds required: false schema: description: Specify the interfaces used by the bonding device. format: pve-iface-list type: string - description: The OVS bridge associated with a OVS port. This is required when you create an OVS port. in: query name: ovs_bridge required: false schema: description: The OVS bridge associated with a OVS port. This is required when you create an OVS port. format: pve-iface type: string - description: OVS interface options. in: query name: ovs_options required: false schema: description: OVS interface options. type: string - description: Specify the interfaces you want to add to your bridge. in: query name: ovs_ports required: false schema: description: Specify the interfaces you want to add to your bridge. format: pve-iface-list type: string - description: Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) in: query name: ovs_tag required: false schema: description: Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) type: integer - description: Specify the interfaces used by the bonding device. in: query name: slaves required: false schema: description: Specify the interfaces used by the bonding device. format: pve-iface-list type: string - description: Network interface type in: query name: type required: false schema: description: Network interface type enum: - bridge - bond - eth - alias - vlan - fabric - OVSBridge - OVSBond - OVSPort - OVSIntPort - vnet - unknown type: string - description: vlan-id for a custom named vlan interface (ifupdown2 only). in: query name: vlan-id required: false schema: description: vlan-id for a custom named vlan interface (ifupdown2 only). type: integer - description: Specify the raw interface for the vlan interface. in: query name: vlan-raw-device required: false schema: description: Specify the raw interface for the vlan interface. format: pve-iface type: string requestBody: content: application/json: schema: properties: address: description: IP address. format: ipv4 type: string address6: description: IP address. format: ipv6 type: string autostart: description: Automatically start interface on boot. type: boolean bond-primary: description: Specify the primary interface for active-backup bond. format: pve-iface type: string bond_mode: description: Bonding mode. enum: - balance-rr - active-backup - balance-xor - broadcast - 802.3ad - balance-tlb - balance-alb - balance-slb - lacp-balance-slb - lacp-balance-tcp type: string bond_xmit_hash_policy: description: Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. enum: - layer2 - layer2+3 - layer3+4 type: string bridge_ports: description: Specify the interfaces you want to add to your bridge. format: pve-iface-list type: string bridge_vids: description: 'Specify the allowed VLANs. For example: ''2 4 100-200''. Only used if the bridge is VLAN aware.' format: pve-vlan-id-or-range-list type: string bridge_vlan_aware: description: Enable bridge vlan support. type: boolean cidr: description: IPv4 CIDR. format: CIDRv4 type: string cidr6: description: IPv6 CIDR. format: CIDRv6 type: string comments: description: Comments type: string comments6: description: Comments type: string gateway: description: Default gateway address. format: ipv4 type: string gateway6: description: Default ipv6 gateway address. format: ipv6 type: string iface: description: Network interface name. format: pve-iface type: string mtu: description: MTU. type: integer netmask: description: Network mask. format: ipv4mask type: string netmask6: description: Network mask. type: integer node: description: The cluster node name. format: pve-node type: string ovs_bonds: description: Specify the interfaces used by the bonding device. format: pve-iface-list type: string ovs_bridge: description: The OVS bridge associated with a OVS port. This is required when you create an OVS port. format: pve-iface type: string ovs_options: description: OVS interface options. type: string ovs_ports: description: Specify the interfaces you want to add to your bridge. format: pve-iface-list type: string ovs_tag: description: Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) type: integer slaves: description: Specify the interfaces used by the bonding device. format: pve-iface-list type: string type: description: Network interface type enum: - bridge - bond - eth - alias - vlan - fabric - OVSBridge - OVSBond - OVSPort - OVSIntPort - vnet - unknown type: string vlan-id: description: vlan-id for a custom named vlan interface (ifupdown2 only). type: integer vlan-raw-device: description: Specify the raw interface for the vlan interface. format: pve-iface type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create network device configuration put: operationId: put_nodes_node_network parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Whether FRR config generation should get skipped or not. in: query name: regenerate-frr required: false schema: description: Whether FRR config generation should get skipped or not. type: boolean requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string regenerate-frr: description: Whether FRR config generation should get skipped or not. type: boolean type: object responses: "200": content: application/json: schema: type: string description: OK summary: Reload network configuration /nodes/{node}/network/{iface}: delete: operationId: delete_nodes_node_network_iface parameters: - description: Network interface name. in: path name: iface required: true schema: description: Network interface name. format: pve-iface type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete network device configuration get: operationId: get_nodes_node_network_iface parameters: - description: Network interface name. in: path name: iface required: true schema: description: Network interface name. format: pve-iface type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: method: type: string type: type: string type: object description: OK summary: Read network device configuration put: operationId: put_nodes_node_network_iface parameters: - description: IP address. in: query name: address required: false schema: description: IP address. format: ipv4 type: string - description: IP address. in: query name: address6 required: false schema: description: IP address. format: ipv6 type: string - description: Automatically start interface on boot. in: query name: autostart required: false schema: description: Automatically start interface on boot. type: boolean - description: Specify the primary interface for active-backup bond. in: query name: bond-primary required: false schema: description: Specify the primary interface for active-backup bond. format: pve-iface type: string - description: Bonding mode. in: query name: bond_mode required: false schema: description: Bonding mode. enum: - balance-rr - active-backup - balance-xor - broadcast - 802.3ad - balance-tlb - balance-alb - balance-slb - lacp-balance-slb - lacp-balance-tcp type: string - description: Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. in: query name: bond_xmit_hash_policy required: false schema: description: Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. enum: - layer2 - layer2+3 - layer3+4 type: string - description: Specify the interfaces you want to add to your bridge. in: query name: bridge_ports required: false schema: description: Specify the interfaces you want to add to your bridge. format: pve-iface-list type: string - description: 'Specify the allowed VLANs. For example: ''2 4 100-200''. Only used if the bridge is VLAN aware.' in: query name: bridge_vids required: false schema: description: 'Specify the allowed VLANs. For example: ''2 4 100-200''. Only used if the bridge is VLAN aware.' format: pve-vlan-id-or-range-list type: string - description: Enable bridge vlan support. in: query name: bridge_vlan_aware required: false schema: description: Enable bridge vlan support. type: boolean - description: IPv4 CIDR. in: query name: cidr required: false schema: description: IPv4 CIDR. format: CIDRv4 type: string - description: IPv6 CIDR. in: query name: cidr6 required: false schema: description: IPv6 CIDR. format: CIDRv6 type: string - description: Comments in: query name: comments required: false schema: description: Comments type: string - description: Comments in: query name: comments6 required: false schema: description: Comments type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Default gateway address. in: query name: gateway required: false schema: description: Default gateway address. format: ipv4 type: string - description: Default ipv6 gateway address. in: query name: gateway6 required: false schema: description: Default ipv6 gateway address. format: ipv6 type: string - description: Network interface name. in: path name: iface required: true schema: description: Network interface name. format: pve-iface type: string - description: MTU. in: query name: mtu required: false schema: description: MTU. type: integer - description: Network mask. in: query name: netmask required: false schema: description: Network mask. format: ipv4mask type: string - description: Network mask. in: query name: netmask6 required: false schema: description: Network mask. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Specify the interfaces used by the bonding device. in: query name: ovs_bonds required: false schema: description: Specify the interfaces used by the bonding device. format: pve-iface-list type: string - description: The OVS bridge associated with a OVS port. This is required when you create an OVS port. in: query name: ovs_bridge required: false schema: description: The OVS bridge associated with a OVS port. This is required when you create an OVS port. format: pve-iface type: string - description: OVS interface options. in: query name: ovs_options required: false schema: description: OVS interface options. type: string - description: Specify the interfaces you want to add to your bridge. in: query name: ovs_ports required: false schema: description: Specify the interfaces you want to add to your bridge. format: pve-iface-list type: string - description: Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) in: query name: ovs_tag required: false schema: description: Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) type: integer - description: Specify the interfaces used by the bonding device. in: query name: slaves required: false schema: description: Specify the interfaces used by the bonding device. format: pve-iface-list type: string - description: Network interface type in: query name: type required: false schema: description: Network interface type enum: - bridge - bond - eth - alias - vlan - fabric - OVSBridge - OVSBond - OVSPort - OVSIntPort - vnet - unknown type: string - description: vlan-id for a custom named vlan interface (ifupdown2 only). in: query name: vlan-id required: false schema: description: vlan-id for a custom named vlan interface (ifupdown2 only). type: integer - description: Specify the raw interface for the vlan interface. in: query name: vlan-raw-device required: false schema: description: Specify the raw interface for the vlan interface. format: pve-iface type: string requestBody: content: application/json: schema: properties: address: description: IP address. format: ipv4 type: string address6: description: IP address. format: ipv6 type: string autostart: description: Automatically start interface on boot. type: boolean bond-primary: description: Specify the primary interface for active-backup bond. format: pve-iface type: string bond_mode: description: Bonding mode. enum: - balance-rr - active-backup - balance-xor - broadcast - 802.3ad - balance-tlb - balance-alb - balance-slb - lacp-balance-slb - lacp-balance-tcp type: string bond_xmit_hash_policy: description: Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. enum: - layer2 - layer2+3 - layer3+4 type: string bridge_ports: description: Specify the interfaces you want to add to your bridge. format: pve-iface-list type: string bridge_vids: description: 'Specify the allowed VLANs. For example: ''2 4 100-200''. Only used if the bridge is VLAN aware.' format: pve-vlan-id-or-range-list type: string bridge_vlan_aware: description: Enable bridge vlan support. type: boolean cidr: description: IPv4 CIDR. format: CIDRv4 type: string cidr6: description: IPv6 CIDR. format: CIDRv6 type: string comments: description: Comments type: string comments6: description: Comments type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string gateway: description: Default gateway address. format: ipv4 type: string gateway6: description: Default ipv6 gateway address. format: ipv6 type: string iface: description: Network interface name. format: pve-iface type: string mtu: description: MTU. type: integer netmask: description: Network mask. format: ipv4mask type: string netmask6: description: Network mask. type: integer node: description: The cluster node name. format: pve-node type: string ovs_bonds: description: Specify the interfaces used by the bonding device. format: pve-iface-list type: string ovs_bridge: description: The OVS bridge associated with a OVS port. This is required when you create an OVS port. format: pve-iface type: string ovs_options: description: OVS interface options. type: string ovs_ports: description: Specify the interfaces you want to add to your bridge. format: pve-iface-list type: string ovs_tag: description: Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) type: integer slaves: description: Specify the interfaces used by the bonding device. format: pve-iface-list type: string type: description: Network interface type enum: - bridge - bond - eth - alias - vlan - fabric - OVSBridge - OVSBond - OVSPort - OVSIntPort - vnet - unknown type: string vlan-id: description: vlan-id for a custom named vlan interface (ifupdown2 only). type: integer vlan-raw-device: description: Specify the raw interface for the vlan interface. format: pve-iface type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update network device configuration /nodes/{node}/qemu: get: operationId: get_nodes_node_qemu parameters: - description: Determine the full status of active VMs. in: query name: full required: false schema: description: Determine the full status of active VMs. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: cpu: description: Current CPU usage. type: number cpus: description: Maximum usable CPUs. type: number diskread: description: 'The amount of bytes the guest read from it''s block devices since the guest was started. (Note: This info is not available for all storage types.)' type: integer diskwrite: description: 'The amount of bytes the guest wrote from it''s block devices since the guest was started. (Note: This info is not available for all storage types.)' type: integer lock: description: The current config lock, if any. type: string maxdisk: description: Root disk size in bytes. type: integer maxmem: description: Maximum memory in bytes. type: integer mem: description: Currently used memory in bytes. Does not take into account kernel same-page merging (KSM). Uses information from ballooning when available. type: integer memhost: description: Current memory usage on the host. Does not take into account kernel same-page merging (KSM). type: integer name: description: VM (host)name. type: string netin: description: The amount of traffic in bytes that was sent to the guest over the network since it was started. type: integer netout: description: The amount of traffic in bytes that was sent from the guest over the network since it was started. type: integer pid: description: PID of the QEMU process, if the VM is running. type: integer pressurecpufull: description: CPU Full pressure stall average over the last 10 seconds. type: number pressurecpusome: description: CPU Some pressure stall average over the last 10 seconds. type: number pressureiofull: description: IO Full pressure stall average over the last 10 seconds. type: number pressureiosome: description: IO Some pressure stall average over the last 10 seconds. type: number pressurememoryfull: description: Memory Full pressure stall average over the last 10 seconds. type: number pressurememorysome: description: Memory Some pressure stall average over the last 10 seconds. type: number qmpstatus: description: VM run state from the 'query-status' QMP monitor command. type: string running-machine: description: The currently running machine type (if running). type: string running-qemu: description: The QEMU version the VM is currently using (if running). type: string serial: description: Guest has serial device configured. type: boolean status: description: QEMU process status. enum: - stopped - running type: string tags: description: The current configured tags, if any type: string template: description: Determines if the guest is a template. type: boolean uptime: description: Uptime in seconds. type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object type: array description: OK summary: Virtual machine index (per node). post: operationId: post_nodes_node_qemu parameters: - description: Enable/disable ACPI. in: query name: acpi required: false schema: description: Enable/disable ACPI. type: boolean - description: 'List of host cores used to execute guest processes, for example: 0,5,8-11' in: query name: affinity required: false schema: description: 'List of host cores used to execute guest processes, for example: 0,5,8-11' format: pve-cpuset type: string - description: Enable/disable communication with the QEMU Guest Agent and its properties. in: query name: agent required: false schema: description: Enable/disable communication with the QEMU Guest Agent and its properties. type: string - description: Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). in: query name: allow-ksm required: false schema: description: Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). type: boolean - description: Secure Encrypted Virtualization (SEV) features by AMD CPUs in: query name: amd-sev required: false schema: description: Secure Encrypted Virtualization (SEV) features by AMD CPUs format: pve-qemu-sev-fmt type: string - description: Virtual processor architecture. Defaults to the host architecture. in: query name: arch required: false schema: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string - description: The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier. in: query name: archive required: false schema: description: The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier. type: string - description: Arbitrary arguments passed to kvm. in: query name: args required: false schema: description: Arbitrary arguments passed to kvm. type: string - description: Configure a audio device, useful in combination with QXL/Spice. in: query name: audio0 required: false schema: description: Configure a audio device, useful in combination with QXL/Spice. type: string - description: Automatic restart after crash (currently ignored). in: query name: autostart required: false schema: description: Automatic restart after crash (currently ignored). type: boolean - description: Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero. in: query name: balloon required: false schema: description: Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero. type: integer - description: Select BIOS implementation. in: query name: bios required: false schema: description: Select BIOS implementation. enum: - seabios - ovmf type: string - description: Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. in: query name: boot required: false schema: description: Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. format: pve-qm-boot type: string - description: 'Enable booting from specified disk. Deprecated: Use ''boot: order=foo;bar'' instead.' in: query name: bootdisk required: false schema: description: 'Enable booting from specified disk. Deprecated: Use ''boot: order=foo;bar'' instead.' format: pve-qm-bootdisk type: string - description: Override I/O bandwidth limit (in KiB/s). in: query name: bwlimit required: false schema: description: Override I/O bandwidth limit (in KiB/s). type: integer - description: This is an alias for option -ide2 in: query name: cdrom required: false schema: description: This is an alias for option -ide2 format: pve-qm-ide type: string - description: 'cloud-init: Specify custom files to replace the automatically generated ones at start.' in: query name: cicustom required: false schema: description: 'cloud-init: Specify custom files to replace the automatically generated ones at start.' format: pve-qm-cicustom type: string - description: 'cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.' in: query name: cipassword required: false schema: description: 'cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.' type: string - description: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. in: query name: citype required: false schema: description: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. enum: - configdrive2 - nocloud - opennebula type: string - description: 'cloud-init: do an automatic package upgrade after the first boot.' in: query name: ciupgrade required: false schema: description: 'cloud-init: do an automatic package upgrade after the first boot.' type: boolean - description: 'cloud-init: User name to change ssh keys and password for instead of the image''s configured default user.' in: query name: ciuser required: false schema: description: 'cloud-init: User name to change ssh keys and password for instead of the image''s configured default user.' type: string - description: The number of cores per socket. in: query name: cores required: false schema: description: The number of cores per socket. type: integer - description: Emulated CPU type. in: query name: cpu required: false schema: description: Emulated CPU type. format: pve-vm-cpu-conf type: string - description: Limit of CPU usage. in: query name: cpulimit required: false schema: description: Limit of CPU usage. type: number - description: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. in: query name: cpuunits required: false schema: description: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. type: integer - description: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. in: query name: description required: false schema: description: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. type: string - description: Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: efidisk0 required: false schema: description: Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Allow to overwrite existing VM. in: query name: force required: false schema: description: Allow to overwrite existing VM. type: boolean - description: Freeze CPU at startup (use 'c' monitor command to start execution). in: query name: freeze required: false schema: description: Freeze CPU at startup (use 'c' monitor command to start execution). type: boolean - description: Add the VM as a HA resource after it was created. in: query name: ha-managed required: false schema: description: Add the VM as a HA resource after it was created. type: boolean - description: Script that will be executed during various steps in the vms lifetime. in: query name: hookscript required: false schema: description: Script that will be executed during various steps in the vms lifetime. format: pve-volume-id type: string - description: Map host PCI devices into guest. in: query name: hostpci[n] required: false schema: description: Map host PCI devices into guest. format: pve-qm-hostpci type: string - description: 'Selectively enable hotplug features. This is a comma separated list of hotplug features: ''network'', ''disk'', ''cpu'', ''memory'', ''usb'' and ''cloudinit''. Use ''0'' to disable hotplug completely. Using ''1'' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.' in: query name: hotplug required: false schema: description: 'Selectively enable hotplug features. This is a comma separated list of hotplug features: ''network'', ''disk'', ''cpu'', ''memory'', ''usb'' and ''cloudinit''. Use ''0'' to disable hotplug completely. Using ''1'' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.' format: pve-hotplug-features type: string - description: |- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. in: query name: hugepages required: false schema: description: |- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. enum: - any - "2" - "1024" type: string - description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: ide[n] required: false schema: description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: A file-based storage with 'images' content-type enabled, which is used as an intermediary extraction storage during import. Defaults to the source storage. in: query name: import-working-storage required: false schema: description: A file-based storage with 'images' content-type enabled, which is used as an intermediary extraction storage during import. Defaults to the source storage. format: pve-storage-id type: string - description: Trusted Domain Extension (TDX) features by Intel CPUs in: query name: intel-tdx required: false schema: description: Trusted Domain Extension (TDX) features by Intel CPUs format: pve-qemu-tdx-fmt type: string - description: | cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. in: query name: ipconfig[n] required: false schema: description: | cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. format: pve-qm-ipconfig type: string - description: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. in: query name: ivshmem required: false schema: description: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. type: string - description: Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. in: query name: keephugepages required: false schema: description: Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. type: boolean - description: Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. in: query name: keyboard required: false schema: description: Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. enum: - de - de-ch - da - en-gb - en-us - es - fi - fr - fr-be - fr-ca - fr-ch - hu - is - it - ja - lt - mk - nl - "no" - pl - pt - pt-br - sv - sl - tr type: string - description: Enable/disable KVM hardware virtualization. in: query name: kvm required: false schema: description: Enable/disable KVM hardware virtualization. type: boolean - description: Start the VM immediately while importing or restoring in the background. in: query name: live-restore required: false schema: description: Start the VM immediately while importing or restoring in the background. type: boolean - description: Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. in: query name: localtime required: false schema: description: Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. type: boolean - description: Lock/unlock the VM. in: query name: lock required: false schema: description: Lock/unlock the VM. enum: - backup - clone - create - migrate - rollback - snapshot - snapshot-delete - suspending - suspended type: string - description: Specify the QEMU machine. in: query name: machine required: false schema: description: Specify the QEMU machine. type: string - description: Memory properties. in: query name: memory required: false schema: description: Memory properties. type: string - description: Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. Will be capped to 2000 seconds (maximum in QEMU). in: query name: migrate_downtime required: false schema: description: Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. Will be capped to 2000 seconds (maximum in QEMU). type: number - description: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. in: query name: migrate_speed required: false schema: description: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. type: integer - description: Set a name for the VM. Only used on the configuration web interface. in: query name: name required: false schema: description: Set a name for the VM. Only used on the configuration web interface. format: dns-name type: string - description: 'cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' in: query name: nameserver required: false schema: description: 'cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' format: address-list type: string - description: Specify network devices. in: query name: net[n] required: false schema: description: Specify network devices. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Enable/disable NUMA. in: query name: numa required: false schema: description: Enable/disable NUMA. type: boolean - description: NUMA topology. in: query name: numa[n] required: false schema: description: NUMA topology. type: string - description: Specifies whether a VM will be started during system bootup. in: query name: onboot required: false schema: description: Specifies whether a VM will be started during system bootup. type: boolean - description: Specify guest operating system. in: query name: ostype required: false schema: description: Specify guest operating system. enum: - other - wxp - w2k - w2k3 - w2k8 - wvista - win7 - win8 - win10 - win11 - l24 - l26 - solaris type: string - description: Map host parallel devices (n is 0 to 2). in: query name: parallel[n] required: false schema: description: Map host parallel devices (n is 0 to 2). type: string - description: Add the VM to the specified pool. in: query name: pool required: false schema: description: Add the VM to the specified pool. format: pve-poolid type: string - description: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. in: query name: protection required: false schema: description: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. type: boolean - description: Allow reboot. If set to '0' the VM exit on reboot. in: query name: reboot required: false schema: description: Allow reboot. If set to '0' the VM exit on reboot. type: boolean - description: Configure a VirtIO-based Random Number Generator. in: query name: rng0 required: false schema: description: Configure a VirtIO-based Random Number Generator. format: pve-qm-rng type: string - description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: sata[n] required: false schema: description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: scsi[n] required: false schema: description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: SCSI controller model in: query name: scsihw required: false schema: description: SCSI controller model enum: - lsi - lsi53c810 - virtio-scsi-pci - virtio-scsi-single - megasas - pvscsi type: string - description: 'cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' in: query name: searchdomain required: false schema: description: 'cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' type: string - description: Create a serial device inside the VM (n is 0 to 3) in: query name: serial[n] required: false schema: description: Create a serial device inside the VM (n is 0 to 3) type: string - description: Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. in: query name: shares required: false schema: description: Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. type: integer - description: Specify SMBIOS type 1 fields. in: query name: smbios1 required: false schema: description: Specify SMBIOS type 1 fields. format: pve-qm-smbios1 type: string - description: The number of CPUs. Please use option -sockets instead. in: query name: smp required: false schema: description: The number of CPUs. Please use option -sockets instead. type: integer - description: The number of CPU sockets. in: query name: sockets required: false schema: description: The number of CPU sockets. type: integer - description: Configure additional enhancements for SPICE. in: query name: spice_enhancements required: false schema: description: Configure additional enhancements for SPICE. type: string - description: 'cloud-init: Setup public SSH keys (one key per line, OpenSSH format).' in: query name: sshkeys required: false schema: description: 'cloud-init: Setup public SSH keys (one key per line, OpenSSH format).' format: urlencoded type: string - description: Start VM after it was created successfully. in: query name: start required: false schema: description: Start VM after it was created successfully. type: boolean - description: Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. in: query name: startdate required: false schema: description: Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. type: string - description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. in: query name: startup required: false schema: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string - description: Default storage. in: query name: storage required: false schema: description: Default storage. format: pve-storage-id type: string - description: Enable/disable the USB tablet device. in: query name: tablet required: false schema: description: Enable/disable the USB tablet device. type: boolean - description: Tags of the VM. This is only meta information. in: query name: tags required: false schema: description: Tags of the VM. This is only meta information. format: pve-tag-list type: string - description: Enable/disable time drift fix. in: query name: tdf required: false schema: description: Enable/disable time drift fix. type: boolean - description: Enable/disable Template. in: query name: template required: false schema: description: Enable/disable Template. type: boolean - description: Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: tpmstate0 required: false schema: description: Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Assign a unique random ethernet address. in: query name: unique required: false schema: description: Assign a unique random ethernet address. type: boolean - description: Reference to unused volumes. This is used internally, and should not be modified manually. in: query name: unused[n] required: false schema: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string - description: Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). in: query name: usb[n] required: false schema: description: Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). type: string - description: Number of hotplugged vcpus. in: query name: vcpus required: false schema: description: Number of hotplugged vcpus. type: integer - description: Configure the VGA hardware. in: query name: vga required: false schema: description: Configure the VGA hardware. type: string - description: Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: virtio[n] required: false schema: description: Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Configuration for sharing a directory between host and guest using Virtio-fs. in: query name: virtiofs[n] required: false schema: description: Configuration for sharing a directory between host and guest using Virtio-fs. type: string - description: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. in: query name: vmgenid required: false schema: description: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. type: string - description: The (unique) ID of the VM. in: query name: vmid required: false schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Default storage for VM state volumes/files. in: query name: vmstatestorage required: false schema: description: Default storage for VM state volumes/files. format: pve-storage-id type: string - description: Create a virtual hardware watchdog device. in: query name: watchdog required: false schema: description: Create a virtual hardware watchdog device. format: pve-qm-watchdog type: string requestBody: content: application/json: schema: properties: acpi: description: Enable/disable ACPI. type: boolean affinity: description: 'List of host cores used to execute guest processes, for example: 0,5,8-11' format: pve-cpuset type: string agent: description: Enable/disable communication with the QEMU Guest Agent and its properties. type: string allow-ksm: description: Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). type: boolean amd-sev: description: Secure Encrypted Virtualization (SEV) features by AMD CPUs format: pve-qemu-sev-fmt type: string arch: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string archive: description: The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier. type: string args: description: Arbitrary arguments passed to kvm. type: string audio0: description: Configure a audio device, useful in combination with QXL/Spice. type: string autostart: description: Automatic restart after crash (currently ignored). type: boolean balloon: description: Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero. type: integer bios: description: Select BIOS implementation. enum: - seabios - ovmf type: string boot: description: Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. format: pve-qm-boot type: string bootdisk: description: 'Enable booting from specified disk. Deprecated: Use ''boot: order=foo;bar'' instead.' format: pve-qm-bootdisk type: string bwlimit: description: Override I/O bandwidth limit (in KiB/s). type: integer cdrom: description: This is an alias for option -ide2 format: pve-qm-ide type: string cicustom: description: 'cloud-init: Specify custom files to replace the automatically generated ones at start.' format: pve-qm-cicustom type: string cipassword: description: 'cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.' type: string citype: description: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. enum: - configdrive2 - nocloud - opennebula type: string ciupgrade: description: 'cloud-init: do an automatic package upgrade after the first boot.' type: boolean ciuser: description: 'cloud-init: User name to change ssh keys and password for instead of the image''s configured default user.' type: string cores: description: The number of cores per socket. type: integer cpu: description: Emulated CPU type. format: pve-vm-cpu-conf type: string cpulimit: description: Limit of CPU usage. type: number cpuunits: description: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. type: integer description: description: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. type: string efidisk0: description: Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string force: description: Allow to overwrite existing VM. type: boolean freeze: description: Freeze CPU at startup (use 'c' monitor command to start execution). type: boolean ha-managed: description: Add the VM as a HA resource after it was created. type: boolean hookscript: description: Script that will be executed during various steps in the vms lifetime. format: pve-volume-id type: string hostpci[n]: description: Map host PCI devices into guest. format: pve-qm-hostpci type: string hotplug: description: 'Selectively enable hotplug features. This is a comma separated list of hotplug features: ''network'', ''disk'', ''cpu'', ''memory'', ''usb'' and ''cloudinit''. Use ''0'' to disable hotplug completely. Using ''1'' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.' format: pve-hotplug-features type: string hugepages: description: |- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. enum: - any - "2" - "1024" type: string ide[n]: description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string import-working-storage: description: A file-based storage with 'images' content-type enabled, which is used as an intermediary extraction storage during import. Defaults to the source storage. format: pve-storage-id type: string intel-tdx: description: Trusted Domain Extension (TDX) features by Intel CPUs format: pve-qemu-tdx-fmt type: string ipconfig[n]: description: | cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. format: pve-qm-ipconfig type: string ivshmem: description: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. type: string keephugepages: description: Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. type: boolean keyboard: description: Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. enum: - de - de-ch - da - en-gb - en-us - es - fi - fr - fr-be - fr-ca - fr-ch - hu - is - it - ja - lt - mk - nl - "no" - pl - pt - pt-br - sv - sl - tr type: string kvm: description: Enable/disable KVM hardware virtualization. type: boolean live-restore: description: Start the VM immediately while importing or restoring in the background. type: boolean localtime: description: Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. type: boolean lock: description: Lock/unlock the VM. enum: - backup - clone - create - migrate - rollback - snapshot - snapshot-delete - suspending - suspended type: string machine: description: Specify the QEMU machine. type: string memory: description: Memory properties. type: string migrate_downtime: description: Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. Will be capped to 2000 seconds (maximum in QEMU). type: number migrate_speed: description: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. type: integer name: description: Set a name for the VM. Only used on the configuration web interface. format: dns-name type: string nameserver: description: 'cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' format: address-list type: string net[n]: description: Specify network devices. type: string node: description: The cluster node name. format: pve-node type: string numa: description: Enable/disable NUMA. type: boolean numa[n]: description: NUMA topology. type: string onboot: description: Specifies whether a VM will be started during system bootup. type: boolean ostype: description: Specify guest operating system. enum: - other - wxp - w2k - w2k3 - w2k8 - wvista - win7 - win8 - win10 - win11 - l24 - l26 - solaris type: string parallel[n]: description: Map host parallel devices (n is 0 to 2). type: string pool: description: Add the VM to the specified pool. format: pve-poolid type: string protection: description: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. type: boolean reboot: description: Allow reboot. If set to '0' the VM exit on reboot. type: boolean rng0: description: Configure a VirtIO-based Random Number Generator. format: pve-qm-rng type: string sata[n]: description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string scsi[n]: description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string scsihw: description: SCSI controller model enum: - lsi - lsi53c810 - virtio-scsi-pci - virtio-scsi-single - megasas - pvscsi type: string searchdomain: description: 'cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' type: string serial[n]: description: Create a serial device inside the VM (n is 0 to 3) type: string shares: description: Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. type: integer smbios1: description: Specify SMBIOS type 1 fields. format: pve-qm-smbios1 type: string smp: description: The number of CPUs. Please use option -sockets instead. type: integer sockets: description: The number of CPU sockets. type: integer spice_enhancements: description: Configure additional enhancements for SPICE. type: string sshkeys: description: 'cloud-init: Setup public SSH keys (one key per line, OpenSSH format).' format: urlencoded type: string start: description: Start VM after it was created successfully. type: boolean startdate: description: Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. type: string startup: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string storage: description: Default storage. format: pve-storage-id type: string tablet: description: Enable/disable the USB tablet device. type: boolean tags: description: Tags of the VM. This is only meta information. format: pve-tag-list type: string tdf: description: Enable/disable time drift fix. type: boolean template: description: Enable/disable Template. type: boolean tpmstate0: description: Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string unique: description: Assign a unique random ethernet address. type: boolean unused[n]: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string usb[n]: description: Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). type: string vcpus: description: Number of hotplugged vcpus. type: integer vga: description: Configure the VGA hardware. type: string virtio[n]: description: Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string virtiofs[n]: description: Configuration for sharing a directory between host and guest using Virtio-fs. type: string vmgenid: description: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer vmstatestorage: description: Default storage for VM state volumes/files. format: pve-storage-id type: string watchdog: description: Create a virtual hardware watchdog device. format: pve-qm-watchdog type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create or restore a virtual machine. /nodes/{node}/qemu/{vmid}: delete: operationId: delete_nodes_node_qemu_vmid parameters: - description: If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. in: query name: destroy-unreferenced-disks required: false schema: description: If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Remove VMID from configurations, like backup & replication jobs and HA. in: query name: purge required: false schema: description: Remove VMID from configurations, like backup & replication jobs and HA. type: boolean - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: type: string description: OK summary: Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules get: operationId: get_nodes_node_qemu_vmid parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: Directory index /nodes/{node}/qemu/{vmid}/agent: get: operationId: get_nodes_node_qemu_vmid_agent parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns the list of QEMU Guest Agent commands items: type: object type: array description: OK summary: QEMU Guest Agent command index. post: operationId: post_nodes_node_qemu_vmid_agent parameters: - description: The QGA command. in: query name: command required: false schema: description: The QGA command. enum: - fsfreeze-freeze - fsfreeze-status - fsfreeze-thaw - fstrim - get-fsinfo - get-host-name - get-memory-block-info - get-memory-blocks - get-osinfo - get-time - get-timezone - get-users - get-vcpus - info - network-get-interfaces - ping - shutdown - suspend-disk - suspend-hybrid - suspend-ram type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: command: description: The QGA command. enum: - fsfreeze-freeze - fsfreeze-status - fsfreeze-thaw - fstrim - get-fsinfo - get-host-name - get-memory-block-info - get-memory-blocks - get-osinfo - get-time - get-timezone - get-users - get-vcpus - info - network-get-interfaces - ping - shutdown - suspend-disk - suspend-hybrid - suspend-ram type: string node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute QEMU Guest Agent commands. /nodes/{node}/qemu/{vmid}/agent/exec: post: operationId: post_nodes_node_qemu_vmid_agent_exec parameters: - description: The command as a list of program + arguments. in: query name: command required: false schema: description: The command as a list of program + arguments. items: description: A single part of the program + arguments. type: string type: array - description: Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'. in: query name: input-data required: false schema: description: Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: command: description: The command as a list of program + arguments. items: description: A single part of the program + arguments. type: string type: array input-data: description: Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'. type: string node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: properties: pid: description: The PID of the process started by the guest-agent. type: integer type: object description: OK summary: Executes the given command in the vm via the guest-agent and returns an object with the pid. /nodes/{node}/qemu/{vmid}/agent/exec-status: get: operationId: get_nodes_node_qemu_vmid_agent_exec_status parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The PID to query in: query name: pid required: false schema: description: The PID to query type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: err-data: description: stderr of the process type: string err-truncated: description: true if stderr was not fully captured type: boolean exitcode: description: process exit code if it was normally terminated. type: integer exited: description: Tells if the given command has exited yet. type: boolean out-data: description: stdout of the process type: string out-truncated: description: true if stdout was not fully captured type: boolean signal: description: signal number or exception code if the process was abnormally terminated. type: integer type: object description: OK summary: Gets the status of the given pid started by the guest-agent /nodes/{node}/qemu/{vmid}/agent/file-read: get: operationId: get_nodes_node_qemu_vmid_agent_file_read parameters: - description: Number of bytes to read. in: query name: count required: false schema: description: Number of bytes to read. type: integer - description: Data received from the QEMU Guest-Agent is base64 encoded. If this is set to true, the data is decoded. Otherwise the content is forwarded with base64 encoding. Defaults to true. in: query name: decode required: false schema: description: Data received from the QEMU Guest-Agent is base64 encoded. If this is set to true, the data is decoded. Otherwise the content is forwarded with base64 encoding. Defaults to true. type: boolean - description: The path to the file in: query name: file required: false schema: description: The path to the file type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Offset to start reading at in: query name: offset required: false schema: description: Offset to start reading at type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a `content` property. properties: content: description: The content of the file, maximum 16777216 type: string truncated: description: If set to 1, the read did not reach the end of the file. type: boolean type: object description: OK summary: Reads the given file via guest agent. Is limited to 16777216 bytes. /nodes/{node}/qemu/{vmid}/agent/file-write: post: operationId: post_nodes_node_qemu_vmid_agent_file_write parameters: - description: The content to write into the file. in: query name: content required: false schema: description: The content to write into the file. type: string - description: If set, the content will be encoded as base64 (required by QEMU).Otherwise the content needs to be encoded beforehand - defaults to true. in: query name: encode required: false schema: description: If set, the content will be encoded as base64 (required by QEMU).Otherwise the content needs to be encoded beforehand - defaults to true. type: boolean - description: The path to the file. in: query name: file required: false schema: description: The path to the file. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: content: description: The content to write into the file. type: string encode: description: If set, the content will be encoded as base64 (required by QEMU).Otherwise the content needs to be encoded beforehand - defaults to true. type: boolean file: description: The path to the file. type: string node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Writes the given file via guest agent. /nodes/{node}/qemu/{vmid}/agent/fsfreeze-freeze: post: operationId: post_nodes_node_qemu_vmid_agent_fsfreeze_freeze parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute fsfreeze-freeze. /nodes/{node}/qemu/{vmid}/agent/fsfreeze-status: post: operationId: post_nodes_node_qemu_vmid_agent_fsfreeze_status parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute fsfreeze-status. /nodes/{node}/qemu/{vmid}/agent/fsfreeze-thaw: post: operationId: post_nodes_node_qemu_vmid_agent_fsfreeze_thaw parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute fsfreeze-thaw. /nodes/{node}/qemu/{vmid}/agent/fstrim: post: operationId: post_nodes_node_qemu_vmid_agent_fstrim parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute fstrim. /nodes/{node}/qemu/{vmid}/agent/get-fsinfo: get: operationId: get_nodes_node_qemu_vmid_agent_get_fsinfo parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute get-fsinfo. /nodes/{node}/qemu/{vmid}/agent/get-host-name: get: operationId: get_nodes_node_qemu_vmid_agent_get_host_name parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute get-host-name. /nodes/{node}/qemu/{vmid}/agent/get-memory-block-info: get: operationId: get_nodes_node_qemu_vmid_agent_get_memory_block_info parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute get-memory-block-info. /nodes/{node}/qemu/{vmid}/agent/get-memory-blocks: get: operationId: get_nodes_node_qemu_vmid_agent_get_memory_blocks parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute get-memory-blocks. /nodes/{node}/qemu/{vmid}/agent/get-osinfo: get: operationId: get_nodes_node_qemu_vmid_agent_get_osinfo parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute get-osinfo. /nodes/{node}/qemu/{vmid}/agent/get-time: get: operationId: get_nodes_node_qemu_vmid_agent_get_time parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute get-time. /nodes/{node}/qemu/{vmid}/agent/get-timezone: get: operationId: get_nodes_node_qemu_vmid_agent_get_timezone parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute get-timezone. /nodes/{node}/qemu/{vmid}/agent/get-users: get: operationId: get_nodes_node_qemu_vmid_agent_get_users parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute get-users. /nodes/{node}/qemu/{vmid}/agent/get-vcpus: get: operationId: get_nodes_node_qemu_vmid_agent_get_vcpus parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute get-vcpus. /nodes/{node}/qemu/{vmid}/agent/info: get: operationId: get_nodes_node_qemu_vmid_agent_info parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute info. /nodes/{node}/qemu/{vmid}/agent/network-get-interfaces: get: operationId: get_nodes_node_qemu_vmid_agent_network_get_interfaces parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute network-get-interfaces. /nodes/{node}/qemu/{vmid}/agent/ping: post: operationId: post_nodes_node_qemu_vmid_agent_ping parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute ping. /nodes/{node}/qemu/{vmid}/agent/set-user-password: post: operationId: post_nodes_node_qemu_vmid_agent_set_user_password parameters: - description: set to 1 if the password has already been passed through crypt() in: query name: crypted required: false schema: description: set to 1 if the password has already been passed through crypt() type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The new password. in: query name: password required: false schema: description: The new password. type: string - description: The user to set the password for. in: query name: username required: false schema: description: The user to set the password for. type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: crypted: description: set to 1 if the password has already been passed through crypt() type: boolean node: description: The cluster node name. format: pve-node type: string password: description: The new password. type: string username: description: The user to set the password for. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Sets the password for the given user to the given password /nodes/{node}/qemu/{vmid}/agent/shutdown: post: operationId: post_nodes_node_qemu_vmid_agent_shutdown parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute shutdown. /nodes/{node}/qemu/{vmid}/agent/suspend-disk: post: operationId: post_nodes_node_qemu_vmid_agent_suspend_disk parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute suspend-disk. /nodes/{node}/qemu/{vmid}/agent/suspend-hybrid: post: operationId: post_nodes_node_qemu_vmid_agent_suspend_hybrid parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute suspend-hybrid. /nodes/{node}/qemu/{vmid}/agent/suspend-ram: post: operationId: post_nodes_node_qemu_vmid_agent_suspend_ram parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returns an object with a single `result` property. type: object description: OK summary: Execute suspend-ram. /nodes/{node}/qemu/{vmid}/clone: post: operationId: post_nodes_node_qemu_vmid_clone parameters: - description: Override I/O bandwidth limit (in KiB/s). in: query name: bwlimit required: false schema: description: Override I/O bandwidth limit (in KiB/s). type: integer - description: Description for the new VM. in: query name: description required: false schema: description: Description for the new VM. type: string - description: Target format for file storage. Only valid for full clone. in: query name: format required: false schema: description: Target format for file storage. Only valid for full clone. enum: - raw - qcow2 - vmdk type: string - description: Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. in: query name: full required: false schema: description: Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. type: boolean - description: Set a name for the new VM. in: query name: name required: false schema: description: Set a name for the new VM. format: dns-name type: string - description: VMID for the clone. in: query name: newid required: false schema: description: VMID for the clone. format: pve-vmid type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Add the new VM to the specified pool. in: query name: pool required: false schema: description: Add the new VM to the specified pool. format: pve-poolid type: string - description: The name of the snapshot. in: query name: snapname required: false schema: description: The name of the snapshot. format: pve-configid type: string - description: Target storage for full clone. in: query name: storage required: false schema: description: Target storage for full clone. format: pve-storage-id type: string - description: Target node. Only allowed if the original VM is on shared storage. in: query name: target required: false schema: description: Target node. Only allowed if the original VM is on shared storage. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: bwlimit: description: Override I/O bandwidth limit (in KiB/s). type: integer description: description: Description for the new VM. type: string format: description: Target format for file storage. Only valid for full clone. enum: - raw - qcow2 - vmdk type: string full: description: Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. type: boolean name: description: Set a name for the new VM. format: dns-name type: string newid: description: VMID for the clone. format: pve-vmid type: integer node: description: The cluster node name. format: pve-node type: string pool: description: Add the new VM to the specified pool. format: pve-poolid type: string snapname: description: The name of the snapshot. format: pve-configid type: string storage: description: Target storage for full clone. format: pve-storage-id type: string target: description: Target node. Only allowed if the original VM is on shared storage. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create a copy of virtual machine/template. /nodes/{node}/qemu/{vmid}/cloudinit: get: operationId: get_nodes_node_qemu_vmid_cloudinit parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: delete: description: 'Indicates a pending delete request if present and not 0. ' type: integer key: description: Configuration option name. type: string pending: description: The new pending value. type: string value: description: Value as it was used to generate the current cloudinit image. type: string type: object type: array description: OK summary: Get the cloudinit configuration with both current and pending values. put: operationId: put_nodes_node_qemu_vmid_cloudinit parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Regenerate and change cloudinit config drive. /nodes/{node}/qemu/{vmid}/cloudinit/dump: get: operationId: get_nodes_node_qemu_vmid_cloudinit_dump parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Config type. in: query name: type required: false schema: description: Config type. enum: - user - network - meta type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: type: string description: OK summary: Get automatically generated cloudinit config. /nodes/{node}/qemu/{vmid}/config: get: operationId: get_nodes_node_qemu_vmid_config parameters: - description: Get current values (instead of pending values). in: query name: current required: false schema: description: Get current values (instead of pending values). type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Fetch config values from given snapshot. in: query name: snapshot required: false schema: description: Fetch config values from given snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: The VM configuration. properties: acpi: description: Enable/disable ACPI. type: boolean affinity: description: 'List of host cores used to execute guest processes, for example: 0,5,8-11' format: pve-cpuset type: string agent: description: Enable/disable communication with the QEMU Guest Agent and its properties. type: string allow-ksm: description: Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). type: boolean amd-sev: description: Secure Encrypted Virtualization (SEV) features by AMD CPUs format: pve-qemu-sev-fmt type: string arch: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string args: description: Arbitrary arguments passed to kvm. type: string audio0: description: Configure a audio device, useful in combination with QXL/Spice. type: string autostart: description: Automatic restart after crash (currently ignored). type: boolean balloon: description: Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero. type: integer bios: description: Select BIOS implementation. enum: - seabios - ovmf type: string boot: description: Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. format: pve-qm-boot type: string bootdisk: description: 'Enable booting from specified disk. Deprecated: Use ''boot: order=foo;bar'' instead.' format: pve-qm-bootdisk type: string cdrom: description: This is an alias for option -ide2 format: pve-qm-ide type: string cicustom: description: 'cloud-init: Specify custom files to replace the automatically generated ones at start.' format: pve-qm-cicustom type: string cipassword: description: 'cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.' type: string citype: description: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. enum: - configdrive2 - nocloud - opennebula type: string ciupgrade: description: 'cloud-init: do an automatic package upgrade after the first boot.' type: boolean ciuser: description: 'cloud-init: User name to change ssh keys and password for instead of the image''s configured default user.' type: string cores: description: The number of cores per socket. type: integer cpu: description: Emulated CPU type. format: pve-vm-cpu-conf type: string cpulimit: description: Limit of CPU usage. type: number cpuunits: description: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. type: integer description: description: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. type: string digest: description: SHA1 digest of configuration file. This can be used to prevent concurrent modifications. type: string efidisk0: description: Configure a disk for storing EFI vars. type: string freeze: description: Freeze CPU at startup (use 'c' monitor command to start execution). type: boolean hookscript: description: Script that will be executed during various steps in the vms lifetime. format: pve-volume-id type: string hostpci[n]: description: Map host PCI devices into guest. format: pve-qm-hostpci type: string hotplug: description: 'Selectively enable hotplug features. This is a comma separated list of hotplug features: ''network'', ''disk'', ''cpu'', ''memory'', ''usb'' and ''cloudinit''. Use ''0'' to disable hotplug completely. Using ''1'' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.' format: pve-hotplug-features type: string hugepages: description: |- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. enum: - any - "2" - "1024" type: string ide[n]: description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). type: string intel-tdx: description: Trusted Domain Extension (TDX) features by Intel CPUs format: pve-qemu-tdx-fmt type: string ipconfig[n]: description: | cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. format: pve-qm-ipconfig type: string ivshmem: description: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. type: string keephugepages: description: Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. type: boolean keyboard: description: Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. enum: - de - de-ch - da - en-gb - en-us - es - fi - fr - fr-be - fr-ca - fr-ch - hu - is - it - ja - lt - mk - nl - "no" - pl - pt - pt-br - sv - sl - tr type: string kvm: description: Enable/disable KVM hardware virtualization. type: boolean localtime: description: Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. type: boolean lock: description: Lock/unlock the VM. enum: - backup - clone - create - migrate - rollback - snapshot - snapshot-delete - suspending - suspended type: string machine: description: Specify the QEMU machine. type: string memory: description: Memory properties. type: string meta: description: Some (read-only) meta-information about this guest. type: string migrate_downtime: description: Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. Will be capped to 2000 seconds (maximum in QEMU). type: number migrate_speed: description: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. type: integer name: description: Set a name for the VM. Only used on the configuration web interface. format: dns-name type: string nameserver: description: 'cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' format: address-list type: string net[n]: description: Specify network devices. type: string numa: description: Enable/disable NUMA. type: boolean numa[n]: description: NUMA topology. type: string onboot: description: Specifies whether a VM will be started during system bootup. type: boolean ostype: description: Specify guest operating system. enum: - other - wxp - w2k - w2k3 - w2k8 - wvista - win7 - win8 - win10 - win11 - l24 - l26 - solaris type: string parallel[n]: description: Map host parallel devices (n is 0 to 2). type: string parent: description: Parent snapshot name. This is used internally, and should not be modified. format: pve-configid type: string protection: description: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. type: boolean reboot: description: Allow reboot. If set to '0' the VM exit on reboot. type: boolean rng0: description: Configure a VirtIO-based Random Number Generator. format: pve-qm-rng type: string running-nets-host-mtu: description: List of VirtIO network devices and their effective host_mtu setting. A value of 0 means that the host_mtu parameter is to be avoided for the corresponding device. This is used internally for snapshots. type: string runningcpu: description: Specifies the QEMU '-cpu' parameter of the running vm. This is used internally for snapshots. type: string runningmachine: description: Specifies the QEMU machine type of the running vm. This is used internally for snapshots. type: string sata[n]: description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). type: string scsi[n]: description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). type: string scsihw: description: SCSI controller model enum: - lsi - lsi53c810 - virtio-scsi-pci - virtio-scsi-single - megasas - pvscsi type: string searchdomain: description: 'cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' type: string serial[n]: description: Create a serial device inside the VM (n is 0 to 3) type: string shares: description: Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. type: integer smbios1: description: Specify SMBIOS type 1 fields. format: pve-qm-smbios1 type: string smp: description: The number of CPUs. Please use option -sockets instead. type: integer snaptime: description: Timestamp for snapshots. type: integer sockets: description: The number of CPU sockets. type: integer spice_enhancements: description: Configure additional enhancements for SPICE. type: string sshkeys: description: 'cloud-init: Setup public SSH keys (one key per line, OpenSSH format).' format: urlencoded type: string startdate: description: Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. type: string startup: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string tablet: description: Enable/disable the USB tablet device. type: boolean tags: description: Tags of the VM. This is only meta information. format: pve-tag-list type: string tdf: description: Enable/disable time drift fix. type: boolean template: description: Enable/disable Template. type: boolean tpmstate0: description: Configure a Disk for storing TPM state. The format is fixed to 'raw'. type: string unused[n]: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string usb[n]: description: Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). type: string vcpus: description: Number of hotplugged vcpus. type: integer vga: description: Configure the VGA hardware. type: string virtio[n]: description: Use volume as VIRTIO hard disk (n is 0 to 15). type: string virtiofs[n]: description: Configuration for sharing a directory between host and guest using Virtio-fs. type: string vmgenid: description: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. type: string vmstate: description: Reference to a volume which stores the VM state. This is used internally for snapshots. format: pve-volume-id type: string vmstatestorage: description: Default storage for VM state volumes/files. format: pve-storage-id type: string watchdog: description: Create a virtual hardware watchdog device. format: pve-qm-watchdog type: string type: object description: OK summary: Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead. post: operationId: post_nodes_node_qemu_vmid_config parameters: - description: Enable/disable ACPI. in: query name: acpi required: false schema: description: Enable/disable ACPI. type: boolean - description: 'List of host cores used to execute guest processes, for example: 0,5,8-11' in: query name: affinity required: false schema: description: 'List of host cores used to execute guest processes, for example: 0,5,8-11' format: pve-cpuset type: string - description: Enable/disable communication with the QEMU Guest Agent and its properties. in: query name: agent required: false schema: description: Enable/disable communication with the QEMU Guest Agent and its properties. type: string - description: Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). in: query name: allow-ksm required: false schema: description: Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). type: boolean - description: Secure Encrypted Virtualization (SEV) features by AMD CPUs in: query name: amd-sev required: false schema: description: Secure Encrypted Virtualization (SEV) features by AMD CPUs format: pve-qemu-sev-fmt type: string - description: Virtual processor architecture. Defaults to the host architecture. in: query name: arch required: false schema: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string - description: Arbitrary arguments passed to kvm. in: query name: args required: false schema: description: Arbitrary arguments passed to kvm. type: string - description: Configure a audio device, useful in combination with QXL/Spice. in: query name: audio0 required: false schema: description: Configure a audio device, useful in combination with QXL/Spice. type: string - description: Automatic restart after crash (currently ignored). in: query name: autostart required: false schema: description: Automatic restart after crash (currently ignored). type: boolean - description: Time to wait for the task to finish. We return 'null' if the task finish within that time. in: query name: background_delay required: false schema: description: Time to wait for the task to finish. We return 'null' if the task finish within that time. type: integer - description: Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero. in: query name: balloon required: false schema: description: Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero. type: integer - description: Select BIOS implementation. in: query name: bios required: false schema: description: Select BIOS implementation. enum: - seabios - ovmf type: string - description: Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. in: query name: boot required: false schema: description: Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. format: pve-qm-boot type: string - description: 'Enable booting from specified disk. Deprecated: Use ''boot: order=foo;bar'' instead.' in: query name: bootdisk required: false schema: description: 'Enable booting from specified disk. Deprecated: Use ''boot: order=foo;bar'' instead.' format: pve-qm-bootdisk type: string - description: This is an alias for option -ide2 in: query name: cdrom required: false schema: description: This is an alias for option -ide2 format: pve-qm-ide type: string - description: 'cloud-init: Specify custom files to replace the automatically generated ones at start.' in: query name: cicustom required: false schema: description: 'cloud-init: Specify custom files to replace the automatically generated ones at start.' format: pve-qm-cicustom type: string - description: 'cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.' in: query name: cipassword required: false schema: description: 'cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.' type: string - description: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. in: query name: citype required: false schema: description: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. enum: - configdrive2 - nocloud - opennebula type: string - description: 'cloud-init: do an automatic package upgrade after the first boot.' in: query name: ciupgrade required: false schema: description: 'cloud-init: do an automatic package upgrade after the first boot.' type: boolean - description: 'cloud-init: User name to change ssh keys and password for instead of the image''s configured default user.' in: query name: ciuser required: false schema: description: 'cloud-init: User name to change ssh keys and password for instead of the image''s configured default user.' type: string - description: The number of cores per socket. in: query name: cores required: false schema: description: The number of cores per socket. type: integer - description: Emulated CPU type. in: query name: cpu required: false schema: description: Emulated CPU type. format: pve-vm-cpu-conf type: string - description: Limit of CPU usage. in: query name: cpulimit required: false schema: description: Limit of CPU usage. type: number - description: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. in: query name: cpuunits required: false schema: description: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. type: integer - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. in: query name: description required: false schema: description: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. type: string - description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string - description: Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: efidisk0 required: false schema: description: Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. in: query name: force required: false schema: description: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. type: boolean - description: Freeze CPU at startup (use 'c' monitor command to start execution). in: query name: freeze required: false schema: description: Freeze CPU at startup (use 'c' monitor command to start execution). type: boolean - description: Script that will be executed during various steps in the vms lifetime. in: query name: hookscript required: false schema: description: Script that will be executed during various steps in the vms lifetime. format: pve-volume-id type: string - description: Map host PCI devices into guest. in: query name: hostpci[n] required: false schema: description: Map host PCI devices into guest. format: pve-qm-hostpci type: string - description: 'Selectively enable hotplug features. This is a comma separated list of hotplug features: ''network'', ''disk'', ''cpu'', ''memory'', ''usb'' and ''cloudinit''. Use ''0'' to disable hotplug completely. Using ''1'' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.' in: query name: hotplug required: false schema: description: 'Selectively enable hotplug features. This is a comma separated list of hotplug features: ''network'', ''disk'', ''cpu'', ''memory'', ''usb'' and ''cloudinit''. Use ''0'' to disable hotplug completely. Using ''1'' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.' format: pve-hotplug-features type: string - description: |- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. in: query name: hugepages required: false schema: description: |- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. enum: - any - "2" - "1024" type: string - description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: ide[n] required: false schema: description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: A file-based storage with 'images' content-type enabled, which is used as an intermediary extraction storage during import. Defaults to the source storage. in: query name: import-working-storage required: false schema: description: A file-based storage with 'images' content-type enabled, which is used as an intermediary extraction storage during import. Defaults to the source storage. format: pve-storage-id type: string - description: Trusted Domain Extension (TDX) features by Intel CPUs in: query name: intel-tdx required: false schema: description: Trusted Domain Extension (TDX) features by Intel CPUs format: pve-qemu-tdx-fmt type: string - description: | cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. in: query name: ipconfig[n] required: false schema: description: | cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. format: pve-qm-ipconfig type: string - description: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. in: query name: ivshmem required: false schema: description: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. type: string - description: Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. in: query name: keephugepages required: false schema: description: Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. type: boolean - description: Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. in: query name: keyboard required: false schema: description: Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. enum: - de - de-ch - da - en-gb - en-us - es - fi - fr - fr-be - fr-ca - fr-ch - hu - is - it - ja - lt - mk - nl - "no" - pl - pt - pt-br - sv - sl - tr type: string - description: Enable/disable KVM hardware virtualization. in: query name: kvm required: false schema: description: Enable/disable KVM hardware virtualization. type: boolean - description: Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. in: query name: localtime required: false schema: description: Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. type: boolean - description: Lock/unlock the VM. in: query name: lock required: false schema: description: Lock/unlock the VM. enum: - backup - clone - create - migrate - rollback - snapshot - snapshot-delete - suspending - suspended type: string - description: Specify the QEMU machine. in: query name: machine required: false schema: description: Specify the QEMU machine. type: string - description: Memory properties. in: query name: memory required: false schema: description: Memory properties. type: string - description: Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. Will be capped to 2000 seconds (maximum in QEMU). in: query name: migrate_downtime required: false schema: description: Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. Will be capped to 2000 seconds (maximum in QEMU). type: number - description: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. in: query name: migrate_speed required: false schema: description: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. type: integer - description: Set a name for the VM. Only used on the configuration web interface. in: query name: name required: false schema: description: Set a name for the VM. Only used on the configuration web interface. format: dns-name type: string - description: 'cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' in: query name: nameserver required: false schema: description: 'cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' format: address-list type: string - description: Specify network devices. in: query name: net[n] required: false schema: description: Specify network devices. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Enable/disable NUMA. in: query name: numa required: false schema: description: Enable/disable NUMA. type: boolean - description: NUMA topology. in: query name: numa[n] required: false schema: description: NUMA topology. type: string - description: Specifies whether a VM will be started during system bootup. in: query name: onboot required: false schema: description: Specifies whether a VM will be started during system bootup. type: boolean - description: Specify guest operating system. in: query name: ostype required: false schema: description: Specify guest operating system. enum: - other - wxp - w2k - w2k3 - w2k8 - wvista - win7 - win8 - win10 - win11 - l24 - l26 - solaris type: string - description: Map host parallel devices (n is 0 to 2). in: query name: parallel[n] required: false schema: description: Map host parallel devices (n is 0 to 2). type: string - description: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. in: query name: protection required: false schema: description: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. type: boolean - description: Allow reboot. If set to '0' the VM exit on reboot. in: query name: reboot required: false schema: description: Allow reboot. If set to '0' the VM exit on reboot. type: boolean - description: Revert a pending change. in: query name: revert required: false schema: description: Revert a pending change. format: pve-configid-list type: string - description: Configure a VirtIO-based Random Number Generator. in: query name: rng0 required: false schema: description: Configure a VirtIO-based Random Number Generator. format: pve-qm-rng type: string - description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: sata[n] required: false schema: description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: scsi[n] required: false schema: description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: SCSI controller model in: query name: scsihw required: false schema: description: SCSI controller model enum: - lsi - lsi53c810 - virtio-scsi-pci - virtio-scsi-single - megasas - pvscsi type: string - description: 'cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' in: query name: searchdomain required: false schema: description: 'cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' type: string - description: Create a serial device inside the VM (n is 0 to 3) in: query name: serial[n] required: false schema: description: Create a serial device inside the VM (n is 0 to 3) type: string - description: Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. in: query name: shares required: false schema: description: Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. type: integer - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: Specify SMBIOS type 1 fields. in: query name: smbios1 required: false schema: description: Specify SMBIOS type 1 fields. format: pve-qm-smbios1 type: string - description: The number of CPUs. Please use option -sockets instead. in: query name: smp required: false schema: description: The number of CPUs. Please use option -sockets instead. type: integer - description: The number of CPU sockets. in: query name: sockets required: false schema: description: The number of CPU sockets. type: integer - description: Configure additional enhancements for SPICE. in: query name: spice_enhancements required: false schema: description: Configure additional enhancements for SPICE. type: string - description: 'cloud-init: Setup public SSH keys (one key per line, OpenSSH format).' in: query name: sshkeys required: false schema: description: 'cloud-init: Setup public SSH keys (one key per line, OpenSSH format).' format: urlencoded type: string - description: Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. in: query name: startdate required: false schema: description: Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. type: string - description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. in: query name: startup required: false schema: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string - description: Enable/disable the USB tablet device. in: query name: tablet required: false schema: description: Enable/disable the USB tablet device. type: boolean - description: Tags of the VM. This is only meta information. in: query name: tags required: false schema: description: Tags of the VM. This is only meta information. format: pve-tag-list type: string - description: Enable/disable time drift fix. in: query name: tdf required: false schema: description: Enable/disable time drift fix. type: boolean - description: Enable/disable Template. in: query name: template required: false schema: description: Enable/disable Template. type: boolean - description: Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: tpmstate0 required: false schema: description: Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Reference to unused volumes. This is used internally, and should not be modified manually. in: query name: unused[n] required: false schema: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string - description: Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). in: query name: usb[n] required: false schema: description: Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). type: string - description: Number of hotplugged vcpus. in: query name: vcpus required: false schema: description: Number of hotplugged vcpus. type: integer - description: Configure the VGA hardware. in: query name: vga required: false schema: description: Configure the VGA hardware. type: string - description: Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: virtio[n] required: false schema: description: Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Configuration for sharing a directory between host and guest using Virtio-fs. in: query name: virtiofs[n] required: false schema: description: Configuration for sharing a directory between host and guest using Virtio-fs. type: string - description: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. in: query name: vmgenid required: false schema: description: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Default storage for VM state volumes/files. in: query name: vmstatestorage required: false schema: description: Default storage for VM state volumes/files. format: pve-storage-id type: string - description: Create a virtual hardware watchdog device. in: query name: watchdog required: false schema: description: Create a virtual hardware watchdog device. format: pve-qm-watchdog type: string requestBody: content: application/json: schema: properties: acpi: description: Enable/disable ACPI. type: boolean affinity: description: 'List of host cores used to execute guest processes, for example: 0,5,8-11' format: pve-cpuset type: string agent: description: Enable/disable communication with the QEMU Guest Agent and its properties. type: string allow-ksm: description: Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). type: boolean amd-sev: description: Secure Encrypted Virtualization (SEV) features by AMD CPUs format: pve-qemu-sev-fmt type: string arch: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string args: description: Arbitrary arguments passed to kvm. type: string audio0: description: Configure a audio device, useful in combination with QXL/Spice. type: string autostart: description: Automatic restart after crash (currently ignored). type: boolean background_delay: description: Time to wait for the task to finish. We return 'null' if the task finish within that time. type: integer balloon: description: Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero. type: integer bios: description: Select BIOS implementation. enum: - seabios - ovmf type: string boot: description: Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. format: pve-qm-boot type: string bootdisk: description: 'Enable booting from specified disk. Deprecated: Use ''boot: order=foo;bar'' instead.' format: pve-qm-bootdisk type: string cdrom: description: This is an alias for option -ide2 format: pve-qm-ide type: string cicustom: description: 'cloud-init: Specify custom files to replace the automatically generated ones at start.' format: pve-qm-cicustom type: string cipassword: description: 'cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.' type: string citype: description: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. enum: - configdrive2 - nocloud - opennebula type: string ciupgrade: description: 'cloud-init: do an automatic package upgrade after the first boot.' type: boolean ciuser: description: 'cloud-init: User name to change ssh keys and password for instead of the image''s configured default user.' type: string cores: description: The number of cores per socket. type: integer cpu: description: Emulated CPU type. format: pve-vm-cpu-conf type: string cpulimit: description: Limit of CPU usage. type: number cpuunits: description: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. type: integer delete: description: A list of settings you want to delete. format: pve-configid-list type: string description: description: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. type: string digest: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string efidisk0: description: Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string force: description: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. type: boolean freeze: description: Freeze CPU at startup (use 'c' monitor command to start execution). type: boolean hookscript: description: Script that will be executed during various steps in the vms lifetime. format: pve-volume-id type: string hostpci[n]: description: Map host PCI devices into guest. format: pve-qm-hostpci type: string hotplug: description: 'Selectively enable hotplug features. This is a comma separated list of hotplug features: ''network'', ''disk'', ''cpu'', ''memory'', ''usb'' and ''cloudinit''. Use ''0'' to disable hotplug completely. Using ''1'' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.' format: pve-hotplug-features type: string hugepages: description: |- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. enum: - any - "2" - "1024" type: string ide[n]: description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string import-working-storage: description: A file-based storage with 'images' content-type enabled, which is used as an intermediary extraction storage during import. Defaults to the source storage. format: pve-storage-id type: string intel-tdx: description: Trusted Domain Extension (TDX) features by Intel CPUs format: pve-qemu-tdx-fmt type: string ipconfig[n]: description: | cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. format: pve-qm-ipconfig type: string ivshmem: description: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. type: string keephugepages: description: Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. type: boolean keyboard: description: Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. enum: - de - de-ch - da - en-gb - en-us - es - fi - fr - fr-be - fr-ca - fr-ch - hu - is - it - ja - lt - mk - nl - "no" - pl - pt - pt-br - sv - sl - tr type: string kvm: description: Enable/disable KVM hardware virtualization. type: boolean localtime: description: Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. type: boolean lock: description: Lock/unlock the VM. enum: - backup - clone - create - migrate - rollback - snapshot - snapshot-delete - suspending - suspended type: string machine: description: Specify the QEMU machine. type: string memory: description: Memory properties. type: string migrate_downtime: description: Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. Will be capped to 2000 seconds (maximum in QEMU). type: number migrate_speed: description: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. type: integer name: description: Set a name for the VM. Only used on the configuration web interface. format: dns-name type: string nameserver: description: 'cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' format: address-list type: string net[n]: description: Specify network devices. type: string node: description: The cluster node name. format: pve-node type: string numa: description: Enable/disable NUMA. type: boolean numa[n]: description: NUMA topology. type: string onboot: description: Specifies whether a VM will be started during system bootup. type: boolean ostype: description: Specify guest operating system. enum: - other - wxp - w2k - w2k3 - w2k8 - wvista - win7 - win8 - win10 - win11 - l24 - l26 - solaris type: string parallel[n]: description: Map host parallel devices (n is 0 to 2). type: string protection: description: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. type: boolean reboot: description: Allow reboot. If set to '0' the VM exit on reboot. type: boolean revert: description: Revert a pending change. format: pve-configid-list type: string rng0: description: Configure a VirtIO-based Random Number Generator. format: pve-qm-rng type: string sata[n]: description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string scsi[n]: description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string scsihw: description: SCSI controller model enum: - lsi - lsi53c810 - virtio-scsi-pci - virtio-scsi-single - megasas - pvscsi type: string searchdomain: description: 'cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' type: string serial[n]: description: Create a serial device inside the VM (n is 0 to 3) type: string shares: description: Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. type: integer skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean smbios1: description: Specify SMBIOS type 1 fields. format: pve-qm-smbios1 type: string smp: description: The number of CPUs. Please use option -sockets instead. type: integer sockets: description: The number of CPU sockets. type: integer spice_enhancements: description: Configure additional enhancements for SPICE. type: string sshkeys: description: 'cloud-init: Setup public SSH keys (one key per line, OpenSSH format).' format: urlencoded type: string startdate: description: Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. type: string startup: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string tablet: description: Enable/disable the USB tablet device. type: boolean tags: description: Tags of the VM. This is only meta information. format: pve-tag-list type: string tdf: description: Enable/disable time drift fix. type: boolean template: description: Enable/disable Template. type: boolean tpmstate0: description: Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string unused[n]: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string usb[n]: description: Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). type: string vcpus: description: Number of hotplugged vcpus. type: integer vga: description: Configure the VGA hardware. type: string virtio[n]: description: Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string virtiofs[n]: description: Configuration for sharing a directory between host and guest using Virtio-fs. type: string vmgenid: description: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer vmstatestorage: description: Default storage for VM state volumes/files. format: pve-storage-id type: string watchdog: description: Create a virtual hardware watchdog device. format: pve-qm-watchdog type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Set virtual machine options (asynchronous API). put: operationId: put_nodes_node_qemu_vmid_config parameters: - description: Enable/disable ACPI. in: query name: acpi required: false schema: description: Enable/disable ACPI. type: boolean - description: 'List of host cores used to execute guest processes, for example: 0,5,8-11' in: query name: affinity required: false schema: description: 'List of host cores used to execute guest processes, for example: 0,5,8-11' format: pve-cpuset type: string - description: Enable/disable communication with the QEMU Guest Agent and its properties. in: query name: agent required: false schema: description: Enable/disable communication with the QEMU Guest Agent and its properties. type: string - description: Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). in: query name: allow-ksm required: false schema: description: Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). type: boolean - description: Secure Encrypted Virtualization (SEV) features by AMD CPUs in: query name: amd-sev required: false schema: description: Secure Encrypted Virtualization (SEV) features by AMD CPUs format: pve-qemu-sev-fmt type: string - description: Virtual processor architecture. Defaults to the host architecture. in: query name: arch required: false schema: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string - description: Arbitrary arguments passed to kvm. in: query name: args required: false schema: description: Arbitrary arguments passed to kvm. type: string - description: Configure a audio device, useful in combination with QXL/Spice. in: query name: audio0 required: false schema: description: Configure a audio device, useful in combination with QXL/Spice. type: string - description: Automatic restart after crash (currently ignored). in: query name: autostart required: false schema: description: Automatic restart after crash (currently ignored). type: boolean - description: Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero. in: query name: balloon required: false schema: description: Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero. type: integer - description: Select BIOS implementation. in: query name: bios required: false schema: description: Select BIOS implementation. enum: - seabios - ovmf type: string - description: Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. in: query name: boot required: false schema: description: Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. format: pve-qm-boot type: string - description: 'Enable booting from specified disk. Deprecated: Use ''boot: order=foo;bar'' instead.' in: query name: bootdisk required: false schema: description: 'Enable booting from specified disk. Deprecated: Use ''boot: order=foo;bar'' instead.' format: pve-qm-bootdisk type: string - description: This is an alias for option -ide2 in: query name: cdrom required: false schema: description: This is an alias for option -ide2 format: pve-qm-ide type: string - description: 'cloud-init: Specify custom files to replace the automatically generated ones at start.' in: query name: cicustom required: false schema: description: 'cloud-init: Specify custom files to replace the automatically generated ones at start.' format: pve-qm-cicustom type: string - description: 'cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.' in: query name: cipassword required: false schema: description: 'cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.' type: string - description: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. in: query name: citype required: false schema: description: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. enum: - configdrive2 - nocloud - opennebula type: string - description: 'cloud-init: do an automatic package upgrade after the first boot.' in: query name: ciupgrade required: false schema: description: 'cloud-init: do an automatic package upgrade after the first boot.' type: boolean - description: 'cloud-init: User name to change ssh keys and password for instead of the image''s configured default user.' in: query name: ciuser required: false schema: description: 'cloud-init: User name to change ssh keys and password for instead of the image''s configured default user.' type: string - description: The number of cores per socket. in: query name: cores required: false schema: description: The number of cores per socket. type: integer - description: Emulated CPU type. in: query name: cpu required: false schema: description: Emulated CPU type. format: pve-vm-cpu-conf type: string - description: Limit of CPU usage. in: query name: cpulimit required: false schema: description: Limit of CPU usage. type: number - description: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. in: query name: cpuunits required: false schema: description: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. type: integer - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. in: query name: description required: false schema: description: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. type: string - description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string - description: Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: efidisk0 required: false schema: description: Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. in: query name: force required: false schema: description: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. type: boolean - description: Freeze CPU at startup (use 'c' monitor command to start execution). in: query name: freeze required: false schema: description: Freeze CPU at startup (use 'c' monitor command to start execution). type: boolean - description: Script that will be executed during various steps in the vms lifetime. in: query name: hookscript required: false schema: description: Script that will be executed during various steps in the vms lifetime. format: pve-volume-id type: string - description: Map host PCI devices into guest. in: query name: hostpci[n] required: false schema: description: Map host PCI devices into guest. format: pve-qm-hostpci type: string - description: 'Selectively enable hotplug features. This is a comma separated list of hotplug features: ''network'', ''disk'', ''cpu'', ''memory'', ''usb'' and ''cloudinit''. Use ''0'' to disable hotplug completely. Using ''1'' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.' in: query name: hotplug required: false schema: description: 'Selectively enable hotplug features. This is a comma separated list of hotplug features: ''network'', ''disk'', ''cpu'', ''memory'', ''usb'' and ''cloudinit''. Use ''0'' to disable hotplug completely. Using ''1'' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.' format: pve-hotplug-features type: string - description: |- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. in: query name: hugepages required: false schema: description: |- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. enum: - any - "2" - "1024" type: string - description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: ide[n] required: false schema: description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Trusted Domain Extension (TDX) features by Intel CPUs in: query name: intel-tdx required: false schema: description: Trusted Domain Extension (TDX) features by Intel CPUs format: pve-qemu-tdx-fmt type: string - description: | cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. in: query name: ipconfig[n] required: false schema: description: | cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. format: pve-qm-ipconfig type: string - description: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. in: query name: ivshmem required: false schema: description: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. type: string - description: Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. in: query name: keephugepages required: false schema: description: Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. type: boolean - description: Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. in: query name: keyboard required: false schema: description: Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. enum: - de - de-ch - da - en-gb - en-us - es - fi - fr - fr-be - fr-ca - fr-ch - hu - is - it - ja - lt - mk - nl - "no" - pl - pt - pt-br - sv - sl - tr type: string - description: Enable/disable KVM hardware virtualization. in: query name: kvm required: false schema: description: Enable/disable KVM hardware virtualization. type: boolean - description: Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. in: query name: localtime required: false schema: description: Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. type: boolean - description: Lock/unlock the VM. in: query name: lock required: false schema: description: Lock/unlock the VM. enum: - backup - clone - create - migrate - rollback - snapshot - snapshot-delete - suspending - suspended type: string - description: Specify the QEMU machine. in: query name: machine required: false schema: description: Specify the QEMU machine. type: string - description: Memory properties. in: query name: memory required: false schema: description: Memory properties. type: string - description: Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. Will be capped to 2000 seconds (maximum in QEMU). in: query name: migrate_downtime required: false schema: description: Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. Will be capped to 2000 seconds (maximum in QEMU). type: number - description: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. in: query name: migrate_speed required: false schema: description: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. type: integer - description: Set a name for the VM. Only used on the configuration web interface. in: query name: name required: false schema: description: Set a name for the VM. Only used on the configuration web interface. format: dns-name type: string - description: 'cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' in: query name: nameserver required: false schema: description: 'cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' format: address-list type: string - description: Specify network devices. in: query name: net[n] required: false schema: description: Specify network devices. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Enable/disable NUMA. in: query name: numa required: false schema: description: Enable/disable NUMA. type: boolean - description: NUMA topology. in: query name: numa[n] required: false schema: description: NUMA topology. type: string - description: Specifies whether a VM will be started during system bootup. in: query name: onboot required: false schema: description: Specifies whether a VM will be started during system bootup. type: boolean - description: Specify guest operating system. in: query name: ostype required: false schema: description: Specify guest operating system. enum: - other - wxp - w2k - w2k3 - w2k8 - wvista - win7 - win8 - win10 - win11 - l24 - l26 - solaris type: string - description: Map host parallel devices (n is 0 to 2). in: query name: parallel[n] required: false schema: description: Map host parallel devices (n is 0 to 2). type: string - description: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. in: query name: protection required: false schema: description: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. type: boolean - description: Allow reboot. If set to '0' the VM exit on reboot. in: query name: reboot required: false schema: description: Allow reboot. If set to '0' the VM exit on reboot. type: boolean - description: Revert a pending change. in: query name: revert required: false schema: description: Revert a pending change. format: pve-configid-list type: string - description: Configure a VirtIO-based Random Number Generator. in: query name: rng0 required: false schema: description: Configure a VirtIO-based Random Number Generator. format: pve-qm-rng type: string - description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: sata[n] required: false schema: description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: scsi[n] required: false schema: description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: SCSI controller model in: query name: scsihw required: false schema: description: SCSI controller model enum: - lsi - lsi53c810 - virtio-scsi-pci - virtio-scsi-single - megasas - pvscsi type: string - description: 'cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' in: query name: searchdomain required: false schema: description: 'cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' type: string - description: Create a serial device inside the VM (n is 0 to 3) in: query name: serial[n] required: false schema: description: Create a serial device inside the VM (n is 0 to 3) type: string - description: Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. in: query name: shares required: false schema: description: Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. type: integer - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: Specify SMBIOS type 1 fields. in: query name: smbios1 required: false schema: description: Specify SMBIOS type 1 fields. format: pve-qm-smbios1 type: string - description: The number of CPUs. Please use option -sockets instead. in: query name: smp required: false schema: description: The number of CPUs. Please use option -sockets instead. type: integer - description: The number of CPU sockets. in: query name: sockets required: false schema: description: The number of CPU sockets. type: integer - description: Configure additional enhancements for SPICE. in: query name: spice_enhancements required: false schema: description: Configure additional enhancements for SPICE. type: string - description: 'cloud-init: Setup public SSH keys (one key per line, OpenSSH format).' in: query name: sshkeys required: false schema: description: 'cloud-init: Setup public SSH keys (one key per line, OpenSSH format).' format: urlencoded type: string - description: Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. in: query name: startdate required: false schema: description: Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. type: string - description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. in: query name: startup required: false schema: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string - description: Enable/disable the USB tablet device. in: query name: tablet required: false schema: description: Enable/disable the USB tablet device. type: boolean - description: Tags of the VM. This is only meta information. in: query name: tags required: false schema: description: Tags of the VM. This is only meta information. format: pve-tag-list type: string - description: Enable/disable time drift fix. in: query name: tdf required: false schema: description: Enable/disable time drift fix. type: boolean - description: Enable/disable Template. in: query name: template required: false schema: description: Enable/disable Template. type: boolean - description: Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: tpmstate0 required: false schema: description: Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Reference to unused volumes. This is used internally, and should not be modified manually. in: query name: unused[n] required: false schema: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string - description: Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). in: query name: usb[n] required: false schema: description: Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). type: string - description: Number of hotplugged vcpus. in: query name: vcpus required: false schema: description: Number of hotplugged vcpus. type: integer - description: Configure the VGA hardware. in: query name: vga required: false schema: description: Configure the VGA hardware. type: string - description: Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. in: query name: virtio[n] required: false schema: description: Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string - description: Configuration for sharing a directory between host and guest using Virtio-fs. in: query name: virtiofs[n] required: false schema: description: Configuration for sharing a directory between host and guest using Virtio-fs. type: string - description: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. in: query name: vmgenid required: false schema: description: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Default storage for VM state volumes/files. in: query name: vmstatestorage required: false schema: description: Default storage for VM state volumes/files. format: pve-storage-id type: string - description: Create a virtual hardware watchdog device. in: query name: watchdog required: false schema: description: Create a virtual hardware watchdog device. format: pve-qm-watchdog type: string requestBody: content: application/json: schema: properties: acpi: description: Enable/disable ACPI. type: boolean affinity: description: 'List of host cores used to execute guest processes, for example: 0,5,8-11' format: pve-cpuset type: string agent: description: Enable/disable communication with the QEMU Guest Agent and its properties. type: string allow-ksm: description: Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). type: boolean amd-sev: description: Secure Encrypted Virtualization (SEV) features by AMD CPUs format: pve-qemu-sev-fmt type: string arch: description: Virtual processor architecture. Defaults to the host architecture. enum: - x86_64 - aarch64 type: string args: description: Arbitrary arguments passed to kvm. type: string audio0: description: Configure a audio device, useful in combination with QXL/Spice. type: string autostart: description: Automatic restart after crash (currently ignored). type: boolean balloon: description: Amount of target RAM for the VM in MiB. The balloon driver is enabled by default, unless it is explicitly disabled by setting the value to zero. type: integer bios: description: Select BIOS implementation. enum: - seabios - ovmf type: string boot: description: Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. format: pve-qm-boot type: string bootdisk: description: 'Enable booting from specified disk. Deprecated: Use ''boot: order=foo;bar'' instead.' format: pve-qm-bootdisk type: string cdrom: description: This is an alias for option -ide2 format: pve-qm-ide type: string cicustom: description: 'cloud-init: Specify custom files to replace the automatically generated ones at start.' format: pve-qm-cicustom type: string cipassword: description: 'cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.' type: string citype: description: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. enum: - configdrive2 - nocloud - opennebula type: string ciupgrade: description: 'cloud-init: do an automatic package upgrade after the first boot.' type: boolean ciuser: description: 'cloud-init: User name to change ssh keys and password for instead of the image''s configured default user.' type: string cores: description: The number of cores per socket. type: integer cpu: description: Emulated CPU type. format: pve-vm-cpu-conf type: string cpulimit: description: Limit of CPU usage. type: number cpuunits: description: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. type: integer delete: description: A list of settings you want to delete. format: pve-configid-list type: string description: description: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. type: string digest: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string efidisk0: description: Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string force: description: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. type: boolean freeze: description: Freeze CPU at startup (use 'c' monitor command to start execution). type: boolean hookscript: description: Script that will be executed during various steps in the vms lifetime. format: pve-volume-id type: string hostpci[n]: description: Map host PCI devices into guest. format: pve-qm-hostpci type: string hotplug: description: 'Selectively enable hotplug features. This is a comma separated list of hotplug features: ''network'', ''disk'', ''cpu'', ''memory'', ''usb'' and ''cloudinit''. Use ''0'' to disable hotplug completely. Using ''1'' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.' format: pve-hotplug-features type: string hugepages: description: |- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. enum: - any - "2" - "1024" type: string ide[n]: description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string intel-tdx: description: Trusted Domain Extension (TDX) features by Intel CPUs format: pve-qemu-tdx-fmt type: string ipconfig[n]: description: | cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. format: pve-qm-ipconfig type: string ivshmem: description: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. type: string keephugepages: description: Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. type: boolean keyboard: description: Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. enum: - de - de-ch - da - en-gb - en-us - es - fi - fr - fr-be - fr-ca - fr-ch - hu - is - it - ja - lt - mk - nl - "no" - pl - pt - pt-br - sv - sl - tr type: string kvm: description: Enable/disable KVM hardware virtualization. type: boolean localtime: description: Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. type: boolean lock: description: Lock/unlock the VM. enum: - backup - clone - create - migrate - rollback - snapshot - snapshot-delete - suspending - suspended type: string machine: description: Specify the QEMU machine. type: string memory: description: Memory properties. type: string migrate_downtime: description: Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. Will be capped to 2000 seconds (maximum in QEMU). type: number migrate_speed: description: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. type: integer name: description: Set a name for the VM. Only used on the configuration web interface. format: dns-name type: string nameserver: description: 'cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' format: address-list type: string net[n]: description: Specify network devices. type: string node: description: The cluster node name. format: pve-node type: string numa: description: Enable/disable NUMA. type: boolean numa[n]: description: NUMA topology. type: string onboot: description: Specifies whether a VM will be started during system bootup. type: boolean ostype: description: Specify guest operating system. enum: - other - wxp - w2k - w2k3 - w2k8 - wvista - win7 - win8 - win10 - win11 - l24 - l26 - solaris type: string parallel[n]: description: Map host parallel devices (n is 0 to 2). type: string protection: description: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. type: boolean reboot: description: Allow reboot. If set to '0' the VM exit on reboot. type: boolean revert: description: Revert a pending change. format: pve-configid-list type: string rng0: description: Configure a VirtIO-based Random Number Generator. format: pve-qm-rng type: string sata[n]: description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string scsi[n]: description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string scsihw: description: SCSI controller model enum: - lsi - lsi53c810 - virtio-scsi-pci - virtio-scsi-single - megasas - pvscsi type: string searchdomain: description: 'cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.' type: string serial[n]: description: Create a serial device inside the VM (n is 0 to 3) type: string shares: description: Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. type: integer skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean smbios1: description: Specify SMBIOS type 1 fields. format: pve-qm-smbios1 type: string smp: description: The number of CPUs. Please use option -sockets instead. type: integer sockets: description: The number of CPU sockets. type: integer spice_enhancements: description: Configure additional enhancements for SPICE. type: string sshkeys: description: 'cloud-init: Setup public SSH keys (one key per line, OpenSSH format).' format: urlencoded type: string startdate: description: Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. type: string startup: description: Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. format: pve-startup-order type: string tablet: description: Enable/disable the USB tablet device. type: boolean tags: description: Tags of the VM. This is only meta information. format: pve-tag-list type: string tdf: description: Enable/disable time drift fix. type: boolean template: description: Enable/disable Template. type: boolean tpmstate0: description: Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string unused[n]: description: Reference to unused volumes. This is used internally, and should not be modified manually. type: string usb[n]: description: Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). type: string vcpus: description: Number of hotplugged vcpus. type: integer vga: description: Configure the VGA hardware. type: string virtio[n]: description: Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. type: string virtiofs[n]: description: Configuration for sharing a directory between host and guest using Virtio-fs. type: string vmgenid: description: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer vmstatestorage: description: Default storage for VM state volumes/files. format: pve-storage-id type: string watchdog: description: Create a virtual hardware watchdog device. format: pve-qm-watchdog type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set virtual machine options (synchronous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation. /nodes/{node}/qemu/{vmid}/dbus-vmstate: post: operationId: post_nodes_node_qemu_vmid_dbus_vmstate parameters: - description: Action to perform on the DBus VMState helper. in: query name: action required: true schema: description: Action to perform on the DBus VMState helper. enum: - start - stop type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: action: description: Action to perform on the DBus VMState helper. enum: - start - stop type: string node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer required: - action type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Control the dbus-vmstate helper for a given running VM. /nodes/{node}/qemu/{vmid}/feature: get: operationId: get_nodes_node_qemu_vmid_feature parameters: - description: Feature to check. in: query name: feature required: false schema: description: Feature to check. enum: - snapshot - clone - copy type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: query name: snapname required: false schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: hasFeature: type: boolean nodes: items: type: string type: array type: object description: OK summary: Check if feature for virtual machine is available. /nodes/{node}/qemu/{vmid}/firewall: get: operationId: get_nodes_node_qemu_vmid_firewall parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Directory index. /nodes/{node}/qemu/{vmid}/firewall/aliases: get: operationId: get_nodes_node_qemu_vmid_firewall_aliases parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: cidr: type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: type: string type: object type: array description: OK summary: List aliases post: operationId: post_nodes_node_qemu_vmid_firewall_aliases parameters: - description: Network/IP specification in CIDR format. in: query name: cidr required: false schema: description: Network/IP specification in CIDR format. format: IPorCIDR type: string - description: "" in: query name: comment required: false schema: type: string - description: Alias name. in: query name: name required: false schema: description: Alias name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDR type: string comment: type: string name: description: Alias name. type: string node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create IP or Network Alias. /nodes/{node}/qemu/{vmid}/firewall/aliases/{name}: delete: operationId: delete_nodes_node_qemu_vmid_firewall_aliases_name parameters: - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Alias name. in: path name: name required: true schema: description: Alias name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove IP or Network alias. get: operationId: get_nodes_node_qemu_vmid_firewall_aliases_name parameters: - description: Alias name. in: path name: name required: true schema: description: Alias name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: type: object description: OK summary: Read alias. put: operationId: put_nodes_node_qemu_vmid_firewall_aliases_name parameters: - description: Network/IP specification in CIDR format. in: query name: cidr required: false schema: description: Network/IP specification in CIDR format. format: IPorCIDR type: string - description: "" in: query name: comment required: false schema: type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Alias name. in: path name: name required: true schema: description: Alias name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Rename an existing alias. in: query name: rename required: false schema: description: Rename an existing alias. type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDR type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: Alias name. type: string node: description: The cluster node name. format: pve-node type: string rename: description: Rename an existing alias. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update IP or Network alias. /nodes/{node}/qemu/{vmid}/firewall/ipset: get: operationId: get_nodes_node_qemu_vmid_firewall_ipset parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: IP set name. type: string type: object type: array description: OK summary: List IPSets post: operationId: post_nodes_node_qemu_vmid_firewall_ipset parameters: - description: "" in: query name: comment required: false schema: type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: IP set name. in: query name: name required: false schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. in: query name: rename required: false schema: description: Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: IP set name. type: string node: description: The cluster node name. format: pve-node type: string rename: description: Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new IPSet /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}: delete: operationId: delete_nodes_node_qemu_vmid_firewall_ipset_name parameters: - description: Delete all members of the IPSet, if there are any. in: query name: force required: false schema: description: Delete all members of the IPSet, if there are any. type: boolean - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete IPSet get: operationId: get_nodes_node_qemu_vmid_firewall_ipset_name parameters: - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: cidr: type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string nomatch: type: boolean type: object type: array description: OK summary: List IPSet content post: operationId: post_nodes_node_qemu_vmid_firewall_ipset_name parameters: - description: Network/IP specification in CIDR format. in: query name: cidr required: false schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: "" in: query name: comment required: false schema: type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: "" in: query name: nomatch required: false schema: type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string comment: type: string name: description: IP set name. type: string node: description: The cluster node name. format: pve-node type: string nomatch: type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Add IP or Network to IPSet. /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}: delete: operationId: delete_nodes_node_qemu_vmid_firewall_ipset_name_cidr parameters: - description: Network/IP specification in CIDR format. in: path name: cidr required: true schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Remove IP or Network from IPSet. get: operationId: get_nodes_node_qemu_vmid_firewall_ipset_name_cidr parameters: - description: Network/IP specification in CIDR format. in: path name: cidr required: true schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: type: object description: OK summary: Read IP or Network settings from IPSet. put: operationId: put_nodes_node_qemu_vmid_firewall_ipset_name_cidr parameters: - description: Network/IP specification in CIDR format. in: path name: cidr required: true schema: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string - description: "" in: query name: comment required: false schema: type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: IP set name. in: path name: name required: true schema: description: IP set name. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: "" in: query name: nomatch required: false schema: type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: cidr: description: Network/IP specification in CIDR format. format: IPorCIDRorAlias type: string comment: type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string name: description: IP set name. type: string node: description: The cluster node name. format: pve-node type: string nomatch: type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update IP or Network settings /nodes/{node}/qemu/{vmid}/firewall/log: get: operationId: get_nodes_node_qemu_vmid_firewall_log parameters: - description: "" in: query name: limit required: false schema: type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Display log since this UNIX epoch. in: query name: since required: false schema: description: Display log since this UNIX epoch. type: integer - description: "" in: query name: start required: false schema: type: integer - description: Display log until this UNIX epoch. in: query name: until required: false schema: description: Display log until this UNIX epoch. type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: "n": description: Line number type: integer t: description: Line text type: string type: object type: array description: OK summary: Read firewall log /nodes/{node}/qemu/{vmid}/firewall/options: get: operationId: get_nodes_node_qemu_vmid_firewall_options parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: dhcp: description: Enable DHCP. type: boolean enable: description: Enable/disable firewall rules. type: boolean ipfilter: description: Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. type: boolean log_level_in: description: Log level for incoming traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string log_level_out: description: Log level for outgoing traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macfilter: description: Enable/disable MAC address filter. type: boolean ndp: description: Enable NDP (Neighbor Discovery Protocol). type: boolean policy_in: description: Input policy. enum: - ACCEPT - REJECT - DROP type: string policy_out: description: Output policy. enum: - ACCEPT - REJECT - DROP type: string radv: description: Allow sending Router Advertisement. type: boolean type: object description: OK summary: Get VM firewall options. put: operationId: put_nodes_node_qemu_vmid_firewall_options parameters: - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Enable DHCP. in: query name: dhcp required: false schema: description: Enable DHCP. type: boolean - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Enable/disable firewall rules. in: query name: enable required: false schema: description: Enable/disable firewall rules. type: boolean - description: Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. in: query name: ipfilter required: false schema: description: Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. type: boolean - description: Log level for incoming traffic. in: query name: log_level_in required: false schema: description: Log level for incoming traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Log level for outgoing traffic. in: query name: log_level_out required: false schema: description: Log level for outgoing traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Enable/disable MAC address filter. in: query name: macfilter required: false schema: description: Enable/disable MAC address filter. type: boolean - description: Enable NDP (Neighbor Discovery Protocol). in: query name: ndp required: false schema: description: Enable NDP (Neighbor Discovery Protocol). type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Input policy. in: query name: policy_in required: false schema: description: Input policy. enum: - ACCEPT - REJECT - DROP type: string - description: Output policy. in: query name: policy_out required: false schema: description: Output policy. enum: - ACCEPT - REJECT - DROP type: string - description: Allow sending Router Advertisement. in: query name: radv required: false schema: description: Allow sending Router Advertisement. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: delete: description: A list of settings you want to delete. format: pve-configid-list type: string dhcp: description: Enable DHCP. type: boolean digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string enable: description: Enable/disable firewall rules. type: boolean ipfilter: description: Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. type: boolean log_level_in: description: Log level for incoming traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string log_level_out: description: Log level for outgoing traffic. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macfilter: description: Enable/disable MAC address filter. type: boolean ndp: description: Enable NDP (Neighbor Discovery Protocol). type: boolean node: description: The cluster node name. format: pve-node type: string policy_in: description: Input policy. enum: - ACCEPT - REJECT - DROP type: string policy_out: description: Output policy. enum: - ACCEPT - REJECT - DROP type: string radv: description: Allow sending Router Advertisement. type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set Firewall options. /nodes/{node}/qemu/{vmid}/firewall/refs: get: operationId: get_nodes_node_qemu_vmid_firewall_refs parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Only list references of specified type. in: query name: type required: false schema: description: Only list references of specified type. enum: - alias - ipset type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: comment: type: string name: type: string ref: type: string scope: type: string type: enum: - alias - ipset type: string type: object type: array description: OK summary: Lists possible IPSet/Alias reference which are allowed in source/dest properties. /nodes/{node}/qemu/{vmid}/firewall/rules: get: operationId: get_nodes_node_qemu_vmid_firewall_rules parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object type: array description: OK summary: List rules. post: operationId: post_nodes_node_qemu_vmid_firewall_rules parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: true schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: query name: pos required: false schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: true schema: description: Rule type. enum: - in - out - forward - group type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string node: description: The cluster node name. format: pve-node type: string pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer required: - type - action type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new rule. /nodes/{node}/qemu/{vmid}/firewall/rules/{pos}: delete: operationId: delete_nodes_node_qemu_vmid_firewall_rules_pos parameters: - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete rule. get: operationId: get_nodes_node_qemu_vmid_firewall_rules_pos parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name type: string comment: description: Descriptive comment type: string dest: description: Restrict packet destination address type: string dport: description: Restrict TCP/UDP destination port type: string enable: description: Flag to enable/disable a rule type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers type: string ipversion: description: IP version (4 or 6) - automatically determined from source/dest addresses type: integer log: description: Log level for firewall rule enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro type: string pos: description: Rule position in the ruleset type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' type: string source: description: Restrict packet source address type: string sport: description: Restrict TCP/UDP source port type: string type: description: Rule type type: string type: object description: OK summary: Get single rule data. put: operationId: put_nodes_node_qemu_vmid_firewall_rules_pos parameters: - description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. in: query name: action required: false schema: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string - description: Descriptive comment. in: query name: comment required: false schema: description: Descriptive comment. type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: dest required: false schema: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: dport required: false schema: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string - description: Flag to enable/disable a rule. in: query name: enable required: false schema: description: Flag to enable/disable a rule. type: integer - description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. in: query name: icmp-type required: false schema: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string - description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. in: query name: iface required: false schema: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string - description: Log level for firewall rule. in: query name: log required: false schema: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string - description: Use predefined standard macro. in: query name: macro required: false schema: description: Use predefined standard macro. type: string - description: Move rule to new position . Other arguments are ignored. in: query name: moveto required: false schema: description: Move rule to new position . Other arguments are ignored. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Update rule at position . in: path name: pos required: true schema: description: Update rule at position . type: integer - description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. in: query name: proto required: false schema: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string - description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. in: query name: source required: false schema: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string - description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. in: query name: sport required: false schema: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string - description: Rule type. in: query name: type required: false schema: description: Rule type. enum: - in - out - forward - group type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: action: description: Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. type: string comment: description: Descriptive comment. type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string dest: description: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string dport: description: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-dport-spec type: string enable: description: Flag to enable/disable a rule. type: integer icmp-type: description: Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. format: pve-fw-icmp-type-spec type: string iface: description: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. format: pve-iface type: string log: description: Log level for firewall rule. enum: - emerg - alert - crit - err - warning - notice - info - debug - nolog type: string macro: description: Use predefined standard macro. type: string moveto: description: Move rule to new position . Other arguments are ignored. type: integer node: description: The cluster node name. format: pve-node type: string pos: description: Update rule at position . type: integer proto: description: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. format: pve-fw-protocol-spec type: string source: description: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. format: pve-fw-addr-spec type: string sport: description: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. format: pve-fw-sport-spec type: string type: description: Rule type. enum: - in - out - forward - group type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Modify rule data. /nodes/{node}/qemu/{vmid}/migrate: get: operationId: get_nodes_node_qemu_vmid_migrate parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Target node. in: query name: target required: false schema: description: Target node. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: allowed_nodes: description: List of nodes allowed for migration. items: description: An allowed node type: string type: array dependent-ha-resources: description: HA resources, which will be migrated to the same target node as the VM, because these are in positive affinity with the VM. items: description: The ':' resource IDs of a HA resource with a positive affinity rule to this VM. type: string type: array has-dbus-vmstate: description: Whether the VM host supports migrating additional VM state, such as conntrack entries. type: boolean local_disks: description: List local disks including CD-Rom, unused and not referenced disks items: properties: cdrom: description: True if the disk is a cdrom. type: boolean is_unused: description: True if the disk is unused. type: boolean size: description: The size of the disk in bytes. type: integer volid: description: The volid of the disk. type: string type: object type: array local_resources: description: List local resources (e.g. pci, usb) that block migration. items: description: A local resource type: string type: array mapped-resource-info: description: Object of mapped resources with additional information such if they're live migratable. type: object mapped-resources: description: List of mapped resources e.g. pci, usb. Deprecated, use 'mapped-resource-info' instead. items: description: A mapped resource type: string type: array not_allowed_nodes: description: List of not allowed nodes with additional information. properties: blocking-ha-resources: description: HA resources, which are blocking the VM from being migrated to the node. items: description: A blocking HA resource properties: cause: description: The reason why the HA resource is blocking the migration. enum: - node-affinity - resource-affinity type: string sid: description: The blocking HA resource id type: string type: object type: array unavailable_storages: description: A list of not available storages. items: description: A storage type: string type: array type: object running: description: Determines if the VM is running. type: boolean type: object description: OK summary: Get preconditions for migration. post: operationId: post_nodes_node_qemu_vmid_migrate parameters: - description: Override I/O bandwidth limit (in KiB/s). in: query name: bwlimit required: false schema: description: Override I/O bandwidth limit (in KiB/s). type: integer - description: Allow to migrate VMs which use local devices. Only root may use this option. in: query name: force required: false schema: description: Allow to migrate VMs which use local devices. Only root may use this option. type: boolean - description: CIDR of the (sub) network that is used for migration. in: query name: migration_network required: false schema: description: CIDR of the (sub) network that is used for migration. format: CIDR type: string - description: Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. in: query name: migration_type required: false schema: description: Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. enum: - secure - insecure type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Use online/live migration if VM is running. Ignored if VM is stopped. in: query name: online required: false schema: description: Use online/live migration if VM is running. Ignored if VM is stopped. type: boolean - description: Target node. in: query name: target required: false schema: description: Target node. format: pve-node type: string - description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. in: query name: targetstorage required: false schema: description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. format: storage-pair-list type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Whether to migrate conntrack entries for running VMs. in: query name: with-conntrack-state required: false schema: description: Whether to migrate conntrack entries for running VMs. type: boolean - description: Enable live storage migration for local disk in: query name: with-local-disks required: false schema: description: Enable live storage migration for local disk type: boolean requestBody: content: application/json: schema: properties: bwlimit: description: Override I/O bandwidth limit (in KiB/s). type: integer force: description: Allow to migrate VMs which use local devices. Only root may use this option. type: boolean migration_network: description: CIDR of the (sub) network that is used for migration. format: CIDR type: string migration_type: description: Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. enum: - secure - insecure type: string node: description: The cluster node name. format: pve-node type: string online: description: Use online/live migration if VM is running. Ignored if VM is stopped. type: boolean target: description: Target node. format: pve-node type: string targetstorage: description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. format: storage-pair-list type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer with-conntrack-state: description: Whether to migrate conntrack entries for running VMs. type: boolean with-local-disks: description: Enable live storage migration for local disk type: boolean type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Migrate virtual machine. Creates a new migration task. /nodes/{node}/qemu/{vmid}/monitor: post: operationId: post_nodes_node_qemu_vmid_monitor parameters: - description: The monitor command. in: query name: command required: false schema: description: The monitor command. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: command: description: The monitor command. type: string node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Execute QEMU monitor commands. /nodes/{node}/qemu/{vmid}/move_disk: post: operationId: post_nodes_node_qemu_vmid_move_disk parameters: - description: Override I/O bandwidth limit (in KiB/s). in: query name: bwlimit required: false schema: description: Override I/O bandwidth limit (in KiB/s). type: integer - description: Delete the original disk after successful copy. By default the original disk is kept as unused disk. in: query name: delete required: false schema: description: Delete the original disk after successful copy. By default the original disk is kept as unused disk. type: boolean - description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string - description: The disk you want to move. in: query name: disk required: false schema: description: The disk you want to move. enum: - ide0 - ide1 - ide2 - ide3 - scsi0 - scsi1 - scsi2 - scsi3 - scsi4 - scsi5 - scsi6 - scsi7 - scsi8 - scsi9 - scsi10 - scsi11 - scsi12 - scsi13 - scsi14 - scsi15 - scsi16 - scsi17 - scsi18 - scsi19 - scsi20 - scsi21 - scsi22 - scsi23 - scsi24 - scsi25 - scsi26 - scsi27 - scsi28 - scsi29 - scsi30 - virtio0 - virtio1 - virtio2 - virtio3 - virtio4 - virtio5 - virtio6 - virtio7 - virtio8 - virtio9 - virtio10 - virtio11 - virtio12 - virtio13 - virtio14 - virtio15 - sata0 - sata1 - sata2 - sata3 - sata4 - sata5 - efidisk0 - tpmstate0 - unused0 - unused1 - unused2 - unused3 - unused4 - unused5 - unused6 - unused7 - unused8 - unused9 - unused10 - unused11 - unused12 - unused13 - unused14 - unused15 - unused16 - unused17 - unused18 - unused19 - unused20 - unused21 - unused22 - unused23 - unused24 - unused25 - unused26 - unused27 - unused28 - unused29 - unused30 - unused31 - unused32 - unused33 - unused34 - unused35 - unused36 - unused37 - unused38 - unused39 - unused40 - unused41 - unused42 - unused43 - unused44 - unused45 - unused46 - unused47 - unused48 - unused49 - unused50 - unused51 - unused52 - unused53 - unused54 - unused55 - unused56 - unused57 - unused58 - unused59 - unused60 - unused61 - unused62 - unused63 - unused64 - unused65 - unused66 - unused67 - unused68 - unused69 - unused70 - unused71 - unused72 - unused73 - unused74 - unused75 - unused76 - unused77 - unused78 - unused79 - unused80 - unused81 - unused82 - unused83 - unused84 - unused85 - unused86 - unused87 - unused88 - unused89 - unused90 - unused91 - unused92 - unused93 - unused94 - unused95 - unused96 - unused97 - unused98 - unused99 - unused100 - unused101 - unused102 - unused103 - unused104 - unused105 - unused106 - unused107 - unused108 - unused109 - unused110 - unused111 - unused112 - unused113 - unused114 - unused115 - unused116 - unused117 - unused118 - unused119 - unused120 - unused121 - unused122 - unused123 - unused124 - unused125 - unused126 - unused127 - unused128 - unused129 - unused130 - unused131 - unused132 - unused133 - unused134 - unused135 - unused136 - unused137 - unused138 - unused139 - unused140 - unused141 - unused142 - unused143 - unused144 - unused145 - unused146 - unused147 - unused148 - unused149 - unused150 - unused151 - unused152 - unused153 - unused154 - unused155 - unused156 - unused157 - unused158 - unused159 - unused160 - unused161 - unused162 - unused163 - unused164 - unused165 - unused166 - unused167 - unused168 - unused169 - unused170 - unused171 - unused172 - unused173 - unused174 - unused175 - unused176 - unused177 - unused178 - unused179 - unused180 - unused181 - unused182 - unused183 - unused184 - unused185 - unused186 - unused187 - unused188 - unused189 - unused190 - unused191 - unused192 - unused193 - unused194 - unused195 - unused196 - unused197 - unused198 - unused199 - unused200 - unused201 - unused202 - unused203 - unused204 - unused205 - unused206 - unused207 - unused208 - unused209 - unused210 - unused211 - unused212 - unused213 - unused214 - unused215 - unused216 - unused217 - unused218 - unused219 - unused220 - unused221 - unused222 - unused223 - unused224 - unused225 - unused226 - unused227 - unused228 - unused229 - unused230 - unused231 - unused232 - unused233 - unused234 - unused235 - unused236 - unused237 - unused238 - unused239 - unused240 - unused241 - unused242 - unused243 - unused244 - unused245 - unused246 - unused247 - unused248 - unused249 - unused250 - unused251 - unused252 - unused253 - unused254 - unused255 type: string - description: Target Format. in: query name: format required: false schema: description: Target Format. enum: - raw - qcow2 - vmdk type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Target storage. in: query name: storage required: false schema: description: Target storage. format: pve-storage-id type: string - description: Prevent changes if the current config file of the target VM has a different SHA1 digest. This can be used to detect concurrent modifications. in: query name: target-digest required: false schema: description: Prevent changes if the current config file of the target VM has a different SHA1 digest. This can be used to detect concurrent modifications. type: string - description: The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. in: query name: target-disk required: false schema: description: The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. enum: - ide0 - ide1 - ide2 - ide3 - scsi0 - scsi1 - scsi2 - scsi3 - scsi4 - scsi5 - scsi6 - scsi7 - scsi8 - scsi9 - scsi10 - scsi11 - scsi12 - scsi13 - scsi14 - scsi15 - scsi16 - scsi17 - scsi18 - scsi19 - scsi20 - scsi21 - scsi22 - scsi23 - scsi24 - scsi25 - scsi26 - scsi27 - scsi28 - scsi29 - scsi30 - virtio0 - virtio1 - virtio2 - virtio3 - virtio4 - virtio5 - virtio6 - virtio7 - virtio8 - virtio9 - virtio10 - virtio11 - virtio12 - virtio13 - virtio14 - virtio15 - sata0 - sata1 - sata2 - sata3 - sata4 - sata5 - efidisk0 - tpmstate0 - unused0 - unused1 - unused2 - unused3 - unused4 - unused5 - unused6 - unused7 - unused8 - unused9 - unused10 - unused11 - unused12 - unused13 - unused14 - unused15 - unused16 - unused17 - unused18 - unused19 - unused20 - unused21 - unused22 - unused23 - unused24 - unused25 - unused26 - unused27 - unused28 - unused29 - unused30 - unused31 - unused32 - unused33 - unused34 - unused35 - unused36 - unused37 - unused38 - unused39 - unused40 - unused41 - unused42 - unused43 - unused44 - unused45 - unused46 - unused47 - unused48 - unused49 - unused50 - unused51 - unused52 - unused53 - unused54 - unused55 - unused56 - unused57 - unused58 - unused59 - unused60 - unused61 - unused62 - unused63 - unused64 - unused65 - unused66 - unused67 - unused68 - unused69 - unused70 - unused71 - unused72 - unused73 - unused74 - unused75 - unused76 - unused77 - unused78 - unused79 - unused80 - unused81 - unused82 - unused83 - unused84 - unused85 - unused86 - unused87 - unused88 - unused89 - unused90 - unused91 - unused92 - unused93 - unused94 - unused95 - unused96 - unused97 - unused98 - unused99 - unused100 - unused101 - unused102 - unused103 - unused104 - unused105 - unused106 - unused107 - unused108 - unused109 - unused110 - unused111 - unused112 - unused113 - unused114 - unused115 - unused116 - unused117 - unused118 - unused119 - unused120 - unused121 - unused122 - unused123 - unused124 - unused125 - unused126 - unused127 - unused128 - unused129 - unused130 - unused131 - unused132 - unused133 - unused134 - unused135 - unused136 - unused137 - unused138 - unused139 - unused140 - unused141 - unused142 - unused143 - unused144 - unused145 - unused146 - unused147 - unused148 - unused149 - unused150 - unused151 - unused152 - unused153 - unused154 - unused155 - unused156 - unused157 - unused158 - unused159 - unused160 - unused161 - unused162 - unused163 - unused164 - unused165 - unused166 - unused167 - unused168 - unused169 - unused170 - unused171 - unused172 - unused173 - unused174 - unused175 - unused176 - unused177 - unused178 - unused179 - unused180 - unused181 - unused182 - unused183 - unused184 - unused185 - unused186 - unused187 - unused188 - unused189 - unused190 - unused191 - unused192 - unused193 - unused194 - unused195 - unused196 - unused197 - unused198 - unused199 - unused200 - unused201 - unused202 - unused203 - unused204 - unused205 - unused206 - unused207 - unused208 - unused209 - unused210 - unused211 - unused212 - unused213 - unused214 - unused215 - unused216 - unused217 - unused218 - unused219 - unused220 - unused221 - unused222 - unused223 - unused224 - unused225 - unused226 - unused227 - unused228 - unused229 - unused230 - unused231 - unused232 - unused233 - unused234 - unused235 - unused236 - unused237 - unused238 - unused239 - unused240 - unused241 - unused242 - unused243 - unused244 - unused245 - unused246 - unused247 - unused248 - unused249 - unused250 - unused251 - unused252 - unused253 - unused254 - unused255 type: string - description: The (unique) ID of the VM. in: query name: target-vmid required: false schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: bwlimit: description: Override I/O bandwidth limit (in KiB/s). type: integer delete: description: Delete the original disk after successful copy. By default the original disk is kept as unused disk. type: boolean digest: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string disk: description: The disk you want to move. enum: - ide0 - ide1 - ide2 - ide3 - scsi0 - scsi1 - scsi2 - scsi3 - scsi4 - scsi5 - scsi6 - scsi7 - scsi8 - scsi9 - scsi10 - scsi11 - scsi12 - scsi13 - scsi14 - scsi15 - scsi16 - scsi17 - scsi18 - scsi19 - scsi20 - scsi21 - scsi22 - scsi23 - scsi24 - scsi25 - scsi26 - scsi27 - scsi28 - scsi29 - scsi30 - virtio0 - virtio1 - virtio2 - virtio3 - virtio4 - virtio5 - virtio6 - virtio7 - virtio8 - virtio9 - virtio10 - virtio11 - virtio12 - virtio13 - virtio14 - virtio15 - sata0 - sata1 - sata2 - sata3 - sata4 - sata5 - efidisk0 - tpmstate0 - unused0 - unused1 - unused2 - unused3 - unused4 - unused5 - unused6 - unused7 - unused8 - unused9 - unused10 - unused11 - unused12 - unused13 - unused14 - unused15 - unused16 - unused17 - unused18 - unused19 - unused20 - unused21 - unused22 - unused23 - unused24 - unused25 - unused26 - unused27 - unused28 - unused29 - unused30 - unused31 - unused32 - unused33 - unused34 - unused35 - unused36 - unused37 - unused38 - unused39 - unused40 - unused41 - unused42 - unused43 - unused44 - unused45 - unused46 - unused47 - unused48 - unused49 - unused50 - unused51 - unused52 - unused53 - unused54 - unused55 - unused56 - unused57 - unused58 - unused59 - unused60 - unused61 - unused62 - unused63 - unused64 - unused65 - unused66 - unused67 - unused68 - unused69 - unused70 - unused71 - unused72 - unused73 - unused74 - unused75 - unused76 - unused77 - unused78 - unused79 - unused80 - unused81 - unused82 - unused83 - unused84 - unused85 - unused86 - unused87 - unused88 - unused89 - unused90 - unused91 - unused92 - unused93 - unused94 - unused95 - unused96 - unused97 - unused98 - unused99 - unused100 - unused101 - unused102 - unused103 - unused104 - unused105 - unused106 - unused107 - unused108 - unused109 - unused110 - unused111 - unused112 - unused113 - unused114 - unused115 - unused116 - unused117 - unused118 - unused119 - unused120 - unused121 - unused122 - unused123 - unused124 - unused125 - unused126 - unused127 - unused128 - unused129 - unused130 - unused131 - unused132 - unused133 - unused134 - unused135 - unused136 - unused137 - unused138 - unused139 - unused140 - unused141 - unused142 - unused143 - unused144 - unused145 - unused146 - unused147 - unused148 - unused149 - unused150 - unused151 - unused152 - unused153 - unused154 - unused155 - unused156 - unused157 - unused158 - unused159 - unused160 - unused161 - unused162 - unused163 - unused164 - unused165 - unused166 - unused167 - unused168 - unused169 - unused170 - unused171 - unused172 - unused173 - unused174 - unused175 - unused176 - unused177 - unused178 - unused179 - unused180 - unused181 - unused182 - unused183 - unused184 - unused185 - unused186 - unused187 - unused188 - unused189 - unused190 - unused191 - unused192 - unused193 - unused194 - unused195 - unused196 - unused197 - unused198 - unused199 - unused200 - unused201 - unused202 - unused203 - unused204 - unused205 - unused206 - unused207 - unused208 - unused209 - unused210 - unused211 - unused212 - unused213 - unused214 - unused215 - unused216 - unused217 - unused218 - unused219 - unused220 - unused221 - unused222 - unused223 - unused224 - unused225 - unused226 - unused227 - unused228 - unused229 - unused230 - unused231 - unused232 - unused233 - unused234 - unused235 - unused236 - unused237 - unused238 - unused239 - unused240 - unused241 - unused242 - unused243 - unused244 - unused245 - unused246 - unused247 - unused248 - unused249 - unused250 - unused251 - unused252 - unused253 - unused254 - unused255 type: string format: description: Target Format. enum: - raw - qcow2 - vmdk type: string node: description: The cluster node name. format: pve-node type: string storage: description: Target storage. format: pve-storage-id type: string target-digest: description: Prevent changes if the current config file of the target VM has a different SHA1 digest. This can be used to detect concurrent modifications. type: string target-disk: description: The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. enum: - ide0 - ide1 - ide2 - ide3 - scsi0 - scsi1 - scsi2 - scsi3 - scsi4 - scsi5 - scsi6 - scsi7 - scsi8 - scsi9 - scsi10 - scsi11 - scsi12 - scsi13 - scsi14 - scsi15 - scsi16 - scsi17 - scsi18 - scsi19 - scsi20 - scsi21 - scsi22 - scsi23 - scsi24 - scsi25 - scsi26 - scsi27 - scsi28 - scsi29 - scsi30 - virtio0 - virtio1 - virtio2 - virtio3 - virtio4 - virtio5 - virtio6 - virtio7 - virtio8 - virtio9 - virtio10 - virtio11 - virtio12 - virtio13 - virtio14 - virtio15 - sata0 - sata1 - sata2 - sata3 - sata4 - sata5 - efidisk0 - tpmstate0 - unused0 - unused1 - unused2 - unused3 - unused4 - unused5 - unused6 - unused7 - unused8 - unused9 - unused10 - unused11 - unused12 - unused13 - unused14 - unused15 - unused16 - unused17 - unused18 - unused19 - unused20 - unused21 - unused22 - unused23 - unused24 - unused25 - unused26 - unused27 - unused28 - unused29 - unused30 - unused31 - unused32 - unused33 - unused34 - unused35 - unused36 - unused37 - unused38 - unused39 - unused40 - unused41 - unused42 - unused43 - unused44 - unused45 - unused46 - unused47 - unused48 - unused49 - unused50 - unused51 - unused52 - unused53 - unused54 - unused55 - unused56 - unused57 - unused58 - unused59 - unused60 - unused61 - unused62 - unused63 - unused64 - unused65 - unused66 - unused67 - unused68 - unused69 - unused70 - unused71 - unused72 - unused73 - unused74 - unused75 - unused76 - unused77 - unused78 - unused79 - unused80 - unused81 - unused82 - unused83 - unused84 - unused85 - unused86 - unused87 - unused88 - unused89 - unused90 - unused91 - unused92 - unused93 - unused94 - unused95 - unused96 - unused97 - unused98 - unused99 - unused100 - unused101 - unused102 - unused103 - unused104 - unused105 - unused106 - unused107 - unused108 - unused109 - unused110 - unused111 - unused112 - unused113 - unused114 - unused115 - unused116 - unused117 - unused118 - unused119 - unused120 - unused121 - unused122 - unused123 - unused124 - unused125 - unused126 - unused127 - unused128 - unused129 - unused130 - unused131 - unused132 - unused133 - unused134 - unused135 - unused136 - unused137 - unused138 - unused139 - unused140 - unused141 - unused142 - unused143 - unused144 - unused145 - unused146 - unused147 - unused148 - unused149 - unused150 - unused151 - unused152 - unused153 - unused154 - unused155 - unused156 - unused157 - unused158 - unused159 - unused160 - unused161 - unused162 - unused163 - unused164 - unused165 - unused166 - unused167 - unused168 - unused169 - unused170 - unused171 - unused172 - unused173 - unused174 - unused175 - unused176 - unused177 - unused178 - unused179 - unused180 - unused181 - unused182 - unused183 - unused184 - unused185 - unused186 - unused187 - unused188 - unused189 - unused190 - unused191 - unused192 - unused193 - unused194 - unused195 - unused196 - unused197 - unused198 - unused199 - unused200 - unused201 - unused202 - unused203 - unused204 - unused205 - unused206 - unused207 - unused208 - unused209 - unused210 - unused211 - unused212 - unused213 - unused214 - unused215 - unused216 - unused217 - unused218 - unused219 - unused220 - unused221 - unused222 - unused223 - unused224 - unused225 - unused226 - unused227 - unused228 - unused229 - unused230 - unused231 - unused232 - unused233 - unused234 - unused235 - unused236 - unused237 - unused238 - unused239 - unused240 - unused241 - unused242 - unused243 - unused244 - unused245 - unused246 - unused247 - unused248 - unused249 - unused250 - unused251 - unused252 - unused253 - unused254 - unused255 type: string target-vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Move volume to different storage or to a different VM. /nodes/{node}/qemu/{vmid}/mtunnel: post: operationId: post_nodes_node_qemu_vmid_mtunnel parameters: - description: List of network bridges to check availability. Will be checked again for actually used bridges during migration. in: query name: bridges required: false schema: description: List of network bridges to check availability. Will be checked again for actually used bridges during migration. format: pve-bridge-id-list type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: List of storages to check permission and availability. Will be checked again for all actually used storages during migration. in: query name: storages required: false schema: description: List of storages to check permission and availability. Will be checked again for all actually used storages during migration. format: pve-storage-id-list type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: bridges: description: List of network bridges to check availability. Will be checked again for actually used bridges during migration. format: pve-bridge-id-list type: string node: description: The cluster node name. format: pve-node type: string storages: description: List of storages to check permission and availability. Will be checked again for all actually used storages during migration. format: pve-storage-id-list type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: properties: socket: type: string ticket: type: string upid: type: string type: object description: OK summary: Migration tunnel endpoint - only for internal use by VM migration. /nodes/{node}/qemu/{vmid}/mtunnelwebsocket: get: operationId: get_nodes_node_qemu_vmid_mtunnelwebsocket parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: unix socket to forward to in: query name: socket required: false schema: description: unix socket to forward to type: string - description: ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command in: query name: ticket required: false schema: description: ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: port: type: string socket: type: string type: object description: OK summary: Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration. /nodes/{node}/qemu/{vmid}/pending: get: operationId: get_nodes_node_qemu_vmid_pending parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: delete: description: Indicates a pending delete request if present and not 0. The value 2 indicates a force-delete request. type: integer key: description: Configuration option name. type: string pending: description: Pending value. type: string value: description: Current value. type: string type: object type: array description: OK summary: Get the virtual machine configuration with both current and pending values. /nodes/{node}/qemu/{vmid}/remote_migrate: post: operationId: post_nodes_node_qemu_vmid_remote_migrate parameters: - description: Override I/O bandwidth limit (in KiB/s). in: query name: bwlimit required: false schema: description: Override I/O bandwidth limit (in KiB/s). type: integer - description: Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state. in: query name: delete required: false schema: description: Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Use online/live migration if VM is running. Ignored if VM is stopped. in: query name: online required: false schema: description: Use online/live migration if VM is running. Ignored if VM is stopped. type: boolean - description: Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. in: query name: target-bridge required: false schema: description: Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. format: bridge-pair-list type: string - description: Remote target endpoint in: query name: target-endpoint required: false schema: description: Remote target endpoint format: proxmox-remote type: string - description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. in: query name: target-storage required: true schema: description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. format: storage-pair-list type: string - description: The (unique) ID of the VM. in: query name: target-vmid required: false schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: bwlimit: description: Override I/O bandwidth limit (in KiB/s). type: integer delete: description: Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state. type: boolean node: description: The cluster node name. format: pve-node type: string online: description: Use online/live migration if VM is running. Ignored if VM is stopped. type: boolean target-bridge: description: Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. format: bridge-pair-list type: string target-endpoint: description: Remote target endpoint format: proxmox-remote type: string target-storage: description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. format: storage-pair-list type: string target-vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer required: - target-storage type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Migrate virtual machine to a remote cluster. Creates a new migration task. EXPERIMENTAL feature! /nodes/{node}/qemu/{vmid}/resize: put: operationId: put_nodes_node_qemu_vmid_resize parameters: - description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string - description: The disk you want to resize. in: query name: disk required: false schema: description: The disk you want to resize. enum: - ide0 - ide1 - ide2 - ide3 - scsi0 - scsi1 - scsi2 - scsi3 - scsi4 - scsi5 - scsi6 - scsi7 - scsi8 - scsi9 - scsi10 - scsi11 - scsi12 - scsi13 - scsi14 - scsi15 - scsi16 - scsi17 - scsi18 - scsi19 - scsi20 - scsi21 - scsi22 - scsi23 - scsi24 - scsi25 - scsi26 - scsi27 - scsi28 - scsi29 - scsi30 - virtio0 - virtio1 - virtio2 - virtio3 - virtio4 - virtio5 - virtio6 - virtio7 - virtio8 - virtio9 - virtio10 - virtio11 - virtio12 - virtio13 - virtio14 - virtio15 - sata0 - sata1 - sata2 - sata3 - sata4 - sata5 - efidisk0 - tpmstate0 type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. in: query name: size required: false schema: description: The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. type: string - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: digest: description: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. type: string disk: description: The disk you want to resize. enum: - ide0 - ide1 - ide2 - ide3 - scsi0 - scsi1 - scsi2 - scsi3 - scsi4 - scsi5 - scsi6 - scsi7 - scsi8 - scsi9 - scsi10 - scsi11 - scsi12 - scsi13 - scsi14 - scsi15 - scsi16 - scsi17 - scsi18 - scsi19 - scsi20 - scsi21 - scsi22 - scsi23 - scsi24 - scsi25 - scsi26 - scsi27 - scsi28 - scsi29 - scsi30 - virtio0 - virtio1 - virtio2 - virtio3 - virtio4 - virtio5 - virtio6 - virtio7 - virtio8 - virtio9 - virtio10 - virtio11 - virtio12 - virtio13 - virtio14 - virtio15 - sata0 - sata1 - sata2 - sata3 - sata4 - sata5 - efidisk0 - tpmstate0 type: string node: description: The cluster node name. format: pve-node type: string size: description: The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. type: string skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Extend volume size. /nodes/{node}/qemu/{vmid}/rrd: get: operationId: get_nodes_node_qemu_vmid_rrd parameters: - description: The RRD consolidation function in: query name: cf required: false schema: description: The RRD consolidation function enum: - AVERAGE - MAX type: string - description: The list of datasources you want to display. in: query name: ds required: false schema: description: The list of datasources you want to display. format: pve-configid-list type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Specify the time frame you are interested in. in: query name: timeframe required: false schema: description: Specify the time frame you are interested in. enum: - hour - day - week - month - year type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: filename: type: string type: object description: OK summary: Read VM RRD statistics (returns PNG) /nodes/{node}/qemu/{vmid}/rrddata: get: operationId: get_nodes_node_qemu_vmid_rrddata parameters: - description: The RRD consolidation function in: query name: cf required: false schema: description: The RRD consolidation function enum: - AVERAGE - MAX type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Specify the time frame you are interested in. in: query name: timeframe required: false schema: description: Specify the time frame you are interested in. enum: - hour - day - week - month - year type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Read VM RRD statistics /nodes/{node}/qemu/{vmid}/sendkey: put: operationId: put_nodes_node_qemu_vmid_sendkey parameters: - description: The key (qemu monitor encoding). in: query name: key required: false schema: description: The key (qemu monitor encoding). type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: key: description: The key (qemu monitor encoding). type: string node: description: The cluster node name. format: pve-node type: string skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Send key event to virtual machine. /nodes/{node}/qemu/{vmid}/snapshot: get: operationId: get_nodes_node_qemu_vmid_snapshot parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: description: description: Snapshot description. type: string name: description: Snapshot identifier. Value 'current' identifies the current VM. type: string parent: description: Parent snapshot identifier. type: string snaptime: description: Snapshot creation time type: integer vmstate: description: Snapshot includes RAM. type: boolean type: object type: array description: OK summary: List all snapshots. post: operationId: post_nodes_node_qemu_vmid_snapshot parameters: - description: A textual description or comment. in: query name: description required: false schema: description: A textual description or comment. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: query name: snapname required: false schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Save the vmstate in: query name: vmstate required: false schema: description: Save the vmstate type: boolean requestBody: content: application/json: schema: properties: description: description: A textual description or comment. type: string node: description: The cluster node name. format: pve-node type: string snapname: description: The name of the snapshot. format: pve-configid type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer vmstate: description: Save the vmstate type: boolean type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Snapshot a VM. /nodes/{node}/qemu/{vmid}/snapshot/{snapname}: delete: operationId: delete_nodes_node_qemu_vmid_snapshot_snapname parameters: - description: For removal from config file, even if removing disk snapshots fails. in: query name: force required: false schema: description: For removal from config file, even if removing disk snapshots fails. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: path name: snapname required: true schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Delete a VM snapshot. get: operationId: get_nodes_node_qemu_vmid_snapshot_snapname parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: path name: snapname required: true schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: "" /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config: get: operationId: get_nodes_node_qemu_vmid_snapshot_snapname_config parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: path name: snapname required: true schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: type: object description: OK summary: Get snapshot configuration put: operationId: put_nodes_node_qemu_vmid_snapshot_snapname_config parameters: - description: A textual description or comment. in: query name: description required: false schema: description: A textual description or comment. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: path name: snapname required: true schema: description: The name of the snapshot. format: pve-configid type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: description: description: A textual description or comment. type: string node: description: The cluster node name. format: pve-node type: string snapname: description: The name of the snapshot. format: pve-configid type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update snapshot metadata. /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback: post: operationId: post_nodes_node_qemu_vmid_snapshot_snapname_rollback parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The name of the snapshot. in: path name: snapname required: true schema: description: The name of the snapshot. format: pve-configid type: string - description: 'Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.)' in: query name: start required: false schema: description: 'Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.)' type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string snapname: description: The name of the snapshot. format: pve-configid type: string start: description: 'Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.)' type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Rollback VM state to specified snapshot. /nodes/{node}/qemu/{vmid}/spiceproxy: post: operationId: post_nodes_node_qemu_vmid_spiceproxy parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). in: query name: proxy required: false schema: description: SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). format: address type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string proxy: description: SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). format: address type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Returned values can be directly passed to the 'remote-viewer' application. properties: host: type: string password: type: string proxy: type: string tls-port: type: integer type: type: string type: object description: OK summary: Returns a SPICE configuration to connect to the VM. /nodes/{node}/qemu/{vmid}/status: get: operationId: get_nodes_node_qemu_vmid_status parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: Directory index /nodes/{node}/qemu/{vmid}/status/current: get: operationId: get_nodes_node_qemu_vmid_status_current parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: properties: agent: description: QEMU Guest Agent is enabled in config. type: boolean clipboard: description: Enable a specific clipboard. If not set, depending on the display type the SPICE one will be added. enum: - vnc type: string cpu: description: Current CPU usage. type: number cpus: description: Maximum usable CPUs. type: number diskread: description: 'The amount of bytes the guest read from it''s block devices since the guest was started. (Note: This info is not available for all storage types.)' type: integer diskwrite: description: 'The amount of bytes the guest wrote from it''s block devices since the guest was started. (Note: This info is not available for all storage types.)' type: integer ha: description: HA manager service status. type: object lock: description: The current config lock, if any. type: string maxdisk: description: Root disk size in bytes. type: integer maxmem: description: Maximum memory in bytes. type: integer mem: description: Currently used memory in bytes. Does not take into account kernel same-page merging (KSM). Uses information from ballooning when available. type: integer memhost: description: Current memory usage on the host. Does not take into account kernel same-page merging (KSM). type: integer name: description: VM (host)name. type: string netin: description: The amount of traffic in bytes that was sent to the guest over the network since it was started. type: integer netout: description: The amount of traffic in bytes that was sent from the guest over the network since it was started. type: integer pid: description: PID of the QEMU process, if the VM is running. type: integer pressurecpufull: description: CPU Full pressure stall average over the last 10 seconds. type: number pressurecpusome: description: CPU Some pressure stall average over the last 10 seconds. type: number pressureiofull: description: IO Full pressure stall average over the last 10 seconds. type: number pressureiosome: description: IO Some pressure stall average over the last 10 seconds. type: number pressurememoryfull: description: Memory Full pressure stall average over the last 10 seconds. type: number pressurememorysome: description: Memory Some pressure stall average over the last 10 seconds. type: number qmpstatus: description: VM run state from the 'query-status' QMP monitor command. type: string running-machine: description: The currently running machine type (if running). type: string running-qemu: description: The QEMU version the VM is currently using (if running). type: string serial: description: Guest has serial device configured. type: boolean spice: description: QEMU VGA configuration supports spice. type: boolean status: description: QEMU process status. enum: - stopped - running type: string tags: description: The current configured tags, if any type: string template: description: Determines if the guest is a template. type: boolean uptime: description: Uptime in seconds. type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object description: OK summary: Get virtual machine status. /nodes/{node}/qemu/{vmid}/status/reboot: post: operationId: post_nodes_node_qemu_vmid_status_reboot parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Wait maximal timeout seconds for the shutdown. in: query name: timeout required: false schema: description: Wait maximal timeout seconds for the shutdown. type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string timeout: description: Wait maximal timeout seconds for the shutdown. type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Reboot the VM by shutting it down, and starting it again. Applies pending changes. /nodes/{node}/qemu/{vmid}/status/reset: post: operationId: post_nodes_node_qemu_vmid_status_reset parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Reset virtual machine. /nodes/{node}/qemu/{vmid}/status/resume: post: operationId: post_nodes_node_qemu_vmid_status_resume parameters: - description: "" in: query name: nocheck required: false schema: type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: nocheck: type: boolean node: description: The cluster node name. format: pve-node type: string skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Resume virtual machine. /nodes/{node}/qemu/{vmid}/status/shutdown: post: operationId: post_nodes_node_qemu_vmid_status_shutdown parameters: - description: Make sure the VM stops. in: query name: forceStop required: false schema: description: Make sure the VM stops. type: boolean - description: Do not deactivate storage volumes. in: query name: keepActive required: false schema: description: Do not deactivate storage volumes. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: Wait maximal timeout seconds. in: query name: timeout required: false schema: description: Wait maximal timeout seconds. type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: forceStop: description: Make sure the VM stops. type: boolean keepActive: description: Do not deactivate storage volumes. type: boolean node: description: The cluster node name. format: pve-node type: string skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean timeout: description: Wait maximal timeout seconds. type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Shutdown virtual machine. This is similar to pressing the power button on a physical machine. This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown. /nodes/{node}/qemu/{vmid}/status/start: post: operationId: post_nodes_node_qemu_vmid_status_start parameters: - description: Override QEMU's -cpu argument with the given string. in: query name: force-cpu required: false schema: description: Override QEMU's -cpu argument with the given string. type: string - description: Specify the QEMU machine. in: query name: machine required: false schema: description: Specify the QEMU machine. type: string - description: The cluster node name. in: query name: migratedfrom required: false schema: description: The cluster node name. format: pve-node type: string - description: CIDR of the (sub) network that is used for migration. in: query name: migration_network required: false schema: description: CIDR of the (sub) network that is used for migration. format: CIDR type: string - description: Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. in: query name: migration_type required: false schema: description: Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. enum: - secure - insecure type: string - description: Used for migration compat. List of VirtIO network devices and their effective host_mtu setting according to the QEMU object model on the source side of the migration. A value of 0 means that the host_mtu parameter is to be avoided for the corresponding device. in: query name: nets-host-mtu required: false schema: description: Used for migration compat. List of VirtIO network devices and their effective host_mtu setting according to the QEMU object model on the source side of the migration. A value of 0 means that the host_mtu parameter is to be avoided for the corresponding device. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: Some command save/restore state from this location. in: query name: stateuri required: false schema: description: Some command save/restore state from this location. type: string - description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. in: query name: targetstorage required: false schema: description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. format: storage-pair-list type: string - description: Wait maximal timeout seconds. in: query name: timeout required: false schema: description: Wait maximal timeout seconds. type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Whether to migrate conntrack entries for running VMs. in: query name: with-conntrack-state required: false schema: description: Whether to migrate conntrack entries for running VMs. type: boolean requestBody: content: application/json: schema: properties: force-cpu: description: Override QEMU's -cpu argument with the given string. type: string machine: description: Specify the QEMU machine. type: string migratedfrom: description: The cluster node name. format: pve-node type: string migration_network: description: CIDR of the (sub) network that is used for migration. format: CIDR type: string migration_type: description: Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. enum: - secure - insecure type: string nets-host-mtu: description: Used for migration compat. List of VirtIO network devices and their effective host_mtu setting according to the QEMU object model on the source side of the migration. A value of 0 means that the host_mtu parameter is to be avoided for the corresponding device. type: string node: description: The cluster node name. format: pve-node type: string skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean stateuri: description: Some command save/restore state from this location. type: string targetstorage: description: Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. format: storage-pair-list type: string timeout: description: Wait maximal timeout seconds. type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer with-conntrack-state: description: Whether to migrate conntrack entries for running VMs. type: boolean type: object responses: "200": content: application/json: schema: type: string description: OK summary: Start virtual machine. /nodes/{node}/qemu/{vmid}/status/stop: post: operationId: post_nodes_node_qemu_vmid_status_stop parameters: - description: Do not deactivate storage volumes. in: query name: keepActive required: false schema: description: Do not deactivate storage volumes. type: boolean - description: The cluster node name. in: query name: migratedfrom required: false schema: description: The cluster node name. format: pve-node type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Try to abort active 'qmshutdown' tasks before stopping. in: query name: overrule-shutdown required: false schema: description: Try to abort active 'qmshutdown' tasks before stopping. type: boolean - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: Wait maximal timeout seconds. in: query name: timeout required: false schema: description: Wait maximal timeout seconds. type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: keepActive: description: Do not deactivate storage volumes. type: boolean migratedfrom: description: The cluster node name. format: pve-node type: string node: description: The cluster node name. format: pve-node type: string overrule-shutdown: description: Try to abort active 'qmshutdown' tasks before stopping. type: boolean skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean timeout: description: Wait maximal timeout seconds. type: integer vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Stop virtual machine. The qemu process will exit immediately. This is akin to pulling the power plug of a running computer and may damage the VM data. /nodes/{node}/qemu/{vmid}/status/suspend: post: operationId: post_nodes_node_qemu_vmid_status_suspend parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Ignore locks - only root is allowed to use this option. in: query name: skiplock required: false schema: description: Ignore locks - only root is allowed to use this option. type: boolean - description: The storage for the VM state in: query name: statestorage required: false schema: description: The storage for the VM state format: pve-storage-id type: string - description: If set, suspends the VM to disk. Will be resumed on next VM start. in: query name: todisk required: false schema: description: If set, suspends the VM to disk. Will be resumed on next VM start. type: boolean - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string skiplock: description: Ignore locks - only root is allowed to use this option. type: boolean statestorage: description: The storage for the VM state format: pve-storage-id type: string todisk: description: If set, suspends the VM to disk. Will be resumed on next VM start. type: boolean vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Suspend virtual machine. /nodes/{node}/qemu/{vmid}/template: post: operationId: post_nodes_node_qemu_vmid_template parameters: - description: If you want to convert only 1 disk to base image. in: query name: disk required: false schema: description: If you want to convert only 1 disk to base image. enum: - ide0 - ide1 - ide2 - ide3 - scsi0 - scsi1 - scsi2 - scsi3 - scsi4 - scsi5 - scsi6 - scsi7 - scsi8 - scsi9 - scsi10 - scsi11 - scsi12 - scsi13 - scsi14 - scsi15 - scsi16 - scsi17 - scsi18 - scsi19 - scsi20 - scsi21 - scsi22 - scsi23 - scsi24 - scsi25 - scsi26 - scsi27 - scsi28 - scsi29 - scsi30 - virtio0 - virtio1 - virtio2 - virtio3 - virtio4 - virtio5 - virtio6 - virtio7 - virtio8 - virtio9 - virtio10 - virtio11 - virtio12 - virtio13 - virtio14 - virtio15 - sata0 - sata1 - sata2 - sata3 - sata4 - sata5 - efidisk0 - tpmstate0 type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: disk: description: If you want to convert only 1 disk to base image. enum: - ide0 - ide1 - ide2 - ide3 - scsi0 - scsi1 - scsi2 - scsi3 - scsi4 - scsi5 - scsi6 - scsi7 - scsi8 - scsi9 - scsi10 - scsi11 - scsi12 - scsi13 - scsi14 - scsi15 - scsi16 - scsi17 - scsi18 - scsi19 - scsi20 - scsi21 - scsi22 - scsi23 - scsi24 - scsi25 - scsi26 - scsi27 - scsi28 - scsi29 - scsi30 - virtio0 - virtio1 - virtio2 - virtio3 - virtio4 - virtio5 - virtio6 - virtio7 - virtio8 - virtio9 - virtio10 - virtio11 - virtio12 - virtio13 - virtio14 - virtio15 - sata0 - sata1 - sata2 - sata3 - sata4 - sata5 - efidisk0 - tpmstate0 type: string node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: the task ID. type: string description: OK summary: Create a Template. /nodes/{node}/qemu/{vmid}/termproxy: post: operationId: post_nodes_node_qemu_vmid_termproxy parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: opens a serial terminal (defaults to display) in: query name: serial required: false schema: description: opens a serial terminal (defaults to display) enum: - serial0 - serial1 - serial2 - serial3 type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string serial: description: opens a serial terminal (defaults to display) enum: - serial0 - serial1 - serial2 - serial3 type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: properties: port: type: integer ticket: type: string upid: type: string user: type: string type: object description: OK summary: Creates a TCP proxy connections. /nodes/{node}/qemu/{vmid}/unlink: put: operationId: put_nodes_node_qemu_vmid_unlink parameters: - description: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. in: query name: force required: false schema: description: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. type: boolean - description: A list of disk IDs you want to delete. in: query name: idlist required: false schema: description: A list of disk IDs you want to delete. format: pve-configid-list type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer requestBody: content: application/json: schema: properties: force: description: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. type: boolean idlist: description: A list of disk IDs you want to delete. format: pve-configid-list type: string node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Unlink/delete disk images. /nodes/{node}/qemu/{vmid}/vncproxy: post: operationId: post_nodes_node_qemu_vmid_vncproxy parameters: - description: Deprecated, do not use. Password is generated when required. in: query name: generate-password required: false schema: description: Deprecated, do not use. Password is generated when required. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Prepare for websocket upgrade (only required when using serial terminal, otherwise upgrade is always possible). in: query name: websocket required: false schema: description: Prepare for websocket upgrade (only required when using serial terminal, otherwise upgrade is always possible). type: boolean requestBody: content: application/json: schema: properties: generate-password: description: Deprecated, do not use. Password is generated when required. type: boolean node: description: The cluster node name. format: pve-node type: string vmid: description: The (unique) ID of the VM. format: pve-vmid type: integer websocket: description: Prepare for websocket upgrade (only required when using serial terminal, otherwise upgrade is always possible). type: boolean type: object responses: "200": content: application/json: schema: properties: cert: type: string password: description: Password used for authentication within the VNC protocol. Consists of printable ASCII characters ('!' .. '~'). type: string port: type: integer ticket: type: string upid: type: string user: type: string type: object description: OK summary: Creates a TCP VNC proxy connections. /nodes/{node}/qemu/{vmid}/vncwebsocket: get: operationId: get_nodes_node_qemu_vmid_vncwebsocket parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Port number returned by previous vncproxy call. in: query name: port required: false schema: description: Port number returned by previous vncproxy call. type: integer - description: The (unique) ID of the VM. in: path name: vmid required: true schema: description: The (unique) ID of the VM. format: pve-vmid type: integer - description: Ticket from previous call to vncproxy. in: query name: vncticket required: false schema: description: Ticket from previous call to vncproxy. type: string responses: "200": content: application/json: schema: properties: port: type: string type: object description: OK summary: Opens a websocket for VNC traffic. /nodes/{node}/query-oci-repo-tags: get: operationId: get_nodes_node_query_oci_repo_tags parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The reference to the repository to query tags from. in: query name: reference required: false schema: description: The reference to the repository to query tags from. type: string responses: "200": content: application/json: schema: items: type: string type: array description: OK summary: List all tags for an OCI repository reference. /nodes/{node}/query-url-metadata: get: operationId: get_nodes_node_query_url_metadata parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The URL to query the metadata from. in: query name: url required: false schema: description: The URL to query the metadata from. type: string - description: If false, no SSL/TLS certificates will be verified. in: query name: verify-certificates required: false schema: description: If false, no SSL/TLS certificates will be verified. type: boolean responses: "200": content: application/json: schema: properties: filename: type: string mimetype: type: string size: type: integer type: object description: OK summary: 'Query metadata of an URL: file size, file name and mime type.' /nodes/{node}/replication: get: operationId: get_nodes_node_replication parameters: - description: Only list replication jobs for this guest. in: query name: guest required: false schema: description: Only list replication jobs for this guest. format: pve-vmid type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: id: type: string type: object type: array description: OK summary: List status of all replication jobs on this node. /nodes/{node}/replication/{id}: get: operationId: get_nodes_node_replication_id parameters: - description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. in: path name: id required: true schema: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Directory index. /nodes/{node}/replication/{id}/log: get: operationId: get_nodes_node_replication_id_log parameters: - description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. in: path name: id required: true schema: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string - description: "" in: query name: limit required: false schema: type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: "" in: query name: start required: false schema: type: integer responses: "200": content: application/json: schema: items: properties: "n": description: Line number type: integer t: description: Line text type: string type: object type: array description: OK summary: Read replication job log. /nodes/{node}/replication/{id}/schedule_now: post: operationId: post_nodes_node_replication_id_schedule_now parameters: - description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. in: path name: id required: true schema: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: id: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Schedule replication job to start as soon as possible. /nodes/{node}/replication/{id}/status: get: operationId: get_nodes_node_replication_id_status parameters: - description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. in: path name: id required: true schema: description: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. format: pve-replication-job-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: object description: OK summary: Get replication job status. /nodes/{node}/report: get: operationId: get_nodes_node_report parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: type: string description: OK summary: Gather various systems information about a node /nodes/{node}/rrd: get: operationId: get_nodes_node_rrd parameters: - description: The RRD consolidation function in: query name: cf required: false schema: description: The RRD consolidation function enum: - AVERAGE - MAX type: string - description: The list of datasources you want to display. in: query name: ds required: false schema: description: The list of datasources you want to display. format: pve-configid-list type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Specify the time frame you are interested in. in: query name: timeframe required: false schema: description: Specify the time frame you are interested in. enum: - hour - day - week - month - year - decade type: string responses: "200": content: application/json: schema: properties: filename: type: string type: object description: OK summary: Read node RRD statistics (returns PNG) /nodes/{node}/rrddata: get: operationId: get_nodes_node_rrddata parameters: - description: The RRD consolidation function in: query name: cf required: false schema: description: The RRD consolidation function enum: - AVERAGE - MAX type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Specify the time frame you are interested in. in: query name: timeframe required: false schema: description: Specify the time frame you are interested in. enum: - hour - day - week - month - year - decade type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Read node RRD statistics /nodes/{node}/scan: get: operationId: get_nodes_node_scan parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: method: type: string type: object type: array description: OK summary: Index of available scan methods /nodes/{node}/scan/cifs: get: operationId: get_nodes_node_scan_cifs parameters: - description: SMB domain (Workgroup). in: query name: domain required: false schema: description: SMB domain (Workgroup). type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: User password. in: query name: password required: false schema: description: User password. type: string - description: The server address (name or IP). in: query name: server required: false schema: description: The server address (name or IP). format: pve-storage-server type: string - description: User name. in: query name: username required: false schema: description: User name. type: string responses: "200": content: application/json: schema: items: properties: description: description: Descriptive text from server. type: string share: description: The cifs share name. type: string type: object type: array description: OK summary: Scan remote CIFS server. /nodes/{node}/scan/iscsi: get: operationId: get_nodes_node_scan_iscsi parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The iSCSI portal (IP or DNS name with optional port). in: query name: portal required: false schema: description: The iSCSI portal (IP or DNS name with optional port). format: pve-storage-portal-dns type: string responses: "200": content: application/json: schema: items: properties: portal: description: The iSCSI portal name. type: string target: description: The iSCSI target name. type: string type: object type: array description: OK summary: Scan remote iSCSI server. /nodes/{node}/scan/lvm: get: operationId: get_nodes_node_scan_lvm parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: vg: description: The LVM logical volume group name. type: string type: object type: array description: OK summary: List local LVM volume groups. /nodes/{node}/scan/lvmthin: get: operationId: get_nodes_node_scan_lvmthin parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: "" in: query name: vg required: false schema: type: string responses: "200": content: application/json: schema: items: properties: lv: description: The LVM Thin Pool name (LVM logical volume). type: string type: object type: array description: OK summary: List local LVM Thin Pools. /nodes/{node}/scan/nfs: get: operationId: get_nodes_node_scan_nfs parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The server address (name or IP). in: query name: server required: false schema: description: The server address (name or IP). format: pve-storage-server type: string responses: "200": content: application/json: schema: items: properties: options: description: NFS export options. type: string path: description: The exported path. type: string type: object type: array description: OK summary: Scan remote NFS server. /nodes/{node}/scan/pbs: get: operationId: get_nodes_node_scan_pbs parameters: - description: Certificate SHA 256 fingerprint. in: query name: fingerprint required: false schema: description: Certificate SHA 256 fingerprint. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: User password or API token secret. in: query name: password required: false schema: description: User password or API token secret. type: string - description: Optional port. in: query name: port required: false schema: description: Optional port. type: integer - description: The server address (name or IP). in: query name: server required: false schema: description: The server address (name or IP). format: pve-storage-server type: string - description: User-name or API token-ID. in: query name: username required: false schema: description: User-name or API token-ID. type: string responses: "200": content: application/json: schema: items: properties: comment: description: Comment from server. type: string store: description: The datastore name. type: string type: object type: array description: OK summary: Scan remote Proxmox Backup Server. /nodes/{node}/scan/zfs: get: operationId: get_nodes_node_scan_zfs parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: pool: description: ZFS pool name. type: string type: object type: array description: OK summary: Scan zfs pool list on local node. /nodes/{node}/sdn: get: operationId: get_nodes_node_sdn parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: SDN index. /nodes/{node}/sdn/fabrics/{fabric}: get: operationId: get_nodes_node_sdn_fabrics_fabric parameters: - description: Identifier for SDN fabrics in: path name: fabric required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: Directory index for SDN fabric status. /nodes/{node}/sdn/fabrics/{fabric}/interfaces: get: operationId: get_nodes_node_sdn_fabrics_fabric_interfaces parameters: - description: Identifier for SDN fabrics in: path name: fabric required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: name: description: The name of the network interface. type: string state: description: The current state of the interface. type: string type: description: The type of this interface in the fabric (e.g. Point-to-Point, Broadcast, ..). type: string type: object type: array description: OK summary: Get all interfaces for a fabric. /nodes/{node}/sdn/fabrics/{fabric}/neighbors: get: operationId: get_nodes_node_sdn_fabrics_fabric_neighbors parameters: - description: Identifier for SDN fabrics in: path name: fabric required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: neighbor: description: The IP or hostname of the neighbor. type: string status: description: The status of the neighbor, as returned by FRR. type: string uptime: description: The uptime of this neighbor, as returned by FRR (e.g. 8h24m12s). type: string type: object type: array description: OK summary: Get all neighbors for a fabric. /nodes/{node}/sdn/fabrics/{fabric}/routes: get: operationId: get_nodes_node_sdn_fabrics_fabric_routes parameters: - description: Identifier for SDN fabrics in: path name: fabric required: true schema: description: Identifier for SDN fabrics format: pve-sdn-fabric-id type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: route: description: The CIDR block for this routing table entry. type: string via: description: A list of nexthops for that route. items: description: The IP address of the nexthop. type: string type: array type: object type: array description: OK summary: Get all routes for a fabric. /nodes/{node}/sdn/vnets/{vnet}: get: operationId: get_nodes_node_sdn_vnets_vnet parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: "" /nodes/{node}/sdn/vnets/{vnet}/mac-vrf: get: operationId: get_nodes_node_sdn_vnets_vnet_mac_vrf parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The SDN vnet object identifier. in: path name: vnet required: true schema: description: The SDN vnet object identifier. type: string responses: "200": content: application/json: schema: description: All routes from the MAC VRF that this node self-originates or has learned via BGP. items: properties: ip: description: The IP address of the MAC VRF entry. format: ip type: string mac: description: The MAC address of the MAC VRF entry. format: mac-addr type: string nexthop: description: The IP address of the nexthop. format: ip type: string type: object type: array description: OK summary: Get the MAC VRF for a VNet in an EVPN zone. /nodes/{node}/sdn/zones: get: operationId: get_nodes_node_sdn_zones parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: status: description: Status of zone enum: - available - pending - error type: string zone: description: The SDN zone object identifier. type: string type: object type: array description: OK summary: Get status for all zones. /nodes/{node}/sdn/zones/{zone}: get: operationId: get_nodes_node_sdn_zones_zone parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The SDN zone object identifier. in: path name: zone required: true schema: description: The SDN zone object identifier. type: string responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: Directory index for SDN zone status. /nodes/{node}/sdn/zones/{zone}/bridges: get: operationId: get_nodes_node_sdn_zones_zone_bridges parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: zone name or "localnetwork" in: path name: zone required: true schema: description: zone name or "localnetwork" type: string responses: "200": content: application/json: schema: items: description: List of bridges contained in the SDN zone. properties: name: description: Name of the bridge. type: string ports: description: All ports that are members of the bridge items: description: Information about bridge ports. properties: index: description: The index of the guests network device that this interface belongs to. type: string name: description: The name of the bridge port. type: string primary_vlan: description: The primary VLAN configured for the port of this bridge (= PVID). Only for VLAN-aware bridges. type: number vlans: description: A list of VLANs and VLAN ranges that are allowed for this bridge port in addition to the primary VLAN. Only for VLAN-aware bridges. items: description: A single VLAN (123) or a VLAN range (234-435). type: string type: array vmid: description: The ID of the guest that this interface belongs to. type: number type: object type: array vlan_filtering: description: Whether VLAN filtering is enabled for this bridge (= VLAN-aware). type: string type: object type: array description: OK summary: Get a list of all bridges (vnets) that are part of a zone, as well as the ports that are members of that bridge. /nodes/{node}/sdn/zones/{zone}/content: get: operationId: get_nodes_node_sdn_zones_zone_content parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The SDN zone object identifier. in: path name: zone required: true schema: description: The SDN zone object identifier. type: string responses: "200": content: application/json: schema: items: properties: status: description: Status. type: string statusmsg: description: Status details type: string vnet: description: Vnet identifier. type: string type: object type: array description: OK summary: List zone content. /nodes/{node}/sdn/zones/{zone}/ip-vrf: get: operationId: get_nodes_node_sdn_zones_zone_ip_vrf parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Name of an EVPN zone. in: path name: zone required: true schema: description: Name of an EVPN zone. type: string responses: "200": content: application/json: schema: description: All entries in the VRF table of zone {zone} of the node.This does not include /32 routes for guests on this host,since they are handled via the respective vnet bridge directly. items: properties: ip: description: The CIDR of the route table entry. format: CIDR type: string metric: description: This route's metric. type: integer nexthops: description: A list of nexthops for the route table entry. items: description: the interface name or ip address of the next hop type: string type: array protocol: description: The protocol where this route was learned from (e.g. BGP). type: string type: object type: array description: OK summary: Get the IP VRF of an EVPN zone. /nodes/{node}/services: get: operationId: get_nodes_node_services parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: active-state: description: Current state of the service process (systemd ActiveState). enum: - active - inactive - failed - activating - deactivating - maintenance - reloading - refreshing - unknown type: string desc: description: Description of the service. type: string name: description: Short identifier for the service (e.g., "pveproxy"). type: string service: description: Systemd unit name (e.g., pveproxy). type: string state: description: Execution status of the service (systemd SubState). enum: - dead - condition - start-pre - start - start-post - running - exited - reload - reload-signal - reload-notify - mounting - stop - stop-watchdog - stop-sigterm - stop-sigkill - stop-post - final-watchdog - final-sigterm - final-sigkill - failed - dead-before-auto-restart - failed-before-auto-restart - dead-resources-pinned - auto-restart - auto-restart-queued - cleaning - unknown type: string unit-state: description: Whether the service is enabled (systemd UnitFileState). enum: - enabled - enabled-runtime - linked - linked-runtime - alias - masked - masked-runtime - static - disabled - indirect - generated - transient - bad - not-found - unknown type: string type: object type: array description: OK summary: Service list. /nodes/{node}/services/{service}: get: operationId: get_nodes_node_services_service parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Service ID in: path name: service required: true schema: description: Service ID enum: - chrony - corosync - cron - ksmtuned - lxcfs - postfix - proxmox-firewall - pve-cluster - pve-firewall - pve-ha-crm - pve-ha-lrm - pve-lxc-syscalld - pvedaemon - pvefw-logger - pveproxy - pvescheduler - pvestatd - qmeventd - spiceproxy - sshd - syslog - systemd-journald - systemd-timesyncd type: string responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: Directory index /nodes/{node}/services/{service}/reload: post: operationId: post_nodes_node_services_service_reload parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Service ID in: path name: service required: true schema: description: Service ID enum: - chrony - corosync - cron - ksmtuned - lxcfs - postfix - proxmox-firewall - pve-cluster - pve-firewall - pve-ha-crm - pve-ha-lrm - pve-lxc-syscalld - pvedaemon - pvefw-logger - pveproxy - pvescheduler - pvestatd - qmeventd - spiceproxy - sshd - syslog - systemd-journald - systemd-timesyncd type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string service: description: Service ID enum: - chrony - corosync - cron - ksmtuned - lxcfs - postfix - proxmox-firewall - pve-cluster - pve-firewall - pve-ha-crm - pve-ha-lrm - pve-lxc-syscalld - pvedaemon - pvefw-logger - pveproxy - pvescheduler - pvestatd - qmeventd - spiceproxy - sshd - syslog - systemd-journald - systemd-timesyncd type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Reload service. Falls back to restart if service cannot be reloaded. /nodes/{node}/services/{service}/restart: post: operationId: post_nodes_node_services_service_restart parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Service ID in: path name: service required: true schema: description: Service ID enum: - chrony - corosync - cron - ksmtuned - lxcfs - postfix - proxmox-firewall - pve-cluster - pve-firewall - pve-ha-crm - pve-ha-lrm - pve-lxc-syscalld - pvedaemon - pvefw-logger - pveproxy - pvescheduler - pvestatd - qmeventd - spiceproxy - sshd - syslog - systemd-journald - systemd-timesyncd type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string service: description: Service ID enum: - chrony - corosync - cron - ksmtuned - lxcfs - postfix - proxmox-firewall - pve-cluster - pve-firewall - pve-ha-crm - pve-ha-lrm - pve-lxc-syscalld - pvedaemon - pvefw-logger - pveproxy - pvescheduler - pvestatd - qmeventd - spiceproxy - sshd - syslog - systemd-journald - systemd-timesyncd type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Hard restart service. Use reload if you want to reduce interruptions. /nodes/{node}/services/{service}/start: post: operationId: post_nodes_node_services_service_start parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Service ID in: path name: service required: true schema: description: Service ID enum: - chrony - corosync - cron - ksmtuned - lxcfs - postfix - proxmox-firewall - pve-cluster - pve-firewall - pve-ha-crm - pve-ha-lrm - pve-lxc-syscalld - pvedaemon - pvefw-logger - pveproxy - pvescheduler - pvestatd - qmeventd - spiceproxy - sshd - syslog - systemd-journald - systemd-timesyncd type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string service: description: Service ID enum: - chrony - corosync - cron - ksmtuned - lxcfs - postfix - proxmox-firewall - pve-cluster - pve-firewall - pve-ha-crm - pve-ha-lrm - pve-lxc-syscalld - pvedaemon - pvefw-logger - pveproxy - pvescheduler - pvestatd - qmeventd - spiceproxy - sshd - syslog - systemd-journald - systemd-timesyncd type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Start service. /nodes/{node}/services/{service}/state: get: operationId: get_nodes_node_services_service_state parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Service ID in: path name: service required: true schema: description: Service ID enum: - chrony - corosync - cron - ksmtuned - lxcfs - postfix - proxmox-firewall - pve-cluster - pve-firewall - pve-ha-crm - pve-ha-lrm - pve-lxc-syscalld - pvedaemon - pvefw-logger - pveproxy - pvescheduler - pvestatd - qmeventd - spiceproxy - sshd - syslog - systemd-journald - systemd-timesyncd type: string responses: "200": content: application/json: schema: properties: active-state: description: Current state of the service process (systemd ActiveState). enum: - active - inactive - failed - activating - deactivating - maintenance - reloading - refreshing - unknown type: string desc: description: Description of the service. type: string name: description: Short identifier for the service (e.g., "pveproxy"). type: string service: description: Systemd unit name (e.g., pveproxy). type: string state: description: Execution status of the service (systemd SubState). enum: - dead - condition - start-pre - start - start-post - running - exited - reload - reload-signal - reload-notify - mounting - stop - stop-watchdog - stop-sigterm - stop-sigkill - stop-post - final-watchdog - final-sigterm - final-sigkill - failed - dead-before-auto-restart - failed-before-auto-restart - dead-resources-pinned - auto-restart - auto-restart-queued - cleaning - unknown type: string unit-state: description: Whether the service is enabled (systemd UnitFileState). enum: - enabled - enabled-runtime - linked - linked-runtime - alias - masked - masked-runtime - static - disabled - indirect - generated - transient - bad - not-found - unknown type: string type: object description: OK summary: Read service properties /nodes/{node}/services/{service}/stop: post: operationId: post_nodes_node_services_service_stop parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Service ID in: path name: service required: true schema: description: Service ID enum: - chrony - corosync - cron - ksmtuned - lxcfs - postfix - proxmox-firewall - pve-cluster - pve-firewall - pve-ha-crm - pve-ha-lrm - pve-lxc-syscalld - pvedaemon - pvefw-logger - pveproxy - pvescheduler - pvestatd - qmeventd - spiceproxy - sshd - syslog - systemd-journald - systemd-timesyncd type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string service: description: Service ID enum: - chrony - corosync - cron - ksmtuned - lxcfs - postfix - proxmox-firewall - pve-cluster - pve-firewall - pve-ha-crm - pve-ha-lrm - pve-lxc-syscalld - pvedaemon - pvefw-logger - pveproxy - pvescheduler - pvestatd - qmeventd - spiceproxy - sshd - syslog - systemd-journald - systemd-timesyncd type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Stop service. /nodes/{node}/spiceshell: post: operationId: post_nodes_node_spiceshell parameters: - description: Run specific command or default to login (requires 'root@pam') in: query name: cmd required: false schema: description: Run specific command or default to login (requires 'root@pam') enum: - ceph_install - login - upgrade type: string - description: Add parameters to a command. Encoded as null terminated strings. in: query name: cmd-opts required: false schema: description: Add parameters to a command. Encoded as null terminated strings. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). in: query name: proxy required: false schema: description: SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). format: address type: string requestBody: content: application/json: schema: properties: cmd: description: Run specific command or default to login (requires 'root@pam') enum: - ceph_install - login - upgrade type: string cmd-opts: description: Add parameters to a command. Encoded as null terminated strings. type: string node: description: The cluster node name. format: pve-node type: string proxy: description: SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). format: address type: string type: object responses: "200": content: application/json: schema: description: Returned values can be directly passed to the 'remote-viewer' application. properties: host: type: string password: type: string proxy: type: string tls-port: type: integer type: type: string type: object description: OK summary: Creates a SPICE shell. /nodes/{node}/startall: post: operationId: post_nodes_node_startall parameters: - description: Issue start command even if virtual guest have 'onboot' not set or set to off. in: query name: force required: false schema: description: Issue start command even if virtual guest have 'onboot' not set or set to off. type: boolean - description: Defines the maximum number of tasks running concurrently. If not set, uses 'max_workers' from datacenter.cfg, and if that's not set, the available CPU threads, clamped to a maximum of 8, are used. in: query name: max-workers required: false schema: description: Defines the maximum number of tasks running concurrently. If not set, uses 'max_workers' from datacenter.cfg, and if that's not set, the available CPU threads, clamped to a maximum of 8, are used. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Only consider guests from this comma separated list of VMIDs. in: query name: vms required: false schema: description: Only consider guests from this comma separated list of VMIDs. format: pve-vmid-list type: string requestBody: content: application/json: schema: properties: force: description: Issue start command even if virtual guest have 'onboot' not set or set to off. type: boolean max-workers: description: Defines the maximum number of tasks running concurrently. If not set, uses 'max_workers' from datacenter.cfg, and if that's not set, the available CPU threads, clamped to a maximum of 8, are used. type: integer node: description: The cluster node name. format: pve-node type: string vms: description: Only consider guests from this comma separated list of VMIDs. format: pve-vmid-list type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Start all VMs and containers located on this node (by default only those with onboot=1). /nodes/{node}/status: get: operationId: get_nodes_node_status parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: boot-info: description: Meta-information about the boot mode. properties: mode: description: Through which firmware the system got booted. enum: - efi - legacy-bios type: string secureboot: description: System is booted in secure mode, only applicable for the "efi" mode. type: boolean type: object cpu: description: The current cpu usage. type: number cpuinfo: properties: cores: description: The number of physical cores of the CPU. type: integer cpus: description: The number of logical threads of the CPU. type: integer model: description: The CPU model type: string sockets: description: The number of logical threads of the CPU. type: integer type: object current-kernel: description: Meta-information about the currently booted kernel of this node. properties: machine: description: Hardware (architecture) type type: string release: description: OS kernel release (e.g., "6.8.0") type: string sysname: description: OS kernel name (e.g., "Linux") type: string version: description: OS kernel version with build info type: string type: object loadavg: description: An array of load avg for 1, 5 and 15 minutes respectively. items: description: The value of the load. type: string type: array memory: properties: available: description: The available memory in bytes. type: integer free: description: The free memory in bytes. type: integer total: description: The total memory in bytes. type: integer used: description: The used memory in bytes. type: integer type: object pveversion: description: The PVE version string. type: string rootfs: properties: avail: description: The available bytes in the root filesystem. type: integer free: description: The free bytes on the root filesystem. type: integer total: description: The total size of the root filesystem in bytes. type: integer used: description: The used bytes in the root filesystem. type: integer type: object type: object description: OK summary: Read node status post: operationId: post_nodes_node_status parameters: - description: Specify the command. in: query name: command required: false schema: description: Specify the command. enum: - reboot - shutdown type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: command: description: Specify the command. enum: - reboot - shutdown type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Reboot or shutdown a node. /nodes/{node}/stopall: post: operationId: post_nodes_node_stopall parameters: - description: Force a hard-stop after the timeout. in: query name: force-stop required: false schema: description: Force a hard-stop after the timeout. type: boolean - description: Defines the maximum number of tasks running concurrently. If not set, uses 'max_workers' from datacenter.cfg, and if that's not set, the available CPU threads, clamped to a maximum of 8, are used. in: query name: max-workers required: false schema: description: Defines the maximum number of tasks running concurrently. If not set, uses 'max_workers' from datacenter.cfg, and if that's not set, the available CPU threads, clamped to a maximum of 8, are used. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced. in: query name: timeout required: false schema: description: Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced. type: integer - description: Only consider Guests with these IDs. in: query name: vms required: false schema: description: Only consider Guests with these IDs. format: pve-vmid-list type: string requestBody: content: application/json: schema: properties: force-stop: description: Force a hard-stop after the timeout. type: boolean max-workers: description: Defines the maximum number of tasks running concurrently. If not set, uses 'max_workers' from datacenter.cfg, and if that's not set, the available CPU threads, clamped to a maximum of 8, are used. type: integer node: description: The cluster node name. format: pve-node type: string timeout: description: Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced. type: integer vms: description: Only consider Guests with these IDs. format: pve-vmid-list type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Stop all VMs and Containers. /nodes/{node}/storage: get: operationId: get_nodes_node_storage parameters: - description: Only list stores which support this content type. in: query name: content required: false schema: description: Only list stores which support this content type. format: pve-storage-content-list type: string - description: Only list stores which are enabled (not disabled in config). in: query name: enabled required: false schema: description: Only list stores which are enabled (not disabled in config). type: boolean - description: Include information about formats in: query name: format required: false schema: description: Include information about formats type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Only list status for specified storage in: query name: storage required: false schema: description: Only list status for specified storage format: pve-storage-id type: string - description: If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. in: query name: target required: false schema: description: If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. format: pve-node type: string responses: "200": content: application/json: schema: items: properties: active: description: Set when storage is accessible. type: boolean avail: description: Available storage space in bytes. type: integer content: description: Allowed storage content types. format: pve-storage-content-list type: string enabled: description: Set when storage is enabled (not disabled). type: boolean formats: description: Lists the supported and default format. Use 'formats' instead. Only included if 'format' parameter is set. properties: default: description: The default format of the storage. enum: - qcow2 - raw - subvol - vmdk type: string supported: description: The list of supported formats items: enum: - qcow2 - raw - subvol - vmdk type: string type: array type: object select_existing: description: Instead of creating new volumes, one must select one that is already existing. Only included if 'format' parameter is set. type: boolean shared: description: Shared flag from storage configuration. type: boolean storage: description: The storage identifier. format: pve-storage-id type: string total: description: Total storage space in bytes. type: integer type: description: Storage type. type: string used: description: Used storage space in bytes. type: integer used_fraction: description: Used fraction (used/total). type: number type: object type: array description: OK summary: Get status for all datastores. /nodes/{node}/storage/{storage}: get: operationId: get_nodes_node_storage_storage parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string responses: "200": content: application/json: schema: items: properties: subdir: type: string type: object type: array description: OK summary: "" /nodes/{node}/storage/{storage}/content: get: operationId: get_nodes_node_storage_storage_content parameters: - description: Only list content of this type. in: query name: content required: false schema: description: Only list content of this type. format: pve-storage-content type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Only list images for this VM in: query name: vmid required: false schema: description: Only list images for this VM format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: approximate-size: description: Approximate volume size in bytes. Present instead of 'size' for storages where determining the exact size has technical limitations. Will typically be an upper bound on the actual size, but the exact semantics depend on the storage plugin. type: integer ctime: description: Creation time (seconds since the UNIX Epoch). type: integer encrypted: description: If whole backup is encrypted, value is the fingerprint or '1' if encrypted. Only useful for the Proxmox Backup Server storage type. type: string format: description: Format identifier ('raw', 'qcow2', 'subvol', 'iso', 'tgz' ...) type: string notes: description: Optional notes. If they contain multiple lines, only the first one is returned here. type: string parent: description: Volume identifier of parent (for linked cloned). type: string protected: description: Protection status. Currently only supported for backups. type: boolean size: description: Volume size in bytes. type: integer used: description: Used space. Please note that most storage plugins do not report anything useful here. type: integer verification: description: Last backup verification result, only useful for PBS storages. properties: state: description: Last backup verification state. type: string upid: description: Last backup verification UPID. type: string type: object vmid: description: Associated Owner VMID. type: integer volid: description: Volume identifier. type: string type: object type: array description: OK summary: List storage content. post: operationId: post_nodes_node_storage_storage_content parameters: - description: The name of the file to create. in: query name: filename required: false schema: description: The name of the file to create. type: string - description: Format of the image. in: query name: format required: false schema: description: Format of the image. enum: - raw - qcow2 - subvol - vmdk type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) in: query name: size required: false schema: description: Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Specify owner VM in: query name: vmid required: false schema: description: Specify owner VM format: pve-vmid type: integer requestBody: content: application/json: schema: properties: filename: description: The name of the file to create. type: string format: description: Format of the image. enum: - raw - qcow2 - subvol - vmdk type: string node: description: The cluster node name. format: pve-node type: string size: description: Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) type: string storage: description: The storage identifier. format: pve-storage-id type: string vmid: description: Specify owner VM format: pve-vmid type: integer type: object responses: "200": content: application/json: schema: description: Volume identifier type: string description: OK summary: Allocate disk images. /nodes/{node}/storage/{storage}/content/{volume}: delete: operationId: delete_nodes_node_storage_storage_content_volume parameters: - description: Time to wait for the task to finish. We return 'null' if the task finish within that time. in: query name: delay required: false schema: description: Time to wait for the task to finish. We return 'null' if the task finish within that time. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Volume identifier in: path name: volume required: true schema: description: Volume identifier type: string responses: "200": content: application/json: schema: type: string description: OK summary: Delete volume get: operationId: get_nodes_node_storage_storage_content_volume parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Volume identifier in: path name: volume required: true schema: description: Volume identifier type: string responses: "200": content: application/json: schema: properties: format: description: Format identifier ('raw', 'qcow2', 'subvol', 'iso', 'tgz' ...) type: string notes: description: Optional notes. type: string path: description: The Path type: string protected: description: Protection status. Currently only supported for backups. type: boolean size: description: Volume size in bytes. type: integer used: description: Used space. Please note that most storage plugins do not report anything useful here. type: integer type: object description: OK summary: Get volume attributes post: operationId: post_nodes_node_storage_storage_content_volume parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Target volume identifier in: query name: target required: false schema: description: Target volume identifier type: string - description: Target node. Default is local node. in: query name: target_node required: false schema: description: Target node. Default is local node. format: pve-node type: string - description: Source volume identifier in: path name: volume required: true schema: description: Source volume identifier type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string storage: description: The storage identifier. format: pve-storage-id type: string target: description: Target volume identifier type: string target_node: description: Target node. Default is local node. format: pve-node type: string volume: description: Source volume identifier type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Copy a volume. This is experimental code - do not use. put: operationId: put_nodes_node_storage_storage_content_volume parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The new notes. in: query name: notes required: false schema: description: The new notes. type: string - description: Protection status. Currently only supported for backups. in: query name: protected required: false schema: description: Protection status. Currently only supported for backups. type: boolean - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Volume identifier in: path name: volume required: true schema: description: Volume identifier type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string notes: description: The new notes. type: string protected: description: Protection status. Currently only supported for backups. type: boolean storage: description: The storage identifier. format: pve-storage-id type: string volume: description: Volume identifier type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update volume attributes /nodes/{node}/storage/{storage}/download-url: post: operationId: post_nodes_node_storage_storage_download_url parameters: - description: The expected checksum of the file. in: query name: checksum required: false schema: description: The expected checksum of the file. type: string - description: The algorithm to calculate the checksum of the file. in: query name: checksum-algorithm required: false schema: description: The algorithm to calculate the checksum of the file. enum: - md5 - sha1 - sha224 - sha256 - sha384 - sha512 type: string - description: Decompress the downloaded file using the specified compression algorithm. in: query name: compression required: false schema: description: Decompress the downloaded file using the specified compression algorithm. type: string - description: Content type. in: query name: content required: false schema: description: Content type. enum: - iso - vztmpl - import format: pve-storage-content type: string - description: 'The name of the file to create. Caution: This will be normalized!' in: query name: filename required: false schema: description: 'The name of the file to create. Caution: This will be normalized!' type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: The URL to download the file from. in: query name: url required: false schema: description: The URL to download the file from. type: string - description: If false, no SSL/TLS certificates will be verified. in: query name: verify-certificates required: false schema: description: If false, no SSL/TLS certificates will be verified. type: boolean requestBody: content: application/json: schema: properties: checksum: description: The expected checksum of the file. type: string checksum-algorithm: description: The algorithm to calculate the checksum of the file. enum: - md5 - sha1 - sha224 - sha256 - sha384 - sha512 type: string compression: description: Decompress the downloaded file using the specified compression algorithm. type: string content: description: Content type. enum: - iso - vztmpl - import format: pve-storage-content type: string filename: description: 'The name of the file to create. Caution: This will be normalized!' type: string node: description: The cluster node name. format: pve-node type: string storage: description: The storage identifier. format: pve-storage-id type: string url: description: The URL to download the file from. type: string verify-certificates: description: If false, no SSL/TLS certificates will be verified. type: boolean type: object responses: "200": content: application/json: schema: type: string description: OK summary: Download templates, ISO images, OVAs and VM images by using an URL. /nodes/{node}/storage/{storage}/file-restore/download: get: operationId: get_nodes_node_storage_storage_file_restore_download parameters: - description: base64-path to the directory or file to download. in: query name: filepath required: false schema: description: base64-path to the directory or file to download. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Download dirs as 'tar.zst' instead of 'zip'. in: query name: tar required: false schema: description: Download dirs as 'tar.zst' instead of 'zip'. type: boolean - description: Backup volume ID or name. Currently only PBS snapshots are supported. in: query name: volume required: false schema: description: Backup volume ID or name. Currently only PBS snapshots are supported. type: string responses: "200": content: application/octet-stream: schema: format: binary type: string description: File download summary: Extract a file or directory (as zip archive) from a PBS backup. /nodes/{node}/storage/{storage}/file-restore/list: get: operationId: get_nodes_node_storage_storage_file_restore_list parameters: - description: base64-path to the directory or file being listed, or "/". in: query name: filepath required: false schema: description: base64-path to the directory or file being listed, or "/". type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Backup volume ID or name. Currently only PBS snapshots are supported. in: query name: volume required: false schema: description: Backup volume ID or name. Currently only PBS snapshots are supported. type: string responses: "200": content: application/json: schema: items: properties: filepath: description: base64 path of the current entry type: string leaf: description: If this entry is a leaf in the directory graph. type: boolean mtime: description: Entry last-modified time (unix timestamp). type: integer size: description: Entry file size. type: integer text: description: Entry display text. type: string type: description: Entry type. type: string type: object type: array description: OK summary: List files and directories for single file restore under the given path. /nodes/{node}/storage/{storage}/identity: get: operationId: get_nodes_node_storage_storage_identity parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string responses: "200": content: application/json: schema: properties: id: description: Unique identifier for this storage instance. The exact format and semantics depend on the storage plugin type. type: string type: description: The type of the storage. enum: - btrfs - cephfs - cifs - dir - esxi - iscsi - iscsidirect - lvm - lvmthin - nfs - pbs - rbd - zfs - zfspool type: string type: object description: OK summary: Return identity information for this storage instance. /nodes/{node}/storage/{storage}/import-metadata: get: operationId: get_nodes_node_storage_storage_import_metadata parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Volume identifier for the guest archive/entry. in: query name: volume required: false schema: description: Volume identifier for the guest archive/entry. type: string responses: "200": content: application/json: schema: description: Information about how to import a guest. properties: create-args: description: Parameters which can be used in a call to create a VM or container. type: object disks: description: Recognised disk volumes as `$bus$id` => `$storeid:$path` map. type: object net: description: Recognised network interfaces as `net$id` => { ...params } object. type: object source: description: The type of the import-source of this guest volume. enum: - esxi type: string type: description: The type of guest this is going to produce. enum: - vm type: string warnings: description: List of known issues that can affect the import of a guest. Note that lack of warning does not imply that there cannot be any problems. items: properties: key: description: Related subject (config) key of warning. type: string type: description: What this warning is about. enum: - cdrom-image-ignored - efi-state-lost - guest-is-running - nvme-unsupported - ova-needs-extracting - ovmf-with-lsi-unsupported - serial-port-socket-only type: string value: description: Related subject (config) value of warning. type: string type: object type: array type: object description: OK summary: Get the base parameters for creating a guest which imports data from a foreign importable guest, like an ESXi VM /nodes/{node}/storage/{storage}/oci-registry-pull: post: operationId: post_nodes_node_storage_storage_oci_registry_pull parameters: - description: 'Custom destination file name of the OCI image. Caution: This will be normalized!' in: query name: filename required: false schema: description: 'Custom destination file name of the OCI image. Caution: This will be normalized!' type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The reference to the OCI image to download. in: query name: reference required: false schema: description: The reference to the OCI image to download. type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string requestBody: content: application/json: schema: properties: filename: description: 'Custom destination file name of the OCI image. Caution: This will be normalized!' type: string node: description: The cluster node name. format: pve-node type: string reference: description: The reference to the OCI image to download. type: string storage: description: The storage identifier. format: pve-storage-id type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Pull an OCI image from a registry. /nodes/{node}/storage/{storage}/prunebackups: delete: operationId: delete_nodes_node_storage_storage_prunebackups parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Use these retention options instead of those from the storage configuration. in: query name: prune-backups required: false schema: description: Use these retention options instead of those from the storage configuration. format: prune-backups type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Either 'qemu' or 'lxc'. Only consider backups for guests of this type. in: query name: type required: false schema: description: Either 'qemu' or 'lxc'. Only consider backups for guests of this type. enum: - qemu - lxc type: string - description: Only prune backups for this VM. in: query name: vmid required: false schema: description: Only prune backups for this VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: type: string description: OK summary: Prune backups. Only those using the standard naming scheme are considered. get: operationId: get_nodes_node_storage_storage_prunebackups parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Use these retention options instead of those from the storage configuration. in: query name: prune-backups required: false schema: description: Use these retention options instead of those from the storage configuration. format: prune-backups type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Either 'qemu' or 'lxc'. Only consider backups for guests of this type. in: query name: type required: false schema: description: Either 'qemu' or 'lxc'. Only consider backups for guests of this type. enum: - qemu - lxc type: string - description: Only consider backups for this guest. in: query name: vmid required: false schema: description: Only consider backups for this guest. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: ctime: description: Creation time of the backup (seconds since the UNIX epoch). type: integer mark: description: Whether the backup would be kept or removed. Backups that are protected or don't use the standard naming scheme are not removed. enum: - keep - remove - protected - renamed type: string type: description: One of 'qemu', 'lxc', 'openvz' or 'unknown'. type: string vmid: description: The VM the backup belongs to. type: integer volid: description: Backup volume ID. type: string type: object type: array description: OK summary: 'Get prune information for backups. NOTE: this is only a preview and might not be what a subsequent prune call does if backups are removed/added in the meantime.' /nodes/{node}/storage/{storage}/rrd: get: operationId: get_nodes_node_storage_storage_rrd parameters: - description: The RRD consolidation function in: query name: cf required: false schema: description: The RRD consolidation function enum: - AVERAGE - MAX type: string - description: The list of datasources you want to display. in: query name: ds required: false schema: description: The list of datasources you want to display. format: pve-configid-list type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Specify the time frame you are interested in. in: query name: timeframe required: false schema: description: Specify the time frame you are interested in. enum: - hour - day - week - month - year type: string responses: "200": content: application/json: schema: properties: filename: type: string type: object description: OK summary: Read storage RRD statistics (returns PNG). /nodes/{node}/storage/{storage}/rrddata: get: operationId: get_nodes_node_storage_storage_rrddata parameters: - description: The RRD consolidation function in: query name: cf required: false schema: description: The RRD consolidation function enum: - AVERAGE - MAX type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Specify the time frame you are interested in. in: query name: timeframe required: false schema: description: Specify the time frame you are interested in. enum: - hour - day - week - month - year type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: Read storage RRD statistics. /nodes/{node}/storage/{storage}/status: get: operationId: get_nodes_node_storage_storage_status parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string responses: "200": content: application/json: schema: properties: active: description: Set when storage is accessible. type: boolean avail: description: Available storage space in bytes. type: integer content: description: Allowed storage content types. format: pve-storage-content-list type: string enabled: description: Set when storage is enabled (not disabled). type: boolean shared: description: Shared flag from storage configuration. type: boolean total: description: Total storage space in bytes. type: integer type: description: Storage type. type: string used: description: Used storage space in bytes. type: integer type: object description: OK summary: Read storage status. /nodes/{node}/storage/{storage}/upload: post: operationId: post_nodes_node_storage_storage_upload parameters: - description: The expected checksum of the file. in: query name: checksum required: false schema: description: The expected checksum of the file. type: string - description: The algorithm to calculate the checksum of the file. in: query name: checksum-algorithm required: false schema: description: The algorithm to calculate the checksum of the file. enum: - md5 - sha1 - sha224 - sha256 - sha384 - sha512 type: string - description: Content type. in: query name: content required: false schema: description: Content type. enum: - iso - vztmpl - import format: pve-storage-content type: string - description: 'The name of the file to create. Caution: This will be normalized!' in: query name: filename required: false schema: description: 'The name of the file to create. Caution: This will be normalized!' type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost. in: query name: tmpfilename required: false schema: description: The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost. type: string requestBody: content: application/json: schema: properties: checksum: description: The expected checksum of the file. type: string checksum-algorithm: description: The algorithm to calculate the checksum of the file. enum: - md5 - sha1 - sha224 - sha256 - sha384 - sha512 type: string content: description: Content type. enum: - iso - vztmpl - import format: pve-storage-content type: string filename: description: 'The name of the file to create. Caution: This will be normalized!' type: string node: description: The cluster node name. format: pve-node type: string storage: description: The storage identifier. format: pve-storage-id type: string tmpfilename: description: The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost. type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Upload templates, ISO images, OVAs and VM images. /nodes/{node}/subscription: delete: operationId: delete_nodes_node_subscription parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete subscription key of this node. get: operationId: get_nodes_node_subscription parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: checktime: description: Timestamp of the last check done. type: integer key: description: The subscription key, if set and permitted to access. type: string level: description: A short code for the subscription level. type: string message: description: A more human readable status message. type: string nextduedate: description: Next due date of the set subscription. type: string productname: description: Human readable productname of the set subscription. type: string regdate: description: Register date of the set subscription. type: string serverid: description: The server ID, if permitted to access. type: string signature: description: Signature for offline keys type: string sockets: description: The number of sockets for this host. type: integer status: description: The current subscription status. enum: - new - notfound - active - invalid - expired - suspended type: string url: description: URL to the web shop. type: string type: object description: OK summary: Read subscription info. post: operationId: post_nodes_node_subscription parameters: - description: Always connect to server, even if local cache is still valid. in: query name: force required: false schema: description: Always connect to server, even if local cache is still valid. type: boolean - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: force: description: Always connect to server, even if local cache is still valid. type: boolean node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update subscription info. put: operationId: put_nodes_node_subscription parameters: - description: Proxmox VE subscription key in: query name: key required: false schema: description: Proxmox VE subscription key type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: key: description: Proxmox VE subscription key type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set subscription key. /nodes/{node}/suspendall: post: operationId: post_nodes_node_suspendall parameters: - description: |- Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg, and if that's not set the available' .' CPU threads, clamped to a maximum of 8, are used. in: query name: max-workers required: false schema: description: |- Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg, and if that's not set the available' .' CPU threads, clamped to a maximum of 8, are used. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Only consider Guests with these IDs. in: query name: vms required: false schema: description: Only consider Guests with these IDs. format: pve-vmid-list type: string requestBody: content: application/json: schema: properties: max-workers: description: |- Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg, and if that's not set the available' .' CPU threads, clamped to a maximum of 8, are used. type: integer node: description: The cluster node name. format: pve-node type: string vms: description: Only consider Guests with these IDs. format: pve-vmid-list type: string type: object responses: "200": content: application/json: schema: type: string description: OK summary: Suspend all VMs. /nodes/{node}/syslog: get: operationId: get_nodes_node_syslog parameters: - description: "" in: query name: limit required: false schema: type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Service ID in: query name: service required: false schema: description: Service ID type: string - description: Display all log since this date-time string. in: query name: since required: false schema: description: Display all log since this date-time string. type: string - description: "" in: query name: start required: false schema: type: integer - description: Display all log until this date-time string. in: query name: until required: false schema: description: Display all log until this date-time string. type: string responses: "200": content: application/json: schema: items: properties: "n": description: Line number type: integer t: description: Line text type: string type: object type: array description: OK summary: Read system log /nodes/{node}/tasks: get: operationId: get_nodes_node_tasks parameters: - description: Only list tasks with a status of ERROR. in: query name: errors required: false schema: description: Only list tasks with a status of ERROR. type: boolean - description: Only list this number of tasks. in: query name: limit required: false schema: description: Only list this number of tasks. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Only list tasks since this UNIX epoch. in: query name: since required: false schema: description: Only list tasks since this UNIX epoch. type: integer - description: List archived, active or all tasks. in: query name: source required: false schema: description: List archived, active or all tasks. enum: - archive - active - all type: string - description: List tasks beginning from this offset. in: query name: start required: false schema: description: List tasks beginning from this offset. type: integer - description: List of Task States that should be returned. in: query name: statusfilter required: false schema: description: List of Task States that should be returned. format: pve-task-status-type-list type: string - description: Only list tasks of this type (e.g., vzstart, vzdump). in: query name: typefilter required: false schema: description: Only list tasks of this type (e.g., vzstart, vzdump). type: string - description: Only list tasks until this UNIX epoch. in: query name: until required: false schema: description: Only list tasks until this UNIX epoch. type: integer - description: Only list tasks from this user. in: query name: userfilter required: false schema: description: Only list tasks from this user. type: string - description: Only list tasks for this VM. in: query name: vmid required: false schema: description: Only list tasks for this VM. format: pve-vmid type: integer responses: "200": content: application/json: schema: items: properties: endtime: type: integer id: type: string node: type: string pid: type: integer pstart: type: integer starttime: type: integer status: type: string type: type: string upid: type: string user: type: string type: object type: array description: OK summary: Read task list for one node (finished tasks). /nodes/{node}/tasks/{upid}: delete: operationId: delete_nodes_node_tasks_upid parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: "" in: path name: upid required: true schema: type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Stop a task. get: operationId: get_nodes_node_tasks_upid parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: "" in: path name: upid required: true schema: type: string responses: "200": content: application/json: schema: items: type: object type: array description: OK summary: "" /nodes/{node}/tasks/{upid}/log: get: operationId: get_nodes_node_tasks_upid_log parameters: - description: Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters in: query name: download required: false schema: description: Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters type: boolean - description: The number of lines to read from the tasklog. in: query name: limit required: false schema: description: The number of lines to read from the tasklog. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Start at this line when reading the tasklog in: query name: start required: false schema: description: Start at this line when reading the tasklog type: integer - description: The task's unique ID. in: path name: upid required: true schema: description: The task's unique ID. type: string responses: "200": content: application/json: schema: items: properties: "n": description: Line number type: integer t: description: Line text type: string type: object type: array description: OK summary: Read task log. /nodes/{node}/tasks/{upid}/status: get: operationId: get_nodes_node_tasks_upid_status parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The task's unique ID. in: path name: upid required: true schema: description: The task's unique ID. type: string responses: "200": content: application/json: schema: properties: exitstatus: type: string id: type: string node: type: string pid: type: integer pstart: type: integer starttime: type: integer status: enum: - running - stopped type: string type: type: string upid: type: string user: type: string type: object description: OK summary: Read task status. /nodes/{node}/termproxy: post: operationId: post_nodes_node_termproxy parameters: - description: Run specific command or default to login (requires 'root@pam') in: query name: cmd required: false schema: description: Run specific command or default to login (requires 'root@pam') enum: - ceph_install - login - upgrade type: string - description: Add parameters to a command. Encoded as null terminated strings. in: query name: cmd-opts required: false schema: description: Add parameters to a command. Encoded as null terminated strings. type: string - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string requestBody: content: application/json: schema: properties: cmd: description: Run specific command or default to login (requires 'root@pam') enum: - ceph_install - login - upgrade type: string cmd-opts: description: Add parameters to a command. Encoded as null terminated strings. type: string node: description: The cluster node name. format: pve-node type: string type: object responses: "200": content: application/json: schema: properties: port: description: port used to bind termproxy to. type: integer ticket: description: VNC ticket used to verify websocket connection. type: string upid: description: UPID for termproxy worker task. type: string user: description: user/token that generated the VNC ticket in `ticket`. type: string type: object description: OK summary: Creates a VNC Shell proxy. /nodes/{node}/time: get: operationId: get_nodes_node_time parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: localtime: description: Seconds since 1970-01-01 00:00:00 (local time) type: integer time: description: Seconds since 1970-01-01 00:00:00 UTC. type: integer timezone: description: Time zone type: string type: object description: OK summary: Read server time and time zone settings. put: operationId: put_nodes_node_time parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names. in: query name: timezone required: false schema: description: Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names. type: string requestBody: content: application/json: schema: properties: node: description: The cluster node name. format: pve-node type: string timezone: description: Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names. type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Set time zone. /nodes/{node}/version: get: operationId: get_nodes_node_version parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string responses: "200": content: application/json: schema: properties: release: description: The current installed Proxmox VE Release type: string repoid: description: The short git commit hash ID from which this version was build type: string version: description: The current installed pve-manager package version type: string type: object description: OK summary: API version details /nodes/{node}/vncshell: post: operationId: post_nodes_node_vncshell parameters: - description: Run specific command or default to login (requires 'root@pam') in: query name: cmd required: false schema: description: Run specific command or default to login (requires 'root@pam') enum: - ceph_install - login - upgrade type: string - description: Add parameters to a command. Encoded as null terminated strings. in: query name: cmd-opts required: false schema: description: Add parameters to a command. Encoded as null terminated strings. type: string - description: sets the height of the console in pixels. in: query name: height required: false schema: description: sets the height of the console in pixels. type: integer - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: use websocket instead of standard vnc. in: query name: websocket required: false schema: description: use websocket instead of standard vnc. type: boolean - description: sets the width of the console in pixels. in: query name: width required: false schema: description: sets the width of the console in pixels. type: integer requestBody: content: application/json: schema: properties: cmd: description: Run specific command or default to login (requires 'root@pam') enum: - ceph_install - login - upgrade type: string cmd-opts: description: Add parameters to a command. Encoded as null terminated strings. type: string height: description: sets the height of the console in pixels. type: integer node: description: The cluster node name. format: pve-node type: string websocket: description: use websocket instead of standard vnc. type: boolean width: description: sets the width of the console in pixels. type: integer type: object responses: "200": content: application/json: schema: properties: cert: type: string password: description: Password used for authentication within the VNC protocol. Consists of printable ASCII characters ('!' .. '~'). type: string port: type: integer ticket: type: string upid: type: string user: type: string type: object description: OK summary: Creates a VNC Shell proxy. /nodes/{node}/vncwebsocket: get: operationId: get_nodes_node_vncwebsocket parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Port number returned by previous 'vncshell' call. in: query name: port required: false schema: description: Port number returned by previous 'vncshell' call. type: integer - description: Ticket from previous call to 'vncshell'. in: query name: vncticket required: false schema: description: Ticket from previous call to 'vncshell'. type: string responses: "200": content: application/json: schema: properties: port: type: string type: object description: OK summary: Opens a websocket for VNC traffic. /nodes/{node}/vzdump: post: operationId: post_nodes_node_vzdump parameters: - description: Backup all known guest systems on this host. in: query name: all required: false schema: description: Backup all known guest systems on this host. type: boolean - description: Limit I/O bandwidth (in KiB/s). in: query name: bwlimit required: false schema: description: Limit I/O bandwidth (in KiB/s). type: integer - description: Compress dump file. in: query name: compress required: false schema: description: Compress dump file. enum: - "0" - "1" - gzip - lzo - zstd type: string - description: Store resulting files to specified directory. in: query name: dumpdir required: false schema: description: Store resulting files to specified directory. type: string - description: Exclude specified guest systems (assumes --all) in: query name: exclude required: false schema: description: Exclude specified guest systems (assumes --all) format: pve-vmid-list type: string - description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. in: query name: exclude-path required: false schema: description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. items: type: string type: array - description: Options for backup fleecing (VM only). in: query name: fleecing required: false schema: description: Options for backup fleecing (VM only). format: backup-fleecing type: string - description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. in: query name: ionice required: false schema: description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. type: integer - description: The ID of the backup job. If set, the 'backup-job' metadata field of the backup notification will be set to this value. Only root@pam can set this parameter. in: query name: job-id required: false schema: description: The ID of the backup job. If set, the 'backup-job' metadata field of the backup notification will be set to this value. Only root@pam can set this parameter. type: string - description: Maximal time to wait for the global lock (minutes). in: query name: lockwait required: false schema: description: Maximal time to wait for the global lock (minutes). type: integer - description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' in: query name: mailnotification required: false schema: description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' enum: - always - failure type: string - description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' in: query name: mailto required: false schema: description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' format: email-or-username-list type: string - description: Backup mode. in: query name: mode required: false schema: description: Backup mode. enum: - snapshot - suspend - stop type: string - description: Only run if executed on this node. in: path name: node required: true schema: description: Only run if executed on this node. format: pve-node type: string - description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. in: query name: notes-template required: false schema: description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. type: string - description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. in: query name: notification-mode required: false schema: description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. enum: - auto - legacy-sendmail - notification-system type: string - description: PBS mode used to detect file changes and switch encoding format for container backups. in: query name: pbs-change-detection-mode required: false schema: description: PBS mode used to detect file changes and switch encoding format for container backups. enum: - legacy - data - metadata type: string - description: Other performance-related settings. in: query name: performance required: false schema: description: Other performance-related settings. format: backup-performance type: string - description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. in: query name: pigz required: false schema: description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. type: integer - description: Backup all known guest systems included in the specified pool. in: query name: pool required: false schema: description: Backup all known guest systems included in the specified pool. type: string - description: If true, mark backup(s) as protected. in: query name: protected required: false schema: description: If true, mark backup(s) as protected. type: boolean - description: Use these retention options instead of those from the storage configuration. in: query name: prune-backups required: false schema: description: Use these retention options instead of those from the storage configuration. format: prune-backups type: string - description: Be quiet. in: query name: quiet required: false schema: description: Be quiet. type: boolean - description: Prune older backups according to 'prune-backups'. in: query name: remove required: false schema: description: Prune older backups according to 'prune-backups'. type: boolean - description: Use specified hook script. in: query name: script required: false schema: description: Use specified hook script. type: string - description: Exclude temporary files and logs. in: query name: stdexcludes required: false schema: description: Exclude temporary files and logs. type: boolean - description: Write tar to stdout, not to a file. in: query name: stdout required: false schema: description: Write tar to stdout, not to a file. type: boolean - description: Stop running backup jobs on this host. in: query name: stop required: false schema: description: Stop running backup jobs on this host. type: boolean - description: Maximal time to wait until a guest system is stopped (minutes). in: query name: stopwait required: false schema: description: Maximal time to wait until a guest system is stopped (minutes). type: integer - description: Store resulting file to this storage. in: query name: storage required: false schema: description: Store resulting file to this storage. format: pve-storage-id type: string - description: Store temporary files to specified directory. in: query name: tmpdir required: false schema: description: Store temporary files to specified directory. type: string - description: The ID of the guest system you want to backup. in: query name: vmid required: false schema: description: The ID of the guest system you want to backup. format: pve-vmid-list type: string - description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. in: query name: zstd required: false schema: description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. type: integer requestBody: content: application/json: schema: properties: all: description: Backup all known guest systems on this host. type: boolean bwlimit: description: Limit I/O bandwidth (in KiB/s). type: integer compress: description: Compress dump file. enum: - "0" - "1" - gzip - lzo - zstd type: string dumpdir: description: Store resulting files to specified directory. type: string exclude: description: Exclude specified guest systems (assumes --all) format: pve-vmid-list type: string exclude-path: description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. items: type: string type: array fleecing: description: Options for backup fleecing (VM only). format: backup-fleecing type: string ionice: description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. type: integer job-id: description: The ID of the backup job. If set, the 'backup-job' metadata field of the backup notification will be set to this value. Only root@pam can set this parameter. type: string lockwait: description: Maximal time to wait for the global lock (minutes). type: integer mailnotification: description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' enum: - always - failure type: string mailto: description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' format: email-or-username-list type: string mode: description: Backup mode. enum: - snapshot - suspend - stop type: string node: description: Only run if executed on this node. format: pve-node type: string notes-template: description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. type: string notification-mode: description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. enum: - auto - legacy-sendmail - notification-system type: string pbs-change-detection-mode: description: PBS mode used to detect file changes and switch encoding format for container backups. enum: - legacy - data - metadata type: string performance: description: Other performance-related settings. format: backup-performance type: string pigz: description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. type: integer pool: description: Backup all known guest systems included in the specified pool. type: string protected: description: If true, mark backup(s) as protected. type: boolean prune-backups: description: Use these retention options instead of those from the storage configuration. format: prune-backups type: string quiet: description: Be quiet. type: boolean remove: description: Prune older backups according to 'prune-backups'. type: boolean script: description: Use specified hook script. type: string stdexcludes: description: Exclude temporary files and logs. type: boolean stdout: description: Write tar to stdout, not to a file. type: boolean stop: description: Stop running backup jobs on this host. type: boolean stopwait: description: Maximal time to wait until a guest system is stopped (minutes). type: integer storage: description: Store resulting file to this storage. format: pve-storage-id type: string tmpdir: description: Store temporary files to specified directory. type: string vmid: description: The ID of the guest system you want to backup. format: pve-vmid-list type: string zstd: description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. type: integer type: object responses: "200": content: application/json: schema: type: string description: OK summary: Create backup. /nodes/{node}/vzdump/defaults: get: operationId: get_nodes_node_vzdump_defaults parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: The storage identifier. in: query name: storage required: false schema: description: The storage identifier. format: pve-storage-id type: string responses: "200": content: application/json: schema: properties: all: description: Backup all known guest systems on this host. type: boolean bwlimit: description: Limit I/O bandwidth (in KiB/s). type: integer compress: description: Compress dump file. enum: - "0" - "1" - gzip - lzo - zstd type: string dumpdir: description: Store resulting files to specified directory. type: string exclude: description: Exclude specified guest systems (assumes --all) format: pve-vmid-list type: string exclude-path: description: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. items: type: string type: array fleecing: description: Options for backup fleecing (VM only). format: backup-fleecing type: string ionice: description: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. type: integer lockwait: description: Maximal time to wait for the global lock (minutes). type: integer mailnotification: description: 'Deprecated: use notification targets/matchers instead. Specify when to send a notification mail' enum: - always - failure type: string mailto: description: 'Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.' format: email-or-username-list type: string mode: description: Backup mode. enum: - snapshot - suspend - stop type: string node: description: Only run if executed on this node. format: pve-node type: string notes-template: description: Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. type: string notification-mode: description: Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. enum: - auto - legacy-sendmail - notification-system type: string pbs-change-detection-mode: description: PBS mode used to detect file changes and switch encoding format for container backups. enum: - legacy - data - metadata type: string performance: description: Other performance-related settings. format: backup-performance type: string pigz: description: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. type: integer pool: description: Backup all known guest systems included in the specified pool. type: string protected: description: If true, mark backup(s) as protected. type: boolean prune-backups: description: Use these retention options instead of those from the storage configuration. format: prune-backups type: string quiet: description: Be quiet. type: boolean remove: description: Prune older backups according to 'prune-backups'. type: boolean script: description: Use specified hook script. type: string stdexcludes: description: Exclude temporary files and logs. type: boolean stop: description: Stop running backup jobs on this host. type: boolean stopwait: description: Maximal time to wait until a guest system is stopped (minutes). type: integer storage: description: Store resulting file to this storage. format: pve-storage-id type: string tmpdir: description: Store temporary files to specified directory. type: string vmid: description: The ID of the guest system you want to backup. format: pve-vmid-list type: string zstd: description: Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. type: integer type: object description: OK summary: Get the currently configured vzdump defaults. /nodes/{node}/vzdump/extractconfig: get: operationId: get_nodes_node_vzdump_extractconfig parameters: - description: The cluster node name. in: path name: node required: true schema: description: The cluster node name. format: pve-node type: string - description: Volume identifier in: query name: volume required: false schema: description: Volume identifier type: string responses: "200": content: application/json: schema: type: string description: OK summary: Extract configuration from vzdump backup archive. /nodes/{node}/wakeonlan: post: operationId: post_nodes_node_wakeonlan parameters: - description: target node for wake on LAN packet in: path name: node required: true schema: description: target node for wake on LAN packet format: pve-node type: string requestBody: content: application/json: schema: properties: node: description: target node for wake on LAN packet format: pve-node type: string type: object responses: "200": content: application/json: schema: description: MAC address used to assemble the WoL magic packet. format: mac-addr type: string description: OK summary: Try to wake a node via 'wake on LAN' network packet. /pools: delete: operationId: delete_pools parameters: - description: "" in: query name: poolid required: false schema: format: pve-poolid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete pool. get: operationId: get_pools parameters: - description: "" in: query name: poolid required: false schema: format: pve-poolid type: string - description: "" in: query name: type required: false schema: enum: - qemu - lxc - storage type: string responses: "200": content: application/json: schema: items: properties: comment: type: string members: items: properties: id: type: string node: type: string storage: type: string type: enum: - qemu - lxc - openvz - storage type: string vmid: type: integer type: object type: array poolid: type: string type: object type: array description: OK summary: List pools or get pool configuration. post: operationId: post_pools parameters: - description: "" in: query name: comment required: false schema: type: string - description: "" in: query name: poolid required: false schema: format: pve-poolid type: string requestBody: content: application/json: schema: properties: comment: type: string poolid: format: pve-poolid type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Create new pool. put: operationId: put_pools parameters: - description: Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. in: query name: allow-move required: false schema: description: Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. type: boolean - description: "" in: query name: comment required: false schema: type: string - description: Remove the passed VMIDs and/or storage IDs instead of adding them. in: query name: delete required: false schema: description: Remove the passed VMIDs and/or storage IDs instead of adding them. type: boolean - description: "" in: query name: poolid required: false schema: format: pve-poolid type: string - description: List of storage IDs to add or remove from this pool. in: query name: storage required: false schema: description: List of storage IDs to add or remove from this pool. format: pve-storage-id-list type: string - description: List of guest VMIDs to add or remove from this pool. in: query name: vms required: false schema: description: List of guest VMIDs to add or remove from this pool. format: pve-vmid-list type: string requestBody: content: application/json: schema: properties: allow-move: description: Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. type: boolean comment: type: string delete: description: Remove the passed VMIDs and/or storage IDs instead of adding them. type: boolean poolid: format: pve-poolid type: string storage: description: List of storage IDs to add or remove from this pool. format: pve-storage-id-list type: string vms: description: List of guest VMIDs to add or remove from this pool. format: pve-vmid-list type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update pool. /pools/{poolid}: delete: operationId: delete_pools_poolid parameters: - description: "" in: path name: poolid required: true schema: format: pve-poolid type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete pool (deprecated, no support for nested pools, use 'DELETE /pools/?poolid={poolid}'). get: operationId: get_pools_poolid parameters: - description: "" in: path name: poolid required: true schema: format: pve-poolid type: string - description: "" in: query name: type required: false schema: enum: - qemu - lxc - storage type: string responses: "200": content: application/json: schema: properties: comment: type: string members: items: properties: id: type: string node: type: string storage: type: string type: enum: - qemu - lxc - openvz - storage type: string vmid: type: integer type: object type: array type: object description: OK summary: Get pool configuration (deprecated, no support for nested pools, use 'GET /pools/?poolid={poolid}'). put: operationId: put_pools_poolid parameters: - description: Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. in: query name: allow-move required: false schema: description: Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. type: boolean - description: "" in: query name: comment required: false schema: type: string - description: Remove the passed VMIDs and/or storage IDs instead of adding them. in: query name: delete required: false schema: description: Remove the passed VMIDs and/or storage IDs instead of adding them. type: boolean - description: "" in: path name: poolid required: true schema: format: pve-poolid type: string - description: List of storage IDs to add or remove from this pool. in: query name: storage required: false schema: description: List of storage IDs to add or remove from this pool. format: pve-storage-id-list type: string - description: List of guest VMIDs to add or remove from this pool. in: query name: vms required: false schema: description: List of guest VMIDs to add or remove from this pool. format: pve-vmid-list type: string requestBody: content: application/json: schema: properties: allow-move: description: Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. type: boolean comment: type: string delete: description: Remove the passed VMIDs and/or storage IDs instead of adding them. type: boolean poolid: format: pve-poolid type: string storage: description: List of storage IDs to add or remove from this pool. format: pve-storage-id-list type: string vms: description: List of guest VMIDs to add or remove from this pool. format: pve-vmid-list type: string type: object responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Update pool data (deprecated, no support for nested pools - use 'PUT /pools/?poolid={poolid}' instead). /storage: get: operationId: get_storage parameters: - description: Only list storage of specific type in: query name: type required: false schema: description: Only list storage of specific type enum: - btrfs - cephfs - cifs - dir - esxi - iscsi - iscsidirect - lvm - lvmthin - nfs - pbs - rbd - zfs - zfspool type: string responses: "200": content: application/json: schema: items: properties: storage: type: string type: object type: array description: OK summary: Storage index. post: operationId: post_storage parameters: - description: Authsupported. in: query name: authsupported required: false schema: description: Authsupported. type: string - description: Base volume. This volume is automatically activated. in: query name: base required: false schema: description: Base volume. This volume is automatically activated. format: pve-volume-id type: string - description: ZFS block size in: query name: blocksize required: false schema: description: ZFS block size format: pve-storage-zfs-blocksize type: string - description: Set I/O bandwidth limit for various operations (in KiB/s). in: query name: bwlimit required: false schema: description: Set I/O bandwidth limit for various operations (in KiB/s). type: string - description: host group for comstar views in: query name: comstar_hg required: false schema: description: host group for comstar views type: string - description: target group for comstar views in: query name: comstar_tg required: false schema: description: target group for comstar views type: string - description: | Allowed content types. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. in: query name: content required: false schema: description: | Allowed content types. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. format: pve-storage-content-list type: string - description: Overrides for default content type directories. in: query name: content-dirs required: false schema: description: Overrides for default content type directories. format: pve-dir-override-list type: string - description: Create the base directory if it doesn't exist. in: query name: create-base-path required: false schema: description: Create the base directory if it doesn't exist. type: boolean - description: Populate the directory with the default structure. in: query name: create-subdirs required: false schema: description: Populate the directory with the default structure. type: boolean - description: Data Pool (for erasure coding only) in: query name: data-pool required: false schema: description: Data Pool (for erasure coding only) type: string - description: Proxmox Backup Server datastore name. in: query name: datastore required: false schema: description: Proxmox Backup Server datastore name. type: string - description: Flag to disable the storage. in: query name: disable required: false schema: description: Flag to disable the storage. type: boolean - description: CIFS domain. in: query name: domain required: false schema: description: CIFS domain. type: string - description: Encryption key. Use 'autogen' to generate one automatically without passphrase. in: query name: encryption-key required: false schema: description: Encryption key. Use 'autogen' to generate one automatically without passphrase. type: string - description: NFS export path. in: query name: export required: false schema: description: NFS export path. format: pve-storage-path type: string - description: Certificate SHA 256 fingerprint. in: query name: fingerprint required: false schema: description: Certificate SHA 256 fingerprint. type: string - description: Default image format. in: query name: format required: false schema: description: Default image format. enum: - raw - qcow2 - subvol - vmdk type: string - description: The Ceph filesystem name. in: query name: fs-name required: false schema: description: The Ceph filesystem name. format: pve-configid type: string - description: Mount CephFS through FUSE. in: query name: fuse required: false schema: description: Mount CephFS through FUSE. type: boolean - description: Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. in: query name: is_mountpoint required: false schema: description: Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. type: string - description: iscsi provider in: query name: iscsiprovider required: false schema: description: iscsi provider type: string - description: Client keyring contents (for external clusters). in: query name: keyring required: false schema: description: Client keyring contents (for external clusters). type: string - description: Always access rbd through krbd kernel module. in: query name: krbd required: false schema: description: Always access rbd through krbd kernel module. type: boolean - description: target portal group for Linux LIO targets in: query name: lio_tpg required: false schema: description: target portal group for Linux LIO targets type: string - description: Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. in: query name: master-pubkey required: false schema: description: Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. type: string - description: Maximal number of protected backups per guest. Use '-1' for unlimited. in: query name: max-protected-backups required: false schema: description: Maximal number of protected backups per guest. Use '-1' for unlimited. type: integer - description: 'Create the directory if it doesn''t exist and populate it with default sub-dirs. NOTE: Deprecated, use the ''create-base-path'' and ''create-subdirs'' options instead.' in: query name: mkdir required: false schema: description: 'Create the directory if it doesn''t exist and populate it with default sub-dirs. NOTE: Deprecated, use the ''create-base-path'' and ''create-subdirs'' options instead.' type: boolean - description: IP addresses of monitors (for external clusters). in: query name: monhost required: false schema: description: IP addresses of monitors (for external clusters). format: pve-storage-portal-dns-list type: string - description: mount point in: query name: mountpoint required: false schema: description: mount point format: pve-storage-path type: string - description: Namespace. in: query name: namespace required: false schema: description: Namespace. type: string - description: Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. in: query name: nocow required: false schema: description: Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. type: boolean - description: List of nodes for which the storage configuration applies. in: query name: nodes required: false schema: description: List of nodes for which the storage configuration applies. format: pve-node-list type: string - description: disable write caching on the target in: query name: nowritecache required: false schema: description: disable write caching on the target type: boolean - description: NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') in: query name: options required: false schema: description: NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') format: pve-storage-options type: string - description: Password for accessing the share/datastore. in: query name: password required: false schema: description: Password for accessing the share/datastore. type: string - description: File system path. in: query name: path required: false schema: description: File system path. format: pve-storage-path type: string - description: Pool. in: query name: pool required: false schema: description: Pool. type: string - description: Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the 'options' option to configure the port via the mount options. in: query name: port required: false schema: description: Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the 'options' option to configure the port via the mount options. type: integer - description: iSCSI portal (IP or DNS name with optional port). in: query name: portal required: false schema: description: iSCSI portal (IP or DNS name with optional port). format: pve-storage-portal-dns type: string - description: Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. in: query name: preallocation required: false schema: description: Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. enum: - "off" - metadata - falloc - full type: string - description: The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. in: query name: prune-backups required: false schema: description: The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. format: prune-backups type: string - description: Zero-out data when removing LVs. in: query name: saferemove required: false schema: description: Zero-out data when removing LVs. type: boolean - description: Wipe step size in MiB. It will be capped to the maximum supported by the storage. in: query name: saferemove-stepsize required: false schema: description: Wipe step size in MiB. It will be capped to the maximum supported by the storage. enum: - "1" - "2" - "4" - "8" - "16" - "32" type: integer - description: Wipe throughput (cstream -t parameter value). in: query name: saferemove_throughput required: false schema: description: Wipe throughput (cstream -t parameter value). type: string - description: Server IP or DNS name. in: query name: server required: false schema: description: Server IP or DNS name. format: pve-storage-server type: string - description: CIFS share. in: query name: share required: false schema: description: CIFS share. type: string - description: Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! in: query name: shared required: false schema: description: Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! type: boolean - description: Disable TLS certificate verification, only enable on fully trusted networks! in: query name: skip-cert-verification required: false schema: description: Disable TLS certificate verification, only enable on fully trusted networks! type: boolean - description: SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. in: query name: smbversion required: false schema: description: SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. enum: - default - "2.0" - "2.1" - "3" - "3.0" - "3.11" type: string - description: Enable support for creating storage-vendor agnostic snapshot through volume backing-chains. in: query name: snapshot-as-volume-chain required: false schema: description: Enable support for creating storage-vendor agnostic snapshot through volume backing-chains. type: boolean - description: use sparse volumes in: query name: sparse required: false schema: description: use sparse volumes type: boolean - description: The storage identifier. in: query name: storage required: false schema: description: The storage identifier. format: pve-storage-id type: string - description: Subdir to mount. in: query name: subdir required: false schema: description: Subdir to mount. format: pve-storage-path type: string - description: Only list logical volumes tagged with 'pve-vm-ID'. in: query name: tagged_only required: false schema: description: Only list logical volumes tagged with 'pve-vm-ID'. type: boolean - description: iSCSI target. in: query name: target required: false schema: description: iSCSI target. type: string - description: LVM thin pool LV name. in: query name: thinpool required: false schema: description: LVM thin pool LV name. format: pve-storage-vgname type: string - description: Storage type. in: query name: type required: false schema: description: Storage type. enum: - btrfs - cephfs - cifs - dir - esxi - iscsi - iscsidirect - lvm - lvmthin - nfs - pbs - rbd - zfs - zfspool type: string - description: RBD Id. in: query name: username required: false schema: description: RBD Id. type: string - description: Volume group name. in: query name: vgname required: false schema: description: Volume group name. format: pve-storage-vgname type: string - description: Base path where to look for the created ZFS block devices. Set automatically during creation if not specified. Usually '/dev/zvol'. in: query name: zfs-base-path required: false schema: description: Base path where to look for the created ZFS block devices. Set automatically during creation if not specified. Usually '/dev/zvol'. format: pve-storage-path type: string requestBody: content: application/json: schema: properties: authsupported: description: Authsupported. type: string base: description: Base volume. This volume is automatically activated. format: pve-volume-id type: string blocksize: description: ZFS block size format: pve-storage-zfs-blocksize type: string bwlimit: description: Set I/O bandwidth limit for various operations (in KiB/s). type: string comstar_hg: description: host group for comstar views type: string comstar_tg: description: target group for comstar views type: string content: description: | Allowed content types. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. format: pve-storage-content-list type: string content-dirs: description: Overrides for default content type directories. format: pve-dir-override-list type: string create-base-path: description: Create the base directory if it doesn't exist. type: boolean create-subdirs: description: Populate the directory with the default structure. type: boolean data-pool: description: Data Pool (for erasure coding only) type: string datastore: description: Proxmox Backup Server datastore name. type: string disable: description: Flag to disable the storage. type: boolean domain: description: CIFS domain. type: string encryption-key: description: Encryption key. Use 'autogen' to generate one automatically without passphrase. type: string export: description: NFS export path. format: pve-storage-path type: string fingerprint: description: Certificate SHA 256 fingerprint. type: string format: description: Default image format. enum: - raw - qcow2 - subvol - vmdk type: string fs-name: description: The Ceph filesystem name. format: pve-configid type: string fuse: description: Mount CephFS through FUSE. type: boolean is_mountpoint: description: Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. type: string iscsiprovider: description: iscsi provider type: string keyring: description: Client keyring contents (for external clusters). type: string krbd: description: Always access rbd through krbd kernel module. type: boolean lio_tpg: description: target portal group for Linux LIO targets type: string master-pubkey: description: Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. type: string max-protected-backups: description: Maximal number of protected backups per guest. Use '-1' for unlimited. type: integer mkdir: description: 'Create the directory if it doesn''t exist and populate it with default sub-dirs. NOTE: Deprecated, use the ''create-base-path'' and ''create-subdirs'' options instead.' type: boolean monhost: description: IP addresses of monitors (for external clusters). format: pve-storage-portal-dns-list type: string mountpoint: description: mount point format: pve-storage-path type: string namespace: description: Namespace. type: string nocow: description: Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. type: boolean nodes: description: List of nodes for which the storage configuration applies. format: pve-node-list type: string nowritecache: description: disable write caching on the target type: boolean options: description: NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') format: pve-storage-options type: string password: description: Password for accessing the share/datastore. type: string path: description: File system path. format: pve-storage-path type: string pool: description: Pool. type: string port: description: Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the 'options' option to configure the port via the mount options. type: integer portal: description: iSCSI portal (IP or DNS name with optional port). format: pve-storage-portal-dns type: string preallocation: description: Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. enum: - "off" - metadata - falloc - full type: string prune-backups: description: The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. format: prune-backups type: string saferemove: description: Zero-out data when removing LVs. type: boolean saferemove-stepsize: description: Wipe step size in MiB. It will be capped to the maximum supported by the storage. enum: - "1" - "2" - "4" - "8" - "16" - "32" type: integer saferemove_throughput: description: Wipe throughput (cstream -t parameter value). type: string server: description: Server IP or DNS name. format: pve-storage-server type: string share: description: CIFS share. type: string shared: description: Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! type: boolean skip-cert-verification: description: Disable TLS certificate verification, only enable on fully trusted networks! type: boolean smbversion: description: SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. enum: - default - "2.0" - "2.1" - "3" - "3.0" - "3.11" type: string snapshot-as-volume-chain: description: Enable support for creating storage-vendor agnostic snapshot through volume backing-chains. type: boolean sparse: description: use sparse volumes type: boolean storage: description: The storage identifier. format: pve-storage-id type: string subdir: description: Subdir to mount. format: pve-storage-path type: string tagged_only: description: Only list logical volumes tagged with 'pve-vm-ID'. type: boolean target: description: iSCSI target. type: string thinpool: description: LVM thin pool LV name. format: pve-storage-vgname type: string type: description: Storage type. enum: - btrfs - cephfs - cifs - dir - esxi - iscsi - iscsidirect - lvm - lvmthin - nfs - pbs - rbd - zfs - zfspool type: string username: description: RBD Id. type: string vgname: description: Volume group name. format: pve-storage-vgname type: string zfs-base-path: description: Base path where to look for the created ZFS block devices. Set automatically during creation if not specified. Usually '/dev/zvol'. format: pve-storage-path type: string type: object responses: "200": content: application/json: schema: properties: config: description: Partial, possibly server generated, configuration properties. properties: encryption-key: description: The, possibly auto-generated, encryption-key. type: string type: object storage: description: The ID of the created storage. type: string type: description: The type of the created storage. enum: - btrfs - cephfs - cifs - dir - esxi - iscsi - iscsidirect - lvm - lvmthin - nfs - pbs - rbd - zfs - zfspool type: string type: object description: OK summary: Create a new storage. /storage/{storage}: delete: operationId: delete_storage_storage parameters: - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string responses: "200": content: application/json: schema: nullable: true type: object description: OK summary: Delete storage configuration. get: operationId: get_storage_storage parameters: - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string responses: "200": content: application/json: schema: type: object description: OK summary: Read storage configuration. put: operationId: put_storage_storage parameters: - description: ZFS block size in: query name: blocksize required: false schema: description: ZFS block size format: pve-storage-zfs-blocksize type: string - description: Set I/O bandwidth limit for various operations (in KiB/s). in: query name: bwlimit required: false schema: description: Set I/O bandwidth limit for various operations (in KiB/s). type: string - description: host group for comstar views in: query name: comstar_hg required: false schema: description: host group for comstar views type: string - description: target group for comstar views in: query name: comstar_tg required: false schema: description: target group for comstar views type: string - description: | Allowed content types. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. in: query name: content required: false schema: description: | Allowed content types. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. format: pve-storage-content-list type: string - description: Overrides for default content type directories. in: query name: content-dirs required: false schema: description: Overrides for default content type directories. format: pve-dir-override-list type: string - description: Create the base directory if it doesn't exist. in: query name: create-base-path required: false schema: description: Create the base directory if it doesn't exist. type: boolean - description: Populate the directory with the default structure. in: query name: create-subdirs required: false schema: description: Populate the directory with the default structure. type: boolean - description: Data Pool (for erasure coding only) in: query name: data-pool required: false schema: description: Data Pool (for erasure coding only) type: string - description: A list of settings you want to delete. in: query name: delete required: false schema: description: A list of settings you want to delete. format: pve-configid-list type: string - description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. in: query name: digest required: false schema: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string - description: Flag to disable the storage. in: query name: disable required: false schema: description: Flag to disable the storage. type: boolean - description: CIFS domain. in: query name: domain required: false schema: description: CIFS domain. type: string - description: Encryption key. Use 'autogen' to generate one automatically without passphrase. in: query name: encryption-key required: false schema: description: Encryption key. Use 'autogen' to generate one automatically without passphrase. type: string - description: Certificate SHA 256 fingerprint. in: query name: fingerprint required: false schema: description: Certificate SHA 256 fingerprint. type: string - description: Default image format. in: query name: format required: false schema: description: Default image format. enum: - raw - qcow2 - subvol - vmdk type: string - description: The Ceph filesystem name. in: query name: fs-name required: false schema: description: The Ceph filesystem name. format: pve-configid type: string - description: Mount CephFS through FUSE. in: query name: fuse required: false schema: description: Mount CephFS through FUSE. type: boolean - description: Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. in: query name: is_mountpoint required: false schema: description: Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. type: string - description: Client keyring contents (for external clusters). in: query name: keyring required: false schema: description: Client keyring contents (for external clusters). type: string - description: Always access rbd through krbd kernel module. in: query name: krbd required: false schema: description: Always access rbd through krbd kernel module. type: boolean - description: target portal group for Linux LIO targets in: query name: lio_tpg required: false schema: description: target portal group for Linux LIO targets type: string - description: Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. in: query name: master-pubkey required: false schema: description: Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. type: string - description: Maximal number of protected backups per guest. Use '-1' for unlimited. in: query name: max-protected-backups required: false schema: description: Maximal number of protected backups per guest. Use '-1' for unlimited. type: integer - description: 'Create the directory if it doesn''t exist and populate it with default sub-dirs. NOTE: Deprecated, use the ''create-base-path'' and ''create-subdirs'' options instead.' in: query name: mkdir required: false schema: description: 'Create the directory if it doesn''t exist and populate it with default sub-dirs. NOTE: Deprecated, use the ''create-base-path'' and ''create-subdirs'' options instead.' type: boolean - description: IP addresses of monitors (for external clusters). in: query name: monhost required: false schema: description: IP addresses of monitors (for external clusters). format: pve-storage-portal-dns-list type: string - description: mount point in: query name: mountpoint required: false schema: description: mount point format: pve-storage-path type: string - description: Namespace. in: query name: namespace required: false schema: description: Namespace. type: string - description: Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. in: query name: nocow required: false schema: description: Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. type: boolean - description: List of nodes for which the storage configuration applies. in: query name: nodes required: false schema: description: List of nodes for which the storage configuration applies. format: pve-node-list type: string - description: disable write caching on the target in: query name: nowritecache required: false schema: description: disable write caching on the target type: boolean - description: NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') in: query name: options required: false schema: description: NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') format: pve-storage-options type: string - description: Password for accessing the share/datastore. in: query name: password required: false schema: description: Password for accessing the share/datastore. type: string - description: Pool. in: query name: pool required: false schema: description: Pool. type: string - description: Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the 'options' option to configure the port via the mount options. in: query name: port required: false schema: description: Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the 'options' option to configure the port via the mount options. type: integer - description: Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. in: query name: preallocation required: false schema: description: Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. enum: - "off" - metadata - falloc - full type: string - description: The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. in: query name: prune-backups required: false schema: description: The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. format: prune-backups type: string - description: Zero-out data when removing LVs. in: query name: saferemove required: false schema: description: Zero-out data when removing LVs. type: boolean - description: Wipe step size in MiB. It will be capped to the maximum supported by the storage. in: query name: saferemove-stepsize required: false schema: description: Wipe step size in MiB. It will be capped to the maximum supported by the storage. enum: - "1" - "2" - "4" - "8" - "16" - "32" type: integer - description: Wipe throughput (cstream -t parameter value). in: query name: saferemove_throughput required: false schema: description: Wipe throughput (cstream -t parameter value). type: string - description: Server IP or DNS name. in: query name: server required: false schema: description: Server IP or DNS name. format: pve-storage-server type: string - description: Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! in: query name: shared required: false schema: description: Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! type: boolean - description: Disable TLS certificate verification, only enable on fully trusted networks! in: query name: skip-cert-verification required: false schema: description: Disable TLS certificate verification, only enable on fully trusted networks! type: boolean - description: SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. in: query name: smbversion required: false schema: description: SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. enum: - default - "2.0" - "2.1" - "3" - "3.0" - "3.11" type: string - description: Enable support for creating storage-vendor agnostic snapshot through volume backing-chains. in: query name: snapshot-as-volume-chain required: false schema: description: Enable support for creating storage-vendor agnostic snapshot through volume backing-chains. type: boolean - description: use sparse volumes in: query name: sparse required: false schema: description: use sparse volumes type: boolean - description: The storage identifier. in: path name: storage required: true schema: description: The storage identifier. format: pve-storage-id type: string - description: Subdir to mount. in: query name: subdir required: false schema: description: Subdir to mount. format: pve-storage-path type: string - description: Only list logical volumes tagged with 'pve-vm-ID'. in: query name: tagged_only required: false schema: description: Only list logical volumes tagged with 'pve-vm-ID'. type: boolean - description: RBD Id. in: query name: username required: false schema: description: RBD Id. type: string - description: Base path where to look for the created ZFS block devices. Set automatically during creation if not specified. Usually '/dev/zvol'. in: query name: zfs-base-path required: false schema: description: Base path where to look for the created ZFS block devices. Set automatically during creation if not specified. Usually '/dev/zvol'. format: pve-storage-path type: string requestBody: content: application/json: schema: properties: blocksize: description: ZFS block size format: pve-storage-zfs-blocksize type: string bwlimit: description: Set I/O bandwidth limit for various operations (in KiB/s). type: string comstar_hg: description: host group for comstar views type: string comstar_tg: description: target group for comstar views type: string content: description: | Allowed content types. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. format: pve-storage-content-list type: string content-dirs: description: Overrides for default content type directories. format: pve-dir-override-list type: string create-base-path: description: Create the base directory if it doesn't exist. type: boolean create-subdirs: description: Populate the directory with the default structure. type: boolean data-pool: description: Data Pool (for erasure coding only) type: string delete: description: A list of settings you want to delete. format: pve-configid-list type: string digest: description: Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. type: string disable: description: Flag to disable the storage. type: boolean domain: description: CIFS domain. type: string encryption-key: description: Encryption key. Use 'autogen' to generate one automatically without passphrase. type: string fingerprint: description: Certificate SHA 256 fingerprint. type: string format: description: Default image format. enum: - raw - qcow2 - subvol - vmdk type: string fs-name: description: The Ceph filesystem name. format: pve-configid type: string fuse: description: Mount CephFS through FUSE. type: boolean is_mountpoint: description: Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. type: string keyring: description: Client keyring contents (for external clusters). type: string krbd: description: Always access rbd through krbd kernel module. type: boolean lio_tpg: description: target portal group for Linux LIO targets type: string master-pubkey: description: Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. type: string max-protected-backups: description: Maximal number of protected backups per guest. Use '-1' for unlimited. type: integer mkdir: description: 'Create the directory if it doesn''t exist and populate it with default sub-dirs. NOTE: Deprecated, use the ''create-base-path'' and ''create-subdirs'' options instead.' type: boolean monhost: description: IP addresses of monitors (for external clusters). format: pve-storage-portal-dns-list type: string mountpoint: description: mount point format: pve-storage-path type: string namespace: description: Namespace. type: string nocow: description: Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. type: boolean nodes: description: List of nodes for which the storage configuration applies. format: pve-node-list type: string nowritecache: description: disable write caching on the target type: boolean options: description: NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') format: pve-storage-options type: string password: description: Password for accessing the share/datastore. type: string pool: description: Pool. type: string port: description: Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the 'options' option to configure the port via the mount options. type: integer preallocation: description: Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. enum: - "off" - metadata - falloc - full type: string prune-backups: description: The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. format: prune-backups type: string saferemove: description: Zero-out data when removing LVs. type: boolean saferemove-stepsize: description: Wipe step size in MiB. It will be capped to the maximum supported by the storage. enum: - "1" - "2" - "4" - "8" - "16" - "32" type: integer saferemove_throughput: description: Wipe throughput (cstream -t parameter value). type: string server: description: Server IP or DNS name. format: pve-storage-server type: string shared: description: Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! type: boolean skip-cert-verification: description: Disable TLS certificate verification, only enable on fully trusted networks! type: boolean smbversion: description: SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. enum: - default - "2.0" - "2.1" - "3" - "3.0" - "3.11" type: string snapshot-as-volume-chain: description: Enable support for creating storage-vendor agnostic snapshot through volume backing-chains. type: boolean sparse: description: use sparse volumes type: boolean storage: description: The storage identifier. format: pve-storage-id type: string subdir: description: Subdir to mount. format: pve-storage-path type: string tagged_only: description: Only list logical volumes tagged with 'pve-vm-ID'. type: boolean username: description: RBD Id. type: string zfs-base-path: description: Base path where to look for the created ZFS block devices. Set automatically during creation if not specified. Usually '/dev/zvol'. format: pve-storage-path type: string type: object responses: "200": content: application/json: schema: properties: config: description: Partial, possibly server generated, configuration properties. properties: encryption-key: description: The, possibly auto-generated, encryption-key. type: string type: object storage: description: The ID of the created storage. type: string type: description: The type of the created storage. enum: - btrfs - cephfs - cifs - dir - esxi - iscsi - iscsidirect - lvm - lvmthin - nfs - pbs - rbd - zfs - zfspool type: string type: object description: OK summary: Update storage configuration. /version: get: operationId: get_version responses: "200": content: application/json: schema: properties: console: description: The default console viewer to use. enum: - applet - vv - html5 - xtermjs type: string release: description: The current Proxmox VE point release in `x.y` format. type: string repoid: description: The short git revision from which this version was build. type: string version: description: The full pve-manager package version of this node. type: string type: object description: OK summary: API version details, including some parts of the global datacenter config.