{"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"},"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"},"xdsl.AsyncTaskStatusEnum":{"type":"string","description":"AsyncTask status","enum":["error","ok","pending"]},"xdsl.AsyncTask_xdsl.ModemInfo":{"type":"object","description":"xdsl.AsyncTask_xdsl.ModemInfo","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"result":{"allOf":[{"$ref":"#/components/schemas/xdsl.ModemInfo"}],"description":"Describe general information of a Modem","nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.AsyncTaskStatusEnum"}],"description":"AsyncTask status","readOnly":true}}},"xdsl.DeviceModemInfo":{"type":"object","description":"Describe device information of a Modem","properties":{"brand":{"type":"string","description":"Modem brand","readOnly":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"IPv4 address (e.g., 192.0.2.0)","readOnly":true},"lastUpdate":{"type":"string","description":"Time of last information refresh","format":"date-time","readOnly":true},"macAddress":{"type":"string","description":"Modem mac address","readOnly":true},"model":{"type":"string","description":"Modem type of model","readOnly":true},"oui":{"type":"string","description":"Organizational Unique Identifier","readOnly":true},"overEthernet":{"type":"string","description":"Protocol used for connection","nullable":true,"readOnly":true},"pppLogin":{"type":"string","description":"login used for ppp protocol","nullable":true,"readOnly":true},"serial":{"type":"string","description":"Modem serial key","readOnly":true},"softVersion":{"type":"string","description":"Software Version","readOnly":true}}},"xdsl.ModemInfo":{"type":"object","description":"Describe general information of a Modem","properties":{"device":{"allOf":[{"$ref":"#/components/schemas/xdsl.DeviceModemInfo"}],"description":"Describe device information of a Modem","readOnly":true},"statistics":{"allOf":[{"$ref":"#/components/schemas/xdsl.StatsModemInfo"}],"description":"Describe statistics information of a Modem","readOnly":true}}},"xdsl.StatsModemInfo":{"type":"object","description":"Describe statistics information of a Modem","properties":{"connectionUptime":{"type":"integer","description":"Connection uptime","readOnly":true},"crcError":{"type":"integer","description":"Amount of CRC error detected","readOnly":true},"deviceUptime":{"type":"integer","description":"Modem uptime","readOnly":true},"downstreamAttenuation":{"type":"number","description":"Downstream attenuation","readOnly":true},"downstreamMargin":{"type":"number","description":"Downstream margin","readOnly":true},"downstreamSync":{"type":"number","description":"Downstream synchronization","readOnly":true},"fecError":{"type":"integer","description":"Amount of FEC error detected","readOnly":true},"hecError":{"type":"integer","description":"Amount of HEC error detected","readOnly":true},"lastUpdate":{"type":"string","description":"Time of last refresh","format":"date-time","readOnly":true},"modulation":{"type":"string","description":"Line modulation used","readOnly":true},"quarterHourStart":{"type":"integer","description":"Count from last refresh in seconds","readOnly":true},"syncUptime":{"type":"integer","description":"Synchronization uptime","readOnly":true},"upstreamAttenuation":{"type":"number","description":"Upstream attenuation","readOnly":true},"upstreamMargin":{"type":"number","description":"Upstream margin","readOnly":true},"upstreamSync":{"type":"number","description":"Upstream synchronization","readOnly":true}}},"xdsl.Task":{"type":"object","description":"Describes the current status of a task","properties":{"doneDate":{"type":"string","description":"Date when the action was completed","nullable":true,"format":"date-time","readOnly":true},"function":{"type":"string","readOnly":true},"id":{"type":"integer","readOnly":true},"isArchived":{"type":"boolean","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.TaskStatusEnum"}],"readOnly":true},"todoDate":{"type":"string","description":"Date when the action will start","format":"date-time","readOnly":true},"updateDate":{"type":"string","format":"date-time","readOnly":true}}},"xdsl.TaskStatusEnum":{"type":"string","description":"Status of a task.","enum":["cancelled","doing","done","error","problem","todo"]},"xdsl.modem.reboot.post":{"type":"object","description":"xdsl.modem.reboot.post","properties":{"todoDate":{"type":"string","description":"Date when the reboot will start","format":"date-time"}}},"xdsl.modem.reset.post":{"type":"object","description":"xdsl.modem.reset.post","properties":{"resetOvhConfig":{"type":"boolean","description":"Reset configuration stored in OVH databases"}}}},"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":{"/xdsl/{serviceName}/modem/reboot":{"post":{"operationId":"rebootModem","summary":"Reboot the modem","description":"Reboots the modem of the access, now or at the given date. Returns the task that performs the change.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.modem.reboot.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Modem","Actions@@@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\n# Request body type: xdsl.modem.reboot.post\nresult = client.post(\"/xdsl/{serviceName}/modem/reboot\",\n\ttodoDate = None, # Date when the reboot will start (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: xdsl.modem.reboot.post\n$result = $ovh->post(\"/xdsl/{serviceName}/modem/reboot\", array(\n\ttodoDate => null, // Date when the reboot will start (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:modem/reboot","required":true}]}},"/xdsl/{serviceName}/modem/reconfigureVoip":{"post":{"summary":"Reconfigure the VoIP line of the modem","description":"Pushes the VoIP line configuration again to the modem of the access.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Modem","Actions@@@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.post(\"/xdsl/{serviceName}/modem/reconfigureVoip\")\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(\"/xdsl/{serviceName}/modem/reconfigureVoip\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:modem/reconfigureVoip","required":true}]}},"/xdsl/{serviceName}/modem/refreshConnectedDevices":{"post":{"summary":"Refresh the devices connected to the modem","description":"Reads again from the modem of the access the devices connected to it. Returns the task that performs the change.","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/xdsl.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Modem","Actions@@@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(\"/xdsl/{serviceName}/modem/refreshConnectedDevices\")\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(\"/xdsl/{serviceName}/modem/refreshConnectedDevices\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:modem/refreshConnectedDevices","required":true}]}},"/xdsl/{serviceName}/modem/reset":{"post":{"operationId":"resetModemConfiguration","summary":"Reset the modem","description":"Resets the modem of the access to its default configuration, and optionally the configuration stored by OVHcloud. Returns the task that performs the change.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.modem.reset.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Modem","Actions@@@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: xdsl.modem.reset.post\nresult = client.post(\"/xdsl/{serviceName}/modem/reset\",\n\tresetOvhConfig = None, # Reset configuration stored in OVH databases (type: boolean)\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: xdsl.modem.reset.post\n$result = $ovh->post(\"/xdsl/{serviceName}/modem/reset\", array(\n\tresetOvhConfig => null, // Reset configuration stored in OVH databases (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:modem/reset","required":true}]}},"/xdsl/{serviceName}/modem/retrieveInfo":{"post":{"summary":"Retrieve the modem information","description":"Reads the general information of the modem of the access. Returns an asynchronous task holding the modem information.","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/xdsl.AsyncTask_xdsl.ModemInfo"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Modem","Actions@@@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.post(\"/xdsl/{serviceName}/modem/retrieveInfo\")\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(\"/xdsl/{serviceName}/modem/retrieveInfo\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:modem/retrieveInfo","required":true}]}}}}