{"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"},"storage.NetAppCapabilitiesFileSize":{"type":"object","description":"File size constraints","properties":{"max":{"type":"integer","description":"Maximum file size","readOnly":true},"unit":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppSizeUnitEnum"}],"description":"File size unit","readOnly":true}}},"storage.NetAppCapabilitiesPerTiBLimit":{"type":"object","description":"A limit proportional to the provisioned size","properties":{"perTiB":{"type":"integer","description":"Limit value per TiB","readOnly":true},"unit":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppPerformanceUnitEnum"}],"description":"Limit unit","readOnly":true}}},"storage.NetAppCapabilitiesPerformance":{"type":"object","description":"Performance capabilities","properties":{"levels":{"type":"array","description":"Available performance levels","items":{"$ref":"#/components/schemas/storage.NetAppCapabilitiesPerformanceLevel"},"readOnly":true}}},"storage.NetAppCapabilitiesPerformanceLevel":{"type":"object","description":"A performance level","properties":{"limits":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesPerformanceLevelLimits"}],"description":"Performance level limits","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppServicePerformanceLevelEnum"}],"description":"Performance level name","readOnly":true}}},"storage.NetAppCapabilitiesPerformanceLevelLimits":{"type":"object","description":"Performance level limits","properties":{"bandwidth":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesPerTiBLimit"}],"description":"Bandwidth limit","readOnly":true},"iops":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesPerTiBLimit"}],"description":"IOPS limit","readOnly":true}}},"storage.NetAppCapabilitiesProduct":{"type":"object","description":"NetApp product capabilities","properties":{"performance":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesPerformance"}],"description":"Performance capabilities","readOnly":true},"service":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesService"}],"description":"Service capabilities","readOnly":true},"share":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesShare"}],"description":"Share capabilities","readOnly":true},"shareReplica":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesShareReplica"}],"description":"Share replica capabilities","readOnly":true},"snapshotPolicy":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSnapshotPolicy"}],"description":"Snapshot policy capabilities","readOnly":true}}},"storage.NetAppCapabilitiesService":{"type":"object","description":"Service capabilities","properties":{"features":{"type":"array","description":"Available features","items":{"$ref":"#/components/schemas/storage.NetAppFeatureEnum"},"readOnly":true},"networks":{"type":"array","description":"Supported network types","items":{"$ref":"#/components/schemas/storage.NetAppCapabilitiesServiceNetwork"},"readOnly":true},"protocols":{"type":"array","description":"Supported protocols","items":{"$ref":"#/components/schemas/storage.NetAppCapabilitiesServiceProtocol"},"readOnly":true},"size":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSizeRange"}],"description":"Service size constraints","readOnly":true}}},"storage.NetAppCapabilitiesServiceNetwork":{"type":"object","description":"Network capabilities","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppNetworkEnum"}],"description":"Network type","readOnly":true},"vRackServices":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesServiceNetworkVRackServices"}],"description":"vRack Services constraints","readOnly":true}}},"storage.NetAppCapabilitiesServiceNetworkVRackServices":{"type":"object","description":"vRack Services constraints","properties":{"max":{"type":"integer","description":"Maximum number of vRack Services","readOnly":true}}},"storage.NetAppCapabilitiesServiceProtocol":{"type":"object","description":"Protocol capabilities","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/storage.ProtocolEnum"}],"description":"Protocol type","readOnly":true},"versions":{"type":"array","description":"Protocol versions","items":{"type":"string"},"readOnly":true}}},"storage.NetAppCapabilitiesShare":{"type":"object","description":"Share capabilities","properties":{"fileSize":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesFileSize"}],"description":"File size constraints","readOnly":true},"maxItemsPerTiB":{"type":"integer","description":"Maximum number of shares per TiB of service size","readOnly":true},"size":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSizeRange"}],"description":"Share size constraints","readOnly":true},"snapshot":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesShareSnapshot"}],"description":"Share snapshot constraints","readOnly":true},"snapshotPolicy":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesShareSnapshotPolicy"}],"description":"Share snapshot policy constraints","readOnly":true},"snapshotReserve":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesShareSnapshotReserve"}],"description":"Share snapshot reserve constraints","readOnly":true}}},"storage.NetAppCapabilitiesShareReplica":{"type":"object","description":"Share replica capabilities","properties":{"fileSize":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesFileSize"}],"description":"File size constraints","readOnly":true},"maxItemsPerTiB":{"type":"integer","description":"Maximum number of share replicas per TiB of service size","readOnly":true},"size":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSizeRange"}],"description":"Share replica size constraints","readOnly":true}}},"storage.NetAppCapabilitiesShareSnapshot":{"type":"object","description":"Share snapshot constraints","properties":{"maxItems":{"type":"integer","description":"Maximum number of snapshots per share","readOnly":true}}},"storage.NetAppCapabilitiesShareSnapshotPolicy":{"type":"object","description":"Share snapshot policy constraints","properties":{"maxItems":{"type":"integer","description":"Maximum number of snapshot policies per share","readOnly":true}}},"storage.NetAppCapabilitiesShareSnapshotReserve":{"type":"object","description":"Share snapshot reserve constraints","properties":{"default":{"type":"integer","description":"Default snapshot reserve percentage","readOnly":true},"max":{"type":"integer","description":"Maximum snapshot reserve percentage","readOnly":true},"min":{"type":"integer","description":"Minimum snapshot reserve percentage","readOnly":true},"unit":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppShareSnapshotReserveUnitEnum"}],"description":"Snapshot reserve unit","readOnly":true}}},"storage.NetAppCapabilitiesSizeRange":{"type":"object","description":"Size constraints","properties":{"granularity":{"type":"integer","description":"Size granularity","readOnly":true},"max":{"type":"integer","description":"Maximum size","readOnly":true},"min":{"type":"integer","description":"Minimum size","readOnly":true},"unit":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppSizeUnitEnum"}],"description":"Size unit","readOnly":true}}},"storage.NetAppCapabilitiesSnapshotPolicy":{"type":"object","description":"Snapshot policy capabilities","properties":{"maxItems":{"type":"integer","description":"Maximum number of snapshot policies","readOnly":true},"rules":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSnapshotPolicyRules"}],"description":"Snapshot policy rules constraints","readOnly":true}}},"storage.NetAppCapabilitiesSnapshotPolicyRules":{"type":"object","description":"Snapshot policy rules constraints","properties":{"maxItems":{"type":"integer","description":"Maximum number of rules per snapshot policy","readOnly":true},"minItems":{"type":"integer","description":"Minimum number of rules per snapshot policy","readOnly":true},"schedule":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSnapshotPolicySchedule"}],"description":"Snapshot policy rule schedule constraints","readOnly":true}}},"storage.NetAppCapabilitiesSnapshotPolicySchedule":{"type":"object","description":"Snapshot policy schedule constraints","properties":{"days":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSnapshotPolicyScheduleField"}],"description":"Days of the month constraints","readOnly":true},"hours":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSnapshotPolicyScheduleField"}],"description":"Hours constraints","readOnly":true},"minutes":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSnapshotPolicyScheduleField"}],"description":"Minutes constraints","readOnly":true},"months":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSnapshotPolicyScheduleField"}],"description":"Months constraints","readOnly":true},"timezone":{"type":"string","description":"Timezone in which the schedule is evaluated","readOnly":true},"weekdays":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesSnapshotPolicyScheduleField"}],"description":"Days of the week constraints","readOnly":true}}},"storage.NetAppCapabilitiesSnapshotPolicyScheduleField":{"type":"object","description":"Snapshot policy schedule field constraints","properties":{"items":{"allOf":[{"$ref":"#/components/schemas/storage.NetAppCapabilitiesValueRange"}],"description":"Allowed value range of each item","readOnly":true},"maxItems":{"type":"integer","description":"Maximum number of items","readOnly":true},"minItems":{"type":"integer","description":"Minimum number of items","readOnly":true},"required":{"type":"boolean","description":"Whether the field is required","readOnly":true}}},"storage.NetAppCapabilitiesValueRange":{"type":"object","description":"Value range","properties":{"max":{"type":"integer","description":"Maximum value","readOnly":true},"min":{"type":"integer","description":"Minimum value","readOnly":true}}},"storage.NetAppFeatureEnum":{"type":"string","description":"Available features","enum":["ovhBackup","shareCreateFromSnapshot","shareReplication","shareRevertFromSnapshot","shareSnapshot","shareSnapshotReserve","snapshotPolicy"]},"storage.NetAppNetworkEnum":{"type":"string","description":"Network types","enum":["vRack"]},"storage.NetAppPerformanceUnitEnum":{"type":"string","description":"Performance unit","enum":["IOPS","MiB/s"]},"storage.NetAppServicePerformanceLevelEnum":{"type":"string","description":"Service performance level","enum":["premium"]},"storage.NetAppShareSnapshotReserveUnitEnum":{"type":"string","description":"Share snapshot reserve unit","enum":["percent"]},"storage.NetAppSizeUnitEnum":{"type":"string","description":"Size unit","enum":["GiB","TiB"]},"storage.ProtocolEnum":{"type":"string","description":"Storage protocol","enum":["NFS"]},"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":{"/storage/netapp/capabilities/product":{"get":{"summary":"Get product capabilities","description":"Returns product capabilities such as features, supported protocols, and limits.","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/storage.NetAppCapabilitiesProduct"}}}}},"tags":["capabilities"],"x-developer-hub-navigation":[["Storage & Backup","File Storage","Enterprise File Storage","Capabilities@@@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(\"/storage/netapp/capabilities/product\")\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(\"/storage/netapp/capabilities/product\");\n\nprint_r($result);\n?>"}]}}},"tags":[{"name":"capabilities","x-tag-expanded":false,"description":"Missing description"}]}