{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"complexType.SafeKeyValueCanBeNull_string":{"type":"object","description":"Key and value, with proper key strings","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string"}}},"complexType.UnitAndValue_long":{"type":"object","description":"A numeric value tagged with its unit","properties":{"unit":{"type":"string"},"value":{"type":"integer"}}},"complexType.UnitAndValue_string":{"type":"object","description":"A numeric value tagged with its unit","properties":{"unit":{"type":"string"},"value":{"type":"string"}}},"dedicated.TaskFunctionEnum":{"type":"string","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"]},"dedicated.TaskStatusEnum":{"type":"string","description":"different task status","enum":["cancelled","customerError","doing","done","init","ovhError","todo"]},"dedicated.TemplateOsHardwareRaidEnum":{"type":"string","description":"Hardware RAID enum","enum":["raid0","raid1","raid10","raid5","raid50","raid6","raid60"]},"dedicated.TemplateOsInfo":{"type":"object","description":"A structure describing some interesting facts about an OS template","properties":{"category":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsUsageEnum"}],"description":"OS Category (also called OS usage)"},"description":{"type":"string","description":"OS long name"},"endOfInstall":{"type":"string","description":"OS template end of install at OVH date","nullable":true,"format":"date"},"family":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsTypeEnum"}],"description":"OS family (also called OS type)"},"license":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsInfoLicense"}],"description":"OS template license details","nullable":true},"project":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsInfoProject"}],"description":"OS template project details","nullable":true},"subfamily":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsSubfamilyEnum"}],"description":"OS subfamily"},"templateName":{"type":"string","description":"OS template name"}}},"dedicated.TemplateOsInfoLicense":{"type":"object","description":"A structure describing some interesting facts about an OS template licensing","properties":{"os":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsInfoLicenseItem"}],"description":"OS template license OS details","nullable":true},"usage":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsInfoLicenseItem"}],"description":"OS template license usage details","nullable":true}}},"dedicated.TemplateOsInfoLicenseItem":{"type":"object","description":"A structure describing some interesting facts about an OS template license item","properties":{"name":{"type":"array","description":"OS template license item names","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.TemplateOsInfoLicenseItemEnum"}},"url":{"type":"string","description":"OS template license item url","nullable":true}}},"dedicated.TemplateOsInfoLicenseItemEnum":{"type":"string","description":"Standard license name according to SPDX","enum":["0BSD","AAL","ADSL","AFL-1.1","AFL-1.2","AFL-2.0","AFL-2.1","AFL-3.0","AGPL-1.0-only","AGPL-1.0-or-later","AGPL-3.0-only","AGPL-3.0-or-later","AMDPLPA","AML","AMPAS","ANTLR-PD","ANTLR-PD-fallback","APAFML","APL-1.0","APSL-1.0","APSL-1.1","APSL-1.2","APSL-2.0","Abstyles","Adobe-2006","Adobe-Glyph","Afmparse","Aladdin","Apache-1.0","Apache-1.1","Apache-2.0","Artistic-1.0","Artistic-1.0-Perl","Artistic-1.0-cl8","Artistic-2.0","BSD-1-Clause","BSD-2-Clause","BSD-2-Clause-Patent","BSD-2-Clause-Views","BSD-3-Clause","BSD-3-Clause-Attribution","BSD-3-Clause-Clear","BSD-3-Clause-LBNL","BSD-3-Clause-Modification","BSD-3-Clause-No-Nuclear-License","BSD-3-Clause-No-Nuclear-License-2014","BSD-3-Clause-No-Nuclear-Warranty","BSD-3-Clause-Open-MPI","BSD-4-Clause","BSD-4-Clause-Shortened","BSD-4-Clause-UC","BSD-Protection","BSD-Source-Code","BSL-1.0","BUSL-1.1","Bahyph","Barr","Beerware","BitTorrent-1.0","BitTorrent-1.1","BlueOak-1.0.0","Borceux","C-UDA-1.0","CAL-1.0","CAL-1.0-Combined-Work-Exception","CATOSL-1.1","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-3.0","CC-BY-4.0","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-4.0","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-4.0","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-4.0","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-4.0","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-4.0","CC-PDDC","CC0-1.0","CDDL-1.0","CDDL-1.1","CDLA-Permissive-1.0","CDLA-Sharing-1.0","CECILL-1.0","CECILL-1.1","CECILL-2.0","CECILL-2.1","CECILL-B","CECILL-C","CERN-OHL-1.1","CERN-OHL-1.2","CERN-OHL-P-2.0","CERN-OHL-S-2.0","CERN-OHL-W-2.0","CNRI-Jython","CNRI-Python","CNRI-Python-GPL-Compatible","CPAL-1.0","CPL-1.0","CPOL-1.02","CUA-OPL-1.0","Caldera","ClArtistic","Condor-1.1","Crossword","CrystalStacker","Cube","D-FSL-1.0","DFSG","DOC","DRL-1.0","DSDP","Dotseqn","ECL-1.0","ECL-2.0","EFL-1.0","EFL-2.0","EPICS","EPL-1.0","EPL-2.0","EUDatagrid","EUPL-1.0","EUPL-1.1","EUPL-1.2","Entessa","ErlPL-1.1","Eurosym","FSFAP","FSFUL","FSFULLR","FTL","Fair","Frameworx-1.0","FreeBSD-DOC","FreeImage","GD","GFDL-1.1-invariants-only","GFDL-1.1-invariants-or-later","GFDL-1.1-no-invariants-only","GFDL-1.1-no-invariants-or-later","GFDL-1.1-only","GFDL-1.1-or-later","GFDL-1.2-invariants-only","GFDL-1.2-invariants-or-later","GFDL-1.2-no-invariants-only","GFDL-1.2-no-invariants-or-later","GFDL-1.2-only","GFDL-1.2-or-later","GFDL-1.3-invariants-only","GFDL-1.3-invariants-or-later","GFDL-1.3-no-invariants-only","GFDL-1.3-no-invariants-or-later","GFDL-1.3-only","GFDL-1.3-or-later","GL2PS","GLWTPL","GPL-1.0-only","GPL-1.0-or-later","GPL-2.0-only","GPL-2.0-or-later","GPL-3.0-only","GPL-3.0-or-later","Giftware","Glide","Glulxe","HPND","HPND-sell-variant","HTMLTIDY","HaskellReport","Hippocratic-2.1","IBM-pibs","ICU","IJG","IPA","IPL-1.0","ISC","ImageMagick","Imlib2","Info-ZIP","Intel","Intel-ACPI","Interbase-1.0","JPNIC","JSON","JasPer-2.0","LAL-1.2","LAL-1.3","LGPL-2.0-only","LGPL-2.0-or-later","LGPL-2.1-only","LGPL-2.1-or-later","LGPL-3.0-only","LGPL-3.0-or-later","LGPLLR","LPL-1.0","LPL-1.02","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3a","LPPL-1.3c","Latex2e","Leptonica","LiLiQ-P-1.1","LiLiQ-R-1.1","LiLiQ-Rplus-1.1","Libpng","Linux-OpenIB","MIT","MIT-0","MIT-CMU","MIT-Modern-Variant","MIT-advertising","MIT-enna","MIT-feh","MIT-open-group","MITNFA","MPL-1.0","MPL-1.1","MPL-2.0","MPL-2.0-no-copyleft-exception","MS-PL","MS-RL","MTLL","MakeIndex","MirOS","Motosoto","MulanPSL-1.0","MulanPSL-2.0","Multics","Mup","NAIST-2003","NASA-1.3","NBPL-1.0","NCGL-UK-2.0","NCSA","NGPL","NIST-PD","NIST-PD-fallback","NLOD-1.0","NLPL","NOSL","NPL-1.0","NPL-1.1","NPOSL-3.0","NRL","NTP","NTP-0","Naumen","Net-SNMP","NetCDF","Newsletr","Nokia","Noweb","O-UDA-1.0","OCCT-PL","OCLC-2.0","ODC-By-1.0","ODbL-1.0","OFL-1.0","OFL-1.0-RFN","OFL-1.0-no-RFN","OFL-1.1","OFL-1.1-RFN","OFL-1.1-no-RFN","OGC-1.0","OGDL-Taiwan-1.0","OGL-Canada-2.0","OGL-UK-1.0","OGL-UK-2.0","OGL-UK-3.0","OGTSL","OLDAP-1.1","OLDAP-1.2","OLDAP-1.3","OLDAP-1.4","OLDAP-2.0","OLDAP-2.0.1","OLDAP-2.1","OLDAP-2.2","OLDAP-2.2.1","OLDAP-2.2.2","OLDAP-2.3","OLDAP-2.4","OLDAP-2.5","OLDAP-2.6","OLDAP-2.7","OLDAP-2.8","OML","OPL-1.0","OSET-PL-2.1","OSL-1.0","OSL-1.1","OSL-2.0","OSL-2.1","OSL-3.0","OpenSSL","PDDL-1.0","PHP-3.0","PHP-3.01","PSF-2.0","Parity-6.0.0","Parity-7.0.0","Plexus","PolyForm-Noncommercial-1.0.0","PolyForm-Small-Business-1.0.0","PostgreSQL","Python-2.0","QPL-1.0","Qhull","RHeCos-1.1","RPL-1.1","RPL-1.5","RPSL-1.0","RSA-MD","RSCPL","Rdisc","Ruby","SAX-PD","SCEA","SGI-B-1.0","SGI-B-1.1","SGI-B-2.0","SHL-0.5","SHL-0.51","SISSL","SISSL-1.2","SMLNJ","SMPPL","SNIA","SPL-1.0","SSH-OpenSSH","SSH-short","SSPL-1.0","SWL","Saxpath","Sendmail","Sendmail-8.23","SimPL-2.0","Sleepycat","Spencer-86","Spencer-94","Spencer-99","SugarCRM-1.1.3","TAPR-OHL-1.0","TCL","TCP-wrappers","TMate","TORQUE-1.1","TOSL","TU-Berlin-1.0","TU-Berlin-2.0","UCL-1.0","UPL-1.0","Unicode-DFS-2015","Unicode-DFS-2016","Unicode-TOU","Unlicense","VOSTROM","VSL-1.0","Vim","W3C","W3C-19980720","W3C-20150513","WTFPL","Watcom-1.0","Wsuipa","X11","XFree86-1.1","XSkat","Xerox","Xnet","ZPL-1.1","ZPL-2.0","ZPL-2.1","Zed","Zend-2.0","Zimbra-1.3","Zimbra-1.4","Zlib","blessing","bzip2-1.0.5","bzip2-1.0.6","copyleft-next-0.3.0","copyleft-next-0.3.1","curl","diffmark","dvipdfm","eGenix","etalab-2.0","freeware","gSOAP-1.3b","gnuplot","iMatix","libpng-2.0","libselinux-1.0","libtiff","mpich2","proprietary","psfrag","psutils","unknown","xinetd","xpp","zlib-acknowledgement"]},"dedicated.TemplateOsInfoProject":{"type":"object","description":"A structure describing some interesting facts about an OS template project","properties":{"os":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsInfoProjectItem"}],"description":"OS template project OS details","nullable":true},"usage":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsInfoProjectItem"}],"description":"OS template project usage details","nullable":true}}},"dedicated.TemplateOsInfoProjectItem":{"type":"object","description":"A structure describing some interesting facts about an OS template project item","properties":{"governance":{"type":"array","description":"OS template project item governance","nullable":true,"items":{"type":"string"}},"name":{"type":"string","description":"OS template project item name","nullable":true},"releaseNotes":{"type":"string","description":"OS template project item release notes","nullable":true},"url":{"type":"string","description":"OS template project item url","nullable":true},"version":{"type":"string","description":"OS template project item version","nullable":true}}},"dedicated.TemplateOsInput":{"type":"object","description":"A structure describing input questions for the specific OS template","properties":{"default":{"type":"string","description":"Default value","nullable":true},"description":{"type":"string","description":"Input question description","nullable":true},"enum":{"type":"array","description":"When type is enum: name of the possible enum values","items":{"type":"string"}},"mandatory":{"type":"boolean","description":"Whether answering to that question is mandatory in order to trigger an install with that specific OS or not"},"name":{"type":"string","description":"Input question name"},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsInputTypeEnum"}],"description":"Input type"}}},"dedicated.TemplateOsInputTypeEnum":{"type":"string","description":"Template OS Input type enum","enum":["boolean","date","email","enum","hexstring","hostname","ip","keyValue","number","sshPubKey","string","text","time","url","uuid"]},"dedicated.TemplateOsSubfamilyEnum":{"type":"string","description":"Os subfamily definition","enum":["alma","aos","arch","byoi","byolinux","centos","cloudlinux","coreos","debian","dgx","esxi","fedora","freebsd","gentoo","hyperv","omnios","openio","openmediavault","opensuse","ovh","pcs","power","proxmox","rhel","rocky","slackware","sles-sap","smartos","solusvm","ubuntu","windows-server-core","windows-server-desktop-exp","xcp","xen"]},"dedicated.TemplateOsTypeEnum":{"type":"string","description":"Os type","enum":["bsd","custom","ibm","linux","solaris","unix","windows"]},"dedicated.TemplateOsUsageEnum":{"type":"string","description":"Os usage definition","enum":["backup","basic","customer","database","erp","hosting","management","other","readyToUse","virtualisation","virtualization"]},"dedicated.TemplatePartitionTypeEnum":{"type":"string","description":"partition type","enum":["logical","lv","primary"]},"dedicated.installationTemplate.Templates":{"type":"object","description":"Available installation templates","properties":{"bitFormat":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.BitFormatEnum"}],"description":"this template bit format","readOnly":true},"category":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsUsageEnum"}],"description":"category of this template (informative only)","readOnly":true},"description":{"type":"string","description":"information about this template","readOnly":true},"distribution":{"type":"string","description":"the distribution this template is based on","readOnly":true},"endOfInstall":{"type":"string","description":"after this date, install of this template will not be possible at OVH","format":"date","readOnly":true},"family":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsTypeEnum"}],"description":"this template family type","readOnly":true},"filesystems":{"type":"array","description":"list of all filesystems available for this template","items":{"$ref":"#/components/schemas/dedicated.server.FileSystemEnum"},"readOnly":true},"inputs":{"type":"array","description":"Inputs","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.TemplateOsInput"},"readOnly":true},"license":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsInfoLicense"}],"description":"This distribution licensing details","nullable":true,"readOnly":true},"lvmReady":{"type":"boolean","description":"This distribution supports Logical Volumes (Linux LVM)","nullable":true,"readOnly":true},"noPartitioning":{"type":"boolean","description":"Partitioning customization is not available for this OS template","readOnly":true},"project":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsInfoProject"}],"description":"This distribution project details","nullable":true,"readOnly":true},"rootMountpoint":{"type":"string","description":"The mandatory mount point of the root filesystem on this OS","nullable":true,"readOnly":true},"softRaidOnlyMirroring":{"type":"boolean","description":"Partitioning customization is available but limited to mirroring for this OS template","readOnly":true},"subfamily":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsSubfamilyEnum"}],"description":"this template subfamily type","readOnly":true},"templateName":{"type":"string","description":"This template name","readOnly":true}}},"dedicated.installationTemplate.hardwareRaid":{"type":"object","description":"Hardware RAID defined in this partitioning scheme","properties":{"disks":{"type":"array","description":"Disk list","items":{"type":"string"},"readOnly":true},"mode":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplateOsHardwareRaidEnum"}],"description":"RAID mode","readOnly":true},"name":{"type":"string","description":"Hardware RAID name","readOnly":true},"step":{"type":"integer","description":"Specifies the creation order of the hardware RAID","readOnly":true}}},"dedicated.installationTemplate.templatePartitioningSchemes":{"type":"object","description":"Partitioning schemes available on this template","properties":{"name":{"type":"string","description":"This partitioning scheme name","readOnly":true},"priority":{"type":"integer","description":"on a reinstall, if a partitioning scheme is not specified, the one with the higher priority will be used by default, among all the compatible partitioning schemes (given the underlying hardware specifications)","readOnly":true}}},"dedicated.installationTemplate.templatePartitions":{"type":"object","description":" Partitions defined in this partitioning scheme","properties":{"filesystem":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.FileSystemEnum"}],"description":"Partition filesytem","readOnly":true},"mountpoint":{"type":"string","description":"Partition mount point","readOnly":true},"order":{"type":"integer","description":"specifies the creation order of the partition on the disk","readOnly":true},"raid":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.PartitionRaidEnum"}],"description":"Partition raid","nullable":true,"readOnly":true},"size":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Partition size (unit: MB GB TB, MB by default), 0 => rest of the space","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.TemplatePartitionTypeEnum"}],"description":"Partition type","readOnly":true},"volumeName":{"type":"string","description":"Logical volume name (required if type is lv) or optional zpool name if filesystem is ZFS","nullable":true,"readOnly":true}}},"dedicated.server.BitFormatEnum":{"type":"integer","description":"Available os bit format","enum":[32,64]},"dedicated.server.BootOptionEnum":{"type":"string","description":"Different option activated on netboot ","enum":["cpufamily","grsec","ipv6","smp"]},"dedicated.server.BootTypeEnum":{"type":"string","description":" Different netboot boot","enum":["harddisk","internal","network","power","rescue"]},"dedicated.server.DiskTypeEnum":{"type":"string","description":"Disk interface type enum","enum":["NVMe","SAS","SATA","SSD","Unknown"]},"dedicated.server.FileSystemEnum":{"type":"string","description":"FileSystems","enum":["btrfs","ext3","ext4","fat16","none","ntfs","reiserfs","swap","ufs","vmfs5","vmfs6","vmfsl","xfs","zfs"]},"dedicated.server.HardwareRaidController":{"type":"object","description":"RAID controller configuration","properties":{"disks":{"type":"array","description":"Connected disk type","items":{"$ref":"#/components/schemas/dedicated.server.HardwareRaidDiskGroup"}},"model":{"type":"string","description":"Raid controler model"},"type":{"type":"string","description":"Raid controler type"}}},"dedicated.server.HardwareRaidDiskGroup":{"type":"object","description":"Disk attached to a RAID controller","properties":{"capacity":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Disk capacity"},"diskGroupId":{"type":"integer","description":"Disk Group Id"},"names":{"type":"array","description":"Disk names","items":{"type":"string"}},"speed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_string"}],"description":"Disk insterface speed"},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.DiskTypeEnum"}],"description":"Disk type"}}},"dedicated.server.HardwareRaidProfile":{"type":"object","description":"A structure describing the server's hardware RAID configuration","properties":{"controllers":{"type":"array","description":"Hardware RAID controller list","items":{"$ref":"#/components/schemas/dedicated.server.HardwareRaidController"}}}},"dedicated.server.InstallTemplate":{"type":"object","description":"A structure describing informations about an Installation templates","properties":{"ovh":{"type":"array","description":"Names list of ovh installationtemplates compatibles with this server","nullable":true,"items":{"type":"string"}}}},"dedicated.server.InstallationProgressStatus":{"type":"object","description":"A structure describing informations about this dedicated server installation status","properties":{"elapsedTime":{"type":"integer","description":"Elapsed time in seconds since installation beggining"},"progress":{"type":"array","description":"Installation steps","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.InstallationProgressSteps"}}}},"dedicated.server.InstallationProgressStatusEnum":{"type":"string","description":"Distinct Installation status","enum":["doing","done","error","expired","idle","pending","stopping","todo"]},"dedicated.server.InstallationProgressSteps":{"type":"object","description":"A structure describing informations about this dedicated server installation steps","properties":{"comment":{"type":"string","description":"Informations about this installation step"},"error":{"type":"string","description":"Error details if state is error","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.InstallationProgressStatusEnum"}],"description":"Status of this installation step"}}},"dedicated.server.Netboot":{"type":"object","description":"Available boots","properties":{"bootId":{"type":"integer","description":"boot id","readOnly":true},"bootType":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.BootTypeEnum"}],"description":"the boot system","readOnly":true},"description":{"type":"string","description":"the boot description","readOnly":true},"kernel":{"type":"string","description":"The boot kernel","readOnly":true}}},"dedicated.server.PartitionRaidEnum":{"type":"string","description":"partition raid type","enum":["0","1","10","5","6","7"]},"dedicated.server.Reinstall":{"type":"object","description":"OS reinstallation payload","properties":{"customizations":{"$ref":"#/components/schemas/dedicated.server.reinstall.Customizations"},"operatingSystem":{"type":"string","description":"Operating System name to install (available values for this server can be retrieved using GET /dedicated/server/{serviceName}/install/compatibleTemplates)"},"properties":{"type":"object","description":"(⚠ Deprecated parameter ⚠, use configDriveMetadata customization instead) Arbitrary properties to pass to cloud-init's config drive datasource","additionalProperties":{"type":"string"}},"storage":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.server.reinstall.Storage"}}},"required":["operatingSystem"]},"dedicated.server.Task":{"type":"object","description":"Server tasks","properties":{"changeUuid":{"type":"string","description":"UUID of the change linked to this task","nullable":true,"readOnly":true},"comment":{"type":"string","description":"Details of this task","nullable":true,"readOnly":true},"doneDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/dedicated.TaskFunctionEnum"}],"description":"Function name","readOnly":true},"lastUpdate":{"type":"string","description":"last update","nullable":true,"format":"date-time","readOnly":true},"needSchedule":{"type":"boolean","description":"Whether this task need to be scheduled or not","readOnly":true},"note":{"type":"string","description":"Extra information about this task","nullable":true,"readOnly":true},"plannedInterventionId":{"type":"integer","description":"ID of the planned intervention for this task","nullable":true,"readOnly":true},"startDate":{"type":"string","description":"Task Creation date","format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/dedicated.TaskStatusEnum"}],"description":"Task status","readOnly":true},"tags":{"type":"array","description":"Task result tags output","nullable":true,"items":{"$ref":"#/components/schemas/complexType.SafeKeyValueCanBeNull_string"},"readOnly":true},"taskId":{"type":"integer","description":"the id of the task","readOnly":true},"ticketReference":{"type":"string","description":"Reference of the thread on the support tool","nullable":true,"readOnly":true}}},"dedicated.server.netbootOption":{"type":"object","description":"Available boot options","properties":{"option":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.BootOptionEnum"}],"description":"The option of this boot","readOnly":true},"value":{"type":"string","description":"the value of this option","readOnly":true}}},"dedicated.server.reinstall.Customizations":{"type":"object","description":"OS reinstallation customizations","properties":{"appToInstall":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.reinstall.customizations.AppToInstallEnum"}],"description":"Application to install with the auto installer"},"configDriveMetadata":{"type":"object","description":"Config Drive MetaData","additionalProperties":{"type":"string"}},"configDriveUserData":{"type":"string","description":"Config Drive UserData"},"efiBootloaderPath":{"type":"string","description":"Path of the EFI bootloader from the OS installed on the server"},"enableLacpBonding":{"type":"boolean","description":"Enable LACP to aggregate multiple network interfaces (if applicable)"},"hostname":{"type":"string","description":"Custom hostname"},"httpHeaders":{"type":"object","description":"Image HTTP Headers","additionalProperties":{"type":"string","format":"password"}},"imageCheckSum":{"type":"string","description":"Image checksum"},"imageCheckSumType":{"$ref":"#/components/schemas/dedicated.server.reinstall.customizations.ImageCheckSumTypeEnum"},"imageType":{"$ref":"#/components/schemas/dedicated.server.reinstall.customizations.ImageTypeEnum"},"imageURL":{"type":"string","description":"Image URL"},"language":{"$ref":"#/components/schemas/dedicated.server.reinstall.customizations.LanguageEnum"},"nutanixConfiguration":{"type":"object","description":"Nutanix specific configuration","additionalProperties":{"type":"string"}},"postInstallationScript":{"type":"string","description":"Post-Installation Script"},"postInstallationScriptExtension":{"$ref":"#/components/schemas/dedicated.server.reinstall.customizations.PostInstallationScriptExtensionEnum"},"sshKey":{"type":"string","description":"SSH Public Key"},"version":{"type":"string","description":"Flavor version"}}},"dedicated.server.reinstall.Storage":{"type":"object","description":"OS reinstallation storage configuration","properties":{"diskGroupId":{"type":"integer","description":"Disk group id (default is 0, meaning automatic)","nullable":true},"erase":{"type":"boolean","description":"Erase all disks of this diskGroup (default is true)","nullable":true},"hardwareRaid":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.server.reinstall.storage.HardwareRaid"}},"partitioning":{"$ref":"#/components/schemas/dedicated.server.reinstall.storage.Partitioning"}}},"dedicated.server.reinstall.customizations.AppToInstallEnum":{"type":"string","description":"Installable Application","enum":["coolify","discourse","dokploy","drupal","easypanel","fastpanel","game-panel","hestiacp","matomo","n8n","nextcloud","openclaw","prestashop","wordpress"]},"dedicated.server.reinstall.customizations.ImageCheckSumTypeEnum":{"type":"string","description":"Checksum type","enum":["md5","sha1","sha256","sha512"]},"dedicated.server.reinstall.customizations.ImageTypeEnum":{"type":"string","description":"Image Type","enum":["qcow2","raw"]},"dedicated.server.reinstall.customizations.LanguageEnum":{"type":"string","description":"Display Language","enum":["cs-cz","de-de","en-us","es-es","fr-fr","it-it","nl-nl","pl-pl","pt-pt"]},"dedicated.server.reinstall.customizations.PostInstallationScriptExtensionEnum":{"type":"string","description":"Post-Installation Script File Extension","enum":["cmd","ps1"]},"dedicated.server.reinstall.storage.HardwareRaid":{"type":"object","description":"Hardware Raid configuration","properties":{"arrays":{"type":"integer","description":"Number of arrays (default is 1)","nullable":true},"disks":{"type":"integer","description":"Total number of disks in the disk group involved in the hardware raid configuration (all disks of the disk group by default)","nullable":true},"raidLevel":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.reinstall.storage.hardwareRaid.RaidLevelEnum"}],"description":"Hardware raid type (default is 1; if set to null, all disks of the chosen disk group will be configured in JBOD mode)","nullable":true},"spares":{"type":"integer","description":"Number of disks in the disk group involved in the spare (default is 0)","nullable":true}}},"dedicated.server.reinstall.storage.Partitioning":{"type":"object","description":"Partitioning configuration","properties":{"disks":{"type":"integer","description":"Total number of disks in the disk group involved in the partitioning configuration (all disks of the disk group by default)","nullable":true},"layout":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.server.reinstall.storage.partitioning.Layout"}},"schemeName":{"type":"string","description":"Partitioning scheme (if applicable with selected operating system)"}}},"dedicated.server.reinstall.storage.hardwareRaid.RaidLevelEnum":{"type":"integer","description":"Hardware raid type","enum":[0,1,5,6,10,50,60]},"dedicated.server.reinstall.storage.partitioning.Layout":{"type":"object","description":"Custom partition configuration","properties":{"extras":{"$ref":"#/components/schemas/dedicated.server.reinstall.storage.partitioning.layout.Extras"},"fileSystem":{"$ref":"#/components/schemas/dedicated.server.reinstall.storage.partitioning.layout.FileSystemEnum"},"mountPoint":{"type":"string","description":"Mount point"},"raidLevel":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.reinstall.storage.partitioning.layout.RaidLevelEnum"}],"description":"Software raid type (default is 1)","nullable":true},"size":{"type":"integer","description":"Partition size in MiB (default value is 0 which means to fill the disk with that partition)"}},"required":["fileSystem","mountPoint"]},"dedicated.server.reinstall.storage.partitioning.layout.Extras":{"type":"object","description":"Partition extras parameters","properties":{"lv":{"$ref":"#/components/schemas/dedicated.server.reinstall.storage.partitioning.layout.extras.Lv"},"zp":{"$ref":"#/components/schemas/dedicated.server.reinstall.storage.partitioning.layout.extras.Zp"}}},"dedicated.server.reinstall.storage.partitioning.layout.FileSystemEnum":{"type":"string","description":"File system type","enum":["btrfs","ext3","ext4","fat16","none","ntfs","reiserfs","swap","ufs","vmfs5","vmfs6","vmfsl","xfs","zfs"]},"dedicated.server.reinstall.storage.partitioning.layout.RaidLevelEnum":{"type":"integer","description":"Software raid type","enum":[0,1,5,6,7,10]},"dedicated.server.reinstall.storage.partitioning.layout.extras.Lv":{"type":"object","description":"LVM-specific parameters","properties":{"name":{"type":"string","description":"Logical volume name"}}},"dedicated.server.reinstall.storage.partitioning.layout.extras.Zp":{"type":"object","description":"ZFS-specific parameters","properties":{"name":{"type":"string","description":"zpool name (generated automatically if not specified, note that multiple ZFS partitions with same zpool names will be configured as multiple datasets belonging to the same zpool if compatible)"}}},"dedicated.server.task.FunctionEnum":{"type":"string","description":"Task operation type","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"]},"dedicated.server.task.Response":{"type":"object","description":"Dedicated server task","properties":{"comment":{"type":"string","description":"Details of this task","readOnly":true},"doneDate":{"type":"string","description":"Task Completion date","nullable":true,"format":"date-time","readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.task.FunctionEnum"}],"readOnly":true},"startDate":{"type":"string","description":"Task Creation date","format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.task.StatusEnum"}],"readOnly":true},"taskId":{"type":"integer","description":"Task id","readOnly":true}}},"dedicated.server.task.StatusEnum":{"type":"string","description":"Task status","enum":["cancelled","customerError","doing","done","init","ovhError","todo"]},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/dedicated/installationTemplate":{"get":{"summary":"List installation templates","description":"List installation templates. Returns the names of the operating system installation templates. This call does not require authentication. To get the templates compatible with a server, use GET /dedicated/server/{serviceName}/install/compatibleTemplates.","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@120"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/installationTemplate\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/installationTemplate\");\n\nprint_r($result);\n?>"}],"x-expanded-response":"DedicatedInstallationTemplateTemplates"}},"/dedicated/installationTemplate/templateInfos":{"get":{"summary":"List installation template details","description":"List installation template details. Returns the details of the available operating system templates: name, category, family, subfamily, end of install date, project and license. This call does not require authentication.","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.TemplateOsInfo"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@130"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/installationTemplate/templateInfos\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/installationTemplate/templateInfos\");\n\nprint_r($result);\n?>"}]}},"/dedicated/installationTemplate/{templateName}":{"get":{"summary":"Get an installation template","description":"Get an installation template. Returns the details of an installation template, such as its distribution, family, filesystems and inputs. After its endOfInstall date, the template can no longer be installed. This call does not require authentication.","parameters":[{"in":"path","name":"templateName","description":"This template name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.installationTemplate.Templates"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@140"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/installationTemplate/{templateName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/installationTemplate/{templateName}\");\n\nprint_r($result);\n?>"}]}},"/dedicated/installationTemplate/{templateName}/partitionScheme":{"get":{"summary":"List partitioning schemes","description":"List partitioning schemes. Returns the names of the partitioning schemes of the template. On a reinstall without a partitioning scheme, the compatible scheme with the highest priority is used.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"templateName","description":"This template name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@150"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/installationTemplate/{templateName}/partitionScheme\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/installationTemplate/{templateName}/partitionScheme\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:dedicatedInstallationTemplate/partitionScheme/get","required":true}],"x-expanded-response":"DedicatedInstallationTemplateTemplatePartitioningSchemes"}},"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}":{"get":{"summary":"Get a partitioning scheme","description":"Get a partitioning scheme. Returns the name and priority of a partitioning scheme. On a reinstall without a partitioning scheme, the compatible scheme with the highest priority is used.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"schemeName","description":"This partitioning scheme name","required":true,"schema":{"type":"string"}},{"in":"path","name":"templateName","description":"This template name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.installationTemplate.templatePartitioningSchemes"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@160"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:dedicatedInstallationTemplate/partitionScheme/get","required":true}]}},"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid":{"get":{"summary":"List hardware RAIDs","description":"List hardware RAIDs. Returns the names of the hardware RAIDs defined in the partitioning scheme. Each one has a RAID mode, a disk list and a creation order.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"schemeName","description":"This partitioning scheme name","required":true,"schema":{"type":"string"}},{"in":"path","name":"templateName","description":"This template name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@170"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:dedicatedInstallationTemplate/partitionScheme/hardwareRaid/get","required":true}],"x-expanded-response":"DedicatedInstallationTemplateHardwareRaid"}},"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid/{name}":{"get":{"summary":"Get a hardware RAID","description":"Get a hardware RAID. Returns the RAID mode, the disks and the creation order of a hardware RAID defined in the partitioning scheme.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Hardware RAID name","required":true,"schema":{"type":"string"}},{"in":"path","name":"schemeName","description":"This partitioning scheme name","required":true,"schema":{"type":"string"}},{"in":"path","name":"templateName","description":"This template name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.installationTemplate.hardwareRaid"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@180"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid/{name}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/hardwareRaid/{name}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:dedicatedInstallationTemplate/partitionScheme/hardwareRaid/get","required":true}]}},"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition":{"get":{"summary":"List partitions","description":"List partitions. Returns the mount points of the partitions defined in the partitioning scheme. Each partition has a filesystem, a type, a size and a creation order on the disk.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"schemeName","description":"This partitioning scheme name","required":true,"schema":{"type":"string"}},{"in":"path","name":"templateName","description":"This template name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@190"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:dedicatedInstallationTemplate/partitionScheme/partition/get","required":true}],"x-expanded-response":"DedicatedInstallationTemplateTemplatePartitions"}},"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition/{mountpoint}":{"get":{"summary":"Get a partition","description":"Get a partition. Returns the filesystem, type, size, RAID level and creation order of a partition of the partitioning scheme. A size of 0 means the rest of the disk space.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"mountpoint","description":"Partition mount point","required":true,"schema":{"type":"string"}},{"in":"path","name":"schemeName","description":"This partitioning scheme name","required":true,"schema":{"type":"string"}},{"in":"path","name":"templateName","description":"This template name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.installationTemplate.templatePartitions"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@200"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition/{mountpoint}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/installationTemplate/{templateName}/partitionScheme/{schemeName}/partition/{mountpoint}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:dedicatedInstallationTemplate/partitionScheme/partition/get","required":true}]}},"/dedicated/server/osAvailabilities":{"get":{"summary":"List operating systems by hardware","description":"Returns the names of the operating systems available for the hardware reference given in the hardware parameter. This call does not require authentication.","parameters":[{"in":"query","name":"hardware","description":"Hardware reference requested","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@110"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/osAvailabilities\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/server/osAvailabilities\");\n\nprint_r($result);\n?>"}]}},"/dedicated/server/{serviceName}/boot":{"get":{"summary":"List compatible netboots","description":"List compatible netboots. Returns the identifiers of the netboots compatible with the server. Filter them by boot type (harddisk, network, rescue, internal or power) with the bootType parameter.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"bootType","description":"Filter the value of bootType property (=)","schema":{"$ref":"#/components/schemas/dedicated.server.BootTypeEnum"}},{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@60"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/boot\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/server/{serviceName}/boot\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:boot/get","required":true}],"x-expanded-response":"DedicatedServerNetboot"}},"/dedicated/server/{serviceName}/boot/{bootId}":{"get":{"summary":"Get a netboot","description":"Get a netboot. Returns a netboot compatible with the server: its boot type, its kernel and its description.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bootId","description":"boot id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.Netboot"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@70"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/boot/{bootId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/server/{serviceName}/boot/{bootId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:boot/get","required":true}]}},"/dedicated/server/{serviceName}/boot/{bootId}/option":{"get":{"summary":"List netboot options","description":"List netboot options. Returns the options activated on the netboot, among cpufamily, grsec, ipv6 and smp.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bootId","description":"boot id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.server.BootOptionEnum"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@80"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/boot/{bootId}/option\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/server/{serviceName}/boot/{bootId}/option\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:boot/option/get","required":true}],"x-expanded-response":"DedicatedServerNetbootOption"}},"/dedicated/server/{serviceName}/boot/{bootId}/option/{option}":{"get":{"summary":"Get a netboot option","description":"Get a netboot option. Returns the value of an option activated on the netboot. The option is one of cpufamily, grsec, ipv6 or smp.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bootId","description":"boot id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"option","description":"The option of this boot","required":true,"schema":{"$ref":"#/components/schemas/dedicated.server.BootOptionEnum"}},{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.netbootOption"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@90"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/boot/{bootId}/option/{option}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/server/{serviceName}/boot/{bootId}/option/{option}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:boot/option/get","required":true}]}},"/dedicated/server/{serviceName}/install/compatibleTemplatePartitionSchemes":{"get":{"summary":"List compatible partitioning schemes","description":"List compatible partitioning schemes. Returns the names of the partitioning schemes of the installation template given in templateName that are compatible with the server.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}},{"in":"query","name":"templateName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@20"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/install/compatibleTemplatePartitionSchemes\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/server/{serviceName}/install/compatibleTemplatePartitionSchemes\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:install/compatibleTemplatePartitionSchemes/get","required":true}]}},"/dedicated/server/{serviceName}/install/compatibleTemplates":{"get":{"summary":"List compatible installation templates","description":"List compatible installation templates. Returns the names of the installation templates compatible with the server, in the ovh list. Use one of them as operatingSystem to reinstall the server.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.InstallTemplate"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/install/compatibleTemplates\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/server/{serviceName}/install/compatibleTemplates\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:install/compatibleTemplates/get","required":true}]}},"/dedicated/server/{serviceName}/install/hardwareRaidProfile":{"get":{"summary":"Get the hardware RAID profile","description":"Get the hardware RAID profile. Returns the hardware RAID controllers of the server, with their type, model and connected disks.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.HardwareRaidProfile"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/install/hardwareRaidProfile\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/server/{serviceName}/install/hardwareRaidProfile\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:install/hardwareRaidProfile/get","required":true}]}},"/dedicated/server/{serviceName}/install/status":{"get":{"summary":"Get the installation status","description":"Get the installation status. Returns the progress of the operating system installation on the server: the elapsed time in seconds and the status of each step. When no installation is in progress, the call returns an error.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.InstallationProgressStatus"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/install/status\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/dedicated/server/{serviceName}/install/status\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:install/status/get","required":true}]}},"/dedicated/server/{serviceName}/reboot":{"post":{"summary":"Reboot the server","description":"Reboot the server. Performs a hard reboot of the server: the power is cycled without a clean shutdown of the operating system. Returns the reboot task, with its status and completion date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@100"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/dedicated/server/{serviceName}/reboot\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/dedicated/server/{serviceName}/reboot\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:reboot","required":true}]}},"/dedicated/server/{serviceName}/reinstall":{"post":{"summary":"Install an operating system","description":"Installs an operating system on the server and returns the installation task. operatingSystem must be one of the names returned by GET /dedicated/server/{serviceName}/install/compatibleTemplates. By default, all disks of the disk group are erased.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.Reinstall"},"examples":{"Example 1 - Simple Linux Installation with password-based authentication":{"value":{"operatingSystem":"debian13_64"}},"Example 2 - Linux Installation with ssh key-based authentication and post-installation script":{"value":{"customizations":{"hostname":"mon-tux","postInstallationScript":"IyEvYmluL2Jhc2gKZWNobyAiY291Y291IHBvc3RJbnN0YWxsYXRpb25TY3JpcHQiID4gL29wdC9jb3Vjb3UKY2F0IC9ldGMvbWFjaGluZS1pZCAgPj4gL29wdC9jb3Vjb3UKZGF0ZSAiKyVZLSVtLSVkICVIOiVNOiVTIiAtLXV0YyA+PiAvb3B0L2NvdWNvdQo=","sshKey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9xPpdqP3sx2H+gcBm65tJEaUbuifQ1uGkgrWtNY0PRKNNPdy+3yoVOtxk6Vjo4YZ0EU/JhmQfnrK7X7Q5vhqYxmozi0LiTRt0BxgqHJ+4hWTWMIOgr+C2jLx7ZsCReRk+fy5AHr6h0PHQEuXVLXeUy/TDyuY2JPtUZ5jcqvLYgQ== my-nuclear-power-plant"},"operatingSystem":"debian13_64"}},"Example 3 - Windows Installation with French display language and PowerShell post-installation script":{"value":{"customizations":{"hostname":"ma-fenetre","language":"fr-fr","postInstallationScript":"ImNvdWNvdSBwb3N0SW5zdGFsbGF0aW9uU2NyaXB0UG93ZXJTaGVsbCIgfCBPdXQtRmlsZSAtRmlsZVBhdGggImM6XG92aHVwZFxzY3JpcHRcY291Y291LnR4dCIKKEdldC1JdGVtUHJvcGVydHkgLUxpdGVyYWxQYXRoICJSZWdpc3RyeTo6SEtMTVxTT0ZUV0FSRVxNaWNyb3NvZnRcQ3J5cHRvZ3JhcGh5IiAtTmFtZSAiTWFjaGluZUd1aWQiKS5NYWNoaW5lR3VpZCB8IE91dC1GaWxlIC1GaWxlUGF0aCAiYzpcb3ZodXBkXHNjcmlwdFxjb3Vjb3UudHh0IiAtQXBwZW5kCihHZXQtRGF0ZSkuVG9Vbml2ZXJzYWxUaW1lKCkuVG9TdHJpbmcoInl5eXktTU0tZGQgSEg6bW06c3MiKSB8IE91dC1GaWxlIC1GaWxlUGF0aCAiYzpcb3ZodXBkXHNjcmlwdFxjb3Vjb3UudHh0IiAtQXBwZW5kCg=="},"operatingSystem":"win2025core-std_64"}},"Example 4 - Custom Linux image Installation with custom config drive datasource":{"value":{"customizations":{"configDriveMetadata":{"foo":"bar","hello":"world"},"configDriveUserData":"I2Nsb3VkLWNvbmZpZwpzc2hfYXV0aG9yaXplZF9rZXlzOgogIC0gc3NoLXJzYSBBQUFBQjhkallpdz09IG15c2VsZkBteWRvbWFpbi5uZXQKCnVzZXJzOgogIC0gbmFtZTogcGF0aWVudDAKICAgIHN1ZG86IEFMTD0oQUxMKSBOT1BBU1NXRDpBTEwKICAgIGdyb3VwczogdXNlcnMsIHN1ZG8KICAgIHNoZWxsOiAvYmluL2Jhc2gKICAgIGxvY2tfcGFzc3dkOiBmYWxzZQogICAgc3NoX2F1dGhvcml6ZWRfa2V5czoKICAgICAgLSBzc2gtcnNhIEFBQUFCOGRqWWl3PT0gbXlzZWxmQG15ZG9tYWluLm5ldApkaXNhYmxlX3Jvb3Q6IGZhbHNlCnBhY2thZ2VzOgogIC0gdmltCiAgLSB0cmVlCmZpbmFsX21lc3NhZ2U6IFRoZSBzeXN0ZW0gaXMgZmluYWxseSB1cCwgYWZ0ZXIgJFVQVElNRSBzZWNvbmRzCg==","efiBootloaderPath":"\\efi\\debian\\grubx64.efi","hostname":"mon-tux","httpHeaders":{"Authorization":"Basic bG9naW46cGFzc3dvcmQ="},"imageURL":"https://github.com/ashmonger/akution_test/releases/latest/download/deb11k6.qcow2"},"operatingSystem":"byolinux_64"}},"Example 5 - Linux Installation with LACP bonding enabled":{"value":{"customizations":{"enableLacpBonding":true,"hostname":"mon-tux"},"operatingSystem":"debian13_64"}},"Example 6 - Linux Installation with custom cloud-init metadata":{"value":{"customizations":{"configDriveMetadata":{"foo":"bar","hello":"world"},"hostname":"mon-tux"},"operatingSystem":"debian13_64"}},"Example 7 - Linux Installation with custom partitioning on some disks of the default diskGroup":{"value":{"customizations":{"hostname":"mon-tux"},"operatingSystem":"debian13_64","storage":[{"partitioning":{"disks":4,"layout":[{"fileSystem":"ext4","mountPoint":"/boot","raidLevel":1,"size":1024},{"extras":{"lv":{"name":"root"}},"fileSystem":"ext4","mountPoint":"/","raidLevel":1,"size":20480},{"fileSystem":"swap","mountPoint":"swap","size":2048},{"extras":{"zp":{"name":"poule"}},"fileSystem":"zfs","mountPoint":"/data","raidLevel":5,"size":0}]}}]}},"Example 8 - Linux Installation with custom partitioning and hardware RAID on diskGroup 2":{"value":{"customizations":{"hostname":"mon-tux"},"operatingSystem":"debian13_64","storage":[{"diskGroupId":2,"hardwareRaid":[{"raidLevel":5}],"partitioning":{"layout":[{"fileSystem":"ext4","mountPoint":"/","raidLevel":1,"size":20480}]}}]}},"Example 9 - Simple Linux Installation on diskGroup 1 and keep data on diskGroup 2":{"value":{"operatingSystem":"debian13_64","storage":[{"diskGroupId":1,"partitioning":{"schemeName":"default"}},{"diskGroupId":2,"erase":false}]}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.task.Response"},"examples":{"Dedicated server task":{"value":{"comment":"Start bare metal OS installation","doneDate":null,"function":"reinstallServer","startDate":"2024-11-20T15:22:14.449Z","status":"init","taskId":0}}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::CustomizationInvalidFormat":{"value":{"class":"Client::BadRequest::CustomizationInvalidFormat","message":"Invalid customization format for {{.name}} of type {{.type}}: {{.msg}}"}},"Client::BadRequest::CustomizationName":{"value":{"class":"Client::BadRequest::CustomizationName","message":"Customization {{.customizationName}} doesn't exist for operating system {{.operatingSystem}}"}},"Client::BadRequest::CustomizationSizeExceeded":{"value":{"class":"Client::BadRequest::CustomizationSizeExceeded","message":"Customization is {{.length}} big, which is exceeding limit of {{.limit}}"}},"Client::BadRequest::DiskGroup":{"value":{"class":"Client::BadRequest::DiskGroup","message":"{{.diskGroupName}} is not installable on server {{.serverName}}"}},"Client::BadRequest::DiskGroupDuplicated":{"value":{"class":"Client::BadRequest::DiskGroupDuplicated","message":"Duplicated {{.diskGroupName}}"}},"Client::BadRequest::DiskGroupIncompatibleDefault":{"value":{"class":"Client::BadRequest::DiskGroupIncompatibleDefault","message":"{{.diskGroupName}} will be used for the operating system installation since no diskGroupId was specified, so it cannot also be kept (erase:false)"}},"Client::BadRequest::DiskGroupIncompatibleParams":{"value":{"class":"Client::BadRequest::DiskGroupIncompatibleParams","message":"{{.diskGroupName}} is set to keep its data (erase:false), so {{.paramNames}} cannot be set on it"}},"Client::BadRequest::HardwareRaidInvalidDisksArrays":{"value":{"class":"Client::BadRequest::HardwareRaidInvalidDisksArrays","message":"Number of disks ({{.disks}}) must be a multiple of arrays ({{.arrays}})"}},"Client::BadRequest::HardwareRaidPartitioningDisks":{"value":{"class":"Client::BadRequest::HardwareRaidPartitioningDisks","message":"Partitioning multiple ({{.disks}}) disks is not possible while setting a hardware raid configuration on the same disk group, because the operating system will only see 1 single (virtual) disk"}},"Client::BadRequest::HostnameInvalidFormat":{"value":{"class":"Client::BadRequest::HostnameInvalidFormat","message":"Invalid hostname {{.label}}; must contain no more than 63 characters, start with a letter, end with a letter or a digit and contain only letters, digits and hyphens, see RFC 1035, section 2.3.1"}},"Client::BadRequest::HostnameSizeExceeded":{"value":{"class":"Client::BadRequest::HostnameSizeExceeded","message":"Hostname provided is {{.length}} length. It shall not be longer than {{.limit}} characters, see RFC 1035, section 2.3.4"}},"Client::BadRequest::IncompatibleParams":{"value":{"class":"Client::BadRequest::IncompatibleParams","message":"Incompatible {{.paramName1}} and {{.paramName2}} parameters"}},"Client::BadRequest::PartitionDuplicatedAttribute":{"value":{"class":"Client::BadRequest::PartitionDuplicatedAttribute","message":"{{.attribute}} value {{.value}} must be unique for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionDuplicatedZpName":{"value":{"class":"Client::BadRequest::PartitionDuplicatedZpName","message":"{{.attribute}} value {{.value}} already exists for another ZFS partition that has a different raid level. Either choose another name for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}} or set the same RAID level for all partitions within zpool {{.value}}"}},"Client::BadRequest::PartitionForbiddenLvName":{"value":{"class":"Client::BadRequest::PartitionForbiddenLvName","message":"{{.attribute}} value {{.value}} is forbidden (must be different from {{.forbiddenValues}}) for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionForbiddenMountpoint":{"value":{"class":"Client::BadRequest::PartitionForbiddenMountpoint","message":"{{.attribute}} value {{.value}} is forbidden (must be different from {{.forbiddenValues}}) for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionForbiddenMountpointCanonical":{"value":{"class":"Client::BadRequest::PartitionForbiddenMountpointCanonical","message":"{{.attribute}} value {{.value}} must be a canonical path and cannot be a hidden path for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionForbiddenMountpointSuffix":{"value":{"class":"Client::BadRequest::PartitionForbiddenMountpointSuffix","message":"{{.attribute}} value {{.value}} cannot end with '/' for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionForbiddenZpName":{"value":{"class":"Client::BadRequest::PartitionForbiddenZpName","message":"{{.attribute}} value {{.value}} is forbidden (must be different from {{.forbiddenValues}}) for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionIncompatibleCustomPartitioning":{"value":{"class":"Client::BadRequest::PartitionIncompatibleCustomPartitioning","message":"Operating system  {{.operatingSystem}} doesn't support custom partitioning layout in {{.diskGroupName}}"}},"Client::BadRequest::PartitionIncompatibleFs":{"value":{"class":"Client::BadRequest::PartitionIncompatibleFs","message":"{{.attribute}} value {{.value}} is not compatible for operating system {{.operatingSystem}} (must be one of {{.expectedValues}}) for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionIncompatibleLvm":{"value":{"class":"Client::BadRequest::PartitionIncompatibleLvm","message":"{{.attribute}} value {{.value}} is not compatible for operating system {{.operatingSystem}} for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionIncompatibleParams":{"value":{"class":"Client::BadRequest::PartitionIncompatibleParams","message":"{{.paramName1}} value {{.paramValue1}} incompatible with {{.paramName2}} value {{.paramValue2}} for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionIncompatibleRaidLevel":{"value":{"class":"Client::BadRequest::PartitionIncompatibleRaidLevel","message":"{{.attribute}} value {{.value}} must be one of {{.expectedValues}} for operating system {{.operatingSystem}} for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionInvalidLvName":{"value":{"class":"Client::BadRequest::PartitionInvalidLvName","message":"{{.attribute}} value {{.value}} is invalid (length can be maximum 16 characters and exclusively composed of valid characters) for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionInvalidUnixMountpoint":{"value":{"class":"Client::BadRequest::PartitionInvalidUnixMountpoint","message":"{{.attribute}} value {{.value}} is invalid (Unix-style mountpoint: length cannot exceed 256 characters; only alphanumeric characters, slashes, dots, underscores and hyphens are allowed) for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionInvalidUnixMountpointPrefix":{"value":{"class":"Client::BadRequest::PartitionInvalidUnixMountpointPrefix","message":"{{.attribute}} value {{.value}} is invalid (Unix-style mountpoint: must start with a '/') for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionInvalidWindowsMountpointLength":{"value":{"class":"Client::BadRequest::PartitionInvalidWindowsMountpointLength","message":"{{.attribute}} value {{.value}} is invalid (Windows-style mountpoint: must contain at most 5 lowercase letters) for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionInvalidWindowsMountpointRoot":{"value":{"class":"Client::BadRequest::PartitionInvalidWindowsMountpointRoot","message":"{{.attribute}} value {{.value}} is invalid (Windows-style mountpoint: first mountpoint must be c:) for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionInvalidZpName":{"value":{"class":"Client::BadRequest::PartitionInvalidZpName","message":"{{.attribute}} value {{.value}} is invalid (if specified, zpool name must begin with a letter, be exclusively composed of alphanumeric characters, underscores, colons or dots, and its length can be at most 239 characters) for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionLength":{"value":{"class":"Client::BadRequest::PartitionLength","message":"Number of partitions defined in the layout is incorrect ({{.partitionsNumber}}): must be between {{.lengthMin}} and {{.lengthMax}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionMinSize":{"value":{"class":"Client::BadRequest::PartitionMinSize","message":"{{.attribute}} value {{.value}} must be bigger than {{.min}} for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionMissingRootMountpoint":{"value":{"class":"Client::BadRequest::PartitionMissingRootMountpoint","message":"{{.attribute}} {{.value}} missing for operating system {{.operatingSystem}} in {{.diskGroupName}}"}},"Client::BadRequest::PartitionRaidLevel":{"value":{"class":"Client::BadRequest::PartitionRaidLevel","message":"{{.attribute}} value {{.value}} must be one of {{.expectedValues}} for partition {{.partitionName}} at position {{.partitionStep}} in {{.diskGroupName}}"}},"Client::BadRequest::PropertyName":{"value":{"class":"Client::BadRequest::PropertyName","message":"{{.propertyName}} is not a valid property name"}},"Client::BadRequest::TaskAlreadyExists":{"value":{"class":"Client::BadRequest::TaskAlreadyExists","message":"Task {{.taskId}} of type {{.taskFunction}} with status {{.taskStatus}} is already running on server {{.serverName}}"}}}}}},"403":{"description":"Error 403 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Forbidden::BadAccess":{"value":{"class":"Client::Forbidden::BadAccess","message":"An internal error has occurred due to a wrong configuration"}},"Client::Forbidden::OperatingSystemLicenseMissing":{"value":{"class":"Client::Forbidden::OperatingSystemLicenseMissing","message":"Operating system {{.operatingSystem}} requires a license on server {{.serverName}}"}},"Client::Forbidden::RetrieveAccess":{"value":{"class":"Client::Forbidden::RetrieveAccess","message":"An internal error has occurred due to a wrong configuration"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::DiskGroup":{"value":{"class":"Client::NotFound::DiskGroup","message":"{{.diskGroupName}} could not be found on server {{.serverName}}"}},"Client::NotFound::OperatingSystem":{"value":{"class":"Client::NotFound::OperatingSystem","message":"Operating system {{.operatingSystem}} could not be found"}},"Client::NotFound::SchemeName":{"value":{"class":"Client::NotFound::SchemeName","message":"Partition scheme {{.schemeName}} not found for operating system {{.operatingSystem}}"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::DisturbAlreadyExists":{"value":{"class":"Client::Conflict::DisturbAlreadyExists","message":"Server resource {{.serverName}} is already locked by another process, blocking any new OS reinstallation"}},"Client::Conflict::HardwareRaidIncompatibleOnController":{"value":{"class":"Client::Conflict::HardwareRaidIncompatibleOnController","message":"Hardware RAID is not supported by controller of type {{.controllerType}} on {{.diskGroupName}} on server {{.serverName}}"}},"Client::Conflict::HardwareRaidIncompatibleOnDiskGroup":{"value":{"class":"Client::Conflict::HardwareRaidIncompatibleOnDiskGroup","message":"Hardware RAID is not supported by {{.diskGroupName}} on server {{.serverName}}"}},"Client::Conflict::HardwareRaidIncompatibleOnServer":{"value":{"class":"Client::Conflict::HardwareRaidIncompatibleOnServer","message":"Hardware RAID is not supported by server {{.serverName}}"}},"Client::Conflict::HardwareRaidTooManyDisks":{"value":{"class":"Client::Conflict::HardwareRaidTooManyDisks","message":"Hardware RAID involving more disks ({{.disksNumber}}) than the {{.diskgroupName}} has ({{.maxDisksNumber}}) is not possible on server {{.serverName}}"}},"Client::Conflict::NetworkingNoPublicInterface":{"value":{"class":"Client::Conflict::NetworkingNoPublicInterface","message":"Server {{.serverName}} has no public network interface configured"}},"Client::Conflict::OperatingSystemIncompatible":{"value":{"class":"Client::Conflict::OperatingSystemIncompatible","message":"Operating system {{.operatingSystem}} is not compatible for server {{.serverName}}"}},"Client::Conflict::PartitioningTooManyDisks":{"value":{"class":"Client::Conflict::PartitioningTooManyDisks","message":"Partitioning involving more disks ({{.disksNumber}}) than the {{.diskgroupName}} has ({{.maxDisksNumber}}) is not possible on server {{.serverName}}"}},"Client::Conflict::PartitioningTooManyDisksFileSystem":{"value":{"class":"Client::Conflict::PartitioningTooManyDisksFileSystem","message":"Partitioning involving more disks ({{.disksNumber}}) than the {{.fileSystem}} filesystem supports ({{.maxDisksNumber}}) is not possible"}},"Client::Conflict::PartitioningTooManyDisksOperatingSystem":{"value":{"class":"Client::Conflict::PartitioningTooManyDisksOperatingSystem","message":"Partitioning involving more disks ({{.disksNumber}}) than the operating system {{.operatingSystem}} supports ({{.maxDisksNumber}}) is not possible"}}}}}},"500":{"description":"Error 500 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Server::InternalServerError::DefaultDiskGroup":{"value":{"class":"Server::InternalServerError::DefaultDiskGroup","message":"Error while getting default installable disk group on server {{.serverName}}"}},"Server::InternalServerError::DisturbCreate":{"value":{"class":"Server::InternalServerError::DisturbCreate","message":"An error has occurred while locking server resource {{.serverName}} for OS reinstallation process"}},"Server::InternalServerError::DisturbLink":{"value":{"class":"Server::InternalServerError::DisturbLink","message":"An error has occurred while locking server resource {{.serverName}} for OS reinstallation task {{.taskId}}"}},"Server::InternalServerError::HardwareProfile":{"value":{"class":"Server::InternalServerError::HardwareProfile","message":"An error has occurred while retrieving details for server {{.serverName}}"}},"Server::InternalServerError::HardwareRaidRetrieve":{"value":{"class":"Server::InternalServerError::HardwareRaidRetrieve","message":"Error while retrieving hardware RAID configuration for {{.diskGroupName}}"}},"Server::InternalServerError::NetworkingRetrieve":{"value":{"class":"Server::InternalServerError::NetworkingRetrieve","message":"Error while retrieving networking details for server {{.serverName}}"}},"Server::InternalServerError::OperatingSystemCompatibilityRetrieve":{"value":{"class":"Server::InternalServerError::OperatingSystemCompatibilityRetrieve","message":"Error while retrieving compatibility details for operating system {{.operatingSystem}} on server {{.serverName}}"}},"Server::InternalServerError::OperatingSystemRetrieve":{"value":{"class":"Server::InternalServerError::OperatingSystemRetrieve","message":"Error while retrieving details for operating system {{.operatingSystem}}"}},"Server::InternalServerError::PartitionRetrieve":{"value":{"class":"Server::InternalServerError::PartitionRetrieve","message":"An error has occurred while retrieving partitions for operating system {{.operatingSystem}}"}},"Server::InternalServerError::TaskCreate":{"value":{"class":"Server::InternalServerError::TaskCreate","message":"An error has occurred while creating installation task on server {{.serverName}}"}},"Server::InternalServerError::TaskDateRetrieve":{"value":{"class":"Server::InternalServerError::TaskDateRetrieve","message":"Error while converting {{.date}} to {{.format}} format"}},"Server::InternalServerError::TaskRetrieve":{"value":{"class":"Server::InternalServerError::TaskRetrieve","message":"Error while retrieving task {{.taskId}}"}}}}}},"501":{"description":"Error 501 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Server::NotImplemented::DiskGroupMultipleConfigs":{"value":{"class":"Server::NotImplemented::DiskGroupMultipleConfigs","message":"Multiple ({{.diskgroupsNumber}}) disk groups installation not implemented"}},"Server::NotImplemented::HardwareRaidMultipleConfigs":{"value":{"class":"Server::NotImplemented::HardwareRaidMultipleConfigs","message":"Multiple ({{.hwRaidConfigsNumber}}) hardware RAID configurations not implemented"}}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Deployments@@@10"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: dedicated.server.Reinstall\nresult = client.post(\"/dedicated/server/{serviceName}/reinstall\",\n\tcustomizations = None, #  (type: )\n\toperatingSystem = None, # Operating System name to install (available values for this server can be retrieved using GET /dedicated/server/{serviceName}/install/compatibleTemplates) (type: string)\n\tproperties = None, # (⚠ Deprecated parameter ⚠, use configDriveMetadata customization instead) Arbitrary properties to pass to cloud-init's config drive datasource (type: object)\n\tstorage = None, #  (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: dedicated.server.Reinstall\n$result = $ovh->post(\"/dedicated/server/{serviceName}/reinstall\", array(\n\tcustomizations => null, //  (type: )\n\toperatingSystem => null, // Operating System name to install (available values for this server can be retrieved using GET /dedicated/server/{serviceName}/install/compatibleTemplates) (type: string)\n\tproperties => null, // (⚠ Deprecated parameter ⚠, use configDriveMetadata customization instead) Arbitrary properties to pass to cloud-init's config drive datasource (type: object)\n\tstorage => null, //  (type: array)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:reinstall","required":true}]}}}}