{"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.BackendCustomerServerStatusEnum":{"type":"string","description":"Possible values for server status","enum":["active","inactive"]},"ipLoadbalancing.BackendProbe":{"type":"object","description":"Probe used to determine if a backend is alive and can handle requests","properties":{"forceSsl":{"type":"boolean","description":"Force probe to run over a SSL layer. Defaults to false","nullable":true},"interval":{"type":"integer","description":"Seconds between each probe check. Must be > 30sec. Defaults to 30","nullable":true},"match":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.ProbeExpectMatchEnum"}],"description":"Matcher to use to valide \"expect\". \"default\" uses HAProxy's default behavior for this type of check. \"status\" is only supported for HTTP probes","nullable":true},"method":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.ProbeMethodEnum"}],"description":"HTTP method to use with \"http\" probe. Consider using HEAD to save bandwidth when possible. Defaults to \"GET\"","nullable":true},"negate":{"type":"boolean","description":"Invert the matching operator effect","nullable":true},"pattern":{"type":"string","description":"Server response expected when UP. Empty for \"default\", comma delimited list of statuses for \"status\", string for \"contains\", regex for \"matches\"","nullable":true},"port":{"type":"integer","description":"Port used to probe your backend. Equal to farm port if null. Ignored for oco probe type","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.ProbeTypeEnum"}],"description":"Probe type. \"tcp\" if null","nullable":true},"url":{"type":"string","description":"URL to use for HTTP probes of the form [www.example.com]/path/to/check. Protocol will be ignored. Defaults to \"/\"","nullable":true}}},"ipLoadbalancing.BalanceTCPEnum":{"type":"string","description":"Possible values for load balancing balance algorithm","enum":["first","leastconn","roundrobin","source"]},"ipLoadbalancing.OnMarkedDownEnum":{"type":"string","description":"Possible values for OnMarkedDown type","enum":["shutdown-sessions"]},"ipLoadbalancing.ProbeExpectMatchEnum":{"type":"string","description":"List of possible probe result matches. \"status\" is only supported for HTTP probes","enum":["contains","default","internal","matches","status"]},"ipLoadbalancing.ProbeMethodEnum":{"type":"string","description":"List of possible method for HTTP probes. Consider using HEAD to save bandwidth when possible.","enum":["GET","HEAD","OPTIONS","internal"]},"ipLoadbalancing.ProbeTypeEnum":{"type":"string","description":"Possible values for farm probe","enum":["http","internal","mysql","oco","pgsql","smtp","tcp"]},"ipLoadbalancing.ProxyProtocolVersionEnum":{"type":"string","description":"Possible values for proxy type","enum":["v1","v2","v2-ssl","v2-ssl-cn"]},"ipLoadbalancing.ServerState":{"type":"object","description":"Available servers states","properties":{"checkCode":{"type":"string","description":"Layer5-7 code, if available","nullable":true},"checkStatus":{"type":"string","description":"Status of last health check","nullable":true},"checkTime":{"type":"string","description":"Time of last health check","nullable":true,"format":"date-time"},"instanceId":{"type":"integer","description":"Id of your instance"},"lastCheckContent":{"type":"string","description":"Last health check contents or textual error","nullable":true},"status":{"type":"string","description":"Status","nullable":true}}},"ipLoadbalancing.StickinessTCPEnum":{"type":"string","description":"Possible values for TCP backend stickiness","enum":["sourceIp"]},"ipLoadbalancing.backendTcp.BackendTcp":{"type":"object","description":"TCP Farm","properties":{"balance":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.BalanceTCPEnum"}],"description":"Load balancing algorithm. 'roundrobin' if null","nullable":true},"displayName":{"type":"string","description":"Human readable name for your backend, this field is for you","nullable":true},"farmId":{"type":"integer","description":"Id of your farm","readOnly":true},"port":{"type":"integer","description":"Port attached to your farm. Inherited from frontend if null","nullable":true},"probe":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.BackendProbe"}],"description":"Probe used to determine if a backend is alive and can handle requests. Defaults to tcp on the same port as the farm","nullable":true},"stickiness":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.StickinessTCPEnum"}],"description":"Stickiness type. No stickiness if null","nullable":true},"vrackNetworkId":{"type":"integer","description":"Internal Load Balancer identifier of the vRack private network attached to your farm, mandatory when your Load Balancer is attached to a vRack","nullable":true},"zone":{"type":"string","description":"Zone of you farm","readOnly":true}}},"ipLoadbalancing.backendTcpCustomerServer.BackendTCPServer":{"type":"object","description":"TCP Farm's Server","properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Address of your server","readOnly":true},"backendId":{"type":"integer","description":"Farm id","readOnly":true},"backup":{"type":"boolean","description":"Backup state. Default: 'false'"},"chain":{"type":"string","description":"Certificate chain. Allow server certificate verification (Avoid man-in-the-middle attacks)","nullable":true},"displayName":{"type":"string","description":"Human readable name for your server, this field is for you","nullable":true},"onMarkedDown":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.OnMarkedDownEnum"}],"description":"Set action when backend marked down. (No action if null)","nullable":true},"port":{"type":"integer","description":"Port attached to your server. Inherited from farm if null","nullable":true},"probe":{"type":"boolean","description":"Probe state. Default: 'false'"},"proxyProtocolVersion":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.ProxyProtocolVersionEnum"}],"description":"Disabled if null. Send PROXY protocol header. Requires a compatible server.","nullable":true},"serverId":{"type":"integer","description":"Id of your server","readOnly":true},"serverState":{"type":"array","description":"Server state","items":{"$ref":"#/components/schemas/ipLoadbalancing.ServerState"},"readOnly":true},"ssl":{"type":"boolean","description":"SSL ciphering. Probes will also be sent ciphered"},"status":{"allOf":[{"$ref":"#/components/schemas/ipLoadbalancing.BackendCustomerServerStatusEnum"}],"description":"Status attached to your server"},"weight":{"type":"integer","description":"Weight value. Defaults to 1. 0 if not used in load balancing. Servers with higher weight get more requests.","nullable":true}}},"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}/tcp/farm":{"get":{"summary":"List TCP farms","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}},{"in":"query","name":"vrackNetworkId","description":"Filter the value of vrackNetworkId property (=)","schema":{"type":"integer"}},{"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","Farms","TCP@@@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}/tcp/farm\")\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}/tcp/farm\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:tcp/farm/get","required":true}],"x-expanded-response":"IpLoadbalancingBackendTcpBackendTcp"},"post":{"summary":"Create a TCP farm","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":{"balance":{"description":"Load balancing algorithm. 'roundrobin' if null","$ref":"#/components/schemas/ipLoadbalancing.BalanceTCPEnum"},"displayName":{"type":"string","description":"Human readable name for your backend, this field is for you"},"port":{"type":"integer","description":"Port attached to your farm ([1..49151]). Inherited from frontend if null"},"probe":{"description":"Probe used to determine if a backend is alive and can handle requests","$ref":"#/components/schemas/ipLoadbalancing.BackendProbe"},"stickiness":{"description":"Stickiness type. No stickiness if null","$ref":"#/components/schemas/ipLoadbalancing.StickinessTCPEnum"},"vrackNetworkId":{"type":"integer","description":"Internal Load Balancer identifier of the vRack private network to attach to your farm, mandatory when your Load Balancer is attached to a vRack"},"zone":{"type":"string","description":"Zone of your farm"}},"required":["zone"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.backendTcp.BackendTcp"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Farms","TCP@@@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\n# Request body type: string\nresult = client.post(\"/ipLoadbalancing/{serviceName}/tcp/farm\",\n\tbalance = None, # Load balancing algorithm. 'roundrobin' if null (type: ipLoadbalancing.BalanceTCPEnum, nullable)\n\tdisplayName = None, # Human readable name for your backend, this field is for you (type: string, nullable)\n\tport = None, # Port attached to your farm ([1..49151]). Inherited from frontend if null (type: long, nullable)\n\tprobe = None, # Probe used to determine if a backend is alive and can handle requests (type: ipLoadbalancing.BackendProbe, nullable)\n\tstickiness = None, # Stickiness type. No stickiness if null (type: ipLoadbalancing.StickinessTCPEnum, nullable)\n\tvrackNetworkId = None, # Internal Load Balancer identifier of the vRack private network to attach to your farm, mandatory when your Load Balancer is attached to a vRack (type: long, nullable)\n\tzone = None, # Zone of your farm (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: string\n$result = $ovh->post(\"/ipLoadbalancing/{serviceName}/tcp/farm\", array(\n\tbalance => null, // Load balancing algorithm. 'roundrobin' if null (type: ipLoadbalancing.BalanceTCPEnum, nullable)\n\tdisplayName => null, // Human readable name for your backend, this field is for you (type: string, nullable)\n\tport => null, // Port attached to your farm ([1..49151]). Inherited from frontend if null (type: long, nullable)\n\tprobe => null, // Probe used to determine if a backend is alive and can handle requests (type: ipLoadbalancing.BackendProbe, nullable)\n\tstickiness => null, // Stickiness type. No stickiness if null (type: ipLoadbalancing.StickinessTCPEnum, nullable)\n\tvrackNetworkId => null, // Internal Load Balancer identifier of the vRack private network to attach to your farm, mandatory when your Load Balancer is attached to a vRack (type: long, nullable)\n\tzone => null, // Zone of your farm (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:tcp/farm/create","required":true}]}},"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}":{"delete":{"summary":"Delete a TCP farm","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"farmId","description":"Id of your farm","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","Farms","TCP@@@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}/tcp/farm/{farmId}\")\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}/tcp/farm/{farmId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:tcp/farm/delete","required":true}]},"get":{"summary":"Get a TCP farm","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"farmId","description":"Id of your farm","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.backendTcp.BackendTcp"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Farms","TCP@@@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}/tcp/farm/{farmId}\")\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}/tcp/farm/{farmId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:tcp/farm/get","required":true}]},"put":{"summary":"Update a TCP farm","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"farmId","description":"Id of your farm","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.backendTcp.BackendTcp"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Load Balancer","Farms","TCP@@@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.backendTcp.BackendTcp\nresult = client.put(\"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}\",\n\tbalance = None, # Load balancing algorithm. 'roundrobin' if null (type: ipLoadbalancing.BalanceTCPEnum, nullable)\n\tdisplayName = None, # Human readable name for your backend, this field is for you (type: string, nullable)\n\tport = None, # Port attached to your farm. Inherited from frontend if null (type: integer, nullable)\n\tprobe = None, # Probe used to determine if a backend is alive and can handle requests. Defaults to tcp on the same port as the farm (type: ipLoadbalancing.BackendProbe, nullable)\n\tstickiness = None, # Stickiness type. No stickiness if null (type: ipLoadbalancing.StickinessTCPEnum, nullable)\n\tvrackNetworkId = None, # Internal Load Balancer identifier of the vRack private network attached to your farm, mandatory when your Load Balancer is attached to a vRack (type: integer, 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.backendTcp.BackendTcp\n$result = $ovh->put(\"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}\", array(\n\tbalance => null, // Load balancing algorithm. 'roundrobin' if null (type: ipLoadbalancing.BalanceTCPEnum, nullable)\n\tdisplayName => null, // Human readable name for your backend, this field is for you (type: string, nullable)\n\tport => null, // Port attached to your farm. Inherited from frontend if null (type: integer, nullable)\n\tprobe => null, // Probe used to determine if a backend is alive and can handle requests. Defaults to tcp on the same port as the farm (type: ipLoadbalancing.BackendProbe, nullable)\n\tstickiness => null, // Stickiness type. No stickiness if null (type: ipLoadbalancing.StickinessTCPEnum, nullable)\n\tvrackNetworkId => null, // Internal Load Balancer identifier of the vRack private network attached to your farm, mandatory when your Load Balancer is attached to a vRack (type: integer, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:tcp/farm/edit","required":true}]}},"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server":{"get":{"summary":"List farm servers","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"address","description":"Filter the value of address property (=)","schema":{"$ref":"#/components/schemas/ipv4"}},{"in":"path","name":"farmId","description":"Id of your farm","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your IP load balancing","required":true,"schema":{"type":"string"}},{"in":"query","name":"status","description":"Filter the value of status property (=)","schema":{"$ref":"#/components/schemas/ipLoadbalancing.BackendCustomerServerStatusEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Farms","TCP@@@60"]],"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}/tcp/farm/{farmId}/server\")\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}/tcp/farm/{farmId}/server\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:tcp/farm/server/get","required":true}],"x-expanded-response":"IpLoadbalancingBackendTcpCustomerServerBackendTCPServer"},"post":{"summary":"Create a farm server","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"farmId","description":"Id of your farm","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":{"address":{"description":"Address of your server","$ref":"#/components/schemas/ipv4"},"backup":{"type":"boolean","description":"Set server as backup. Default: 'false'"},"chain":{"type":"string","description":"Certificate chain. Allow server certificate verification (Avoid man-in-the-middle attacks)"},"displayName":{"type":"string","description":"Human readable name for your server, this field is for you"},"onMarkedDown":{"description":"Enable action when backend marked down. (No action if null)","$ref":"#/components/schemas/ipLoadbalancing.OnMarkedDownEnum"},"port":{"type":"integer","description":"Port attached to your server ([1..49151]). Inherited from farm if null"},"probe":{"type":"boolean","description":"Enable/disable probe. Default: 'false'"},"proxyProtocolVersion":{"description":"Disabled if null. Send PROXY protocol header. Requires a compatible server.","$ref":"#/components/schemas/ipLoadbalancing.ProxyProtocolVersionEnum"},"ssl":{"type":"boolean","description":"SSL ciphering. Probes will also be sent ciphered. Default: 'false'"},"status":{"description":"Enable or disable your server","$ref":"#/components/schemas/ipLoadbalancing.BackendCustomerServerStatusEnum"},"weight":{"type":"integer","description":"Set weight on that server [1..256]. 0 if not used in load balancing. 1 if left null. Servers with higher weight get more requests."}},"required":["address","status"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ipLoadbalancing.backendTcpCustomerServer.BackendTCPServer"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Farms","TCP@@@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\n# Request body type: long\nresult = client.post(\"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server\",\n\taddress = None, # Address of your server (type: ipv4)\n\tbackup = None, # Set server as backup. Default: 'false' (type: boolean, nullable)\n\tchain = None, # Certificate chain. Allow server certificate verification (Avoid man-in-the-middle attacks) (type: text, nullable)\n\tdisplayName = None, # Human readable name for your server, this field is for you (type: string, nullable)\n\tonMarkedDown = None, # Enable action when backend marked down. (No action if null) (type: ipLoadbalancing.OnMarkedDownEnum, nullable)\n\tport = None, # Port attached to your server ([1..49151]). Inherited from farm if null (type: long, nullable)\n\tprobe = None, # Enable/disable probe. Default: 'false' (type: boolean, nullable)\n\tproxyProtocolVersion = None, # Disabled if null. Send PROXY protocol header. Requires a compatible server. (type: ipLoadbalancing.ProxyProtocolVersionEnum, nullable)\n\tssl = None, # SSL ciphering. Probes will also be sent ciphered. Default: 'false' (type: boolean, nullable)\n\tstatus = None, # Enable or disable your server (type: ipLoadbalancing.BackendCustomerServerStatusEnum)\n\tweight = None, # Set weight on that server [1..256]. 0 if not used in load balancing. 1 if left null. Servers with higher weight get more requests. (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// Request body type: long\n$result = $ovh->post(\"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server\", array(\n\taddress => null, // Address of your server (type: ipv4)\n\tbackup => null, // Set server as backup. Default: 'false' (type: boolean, nullable)\n\tchain => null, // Certificate chain. Allow server certificate verification (Avoid man-in-the-middle attacks) (type: text, nullable)\n\tdisplayName => null, // Human readable name for your server, this field is for you (type: string, nullable)\n\tonMarkedDown => null, // Enable action when backend marked down. (No action if null) (type: ipLoadbalancing.OnMarkedDownEnum, nullable)\n\tport => null, // Port attached to your server ([1..49151]). Inherited from farm if null (type: long, nullable)\n\tprobe => null, // Enable/disable probe. Default: 'false' (type: boolean, nullable)\n\tproxyProtocolVersion => null, // Disabled if null. Send PROXY protocol header. Requires a compatible server. (type: ipLoadbalancing.ProxyProtocolVersionEnum, nullable)\n\tssl => null, // SSL ciphering. Probes will also be sent ciphered. Default: 'false' (type: boolean, nullable)\n\tstatus => null, // Enable or disable your server (type: ipLoadbalancing.BackendCustomerServerStatusEnum)\n\tweight => null, // Set weight on that server [1..256]. 0 if not used in load balancing. 1 if left null. Servers with higher weight get more requests. (type: long, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:tcp/farm/server/create","required":true},{"name":"ip:apiovh:loadbalancer/allowAsBackend","required":false}]}},"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}":{"delete":{"summary":"Delete a farm server","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"farmId","description":"Id of your farm","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serverId","description":"Id of your server","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","Farms","TCP@@@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.delete(\"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}\")\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}/tcp/farm/{farmId}/server/{serverId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:tcp/farm/server/delete","required":true}]},"get":{"summary":"Get a farm server","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"farmId","description":"Id of your farm","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serverId","description":"Id of your server","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.backendTcpCustomerServer.BackendTCPServer"}}}}},"x-developer-hub-navigation":[["Network","Load Balancer","Farms","TCP@@@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.get(\"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}\")\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}/tcp/farm/{farmId}/server/{serverId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:tcp/farm/server/get","required":true}]},"put":{"summary":"Update a farm server","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"farmId","description":"Id of your farm","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serverId","description":"Id of your server","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.backendTcpCustomerServer.BackendTCPServer"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Network","Load Balancer","Farms","TCP@@@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\n# Request body type: ipLoadbalancing.backendTcpCustomerServer.BackendTCPServer\nresult = client.put(\"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}\",\n\tbackup = None, # Backup state. Default: 'false' (type: boolean)\n\tchain = None, # Certificate chain. Allow server certificate verification (Avoid man-in-the-middle attacks) (type: string, nullable)\n\tdisplayName = None, # Human readable name for your server, this field is for you (type: string, nullable)\n\tonMarkedDown = None, # Set action when backend marked down. (No action if null) (type: ipLoadbalancing.OnMarkedDownEnum, nullable)\n\tport = None, # Port attached to your server. Inherited from farm if null (type: integer, nullable)\n\tprobe = None, # Probe state. Default: 'false' (type: boolean)\n\tproxyProtocolVersion = None, # Disabled if null. Send PROXY protocol header. Requires a compatible server. (type: ipLoadbalancing.ProxyProtocolVersionEnum, nullable)\n\tssl = None, # SSL ciphering. Probes will also be sent ciphered (type: boolean)\n\tstatus = None, # Status attached to your server (type: ipLoadbalancing.BackendCustomerServerStatusEnum)\n\tweight = None, # Weight value. Defaults to 1. 0 if not used in load balancing. Servers with higher weight get more requests. (type: integer, 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.backendTcpCustomerServer.BackendTCPServer\n$result = $ovh->put(\"/ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}\", array(\n\tbackup => null, // Backup state. Default: 'false' (type: boolean)\n\tchain => null, // Certificate chain. Allow server certificate verification (Avoid man-in-the-middle attacks) (type: string, nullable)\n\tdisplayName => null, // Human readable name for your server, this field is for you (type: string, nullable)\n\tonMarkedDown => null, // Set action when backend marked down. (No action if null) (type: ipLoadbalancing.OnMarkedDownEnum, nullable)\n\tport => null, // Port attached to your server. Inherited from farm if null (type: integer, nullable)\n\tprobe => null, // Probe state. Default: 'false' (type: boolean)\n\tproxyProtocolVersion => null, // Disabled if null. Send PROXY protocol header. Requires a compatible server. (type: ipLoadbalancing.ProxyProtocolVersionEnum, nullable)\n\tssl => null, // SSL ciphering. Probes will also be sent ciphered (type: boolean)\n\tstatus => null, // Status attached to your server (type: ipLoadbalancing.BackendCustomerServerStatusEnum)\n\tweight => null, // Weight value. Defaults to 1. 0 if not used in load balancing. Servers with higher weight get more requests. (type: integer, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"loadbalancer:apiovh:tcp/farm/server/edit","required":true},{"name":"ip:apiovh:loadbalancer/allowAsBackend","required":false}]}}}}