{"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.RouteHttp.RouteHttp":{"type":"object","description":"HTTP Route","properties":{"action":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.RouteHttpAction"}],"description":"Action triggered when all rules match"},"displayName":{"type":"string","description":"Human readable name for your route, this field is for you","nullable":true},"frontendId":{"type":"integer","description":"Route traffic for this frontend","nullable":true},"routeId":{"type":"integer","description":"Id of your route","readOnly":true},"rules":{"type":"array","description":"List of rules to match to trigger action","items":{"$ref":"#/components/schemas/ipLoadbalancing.RouteRule"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.RouteStatusEnum"}],"description":"Route status. Routes in \"ok\" state are ready to operate","readOnly":true},"weight":{"type":"integer","description":"Route priority ([0..255]). 0 if null. Highest priority routes are evaluated last. Only the first matching route will trigger an action"}}},"ipLoadbalancing.RouteHttpAction":{"type":"object","description":"Action triggered when all rules from route match","properties":{"status":{"type":"integer","description":"HTTP status code for \"redirect\" and \"reject\" actions","nullable":true},"target":{"type":"string","description":"Farm ID for \"farm\" action type or URL template for \"redirect\" action. You may use ${uri}, ${protocol}, ${host}, ${port} and ${path} variables in redirect target","nullable":true},"type":{"type":"string","description":"Action to trigger if all the rules of this route matches"}}},"ipLoadbalancing.RouteRule":{"type":"object","description":"Match rule to combine to build routes","properties":{"field":{"type":"string","description":"Name of the field to match like \"protocol\" or \"host\". See \"/ipLoadbalancing/{serviceName}/route/availableRules\" for a list of available rules"},"match":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.RouteRuleMatchesEnum"}],"description":"Matching operator. Not all operators are available for all fields. See \"/availableRules\""},"negate":{"type":"boolean","description":"Invert the matching operator effect"},"pattern":{"type":"string","description":"Value to match against this match. Interpretation if this field depends on the match and field","nullable":true},"ruleId":{"type":"integer","description":"Id of your rule"},"subField":{"type":"string","description":"Name of sub-field, if applicable. This may be a Cookie or Header name for instance","nullable":true}}},"ipLoadbalancing.RouteRule.RouteRule":{"type":"object","description":"Rule of a route","properties":{"displayName":{"type":"string","description":"Human readable name for your rule","nullable":true},"field":{"type":"string","description":"Name of the field to match like \"protocol\" or \"host\". See \"/ipLoadbalancing/{serviceName}/availableRouteRules\" for a list of available rules"},"match":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.RouteRuleMatchesEnum"}],"description":"Matching operator. Not all operators are available for all fields. See \"/ipLoadbalancing/{serviceName}/availableRouteRules\""},"negate":{"type":"boolean","description":"Invert the matching operator effect"},"pattern":{"type":"string","description":"Value to match against this match. Interpretation if this field depends on the match and field","nullable":true},"ruleId":{"type":"integer","description":"Id of your rule","readOnly":true},"subField":{"type":"string","description":"Name of sub-field, if applicable. This may be a Cookie or Header name for instance","nullable":true}}},"ipLoadbalancing.RouteRuleMatchesEnum":{"type":"string","description":"List of possible route rule matches","enum":["contains","endswith","exists","in","internal","is","matches","startswith"]},"ipLoadbalancing.RouteStatusEnum":{"type":"string","description":"Route configuration status","enum":["creating","deleting","internal","ok","updating"]},"ipLoadbalancing.frontendHttp.FrontendHttp":{"type":"object","description":"Frontend HTTP","properties":{"allowedSource":{"type":"array","description":"Restrict IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time","nullable":true,"items":{"$ref":"#/components/schemas/ipBlock"}},"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 HTTP Farm of your frontend","nullable":true},"defaultSslId":{"type":"integer","description":"Default ssl served to your customer","nullable":true},"deniedSource":{"type":"array","description":"Deny IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time","nullable":true,"items":{"$ref":"#/components/schemas/ipBlock"}},"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},"forceSni":{"type":"boolean","description":"block all SSL connection request without SNI. Default: 'false'"},"frontendId":{"type":"integer","description":"Id of your frontend","readOnly":true},"hsts":{"type":"boolean","description":"HTTP Strict Transport Security. Default: 'false'"},"httpHeader":{"type":"array","description":"Add header to your frontend. Useful variables admitted : %ci <=> client_ip, %cp <=> client_port","nullable":true,"items":{"type":"string"}},"port":{"type":"string","description":"Listening port(s) on the server"},"redirectLocation":{"type":"string","description":"HTTP redirection (Ex : http://www.ovh.com)","nullable":true},"ssl":{"type":"boolean","description":"SSL deciphering. Default: 'false'"},"vrackNetworkId":{"type":"integer","description":"Internal Load Balancer identifier of the vRack private network attached to your frontend.","nullable":true,"readOnly":true},"vrackVrouterId":{"type":"integer","description":"Virtual Router Identifier. 1-255","nullable":true,"readOnly":true},"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}/http/frontend":{"get":{"summary":"List HTTP frontends","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"defaultFarmId","description":"Filter the value of defaultFarmId property (=)","schema":{"type":"integer"}},{"in":"query","name":"defaultSslId","description":"Filter the value of defaultSslId 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","HTTP@@@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/{serviceName}/http/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}/http/frontend\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/frontend/get","required":true}],"x-expanded-response":"IpLoadbalancingFrontendHttpFrontendHttp"},"post":{"summary":"Create an HTTP 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":{"allowedSource":{"type":"array","description":"Restrict IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time","items":{"$ref":"#/components/schemas/ipBlock"}},"dedicatedIpfo":{"type":"array","description":"Only attach frontend on these ip. No restriction if null","items":{"$ref":"#/components/schemas/ipBlock"}},"defaultFarmId":{"type":"integer","description":"Default HTTP Farm of your frontend"},"defaultSslId":{"type":"integer","description":"Default ssl served to your customer"},"deniedSource":{"type":"array","description":"Deny IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time","items":{"$ref":"#/components/schemas/ipBlock"}},"disabled":{"type":"boolean","description":"Disable your frontend. Default: 'false'"},"displayName":{"type":"string","description":"Human readable name for your frontend, this field is for you"},"forceSni":{"type":"boolean","description":"block all SSL connection request without SNI. Default: 'false'"},"hsts":{"type":"boolean","description":"HTTP Strict Transport Security. Default: 'false'"},"httpHeader":{"type":"array","description":"Add header to your frontend. Useful variables admitted : %ci <=> client_ip, %cp <=> client_port","items":{"type":"string"}},"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."},"redirectLocation":{"type":"string","description":"HTTP redirection (Ex : http://www.ovh.com)"},"ssl":{"type":"boolean","description":"SSL deciphering. Default: 'false'"},"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.frontendHttp.FrontendHttp"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@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.post(\"/ipLoadbalancing/{serviceName}/http/frontend\",\n\tallowedSource = None, # Restrict IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time (type: ipBlock[], nullable)\n\tdedicatedIpfo = None, # Only attach frontend on these ip. No restriction if null (type: ipBlock[], nullable)\n\tdefaultFarmId = None, # Default HTTP Farm of your frontend (type: long, nullable)\n\tdefaultSslId = None, # Default ssl served to your customer (type: long, nullable)\n\tdeniedSource = None, # Deny IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time (type: ipBlock[], 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\tforceSni = None, # block all SSL connection request without SNI. Default: 'false' (type: boolean, nullable)\n\thsts = None, # HTTP Strict Transport Security. Default: 'false' (type: boolean, nullable)\n\thttpHeader = None, # Add header to your frontend. Useful variables admitted : %ci <=> client_ip, %cp <=> client_port (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\tredirectLocation = None, # HTTP redirection (Ex : http://www.ovh.com) (type: string, nullable)\n\tssl = None, # SSL deciphering. Default: 'false' (type: boolean, nullable)\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}/http/frontend\", array(\n\tallowedSource => null, // Restrict IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time (type: ipBlock[], nullable)\n\tdedicatedIpfo => null, // Only attach frontend on these ip. No restriction if null (type: ipBlock[], nullable)\n\tdefaultFarmId => null, // Default HTTP Farm of your frontend (type: long, nullable)\n\tdefaultSslId => null, // Default ssl served to your customer (type: long, nullable)\n\tdeniedSource => null, // Deny IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time (type: ipBlock[], 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\tforceSni => null, // block all SSL connection request without SNI. Default: 'false' (type: boolean, nullable)\n\thsts => null, // HTTP Strict Transport Security. Default: 'false' (type: boolean, nullable)\n\thttpHeader => null, // Add header to your frontend. Useful variables admitted : %ci <=> client_ip, %cp <=> client_port (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\tredirectLocation => null, // HTTP redirection (Ex : http://www.ovh.com) (type: string, nullable)\n\tssl => null, // SSL deciphering. Default: 'false' (type: boolean, nullable)\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:http/frontend/create","required":true}]}},"/ipLoadbalancing/{serviceName}/http/frontend/{frontendId}":{"delete":{"summary":"Delete an HTTP 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","HTTP@@@40"]],"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.delete(\"/ipLoadbalancing/{serviceName}/http/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}/http/frontend/{frontendId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/frontend/delete","required":true}]},"get":{"summary":"Get an HTTP 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.frontendHttp.FrontendHttp"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@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\nresult = client.get(\"/ipLoadbalancing/{serviceName}/http/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}/http/frontend/{frontendId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/frontend/get","required":true}]},"put":{"summary":"Update an HTTP 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.frontendHttp.FrontendHttp"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@50"]],"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.frontendHttp.FrontendHttp\nresult = client.put(\"/ipLoadbalancing/{serviceName}/http/frontend/{frontendId}\",\n\tallowedSource = None, # Restrict IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time (type: array, nullable)\n\tdedicatedIpfo = None, # Only attach frontend on these ip. No restriction if null (type: array, nullable)\n\tdefaultFarmId = None, # Default HTTP Farm of your frontend (type: integer, nullable)\n\tdefaultSslId = None, # Default ssl served to your customer (type: integer, nullable)\n\tdeniedSource = None, # Deny IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time (type: array, 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\tforceSni = None, # block all SSL connection request without SNI. Default: 'false' (type: boolean)\n\thsts = None, # HTTP Strict Transport Security. Default: 'false' (type: boolean)\n\thttpHeader = None, # Add header to your frontend. Useful variables admitted : %ci <=> client_ip, %cp <=> client_port (type: array, nullable)\n\tport = None, # Listening port(s) on the server (type: string)\n\tredirectLocation = None, # HTTP redirection (Ex : http://www.ovh.com) (type: string, nullable)\n\tssl = None, # SSL deciphering. Default: 'false' (type: boolean)\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.frontendHttp.FrontendHttp\n$result = $ovh->put(\"/ipLoadbalancing/{serviceName}/http/frontend/{frontendId}\", array(\n\tallowedSource => null, // Restrict IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time (type: array, nullable)\n\tdedicatedIpfo => null, // Only attach frontend on these ip. No restriction if null (type: array, nullable)\n\tdefaultFarmId => null, // Default HTTP Farm of your frontend (type: integer, nullable)\n\tdefaultSslId => null, // Default ssl served to your customer (type: integer, nullable)\n\tdeniedSource => null, // Deny IP Load Balancing access to these ip block. No restriction if null. You cannot specify allowedSource and deniedSource both at the same time (type: array, 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\tforceSni => null, // block all SSL connection request without SNI. Default: 'false' (type: boolean)\n\thsts => null, // HTTP Strict Transport Security. Default: 'false' (type: boolean)\n\thttpHeader => null, // Add header to your frontend. Useful variables admitted : %ci <=> client_ip, %cp <=> client_port (type: array, nullable)\n\tport => null, // Listening port(s) on the server (type: string)\n\tredirectLocation => null, // HTTP redirection (Ex : http://www.ovh.com) (type: string, nullable)\n\tssl => null, // SSL deciphering. Default: 'false' (type: boolean)\n\tzone => null, // Zone of you frontend (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/frontend/edit","required":true}]}},"/ipLoadbalancing/{serviceName}/http/route":{"get":{"summary":"List HTTP routes","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"frontendId","description":"Filter the value of frontendId property (=)","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":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@70"]],"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}/http/route\")\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}/http/route\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/route/get","required":true}],"x-expanded-response":"IpLoadbalancingRouteHttpRouteHttp"},"post":{"summary":"Create an HTTP route","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":{"action":{"description":"Action triggered when all rules match","$ref":"#/components/schemas/ipLoadbalancing.RouteHttpAction"},"displayName":{"type":"string","description":"Human readable name for your route, this field is for you"},"frontendId":{"type":"integer","description":"Route traffic for this frontend"},"weight":{"type":"integer","description":"Route priority ([0..255]). 0 if null. Highest priority routes are evaluated last. Only the first matching route will trigger an action"}},"required":["action"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.RouteHttp.RouteHttp"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@80"]],"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.post(\"/ipLoadbalancing/{serviceName}/http/route\",\n\taction = None, # Action triggered when all rules match (type: ipLoadbalancing.RouteHttpAction)\n\tdisplayName = None, # Human readable name for your route, this field is for you (type: string, nullable)\n\tfrontendId = None, # Route traffic for this frontend (type: long, nullable)\n\tweight = None, # Route priority ([0..255]). 0 if null. Highest priority routes are evaluated last. Only the first matching route will trigger an action (type: long, 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$result = $ovh->post(\"/ipLoadbalancing/{serviceName}/http/route\", array(\n\taction => null, // Action triggered when all rules match (type: ipLoadbalancing.RouteHttpAction)\n\tdisplayName => null, // Human readable name for your route, this field is for you (type: string, nullable)\n\tfrontendId => null, // Route traffic for this frontend (type: long, nullable)\n\tweight => null, // Route priority ([0..255]). 0 if null. Highest priority routes are evaluated last. Only the first matching route will trigger an action (type: long, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/route/create","required":true}]}},"/ipLoadbalancing/{serviceName}/http/route/{routeId}":{"delete":{"summary":"Delete an HTTP route","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"routeId","description":"Id of your route","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","HTTP@@@100"]],"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.delete(\"/ipLoadbalancing/{serviceName}/http/route/{routeId}\")\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}/http/route/{routeId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/route/delete","required":true}]},"get":{"summary":"Get an HTTP route","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"routeId","description":"Id of your route","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.RouteHttp.RouteHttp"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@90"]],"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}/http/route/{routeId}\")\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}/http/route/{routeId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/route/get","required":true}]},"put":{"summary":"Update an HTTP route","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"routeId","description":"Id of your route","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.RouteHttp.RouteHttp"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@110"]],"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.RouteHttp.RouteHttp\nresult = client.put(\"/ipLoadbalancing/{serviceName}/http/route/{routeId}\",\n\taction = None, # Action triggered when all rules match (type: ipLoadbalancing.RouteHttpAction)\n\tdisplayName = None, # Human readable name for your route, this field is for you (type: string, nullable)\n\tfrontendId = None, # Route traffic for this frontend (type: integer, nullable)\n\tweight = None, # Route priority ([0..255]). 0 if null. Highest priority routes are evaluated last. Only the first matching route will trigger an action (type: integer)\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.RouteHttp.RouteHttp\n$result = $ovh->put(\"/ipLoadbalancing/{serviceName}/http/route/{routeId}\", array(\n\taction => null, // Action triggered when all rules match (type: ipLoadbalancing.RouteHttpAction)\n\tdisplayName => null, // Human readable name for your route, this field is for you (type: string, nullable)\n\tfrontendId => null, // Route traffic for this frontend (type: integer, nullable)\n\tweight => null, // Route priority ([0..255]). 0 if null. Highest priority routes are evaluated last. Only the first matching route will trigger an action (type: integer)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/route/edit","required":true}]}},"/ipLoadbalancing/{serviceName}/http/route/{routeId}/rule":{"get":{"summary":"List route rules","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"routeId","description":"Id of your route","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":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@120"]],"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}/http/route/{routeId}/rule\")\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}/http/route/{routeId}/rule\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/route/rule/get","required":true}],"x-expanded-response":"IpLoadbalancingRouteRuleRouteRule"},"post":{"summary":"Create a route rule","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"routeId","description":"Id of your route","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":{"type":"object","properties":{"displayName":{"type":"string","description":"Human readable name for your rule"},"field":{"type":"string","description":"Name of the field to match like \"protocol\" or \"host\". See \"/ipLoadbalancing/{serviceName}/availableRouteRules\" for a list of available rules"},"match":{"description":"Matching operator. Not all operators are available for all fields. See \"/ipLoadbalancing/{serviceName}/availableRouteRules\"","$ref":"#/components/schemas/ipLoadbalancing.RouteRuleMatchesEnum"},"negate":{"type":"boolean","description":"Invert the matching operator effect"},"pattern":{"type":"string","description":"Value to match against this match. Interpretation if this field depends on the match and field"},"subField":{"type":"string","description":"Name of sub-field, if applicable. This may be a Cookie or Header name for instance"}},"required":["field","match"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.RouteRule.RouteRule"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@130"]],"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.post(\"/ipLoadbalancing/{serviceName}/http/route/{routeId}/rule\",\n\tdisplayName = None, # Human readable name for your rule (type: string, nullable)\n\tfield = None, # Name of the field to match like \"protocol\" or \"host\". See \"/ipLoadbalancing/{serviceName}/availableRouteRules\" for a list of available rules (type: string)\n\tmatch = None, # Matching operator. Not all operators are available for all fields. See \"/ipLoadbalancing/{serviceName}/availableRouteRules\" (type: ipLoadbalancing.RouteRuleMatchesEnum)\n\tnegate = None, # Invert the matching operator effect (type: boolean, nullable)\n\tpattern = None, # Value to match against this match. Interpretation if this field depends on the match and field (type: string, nullable)\n\tsubField = None, # Name of sub-field, if applicable. This may be a Cookie or Header name for instance (type: string, 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$result = $ovh->post(\"/ipLoadbalancing/{serviceName}/http/route/{routeId}/rule\", array(\n\tdisplayName => null, // Human readable name for your rule (type: string, nullable)\n\tfield => null, // Name of the field to match like \"protocol\" or \"host\". See \"/ipLoadbalancing/{serviceName}/availableRouteRules\" for a list of available rules (type: string)\n\tmatch => null, // Matching operator. Not all operators are available for all fields. See \"/ipLoadbalancing/{serviceName}/availableRouteRules\" (type: ipLoadbalancing.RouteRuleMatchesEnum)\n\tnegate => null, // Invert the matching operator effect (type: boolean, nullable)\n\tpattern => null, // Value to match against this match. Interpretation if this field depends on the match and field (type: string, nullable)\n\tsubField => null, // Name of sub-field, if applicable. This may be a Cookie or Header name for instance (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/route/rule/create","required":true}]}},"/ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}":{"delete":{"summary":"Delete a route rule","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"routeId","description":"Id of your route","required":true,"schema":{"type":"integer"}},{"in":"path","name":"ruleId","description":"Id of your rule","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","HTTP@@@150"]],"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.delete(\"/ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}\")\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}/http/route/{routeId}/rule/{ruleId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/route/rule/delete","required":true}]},"get":{"summary":"Get a route rule","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"routeId","description":"Id of your route","required":true,"schema":{"type":"integer"}},{"in":"path","name":"ruleId","description":"Id of your rule","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.RouteRule.RouteRule"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@140"]],"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}/http/route/{routeId}/rule/{ruleId}\")\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}/http/route/{routeId}/rule/{ruleId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/route/rule/get","required":true}]},"put":{"summary":"Update a route rule","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"routeId","description":"Id of your route","required":true,"schema":{"type":"integer"}},{"in":"path","name":"ruleId","description":"Id of your rule","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.RouteRule.RouteRule"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Load Balancer","Frontends","HTTP@@@160"]],"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.RouteRule.RouteRule\nresult = client.put(\"/ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}\",\n\tdisplayName = None, # Human readable name for your rule (type: string, nullable)\n\tfield = None, # Name of the field to match like \"protocol\" or \"host\". See \"/ipLoadbalancing/{serviceName}/availableRouteRules\" for a list of available rules (type: string)\n\tmatch = None, # Matching operator. Not all operators are available for all fields. See \"/ipLoadbalancing/{serviceName}/availableRouteRules\" (type: ipLoadbalancing.RouteRuleMatchesEnum)\n\tnegate = None, # Invert the matching operator effect (type: boolean)\n\tpattern = None, # Value to match against this match. Interpretation if this field depends on the match and field (type: string, nullable)\n\tsubField = None, # Name of sub-field, if applicable. This may be a Cookie or Header name for instance (type: string, 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.RouteRule.RouteRule\n$result = $ovh->put(\"/ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}\", array(\n\tdisplayName => null, // Human readable name for your rule (type: string, nullable)\n\tfield => null, // Name of the field to match like \"protocol\" or \"host\". See \"/ipLoadbalancing/{serviceName}/availableRouteRules\" for a list of available rules (type: string)\n\tmatch => null, // Matching operator. Not all operators are available for all fields. See \"/ipLoadbalancing/{serviceName}/availableRouteRules\" (type: ipLoadbalancing.RouteRuleMatchesEnum)\n\tnegate => null, // Invert the matching operator effect (type: boolean)\n\tpattern => null, // Value to match against this match. Interpretation if this field depends on the match and field (type: string, nullable)\n\tsubField => null, // Name of sub-field, if applicable. This may be a Cookie or Header name for instance (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:http/route/rule/edit","required":true}]}}}}