{"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"},"ovhcloudconnect.Diagnostic":{"type":"object","description":"OVHcloud Connect Diagnostic","properties":{"date":{"type":"string","description":"Date of the diagnostic","nullable":true,"format":"date-time","readOnly":true},"description":{"type":"string","description":"Description of the diagnostic","nullable":true,"readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/ovhcloudconnect.diagnostic.FunctionEnum"}],"description":"Diagnostic function","readOnly":true},"id":{"type":"integer","description":"Diagnostic id","readOnly":true},"result":{"type":"array","description":"Diagnostic result","nullable":true,"items":{"$ref":"#/components/schemas/ovhcloudconnect.DiagnosticResult"},"readOnly":true},"source":{"type":"string","description":"Source where the diagnostic was run","nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/ovhcloudconnect.task.StatusEnum"}],"description":"Diagnostic status","readOnly":true}}},"ovhcloudconnect.DiagnosticConfiguration":{"type":"object","description":"OVHcloud Connect Service Diagnostic Configuration","properties":{"dcConfigId":{"type":"integer","description":"ID of the Datacenter configuration"},"diagnosticName":{"allOf":[{"$ref":"#/components/schemas/ovhcloudconnect.diagnostic.FunctionEnum"}],"description":"Name of the diagnostic"},"diagnosticType":{"allOf":[{"$ref":"#/components/schemas/ovhcloudconnect.diagnostic.TypeEnum"}],"description":"Type of the diagnostic"},"edgeId":{"type":"integer","description":"ID of the service Edge"},"extraConfigId":{"type":"integer","description":"ID of the extra configuration"},"popConfigId":{"type":"integer","description":"ID of the Pop Configuration"}},"required":["diagnosticName"]},"ovhcloudconnect.DiagnosticResult":{"type":"object","description":"OVHcloud Connect Diagnostic Result","properties":{"aspath":{"type":"string","description":"As-path for routes","nullable":true,"readOnly":true},"cmd":{"type":"string","description":"Command sent to equipment","nullable":true,"readOnly":true},"localprefix":{"type":"integer","description":"Local prefix used for routes","nullable":true,"readOnly":true},"mac":{"allOf":[{"$ref":"#/components/schemas/macAddress"}],"description":"Mac address","nullable":true,"readOnly":true},"med":{"type":"integer","description":"BGP Med (Metric)","nullable":true,"readOnly":true},"output":{"type":"string","description":"Output of command sent to equipment","nullable":true,"readOnly":true},"prefix":{"allOf":[{"$ref":"#/components/schemas/ipBlock"}],"description":"Prefix for routes","nullable":true,"readOnly":true},"routermac":{"type":"string","description":"eVPN router mac","nullable":true,"readOnly":true},"timestamp":{"type":"string","description":"Local date when route/mac was declared","nullable":true,"format":"date-time","readOnly":true}}},"ovhcloudconnect.diagnostic.FunctionEnum":{"type":"string","description":"Enum values for Diagnostic function","enum":["diagAccessEdge","diagMacs","diagPeering","diagPeeringExtra","diagRoutes"]},"ovhcloudconnect.diagnostic.TypeEnum":{"type":"string","description":"Enum values for Diagnostic type","enum":["advertised-routes","default","routes"]},"ovhcloudconnect.task.StatusEnum":{"type":"string","description":"Enum values for Task status","enum":["denied","doing","done","error","pause","todo"]},"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":{"/ovhCloudConnect/{serviceName}/diagnostic":{"get":{"summary":"List diagnostics","description":"Returns the IDs of the diagnostics run on the service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Network","OVHcloud Connect","Diagnostics@@@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(\"/ovhCloudConnect/{serviceName}/diagnostic\")\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(\"/ovhCloudConnect/{serviceName}/diagnostic\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ovhCloudConnect:apiovh:diagnostic/get","required":true}],"x-expanded-response":"OvhcloudconnectDiagnostic"},"post":{"summary":"Run diagnostic","description":"Checks BGP peering, routes or MAC addresses on a configuration; runs per 24 h are capped.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ovhcloudconnect.DiagnosticConfiguration"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ovhcloudconnect.Diagnostic"}}}}},"x-developer-hub-navigation":[["Network","OVHcloud Connect","Diagnostics@@@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: ovhcloudconnect.DiagnosticConfiguration\nresult = client.post(\"/ovhCloudConnect/{serviceName}/diagnostic\",\n\tdcConfigId = None, # ID of the Datacenter configuration (type: integer)\n\tdiagnosticName = None, # Name of the diagnostic (type: ovhcloudconnect.diagnostic.FunctionEnum)\n\tdiagnosticType = None, # Type of the diagnostic (type: ovhcloudconnect.diagnostic.TypeEnum)\n\tedgeId = None, # ID of the service Edge (type: integer)\n\textraConfigId = None, # ID of the extra configuration (type: integer)\n\tpopConfigId = None, # ID of the Pop Configuration (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: ovhcloudconnect.DiagnosticConfiguration\n$result = $ovh->post(\"/ovhCloudConnect/{serviceName}/diagnostic\", array(\n\tdcConfigId => null, // ID of the Datacenter configuration (type: integer)\n\tdiagnosticName => null, // Name of the diagnostic (type: ovhcloudconnect.diagnostic.FunctionEnum)\n\tdiagnosticType => null, // Type of the diagnostic (type: ovhcloudconnect.diagnostic.TypeEnum)\n\tedgeId => null, // ID of the service Edge (type: integer)\n\textraConfigId => null, // ID of the extra configuration (type: integer)\n\tpopConfigId => null, // ID of the Pop Configuration (type: integer)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ovhCloudConnect:apiovh:diagnostic/create","required":true}]}},"/ovhCloudConnect/{serviceName}/diagnostic/{id}":{"get":{"summary":"Get diagnostic","description":"Returns the diagnostic status and the equipment output (BGP state, routes or MACs).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ovhcloudconnect.Diagnostic"}}}}},"x-developer-hub-navigation":[["Network","OVHcloud Connect","Diagnostics@@@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(\"/ovhCloudConnect/{serviceName}/diagnostic/{id}\")\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(\"/ovhCloudConnect/{serviceName}/diagnostic/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ovhCloudConnect:apiovh:diagnostic/get","required":true}],"x-response-identifier":"id"}}}}