{"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"}}},"dedicated.DatacenterEnum":{"type":"string","description":"ovh datacenter","enum":["bhs1","bhs2","bhs3","bhs4","bhs5","bhs6","bhs7","bhs8","cch01","crx1","crx2","dc1","eri1","eri2","frcrx41","frcrx42","frcrx43","gra04","gra1","gra2","gra3","gsw","hdf01","hil1","ieb01","itbsi01","itmil01","itzvf01","lil1-int1","lim1","lim2","lim3","mr901","p19","rbx","rbx-hz","rbx1","rbx10","rbx2","rbx3","rbx4","rbx5","rbx6","rbx7","rbx8","rbx9","sbg1","sbg2","sbg3","sbg4","sbg5","sgp02","sgp1","syd03","syd1","syd2","vin1","waw1","ynm1","yyz01"]},"dedicated.ExposedTask":{"type":"object","description":"A task for a dedicated server","properties":{"datacenter":{"allOf":[{"$ref":"#/components/schemas/dedicated.DatacenterEnum"}],"description":"Location of the server"},"description":{"type":"string","description":"Short text describing the entry"},"server":{"type":"string","description":"Name of the dedicated server"},"todoDate":{"type":"string","description":"Timestamp for processing","format":"date-time"}}},"dedicated.PlannedInterventionTimeSlot":{"type":"object","description":"A time slot for a planned intervention","properties":{"endDate":{"type":"string","description":"End date for the planned intervention","format":"date-time"},"startDate":{"type":"string","description":"Start date for the planned intervention","format":"date-time"}}},"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.server.Access":{"type":"object","description":"A structure describing the server's access","properties":{"password":{"type":"string","description":"Password","nullable":true,"format":"password"},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.AccessTypeEnum"}],"description":"Application access type"},"url":{"type":"string","description":"Url","nullable":true},"user":{"type":"string","description":"Login","nullable":true}}},"dedicated.server.AccessTypeEnum":{"type":"string","description":"Application access type","enum":["DIRECTADMIN_PANEL","PLESK_PANEL","PROXMOX_PANEL","RDP","SQL_SERVER","SSH","WEB_PANEL"]},"dedicated.server.BandwidthDetails":{"type":"object","description":"A structure describing bandwidth informations about this dedicated server","properties":{"InternetToOvh":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"bandwidth limitation Internet to OVH","nullable":true},"OvhToInternet":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"bandwidth limitation OVH to Internet","nullable":true},"OvhToOvh":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"bandwidth limitation OVH to OVH","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.BandwidthTypeEnum"}],"description":"bandwidth offer type","nullable":true}}},"dedicated.server.BandwidthTypeEnum":{"type":"string","description":" Different Bandwidth type","enum":["improved","included","platinum","premium","standard","ultimate"]},"dedicated.server.BandwidthvRackDetails":{"type":"object","description":"A structure describing vRack bandwidth informations about this dedicated server","properties":{"bandwidth":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"vrack bandwidth limitation","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.BandwidthvRackTypeEnum"}],"description":"bandwidth offer type","nullable":true}}},"dedicated.server.BandwidthvRackTypeEnum":{"type":"string","description":" Different Bandwidth type","enum":["included","standard"]},"dedicated.server.BootModeEnum":{"type":"string","description":"Server boot mode","enum":["legacy","uefi","uefi-legacy"]},"dedicated.server.CpuFamilyEnum":{"type":"string","description":"cpu family ","enum":["arm64","armhf32","ppc64","x86","x86-ht","x86_64"]},"dedicated.server.Dedicated":{"type":"object","description":"Server informations","properties":{"availabilityZone":{"type":"string","description":"dedicated AZ localisation","readOnly":true},"bootId":{"type":"integer","nullable":true},"bootScript":{"type":"string","description":"Ipxe script served on boot","nullable":true},"commercialRange":{"type":"string","description":"dedicater server commercial range","nullable":true,"readOnly":true},"datacenter":{"allOf":[{"$ref":"#/components/schemas/dedicated.DatacenterEnum"}],"description":"dedicated datacenter localisation","readOnly":true},"efiBootloaderPath":{"type":"string","description":"EfiBootloader path","nullable":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"dedicated server ip","readOnly":true},"linkSpeed":{"type":"integer","nullable":true,"readOnly":true},"monitoring":{"type":"boolean","description":"Icmp monitoring state"},"name":{"type":"string","description":"dedicated server name","readOnly":true},"newUpgradeSystem":{"type":"boolean","readOnly":true},"noIntervention":{"type":"boolean","description":"Prevent datacenter intervention"},"os":{"type":"string","description":"Operating system","readOnly":true},"powerState":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.PowerStateEnum"}],"description":"Power state of the server","readOnly":true},"professionalUse":{"type":"boolean","description":"Does this server have professional use option","readOnly":true},"rack":{"type":"string","readOnly":true},"region":{"type":"string","description":"dedicated region localisation","readOnly":true},"rescueMail":{"type":"string","description":"Custom email used to receive rescue credentials","nullable":true},"rescueSshKey":{"type":"string","description":"Public SSH Key used in the rescue mode","nullable":true},"reverse":{"type":"string","description":"dedicated server reverse","nullable":true,"readOnly":true},"rootDevice":{"type":"string","nullable":true},"serverId":{"type":"integer","description":"your server id","readOnly":true},"state":{"$ref":"#/components/schemas/dedicated.server.StateEnum"},"supportLevel":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.SupportLevelEnum"}],"description":"Dedicated server support level","readOnly":true}}},"dedicated.server.DedicatedWithIAM":{"type":"object","description":"Server informations","properties":{"availabilityZone":{"type":"string","description":"dedicated AZ localisation","readOnly":true},"bootId":{"type":"integer","nullable":true},"bootScript":{"type":"string","description":"Ipxe script served on boot","nullable":true},"commercialRange":{"type":"string","description":"dedicater server commercial range","nullable":true,"readOnly":true},"datacenter":{"allOf":[{"$ref":"#/components/schemas/dedicated.DatacenterEnum"}],"description":"dedicated datacenter localisation","readOnly":true},"efiBootloaderPath":{"type":"string","description":"EfiBootloader path","nullable":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"dedicated server ip","readOnly":true},"linkSpeed":{"type":"integer","nullable":true,"readOnly":true},"monitoring":{"type":"boolean","description":"Icmp monitoring state"},"name":{"type":"string","description":"dedicated server name","readOnly":true},"newUpgradeSystem":{"type":"boolean","readOnly":true},"noIntervention":{"type":"boolean","description":"Prevent datacenter intervention"},"os":{"type":"string","description":"Operating system","readOnly":true},"powerState":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.PowerStateEnum"}],"description":"Power state of the server","readOnly":true},"professionalUse":{"type":"boolean","description":"Does this server have professional use option","readOnly":true},"rack":{"type":"string","readOnly":true},"region":{"type":"string","description":"dedicated region localisation","readOnly":true},"rescueMail":{"type":"string","description":"Custom email used to receive rescue credentials","nullable":true},"rescueSshKey":{"type":"string","description":"Public SSH Key used in the rescue mode","nullable":true},"reverse":{"type":"string","description":"dedicated server reverse","nullable":true,"readOnly":true},"rootDevice":{"type":"string","nullable":true},"serverId":{"type":"integer","description":"your server id","readOnly":true},"state":{"$ref":"#/components/schemas/dedicated.server.StateEnum"},"supportLevel":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.SupportLevelEnum"}],"description":"Dedicated server support level","readOnly":true}}},"dedicated.server.FormFactorEnum":{"type":"string","description":"Server form factor","enum":["0.25u","0.5u","1u","2u","3u","4u"]},"dedicated.server.HardwareSpecifications":{"type":"object","description":"A structure describing informations about this dedicated server","properties":{"bootMode":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.BootModeEnum"}],"description":"Server boot mode"},"coresPerProcessor":{"type":"integer","description":"number of cores per processor","nullable":true},"defaultDiskGroupId":{"type":"integer","description":"Default disk group id used for OS reinstallation when not specified","nullable":true},"defaultHardwareRaidSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Default hardware raid size for this server","nullable":true},"defaultHardwareRaidType":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.HardwareSpecificationsRaidHardEnum"}],"description":"Default hardware raid type configured on this server","nullable":true},"description":{"type":"string","description":"commercial name of this server","nullable":true},"diskGroups":{"type":"array","description":"details about the groups of disks in the server","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.HardwareSpecificationsDisk"}},"expansionCards":{"type":"array","description":"details about the server's expansion cards","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.HardwareSpecificationsExpansionCard"}},"formFactor":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.FormFactorEnum"}],"description":"Server form factor","nullable":true},"memorySize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"ram capacity","nullable":true},"motherboard":{"type":"string","description":"server motherboard","nullable":true},"numberOfProcessors":{"type":"integer","description":"number of processors in this dedicated server","nullable":true},"processorArchitecture":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.CpuFamilyEnum"}],"description":"processor architecture bit","nullable":true},"processorName":{"type":"string","description":"processor name","nullable":true},"threadsPerProcessor":{"type":"integer","description":"number of threads per processor","nullable":true},"usbKeys":{"type":"array","description":"Capacity of the USB keys installed on your server, if any","nullable":true,"items":{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}}}},"dedicated.server.HardwareSpecificationsDisk":{"type":"object","description":"A structure describing informations about server disks","properties":{"defaultHardwareRaidSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"default hardware raid size for this disk group","nullable":true},"defaultHardwareRaidType":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.HardwareSpecificationsRaidHardEnum"}],"description":"default hardware raid type for this disk group","nullable":true},"description":{"type":"string","description":"human readable description of this disk group","nullable":true},"diskGroupId":{"type":"integer","description":"identifier of this disk group","nullable":true},"diskSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"disk capacity","nullable":true},"diskType":{"type":"string","description":"type of the disk (SSD, SATA, SAS, ...)","nullable":true},"numberOfDisks":{"type":"integer","description":"number of disks in this group","nullable":true},"raidController":{"type":"string","description":"raid controller, if any, managing this group of disks","nullable":true}}},"dedicated.server.HardwareSpecificationsExpansionCard":{"type":"object","description":"A structure describing informations about server expansion cards","properties":{"description":{"type":"string","description":"expansion card description"},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.HardwareSpecificationsExpansionCardTypeEnum"}],"description":"expansion card type"}}},"dedicated.server.HardwareSpecificationsExpansionCardTypeEnum":{"type":"string","description":"Expansion card type enum","enum":["fpga","gpu"]},"dedicated.server.HardwareSpecificationsRaidHardEnum":{"type":"string","description":"Raid hard configuration","enum":["raid0","raid1","raid10","raid1E","raid5","raid50","raid6","raid60"]},"dedicated.server.IpBlockSizeEnum":{"type":"integer","description":"IP block size","enum":[1,4,8,16,32,64,128,256]},"dedicated.server.IpOrderable":{"type":"object","description":"A structure describing informations about orderable IP address","properties":{"ipv4":{"type":"array","description":"Orderable IP v4 details","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.IpOrderableDetails"}},"ipv6":{"type":"array","description":"Orderable IP v6 details","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.IpOrderableDetails"}}}},"dedicated.server.IpOrderableDetails":{"type":"object","description":"A structure describing informations about orderable IP address","properties":{"blockSizes":{"type":"array","description":"Orderable IP blocks sizes","items":{"$ref":"#/components/schemas/dedicated.server.IpBlockSizeEnum"}},"included":{"type":"boolean","description":"Are those IP included with your offer"},"ipNumber":{"type":"integer","description":"Total number of IP that can be routed to this server","nullable":true},"number":{"type":"integer","description":"Total number of prefixes that can be routed to this server"},"optionRequired":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.OptionRequiredEnum"}],"description":"Which option is required to order this type of IP","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.IpTypeOrderableEnum"}],"description":"this IP type"}}},"dedicated.server.IpTypeOrderableEnum":{"type":"string","description":"Orderable IP type","enum":["failover","static","unshielded"]},"dedicated.server.NetworkSpecifications":{"type":"object","description":"A structure describing network informations about this dedicated server","properties":{"bandwidth":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.BandwidthDetails"}],"description":"Bandwidth details","nullable":true},"connection":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Network connection flow rate","nullable":true},"ola":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.OlaDetails"}],"description":"OLA details","nullable":true},"routing":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.RoutingDetails"}],"description":"Routing details","nullable":true},"switching":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.SwitchingDetails"}],"description":"Switching details","nullable":true},"traffic":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.TrafficDetails"}],"description":"Traffic details","nullable":true},"vmac":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.VmacDetails"}],"description":"A structure describing VMAC Infos for this dedicated server"},"vrack":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.BandwidthvRackDetails"}],"description":"vRack details","nullable":true}}},"dedicated.server.OlaAvailableModes":{"type":"object","description":"A structure describing OVH Link Aggregation available modes","properties":{"default":{"type":"boolean","description":"Is it the default configuration of the server"},"interfaces":{"type":"array","description":"Interface layout","items":{"$ref":"#/components/schemas/dedicated.server.OlaInterface"}},"name":{"type":"string","description":"Mode name"}}},"dedicated.server.OlaDetails":{"type":"object","description":"A structure describing OVH Link Aggregation available modes for this dedicated server","properties":{"available":{"type":"boolean","description":"Is the OLA feature available"},"availableModes":{"type":"array","description":"What modes are supported","items":{"$ref":"#/components/schemas/dedicated.server.OlaAvailableModes"}},"supportedModes":{"type":"array","description":"(DEPRECATED) What modes are supported","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.virtualNetworkInterface.VirtualNetworkInterfaceModeEnum"}}}},"dedicated.server.OlaInterface":{"type":"object","description":"A structure describing OVH Link Aggregation interface configuration","properties":{"aggregation":{"type":"boolean","description":"Interface aggregation status"},"count":{"type":"integer","description":"Interface count"},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.OlaInterfaceModeEnum"}],"description":"Interface mode"}}},"dedicated.server.OlaInterfaceModeEnum":{"type":"string","description":"An enum describing OVH Link Aggregation interface types","enum":["public","vrack"]},"dedicated.server.Option":{"type":"object","description":"Information about the options of a dedicated server","properties":{"option":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.OptionEnum"}],"description":"The option name","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.OptionStateEnum"}],"description":"The state of the option","readOnly":true}}},"dedicated.server.OptionEnum":{"type":"string","description":"All options a dedicated server can have and release","enum":["BACKUPPROTOCOL","BANDWIDTH","BANDWIDTH_VRACK","OLA","SGX","TRAFFIC","TRAFFIC_DISCOVER","TUNING","TUNING_FIREWALL","TUNING_KVM","USB_KVM_IP"]},"dedicated.server.OptionRequiredEnum":{"type":"string","description":"Required option","enum":["professionalUse"]},"dedicated.server.OptionStateEnum":{"type":"string","description":"All states a dedicated server option can be in","enum":["released","subscribed"]},"dedicated.server.PowerStateEnum":{"type":"string","description":"Power states of a Dedicated","enum":["poweroff","poweron"]},"dedicated.server.RoutingDetails":{"type":"object","description":"A structure describing routing informations about this dedicated server","properties":{"ipv4":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.RoutingDetailsIpv4"}],"description":"Ipv4 routing details","nullable":true},"ipv6":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.RoutingDetailsIpv6"}],"description":"Ipv6 routing details","nullable":true}}},"dedicated.server.RoutingDetailsIpv4":{"type":"object","description":"A structure describing IPv4 routing informations about this dedicated server","properties":{"gateway":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Server gateway","nullable":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Server main IP","nullable":true},"network":{"allOf":[{"$ref":"#/components/schemas/ipv4Block"}],"description":"Server network","nullable":true}}},"dedicated.server.RoutingDetailsIpv6":{"type":"object","description":"A structure describing IPv6 routing informations about this dedicated server","properties":{"gateway":{"allOf":[{"$ref":"#/components/schemas/ipv6"}],"description":"Server gateway","nullable":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv6Block"}],"description":"Server main IP","nullable":true},"network":{"allOf":[{"$ref":"#/components/schemas/ipv6Block"}],"description":"Server network","nullable":true}}},"dedicated.server.StateEnum":{"type":"string","description":"All states a Dedicated can in","enum":["error","hacked","hackedBlocked","ok"]},"dedicated.server.SupportLevelEnum":{"type":"string","description":"distincts support level","enum":["critical","fastpath","gs","pro"]},"dedicated.server.SupportReplaceHddInfo":{"type":"object","description":"Hdd replace support request details. ","properties":{"disk_serial":{"type":"string","description":"Disk serial number"},"slot_id":{"type":"integer","description":"Disk slotId (if any)","nullable":true}}},"dedicated.server.SwitchingDetails":{"type":"object","description":"A structure describing switching informations about this dedicated server","properties":{"name":{"type":"string","description":"Switch name","nullable":true}}},"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.TrafficDetails":{"type":"object","description":"A structure describing traffic informations about this dedicated server","properties":{"inputQuotaSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Monthly input traffic quota allowed","nullable":true},"inputQuotaUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Monthly input traffic consumed this month","nullable":true},"isThrottled":{"type":"boolean","description":"Is bandwidth throttleted for being over quota","nullable":true},"outputQuotaSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Monthly output traffic quota allowed","nullable":true},"outputQuotaUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Monthly output traffic consumed this month","nullable":true},"resetQuotaDate":{"type":"string","description":"Next reset quota date for traffic counter","nullable":true}}},"dedicated.server.VmacDetails":{"type":"object","description":"A structure describing VMAC Infos for this dedicated server","properties":{"quota":{"type":"integer","description":"Maximum number of VirtualMacs allowed on this server"},"supported":{"type":"boolean","description":"Server is compatible vmac or not"}}},"dedicated.virtualNetworkInterface.VirtualNetworkInterfaceModeEnum":{"type":"string","description":"Available VirtualNetworkInterface modes","enum":["public","public_aggregation","vrack","vrack_aggregation"]},"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"},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value (defaults to 'EQ')","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"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"},"service.RenewType":{"type":"object","description":"Map a possible renew for a specific service","properties":{"automatic":{"type":"boolean","description":"The service is automatically renewed"},"deleteAtExpiration":{"type":"boolean","description":"The service will be deleted at expiration"},"forced":{"type":"boolean","description":"The service forced to be renewed"},"manualPayment":{"type":"boolean","description":"The service needs to be manually renewed and paid","nullable":true},"period":{"type":"integer","description":"period of renew in month","nullable":true}}},"service.RenewalTypeEnum":{"type":"string","description":"Detailed renewal type of a service","enum":["automaticForcedProduct","automaticV2012","automaticV2014","automaticV2016","automaticV2024","manual","oneShot","option"]},"service.StateEnum":{"type":"string","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"]},"service.TerminationFutureUseEnum":{"type":"string","description":"All future uses you can provide for a service termination","enum":["NOT_REPLACING_SERVICE","OTHER","SUBSCRIBE_AN_OTHER_SERVICE","SUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITOR","SUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITOR"]},"service.TerminationReasonEnum":{"type":"string","description":"All reasons you can provide for a service termination","enum":["FEATURES_DONT_SUIT_ME","LACK_OF_PERFORMANCES","MIGRATED_TO_ANOTHER_OVH_PRODUCT","MIGRATED_TO_COMPETITOR","NOT_ENOUGH_RECOGNITION","NOT_NEEDED_ANYMORE","NOT_RELIABLE","NO_ANSWER","OTHER","PRODUCT_DIMENSION_DONT_SUIT_ME","PRODUCT_TOOLS_DONT_SUIT_ME","TOO_EXPENSIVE","TOO_HARD_TO_USE","UNSATIFIED_BY_CUSTOMER_SUPPORT"]},"services.Service":{"type":"object","description":"Details about a Service","properties":{"canDeleteAtExpiration":{"type":"boolean","description":"Indicates that the service can be set up to be deleted at expiration","readOnly":true},"contactAdmin":{"type":"string","readOnly":true},"contactBilling":{"type":"string","readOnly":true},"contactTech":{"type":"string","readOnly":true},"creation":{"type":"string","format":"date","readOnly":true},"domain":{"type":"string","readOnly":true},"engagedUpTo":{"type":"string","nullable":true,"format":"date","readOnly":true},"expiration":{"type":"string","format":"date","readOnly":true},"possibleRenewPeriod":{"type":"array","description":"All the possible renew period of your service in month","nullable":true,"items":{"type":"integer"},"readOnly":true},"renew":{"allOf":[{"$ref":"#/components/schemas/service.RenewType"}],"description":"Way of handling the renew","nullable":true},"renewalType":{"allOf":[{"$ref":"#/components/schemas/service.RenewalTypeEnum"}],"readOnly":true},"serviceId":{"type":"integer","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/service.StateEnum"}],"readOnly":true}}},"support.NewMessageInfo":{"type":"object","description":"Newly created support identifiers","properties":{"additionalNotice":{"type":"string","description":"Notice or warning","nullable":true},"messageId":{"type":"integer","description":"Message identifier"},"ticketId":{"type":"integer","description":"Ticket identifier"},"ticketNumber":{"type":"integer","description":"Ticket external 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/server":{"get":{"summary":"List servers","description":"List servers. Returns the names of the dedicated servers the account can access. Each name is the serviceName used by the other calls on a server.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:get","required":true}],"x-expanded-response":"DedicatedServerDedicatedWithIAM"}},"/dedicated/server/{serviceName}":{"get":{"summary":"Get a server","description":"Get a server. Returns the properties of the server, such as its datacenter, IP address, operating system, power state, and boot and rescue settings. The response also contains the IAM metadata of 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.DedicatedWithIAM"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:get","required":true}]},"put":{"summary":"Update a server","description":"Update a server. Updates the writable properties of the server, such as its boot, rescue, monitoring and datacenter intervention settings. The other properties are read-only.","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.Dedicated"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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\n# Request body type: dedicated.server.Dedicated\nresult = client.put(\"/dedicated/server/{serviceName}\",\n\tbootId = None, # (type: integer, nullable)\n\tbootScript = None, # Ipxe script served on boot (type: string, nullable)\n\tefiBootloaderPath = None, # EfiBootloader path (type: string, nullable)\n\tmonitoring = None, # Icmp monitoring state (type: boolean)\n\tnoIntervention = None, # Prevent datacenter intervention (type: boolean)\n\trescueMail = None, # Custom email used to receive rescue credentials (type: string, nullable)\n\trescueSshKey = None, # Public SSH Key used in the rescue mode (type: string, nullable)\n\trootDevice = None, # (type: string, nullable)\n\tstate = None, # (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"put(\"/dedicated/server/{serviceName}\", array(\n\tbootId => null, // (type: integer, nullable)\n\tbootScript => null, // Ipxe script served on boot (type: string, nullable)\n\tefiBootloaderPath => null, // EfiBootloader path (type: string, nullable)\n\tmonitoring => null, // Icmp monitoring state (type: boolean)\n\tnoIntervention => null, // Prevent datacenter intervention (type: boolean)\n\trescueMail => null, // Custom email used to receive rescue credentials (type: string, nullable)\n\trescueSshKey => null, // Public SSH Key used in the rescue mode (type: string, nullable)\n\trootDevice => null, // (type: string, nullable)\n\tstate => null, // (type: )\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:put","required":true}]}},"/dedicated/server/{serviceName}/authenticationSecret":{"post":{"summary":"Get access credentials","description":"Get access credentials. Returns the credentials to connect to the server or to an application installed on it, such as SSH, RDP, SQL Server or a web control panel. Each entry gives the access type, URL, login and password.","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":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.server.Access"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@240"]],"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}/authenticationSecret\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/dedicated/server/{serviceName}/authenticationSecret\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:authenticationSecret/create","required":true}]}},"/dedicated/server/{serviceName}/changeContact":{"post":{"summary":"Change service contacts","description":"Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.","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":{"type":"object","properties":{"contactAdmin":{"type":"string","description":"The contact to set as admin contact"},"contactBilling":{"type":"string","description":"The contact to set as billing contact"},"contactTech":{"type":"string","description":"The contact to set as tech contact"}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@250"]],"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: coreTypes.AccountId:string\nresult = client.post(\"/dedicated/server/{serviceName}/changeContact\",\n\tcontactAdmin = None, # The contact to set as admin contact (type: coreTypes.AccountId:string, nullable)\n\tcontactBilling = None, # The contact to set as billing contact (type: coreTypes.AccountId:string, nullable)\n\tcontactTech = None, # The contact to set as tech contact (type: coreTypes.AccountId:string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/dedicated/server/{serviceName}/changeContact\", array(\n\tcontactAdmin => null, // The contact to set as admin contact (type: coreTypes.AccountId:string, nullable)\n\tcontactBilling => null, // The contact to set as billing contact (type: coreTypes.AccountId:string, nullable)\n\tcontactTech => null, // The contact to set as tech contact (type: coreTypes.AccountId:string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:changeContact","required":true}]}},"/dedicated/server/{serviceName}/confirmTermination":{"post":{"summary":"Confirm service termination","description":"Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.","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":{"type":"object","properties":{"commentary":{"type":"string","description":"Commentary about your termination request"},"futureUse":{"description":"What next after your termination request","$ref":"#/components/schemas/service.TerminationFutureUseEnum"},"reason":{"description":"Reason of your termination request","$ref":"#/components/schemas/service.TerminationReasonEnum"},"token":{"type":"string","description":"The termination token sent by email to the admin contact"}},"required":["token"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@270"]],"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}/confirmTermination\",\n\tcommentary = None, # Commentary about your termination request (type: string, nullable)\n\tfutureUse = None, # What next after your termination request (type: service.TerminationFutureUseEnum, nullable)\n\treason = None, # Reason of your termination request (type: service.TerminationReasonEnum, nullable)\n\ttoken = None, # The termination token sent by email to the admin contact (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/dedicated/server/{serviceName}/confirmTermination\", array(\n\tcommentary => null, // Commentary about your termination request (type: string, nullable)\n\tfutureUse => null, // What next after your termination request (type: service.TerminationFutureUseEnum, nullable)\n\treason => null, // Reason of your termination request (type: service.TerminationReasonEnum, nullable)\n\ttoken => null, // The termination token sent by email to the admin contact (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:confirmTermination","required":true}]}},"/dedicated/server/{serviceName}/ongoing":{"get":{"summary":"List ongoing tasks","description":"List ongoing tasks. Returns what is in progress on the server. Each entry gives a short description, the datacenter of the server and the processing 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":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.ExposedTask"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@200"]],"x-badges":[{"color":"blue","label":"Beta 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}/ongoing\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}/ongoing\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:ongoing/get","required":true}]}},"/dedicated/server/{serviceName}/option":{"get":{"summary":"List options","description":"List options. Returns the names of the options of the server. Get an option to know whether it is subscribed or released.","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":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.server.OptionEnum"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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/server/{serviceName}/option\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}/option\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:option/get","required":true}],"x-expanded-response":"DedicatedServerOption"}},"/dedicated/server/{serviceName}/option/{option}":{"delete":{"summary":"Release an option","description":"Release an option. Releases an option of the server, identified by its name, such as BANDWIDTH, TRAFFIC or USB_KVM_IP. The name is one of the options a server can have and release.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"option","description":"The option name","required":true,"schema":{"$ref":"#/components/schemas/dedicated.server.OptionEnum"}},{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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.delete(\"/dedicated/server/{serviceName}/option/{option}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"delete(\"/dedicated/server/{serviceName}/option/{option}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:option/delete","required":true}]},"get":{"summary":"Get an option","description":"Get an option. Returns the state of an option of the server, subscribed or released. The option is identified by its name, such as BANDWIDTH, OLA or SGX.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"option","description":"The option name","required":true,"schema":{"$ref":"#/components/schemas/dedicated.server.OptionEnum"}},{"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.Option"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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/server/{serviceName}/option/{option}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}/option/{option}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:option/get","required":true}]}},"/dedicated/server/{serviceName}/serviceInfos":{"get":{"summary":"Get service information","description":"Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.","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/services.Service"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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}/serviceInfos\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:serviceInfos/get","required":true}]},"put":{"summary":"Update service information","description":"Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.","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/services.Service"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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\n# Request body type: services.Service\nresult = client.put(\"/dedicated/server/{serviceName}/serviceInfos\",\n\trenew = None, # Way of handling the renew (type: service.RenewType, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"put(\"/dedicated/server/{serviceName}/serviceInfos\", array(\n\trenew => null, // Way of handling the renew (type: service.RenewType, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:serviceInfos/edit","required":true}]}},"/dedicated/server/{serviceName}/specifications/hardware":{"get":{"summary":"Get the hardware specifications","description":"Get the hardware specifications. Returns the hardware of the server: commercial name, processors, memory, disk groups, expansion cards, motherboard, form factor and default RAID settings.","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.HardwareSpecifications"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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}/specifications/hardware\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}/specifications/hardware\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:specifications/hardware/get","required":true}]}},"/dedicated/server/{serviceName}/specifications/ip":{"get":{"summary":"Get the IP capabilities","description":"Get the IP capabilities. Returns the IPv4 and IPv6 addresses that can be ordered for the server. For each IP type, it gives the orderable block sizes, how many IPs and prefixes can be routed to the server, and whether they are included in the offer.","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.IpOrderable"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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.get(\"/dedicated/server/{serviceName}/specifications/ip\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}/specifications/ip\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:specifications/ip/get","required":true}]}},"/dedicated/server/{serviceName}/specifications/network":{"get":{"summary":"Get the network specifications","description":"Get the network specifications. Returns the network specifications of the server: connection rate, bandwidth, vRack bandwidth, traffic, OLA, routing, switching and virtual MAC details.","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.NetworkSpecifications"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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/{serviceName}/specifications/network\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}/specifications/network\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:specifications/network/get","required":true}]}},"/dedicated/server/{serviceName}/support/replace/cooling":{"post":{"summary":"Request a cooling module replacement","description":"Request a cooling module replacement. Opens a support request to replace a cooling module of the server, with a comment and technical details or logs. Returns the identifiers of the created support ticket and message.","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":{"type":"object","properties":{"comment":{"type":"string","description":"User comment"},"details":{"type":"string","description":"Technical details or logs"}},"required":["comment","details"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/support.NewMessageInfo"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@210"]],"x-badges":[{"color":"blue","label":"Beta 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}/support/replace/cooling\",\n\tcomment = None, # User comment (type: text)\n\tdetails = None, # Technical details or logs (type: text)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/dedicated/server/{serviceName}/support/replace/cooling\", array(\n\tcomment => null, // User comment (type: text)\n\tdetails => null, // Technical details or logs (type: text)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:support/replace/cooling/create","required":true}]}},"/dedicated/server/{serviceName}/support/replace/hardDiskDrive":{"post":{"summary":"Request a disk replacement","description":"Request a disk replacement. Opens a support request to replace disks of the server, identified by serial number or slot. With inverse set to true, the listed disks are kept and all the other disks are replaced. Returns the identifiers of the created support ticket and message.","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":{"type":"object","properties":{"comment":{"type":"string","description":"User comment"},"disks":{"type":"array","description":"If 'inverse' is set as 'false', the list of HDD TO REPLACE. If 'inverse' is set as 'true', the list of HDD TO NOT REPLACE.","items":{"$ref":"#/components/schemas/dedicated.server.SupportReplaceHddInfo"}},"inverse":{"type":"boolean","description":"If set to 'true', replace only NON LISTED DISKS"}},"required":["comment","disks","inverse"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/support.NewMessageInfo"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@220"]],"x-badges":[{"color":"blue","label":"Beta 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: boolean\nresult = client.post(\"/dedicated/server/{serviceName}/support/replace/hardDiskDrive\",\n\tcomment = None, # User comment (type: text)\n\tdisks = None, # If 'inverse' is set as 'false', the list of HDD TO REPLACE. If 'inverse' is set as 'true', the list of HDD TO NOT REPLACE. (type: dedicated.server.SupportReplaceHddInfo[])\n\tinverse = None, # If set to 'true', replace only NON LISTED DISKS (type: boolean)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/dedicated/server/{serviceName}/support/replace/hardDiskDrive\", array(\n\tcomment => null, // User comment (type: text)\n\tdisks => null, // If 'inverse' is set as 'false', the list of HDD TO REPLACE. If 'inverse' is set as 'true', the list of HDD TO NOT REPLACE. (type: dedicated.server.SupportReplaceHddInfo[])\n\tinverse => null, // If set to 'true', replace only NON LISTED DISKS (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:support/replace/hardDiskDrive/create","required":true}]}},"/dedicated/server/{serviceName}/support/replace/memory":{"post":{"summary":"Request a memory module replacement","description":"Request a memory module replacement. Opens a support request to replace a faulty RAM module of the server, with a comment and technical details or logs. The faulty slots can be listed if known. Returns the identifiers of the created support ticket and message.","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":{"type":"object","properties":{"comment":{"type":"string","description":"User comment"},"details":{"type":"string","description":"Technical details or logs"},"slots":{"type":"array","description":"The list of faulty RAM slots (if you have the information)","items":{"type":"string"}}},"required":["comment","details"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/support.NewMessageInfo"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@230"]],"x-badges":[{"color":"blue","label":"Beta 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: string[]\nresult = client.post(\"/dedicated/server/{serviceName}/support/replace/memory\",\n\tcomment = None, # User comment (type: text)\n\tdetails = None, # Technical details or logs (type: text)\n\tslots = None, # The list of faulty RAM slots (if you have the information) (type: string[], nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/dedicated/server/{serviceName}/support/replace/memory\", array(\n\tcomment => null, // User comment (type: text)\n\tdetails => null, // Technical details or logs (type: text)\n\tslots => null, // The list of faulty RAM slots (if you have the information) (type: string[], nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:support/replace/memory/create","required":true}]}},"/dedicated/server/{serviceName}/task":{"get":{"summary":"List tasks","description":"List tasks. Returns the IDs of the tasks of the server, such as reboots, reinstallations and IP moves. Filter them by function or status.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"function","description":"Filter the value of function property (=)","schema":{"$ref":"#/components/schemas/dedicated.TaskFunctionEnum"}},{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}},{"in":"query","name":"status","description":"Filter the value of status property (=)","schema":{"$ref":"#/components/schemas/dedicated.TaskStatusEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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/server/{serviceName}/task\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}/task\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:task/get","required":true}],"x-expanded-response":"DedicatedServerTask"}},"/dedicated/server/{serviceName}/task/{taskId}":{"get":{"summary":"Get a task","description":"Get a task. Returns the function, status and dates of a task of the server. needSchedule tells whether the task must be scheduled, and plannedInterventionId links it to a planned intervention.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","description":"the id of the task","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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/server/{serviceName}/task/{taskId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}/task/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:task/get","required":true}]}},"/dedicated/server/{serviceName}/task/{taskId}/availableTimeslots":{"get":{"summary":"List available time slots","description":"List available time slots. Returns the time slots available for the planned intervention of a task, between periodStart and periodEnd. Only a task whose needSchedule is true has slots; any other task returns an error.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"periodEnd","description":"End of the period to query","required":true,"schema":{"type":"string","format":"date"}},{"in":"query","name":"periodStart","description":"Begining of the period to query","required":true,"schema":{"type":"string","format":"date"}},{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","description":"the id of the task","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.PlannedInterventionTimeSlot"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@170"]],"x-badges":[{"color":"blue","label":"Beta 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}/task/{taskId}/availableTimeslots\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/dedicated/server/{serviceName}/task/{taskId}/availableTimeslots\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:task/availableTimeslots/get","required":true}]}},"/dedicated/server/{serviceName}/task/{taskId}/cancel":{"post":{"summary":"Cancel a task","description":"Cancel a task. Stops the progression of a task of the server, if possible. Not every task can be canceled: a task that is already done returns an error.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","description":"the id of the task","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@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.post(\"/dedicated/server/{serviceName}/task/{taskId}/cancel\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/dedicated/server/{serviceName}/task/{taskId}/cancel\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:task/cancel","required":true}]}},"/dedicated/server/{serviceName}/task/{taskId}/schedule":{"post":{"summary":"Schedule an intervention","description":"Schedule an intervention. Schedules the intervention linked to a task at the wanted start date. The body must also state whether a backup of the data has been made. A task whose needSchedule is false cannot be scheduled.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","description":"the id of the task","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hasPerformedBackup":{"type":"boolean","description":"Whether or not you have made a backup of your data"},"wantedBeginingDate":{"type":"string","description":"Wanted begining date for your intervention","format":"date-time"}},"required":["hasPerformedBackup","wantedBeginingDate"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@190"]],"x-badges":[{"color":"blue","label":"Beta 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}/task/{taskId}/schedule\",\n\thasPerformedBackup = None, # Whether or not you have made a backup of your data (type: boolean)\n\twantedBeginingDate = None, # Wanted begining date for your intervention (type: datetime)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/dedicated/server/{serviceName}/task/{taskId}/schedule\", array(\n\thasPerformedBackup => null, // Whether or not you have made a backup of your data (type: boolean)\n\twantedBeginingDate => null, // Wanted begining date for your intervention (type: datetime)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:task/schedule","required":true}]}},"/dedicated/server/{serviceName}/terminate":{"post":{"summary":"Request service termination","description":"Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the `confirmTermination` call.","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":{"type":"string"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@260"]],"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}/terminate\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/dedicated/server/{serviceName}/terminate\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:terminate","required":true}]}}}}