{"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"},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value (defaults to 'EQ')","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"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"},"ipLoadbalancing.Ip":{"type":"object","description":"Your IP load balancing","properties":{"displayName":{"type":"string","description":"Set the name displayed in ManagerV6 for your iplb (max 50 chars)","nullable":true},"ipLoadbalancing":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"Your IP load balancing","readOnly":true},"ipv4":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"The IPV4 associated to your IP load balancing","nullable":true,"readOnly":true},"ipv6":{"allOf":[{"$ref":"#/components/schemas/ipv6"}],"description":"The IPV6 associated to your IP load balancing","nullable":true,"readOnly":true},"metricsToken":{"type":"string","description":"The metrics token associated with your IP load balancing","nullable":true,"readOnly":true},"offer":{"type":"string","description":"The offer of your IP load balancing","readOnly":true},"orderableZone":{"type":"array","description":"Available additional zone for your Load Balancer","items":{"$ref":"#/components/schemas/ipLoadbalancing.OrderableZone"},"readOnly":true},"serviceName":{"type":"string","description":"The internal name of your IP load balancing","readOnly":true},"sslConfiguration":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.SslConfigurationEnum"}],"description":"Modern oldest compatible clients : Firefox 27, Chrome 30, IE 11 on Windows 7, Edge, Opera 17, Safari 9, Android 5.0, and Java 8. Intermediate oldest compatible clients : Firefox 1, Chrome 1, IE 7, Opera 5, Safari 1, Windows XP IE8, Android 2.3, Java 7. Intermediate if null.","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.IpStateEnum"}],"description":"Current state of your IP","readOnly":true},"vrackEligibility":{"type":"boolean","description":"Vrack eligibility","readOnly":true},"vrackName":{"type":"string","description":"Name of the vRack on which the current Load Balancer is attached to, as it is named on vRack product","nullable":true,"readOnly":true},"zone":{"type":"array","description":"Location where your service is","items":{"type":"string"},"readOnly":true}}},"ipLoadbalancing.IpStateEnum":{"type":"string","description":"Possible values for load balancing IP state","enum":["blacklisted","deleted","free","ok","quarantined","suspended"]},"ipLoadbalancing.IpWithIAM":{"type":"object","description":"Your IP load balancing","properties":{"displayName":{"type":"string","description":"Set the name displayed in ManagerV6 for your iplb (max 50 chars)","nullable":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"ipLoadbalancing":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"Your IP load balancing","readOnly":true},"ipv4":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"The IPV4 associated to your IP load balancing","nullable":true,"readOnly":true},"ipv6":{"allOf":[{"$ref":"#/components/schemas/ipv6"}],"description":"The IPV6 associated to your IP load balancing","nullable":true,"readOnly":true},"metricsToken":{"type":"string","description":"The metrics token associated with your IP load balancing","nullable":true,"readOnly":true},"offer":{"type":"string","description":"The offer of your IP load balancing","readOnly":true},"orderableZone":{"type":"array","description":"Available additional zone for your Load Balancer","items":{"$ref":"#/components/schemas/ipLoadbalancing.OrderableZone"},"readOnly":true},"serviceName":{"type":"string","description":"The internal name of your IP load balancing","readOnly":true},"sslConfiguration":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.SslConfigurationEnum"}],"description":"Modern oldest compatible clients : Firefox 27, Chrome 30, IE 11 on Windows 7, Edge, Opera 17, Safari 9, Android 5.0, and Java 8. Intermediate oldest compatible clients : Firefox 1, Chrome 1, IE 7, Opera 5, Safari 1, Windows XP IE8, Android 2.3, Java 7. Intermediate if null.","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.IpStateEnum"}],"description":"Current state of your IP","readOnly":true},"vrackEligibility":{"type":"boolean","description":"Vrack eligibility","readOnly":true},"vrackName":{"type":"string","description":"Name of the vRack on which the current Load Balancer is attached to, as it is named on vRack product","nullable":true,"readOnly":true},"zone":{"type":"array","description":"Location where your service is","items":{"type":"string"},"readOnly":true}}},"ipLoadbalancing.OrderableZone":{"type":"object","description":"Available additional zone to order for a Load Balancer","properties":{"name":{"type":"string","description":"The zone three letter code"},"planCode":{"type":"string","description":"The billing planCode for this zone"}}},"ipLoadbalancing.SslConfigurationEnum":{"type":"string","description":"Possible values for ssl ciphers","enum":["intermediate","modern"]},"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":{"/ipLoadbalancing":{"get":{"summary":"List Load Balancer services","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","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(\"/ipLoadbalancing\")\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(\"/ipLoadbalancing\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:get","required":true}],"x-expanded-response":"IpLoadbalancingIpWithIAM"}},"/ipLoadbalancing/{serviceName}":{"get":{"summary":"Get a Load Balancer service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.IpWithIAM"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Services@@@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(\"/ipLoadbalancing/{serviceName}\")\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(\"/ipLoadbalancing/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:get","required":true}]},"put":{"summary":"Update a Load Balancer service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.Ip"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Load Balancer","Services@@@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\n# Request body type: ipLoadbalancing.Ip\nresult = client.put(\"/ipLoadbalancing/{serviceName}\",\n\tdisplayName = None, # Set the name displayed in ManagerV6 for your iplb (max 50 chars) (type: string, nullable)\n\tsslConfiguration = None, # Modern oldest compatible clients : Firefox 27, Chrome 30, IE 11 on Windows 7, Edge, Opera 17, Safari 9, Android 5.0, and Java 8. Intermediate oldest compatible clients : Firefox 1, Chrome 1, IE 7, Opera 5, Safari 1, Windows XP IE8, Android 2.3, Java 7. Intermediate if null. (type: ipLoadbalancing.SslConfigurationEnum, nullable)\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: ipLoadbalancing.Ip\n$result = $ovh->put(\"/ipLoadbalancing/{serviceName}\", array(\n\tdisplayName => null, // Set the name displayed in ManagerV6 for your iplb (max 50 chars) (type: string, nullable)\n\tsslConfiguration => null, // Modern oldest compatible clients : Firefox 27, Chrome 30, IE 11 on Windows 7, Edge, Opera 17, Safari 9, Android 5.0, and Java 8. Intermediate oldest compatible clients : Firefox 1, Chrome 1, IE 7, Opera 5, Safari 1, Windows XP IE8, Android 2.3, Java 7. Intermediate if null. (type: ipLoadbalancing.SslConfigurationEnum, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:put","required":true}]}}}}