{"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 !"},"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"},"vps.AutomatedBackup":{"type":"object","description":"Backup your VPS","properties":{"rotation":{"type":"integer","description":"Number of rotation of your daily backup","nullable":true,"readOnly":true},"schedule":{"allOf":[{"$ref":"#/components/schemas/time"}],"description":"Scheduled time of your daily backup","nullable":true,"readOnly":true},"serviceResourceName":{"type":"string","description":"Resource name of the service of your automated backup","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/vps.BackupStateEnum"}],"description":"Backup state","readOnly":true}}},"vps.BackupStateEnum":{"type":"string","description":"Available AutomatedBackup states","enum":["disabled","enabled"]},"vps.DownloadSnapshotURL":{"type":"object","description":"URL to download the VPS snapshot","properties":{"size":{"type":"integer","description":"Snapshot size (bytes)","readOnly":true},"url":{"type":"string","description":"URL to download the snapshot","readOnly":true}}},"vps.RestoreStateEnum":{"type":"string","description":"Available restore state","enum":["available","restored","restoring"]},"vps.RestoreTypeEnum":{"type":"string","description":"Available restore types","enum":["file","full"]},"vps.Snapshot":{"type":"object","description":"Information about the snapshot of a VPS Virtual Machine","properties":{"creationDate":{"type":"string","format":"date-time","readOnly":true},"description":{"type":"string"},"id":{"type":"string","readOnly":true},"region":{"type":"string","nullable":true,"readOnly":true}}},"vps.Task":{"type":"object","description":"Operation on a VPS Virtual Machine","properties":{"date":{"type":"string","format":"date-time","readOnly":true},"id":{"type":"integer","readOnly":true},"progress":{"type":"integer","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/vps.TaskStateEnum"}],"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/vps.TaskTypeEnum"}],"readOnly":true}}},"vps.TaskStateEnum":{"type":"string","description":"All states a VPS task can be in","enum":["blocked","cancelled","doing","done","error","paused","todo","waitingAck"]},"vps.TaskTypeEnum":{"type":"string","description":"All type a VPS task can be","enum":["addVeeamBackupJob","changeRootPassword","createSnapshot","deleteSnapshot","deliverVm","getConsoleUrl","internalTask","migrate","openConsoleAccess","provisioningAdditionalIp","reOpenVm","rebootVm","reinstallVm","removeVeeamBackup","rescheduleAutoBackup","restoreFullVeeamBackup","restoreVeeamBackup","restoreVm","revertSnapshot","setMonitoring","setNetboot","startVm","stopVm","upgradeVm"]},"vps.automatedBackup.Attached":{"type":"object","description":"A backup attached to your VPS","properties":{"access":{"allOf":[{"$ref":"#/components/schemas/vps.automatedBackup.attached.Infos"}],"description":"A structure describing a backup's access informations","readOnly":true},"restorePoint":{"type":"string","format":"date-time","readOnly":true}}},"vps.automatedBackup.attached.Infos":{"type":"object","description":"A structure describing a backup's access informations","properties":{"additionalDisk":{"type":"string","description":"Additional Disk details","nullable":true,"readOnly":true},"nfs":{"type":"string","description":"NFS URL of the backup","nullable":true,"readOnly":true},"smb":{"type":"string","description":"SMB URL of the backup","nullable":true,"readOnly":true}}},"vps.automatedBackup.detachBackup.post":{"type":"object","description":"vps.automatedBackup.detachBackup.post","properties":{"restorePoint":{"type":"string","description":"restorePoint fetched in /vps/{serviceName}/automatedBackup/attachedBackup","format":"date-time"}},"required":["restorePoint"]},"vps.automatedBackup.reschedule.post":{"type":"object","description":"vps.automatedBackup.reschedule.post","properties":{"schedule":{"allOf":[{"$ref":"#/components/schemas/time"}],"description":"Time (e.g., 15:04:05)"}},"required":["schedule"]},"vps.automatedBackup.restore.post":{"type":"object","description":"vps.automatedBackup.restore.post","properties":{"changePassword":{"type":"boolean","description":"Only with restore full on VPS Cloud 2014"},"restorePoint":{"type":"string","description":"Restore Point fetched in /automatedBackup/restorePoints","format":"date-time"},"type":{"allOf":[{"$ref":"#/components/schemas/vps.RestoreTypeEnum"}],"description":"Available restore types"}},"required":["restorePoint","type"]},"vps.createSnapshot.post":{"type":"object","description":"vps.createSnapshot.post","properties":{"description":{"type":"string","description":"A textual description for your snapshot"}}}},"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":{"/vps/{serviceName}/abortSnapshot":{"post":{"operationId":"abortVpsSnapshot","summary":"Abort an ongoing snapshot or automated backup operation for this VPS","description":"Stops the snapshot or automated backup operation in progress on the VPS.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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(\"/vps/{serviceName}/abortSnapshot\")\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(\"/vps/{serviceName}/abortSnapshot\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:abortSnapshot","required":true}]}},"/vps/{serviceName}/automatedBackup":{"get":{"operationId":"getVpsAutomatedBackup","summary":"Retrieve automated backup settings for this VPS","description":"Returns whether the automated backup is enabled, its rotation and the time of the daily backup.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.AutomatedBackup"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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(\"/vps/{serviceName}/automatedBackup\")\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(\"/vps/{serviceName}/automatedBackup\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:automatedBackup/get","required":true}]}},"/vps/{serviceName}/automatedBackup/attachedBackup":{"get":{"operationId":"getVpsAutomatedBackupAttached","summary":"List backups currently attached to this VPS","description":"Returns the backups currently attached to the VPS, with their restore point and access settings.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/vps.automatedBackup.Attached"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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(\"/vps/{serviceName}/automatedBackup/attachedBackup\")\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(\"/vps/{serviceName}/automatedBackup/attachedBackup\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:automatedBackup/attachedBackup/get","required":true}]}},"/vps/{serviceName}/automatedBackup/detachBackup":{"post":{"operationId":"detachVpsAutomatedBackup","summary":"Unmount a restored backup from this VPS and return an asynchronous task","description":"Unmounts the restored backup from the VPS and returns the task that performs it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.automatedBackup.detachBackup.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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\n# Request body type: vps.automatedBackup.detachBackup.post\nresult = client.post(\"/vps/{serviceName}/automatedBackup/detachBackup\",\n\trestorePoint = None, # restorePoint fetched in /vps/{serviceName}/automatedBackup/attachedBackup (type: string)\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: vps.automatedBackup.detachBackup.post\n$result = $ovh->post(\"/vps/{serviceName}/automatedBackup/detachBackup\", array(\n\trestorePoint => null, // restorePoint fetched in /vps/{serviceName}/automatedBackup/attachedBackup (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:automatedBackup/detachBackup","required":true}]}},"/vps/{serviceName}/automatedBackup/reschedule":{"post":{"operationId":"rescheduleVpsAutomatedBackup","summary":"Change the scheduled time of the daily automated backup and return an asynchronous task","description":"Changes the time of the daily automated backup and returns the task that performs it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.automatedBackup.reschedule.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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\n# Request body type: vps.automatedBackup.reschedule.post\nresult = client.post(\"/vps/{serviceName}/automatedBackup/reschedule\",\n\tschedule = None, # Time (e.g., 15:04:05) (type: time)\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: vps.automatedBackup.reschedule.post\n$result = $ovh->post(\"/vps/{serviceName}/automatedBackup/reschedule\", array(\n\tschedule => null, // Time (e.g., 15:04:05) (type: time)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:automatedBackup/reschedule","required":true}]}},"/vps/{serviceName}/automatedBackup/restore":{"post":{"operationId":"restoreVpsAutomatedBackup","summary":"Restore this VPS from a given restore point and return an asynchronous task","description":"Restores the VPS from the given restore point and returns the task that performs it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.automatedBackup.restore.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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: vps.automatedBackup.restore.post\nresult = client.post(\"/vps/{serviceName}/automatedBackup/restore\",\n\tchangePassword = None, # Only with restore full on VPS Cloud 2014 (type: boolean)\n\trestorePoint = None, # Restore Point fetched in /automatedBackup/restorePoints (type: string)\n\ttype = None, # Available restore types (type: vps.RestoreTypeEnum)\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: vps.automatedBackup.restore.post\n$result = $ovh->post(\"/vps/{serviceName}/automatedBackup/restore\", array(\n\tchangePassword => null, // Only with restore full on VPS Cloud 2014 (type: boolean)\n\trestorePoint => null, // Restore Point fetched in /automatedBackup/restorePoints (type: string)\n\ttype => null, // Available restore types (type: vps.RestoreTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:automatedBackup/restore","required":true}]}},"/vps/{serviceName}/automatedBackup/restorePoints":{"get":{"operationId":"getVpsAutomatedBackupRestorePoints","summary":"List available restore points for the automated backup","description":"Returns the restore points available for the automated backup of the VPS.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"query","name":"state","description":"The state of the restore point","required":true,"schema":{"$ref":"#/components/schemas/vps.RestoreStateEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"date-time"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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(\"/vps/{serviceName}/automatedBackup/restorePoints\")\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(\"/vps/{serviceName}/automatedBackup/restorePoints\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:automatedBackup/restorePoints/get","required":true}]}},"/vps/{serviceName}/createSnapshot":{"post":{"operationId":"createVpsSnapshot","summary":"Create a snapshot of this VPS (requires the snapshot option and no existing snapshot); returns an asynchronous task","description":"Creates a snapshot of the VPS and returns the task that performs it. The snapshot option must be active and no snapshot can exist.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.createSnapshot.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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: vps.createSnapshot.post\nresult = client.post(\"/vps/{serviceName}/createSnapshot\",\n\tdescription = None, # A textual description for your snapshot (type: string)\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: vps.createSnapshot.post\n$result = $ovh->post(\"/vps/{serviceName}/createSnapshot\", array(\n\tdescription => null, // A textual description for your snapshot (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:snapshot/create","required":true}]}},"/vps/{serviceName}/snapshot":{"delete":{"operationId":"deleteVpsSnapshot","summary":"Delete the VPS snapshot and return an asynchronous task","description":"Deletes the snapshot of the VPS and returns the task that performs it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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.delete(\"/vps/{serviceName}/snapshot\")\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(\"/vps/{serviceName}/snapshot\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:snapshot/delete","required":true}]},"get":{"operationId":"getVpsSnapshot","summary":"Retrieve information about the current VPS snapshot","description":"Returns the ID, creation date, description and region of the snapshot of the VPS.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.Snapshot"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/vps/{serviceName}/snapshot\")\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(\"/vps/{serviceName}/snapshot\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:snapshot/get","required":true}]},"put":{"operationId":"editVpsSnapshot","summary":"Update the VPS snapshot properties","description":"Updates the description of the snapshot of the VPS.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.Snapshot"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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\n# Request body type: vps.Snapshot\nresult = client.put(\"/vps/{serviceName}/snapshot\",\n\tdescription = None, #  (type: string)\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: vps.Snapshot\n$result = $ovh->put(\"/vps/{serviceName}/snapshot\", array(\n\tdescription => null, //  (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:snapshot/edit","required":true}]}},"/vps/{serviceName}/snapshot/download":{"get":{"operationId":"downloadVpsSnapshot","summary":"Generate a download URL for the VPS snapshot","description":"Returns the URL and the size of the snapshot to download.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.DownloadSnapshotURL"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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(\"/vps/{serviceName}/snapshot/download\")\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(\"/vps/{serviceName}/snapshot/download\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:snapshot/download/get","required":true}]}},"/vps/{serviceName}/snapshot/revert":{"post":{"operationId":"revertVpsSnapshot","summary":"Revert this VPS to the specified snapshot and return an asynchronous task","description":"Reverts the VPS to its snapshot and returns the task that performs it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vps.Task"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","VPS","Backups@@@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.post(\"/vps/{serviceName}/snapshot/revert\")\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(\"/vps/{serviceName}/snapshot/revert\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vps:apiovh:snapshot/revert","required":true}]}}}}