{"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 !"},"dedicated.AvailabilityDatacenter":{"type":"object","description":"A structure describing the hardware availability for each datacenter","properties":{"availability":{"allOf":[{"$ref":"#/components/schemas/dedicated.AvailabilityEnum"}],"description":"The availability","readOnly":true},"datacenter":{"allOf":[{"$ref":"#/components/schemas/dedicated.AvailabilityDatacenterEnum"}],"description":"The datacenter","readOnly":true}}},"dedicated.AvailabilityDatacenterEnum":{"type":"string","description":"The datacenter","enum":["ap-south-1-a","ap-south-mum-a","ap-southeast-sgp-a","ap-southeast-syd-a","au","bhs","ca","ca-east-1-a","ca-east-bhs-a","ca-east-tor-a","de","default","eu-central-waw-a","eu-south-mil-a","eu-south-mil-b","eu-south-mil-c","eu-west-1-a","eu-west-1-b","eu-west-1-c","eu-west-eri-a","eu-west-gra-a","eu-west-lim-a","eu-west-par-a","eu-west-par-b","eu-west-par-c","eu-west-rbx-a","eu-west-sbg-a","fr","fra","gb","gra","hil","in","lon","par","pl","rbx","rbx-hz","sbg","sg","sgp","syd","us","us-east-vin-a","us-west-hil-a","vin","waw","ynm"]},"dedicated.AvailabilityEnum":{"type":"string","description":"The availability","enum":["120H","1440H","1H-high","1H-low","2160H","240H","24H","480H","720H","72H","comingSoon","unavailable","unknown"]},"dedicated.DatacenterAvailability":{"type":"object","description":"A structure describing the availabilities of dedicated server","properties":{"datacenters":{"type":"array","description":"The hardware availability for each datacenter","items":{"$ref":"#/components/schemas/dedicated.AvailabilityDatacenter"},"readOnly":true},"fqn":{"type":"string","description":"Fully qualified and unique name of the hardware","readOnly":true},"gpu":{"type":"string","description":"Name of the gpu hardware part","nullable":true,"readOnly":true},"memory":{"type":"string","description":"Name of the memory hardware part","nullable":true,"readOnly":true},"planCode":{"type":"string","description":"Plan code in which the hardware is involved","readOnly":true},"server":{"type":"string","description":"Name of the base hardware","readOnly":true},"storage":{"type":"string","description":"Name of the storage hardware part","nullable":true,"readOnly":true},"systemStorage":{"type":"string","description":"Name of the system storage hardware part","nullable":true,"readOnly":true}}},"dedicated.server.AvailabilityByRegion":{"type":"object","description":"A structure describing the hardware availability for each region","properties":{"availability":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.AvailabilityEnum"}],"description":"The availability","readOnly":true},"availabilityZones":{"type":"array","description":"Availability zones","items":{"$ref":"#/components/schemas/dedicated.server.AvailabilityZones"},"readOnly":true},"region":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.AvailabilityRegionalizationEnum"}],"description":"The region","readOnly":true}}},"dedicated.server.AvailabilityEnum":{"type":"string","description":"The availability","enum":["120H","1440H","1H-high","1H-low","2160H","240H","24H","480H","720H","72H","comingSoon","unavailable","unknown"]},"dedicated.server.AvailabilityRegionalizationEnum":{"type":"string","description":"The region","enum":["ap-south-1","ap-southeast-sgp","ap-southeast-syd","ca-east-1","ca-east-bhs","eu-central-waw","eu-west-eri","eu-west-gra","eu-west-lim","eu-west-par","eu-west-rbx","eu-west-sbg","us-east-vin","us-west-hil"]},"dedicated.server.AvailabilityZones":{"type":"object","description":"A structure describing the hardware availability for each availability zone","properties":{"availability":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.AvailabilityEnum"}],"description":"The availability","readOnly":true},"availabilityZone":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.AvailabilityZonesEnum"}],"description":"The availability zone","readOnly":true}}},"dedicated.server.AvailabilityZonesEnum":{"type":"string","description":"The availability zone","enum":["ap-south-1-a","ap-south-mum-a","ap-southeast-sgp-a","ap-southeast-syd-a","ca-east-1-a","ca-east-bhs-a","ca-east-tor-a","eu-central-waw-a","eu-south-mil-a","eu-south-mil-b","eu-south-mil-c","eu-west-1-a","eu-west-1-b","eu-west-1-c","eu-west-eri-a","eu-west-gra-a","eu-west-lim-a","eu-west-par-a","eu-west-par-b","eu-west-par-c","eu-west-rbx-a","eu-west-sbg-a","us-east-vin-a","us-west-hil-a"]},"dedicated.server.BackupStorageCapacityEnum":{"type":"integer","description":"Different backup storage capacity in gigabytes","enum":[500,1000,5000,10000]},"dedicated.server.BackupStorageOrderable":{"type":"object","description":"A structure describing informations storage backup orderable for this dedicated server","properties":{"capacities":{"type":"array","description":"Backup storage orderable capacities in gigabytes","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.BackupStorageCapacityEnum"}},"orderable":{"type":"boolean","description":"Is a backup storage is orderable for this server"}}},"dedicated.server.BandwidthOrderEnum":{"type":"integer","description":" Different Bandwidth orderable in Mbps","enum":[1000,2000,3000]},"dedicated.server.BandwidthOrderable":{"type":"object","description":"A structure describing informations bandwidth orderable for this dedicated server","properties":{"orderable":{"type":"boolean","description":"Is bandwidth orderable for this server"},"platinum":{"type":"array","description":"Bandwidth \"platinum\" orderable in mbps","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.BandwidthOrderEnum"}},"premium":{"type":"array","description":"Bandwidth \"premium\" orderable in mbps","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.BandwidthOrderEnum"}},"ultimate":{"type":"array","description":"Bandwidth \"ultimate\" orderable in mbps","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.BandwidthOrderEnum"}}}},"dedicated.server.BandwidthvRackOrderEnum":{"type":"integer","description":" Different vRack Bandwidth orderable in Mbps","enum":[1000,3000]},"dedicated.server.BandwidthvRackOrderable":{"type":"object","description":"A structure describing informations bandwidth orderable for this dedicated server","properties":{"orderable":{"type":"boolean","description":"Is bandwidth orderable for this server"},"vrack":{"type":"array","description":"vRack Bandwidth orderable in mbps","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.BandwidthvRackOrderEnum"}}}},"dedicated.server.IpBlockSizeEnum":{"type":"integer","description":"IP block size","enum":[1,4,8,16,32,64,128,256]},"dedicated.server.IpOrderable":{"type":"object","description":"A structure describing informations about orderable IP address","properties":{"ipv4":{"type":"array","description":"Orderable IP v4 details","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.IpOrderableDetails"}},"ipv6":{"type":"array","description":"Orderable IP v6 details","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.IpOrderableDetails"}}}},"dedicated.server.IpOrderableDetails":{"type":"object","description":"A structure describing informations about orderable IP address","properties":{"blockSizes":{"type":"array","description":"Orderable IP blocks sizes","items":{"$ref":"#/components/schemas/dedicated.server.IpBlockSizeEnum"}},"included":{"type":"boolean","description":"Are those IP included with your offer"},"ipNumber":{"type":"integer","description":"Total number of IP that can be routed to this server","nullable":true},"number":{"type":"integer","description":"Total number of prefixes that can be routed to this server"},"optionRequired":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.OptionRequiredEnum"}],"description":"Which option is required to order this type of IP","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.IpTypeOrderableEnum"}],"description":"this IP type"}}},"dedicated.server.IpTypeOrderableEnum":{"type":"string","description":"Orderable IP type","enum":["failover","static","unshielded"]},"dedicated.server.OptionRequiredEnum":{"type":"string","description":"Required option","enum":["professionalUse"]},"dedicated.server.OrderableSysFeatureEnum":{"type":"string","description":"Dedicated server orderable features","enum":["backupProtocol","monitoring"]},"dedicated.server.RegionAvailability":{"type":"object","description":"A structure describing the availabilities of dedicated server","properties":{"fqn":{"type":"string","description":"Fully qualified and unique name of the hardware","readOnly":true},"gpu":{"type":"string","description":"Name of the gpu hardware part","nullable":true,"readOnly":true},"memory":{"type":"string","description":"Name of the memory hardware part","nullable":true,"readOnly":true},"planCode":{"type":"string","description":"Plan code in which the hardware is involved","readOnly":true},"regions":{"type":"array","description":"The hardware availability for each region","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.AvailabilityByRegion"},"readOnly":true},"server":{"type":"string","description":"Name of the base hardware","readOnly":true},"storage":{"type":"string","description":"Name of the storage hardware part","nullable":true,"readOnly":true},"systemStorage":{"type":"string","description":"Name of the system storage hardware part","nullable":true,"readOnly":true}}},"dedicated.server.TrafficOrderEnum":{"type":"string","description":" traffic orderable ","enum":["100Mbps-Unlimited","250Mbps-Unlimited","500Mbps-Unlimited"]},"dedicated.server.TrafficOrderable":{"type":"object","description":"A structure describing informations bandwidth orderable for this dedicated server","properties":{"orderable":{"type":"boolean","description":"Is traffic orderable for this server"},"traffic":{"type":"array","description":"traffic orderable","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.TrafficOrderEnum"}}}},"dedicated.server.UsbKeyCapacityEnum":{"type":"integer","description":" Different USB key capacity in gigabytes","enum":[16,32,64,128,256]},"dedicated.server.UsbKeyOrderableDetails":{"type":"object","description":"A structure describing informations about orderable USB keys","properties":{"capacity":{"type":"array","description":"Orderable USB keys capacity in gigabytes","items":{"$ref":"#/components/schemas/dedicated.server.UsbKeyCapacityEnum"}},"number":{"type":"integer","description":"Number of USB keys that can be ordered for this server"},"optionRequired":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.OptionRequiredEnum"}],"description":"Which option is required to order an USB key","nullable":true},"orderable":{"type":"boolean","description":"Is USB keys orderable for this server"}}},"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/datacenter/availabilities":{"get":{"summary":"List server availability by datacenter","description":"Returns the availability of each server hardware configuration in each datacenter. Filter by plan code or hardware part, and choose datacenters with datacenters and excludeDatacenters. This call does not require authentication.","parameters":[{"in":"query","name":"datacenters","description":"The names of datacenters separated by commas","schema":{"type":"string"}},{"in":"query","name":"excludeDatacenters","description":"If true, all datacenters are returned except those listed in datacenters parameter","schema":{"type":"boolean"}},{"in":"query","name":"gpu","description":"The name of the gpu hardware part","schema":{"type":"string"}},{"in":"query","name":"memory","description":"The name of the memory hardware part","schema":{"type":"string"}},{"in":"query","name":"planCode","description":"The plan code in which the hardware is involved","schema":{"type":"string"}},{"in":"query","name":"server","description":"The name of the base hardware","schema":{"type":"string"}},{"in":"query","name":"storage","description":"The name of the storage hardware part","schema":{"type":"string"}},{"in":"query","name":"systemStorage","description":"The name of the system storage hardware part","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.DatacenterAvailability"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@110"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/datacenter/availabilities\")\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/datacenter/availabilities\");\n\nprint_r($result);\n?>"}]}},"/dedicated/server/region/availabilities":{"get":{"summary":"List server availability by region","description":"Returns the availability of each server hardware configuration in each region and its availability zones. Filter by plan code or hardware part, and choose regions with regions and excludeRegions. Unlike the datacenter route, this call requires authentication.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"excludeRegions","description":"If true, all regions are returned except those listed in regions parameter","schema":{"type":"boolean"}},{"in":"query","name":"gpu","description":"The name of the gpu hardware part","schema":{"type":"string"}},{"in":"query","name":"memory","description":"The name of the memory hardware part","schema":{"type":"string"}},{"in":"query","name":"planCode","description":"The plan code in which the hardware is involved","schema":{"type":"string"}},{"in":"query","name":"regions","description":"The names of regions","schema":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.server.AvailabilityRegionalizationEnum"}}},{"in":"query","name":"server","description":"The name of the base hardware","schema":{"type":"string"}},{"in":"query","name":"storage","description":"The name of the storage hardware part","schema":{"type":"string"}},{"in":"query","name":"systemStorage","description":"The name of the system storage hardware part","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.server.RegionAvailability"}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@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.get(\"/dedicated/server/region/availabilities\")\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/region/availabilities\");\n\nprint_r($result);\n?>"}]}},"/dedicated/server/{serviceName}/orderable/backupStorage":{"get":{"summary":"Get orderable backup storage","description":"Get orderable backup storage. Returns whether backup storage can be ordered for the server and the orderable capacities in gigabytes.","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.BackupStorageOrderable"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@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}/orderable/backupStorage\")\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}/orderable/backupStorage\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:orderable/backupStorage/get","required":true}]}},"/dedicated/server/{serviceName}/orderable/bandwidth":{"get":{"summary":"Get orderable bandwidth","description":"Get orderable bandwidth. Returns whether bandwidth can be ordered for the server and the orderable premium, platinum and ultimate bandwidths in Mbps.","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.BandwidthOrderable"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@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}/orderable/bandwidth\")\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}/orderable/bandwidth\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:orderable/bandwidth/get","required":true}]}},"/dedicated/server/{serviceName}/orderable/bandwidthvRack":{"get":{"summary":"Get orderable vRack bandwidth","description":"Get orderable vRack bandwidth. Returns whether vRack bandwidth can be ordered for the server and the orderable vRack bandwidths in Mbps.","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.BandwidthvRackOrderable"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/orderable/bandwidthvRack\")\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}/orderable/bandwidthvRack\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:orderable/bandwidthvRack/get","required":true}]}},"/dedicated/server/{serviceName}/orderable/feature":{"get":{"summary":"Check whether a feature is orderable","description":"Check whether a feature is orderable. Returns true if the feature given in the feature parameter can be ordered for the server, false otherwise. Accepted features are monitoring and backupProtocol.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"feature","description":"the feature","required":true,"schema":{"$ref":"#/components/schemas/dedicated.server.OrderableSysFeatureEnum"}},{"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":"boolean"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/orderable/feature\")\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}/orderable/feature\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:orderable/feature/get","required":true}]}},"/dedicated/server/{serviceName}/orderable/ip":{"get":{"summary":"Get orderable IP addresses","description":"Get orderable IP addresses. Returns the IPv4 and IPv6 types that can be ordered for the server, with their block sizes, the number of prefixes and IPs that can be routed to it, and whether they are included in the offer. When a type needs an option first, optionRequired names it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your dedicated server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.server.IpOrderable"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/orderable/ip\")\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}/orderable/ip\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:orderable/ip/get","required":true}]}},"/dedicated/server/{serviceName}/orderable/kvm":{"get":{"summary":"Check whether a KVM is orderable","description":"Check whether a KVM is orderable. Returns true if a KVM can be ordered for the server, false otherwise. KVM Express has its own route, orderable/kvmExpress.","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":"boolean"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@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}/orderable/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}/orderable/kvm\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:orderable/kvm/get","required":true}]}},"/dedicated/server/{serviceName}/orderable/kvmExpress":{"get":{"summary":"Check whether KVM Express is orderable","description":"Check whether KVM Express is orderable. Returns true if a KVM Express can be ordered for the server, false otherwise. A standard KVM has its own route, orderable/kvm.","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":"boolean"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@70"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/orderable/kvmExpress\")\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}/orderable/kvmExpress\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:orderable/kvmExpress/get","required":true}]}},"/dedicated/server/{serviceName}/orderable/professionalUse":{"get":{"summary":"Check whether professional use is orderable","description":"Check whether professional use is orderable. Returns true if the professional use option can be ordered for the server, false otherwise. Ordering some IP types or USB keys can require this option.","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":"boolean"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@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}/orderable/professionalUse\")\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}/orderable/professionalUse\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:orderable/professionalUse/get","required":true}]}},"/dedicated/server/{serviceName}/orderable/traffic":{"get":{"summary":"Get orderable traffic","description":"Get orderable traffic. Returns whether traffic can be ordered for the server and the orderable traffic values, such as 250Mbps-Unlimited.","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.TrafficOrderable"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@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}/orderable/traffic\")\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}/orderable/traffic\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:orderable/traffic/get","required":true}]}},"/dedicated/server/{serviceName}/orderable/usbKey":{"get":{"summary":"Get orderable USB keys","description":"Get orderable USB keys. Returns whether USB keys can be ordered for the server, how many, and the orderable capacities in gigabytes. When an option is needed first, optionRequired names it.","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.UsbKeyOrderableDetails"}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Availability & Ordering@@@100"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/dedicated/server/{serviceName}/orderable/usbKey\")\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}/orderable/usbKey\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:orderable/usbKey/get","required":true}]}}}}