{"apiVersion":"1.0","apis":[{"path":"/vps","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"listVPS","httpMethod":"GET","parameters":[{"name":"iamTags","dataType":"map[string][]iam.resource.TagFilter","paramType":"query","required":false,"description":"Filter resources on IAM tags"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List your VPS","iamActions":[{"name":"vps:apiovh:get","required":true}]}],"description":""},{"path":"/vps/{serviceName}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVPS","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.VPSWithIAM","responseTypes":{"200":"vps.VPSWithIAM"},"noAuthentication":false,"description":"Get information about a specific VPS","iamActions":[{"name":"vps:apiovh:get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editVPS","httpMethod":"PUT","parameters":[{"dataType":"vps.VPS","paramType":"body","fullType":"vps.VPS","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Edit properties of the given VPS","iamActions":[{"name":"vps:apiovh:put","required":true}]}],"description":""},{"path":"/vps/{serviceName}/abortSnapshot","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"abortVpsSnapshot","httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Abort an ongoing snapshot or automated backup operation for this VPS","iamActions":[{"name":"vps:apiovh:abortSnapshot","required":true}]}],"description":""},{"path":"/vps/{serviceName}/automatedBackup","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsAutomatedBackup","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.AutomatedBackup","responseTypes":{"200":"vps.AutomatedBackup"},"noAuthentication":false,"description":"Retrieve automated backup settings for this VPS","iamActions":[{"name":"vps:apiovh:automatedBackup/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/automatedBackup/attachedBackup","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsAutomatedBackupAttached","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.automatedBackup.Attached[]","responseTypes":{"200":"vps.automatedBackup.Attached[]"},"noAuthentication":false,"description":"List backups currently attached to this VPS","iamActions":[{"name":"vps:apiovh:automatedBackup/attachedBackup/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/automatedBackup/detachBackup","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"detachVpsAutomatedBackup","httpMethod":"POST","parameters":[{"dataType":"vps.automatedBackup.detachBackup.post","paramType":"body","fullType":"vps.automatedBackup.detachBackup.post","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Unmount a restored backup from this VPS and return an asynchronous task","iamActions":[{"name":"vps:apiovh:automatedBackup/detachBackup","required":true}]}],"description":""},{"path":"/vps/{serviceName}/automatedBackup/reschedule","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"rescheduleVpsAutomatedBackup","httpMethod":"POST","parameters":[{"dataType":"vps.automatedBackup.reschedule.post","paramType":"body","fullType":"vps.automatedBackup.reschedule.post","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Change the scheduled time of the daily automated backup and return an asynchronous task","iamActions":[{"name":"vps:apiovh:automatedBackup/reschedule","required":true}]}],"description":""},{"path":"/vps/{serviceName}/automatedBackup/restore","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"restoreVpsAutomatedBackup","httpMethod":"POST","parameters":[{"dataType":"vps.automatedBackup.restore.post","paramType":"body","fullType":"vps.automatedBackup.restore.post","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Restore this VPS from a given restore point and return an asynchronous task","iamActions":[{"name":"vps:apiovh:automatedBackup/restore","required":true}]}],"description":""},{"path":"/vps/{serviceName}/automatedBackup/restorePoints","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsAutomatedBackupRestorePoints","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"state","dataType":"vps.RestoreStateEnum","paramType":"query","fullType":"vps.RestoreStateEnum","required":true,"description":"The state of the restore point"}],"responseType":"datetime[]","responseTypes":{"200":"datetime[]"},"noAuthentication":false,"description":"List available restore points for the automated backup","iamActions":[{"name":"vps:apiovh:automatedBackup/restorePoints/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/confirmTermination","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"confirmVpsTermination","httpMethod":"POST","parameters":[{"dataType":"services.confirmTermination","paramType":"body","fullType":"services.confirmTermination","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Confirm the termination of this VPS service","iamActions":[{"name":"vps:apiovh:confirmTermination","required":true}]}],"description":""},{"path":"/vps/{serviceName}/createSnapshot","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"createVpsSnapshot","httpMethod":"POST","parameters":[{"dataType":"vps.createSnapshot.post","paramType":"body","fullType":"vps.createSnapshot.post","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Create a snapshot of this VPS (requires the snapshot option and no existing snapshot); returns an asynchronous task","iamActions":[{"name":"vps:apiovh:snapshot/create","required":true}]}],"description":""},{"path":"/vps/{serviceName}/datacenter","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsDatacenter","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Datacenter","responseTypes":{"200":"vps.Datacenter"},"noAuthentication":false,"description":"Retrieve the datacenter information for this VPS","iamActions":[{"name":"vps:apiovh:datacenter/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/disks","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"listVpsDisks","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List disks attached to this VPS","iamActions":[{"name":"vps:apiovh:disks/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/disks/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsDisk","httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Disk","responseTypes":{"200":"vps.Disk"},"noAuthentication":false,"description":"Retrieve details about a specific disk attached to this VPS","iamActions":[{"name":"vps:apiovh:disks/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editVpsDisk","httpMethod":"PUT","parameters":[{"dataType":"vps.Disk","paramType":"body","fullType":"vps.Disk","required":true,"description":"Request Body"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update disk properties for this VPS","iamActions":[{"name":"vps:apiovh:disks/edit","required":true}]}],"description":""},{"path":"/vps/{serviceName}/disks/{id}/monitoring","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsDiskMonitoring","httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"period","dataType":"vps.VpsMonitoringPeriodEnum","paramType":"query","fullType":"vps.VpsMonitoringPeriodEnum","required":true,"description":"The period the statistics are fetched for"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"type","dataType":"vps.disk.StatisticTypeEnum","paramType":"query","fullType":"vps.disk.StatisticTypeEnum","required":true,"description":"The type of statistic to be fetched"}],"responseType":"complexType.UnitAndValues_vps.VpsTimestampValue","responseTypes":{"200":"complexType.UnitAndValues_vps.VpsTimestampValue"},"noAuthentication":false,"description":"Retrieve disk monitoring statistics for this VPS over a given period","iamActions":[{"name":"vps:apiovh:disks/monitoring/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/disks/{id}/use","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsDiskUsage","httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"type","dataType":"vps.disk.StatisticTypeEnum","paramType":"query","fullType":"vps.disk.StatisticTypeEnum","required":true,"description":"The type of statistic to be fetched"}],"responseType":"complexType.UnitAndValue_double","responseTypes":{"200":"complexType.UnitAndValue_double"},"noAuthentication":false,"description":"Retrieve current disk usage metrics for this VPS","iamActions":[{"name":"vps:apiovh:disks/use/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/distribution/software","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-10-15T00:00:00Z","deprecatedDate":"2026-07-15T00:00:00Z"},"operationId":"listVpsDistributionSoftwares","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List software available for the VPS distribution","iamActions":[{"name":"vps:apiovh:distribution/software/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/distribution/software/{softwareId}","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-10-15T00:00:00Z","deprecatedDate":"2026-07-15T00:00:00Z"},"operationId":"getVpsDistributionSoftware","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"softwareId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Software ID"}],"responseType":"vps.Software","responseTypes":{"200":"vps.Software"},"noAuthentication":false,"description":"Retrieve details about a specific software available for the VPS distribution","iamActions":[{"name":"vps:apiovh:distribution/software/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/getConsoleUrl","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsConsoleUrl","httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Generate and return a console access URL for this VPS","iamActions":[{"name":"vps:apiovh:getConsoleUrl","required":true}]}],"description":""},{"path":"/vps/{serviceName}/images/available","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"operationId":"listVpsAvailableImages","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List images available for this VPS","iamActions":[{"name":"vps:apiovh:images/available/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/images/available/{id}","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"operationId":"getVpsAvailableImage","httpMethod":"GET","parameters":[{"name":"id","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Image","responseTypes":{"200":"vps.Image"},"noAuthentication":false,"description":"Retrieve details about a specific image available for this VPS","iamActions":[{"name":"vps:apiovh:images/available/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/images/current","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"operationId":"getVpsCurrentImage","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Image","responseTypes":{"200":"vps.Image"},"noAuthentication":false,"description":"Retrieve the currently installed image on this VPS","iamActions":[{"name":"vps:apiovh:images/current/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/ipCountryAvailable","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsIpCountryAvailable","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.ip.GeolocationEnum[]","responseTypes":{"200":"vps.ip.GeolocationEnum[]"},"noAuthentication":false,"description":"List the available countries for IP geolocation (GeoIP) on this VPS","iamActions":[{"name":"vps:apiovh:ipCountryAvailable/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/ips","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"listVpsIps","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"ip[]","responseTypes":{"200":"ip[]"},"noAuthentication":false,"description":"List IPs attached to this VPS","iamActions":[{"name":"vps:apiovh:ips/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/ips/{ipAddress}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"deleteVpsIp","httpMethod":"DELETE","parameters":[{"name":"ipAddress","dataType":"ip","paramType":"path","fullType":"ip","required":true,"description":"Ip address"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Release an additional IP attached to this VPS","iamActions":[{"name":"vps:apiovh:ips/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsIp","httpMethod":"GET","parameters":[{"name":"ipAddress","dataType":"ip","paramType":"path","fullType":"ip","required":true,"description":"Ip address"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Ip","responseTypes":{"200":"vps.Ip"},"noAuthentication":false,"description":"Retrieve details about a specific IP attached to this VPS","iamActions":[{"name":"vps:apiovh:ips/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editVpsIp","httpMethod":"PUT","parameters":[{"dataType":"vps.Ip","paramType":"body","fullType":"vps.Ip","required":true,"description":"Request Body"},{"name":"ipAddress","dataType":"ip","paramType":"path","fullType":"ip","required":true,"description":"Ip address"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update IP properties for this VPS","iamActions":[{"name":"vps:apiovh:ips/edit","required":true}]}],"description":""},{"path":"/vps/{serviceName}/migration2020","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"cancelVpsMigration2020","httpMethod":"DELETE","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Cancel the migration request from VPS 2020 to VPS 2025","iamActions":[{"name":"vps:apiovh:migration2020/create","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsMigration2020","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.migration.VPS2020to2025","responseTypes":{"200":"vps.migration.VPS2020to2025"},"noAuthentication":false,"description":"Retrieve information about the possible/ongoing migration from VPS 2020 to VPS 2025","iamActions":[{"name":"vps:apiovh:migration2020/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"createVpsMigration2020","httpMethod":"POST","parameters":[{"dataType":"vps.migration.VPS2020to2025.Post","paramType":"body","fullType":"vps.migration.VPS2020to2025.Post","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.migration.VPS2020to2025","responseTypes":{"200":"vps.migration.VPS2020to2025"},"noAuthentication":false,"description":"Request to be queued for migration from VPS 2020 to VPS 2025","iamActions":[{"name":"vps:apiovh:migration2020/create","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editVpsMigration2020","httpMethod":"PUT","parameters":[{"dataType":"vps.migration.VPS2020to2025.Put","paramType":"body","fullType":"vps.migration.VPS2020to2025.Put","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.migration.VPS2020to2025","responseTypes":{"200":"vps.migration.VPS2020to2025"},"noAuthentication":false,"description":"Update migration parameters for the VPS 2020 to VPS 2025 migration","iamActions":[{"name":"vps:apiovh:migration2020/create","required":true}]}],"description":""},{"path":"/vps/{serviceName}/option","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"listVpsOptions","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.VpsOptionEnum[]","responseTypes":{"200":"vps.VpsOptionEnum[]"},"noAuthentication":false,"description":"List options attached to this VPS","iamActions":[{"name":"vps:apiovh:option/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/option/{option}","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-12-25T00:00:00Z","deprecatedDate":"2023-12-22T00:00:00Z"},"operationId":"deleteVpsOption","httpMethod":"DELETE","parameters":[{"name":"deleteNow","dataType":"boolean","paramType":"query","fullType":"boolean","required":false,"description":"Delete option now, don't wait for expiration"},{"name":"option","dataType":"vps.VpsOptionEnum","paramType":"path","fullType":"vps.VpsOptionEnum","required":true,"description":"Option"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Release an option attached to this VPS (deprecated)","iamActions":[{"name":"vps:apiovh:option/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsOption","httpMethod":"GET","parameters":[{"name":"option","dataType":"vps.VpsOptionEnum","paramType":"path","fullType":"vps.VpsOptionEnum","required":true,"description":"Option"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Option","responseTypes":{"200":"vps.Option"},"noAuthentication":false,"description":"Retrieve details about a specific option attached to this VPS","iamActions":[{"name":"vps:apiovh:option/get","required":true}]}],"description":""},{"path":"/vps/order/rule/datacenter","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"listVpsOrderDatacentersRule","httpMethod":"GET","parameters":[{"name":"os","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"VPS OS selection in order api"},{"name":"ovhSubsidiary","dataType":"nichandle.OvhSubsidiaryEnum","paramType":"query","fullType":"nichandle.OvhSubsidiaryEnum","required":true,"description":"Subsidiary to sort datacenters"},{"name":"planCode","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"VPS plan code from order api"}],"responseType":"vps.order.rule.Datacenters","responseTypes":{"200":"vps.order.rule.Datacenters"},"noAuthentication":true,"description":"List datacenters with priority and stock status for a VPS order"}],"description":""},{"path":"/vps/order/rule/datacenter/aggregated","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"listVpsOrderAggregatedDatacentersRule","httpMethod":"GET","parameters":[{"name":"ovhSubsidiary","dataType":"nichandle.OvhSubsidiaryEnum","paramType":"query","fullType":"nichandle.OvhSubsidiaryEnum","required":true,"description":"Subsidiary to sort datacenters"},{"name":"planCodes","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"Comma separated VPS plan codes from order api to answer for"}],"responseType":"vps.order.rule.AggregatedDatacenters","responseTypes":{"200":"vps.order.rule.AggregatedDatacenters"},"noAuthentication":true,"description":"List datacenters with priority and stock status for every VPS model and storage option"}],"description":""},{"path":"/vps/order/rule/osChoices","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"listVpsOrderOsChoicesRule","httpMethod":"GET","parameters":[{"name":"datacenter","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"VPS datacenter"},{"name":"os","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"VPS OS selection in order api"}],"responseType":"vps.order.rule.OSChoices","responseTypes":{"200":"vps.order.rule.OSChoices"},"noAuthentication":true,"description":"List OS choices and availability status for a VPS order"}],"description":""},{"path":"/vps/{serviceName}/reboot","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"rebootVps","httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Request a reboot of the VPS","iamActions":[{"name":"vps:apiovh:reboot","required":true}]}],"description":""},{"path":"/vps/{serviceName}/rebuild","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"operationId":"rebuildVps","httpMethod":"POST","parameters":[{"dataType":"vps.rebuild.post","paramType":"body","fullType":"vps.rebuild.post","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Rebuild (reinstall) this VPS and return an asynchronous task","iamActions":[{"name":"vps:apiovh:rebuild","required":true}]}],"description":""},{"path":"/vps/{serviceName}/secondaryDnsDomains","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"listVpsSecondaryDnsDomains","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List domains configured on secondary DNS for this VPS","iamActions":[{"name":"vps:apiovh:secondaryDnsDomains/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"createVpsSecondaryDnsDomain","httpMethod":"POST","parameters":[{"dataType":"vps.secondaryDnsDomains.post","paramType":"body","fullType":"vps.secondaryDnsDomains.post","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Add a domain to the secondary DNS configuration","iamActions":[{"name":"vps:apiovh:secondaryDnsDomains/create","required":true}]}],"description":""},{"path":"/vps/{serviceName}/secondaryDnsDomains/{domain}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"deleteVpsSecondaryDnsDomain","httpMethod":"DELETE","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Remove this domain from the secondary DNS configuration","iamActions":[{"name":"vps:apiovh:secondaryDnsDomains/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsSecondaryDnsDomain","httpMethod":"GET","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"secondaryDns.SecondaryDNS","responseTypes":{"200":"secondaryDns.SecondaryDNS"},"noAuthentication":false,"description":"Retrieve the secondary DNS configuration for a specific domain","iamActions":[{"name":"vps:apiovh:secondaryDnsDomains/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/secondaryDnsDomains/{domain}/dnsServer","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsSecondaryDnsNameServer","httpMethod":"GET","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"secondaryDns.SecondaryDNSNameServer","responseTypes":{"200":"secondaryDns.SecondaryDNSNameServer"},"noAuthentication":false,"description":"Retrieve the authoritative name server information for this secondary DNS domain","iamActions":[{"name":"vps:apiovh:secondaryDnsDomains/dnsServer/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/secondaryDnsNameServerAvailable","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsSecondaryDnsNameServerAvailable","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"secondaryDns.SecondaryDNSNameServer","responseTypes":{"200":"secondaryDns.SecondaryDNSNameServer"},"noAuthentication":false,"description":"Retrieve the secondary DNS name server available for this VPS","iamActions":[{"name":"vps:apiovh:secondaryDnsNameServerAvailable/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/serviceInfos","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsServiceInfos","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Retrieve the service information for this VPS","iamActions":[{"name":"vps:apiovh:serviceInfos/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editVpsServiceInfos","httpMethod":"PUT","parameters":[{"dataType":"services.Service","paramType":"body","fullType":"services.Service","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update the service information for this VPS","iamActions":[{"name":"vps:apiovh:serviceInfos/edit","required":true}]}],"description":""},{"path":"/vps/{serviceName}/snapshot","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"deleteVpsSnapshot","httpMethod":"DELETE","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Delete the VPS snapshot and return an asynchronous task","iamActions":[{"name":"vps:apiovh:snapshot/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsSnapshot","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Snapshot","responseTypes":{"200":"vps.Snapshot"},"noAuthentication":false,"description":"Retrieve information about the current VPS snapshot","iamActions":[{"name":"vps:apiovh:snapshot/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"editVpsSnapshot","httpMethod":"PUT","parameters":[{"dataType":"vps.Snapshot","paramType":"body","fullType":"vps.Snapshot","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update the VPS snapshot properties","iamActions":[{"name":"vps:apiovh:snapshot/edit","required":true}]}],"description":""},{"path":"/vps/{serviceName}/snapshot/download","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"downloadVpsSnapshot","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.DownloadSnapshotURL","responseTypes":{"200":"vps.DownloadSnapshotURL"},"noAuthentication":false,"description":"Generate a download URL for the VPS snapshot","iamActions":[{"name":"vps:apiovh:snapshot/download/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/snapshot/revert","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"revertVpsSnapshot","httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Revert this VPS to the specified snapshot and return an asynchronous task","iamActions":[{"name":"vps:apiovh:snapshot/revert","required":true}]}],"description":""},{"path":"/vps/{serviceName}/start","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"startVps","httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Start the VPS (power on) and return an asynchronous task","iamActions":[{"name":"vps:apiovh:start","required":true}]}],"description":""},{"path":"/vps/{serviceName}/stop","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"stopVps","httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Stop the VPS (power off) and return an asynchronous task","iamActions":[{"name":"vps:apiovh:stop","required":true}]}],"description":""},{"path":"/vps/{serviceName}/tasks","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"listVpsTasks","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"state","dataType":"vps.TaskStateEnum","paramType":"query","fullType":"vps.TaskStateEnum","required":false,"description":"Filter the value of state property (=)"},{"name":"type","dataType":"vps.TaskTypeEnum","paramType":"query","fullType":"vps.TaskTypeEnum","required":false,"description":"Filter the value of type property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List tasks associated with this VPS","iamActions":[{"name":"vps:apiovh:tasks/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/tasks/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"getVpsTask","httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Retrieve details about a specific task for this VPS","iamActions":[{"name":"vps:apiovh:tasks/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/templates/{id}/software","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-10-15T00:00:00Z","deprecatedDate":"2026-07-15T00:00:00Z"},"operationId":"listVpsTemplateSoftwares","httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List software available for the given VPS template","iamActions":[{"name":"vps:apiovh:templates/software/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/templates/{id}/software/{softwareId}","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-10-15T00:00:00Z","deprecatedDate":"2026-07-15T00:00:00Z"},"operationId":"getVpsTemplateSoftware","httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"softwareId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Software ID"}],"responseType":"vps.Software","responseTypes":{"200":"vps.Software"},"noAuthentication":false,"description":"Retrieve details about a specific software available for a VPS template","iamActions":[{"name":"vps:apiovh:templates/software/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/terminate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"operationId":"terminateVps","httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Request termination of this VPS service","iamActions":[{"name":"vps:apiovh:terminate","required":true}]}],"description":""},{"path":"/vps/{serviceName}/veeam/restorePoints","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-10-15T00:00:00Z","deprecatedDate":"2026-07-15T00:00:00Z"},"operationId":"listVpsVeeamRestorePoints","httpMethod":"GET","parameters":[{"name":"creationTime","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationTime property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List Veeam restore points available for this VPS","iamActions":[{"name":"vps:apiovh:veeam/restorePoints/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/veeam/restorePoints/{id}","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-10-15T00:00:00Z","deprecatedDate":"2026-07-15T00:00:00Z"},"operationId":"getVpsVeeamRestorePoint","httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.veeam.RestorePoint","responseTypes":{"200":"vps.veeam.RestorePoint"},"noAuthentication":false,"description":"Retrieve details about a specific Veeam restore point for this VPS","iamActions":[{"name":"vps:apiovh:veeam/restorePoints/get","required":true}]}],"description":""},{"path":"/vps/{serviceName}/veeam/restorePoints/{id}/restore","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-10-15T00:00:00Z","deprecatedDate":"2026-07-15T00:00:00Z"},"operationId":"restoreVpsVeeamRestorePoint","httpMethod":"POST","parameters":[{"dataType":"vps.veeam.restorePoints.restore.post","paramType":"body","fullType":"vps.veeam.restorePoints.restore.post","required":true,"description":"Request Body"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Restore this VPS from a Veeam restore point and return an asynchronous task","iamActions":[{"name":"vps:apiovh:veeam/restorePoints/restore","required":true}]}],"description":""},{"path":"/vps/{serviceName}/veeam/restoredBackup","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-10-15T00:00:00Z","deprecatedDate":"2026-07-15T00:00:00Z"},"operationId":"deleteVpsVeeamRestoredBackup","httpMethod":"DELETE","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.Task","responseTypes":{"200":"vps.Task"},"noAuthentication":false,"description":"Unmount the restored Veeam backup from this VPS and return an asynchronous task","iamActions":[{"name":"vps:apiovh:veeam/restoredBackup/delete","required":true}]},{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-10-15T00:00:00Z","deprecatedDate":"2026-07-15T00:00:00Z"},"operationId":"getVpsVeeamRestoredBackup","httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"vps.veeam.RestoredBackup","responseTypes":{"200":"vps.veeam.RestoredBackup"},"noAuthentication":false,"description":"Retrieve information about the currently restored Veeam backup","iamActions":[{"name":"vps:apiovh:veeam/restoredBackup/get","required":true}]}],"description":""}],"resourcePath":"/vps","basePath":"https://api.us.ovhcloud.com/1.0","models":{"complexType.SafeKeyValueCanBeNull_string":{"id":"SafeKeyValueCanBeNull_string","namespace":"complexType","description":"complexType.SafeKeyValueCanBeNull_string","properties":{"key":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"required":false},"value":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false}}},"complexType.UnitAndValue_double":{"id":"UnitAndValue_double","namespace":"complexType","description":"complexType.UnitAndValue_double","properties":{"unit":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"value":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"required":false}}},"complexType.UnitAndValue_long":{"id":"UnitAndValue_long","namespace":"complexType","description":"complexType.UnitAndValue_long","properties":{"unit":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"value":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false}}},"complexType.UnitAndValues_vps.VpsTimestampValue":{"id":"VpsTimestampValue","namespace":"complexType.UnitAndValues_vps","description":"complexType.UnitAndValues_vps.VpsTimestampValue","properties":{"unit":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"values":{"type":"vps.VpsTimestampValue[]","fullType":"vps.VpsTimestampValue[]","canBeNull":false,"readOnly":true,"required":false}}},"coreTypes.CountryEnum":{"id":"CountryEnum","namespace":"coreTypes","description":"ISO country codes","enum":["ac","ad","ae","af","ag","ai","al","am","an","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cs","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fc","fd","fi","fj","fk","fm","fo","fr","fx","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gs","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","qc","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sj","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tp","tr","tt","tv","tw","tz","ua","ug","uk","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","we","wf","ws","ye","yt","yu","za","zm","zw"],"enumType":"string"},"coreTypes.IpVersionEnum":{"id":"IpVersionEnum","namespace":"coreTypes","description":"Ip versions","enum":["v4","v6"],"enumType":"string"},"dedicated.TaskFunctionEnum":{"id":"TaskFunctionEnum","namespace":"dedicated","description":"different task operation","enum":["INFRA_002_VirtualNetworkInterface","INFRA_002_VirtualNetworkInterface_group","INFRA_002_VirtualNetworkInterface_ungroup","INFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_group","INFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroup","INFRA_ONE_NETWORK_VirtualNetworkInterface_group","INFRA_ONE_NETWORK_VirtualNetworkInterface_ungroup","addVirtualMac","addWindowSplaFromExistingSerial","applyBackupFtpAcls","applyBackupFtpQuota","bypassAntiDDosGame","changePasswordBackupFTP","changeRipeOrg","checkAndReleaseIp","createBackupFTP","createOrUpdateRipeOrg","createPrivateNetwork","disableFirewall","enableFirewall","genericMoveFloatingIp","hardReboot","hardware_update","ipmi/configureSGX","migrateBackupFTP","moveFloatingIp","moveVirtualMac","reagregateBlock","rebootPower8To","reinstallServer","releaseIp","removeBackupFTP","removeVirtualMac","requestAccessIPMI","resetIPMI","resetIPMISession","testIPMIhttp","testIPMIpassword","testIPMIping","virtualMacAdd","virtualMacDelete"],"enumType":"string"},"dedicated.TaskStatusEnum":{"id":"TaskStatusEnum","namespace":"dedicated","description":"different task status","enum":["cancelled","customerError","doing","done","init","ovhError","todo"],"enumType":"string"},"dedicated.server.BackupFtpAcl":{"id":"BackupFtpAcl","namespace":"dedicated.server","description":"Backup Ftp ACL for this server and Backup Ftp","properties":{"cifs":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Whether to allow the CIFS (SMB) protocol for this ACL","required":false},"ftp":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Whether to allow the FTP protocol for this ACL","required":false},"ipBlock":{"type":"ipBlock","fullType":"ipBlock","canBeNull":false,"readOnly":true,"description":"The IP Block specific to this ACL","required":false},"isApplied":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the rule has been applied on the Backup Ftp","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date of the last object modification","required":false},"nfs":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Whether to allow the NFS protocol for this ACL","required":false}}},"dedicated.server.Task":{"id":"Task","namespace":"dedicated.server","description":"Server tasks","properties":{"comment":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Details of this task","required":false},"doneDate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Completion date","required":false},"function":{"type":"dedicated.TaskFunctionEnum","fullType":"dedicated.TaskFunctionEnum","canBeNull":false,"readOnly":true,"description":"Function name","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"last update","required":false},"needSchedule":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether this task need to be scheduled or not","required":false},"note":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Extra information about this task","required":false},"plannedInterventionId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"ID of the planned intervention for this task","required":false},"startDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Task Creation date","required":false},"status":{"type":"dedicated.TaskStatusEnum","fullType":"dedicated.TaskStatusEnum","canBeNull":false,"readOnly":true,"description":"Task status","required":false},"tags":{"type":"complexType.SafeKeyValueCanBeNull_string[]","fullType":"complexType.SafeKeyValueCanBeNull_string[]","canBeNull":true,"readOnly":true,"description":"Task result tags output","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"the id of the task","required":false},"ticketReference":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Reference of the thread on the support tool","required":false}}},"iam.ResourceMetadata":{"id":"ResourceMetadata","namespace":"iam","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Resource display name","required":false},"id":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Unique identifier of the resource","required":false},"state":{"type":"iam.ResourceMetadata.StateEnum","fullType":"iam.ResourceMetadata.StateEnum","canBeNull":true,"readOnly":true,"description":"Resource state","required":false},"tags":{"type":"map[string]string","fullType":"map[string]string","canBeNull":true,"readOnly":true,"description":"Resource tags. Tags that were internally computed are prefixed with ovh:","required":false},"urn":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Unique resource name used in policies","required":false}}},"iam.ResourceMetadata.StateEnum":{"id":"StateEnum","namespace":"iam.ResourceMetadata","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"],"enumType":"string"},"iam.resource.TagFilter":{"id":"TagFilter","namespace":"iam.resource","description":"Resource tag filter","properties":{"operator":{"type":"iam.resource.TagFilter.OperatorEnum","fullType":"iam.resource.TagFilter.OperatorEnum","canBeNull":true,"readOnly":true,"description":"Operator to use in order to filter on the value (defaults to 'EQ')","required":false},"value":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Value to use in order to filter tags","required":false}}},"iam.resource.TagFilter.OperatorEnum":{"id":"OperatorEnum","namespace":"iam.resource.TagFilter","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"],"enumType":"string"},"nichandle.OvhSubsidiaryEnum":{"id":"OvhSubsidiaryEnum","namespace":"nichandle","description":"OVH subsidiaries","enum":["ASIA","AU","CA","CZ","DE","ES","EU","FI","FR","GB","IE","IT","LT","MA","NL","PL","PT","QC","SG","SN","TN","US","WE","WS"],"enumType":"string"},"secondaryDns.SecondaryDNS":{"id":"SecondaryDNS","namespace":"secondaryDns","description":"Secondary dns infos","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"required":false},"dns":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"secondary dns server","required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"domain on slave server","required":false},"ipMaster":{"type":"ipv4","fullType":"ipv4","canBeNull":false,"readOnly":true,"description":"IPv4 address (e.g., 192.0.2.0)","required":false}}},"secondaryDns.SecondaryDNSNameServer":{"id":"SecondaryDNSNameServer","namespace":"secondaryDns","description":"A structure describing informations about available nameserver for secondary dns ","properties":{"hostname":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"the name server","required":false},"ip":{"type":"ipv4","fullType":"ipv4","canBeNull":false,"readOnly":true,"description":"IPv4 address (e.g., 192.0.2.0)","required":false},"ipv6":{"type":"ipv6","fullType":"ipv6","canBeNull":true,"readOnly":true,"required":false}}},"service.RenewType":{"id":"RenewType","namespace":"service","description":"Map a possible renew for a specific service","properties":{"automatic":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"The service is automatically renewed","required":false},"deleteAtExpiration":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"The service will be deleted at expiration","required":false},"forced":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"The service forced to be renewed","required":false},"manualPayment":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"The service needs to be manually renewed and paid","required":false},"period":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"period of renew in month","required":false}}},"service.RenewalTypeEnum":{"id":"RenewalTypeEnum","namespace":"service","description":"Detailed renewal type of a service","enum":["automaticForcedProduct","automaticV2012","automaticV2014","automaticV2016","manual","oneShot","option"],"enumType":"string"},"service.StateEnum":{"id":"StateEnum","namespace":"service","description":"service.StateEnum","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"],"enumType":"string"},"service.TerminationFutureUseEnum":{"id":"TerminationFutureUseEnum","namespace":"service","description":"All future uses you can provide for a service termination","enum":["NOT_REPLACING_SERVICE","OTHER","SUBSCRIBE_AN_OTHER_SERVICE","SUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITOR","SUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITOR"],"enumType":"string"},"service.TerminationReasonEnum":{"id":"TerminationReasonEnum","namespace":"service","description":"All reasons you can provide for a service termination","enum":["FEATURES_DONT_SUIT_ME","LACK_OF_PERFORMANCES","MIGRATED_TO_ANOTHER_OVH_PRODUCT","MIGRATED_TO_COMPETITOR","NOT_ENOUGH_RECOGNITION","NOT_NEEDED_ANYMORE","NOT_RELIABLE","NO_ANSWER","OTHER","PRODUCT_DIMENSION_DONT_SUIT_ME","PRODUCT_TOOLS_DONT_SUIT_ME","TOO_EXPENSIVE","TOO_HARD_TO_USE","UNSATIFIED_BY_CUSTOMER_SUPPORT"],"enumType":"string"},"services.Service":{"id":"Service","namespace":"services","description":"Details about a Service","properties":{"canDeleteAtExpiration":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Indicates that the service can be set up to be deleted at expiration","required":false},"contactAdmin":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"contactBilling":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"contactTech":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"creation":{"type":"date","fullType":"date","canBeNull":false,"readOnly":true,"required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"engagedUpTo":{"type":"date","fullType":"date","canBeNull":true,"readOnly":true,"required":false},"expiration":{"type":"date","fullType":"date","canBeNull":false,"readOnly":true,"required":false},"possibleRenewPeriod":{"type":"long[]","fullType":"long[]","canBeNull":true,"readOnly":true,"description":"All the possible renew period of your service in month","required":false},"renew":{"type":"service.RenewType","fullType":"service.RenewType","canBeNull":true,"readOnly":false,"description":"Way of handling the renew","required":false},"renewalType":{"type":"service.RenewalTypeEnum","fullType":"service.RenewalTypeEnum","canBeNull":false,"readOnly":true,"required":false},"serviceId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"status":{"type":"service.StateEnum","fullType":"service.StateEnum","canBeNull":false,"readOnly":true,"required":false}}},"services.confirmTermination":{"id":"confirmTermination","namespace":"services","description":"Service confirm termination payload","properties":{"commentary":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Commentary about your termination request","required":false},"commentaryFutureUse":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Commentary about your future use","required":false},"commentaryReason":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Commentary about your reason for termination request","required":false},"futureUse":{"type":"service.TerminationFutureUseEnum","fullType":"service.TerminationFutureUseEnum","canBeNull":false,"readOnly":false,"description":"All future uses you can provide for a service termination","required":false},"reason":{"type":"service.TerminationReasonEnum","fullType":"service.TerminationReasonEnum","canBeNull":false,"readOnly":false,"description":"All reasons you can provide for a service termination","required":false},"token":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"The termination token sent by email to the admin contact","required":true}}},"vps.AutomatedBackup":{"id":"AutomatedBackup","namespace":"vps","description":"Backup your VPS","properties":{"rotation":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Number of rotation of your daily backup","required":false},"schedule":{"type":"time","fullType":"time","canBeNull":true,"readOnly":true,"description":"Scheduled time of your daily backup","required":false},"serviceResourceName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Resource name of the service of your automated backup","required":false},"state":{"type":"vps.BackupStateEnum","fullType":"vps.BackupStateEnum","canBeNull":false,"readOnly":true,"description":"Backup state","required":false}}},"vps.BackupFtp":{"id":"BackupFtp","namespace":"vps","description":"Backup Ftp assigned to this VPS","properties":{"ftpBackupName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The backup FTP server name","required":false},"quota":{"type":"complexType.UnitAndValue_long","fullType":"complexType.UnitAndValue_long","canBeNull":true,"readOnly":true,"description":"The disk space available on your backup FTP","required":false},"readOnlyDate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"If not-null, gives the date since when your account was set in read-only mode because the quota was exceeded","required":false},"type":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The backup FTP type","required":false},"usage":{"type":"complexType.UnitAndValue_long","fullType":"complexType.UnitAndValue_long","canBeNull":true,"readOnly":true,"description":"The disk space currently used on your backup FTP","required":false}}},"vps.BackupStateEnum":{"id":"BackupStateEnum","namespace":"vps","description":"Available AutomatedBackup states","enum":["disabled","enabled"],"enumType":"string"},"vps.Datacenter":{"id":"Datacenter","namespace":"vps","description":"Information about a datacenter of a VPS Virtual Machine","properties":{"country":{"type":"coreTypes.CountryEnum","fullType":"coreTypes.CountryEnum","canBeNull":false,"readOnly":true,"description":"Datacenter ISO country code","required":false},"longName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Datacenter display name","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Datacenter name","required":false}}},"vps.Disk":{"id":"Disk","namespace":"vps","description":"Information about a disk of a VPS Virtual Machine","properties":{"bandwidthLimit":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"lowFreeSpaceThreshold":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"The low disk free space threshold in MiB","required":false},"monitoring":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"The monitoring state of this disk","required":false},"serviceName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Service name","required":false},"size":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"state":{"type":"vps.disk.StateEnum","fullType":"vps.disk.StateEnum","canBeNull":false,"readOnly":true,"required":false},"type":{"type":"vps.disk.TypeEnum","fullType":"vps.disk.TypeEnum","canBeNull":false,"readOnly":true,"required":false}}},"vps.DownloadSnapshotURL":{"id":"DownloadSnapshotURL","namespace":"vps","description":"URL to download the VPS snapshot","properties":{"size":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Snapshot size (bytes)","required":false},"url":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"URL to download the snapshot","required":false}}},"vps.Image":{"id":"Image","namespace":"vps","description":"Installation image for a VPS","properties":{"id":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false}}},"vps.Ip":{"id":"Ip","namespace":"vps","description":"Information about an IP address for a VPS Virtual Machine","properties":{"gateway":{"type":"ip","fullType":"ip","canBeNull":true,"readOnly":true,"required":false},"geolocation":{"type":"vps.ip.GeolocationEnum","fullType":"vps.ip.GeolocationEnum","canBeNull":false,"readOnly":true,"required":false},"ipAddress":{"type":"ip","fullType":"ip","canBeNull":false,"readOnly":true,"description":"The effective ip address of the Ip object","required":false},"macAddress":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"required":false},"reverse":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"required":false},"type":{"type":"vps.ip.TypeEnum","fullType":"vps.ip.TypeEnum","canBeNull":false,"readOnly":true,"required":false},"version":{"type":"coreTypes.IpVersionEnum","fullType":"coreTypes.IpVersionEnum","canBeNull":false,"readOnly":true,"required":false}}},"vps.LockReasonEnum":{"id":"LockReasonEnum","namespace":"vps","description":"Reasons why a VPS might be locked","enum":["abuse"],"enumType":"string"},"vps.LockStatus":{"id":"LockStatus","namespace":"vps","description":"A structure describing the lock status of a VPS","properties":{"locked":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Indicates whether the VPS is locked","required":false},"reason":{"type":"vps.LockReasonEnum","fullType":"vps.LockReasonEnum","canBeNull":false,"readOnly":true,"description":"The reason for the lock","required":false}}},"vps.Model":{"id":"Model","namespace":"vps","description":"A structure describing characteristics of a VPS model","properties":{"availableOptions":{"type":"vps.VpsOptionEnum[]","fullType":"vps.VpsOptionEnum[]","canBeNull":false,"readOnly":false,"required":false},"datacenter":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":false,"required":false},"disk":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"required":false},"diskLocationType":{"type":"vps.disk.LocationTypeEnum","fullType":"vps.disk.LocationTypeEnum","canBeNull":false,"readOnly":true,"required":false},"maximumAdditionnalIp":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"required":false},"memory":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"required":false},"offer":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"required":false},"vcore":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"required":false},"version":{"type":"vps.VpsVersionEnum","fullType":"vps.VpsVersionEnum","canBeNull":false,"readOnly":false,"description":"All versions that VPS can have","required":false}}},"vps.Option":{"id":"Option","namespace":"vps","description":"Information about the options of a VPS Virtual Machine","properties":{"option":{"type":"vps.VpsOptionEnum","fullType":"vps.VpsOptionEnum","canBeNull":false,"readOnly":true,"description":"The option name","required":false},"state":{"type":"vps.VpsOptionStateEnum","fullType":"vps.VpsOptionStateEnum","canBeNull":false,"readOnly":true,"description":"The state of the option","required":false}}},"vps.RestoreStateEnum":{"id":"RestoreStateEnum","namespace":"vps","description":"Available restore state","enum":["available","restored","restoring"],"enumType":"string"},"vps.RestoreTypeEnum":{"id":"RestoreTypeEnum","namespace":"vps","description":"Available restore types","enum":["file","full"],"enumType":"string"},"vps.Snapshot":{"id":"Snapshot","namespace":"vps","description":"Information about the snapshot of a VPS Virtual Machine","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"required":false},"description":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"required":false},"id":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"region":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"required":false}}},"vps.Software":{"id":"Software","namespace":"vps","description":"Available softwares on a Template","properties":{"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"status":{"type":"vps.SoftwareStatusEnum","fullType":"vps.SoftwareStatusEnum","canBeNull":false,"readOnly":true,"required":false},"type":{"type":"vps.SoftwareTypeEnum","fullType":"vps.SoftwareTypeEnum","canBeNull":false,"readOnly":true,"required":false}}},"vps.SoftwareStatusEnum":{"id":"SoftwareStatusEnum","namespace":"vps","description":"Available Status for a vps Software","enum":["deprecated","stable","testing"],"enumType":"string"},"vps.SoftwareTypeEnum":{"id":"SoftwareTypeEnum","namespace":"vps","description":"Available Type for a vps Software","enum":["database","environment","webserver"],"enumType":"string"},"vps.Task":{"id":"Task","namespace":"vps","description":"Operation on a VPS Virtual Machine","properties":{"date":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"progress":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"state":{"type":"vps.TaskStateEnum","fullType":"vps.TaskStateEnum","canBeNull":false,"readOnly":true,"required":false},"type":{"type":"vps.TaskTypeEnum","fullType":"vps.TaskTypeEnum","canBeNull":false,"readOnly":true,"required":false}}},"vps.TaskStateEnum":{"id":"TaskStateEnum","namespace":"vps","description":"All states a VPS task can be in","enum":["blocked","cancelled","doing","done","error","paused","todo","waitingAck"],"enumType":"string"},"vps.TaskTypeEnum":{"id":"TaskTypeEnum","namespace":"vps","description":"All type a VPS task can be","enum":["addVeeamBackupJob","changeRootPassword","createSnapshot","deleteSnapshot","deliverVm","getConsoleUrl","internalTask","migrate","openConsoleAccess","provisioningAdditionalIp","reOpenVm","rebootVm","reinstallVm","removeVeeamBackup","rescheduleAutoBackup","restoreFullVeeamBackup","restoreVeeamBackup","restoreVm","revertSnapshot","setMonitoring","setNetboot","startVm","stopVm","upgradeVm"],"enumType":"string"},"vps.Template":{"id":"Template","namespace":"vps","description":"Installation template for a VPS Virtual Machine","properties":{"availableLanguage":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"required":false},"bitFormat":{"type":"vps.TemplateBitFormatEnum","fullType":"vps.TemplateBitFormatEnum","canBeNull":false,"readOnly":true,"required":false},"distribution":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"locale":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false}}},"vps.TemplateBitFormatEnum":{"id":"TemplateBitFormatEnum","namespace":"vps","description":"Bitness of a VPS template","enum":[32,64],"enumType":"long"},"vps.VPS":{"id":"VPS","namespace":"vps","description":"VPS Virtual Machine","properties":{"cluster":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"displayName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Set the name displayed in ManagerV6 for your VPS (max 50 chars)","required":false},"keymap":{"type":"vps.VpsKeymapEnum","fullType":"vps.VpsKeymapEnum","canBeNull":true,"readOnly":false,"description":"Set KVM keyboard layout on VPS Cloud. Reboot your VPS after change","required":false},"lockStatus":{"type":"vps.LockStatus","fullType":"vps.LockStatus","canBeNull":false,"readOnly":true,"description":"Lock status of the VPS","required":false},"memoryLimit":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"model":{"type":"vps.Model","fullType":"vps.Model","canBeNull":false,"readOnly":true,"required":false},"monitoringIpBlocks":{"type":"ipBlock[]","fullType":"ipBlock[]","canBeNull":false,"readOnly":true,"description":"Ip blocks for OVH monitoring servers","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"netbootMode":{"type":"vps.VpsNetbootEnum","fullType":"vps.VpsNetbootEnum","canBeNull":false,"readOnly":false,"description":"All values a VPS netboot mode can be in","required":false},"offerType":{"type":"vps.VpsOfferEnum","fullType":"vps.VpsOfferEnum","canBeNull":false,"readOnly":true,"required":false},"slaMonitoring":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"required":false},"state":{"type":"vps.VpsStateEnum","fullType":"vps.VpsStateEnum","canBeNull":false,"readOnly":true,"required":false},"vcore":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"zone":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"zoneType":{"type":"vps.ZoneTypeEnum","fullType":"vps.ZoneTypeEnum","canBeNull":false,"readOnly":true,"required":false}}},"vps.VPSWithIAM":{"id":"VPS","namespace":"vps","description":"VPS Virtual Machine","properties":{"cluster":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"displayName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Set the name displayed in ManagerV6 for your VPS (max 50 chars)","required":false},"iam":{"type":"iam.ResourceMetadata","canBeNull":true,"readOnly":true,"description":"IAM resource metadata","required":false},"keymap":{"type":"vps.VpsKeymapEnum","fullType":"vps.VpsKeymapEnum","canBeNull":true,"readOnly":false,"description":"Set KVM keyboard layout on VPS Cloud. Reboot your VPS after change","required":false},"lockStatus":{"type":"vps.LockStatus","fullType":"vps.LockStatus","canBeNull":false,"readOnly":true,"description":"Lock status of the VPS","required":false},"memoryLimit":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"model":{"type":"vps.Model","fullType":"vps.Model","canBeNull":false,"readOnly":true,"required":false},"monitoringIpBlocks":{"type":"ipBlock[]","fullType":"ipBlock[]","canBeNull":false,"readOnly":true,"description":"Ip blocks for OVH monitoring servers","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"netbootMode":{"type":"vps.VpsNetbootEnum","fullType":"vps.VpsNetbootEnum","canBeNull":false,"readOnly":false,"description":"All values a VPS netboot mode can be in","required":false},"offerType":{"type":"vps.VpsOfferEnum","fullType":"vps.VpsOfferEnum","canBeNull":false,"readOnly":true,"required":false},"slaMonitoring":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"required":false},"state":{"type":"vps.VpsStateEnum","fullType":"vps.VpsStateEnum","canBeNull":false,"readOnly":true,"required":false},"vcore":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"zone":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"zoneType":{"type":"vps.ZoneTypeEnum","fullType":"vps.ZoneTypeEnum","canBeNull":false,"readOnly":true,"required":false}}},"vps.Veeam":{"id":"Veeam","namespace":"vps","description":"Informations about a VPS Veeam backups","properties":{"backup":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Backup state","required":false}}},"vps.Vnc":{"id":"Vnc","namespace":"vps","description":"A VNC connection informations","properties":{"host":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"password":{"type":"password","fullType":"password","canBeNull":false,"readOnly":true,"required":false},"port":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false}}},"vps.VncProtocolEnum":{"id":"VncProtocolEnum","namespace":"vps","description":"All supported VNC protocols by VPS","enum":["VNC","VNCOverWebSocket"],"enumType":"string"},"vps.VpsBillingVersion":{"id":"VpsBillingVersion","namespace":"vps","description":"VPS billing version","properties":{"version":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false}}},"vps.VpsKeymapEnum":{"id":"VpsKeymapEnum","namespace":"vps","description":"All values keymap can be in","enum":["fr","us"],"enumType":"string"},"vps.VpsMonitoringPeriodEnum":{"id":"VpsMonitoringPeriodEnum","namespace":"vps","description":"Available periods for the VPS monitoring","enum":["lastday","lastmonth","lastweek","lastyear","today"],"enumType":"string"},"vps.VpsNetbootEnum":{"id":"VpsNetbootEnum","namespace":"vps","description":"All values a VPS netboot mode can be in","enum":["distant","local","rescue"],"enumType":"string"},"vps.VpsOfferEnum":{"id":"VpsOfferEnum","namespace":"vps","description":"All offers a VPS can have","enum":["beta-classic","classic","cloud","cloudram","game-classic","lowlat","ssd"],"enumType":"string"},"vps.VpsOptionEnum":{"id":"VpsOptionEnum","namespace":"vps","description":"All options a VPS can have","enum":["additionalDisk","automatedBackup","cpanel","ftpbackup","plesk","snapshot","veeam","windows"],"enumType":"string"},"vps.VpsOptionStateEnum":{"id":"VpsOptionStateEnum","namespace":"vps","description":"All states a VPS Option can be in","enum":["released","subscribed"],"enumType":"string"},"vps.VpsStateEnum":{"id":"VpsStateEnum","namespace":"vps","description":"All states a VPS can be in","enum":["backuping","installing","maintenance","rebooting","rescued","running","stopped","stopping","upgrading"],"enumType":"string"},"vps.VpsTimestampValue":{"id":"VpsTimestampValue","namespace":"vps","description":"A timestamp associated to a value","properties":{"timestamp":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"value":{"type":"double","fullType":"double","canBeNull":true,"readOnly":true,"required":false}}},"vps.VpsVersionEnum":{"id":"VpsVersionEnum","namespace":"vps","description":"All versions that VPS can have","enum":["2013v1","2014v1","2015v1","2017v1","2017v2","2017v3","2018v1","2018v2","2019v1","2025v1"],"enumType":"string"},"vps.ZoneTypeEnum":{"id":"ZoneTypeEnum","namespace":"vps","description":"Enum values for zone type","enum":["localzone","region"],"enumType":"string"},"vps.automatedBackup.Attached":{"id":"Attached","namespace":"vps.automatedBackup","description":"A backup attached to your VPS","properties":{"access":{"type":"vps.automatedBackup.attached.Infos","fullType":"vps.automatedBackup.attached.Infos","canBeNull":false,"readOnly":true,"description":"A structure describing a backup's access informations","required":false},"restorePoint":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"required":false}}},"vps.automatedBackup.attached.Infos":{"id":"Infos","namespace":"vps.automatedBackup.attached","description":"A structure describing a backup's access informations","properties":{"additionalDisk":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Additional Disk details","required":false},"nfs":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"NFS URL of the backup","required":false},"smb":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"SMB URL of the backup","required":false}}},"vps.automatedBackup.detachBackup.post":{"id":"post","namespace":"vps.automatedBackup.detachBackup","description":"vps.automatedBackup.detachBackup.post","properties":{"restorePoint":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":false,"description":"restorePoint fetched in /vps/{serviceName}/automatedBackup/attachedBackup","required":true}}},"vps.automatedBackup.reschedule.post":{"id":"post","namespace":"vps.automatedBackup.reschedule","description":"vps.automatedBackup.reschedule.post","properties":{"schedule":{"type":"time","fullType":"time","canBeNull":false,"readOnly":false,"description":"Time (e.g., 15:04:05)","required":true}}},"vps.automatedBackup.restore.post":{"id":"post","namespace":"vps.automatedBackup.restore","description":"vps.automatedBackup.restore.post","properties":{"changePassword":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Only with restore full on VPS Cloud 2014","required":false},"restorePoint":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":false,"description":"Restore Point fetched in /automatedBackup/restorePoints","required":true},"type":{"type":"vps.RestoreTypeEnum","fullType":"vps.RestoreTypeEnum","canBeNull":false,"readOnly":false,"description":"Available restore types","required":true}}},"vps.backupftp.access.post":{"id":"post","namespace":"vps.backupftp.access","description":"vps.backupftp.access.post","properties":{"cifs":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Whether to allow the CIFS (SMB) protocol for this ACL","required":true},"ftp":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Whether to allow the FTP protocol for this ACL","required":false},"ipBlock":{"type":"ipBlock","fullType":"ipBlock","canBeNull":false,"readOnly":false,"description":"IP CIDR notation (e.g., 192.0.2.0/24)","required":true},"nfs":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Whether to allow the NFS protocol for this ACL","required":true}}},"vps.createSnapshot.post":{"id":"post","namespace":"vps.createSnapshot","description":"vps.createSnapshot.post","properties":{"description":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"A textual description for your snapshot","required":false}}},"vps.disk.LocationTypeEnum":{"id":"LocationTypeEnum","namespace":"vps.disk","description":"Possible location type a disk can have","enum":["distant","local"],"enumType":"string"},"vps.disk.StateEnum":{"id":"StateEnum","namespace":"vps.disk","description":"Possible states the disk can be in","enum":["connected","disconnected","pending"],"enumType":"string"},"vps.disk.StatisticTypeEnum":{"id":"StatisticTypeEnum","namespace":"vps.disk","description":"Available types for the Disk monitoring and use","enum":["max","used"],"enumType":"string"},"vps.disk.TypeEnum":{"id":"TypeEnum","namespace":"vps.disk","description":"Possible type a disk can be in","enum":["additional","primary"],"enumType":"string"},"vps.ip.GeolocationEnum":{"id":"GeolocationEnum","namespace":"vps.ip","description":"Geolocation of the IP Address","enum":["at","au","be","ca","ch","cz","de","es","fi","fr","gb","ie","in","it","lt","nl","pl","pt","sg","uk","us"],"enumType":"string"},"vps.ip.ServiceStatus":{"id":"ServiceStatus","namespace":"vps.ip","description":"Service states for an Ip","properties":{"dns":{"type":"vps.ip.ServiceStatusService","fullType":"vps.ip.ServiceStatusService","canBeNull":false,"readOnly":true,"description":"Port and state of a service on an IP","required":false},"http":{"type":"vps.ip.ServiceStatusService","fullType":"vps.ip.ServiceStatusService","canBeNull":false,"readOnly":true,"description":"Port and state of a service on an IP","required":false},"https":{"type":"vps.ip.ServiceStatusService","fullType":"vps.ip.ServiceStatusService","canBeNull":false,"readOnly":true,"description":"Port and state of a service on an IP","required":false},"ping":{"type":"vps.ip.ServiceStatusStateEnum","fullType":"vps.ip.ServiceStatusStateEnum","canBeNull":false,"readOnly":true,"description":"Possible states of a service (ping, port)","required":false},"smtp":{"type":"vps.ip.ServiceStatusService","fullType":"vps.ip.ServiceStatusService","canBeNull":false,"readOnly":true,"description":"Port and state of a service on an IP","required":false},"ssh":{"type":"vps.ip.ServiceStatusService","fullType":"vps.ip.ServiceStatusService","canBeNull":false,"readOnly":true,"description":"Port and state of a service on an IP","required":false},"tools":{"type":"vps.ip.ServiceStatusStateEnum","fullType":"vps.ip.ServiceStatusStateEnum","canBeNull":true,"readOnly":true,"required":false}}},"vps.ip.ServiceStatusService":{"id":"ServiceStatusService","namespace":"vps.ip","description":"Port and state of a service on an IP","properties":{"port":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"state":{"type":"vps.ip.ServiceStatusStateEnum","fullType":"vps.ip.ServiceStatusStateEnum","canBeNull":false,"readOnly":true,"description":"Possible states of a service (ping, port)","required":false}}},"vps.ip.ServiceStatusStateEnum":{"id":"ServiceStatusStateEnum","namespace":"vps.ip","description":"Possible states of a service (ping, port)","enum":["down","up"],"enumType":"string"},"vps.ip.TypeEnum":{"id":"TypeEnum","namespace":"vps.ip","description":"Ip types on a VPS","enum":["additional","primary"],"enumType":"string"},"vps.migration.DatacenterEnum":{"id":"DatacenterEnum","namespace":"vps.migration","description":"All datacenter of vps migration","enum":["BHS","DE","GRA","SBG","SGP","SYD","UK","WAW"],"enumType":"string"},"vps.migration.OptionMapping2016":{"id":"OptionMapping2016","namespace":"vps.migration","description":"Mapping between a VPS 2016 option code and a VPS 2020 option code","properties":{"currentPlan":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"VPS option current plan code","required":false},"newPlan":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"New VPS option plan code after migration","required":false},"options":{"type":"vps.migration.OptionOptionMapping2016[]","fullType":"vps.migration.OptionOptionMapping2016[]","canBeNull":false,"readOnly":true,"description":"Mapping of VPS options of option from VPS 2016 to VPS 2020","required":false},"product":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"VPS option product","required":false}}},"vps.migration.OptionOptionMapping2016":{"id":"OptionOptionMapping2016","namespace":"vps.migration","description":"Mapping between a VPS 2016 option code and a VPS 2020 option code","properties":{"currentPlan":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"VPS option current plan code","required":false},"newPlan":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"New VPS option plan code after migration","required":false},"product":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"VPS option product","required":false}}},"vps.migration.StatusEnum":{"id":"StatusEnum","namespace":"vps.migration","description":"All status a migration task can be in","enum":["available","done","notAvailable","ongoing","planned","toPlan"],"enumType":"string"},"vps.migration.VPS2018to2020":{"id":"VPS2018to2020","namespace":"vps.migration","description":"A structure describing a migration from VPS 2016/2018 to VPS 2020","properties":{"datacenter":{"type":"vps.migration.DatacenterEnum","fullType":"vps.migration.DatacenterEnum","canBeNull":false,"readOnly":true,"description":"All datacenter of vps migration","required":false},"date":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Migration start date","required":false},"plans":{"type":"vps.migration.VPS2018to2020Plan[]","fullType":"vps.migration.VPS2018to2020Plan[]","canBeNull":false,"readOnly":true,"description":"List of available plans to migrate","required":false},"status":{"type":"vps.migration.StatusEnum","fullType":"vps.migration.StatusEnum","canBeNull":false,"readOnly":true,"description":"All status a migration task can be in","required":false}}},"vps.migration.VPS2018to2020Plan":{"id":"VPS2018to2020Plan","namespace":"vps.migration","description":"A structure describing a migration plan from VPS 2016/2018 to VPS 2020","properties":{"currentPlan":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"VPS current plan code","required":false},"newPlan":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"New VPS plan code after migration","required":false},"options":{"type":"vps.migration.OptionMapping2016[]","fullType":"vps.migration.OptionMapping2016[]","canBeNull":false,"readOnly":true,"description":"Mapping of VPS options from VPS 2016 to VPS 2020","required":false},"product":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"VPS product","required":false}}},"vps.migration.VPS2020to2025":{"id":"VPS2020to2025","namespace":"vps.migration","description":"A structure describing a migration from VPS 2020 to VPS 2025","properties":{"availablePlans":{"type":"vps.migration.VPS2020to2025Plan[]","fullType":"vps.migration.VPS2020to2025Plan[]","canBeNull":false,"readOnly":true,"description":"List of available plans to migrate","required":false},"currentPlan":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"VPS current plan code","required":false},"date":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Date of planned migration, null if not scheduled","required":false},"position":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Position on the migration queue, null if not in queue","required":false},"status":{"type":"vps.migration.StatusEnum","fullType":"vps.migration.StatusEnum","canBeNull":false,"readOnly":true,"description":"All status a migration task can be in","required":false},"targetPlan":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"VPS target plan code after migration","required":false}}},"vps.migration.VPS2020to2025.Post":{"id":"Post","namespace":"vps.migration.VPS2020to2025","description":"A structure describing inputs to migrate from VPS 2020 to VPS 2025","properties":{"plan":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"VPS target plan code","required":true}}},"vps.migration.VPS2020to2025.Put":{"id":"Put","namespace":"vps.migration.VPS2020to2025","description":"A structure describing inputs to manage migration from VPS 2020 to VPS 2025","properties":{"date":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":false,"description":"Date of migration. Use current date to trigger migration as soon as possible.","required":false}}},"vps.migration.VPS2020to2025Plan":{"id":"VPS2020to2025Plan","namespace":"vps.migration","description":"A structure describing a migration plan from VPS 2020 to VPS 2025","properties":{"planCode":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"VPS plan code available for migration","required":false}}},"vps.migration2018.post":{"id":"post","namespace":"vps.migration2018","description":"vps.migration2018.post","properties":{"newPlan":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Choosen plan for migration","required":true}}},"vps.openConsoleAccess.post":{"id":"post","namespace":"vps.openConsoleAccess","description":"vps.openConsoleAccess.post","properties":{"protocol":{"type":"vps.VncProtocolEnum","fullType":"vps.VncProtocolEnum","canBeNull":false,"readOnly":false,"description":"All supported VNC protocols by VPS","required":false}}},"vps.order.rule.AggregatedDatacenters":{"id":"AggregatedDatacenters","namespace":"vps.order.rule","description":"Datacenters rules of every VPS model","properties":{"models":{"type":"vps.order.rule.ModelDatacenters[]","fullType":"vps.order.rule.ModelDatacenters[]","canBeNull":false,"readOnly":true,"description":"Datacenters rules of every requested VPS model","required":false}}},"vps.order.rule.Datacenter":{"id":"Datacenter","namespace":"vps.order.rule","description":"Datacenter rules","properties":{"code":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"datacenter":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"daysBeforeDelivery":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"linuxStatus":{"type":"vps.order.rule.DatacenterStatusEnum","fullType":"vps.order.rule.DatacenterStatusEnum","canBeNull":false,"readOnly":true,"required":false},"status":{"type":"vps.order.rule.DatacenterStatusEnum","fullType":"vps.order.rule.DatacenterStatusEnum","canBeNull":false,"readOnly":true,"required":false},"windowsStatus":{"type":"vps.order.rule.DatacenterStatusEnum","fullType":"vps.order.rule.DatacenterStatusEnum","canBeNull":false,"readOnly":true,"required":false}}},"vps.order.rule.DatacenterStatusEnum":{"id":"DatacenterStatusEnum","namespace":"vps.order.rule","description":"Possible values for datacenter status","enum":["available","out-of-stock","out-of-stock-preorder-allowed"],"enumType":"string"},"vps.order.rule.Datacenters":{"id":"Datacenters","namespace":"vps.order.rule","description":"Datacenters rules","properties":{"datacenters":{"type":"vps.order.rule.Datacenter[]","fullType":"vps.order.rule.Datacenter[]","canBeNull":false,"readOnly":true,"required":false}}},"vps.order.rule.ModelDatacenter":{"id":"ModelDatacenter","namespace":"vps.order.rule","description":"Datacenter rules of one VPS model, for one way of delivering it","properties":{"code":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Datacenter code to give to order api","required":false},"datacenter":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of the datacenter","required":false},"daysBeforeDelivery":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of days before delivery, for a preorder","required":false},"linuxStatus":{"type":"vps.order.rule.DatacenterStatusEnum","fullType":"vps.order.rule.DatacenterStatusEnum","canBeNull":false,"readOnly":true,"description":"Stock status of the datacenter for a Linux delivery","required":false},"remoteStorage":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether these rules apply to the model delivered with remote storage","required":false},"status":{"type":"vps.order.rule.DatacenterStatusEnum","fullType":"vps.order.rule.DatacenterStatusEnum","canBeNull":false,"readOnly":true,"description":"Stock status of the datacenter for any distribution","required":false},"windowsStatus":{"type":"vps.order.rule.DatacenterStatusEnum","fullType":"vps.order.rule.DatacenterStatusEnum","canBeNull":false,"readOnly":true,"description":"Stock status of the datacenter for a Windows delivery","required":false}}},"vps.order.rule.ModelDatacenters":{"id":"ModelDatacenters","namespace":"vps.order.rule","description":"Datacenters rules of one VPS model","properties":{"datacenters":{"type":"vps.order.rule.ModelDatacenter[]","fullType":"vps.order.rule.ModelDatacenter[]","canBeNull":false,"readOnly":true,"description":"Datacenters rules of the model, one entry per datacenter and way of delivering it","required":false},"planCode":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"VPS plan code from order api these rules apply to","required":false}}},"vps.order.rule.OSChoice":{"id":"OSChoice","namespace":"vps.order.rule","description":"OS choice rules","properties":{"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"status":{"type":"vps.order.rule.OSChoiceStatusEnum","fullType":"vps.order.rule.OSChoiceStatusEnum","canBeNull":false,"readOnly":true,"required":false}}},"vps.order.rule.OSChoiceStatusEnum":{"id":"OSChoiceStatusEnum","namespace":"vps.order.rule","description":"Possible values for OS choice status","enum":["available","checked-by-default","unavailable"],"enumType":"string"},"vps.order.rule.OSChoices":{"id":"OSChoices","namespace":"vps.order.rule","description":"OS choices rules","properties":{"choices":{"type":"vps.order.rule.OSChoice[]","fullType":"vps.order.rule.OSChoice[]","canBeNull":false,"readOnly":true,"required":false}}},"vps.rebuild.post":{"id":"post","namespace":"vps.rebuild","description":"vps.rebuild.post","properties":{"doNotSendPassword":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"If asked, the installation password will NOT be sent (only if sshKey defined)","required":false},"imageId":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Id of the vps.Image fetched in /images list","required":true},"installRTM":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"If asked, RTM will be installed on your VPS","required":false},"postInstallScript":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Bash script run once on first boot after reinstall","required":false},"publicSshKey":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Public SSH key to pre-install on your VPS","required":false},"sshKey":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"SSH key name to pre-install on your VPS (name from /me/sshKey)","required":false}}},"vps.reinstall.post":{"id":"post","namespace":"vps.reinstall","description":"vps.reinstall.post","properties":{"doNotSendPassword":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"If asked, the installation password will NOT be sent (only if sshKey defined)","required":false},"language":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Distribution language. default : en","required":false},"publicSshKey":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Public SSH key to pre-install on your VPS","required":false},"softwareId":{"type":"long[]","fullType":"long[]","canBeNull":false,"readOnly":false,"description":"Id of the vps.Software type fetched in /template/{id}/software","required":false},"sshKey":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":false,"description":"SSH key names to pre-install on your VPS (name from /me/sshKey)","required":false},"templateId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"description":"Id of the vps.Template fetched in /templates list","required":true}}},"vps.secondaryDnsDomains.post":{"id":"post","namespace":"vps.secondaryDnsDomains","description":"vps.secondaryDnsDomains.post","properties":{"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"The domain to add","required":true},"ip":{"type":"ipv4","fullType":"ipv4","canBeNull":false,"readOnly":false,"description":"IPv4 address (e.g., 192.0.2.0)","required":false}}},"vps.veeam.ExportTypeEnum":{"id":"ExportTypeEnum","namespace":"vps.veeam","description":"A structure describing a Veeam backup's export options","enum":["nfs","smb"],"enumType":"string"},"vps.veeam.Infos":{"id":"Infos","namespace":"vps.veeam","description":"A structure describing a Veeam backup's access informations","properties":{"nfs":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"NFS URL of the backup","required":false},"smb":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"SMB URL of the backup","required":false}}},"vps.veeam.RestorePoint":{"id":"RestorePoint","namespace":"vps.veeam","description":"Informations about a VPS Veeam restore points","properties":{"creationTime":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"The restore point's creation time","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"The restore point's id","required":false}}},"vps.veeam.RestoredBackup":{"id":"RestoredBackup","namespace":"vps.veeam","description":"Currently restored backup","properties":{"accessInfos":{"type":"vps.veeam.Infos","fullType":"vps.veeam.Infos","canBeNull":false,"readOnly":true,"description":"Backup access informations","required":false},"restorePointId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"The restore point id","required":false},"state":{"type":"vps.veeam.StateEnum","fullType":"vps.veeam.StateEnum","canBeNull":false,"readOnly":true,"description":"The restored backup state","required":false}}},"vps.veeam.StateEnum":{"id":"StateEnum","namespace":"vps.veeam","description":"A structure describing a Veeam restored backup's state","enum":["mounted","restoring","unmounted","unmounting"],"enumType":"string"},"vps.veeam.restorePoints.restore.post":{"id":"post","namespace":"vps.veeam.restorePoints.restore","description":"vps.veeam.restorePoints.restore.post","properties":{"changePassword":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"(Full only) Change the restored VPS root password when done","required":false},"export":{"type":"vps.veeam.ExportTypeEnum","fullType":"vps.veeam.ExportTypeEnum","canBeNull":false,"readOnly":false,"description":"A structure describing a Veeam backup's export options","required":false},"full":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Replace your current VPS by the restorePoint","required":true}}}}}