{"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"},"vrack.AllowedDedicatedServerInterfaces":{"type":"object","description":"A structure giving all dedicated server interfaces allowed for this vrack","properties":{"dedicatedServer":{"type":"string","description":"the name of dedicatedServer"},"dedicatedServerInterface":{"type":"string","description":"the unique identifier of dedicatedServerInterface"},"name":{"type":"string","description":"the name of dedicatedServerInterface"}}},"vrack.AllowedServiceEnum":{"type":"string","description":"Possible values for vrack allowed service","enum":["cloudProject","dedicatedCloud","dedicatedCloudDatacenter","dedicatedConnect","dedicatedServer","dedicatedServerInterface","ip","ipLoadbalancing","ipv6","legacyVrack","ovhCloudConnect","vmwareCloudDirectorVirtualDataCenter","vrackServices"]},"vrack.AllowedServices":{"type":"object","description":"A structure given all service allowed for this vrack","properties":{"cloudProject":{"type":"array","description":"list of publicCloud projects allowed to be connected to vrack","nullable":true,"items":{"type":"string"}},"dedicatedCloud":{"type":"array","description":"list of dedicated cloud allowed to be connected to vrack","nullable":true,"items":{"type":"string"}},"dedicatedCloudDatacenter":{"type":"array","description":"list of dedicated cloud datacenters allowed to be connected to vrack","nullable":true,"items":{"type":"string"}},"dedicatedConnect":{"type":"array","description":"list of dedicated connect links allowed to be connected to vrack","nullable":true,"items":{"type":"string"}},"dedicatedServer":{"type":"array","description":"list of dedicated servers allowed to be connected to vrack","nullable":true,"items":{"type":"string"}},"dedicatedServerInterface":{"type":"array","description":"list of dedicated server interfaces allowed to be connected to vrack","nullable":true,"items":{"$ref":"#/components/schemas/vrack.AllowedDedicatedServerInterfaces"}},"ip":{"type":"array","description":"list of blocks allowed to be connected to vrack","nullable":true,"items":{"$ref":"#/components/schemas/ipBlock"}},"ipLoadbalancing":{"type":"array","description":"list of ipLoadbalancing allowed to be connected to vrack","nullable":true,"items":{"type":"string"}},"ipv6":{"type":"array","description":"list of ipv6 blocks allowed to be connected to vrack","nullable":true,"items":{"$ref":"#/components/schemas/ipv6Block"}},"legacyVrack":{"type":"array","description":"list of legacy vrack (1.0) allowed to be connected to vrack","nullable":true,"items":{"type":"string"}},"ovhCloudConnect":{"type":"array","description":"List of the ovhCloudConnect services allowed to be connected to vrack","nullable":true,"items":{"type":"string","format":"uuid"}},"vmwareCloudDirectorVirtualDataCenter":{"type":"array","description":"List of the vmwareCloudDirectorVirtualDataCenter allowed to be connected to vrack","nullable":true,"items":{"type":"string"}},"vrackServices":{"type":"array","description":"List of the vrackServices allowed to be connected to vrack","nullable":true,"items":{"type":"string"}}}},"vrack.EligibleDedicatedServerInterfaces":{"type":"object","description":"Dedicated server interfaces allowed for this vRack","properties":{"dedicatedServer":{"type":"string","description":"The name of the dedicatedServer","readOnly":true},"dedicatedServerInterface":{"type":"string","description":"The unique identifier of the dedicatedServerInterface","readOnly":true},"name":{"type":"string","description":"The name of the dedicatedServerInterface","readOnly":true}}},"vrack.EligibleServices":{"type":"object","description":"Eligible services for this vRack","properties":{"cloudProject":{"type":"array","description":"List of publicCloud projects allowed to be connected to this vRack","nullable":true,"items":{"type":"string"},"readOnly":true},"dedicatedCloud":{"type":"array","description":"List of dedicated cloud allowed to be connected to this vRack","nullable":true,"items":{"type":"string"},"readOnly":true},"dedicatedCloudDatacenter":{"type":"array","description":"List of dedicated cloud datacenters allowed to be connected to this vRack","nullable":true,"items":{"type":"string"},"readOnly":true},"dedicatedConnect":{"type":"array","description":"List of dedicated connect links allowed to be connected to this vRack","nullable":true,"items":{"type":"string"},"readOnly":true},"dedicatedServer":{"type":"array","description":"List of dedicated servers allowed to be connected to this vRack","nullable":true,"items":{"type":"string"},"readOnly":true},"dedicatedServerInterface":{"type":"array","description":"List of dedicated server interfaces allowed to be connected to this vRack","nullable":true,"items":{"$ref":"#/components/schemas/vrack.EligibleDedicatedServerInterfaces"},"readOnly":true},"ip":{"type":"array","description":"List of blocks allowed to be connected to this vRack","nullable":true,"items":{"$ref":"#/components/schemas/ipBlock"},"readOnly":true},"ipLoadbalancing":{"type":"array","description":"List of ipLoadbalancing allowed to be connected to this vRack","nullable":true,"items":{"type":"string"},"readOnly":true},"ipv6":{"type":"array","description":"List of ipv6 blocks allowed to be connected to this vRack","nullable":true,"items":{"$ref":"#/components/schemas/ipv6Block"},"readOnly":true},"legacyVrack":{"type":"array","description":"List of legacy vRack (1.0) allowed to be connected to this vRack","nullable":true,"items":{"type":"string"},"readOnly":true},"ovhCloudConnect":{"type":"array","description":"List of the ovhCloudConnect services allowed to be connected to this vRack","nullable":true,"items":{"type":"string","format":"uuid"},"readOnly":true},"vmwareCloudDirectorVirtualDataCenter":{"type":"array","description":"List of the VMwareCloudDirectorVirtualDatacenter allowed to be connected to this vRack","nullable":true,"items":{"type":"string"},"readOnly":true},"vrackServices":{"type":"array","description":"List of the vrackServices allowed to be connected to this vRack","nullable":true,"items":{"type":"string"},"readOnly":true}}},"vrack.EligibleServicesEnum":{"type":"string","description":"Possible values for vrack eligible services","enum":["cloudProject","dedicatedCloud","dedicatedServer","dedicatedServerInterface","ip","ipLoadbalancing","ipv6","legacyVrack","ovhCloudConnect","vmwareCloudDirectorVirtualDataCenter","vrackServices"]},"vrack.EligibleServicesResponse":{"type":"object","description":"Eligible services call response","properties":{"createdAt":{"type":"string","description":"Creation date of the call","readOnly":true},"errors":{"type":"array","description":"List of services where an error has been encountered","items":{"type":"string"},"readOnly":true},"result":{"allOf":[{"$ref":"#/components/schemas/vrack.EligibleServices"}],"description":"Eligible services for this vRack","readOnly":true},"status":{"type":"string","description":"Status of the call","readOnly":true}}}},"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":{"/vrack/{serviceName}/allowedServices":{"get":{"summary":"List allowed services (deprecated)","description":"List allowed services (deprecated). Returns, by service family, the services that can be attached to the vRack. Deprecated: use eligibleServices instead.","deprecated":true,"x-deprecation-date":"2025-09-02T00:00:00+01:00","x-deletion-date":"2025-12-02T00:00:00+01:00","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"serviceFamily","description":"Filter on a specific service family","schema":{"$ref":"#/components/schemas/vrack.AllowedServiceEnum"}},{"in":"path","name":"serviceName","description":"The internal name of your vrack","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vrack.AllowedServices"}}}}},"x-developer-hub-navigation":[["Network","vRack","Attached services","Eligible services@@@20"]],"x-badges":[{"color":"red","label":"Deprecated, will be removed"}],"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(\"/vrack/{serviceName}/allowedServices\")\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(\"/vrack/{serviceName}/allowedServices\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vrack:apiovh:allowedServices/get","required":true},{"name":"publicCloudProject:apiovh:vrack/attach","description":"Needed on the Cloud Project services to be listed in the response body","required":false},{"name":"legacyVrack:apiovh:vrack/attach","description":"Needed on the legacy vRack services to be listed in the response body","required":false},{"name":"ipLoadbalancing:apiovh:vrack/attach","description":"Needed on the IP Load Balancer services to be listed in the response body","required":false},{"name":"ovhCloudConnect:apiovh:vrack/attach","description":"Needed on the OVH Cloud Connect services to be listed in the response body","required":false},{"name":"dedicatedServer:apiovh:vrack/attach","description":"Needed on the Dedicated Server services to be listed in dedicatedServer and dedicatedServerInterface body entries","required":false},{"name":"pccVMware:apiovh:vrack/attach","description":"Needed on the Dedicated Cloud (VMware) services to be listed in the response body","required":false},{"name":"vrackServices:apiovh:vrack/attach","description":"Needed on the VrackServices services to be listed in the response body","required":false},{"name":"ip:apiovh:vrack/attach","description":"Needed on the IP services to be listed in the response body","required":false},{"name":"vmwareCloudDirector:apiovh:organization/virtualDataCenter/vrack/attach","description":"Needed on the VCD VirtualDataCenter services to be listed in the response body","required":false}]}},"/vrack/{serviceName}/eligibleServices":{"get":{"summary":"List eligible services","description":"Returns, by service family, the services that can be attached to the vRack. The eligibility check runs asynchronously: the route can be called several times until all the eligible services are returned.\n\nWhile the `status` is set to `pending` the results are partial.\n\nOnce the `status` is set to `done`, all the eligible services have been found.\n\nIn the eventuality of errors getting specific service types, the errors will be listed in the `errors` field.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"serviceFamily","description":"serviceFamily allows to filter on a specific service family","schema":{"$ref":"#/components/schemas/vrack.EligibleServicesEnum"}},{"in":"path","name":"serviceName","description":"The internal name of your vrack","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vrack.EligibleServicesResponse"},"examples":{"1. Partial result":{"value":{"createdAt":"2024-06-21 08:38:09","errors":[],"result":{"ip":["123.123.123.123/24","234.234.234.234/28","34.34.34.34/30"],"ipv6":["2001:3000:b00::/56"],"legacyVrack":[]},"status":"pending"},"summary":"1. Partial result"},"2. Complete result":{"value":{"createdAt":"2024-06-21 08:38:09","errors":[],"result":{"cloudProject":[],"dedicatedCloud":[],"dedicatedServer":["nsxxxxxxx.ip-xxx-xxx-xxx.eu","nsyyyyyy.ip-yyy-yy-yyy.eu"],"dedicatedServerInterface":[],"ip":["123.123.123.123/24","234.234.234.234/28","34.34.34.34/30"],"ipLoadbalancing":["loadbalancer-abcdef1234567890abcdef1234567890"],"ipv6":["2001:3000:b00::/56"],"legacyVrack":[],"ovhCloudConnect":[],"vmwareCloudDirectorVirtualDataCenter":[],"vrackServices":["vrs-xxx-xxx-xxx-xxx"]},"status":"done"},"summary":"2. Complete result"},"3. Error in result":{"value":{"createdAt":"2024-06-21 08:38:09","errors":["cloudProject"],"result":{"cloudProject":[],"dedicatedCloud":[],"dedicatedServer":["nsxxxxxxx.ip-xxx-xxx-xxx.eu","nsyyyyyy.ip-yyy-yy-yyy.eu"],"dedicatedServerInterface":[],"ip":["123.123.123.123/24","234.234.234.234/28","34.34.34.34/30"],"ipLoadbalancing":["loadbalancer-abcdef1234567890abcdef1234567890"],"ipv6":["2001:3000:b00::/56"],"legacyVrack":[],"ovhCloudConnect":[],"vmwareCloudDirectorVirtualDataCenter":[],"vrackServices":["vrs-xxx-xxx-xxx-xxx"]},"status":"done"},"summary":"3. Error in result"},"4. Complete result with filter on ip serviceFamily":{"value":{"createdAt":"2024-06-21 08:38:09","errors":[],"result":{"ip":["123.123.123.123/24","234.234.234.234/28","34.34.34.34/30"]},"status":"done"},"summary":"4. Complete result with filter on ip serviceFamily"}}}}}},"x-developer-hub-navigation":[["Network","vRack","Attached services","Eligible services@@@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(\"/vrack/{serviceName}/eligibleServices\")\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(\"/vrack/{serviceName}/eligibleServices\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"vrack:apiovh:eligibleServices/get","required":true},{"name":"legacyVrack:apiovh:vrack/attach","description":"Needed on the legacy vRack services to be listed in the response body","required":false},{"name":"ipLoadbalancing:apiovh:vrack/attach","description":"Needed on the IP Load Balancer services to be listed in the response body","required":false},{"name":"ovhCloudConnect:apiovh:vrack/attach","description":"Needed on the OVH Cloud Connect services to be listed in the response body","required":false},{"name":"dedicatedServer:apiovh:vrack/attach","description":"Needed on the Dedicated Server services to be listed in dedicatedServer and dedicatedServerInterface body entries","required":false},{"name":"pccVMware:apiovh:vrack/attach","description":"Needed on the Dedicated Cloud (VMware) services to be listed in the response body","required":false},{"name":"vrackServices:apiovh:vrack/attach","description":"Needed on the VrackServices services to be listed in the response body","required":false},{"name":"ip:apiovh:vrack/attach","description":"Needed on the IP Block services to be listed in the response body","required":false},{"name":"vmwareCloudDirector:apiovh:organization/virtualDataCenter/vrack/attach","description":"Needed on the VMwareCloudDirector VirtualDataCenter services to be listed in the response body","required":false}]}}}}