{"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"},"ipLoadbalancing.frontendUdp.FrontendUdp":{"type":"object","description":"Frontend UDP","properties":{"dedicatedIpfo":{"type":"array","description":"Only attach frontend on these ip. No restriction if null","nullable":true,"items":{"$ref":"#/components/schemas/ipBlock"}},"defaultFarmId":{"type":"integer","description":"Default UDP Farm of your frontend","nullable":true},"disabled":{"type":"boolean","description":"Disable frontend. Default: 'false'"},"displayName":{"type":"string","description":"Human readable name for your frontend, this field is for you","nullable":true},"frontendId":{"type":"integer","description":"Id of your frontend","readOnly":true},"port":{"type":"string","description":"Listening port(s) on the server"},"zone":{"type":"string","description":"Zone of you frontend"}}},"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/{serviceName}/udp/frontend":{"get":{"summary":"List UDP frontends","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"defaultFarmId","description":"Filter the value of defaultFarmId property (=)","schema":{"type":"integer"}},{"in":"query","name":"port","description":"Filter the value of port property (like)","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}},{"in":"query","name":"zone","description":"Filter the value of zone property (=)","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","UDP@@@10"]],"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(\"/ipLoadbalancing/{serviceName}/udp/frontend\")\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}/udp/frontend\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:udp/frontend/get","required":true}],"x-expanded-response":"IpLoadbalancingFrontendUdpFrontendUdp"},"post":{"summary":"Create a UDP frontend","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":{"type":"object","properties":{"dedicatedIpfo":{"type":"array","description":"Only attach frontend on these ip. No restriction if null","items":{"$ref":"#/components/schemas/ipBlock"}},"defaultFarmId":{"type":"integer","description":"Default UDP Farm of your frontend"},"disabled":{"type":"boolean","description":"Disable your frontend. Default: 'false'"},"displayName":{"type":"string","description":"Human readable name for your frontend, this field is for you"},"port":{"type":"string","description":"Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range."},"zone":{"type":"string","description":"Zone of your frontend. Use \"all\" for all owned zone."}},"required":["port","zone"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.frontendUdp.FrontendUdp"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","UDP@@@20"]],"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.post(\"/ipLoadbalancing/{serviceName}/udp/frontend\",\n\tdedicatedIpfo = None, # Only attach frontend on these ip. No restriction if null (type: ipBlock[], nullable)\n\tdefaultFarmId = None, # Default UDP Farm of your frontend (type: long, nullable)\n\tdisabled = None, # Disable your frontend. Default: 'false' (type: boolean, nullable)\n\tdisplayName = None, # Human readable name for your frontend, this field is for you (type: string, nullable)\n\tport = None, # Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range. (type: string)\n\tzone = None, # Zone of your frontend. Use \"all\" for all owned zone. (type: string)\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$result = $ovh->post(\"/ipLoadbalancing/{serviceName}/udp/frontend\", array(\n\tdedicatedIpfo => null, // Only attach frontend on these ip. No restriction if null (type: ipBlock[], nullable)\n\tdefaultFarmId => null, // Default UDP Farm of your frontend (type: long, nullable)\n\tdisabled => null, // Disable your frontend. Default: 'false' (type: boolean, nullable)\n\tdisplayName => null, // Human readable name for your frontend, this field is for you (type: string, nullable)\n\tport => null, // Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range. (type: string)\n\tzone => null, // Zone of your frontend. Use \"all\" for all owned zone. (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:udp/frontend/create","required":true}]}},"/ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}":{"delete":{"summary":"Delete a UDP frontend","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"frontendId","description":"Id of your frontend","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","UDP@@@40"]],"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.delete(\"/ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}\")\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->delete(\"/ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:udp/frontend/delete","required":true}]},"get":{"summary":"Get a UDP frontend","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"frontendId","description":"Id of your frontend","required":true,"schema":{"type":"integer"}},{"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.frontendUdp.FrontendUdp"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","UDP@@@30"]],"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(\"/ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}\")\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}/udp/frontend/{frontendId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:udp/frontend/get","required":true}]},"put":{"summary":"Update a UDP frontend","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"frontendId","description":"Id of your frontend","required":true,"schema":{"type":"integer"}},{"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.frontendUdp.FrontendUdp"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","UDP@@@50"]],"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\n# Request body type: ipLoadbalancing.frontendUdp.FrontendUdp\nresult = client.put(\"/ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}\",\n\tdedicatedIpfo = None, # Only attach frontend on these ip. No restriction if null (type: array, nullable)\n\tdefaultFarmId = None, # Default UDP Farm of your frontend (type: integer, nullable)\n\tdisabled = None, # Disable frontend. Default: 'false' (type: boolean)\n\tdisplayName = None, # Human readable name for your frontend, this field is for you (type: string, nullable)\n\tport = None, # Listening port(s) on the server (type: string)\n\tzone = None, # Zone of you frontend (type: string)\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.frontendUdp.FrontendUdp\n$result = $ovh->put(\"/ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}\", array(\n\tdedicatedIpfo => null, // Only attach frontend on these ip. No restriction if null (type: array, nullable)\n\tdefaultFarmId => null, // Default UDP Farm of your frontend (type: integer, nullable)\n\tdisabled => null, // Disable frontend. Default: 'false' (type: boolean)\n\tdisplayName => null, // Human readable name for your frontend, this field is for you (type: string, nullable)\n\tport => null, // Listening port(s) on the server (type: string)\n\tzone => null, // Zone of you frontend (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:udp/frontend/edit","required":true}]}}}}