{"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.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.BackupCloud":{"type":"object","description":"Backup Cloud assigned to this server","properties":{"agreements":{"type":"array","description":"Agreement ids waiting for validation","nullable":true,"items":{"type":"integer"},"readOnly":true},"archive":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.backup.BackupContainer"}],"description":"Archive space info.","nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.backup.BackupStatus"}],"description":"Status of the container.","readOnly":true},"storage":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.backup.BackupContainer"}],"description":"Storage space info.","nullable":true,"readOnly":true}}},"dedicated.server.BackupFtp":{"type":"object","description":"Backup Ftp assigned to this server","properties":{"ftpBackupName":{"type":"string","description":"The backup FTP server name","readOnly":true},"quota":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"The disk space available in gigabytes","nullable":true,"readOnly":true},"readOnlyDate":{"type":"string","description":"If not-null, gives the date since when your account was set in read-only mode because the quota was exceeded","nullable":true,"format":"date-time","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.BackupStorageTypeEnum"}],"description":"The backup FTP type","readOnly":true},"usage":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"The disk space currently used on your backup FTP in percent","nullable":true,"readOnly":true}}},"dedicated.server.BackupFtpAcl":{"type":"object","description":"Backup Ftp ACL for this server and Backup Ftp","properties":{"cifs":{"type":"boolean","description":"Whether to allow the CIFS (SMB) protocol for this ACL"},"ftp":{"type":"boolean","description":"Whether to allow the FTP protocol for this ACL"},"ipBlock":{"allOf":[{"$ref":"#/components/schemas/ipBlock"}],"description":"The IP Block specific to this ACL","readOnly":true},"isApplied":{"type":"boolean","description":"Whether the rule has been applied on the Backup Ftp","readOnly":true},"lastUpdate":{"type":"string","description":"Date of the last object modification","format":"date-time","readOnly":true},"nfs":{"type":"boolean","description":"Whether to allow the NFS protocol for this ACL"}}},"dedicated.server.BackupStorageTypeEnum":{"type":"string","description":"Different backup storage type","enum":["included","storage"]},"dedicated.server.CacheTTLEnum":{"type":"integer","description":"Time to live in minutes for cache","enum":[1,3,5,10,15]},"dedicated.server.Firewall":{"type":"object","description":"Firewall attached to this server","properties":{"enabled":{"type":"boolean"},"firewall":{"type":"string","readOnly":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Firewall management IP","readOnly":true},"mode":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.FirewallModeEnum"}],"description":"transparent mode : device is invisible on the network; routed mode : the security appliance is considered to be a router hop in the network","readOnly":true},"model":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.FirewallModelEnum"}],"description":"Firewall model","nullable":true,"readOnly":true}}},"dedicated.server.FirewallModeEnum":{"type":"string","description":"Dedicated server firewall mode","enum":["routed","transparent"]},"dedicated.server.FirewallModelEnum":{"type":"string","description":"Firewall model name","enum":["asa5505","asa5510","asa5520"]},"dedicated.server.Ipmi":{"type":"object","description":"Server IPMI interface","properties":{"activated":{"type":"boolean","description":"true, if IPMI is available on this server","readOnly":true},"supportedFeatures":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.IpmiSupportedFeatures"}],"description":"A structure describing the IPMI supported features","readOnly":true}}},"dedicated.server.IpmiAccessTypeEnum":{"type":"string","description":"Distinct way to acces a KVM IPMI session","enum":["kvmipHtml5URL","kvmipJnlp","serialOverLanSshKey","serialOverLanURL"]},"dedicated.server.IpmiAccessValue":{"type":"object","description":"A structure describing ipmi access value","properties":{"expiration":{"type":"string","description":"Session expiration date","nullable":true,"format":"date-time"},"value":{"type":"string","description":"value","nullable":true}}},"dedicated.server.IpmiSupportedFeatures":{"type":"object","description":"A structure describing the IPMI supported features","properties":{"kvmipHtml5URL":{"type":"boolean","description":"Access to the KVM through an HTML web interface"},"kvmipJnlp":{"type":"boolean","description":"Access to the KVM through a Java web launch application"},"serialOverLanSshKey":{"type":"boolean","description":"Access to the virtual serial port of your server through an SSH client"},"serialOverLanURL":{"type":"boolean","description":"Access to the virtual serial port of your server through an HTML command line interface"}}},"dedicated.server.IpmiTestResult":{"type":"object","description":"A structure describing IPMI test result","properties":{"date":{"type":"string","description":"Test running date","nullable":true,"format":"date-time"},"status":{"type":"string","description":"Test result","nullable":true}}},"dedicated.server.IpmiTestTypeEnum":{"type":"string","description":"Different test can be made on IPMI interface","enum":["http","password","ping"]},"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.backup.BackupContainer":{"type":"object","description":"A structure describing informations about the backup cloud feature","properties":{"cloudProject":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.backup.BackupProject"}],"description":"/cloud project which the container belongs to.","nullable":true},"id":{"type":"string","description":"Container id (can also be used to retrieve the resource in the /cloud api).","nullable":true},"name":{"type":"string","description":"Container name.","nullable":true},"quota":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.backup.BackupQuota"}],"description":"Quota on the current container","nullable":true},"region":{"type":"string","description":"The cloud region which the container belongs to.","nullable":true},"sftp":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.backup.BackupSftp"}],"description":"Sftp connection info","nullable":true},"swift":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.backup.BackupSwift"}],"description":"Swift related information to reach the container","nullable":true}}},"dedicated.server.backup.BackupOffer":{"type":"object","description":"Backup cloud offer description for a dedicated server","properties":{"maxArchive":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Archive container max size.","nullable":true},"maxBandwidthArchive":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Archive volume r/w bandwidth limit: read/write volume offered per month on the container.","nullable":true},"maxBandwidthStorage":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Storage volume r/w bandwidth limit: read/write volume offered per month on the container.","nullable":true},"maxStorage":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Storage container max size.","nullable":true}}},"dedicated.server.backup.BackupPassword":{"type":"object","description":"A structure describing regenerated passwords","properties":{"sftpArchive":{"type":"string","description":"Password to reach the archive container through the sftp gw.","nullable":true,"format":"password"},"sftpStorage":{"type":"string","description":"Password to reach the storage container through the sftp gw.","nullable":true,"format":"password"},"swiftArchive":{"type":"string","description":"Password to reach the archive container through swift.","nullable":true,"format":"password"},"swiftStorage":{"type":"string","description":"Password to reach the storage container through swift.","nullable":true,"format":"password"}}},"dedicated.server.backup.BackupProject":{"type":"object","description":"Cloud project struct.","properties":{"description":{"type":"string","description":"Project description.","nullable":true},"projectId":{"type":"string","description":"Project id.","nullable":true}}},"dedicated.server.backup.BackupQuota":{"type":"object","description":"A structure describing quota associated to the current container","properties":{"maxBandwidth":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Volume r/w bandwidth limit: read/write volume offered per month on the container.","nullable":true},"maxStorage":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Container max size.","nullable":true},"storageUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Volume usage.","nullable":true},"usagePercent":{"type":"number","description":"Volume usage in percent","nullable":true}}},"dedicated.server.backup.BackupSftp":{"type":"object","description":"A structure describing the SFTP access to a container","properties":{"password":{"type":"string","description":"Sftp password.","nullable":true,"format":"password"},"url":{"type":"string","description":"Url","nullable":true},"username":{"type":"string","description":"Username","nullable":true}}},"dedicated.server.backup.BackupStatus":{"type":"object","description":"A structure describing the status of your backup","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.backup.BackupStatusCodeEnum"}],"description":"Status code"},"reason":{"type":"string","description":"Status code reason (when not ok)","nullable":true}}},"dedicated.server.backup.BackupStatusCodeEnum":{"type":"string","description":"Possible values for backup status code","enum":["DELETING","ERROR","OK","SUSPENDED","SUSPENDING","UNKNOWN","WAITING_AGREEMENTS_VALIDATION"]},"dedicated.server.backup.BackupSwift":{"type":"object","description":"A structure describing the information related to Openstack to reach the container.","properties":{"authUrl":{"type":"string","description":"Auth url.","nullable":true},"password":{"type":"string","description":"Openstack password.","nullable":true,"format":"password"},"username":{"type":"string","description":"Openstack username to use swift.","nullable":true}}},"dedicated.server.kvm":{"type":"object","description":"Physical KVM","properties":{"expiration":{"type":"string","description":"KVM expiration date","format":"date-time","readOnly":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"KVM access ip","nullable":true,"readOnly":true},"name":{"type":"string","description":"KVM hostname","readOnly":true}}},"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/server/{serviceName}/backupCloudOfferDetails":{"get":{"summary":"Get the cloud backup offer","description":"Get the cloud backup offer. Returns the cloud backup offer available for the server: the maximum size and the monthly read/write volume of the storage and archive containers. When no offer is available, 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.backup.BackupOffer"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@250"]],"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}/backupCloudOfferDetails\")\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}/backupCloudOfferDetails\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:backupCloudOfferDetails/get","required":true}]}},"/dedicated/server/{serviceName}/features/backupCloud":{"delete":{"summary":"Deactivate the cloud backup","description":"Deactivate the cloud backup. Deactivates the cloud backup of the server. The container data is not deleted.","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"}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@130"]],"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.delete(\"/dedicated/server/{serviceName}/features/backupCloud\")\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->delete(\"/dedicated/server/{serviceName}/features/backupCloud\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupCloud/delete","required":true}]},"get":{"summary":"Get the cloud backup","description":"Get the cloud backup. Returns the cloud backup of the server: its storage and archive containers, its status and the agreements waiting for validation.","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.BackupCloud"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@110"]],"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}/features/backupCloud\")\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}/features/backupCloud\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupCloud/get","required":true}]},"post":{"summary":"Create the cloud backup","description":"Create the cloud backup. Creates the cloud backup of the server, with storage and archive containers in a cloud project. Set cloudProjectId to use an existing project; otherwise a project is created, described by projectDescription.","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":{"cloudProjectId":{"type":"string","description":"cloud project id"},"projectDescription":{"type":"string","description":"Project description of the project to be created (ignored when an existing project is already specified)"}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.BackupCloud"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@120"]],"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}/features/backupCloud\",\n\tcloudProjectId = None, # cloud project id (type: string, nullable)\n\tprojectDescription = None, # Project description of the project to be created (ignored when an existing project is already specified) (type: string, nullable)\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$result = $ovh->post(\"/dedicated/server/{serviceName}/features/backupCloud\", array(\n\tcloudProjectId => null, // cloud project id (type: string, nullable)\n\tprojectDescription => null, // Project description of the project to be created (ignored when an existing project is already specified) (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupCloud/create","required":true}]}},"/dedicated/server/{serviceName}/features/backupCloud/password":{"post":{"summary":"Regenerate cloud backup passwords","description":"Regenerate cloud backup passwords. Regenerates the cloud backup passwords and returns them: the Swift and SFTP passwords of the storage and archive containers.","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.backup.BackupPassword"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@140"]],"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}/features/backupCloud/password\")\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}/features/backupCloud/password\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupCloud/password/create","required":true}]}},"/dedicated/server/{serviceName}/features/backupFTP":{"delete":{"summary":"Delete the backup FTP space","description":"Delete the backup FTP space. Terminates the backup FTP space and returns a task. All data stored on it is permanently deleted.","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","Features@@@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.delete(\"/dedicated/server/{serviceName}/features/backupFTP\")\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->delete(\"/dedicated/server/{serviceName}/features/backupFTP\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupFTP/delete","required":true}]},"get":{"summary":"Get the backup FTP space","description":"Get the backup FTP space. Returns the backup FTP space: its server name, type, available disk space and usage. readOnlyDate is set when the account was switched to read-only because the quota was exceeded.","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.BackupFtp"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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}/features/backupFTP\")\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}/features/backupFTP\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupFTP/get","required":true}]},"post":{"summary":"Create the backup FTP space","description":"Create the backup FTP space. Creates the backup FTP space and returns a task. The IP blocks allowed to reach it, and their protocols, are managed with the access routes.","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","Features@@@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.post(\"/dedicated/server/{serviceName}/features/backupFTP\")\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}/features/backupFTP\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupFTP/create","required":true}]}},"/dedicated/server/{serviceName}/features/backupFTP/access":{"get":{"summary":"List backup FTP ACLs","description":"List backup FTP ACLs. Returns the IP blocks authorized on the backup FTP space. Get an ACL to see the protocols it allows: FTP, NFS and CIFS (SMB).","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/ipBlock"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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/server/{serviceName}/features/backupFTP/access\")\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}/features/backupFTP/access\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupFTP/access/get","required":true}],"x-expanded-response":"DedicatedServerBackupFtpAcl"},"post":{"summary":"Create a backup FTP ACL","description":"Create a backup FTP ACL. Authorizes an IP block on the backup FTP space with the chosen protocols and returns a task. At least one of ftp, nfs and cifs must be enabled; ftp is false when omitted. authorizableBlocks lists the eligible blocks.","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":{"cifs":{"type":"boolean","description":"Whether to allow the CIFS (SMB) protocol for this ACL"},"ftp":{"type":"boolean","description":"Whether to allow the FTP protocol for this ACL"},"ipBlock":{"description":"The IP Block specific to this ACL. It musts belong to your server.","$ref":"#/components/schemas/ipBlock"},"nfs":{"type":"boolean","description":"Whether to allow the NFS protocol for this ACL"}},"required":["cifs","ipBlock","nfs"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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.post(\"/dedicated/server/{serviceName}/features/backupFTP/access\",\n\tcifs = None, # Whether to allow the CIFS (SMB) protocol for this ACL (type: boolean)\n\tftp = None, # Whether to allow the FTP protocol for this ACL (type: boolean, nullable)\n\tipBlock = None, # The IP Block specific to this ACL. It musts belong to your server. (type: ipBlock)\n\tnfs = None, # Whether to allow the NFS protocol for this ACL (type: boolean)\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$result = $ovh->post(\"/dedicated/server/{serviceName}/features/backupFTP/access\", array(\n\tcifs => null, // Whether to allow the CIFS (SMB) protocol for this ACL (type: boolean)\n\tftp => null, // Whether to allow the FTP protocol for this ACL (type: boolean, nullable)\n\tipBlock => null, // The IP Block specific to this ACL. It musts belong to your server. (type: ipBlock)\n\tnfs => null, // Whether to allow the NFS protocol for this ACL (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupFTP/access/create","required":true}]}},"/dedicated/server/{serviceName}/features/backupFTP/access/{ipBlock}":{"delete":{"summary":"Delete a backup FTP ACL","description":"Delete a backup FTP ACL. Revokes the access of the IP block to the backup FTP space and returns a task. The task carries the status of the revocation.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"ipBlock","description":"The IP Block specific to this ACL","required":true,"schema":{"$ref":"#/components/schemas/ipBlock"}},{"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","Features@@@210"]],"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}/features/backupFTP/access/{ipBlock}\")\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->delete(\"/dedicated/server/{serviceName}/features/backupFTP/access/{ipBlock}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupFTP/access/delete","required":true}]},"get":{"summary":"Get a backup FTP ACL","description":"Get a backup FTP ACL. Returns the protocols allowed for the IP block (FTP, NFS, CIFS), whether the rule is applied on the backup FTP space and its last update date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"ipBlock","description":"The IP Block specific to this ACL","required":true,"schema":{"$ref":"#/components/schemas/ipBlock"}},{"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.BackupFtpAcl"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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/server/{serviceName}/features/backupFTP/access/{ipBlock}\")\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}/features/backupFTP/access/{ipBlock}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupFTP/access/get","required":true}]},"put":{"summary":"Update a backup FTP ACL","description":"Update a backup FTP ACL. Updates the protocols allowed for the IP block: ftp, nfs and cifs. The change is applied asynchronously: isApplied stays false until it is in effect.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"ipBlock","description":"The IP Block specific to this ACL","required":true,"schema":{"$ref":"#/components/schemas/ipBlock"}},{"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.BackupFtpAcl"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@220"]],"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.BackupFtpAcl\nresult = client.put(\"/dedicated/server/{serviceName}/features/backupFTP/access/{ipBlock}\",\n\tcifs = None, # Whether to allow the CIFS (SMB) protocol for this ACL (type: boolean)\n\tftp = None, # Whether to allow the FTP protocol for this ACL (type: boolean)\n\tnfs = None, # Whether to allow the NFS protocol for this ACL (type: boolean)\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.BackupFtpAcl\n$result = $ovh->put(\"/dedicated/server/{serviceName}/features/backupFTP/access/{ipBlock}\", array(\n\tcifs => null, // Whether to allow the CIFS (SMB) protocol for this ACL (type: boolean)\n\tftp => null, // Whether to allow the FTP protocol for this ACL (type: boolean)\n\tnfs => null, // Whether to allow the NFS protocol for this ACL (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupFTP/access/edit","required":true}]}},"/dedicated/server/{serviceName}/features/backupFTP/authorizableBlocks":{"get":{"summary":"List authorizable IP blocks","description":"List authorizable IP blocks. Returns the IP blocks of the account that can be authorized in a backup FTP ACL. They include blocks routed to other services of the account, not only to this 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":{"type":"array","items":{"$ref":"#/components/schemas/ipBlock"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@230"]],"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}/features/backupFTP/authorizableBlocks\")\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}/features/backupFTP/authorizableBlocks\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupFTP/authorizableBlocks/get","required":true}]}},"/dedicated/server/{serviceName}/features/backupFTP/password":{"post":{"summary":"Reset the backup FTP password","description":"Reset the backup FTP password. Resets the backup FTP password and returns a task. The response does not contain the new 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":{"$ref":"#/components/schemas/dedicated.server.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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}/features/backupFTP/password\")\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}/features/backupFTP/password\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/backupFTP/password/create","required":true}]}},"/dedicated/server/{serviceName}/features/firewall":{"get":{"summary":"Get the firewall","description":"Get the firewall. Returns the firewall attached to the server: its management IP, model, mode and whether it is enabled. In transparent mode the firewall is invisible on the network; in routed mode it is a router hop.","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.Firewall"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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}/features/firewall\")\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}/features/firewall\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/firewall/get","required":true}]},"put":{"summary":"Update the firewall","description":"Update the firewall. Updates the firewall attached to the server. Only the enabled field can be changed; the other fields 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.Firewall"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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\n# Request body type: dedicated.server.Firewall\nresult = client.put(\"/dedicated/server/{serviceName}/features/firewall\",\n\tenabled = None, #  (type: boolean)\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.Firewall\n$result = $ovh->put(\"/dedicated/server/{serviceName}/features/firewall\", array(\n\tenabled => null, //  (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/firewall/edit","required":true}]}},"/dedicated/server/{serviceName}/features/ipmi":{"get":{"summary":"Get the IPMI interface","description":"Get the IPMI interface. Returns whether IPMI is available on the server and which access methods it supports. KVM is reached through an HTML or Java web interface, and the virtual serial port through an HTML interface or an SSH client.","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.Ipmi"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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\nresult = client.get(\"/dedicated/server/{serviceName}/features/ipmi\")\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}/features/ipmi\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/ipmi/get","required":true}]}},"/dedicated/server/{serviceName}/features/ipmi/access":{"get":{"summary":"Get the IPMI session access","description":"Get the IPMI session access. Returns the access value and the session expiration date for the given access type. Request the access with POST on the same route first: before that, and after expiration, 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"}},{"in":"query","name":"type","description":"IPMI console access","required":true,"schema":{"$ref":"#/components/schemas/dedicated.server.IpmiAccessTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.IpmiAccessValue"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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}/features/ipmi/access\")\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}/features/ipmi/access\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/ipmi/access/get","required":true}]},"post":{"summary":"Request IPMI access","description":"Request IPMI access. Requests an IPMI session for the given access type and returns a task. Once the task is done, read the access value and its expiration date with GET on the same route. sshKey, for serial over LAN SSH access, must be a raw public SSH key.","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":{"ipToAllow":{"description":"IP to allow connection from for this IPMI session","$ref":"#/components/schemas/ipv4"},"sshKey":{"type":"string","description":"Public SSH key for Serial Over Lan SSH access | ⚠️ Starting 2024-08-27, SSH key name will no longer be accepted and only raw public SSH key will remain accepted"},"ttl":{"description":"Session access time to live in minutes","$ref":"#/components/schemas/dedicated.server.CacheTTLEnum"},"type":{"description":"IPMI console access","$ref":"#/components/schemas/dedicated.server.IpmiAccessTypeEnum"}},"required":["ttl","type"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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.post(\"/dedicated/server/{serviceName}/features/ipmi/access\",\n\tipToAllow = None, # IP to allow connection from for this IPMI session (type: ipv4, nullable)\n\tsshKey = None, # Public SSH key for Serial Over Lan SSH access | ⚠️ Starting 2024-08-27, SSH key name will no longer be accepted and only raw public SSH key will remain accepted (type: text, nullable)\n\tttl = None, # Session access time to live in minutes (type: dedicated.server.CacheTTLEnum)\n\ttype = None, # IPMI console access (type: dedicated.server.IpmiAccessTypeEnum)\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$result = $ovh->post(\"/dedicated/server/{serviceName}/features/ipmi/access\", array(\n\tipToAllow => null, // IP to allow connection from for this IPMI session (type: ipv4, nullable)\n\tsshKey => null, // Public SSH key for Serial Over Lan SSH access | ⚠️ Starting 2024-08-27, SSH key name will no longer be accepted and only raw public SSH key will remain accepted (type: text, nullable)\n\tttl => null, // Session access time to live in minutes (type: dedicated.server.CacheTTLEnum)\n\ttype => null, // IPMI console access (type: dedicated.server.IpmiAccessTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/ipmi/access/create","required":true}]}},"/dedicated/server/{serviceName}/features/ipmi/resetInterface":{"post":{"summary":"Reset the IPMI interface","description":"Reset the IPMI interface. Resets the IPMI interface of the server and returns a task. The task carries the status and the completion date of the reset.","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","Features@@@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.post(\"/dedicated/server/{serviceName}/features/ipmi/resetInterface\")\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}/features/ipmi/resetInterface\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/ipmi/resetInterface","required":true}]}},"/dedicated/server/{serviceName}/features/ipmi/resetSessions":{"post":{"summary":"Reset IPMI sessions","description":"Reset IPMI sessions. Resets the IPMI sessions of the server and returns a task. Access values obtained before the reset stop working and must be requested again.","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","Features@@@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.post(\"/dedicated/server/{serviceName}/features/ipmi/resetSessions\")\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}/features/ipmi/resetSessions\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/ipmi/resetSessions","required":true}]}},"/dedicated/server/{serviceName}/features/ipmi/test":{"get":{"summary":"Get an IPMI test result","description":"Get an IPMI test result. Returns the result and the run date of the IPMI test of the given type: http, password or ping. Launch the test with POST on the same route first; the result is kept only for the ttl given at launch.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}},{"in":"query","name":"type","description":"Test type result on KVM IPMI interface","required":true,"schema":{"$ref":"#/components/schemas/dedicated.server.IpmiTestTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.IpmiTestResult"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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}/features/ipmi/test\")\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}/features/ipmi/test\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/ipmi/test/get","required":true}]},"post":{"summary":"Test the IPMI interface","description":"Test the IPMI interface. Launches an http, password or ping test on the IPMI interface and returns a task. ttl sets how long the result is kept: 1, 3, 5, 10 or 15 minutes. The result is read with GET on the same route.","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":{"ttl":{"description":"Result time to live in minutes","$ref":"#/components/schemas/dedicated.server.CacheTTLEnum"},"type":{"description":"Test to make on KVM IPMI interface","$ref":"#/components/schemas/dedicated.server.IpmiTestTypeEnum"}},"required":["ttl","type"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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.post(\"/dedicated/server/{serviceName}/features/ipmi/test\",\n\tttl = None, # Result time to live in minutes (type: dedicated.server.CacheTTLEnum)\n\ttype = None, # Test to make on KVM IPMI interface (type: dedicated.server.IpmiTestTypeEnum)\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$result = $ovh->post(\"/dedicated/server/{serviceName}/features/ipmi/test\", array(\n\tttl => null, // Result time to live in minutes (type: dedicated.server.CacheTTLEnum)\n\ttype => null, // Test to make on KVM IPMI interface (type: dedicated.server.IpmiTestTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/ipmi/test/create","required":true}]}},"/dedicated/server/{serviceName}/features/kvm":{"get":{"summary":"Get the physical KVM","description":"Get the physical KVM. Returns the physical KVM of the server: its hostname, access IP and expiration date. When no physical KVM is installed on the server, 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.kvm"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Features@@@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}/features/kvm\")\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}/features/kvm\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:features/kvm/get","required":true}]}}}}