Availability & Ordering
All operations require authentication, except the one marked Public.
Get orderable backup storageProduction
Get orderable backup storage. Returns whether backup storage can be ordered for the server and the orderable capacities in gigabytes.
Path parameters
The internal name of your dedicated server
Response
Backup storage orderable capacities in gigabytes
5001000500010000Is a backup storage is orderable for this server
Example uses serviceName = string
$ curl https:/{ "capacities": [ 500 ], "orderable": true}
Get orderable bandwidthProduction
Get orderable bandwidth. Returns whether bandwidth can be ordered for the server and the orderable premium, platinum and ultimate bandwidths in Mbps.
Path parameters
The internal name of your dedicated server
Response
Is bandwidth orderable for this server
Bandwidth "platinum" orderable in mbps
100020003000Bandwidth "premium" orderable in mbps
100020003000Bandwidth "ultimate" orderable in mbps
100020003000Example uses serviceName = string
$ curl https:/{ "orderable": true, "platinum": [ 1000 ], "premium": [ 1000 ], "ultimate": [ 1000 ]}
Get orderable vRack bandwidthProduction
Get orderable vRack bandwidth. Returns whether vRack bandwidth can be ordered for the server and the orderable vRack bandwidths in Mbps.
Path parameters
The internal name of your dedicated server
Response
Is bandwidth orderable for this server
vRack Bandwidth orderable in mbps
10003000Example uses serviceName = string
$ curl https:/{ "orderable": true, "vrack": [ 1000 ]}
Check whether a feature is orderableProduction
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.
Path parameters
The internal name of your dedicated server
Query parameters
the feature
backupProtocolmonitoringResponse
Example uses serviceName = string
$ curl https:/true
Get orderable IP addressesProduction
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.
Path parameters
The internal name of your dedicated server
Response
Orderable IP v4 details
Orderable IP v6 details
Example uses serviceName = string
$ curl https:/{ "ipv4": [ { "blockSizes": [ 1 ], "included": true, "ipNumber": 0, "number": 0, "optionRequired": "professionalUse", "type": "failover" } ], "ipv6": [ { "blockSizes": [ 1 ], "included": true, "ipNumber": 0, "number": 0, "optionRequired": "professionalUse", "type": "failover" } ]}
Check whether a KVM is orderableProduction
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.
Path parameters
The internal name of your dedicated server
Response
Example uses serviceName = string
$ curl https:/true
Check whether KVM Express is orderableProduction
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.
Path parameters
The internal name of your dedicated server
Response
Example uses serviceName = string
$ curl https:/true
Check whether professional use is orderableProduction
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.
Path parameters
The internal name of your dedicated server
Response
Example uses serviceName = string
$ curl https:/true
Get orderable trafficProduction
Get orderable traffic. Returns whether traffic can be ordered for the server and the orderable traffic values, such as 250Mbps-Unlimited.
Path parameters
The internal name of your dedicated server
Response
Is traffic orderable for this server
traffic orderable
100Mbps-Unlimited250Mbps-Unlimited500Mbps-UnlimitedExample uses serviceName = string
$ curl https:/{ "orderable": true, "traffic": [ "100Mbps-Unlimited" ]}
Get orderable USB keysProduction
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.
Path parameters
The internal name of your dedicated server
Response
Orderable USB keys capacity in gigabytes
163264128256Number of USB keys that can be ordered for this server
Which option is required to order an USB key
professionalUseIs USB keys orderable for this server
Example uses serviceName = string
$ curl https:/{ "capacity": [ 16 ], "number": 0, "optionRequired": "professionalUse", "orderable": true}
List server availability by datacenterProductionPublic
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.
Query parameters
The names of datacenters separated by commas
If true, all datacenters are returned except those listed in datacenters parameter
The name of the gpu hardware part
The name of the memory hardware part
The plan code in which the hardware is involved
The name of the base hardware
The name of the storage hardware part
The name of the system storage hardware part
Response
The hardware availability for each datacenter
Fully qualified and unique name of the hardware
Name of the gpu hardware part
Name of the memory hardware part
Plan code in which the hardware is involved
Name of the base hardware
Name of the storage hardware part
Name of the system storage hardware part
Public: no token needed
$ curl https:/[ { "datacenters": [ { "availability": "120H", "datacenter": "ap-south-1-a" } ], "fqn": "string", "gpu": "string", "memory": "string", "planCode": "string", "server": "string", "storage": "string", "systemStorage": "string" }]
List server availability by regionBeta
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.
Query parameters
If true, all regions are returned except those listed in regions parameter
The name of the gpu hardware part
The name of the memory hardware part
The plan code in which the hardware is involved
The names of regions
ap-south-1ap-southeast-sgpap-southeast-sydca-east-1ca-east-bhseu-central-waweu-west-erieu-west-graeu-west-limeu-west-pareu-west-rbxeu-west-sbgus-east-vinus-west-hilThe name of the base hardware
The name of the storage hardware part
The name of the system storage hardware part
Response
Fully qualified and unique name of the hardware
Name of the gpu hardware part
Name of the memory hardware part
Plan code in which the hardware is involved
The hardware availability for each region
Name of the base hardware
Name of the storage hardware part
Name of the system storage hardware part
Reads your token from $OVH_TOKEN
$ curl https:/[ { "fqn": "string", "gpu": "string", "memory": "string", "planCode": "string", "regions": [ { "availability": "120H", "availabilityZones": [ { "availability": "120H", "availabilityZone": "ap-south-1-a" } ], "region": "ap-south-1" } ], "server": "string", "storage": "string", "systemStorage": "string" }]