{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value (defaults to 'EQ')","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"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"},"otb.service.activationStatusEnum":{"type":"string","description":"Activation status of a service","enum":["disabled","enabled"]},"otb.service.configurationModeEnum":{"type":"string","description":"Configuration mode of the service","enum":["autoconfigure","local"]},"otb.service.graphEndpoint":{"type":"object","description":"Parameters required to query metrics from OpenTSDB","properties":{"host":{"type":"string","description":"The openTSDB host","readOnly":true},"readToken":{"type":"string","description":"The read-only token","readOnly":true},"readTokenID":{"type":"string","description":"The read-only token ID","readOnly":true}}},"otb.service.operationModeEnum":{"type":"string","description":"Operation mode of the service","enum":["overthebox","overthebox-legacy","wireguard"]},"otb.service.statusEnum":{"type":"string","description":"Status of the service","enum":["active","creating","deleted","suspended","toCreate","toDelete"]},"otb.service.tunnelModeEnum":{"type":"string","description":"Tunnel mode of the service","enum":["glorytun","glorytun_hybrid","glorytun_mud","wireguard"]},"otb.serviceWithIAM":{"type":"object","description":"Service details","properties":{"SOCKSProxyEnabled":{"type":"boolean","description":"Service socks proxy status","readOnly":true},"autoMTU":{"allOf":[{"$ref":"#/components/schemas/otb.service.activationStatusEnum"}],"description":"Service auto MTU status","readOnly":true},"autoUpgrade":{"type":"boolean","description":"Service auto upgrade status","readOnly":true},"bandwidth":{"type":"integer","description":"Service bandwith in bits","readOnly":true},"configurationMode":{"allOf":[{"$ref":"#/components/schemas/otb.service.configurationModeEnum"}],"description":"Service description","readOnly":true},"customerDescription":{"type":"string","description":"Service description","nullable":true,"readOnly":true},"graphEndpoint":{"allOf":[{"$ref":"#/components/schemas/otb.service.graphEndpoint"}],"description":"Service metrics endpoint","nullable":true,"readOnly":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"ipv6Enabled":{"type":"boolean","description":"Service IPv6 status","readOnly":true},"offer":{"type":"string","description":"Service offer","readOnly":true},"operationMode":{"allOf":[{"$ref":"#/components/schemas/otb.service.operationModeEnum"}],"description":"Service operation mode options","readOnly":true},"prettyOfferName":{"type":"string","description":"Service pretty offer name","readOnly":true},"releaseChannel":{"type":"string","description":"Service release channel","readOnly":true},"serviceName":{"type":"string","description":"Service name","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/otb.service.statusEnum"}],"description":"Service status","readOnly":true},"tunnelMode":{"allOf":[{"$ref":"#/components/schemas/otb.service.tunnelModeEnum"}],"description":"Service tunnel mode options","readOnly":true}}},"overTheBox.AvailableStatusEnum":{"type":"string","description":"Status of the service","enum":["disabled","enabled"]},"overTheBox.GraphEndpoint":{"type":"object","description":"Parameters required to query metrics from OpenTSDB","properties":{"host":{"type":"string","description":"The OpenTSDB host"},"readToken":{"type":"string","description":"A read-only token"},"readTokenID":{"type":"string","description":"The read-only token ID"}}},"overTheBox.OperationModeEnum":{"type":"string","description":"Operation mode of the service.","enum":["overthebox","overthebox-legacy","wireguard"]},"overTheBox.Service":{"type":"object","description":"Service","properties":{"SOCKSProxyEnabled":{"type":"boolean","description":"If the socks proxy is enabled","readOnly":true},"autoMTU":{"allOf":[{"$ref":"#/components/schemas/overTheBox.AvailableStatusEnum"}],"description":"The status of the autoMTU","readOnly":true},"autoUpgrade":{"type":"boolean","description":"Enable device auto upgrade"},"bandwidth":{"type":"integer","description":"The service maximum bandwidth in bits","readOnly":true},"configurationMode":{"allOf":[{"$ref":"#/components/schemas/overTheBox.ServiceConfigurationModeEnum"}],"description":"Configuration mode of the service","readOnly":true},"customerDescription":{"type":"string","description":"Editable field for customer","nullable":true},"graphEndpoint":{"allOf":[{"$ref":"#/components/schemas/overTheBox.GraphEndpoint"}],"description":"Parameters needed to fetch metrics","nullable":true,"readOnly":true},"ipv6Enabled":{"type":"boolean","description":"Indicates if IPv6 is enabled","readOnly":true},"offer":{"type":"string","description":"The service offer","readOnly":true},"operationMode":{"allOf":[{"$ref":"#/components/schemas/overTheBox.OperationModeEnum"}],"description":"Operation mode of the service","readOnly":true},"prettyOfferName":{"type":"string","description":"The service pretty offer name","readOnly":true},"releaseChannel":{"type":"string","description":"Release channel of the service"},"serviceName":{"type":"string","description":"The name of the service","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/overTheBox.ServiceStatusEnum"}],"description":"The status of the service","readOnly":true},"tunnelMode":{"allOf":[{"$ref":"#/components/schemas/overTheBox.TunnelModeEnum"}],"description":"The tunnel mode of the service","readOnly":true}}},"overTheBox.ServiceConfigurationModeEnum":{"type":"string","description":"Configuration mode of the service","enum":["autoconfigure","local"]},"overTheBox.ServiceStatusEnum":{"type":"string","description":"Status of the service.","enum":["active","creating","deleted","suspended","toCreate","toDelete"]},"overTheBox.ServiceWithIAM":{"type":"object","description":"Service","properties":{"SOCKSProxyEnabled":{"type":"boolean","description":"If the socks proxy is enabled","readOnly":true},"autoMTU":{"allOf":[{"$ref":"#/components/schemas/overTheBox.AvailableStatusEnum"}],"description":"The status of the autoMTU","readOnly":true},"autoUpgrade":{"type":"boolean","description":"Enable device auto upgrade"},"bandwidth":{"type":"integer","description":"The service maximum bandwidth in bits","readOnly":true},"configurationMode":{"allOf":[{"$ref":"#/components/schemas/overTheBox.ServiceConfigurationModeEnum"}],"description":"Configuration mode of the service","readOnly":true},"customerDescription":{"type":"string","description":"Editable field for customer","nullable":true},"graphEndpoint":{"allOf":[{"$ref":"#/components/schemas/overTheBox.GraphEndpoint"}],"description":"Parameters needed to fetch metrics","nullable":true,"readOnly":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"ipv6Enabled":{"type":"boolean","description":"Indicates if IPv6 is enabled","readOnly":true},"offer":{"type":"string","description":"The service offer","readOnly":true},"operationMode":{"allOf":[{"$ref":"#/components/schemas/overTheBox.OperationModeEnum"}],"description":"Operation mode of the service","readOnly":true},"prettyOfferName":{"type":"string","description":"The service pretty offer name","readOnly":true},"releaseChannel":{"type":"string","description":"Release channel of the service"},"serviceName":{"type":"string","description":"The name of the service","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/overTheBox.ServiceStatusEnum"}],"description":"The status of the service","readOnly":true},"tunnelMode":{"allOf":[{"$ref":"#/components/schemas/overTheBox.TunnelModeEnum"}],"description":"The tunnel mode of the service","readOnly":true}}},"overTheBox.TunnelModeEnum":{"type":"string","description":"Tunnel mode of the service.","enum":["glorytun","glorytun_hybrid","glorytun_mud","wireguard"]},"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":{"/overTheBox":{"get":{"summary":"List OverTheBox services","description":"Returns the names of the OverTheBox services of the account. Each name is the serviceName used by the other OverTheBox calls.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","OverTheBox","Service@@@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(\"/overTheBox\")\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(\"/overTheBox\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"overTheBox:apiovh:get","required":true}],"x-expanded-response":"OtbServiceWithIAM"}},"/overTheBox/{serviceName}":{"delete":{"summary":"Resiliate an OverTheBox service","description":"Resiliate an OverTheBox service. Requests the resiliation of the service. Cancel it with cancelResiliation while it is not effective.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your overTheBox offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","OverTheBox","Service@@@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(\"/overTheBox/{serviceName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/overTheBox/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"overTheBox:apiovh:delete","required":true}]},"get":{"summary":"Get an OverTheBox service","description":"Returns the service status, offer and bandwidth, its operation, tunnel and configuration modes, release channel, IPv6, autoMTU and auto upgrade settings, and the endpoint to query its metrics.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/otb.serviceWithIAM"}}}}},"x-developer-hub-navigation":[["Web Cloud","OverTheBox","Service@@@20"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/overTheBox/{serviceName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/overTheBox/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"overTheBox:apiovh:get","required":true}]},"put":{"summary":"Update an OverTheBox service","description":"Update an OverTheBox service. Changes the settings that can be modified: the customer description, the release channel and the device auto upgrade.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your overTheBox offer","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/overTheBox.Service"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","OverTheBox","Service@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: overTheBox.Service\nresult = client.put(\"/overTheBox/{serviceName}\",\n\tautoUpgrade = None, # Enable device auto upgrade (type: boolean)\n\tcustomerDescription = None, # Editable field for customer (type: string, nullable)\n\treleaseChannel = None, # Release channel of the service (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: overTheBox.Service\n$result = $ovh->put(\"/overTheBox/{serviceName}\", array(\n\tautoUpgrade => null, // Enable device auto upgrade (type: boolean)\n\tcustomerDescription => null, // Editable field for customer (type: string, nullable)\n\treleaseChannel => null, // Release channel of the service (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"overTheBox:apiovh:put","required":true}]}},"/overTheBox/{serviceName}/autoMTU":{"put":{"summary":"Update the autoMTU of an OverTheBox service","description":"Update the autoMTU of an OverTheBox service. Enables or disables the automatic detection of the MTU on the service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your overTheBox offer","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mtuAuto":{"description":"Enable or disable autoMTU","$ref":"#/components/schemas/overTheBox.AvailableStatusEnum"}},"required":["mtuAuto"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","OverTheBox","Service"]],"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: overTheBox.AvailableStatusEnum\nresult = client.put(\"/overTheBox/{serviceName}/autoMTU\",\n\tmtuAuto = None, # Enable or disable autoMTU (type: overTheBox.AvailableStatusEnum)\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: overTheBox.AvailableStatusEnum\n$result = $ovh->put(\"/overTheBox/{serviceName}/autoMTU\", array(\n\tmtuAuto => null, // Enable or disable autoMTU (type: overTheBox.AvailableStatusEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"overTheBox:apiovh:autoMTU/edit","required":true}]}},"/overTheBox/{serviceName}/linkDevice":{"post":{"summary":"Link a device to an OverTheBox service","description":"Link a device to an OverTheBox service. Associates the device, identified by its ID, with the service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your overTheBox offer","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"deviceId":{"type":"string","description":"The id of the device"}},"required":["deviceId"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","OverTheBox","Service"]],"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(\"/overTheBox/{serviceName}/linkDevice\",\n\tdeviceId = None, # The id of the device (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(\"/overTheBox/{serviceName}/linkDevice\", array(\n\tdeviceId => null, // The id of the device (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"overTheBox:apiovh:linkDevice","required":true}]}},"/overTheBox/{serviceName}/linkHardware":{"post":{"summary":"Link a hardware to an OverTheBox service","description":"Link a hardware to an OverTheBox service. Associates one of the available hardware of the account, identified by its name, with the service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your overTheBox offer","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hardwareName":{"type":"string","description":"The internal name of your hardware"}},"required":["hardwareName"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","OverTheBox","Service"]],"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(\"/overTheBox/{serviceName}/linkHardware\",\n\thardwareName = None, # The internal name of your hardware (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(\"/overTheBox/{serviceName}/linkHardware\", array(\n\thardwareName => null, // The internal name of your hardware (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"overTheBox:apiovh:linkHardware","required":true}]}}}}