{"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 !"},"complexType.UnitAndValues_xdsl.TimestampAndValue":{"type":"object","description":"complexType.UnitAndValues_xdsl.TimestampAndValue","properties":{"unit":{"type":"string","readOnly":true},"values":{"type":"array","items":{"$ref":"#/components/schemas/xdsl.TimestampAndValue"},"readOnly":true}}},"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.DeconsolidationEnum":{"type":"string","description":"Deconsolidation of the line.","enum":["createNeighbour","creation","creationNeighbour","partial","total"]},"xdsl.DslTypeEnum":{"type":"string","description":"Possible copper or fiber technologies","enum":["adsl","ftte","ftth","ftto","sdsl","vdsl"]},"xdsl.DslamLineProfile":{"type":"object","description":"Profile on the DSLAM","properties":{"id":{"type":"integer","readOnly":true},"isCurrent":{"type":"boolean","readOnly":true},"name":{"type":"string","readOnly":true}}},"xdsl.DslamPort":{"type":"object","description":"Information about the port on the DSLAM","properties":{"lastDesyncDate":{"type":"string","description":"Last time the port lost the synchronization","nullable":true,"format":"date-time","readOnly":true},"lastSyncDate":{"type":"string","description":"Last time the port synchronized","nullable":true,"format":"date-time","readOnly":true},"profile":{"allOf":[{"$ref":"#/components/schemas/xdsl.DslamLineProfile"}],"nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.DslamPortStatusEnum"}],"readOnly":true}}},"xdsl.DslamPortLog":{"type":"object","description":"A message log from the DSLAM","properties":{"date":{"type":"string","format":"date-time","readOnly":true},"lastOccurrenceDate":{"type":"string","description":"The last time this message occured","format":"date-time","readOnly":true},"message":{"type":"string","readOnly":true},"numberOfOccurrences":{"type":"integer","description":"The number of times this message occured between date and lastOccurrenceDate","readOnly":true}}},"xdsl.DslamPortStatusEnum":{"type":"string","description":"Different states of a DSLAM port","enum":["activated","deactivated","outofsync"]},"xdsl.FaultRepairTimeEnum":{"type":"string","description":"Maximum time needed to repair a landline","enum":["10HO","4HNO","4HO","DPLUS1","NORMAL"]},"xdsl.LandlineConcentrationPoint":{"type":"object","description":"Infos about a Landline at the concentration point","properties":{"lineHead":{"type":"string","description":"Identifier of the head of the cable from the MDF","readOnly":true},"lineInitialSection":{"type":"integer","description":"Identifier of the section at the lineHead","readOnly":true},"lineInitialSectionPair":{"type":"integer","description":"Identifier of the pair at the lineHead's lineInitialSection","readOnly":true}}},"xdsl.Line":{"type":"object","description":"Information about the physical copper line","properties":{"concentrationPoint":{"allOf":[{"$ref":"#/components/schemas/xdsl.LandlineConcentrationPoint"}],"description":"Data to identify the line at the concentration point","nullable":true,"readOnly":true},"deconsolidation":{"allOf":[{"$ref":"#/components/schemas/xdsl.DeconsolidationEnum"}],"readOnly":true},"directDistribution":{"type":"boolean","description":"True if the line is directly wired on the DSLAM","nullable":true,"readOnly":true},"distance":{"type":"integer","description":"Distance in meters from the DSLAM","readOnly":true},"faultRepairTime":{"allOf":[{"$ref":"#/components/schemas/xdsl.FaultRepairTimeEnum"}],"readOnly":true},"lineSectionsLength":{"type":"array","description":"Detailed information about the sections between the DSLAM and the telephone jack","items":{"$ref":"#/components/schemas/xdsl.LineSectionLength"},"readOnly":true},"mitigation":{"type":"number","description":"Mitigation of the line in dB","readOnly":true},"number":{"type":"string","description":"The number of the line","readOnly":true},"originalNumber":{"type":"string","description":"The number used to place the order. Null if the same as the current number.","nullable":true,"readOnly":true},"portability":{"type":"boolean","description":"Whether the line number has been ported to OVH, to be used with VoIP service","readOnly":true},"syncDown":{"type":"number","description":"The download synchronisation on the DSLAM in Kbps","nullable":true,"readOnly":true},"syncUp":{"type":"number","description":"The upload synchronisation on the DSLAM in Kbps","nullable":true,"readOnly":true}}},"xdsl.LineSectionLength":{"type":"object","description":"xdsl.LineSectionLength","properties":{"diameter":{"type":"integer","description":"The diameter of this section in millimeters","readOnly":true},"length":{"type":"integer","description":"The length of this section in meters","readOnly":true}}},"xdsl.LineStatisticsTypeEnum":{"type":"string","description":"Various types of statisctics available for the line.","enum":["attenuation:download","attenuation:upload","error:crc","error:fec","error:hec","snr:download","snr:upload","synchronization:download","synchronization:upload"]},"xdsl.ProviderEnum":{"type":"string","description":"The providers","enum":["axione","bouygues","ft","ftBySfr","kosc","koscDeg","ovh","sfr"]},"xdsl.StatisticsPeriodEnum":{"type":"string","description":"Periods for statistics.","enum":["daily","monthly","preview","weekly","yearly"]},"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.TimestampAndValue":{"type":"object","description":"A value associated to a timestamp","properties":{"timestamp":{"type":"integer","readOnly":true},"value":{"type":"number","nullable":true,"readOnly":true}}},"xdsl.lineDiagnostic.Answers":{"type":"object","description":"Customer answers for line diagnostic","properties":{"bandwidthTestUnit":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.BandwidthTestUnitEnum"}],"description":"bandwidth unit for proof.ovh.net test values","nullable":true,"readOnly":true},"comment":{"type":"string","description":"comment will contains all information needed for intervention and about your access problem","nullable":true,"readOnly":true},"conditionsAccepted":{"type":"boolean","description":"customer knows that he can be charged (150 euros HT) if he is responsible for the problem or if tests have not been done correctly ?","nullable":true,"readOnly":true},"contactPhone":{"type":"string","description":"customer's phone number","nullable":true,"readOnly":true},"datetimeOfAppearance":{"type":"string","description":"approximative datetime of problem happening","nullable":true,"format":"date-time","readOnly":true},"downloadBandwidthTest":{"type":"integer","description":"bandwidth download value on proof.ovh.net test","nullable":true,"readOnly":true},"endAfternoonHours":{"type":"string","description":"afternoon closing information or time for the site","nullable":true,"readOnly":true},"endMorningHours":{"type":"string","description":"morning closing information or time for the site","nullable":true,"readOnly":true},"followBySms":{"type":"boolean","description":"indicate if customer wants to be informed by sms","nullable":true,"readOnly":true},"hasModemKeptSynchronization":{"type":"boolean","description":"Has modem kept his synchronization during line port reset ?","nullable":true,"readOnly":true},"idAppointment":{"type":"integer","description":"id of appointment chosen (\"possibleValues\" contains choices list with id)","nullable":true,"readOnly":true},"individualSite":{"type":"boolean","description":"is non-professional site ?","nullable":true,"readOnly":true},"modemIsSynchronized":{"type":"boolean","description":"Is modem synchronized ? (whatever internet connection)","nullable":true,"readOnly":true},"modemMac":{"type":"string","description":"modem mac address","nullable":true,"readOnly":true},"modemStillSynchronized":{"type":"boolean","description":"Modem still synchronized ? Please check once again.","nullable":true,"readOnly":true},"modemType":{"type":"string","description":"modem brand and reference","nullable":true,"readOnly":true},"ovhTicket":{"type":"string","description":"Ovh ticket name or ticket ID, only if a ticket is already opened for this problem","nullable":true,"readOnly":true},"problemType":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.ProblemTypeEnum"}],"description":"Problem Type on DSL connection","nullable":true,"readOnly":true},"resolvedAfterTests":{"type":"boolean","description":"is access problem solved ?","nullable":true,"readOnly":true},"secureSite":{"type":"boolean","description":"is secure site ?","nullable":true,"readOnly":true},"severalInternetConnections":{"type":"boolean","description":"Has customer several internal connections ? (on the same place)","nullable":true,"readOnly":true},"siteClosedDays":{"type":"string","description":"days or period where site access is not possible","nullable":true,"readOnly":true},"siteDigicode":{"type":"string","description":"digicode for site entrance","nullable":true,"readOnly":true},"siteOpening":{"type":"string","description":"site opening hours or information","nullable":true,"readOnly":true},"startAfternoonHours":{"type":"string","description":"afternoon opening information or time for the site","nullable":true,"readOnly":true},"startMorningHours":{"type":"string","description":"morning opening information or time for the site","nullable":true,"readOnly":true},"uploadBandwidthTest":{"type":"integer","description":"bandwidth upload value on proof.ovh.net test","nullable":true,"readOnly":true}}},"xdsl.lineDiagnostic.BandwidthTestUnitEnum":{"type":"string","description":"bandwidth unit for proof.ovh.net test values","enum":["Kbps","Mbps"]},"xdsl.lineDiagnostic.ConnectionInformations":{"type":"object","description":"Informations directly get on DSLAM or Modem","properties":{"crcError":{"type":"integer","description":"Amount of CRC error detected","nullable":true,"readOnly":true},"downstreamAttenuation":{"type":"number","description":"Downstream attenuation","nullable":true,"readOnly":true},"downstreamMargin":{"type":"number","description":"Downstream margin","nullable":true,"readOnly":true},"downstreamSync":{"type":"number","description":"Downstream synchronization","nullable":true,"readOnly":true},"ifName":{"type":"string","description":"Modem interface name","nullable":true,"readOnly":true},"profile":{"type":"string","description":"Profile on the DSLAM","nullable":true,"readOnly":true},"upstreamAttenuation":{"type":"number","description":"Upstream attenuation","nullable":true,"readOnly":true},"upstreamMargin":{"type":"number","description":"Upstream margin","nullable":true,"readOnly":true},"upstreamSync":{"type":"number","description":"Upstream synchronization","nullable":true,"readOnly":true}}},"xdsl.lineDiagnostic.CustomerActionToDo":{"type":"object","description":"Customer action to do","properties":{"description":{"type":"string","description":"action's description","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.CustomerActionsEnum"}],"description":"Customer possible actions","readOnly":true}}},"xdsl.lineDiagnostic.CustomerActionsEnum":{"type":"string","description":"Customer possible actions","enum":["bePreparedToCheckModemSynchronization","changeDslFilterAndPlugInDti","changeExtensionCable","changeProfile","checkConnectionCable","checkConnectionLoginAndParameters","checkFilter","connectModemToOtherPlugs","neutralTest","rebootModem","resetModem","unplugEveryModems","unplugModem"]},"xdsl.lineDiagnostic.Diagnostic":{"type":"object","description":"Diagnostic status and information","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.DiagnosticData"}],"description":"Diagnostic data and information","readOnly":true},"faultType":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.FaultTypeEnum"}],"description":"Line diagnostic fault type","readOnly":true},"id":{"type":"integer","description":"Diagnostic id","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.DiagnosticStatusEnum"}],"description":"Diagnostic status possible values","readOnly":true}}},"xdsl.lineDiagnostic.DiagnosticData":{"type":"object","description":"Diagnostic data and information","properties":{"actionsDone":{"type":"array","description":"List of actions already done by customer","items":{"$ref":"#/components/schemas/xdsl.lineDiagnostic.CustomerActionsEnum"},"readOnly":true},"actionsToDo":{"type":"array","description":"List of actions that must be done by customer","items":{"$ref":"#/components/schemas/xdsl.lineDiagnostic.CustomerActionToDo"},"readOnly":true},"answers":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.Answers"}],"description":"Customer answers for line diagnostic","readOnly":true},"comment":{"type":"string","description":"Diagnostic comment. Can be update during any diagnostic step","nullable":true,"readOnly":true},"creationDate":{"type":"string","description":"Diagnostic creation date","format":"date-time","readOnly":true},"diagnosticDoneDate":{"type":"string","description":"End of diagnostic date. Will be null until problem totally identified","nullable":true,"format":"date-time","readOnly":true},"error":{"type":"string","description":"Error message","readOnly":true},"lastUpdate":{"type":"string","description":"Last diagnostic update date","format":"date-time","readOnly":true},"lineDetails":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.LineDetails"}],"description":"Line information","readOnly":true},"robotAction":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.RobotActionsEnum"}],"description":"Current or last robot action","nullable":true,"readOnly":true},"seltTest":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.SeltResult"}],"description":"Customer answers for line diagnostic","readOnly":true},"timeout":{"type":"integer","description":"Diagnostic timeout in minutes. Any action restart timeout","readOnly":true},"toAnswer":{"type":"array","description":"List of questions that must be answered by customer","items":{"$ref":"#/components/schemas/xdsl.lineDiagnostic.Question"},"readOnly":true}}},"xdsl.lineDiagnostic.DiagnosticStatusEnum":{"type":"string","description":"Diagnostic status possible values","enum":["cancelled","connectionProblem","genericIncidentPending","haveToConnectModemOnTheRightPlug","init","interventionRequested","noBandwidthFault","noProblemAnymore","noSyncFaultDiagnosticRequired","problem","resolvedAfterTests","sleeping","validationRefused","waitingHuman","waitingRobot","waitingValidation"]},"xdsl.lineDiagnostic.FaultTypeEnum":{"type":"string","description":"Line diagnostic fault type","enum":["alignment","noSync","syncLossOrLowBandwidth","unknown"]},"xdsl.lineDiagnostic.LineCapabilities":{"type":"object","description":"Theoretical line capabilities","properties":{"down":{"type":"number","description":"Theoretical Downstream synchronization ","nullable":true,"readOnly":true},"mitigation":{"type":"string","description":"Theoretical line mitigation","nullable":true,"readOnly":true},"ping":{"type":"number","description":"Theoretical ping","nullable":true,"readOnly":true},"up":{"type":"number","description":"Theoretical Upstream synchronization ","nullable":true,"readOnly":true}}},"xdsl.lineDiagnostic.LineDetails":{"type":"object","description":"Line information","properties":{"accessName":{"type":"string","description":"access name","readOnly":true},"accessPing":{"type":"boolean","description":"Access IP ping or not","nullable":true,"readOnly":true},"address":{"type":"string","description":"address of the access","nullable":true,"readOnly":true},"connectionInfo":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.ConnectionInformations"}],"description":"information directly get on DSLAM or Modem","nullable":true,"readOnly":true},"contactPhone":{"type":"string","description":"customer phone number for contact","nullable":true,"readOnly":true},"description":{"type":"string","description":"custom access description","nullable":true,"readOnly":true},"dslamIsSynchronized":{"type":"boolean","description":"DSLAM is synchronized or not","nullable":true,"readOnly":true},"gtr":{"type":"boolean","description":"is GTR access or not","readOnly":true},"length":{"type":"integer","description":"Line length in meters","readOnly":true},"lineCapabilities":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.LineCapabilities"}],"description":"Theoretical line capabilities","nullable":true,"readOnly":true},"lineType":{"allOf":[{"$ref":"#/components/schemas/xdsl.DslTypeEnum"}],"description":"Possible DSL technologies","readOnly":true},"nra":{"type":"string","description":"NRA name","nullable":true,"readOnly":true},"number":{"type":"string","description":"line number","readOnly":true},"operator":{"allOf":[{"$ref":"#/components/schemas/xdsl.ProviderEnum"}],"description":"The providers","readOnly":true},"sections":{"type":"array","description":"cables sections details","nullable":true,"items":{"$ref":"#/components/schemas/xdsl.lineDiagnostic.Section"},"readOnly":true}}},"xdsl.lineDiagnostic.PossibleValue":{"type":"object","description":"possible value for specific answer","properties":{"id":{"type":"integer","description":"answer id","nullable":true,"readOnly":true},"label":{"type":"string","description":"answer choice string","nullable":true,"readOnly":true},"value":{"type":"string","description":"answer choice value","nullable":true,"readOnly":true}}},"xdsl.lineDiagnostic.ProblemTypeEnum":{"type":"string","description":"Possible customer questions","enum":["lowBandwidth","syncLoss"]},"xdsl.lineDiagnostic.Question":{"type":"object","description":"Question to customer","properties":{"defaultValue":{"type":"string","description":"question description","nullable":true,"readOnly":true},"description":{"type":"string","description":"question description","readOnly":true},"enumValues":{"type":"array","description":"available values for enum","nullable":true,"items":{"type":"string"},"readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.QuestionsEnum"}],"description":"Possible customer questions","readOnly":true},"possibleValues":{"type":"array","description":"list of possible values","nullable":true,"items":{"$ref":"#/components/schemas/xdsl.lineDiagnostic.PossibleValue"},"readOnly":true},"required":{"type":"boolean","description":"is a required question","nullable":true,"readOnly":true},"type":{"type":"string","description":"answer type","readOnly":true}}},"xdsl.lineDiagnostic.QuestionsEnum":{"type":"string","description":"Possible customer questions","enum":["bandwidthTestUnit","comment","conditionsAccepted","contactPhone","datetimeOfAppearance","downloadBandwidthTest","endAfternoonHours","endMorningHours","followBySms","hasModemKeptSynchronization","idAppointment","individualSite","modemIsSynchronized","modemMac","modemStillSynchronized","modemType","ovhTicket","problemType","resolvedAfterTests","secureSite","severalInternetConnections","siteClosedDays","siteDigicode","siteOpening","startAfternoonHours","startMorningHours","uploadBandwidthTest"]},"xdsl.lineDiagnostic.RobotActionsEnum":{"type":"string","description":"Diagnostic robot possible actions","enum":["alignmentLockTest","alignmentResetTest","alignmentTestResult","checkCustomerTicket","checkIfAccessPing","checkIfResolvedAfterConnectionTests","checkIfResolvedAfterInstallationCheck","checkIfResolvedAfterTests","checkIfSeveralConnections","checkInstallation","checkProblem","checkSynchronizationWithoutOtherModems","customerPrelocChecks","findProblem","installationCheck","lockUnlock","needToRequestMonitoring","needToRequestOperatorIntervention","needToRequestOvhIntervention","requestMonitoring","requestOperatorIntervention","requestOvhIntervention","seltTest"]},"xdsl.lineDiagnostic.Section":{"type":"object","description":"Cables section details","properties":{"length":{"type":"integer","description":"cables length in meters","readOnly":true},"section":{"type":"integer","description":"cables section in millimeters","readOnly":true}}},"xdsl.lineDiagnostic.SeltPrelocEnum":{"type":"string","description":"Possible SELT test prelocalizations","enum":["CUST","DSLAM","LINE","RE"]},"xdsl.lineDiagnostic.SeltResult":{"type":"object","description":"Customer answers for line diagnostic","properties":{"date":{"type":"string","description":"SELT test running date","nullable":true,"format":"date-time","readOnly":true},"distance":{"type":"integer","description":"Distance of the problem identified on the line (by SELT test), from NRA to customer","nullable":true,"readOnly":true},"preloc":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.SeltPrelocEnum"}],"description":"Prelocalization of the problem","nullable":true,"readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.SeltStateEnum"}],"description":"Problem type identified by SELT test","nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.SeltStatusEnum"}],"description":"SELT test status","nullable":true,"readOnly":true}}},"xdsl.lineDiagnostic.SeltStateEnum":{"type":"string","description":"Possible SELT test states","enum":["open","short","synced","unknown"]},"xdsl.lineDiagnostic.SeltStatusEnum":{"type":"string","description":"Possible SELT test status","enum":["failed","notAvailable","ok"]},"xdsl.lines.diagnostic.run.post":{"type":"object","description":"xdsl.lines.diagnostic.run.post","properties":{"actionsDone":{"type":"array","description":"Customer possible actions","items":{"$ref":"#/components/schemas/xdsl.lineDiagnostic.CustomerActionsEnum"}},"answers":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.Answers"}],"description":"Customer answers for line diagnostic"},"faultType":{"allOf":[{"$ref":"#/components/schemas/xdsl.lineDiagnostic.FaultTypeEnum"}],"description":"Line diagnostic fault type"}},"required":["faultType"]},"xdsl.lines.dslamPort.changeProfile.post":{"type":"object","description":"xdsl.lines.dslamPort.changeProfile.post","properties":{"dslamProfileId":{"type":"integer","description":"The id of the xdsl.DslamLineProfile"}},"required":["dslamProfileId"]}},"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}/lines":{"get":{"summary":"List the lines of an xDSL access","description":"Returns the numbers of the copper lines of the access.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Lines@@@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.get(\"/xdsl/{serviceName}/lines\")\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(\"/xdsl/{serviceName}/lines\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:lines/get","required":true}],"x-expanded-response":"XdslLine"}},"/xdsl/{serviceName}/lines/{number}":{"get":{"summary":"Get a line of an xDSL access","description":"Returns the line number, distance and sections to the DSLAM, synchronization rates, mitigation, deconsolidation, portability and fault repair time.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"Number","required":true,"schema":{"type":"string"}},{"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.Line"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Lines@@@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.get(\"/xdsl/{serviceName}/lines/{number}\")\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(\"/xdsl/{serviceName}/lines/{number}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:lines/get","required":true}]}},"/xdsl/{serviceName}/lines/{number}/diagnostic/cancel":{"post":{"summary":"Cancel the diagnostic of a line","description":"Cancels the ongoing advanced diagnostic of the line, when it can still be canceled.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"Number","required":true,"schema":{"type":"string"}},{"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","Lines@@@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.post(\"/xdsl/{serviceName}/lines/{number}/diagnostic/cancel\")\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}/lines/{number}/diagnostic/cancel\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:lines/diagnostic/cancel","required":true}]}},"/xdsl/{serviceName}/lines/{number}/diagnostic/run":{"post":{"operationId":"updateLineDiagnostic","summary":"Run the advanced diagnostic of a line","description":"Starts or continues the advanced diagnostic of the line with the customer answers and actions done. Returns the diagnostic with its status, fault type and data.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"Number","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.lines.diagnostic.run.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.lineDiagnostic.Diagnostic"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Lines@@@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.lines.diagnostic.run.post\nresult = client.post(\"/xdsl/{serviceName}/lines/{number}/diagnostic/run\",\n\tactionsDone = None, # Customer possible actions (type: array)\n\tanswers = None, # Customer answers for line diagnostic (type: xdsl.lineDiagnostic.Answers)\n\tfaultType = None, # Line diagnostic fault type (type: xdsl.lineDiagnostic.FaultTypeEnum)\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.lines.diagnostic.run.post\n$result = $ovh->post(\"/xdsl/{serviceName}/lines/{number}/diagnostic/run\", array(\n\tactionsDone => null, // Customer possible actions (type: array)\n\tanswers => null, // Customer answers for line diagnostic (type: xdsl.lineDiagnostic.Answers)\n\tfaultType => null, // Line diagnostic fault type (type: xdsl.lineDiagnostic.FaultTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:lines/diagnostic/run","required":true}]}},"/xdsl/{serviceName}/lines/{number}/dslamPort":{"get":{"summary":"Get the DSLAM port of a line","description":"Returns the status and profile of the DSLAM port of the line, with its last synchronization and desynchronization dates.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"Number","required":true,"schema":{"type":"string"}},{"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.DslamPort"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Lines@@@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.get(\"/xdsl/{serviceName}/lines/{number}/dslamPort\")\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(\"/xdsl/{serviceName}/lines/{number}/dslamPort\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:lines/dslamPort/get","required":true}]}},"/xdsl/{serviceName}/lines/{number}/dslamPort/availableProfiles":{"get":{"summary":"List the profiles of a DSLAM port","description":"Returns the profiles that can be applied to the DSLAM port of the line, and which one is current.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"Number","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/xdsl.DslamLineProfile"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Lines@@@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.get(\"/xdsl/{serviceName}/lines/{number}/dslamPort/availableProfiles\")\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(\"/xdsl/{serviceName}/lines/{number}/dslamPort/availableProfiles\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:lines/dslamPort/availableProfiles/get","required":true}]}},"/xdsl/{serviceName}/lines/{number}/dslamPort/changeProfile":{"post":{"operationId":"changeLineDSLAMProfile","summary":"Change the profile of a DSLAM port","description":"Applies one of the available profiles to the DSLAM port of the line. Returns the task that performs the change.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"Number","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.lines.dslamPort.changeProfile.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Lines@@@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.lines.dslamPort.changeProfile.post\nresult = client.post(\"/xdsl/{serviceName}/lines/{number}/dslamPort/changeProfile\",\n\tdslamProfileId = None, # The id of the xdsl.DslamLineProfile (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: xdsl.lines.dslamPort.changeProfile.post\n$result = $ovh->post(\"/xdsl/{serviceName}/lines/{number}/dslamPort/changeProfile\", array(\n\tdslamProfileId => null, // The id of the xdsl.DslamLineProfile (type: integer)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:lines/dslamPort/changeProfile","required":true}]}},"/xdsl/{serviceName}/lines/{number}/dslamPort/logs":{"get":{"summary":"List the logs of a DSLAM port","description":"Returns the messages the DSLAM emitted for the port of the line, with their date, last occurrence and number of occurrences.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"limit","required":true,"schema":{"type":"integer"}},{"in":"path","name":"number","description":"Number","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/xdsl.DslamPortLog"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Lines@@@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.get(\"/xdsl/{serviceName}/lines/{number}/dslamPort/logs\")\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(\"/xdsl/{serviceName}/lines/{number}/dslamPort/logs\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:lines/dslamPort/logs/get","required":true}]}},"/xdsl/{serviceName}/lines/{number}/dslamPort/reset":{"post":{"summary":"Reset a DSLAM port","description":"Resets the port of the line on the DSLAM. Returns the task that performs the change.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"Number","required":true,"schema":{"type":"string"}},{"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","Lines@@@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.post(\"/xdsl/{serviceName}/lines/{number}/dslamPort/reset\")\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}/lines/{number}/dslamPort/reset\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:lines/dslamPort/reset","required":true}]}},"/xdsl/{serviceName}/lines/{number}/statistics":{"get":{"summary":"Get the statistics of a line","description":"Returns the values of one line metric (attenuation, SNR, synchronization or CRC, FEC and HEC errors) over a daily, weekly, monthly or yearly period, with their unit.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"Number","required":true,"schema":{"type":"string"}},{"in":"query","name":"period","required":true,"schema":{"$ref":"#/components/schemas/xdsl.StatisticsPeriodEnum"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"query","name":"type","required":true,"schema":{"$ref":"#/components/schemas/xdsl.LineStatisticsTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/complexType.UnitAndValues_xdsl.TimestampAndValue"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Access","Lines@@@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.get(\"/xdsl/{serviceName}/lines/{number}/statistics\")\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(\"/xdsl/{serviceName}/lines/{number}/statistics\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"xdsl:apiovh:lines/statistics/get","required":true}]}}}}