{"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 !"},"connectivity.eligibility.EligibilityRecall":{"type":"object","description":"Eligibility recall","properties":{"completed":{"type":"boolean","description":"Is the recall completed ?","readOnly":true},"completedDate":{"type":"string","description":"Completed date","nullable":true,"format":"date-time","readOnly":true},"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"customer":{"type":"string","description":"customer ID","readOnly":true},"dedicatedfiberRequest":{"type":"boolean","description":"Check for Dedicated Fiber FTTO/FTTE eligibility ?","readOnly":true},"id":{"type":"integer","description":"ID","readOnly":true},"profiberRequest":{"type":"boolean","description":"Check for Pro Fiber FTTH eligibility ?","readOnly":true},"reference":{"type":"string","description":"Reference","readOnly":true},"referenceType":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.ReferenceTypeEnum"}],"description":"Reference type","readOnly":true},"updatedDate":{"type":"string","description":"Updated date","format":"date-time","readOnly":true}}},"connectivity.eligibility.EligibilityRecall.post":{"type":"object","description":"Eligibility recall POST request body","properties":{"dedicatedfiberRequest":{"type":"boolean","description":"Check for Dedicated Fiber FTTO/FTTE eligibility ?"},"profiberRequest":{"type":"boolean","description":"Check for Pro Fiber FTTH eligibility ?"},"reference":{"type":"string","description":"Reference"},"referenceType":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.ReferenceTypeEnum"}],"description":"Reference type"}},"required":["reference","referenceType"]},"connectivity.eligibility.ReferenceTypeEnum":{"type":"string","description":"Reference type","enum":["address","building"]},"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"}},"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":{"/connectivity/eligibility/recall":{"get":{"summary":"List eligibility recalls","description":"Returns the eligibility recalls of the account, with their address or building reference, the requested fiber offers and whether each one is completed.","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/connectivity.eligibility.EligibilityRecall"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Recall@@@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(\"/connectivity/eligibility/recall\")\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(\"/connectivity/eligibility/recall\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:connectivity/eligibility/recall/list","required":true}],"x-response-identifier":"id","x-expanded-response":"ConnectivityEligibilityEligibilityRecall"},"post":{"summary":"Create an eligibility recall","description":"Creates a recall on an address or building reference, to check again its eligibility to Pro Fiber FTTH or Dedicated Fiber FTTO/FTTE. Returns the created recall.","security":[{"oAuth2AuthCode":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.EligibilityRecall.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.EligibilityRecall"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Recall@@@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: connectivity.eligibility.EligibilityRecall.post\nresult = client.post(\"/connectivity/eligibility/recall\",\n\tdedicatedfiberRequest = None, # Check for Dedicated Fiber FTTO/FTTE eligibility ? (type: boolean)\n\tprofiberRequest = None, # Check for Pro Fiber FTTH eligibility ? (type: boolean)\n\treference = None, # Reference (type: string)\n\treferenceType = None, # Reference type (type: connectivity.eligibility.ReferenceTypeEnum)\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: connectivity.eligibility.EligibilityRecall.post\n$result = $ovh->post(\"/connectivity/eligibility/recall\", array(\n\tdedicatedfiberRequest => null, // Check for Dedicated Fiber FTTO/FTTE eligibility ? (type: boolean)\n\tprofiberRequest => null, // Check for Pro Fiber FTTH eligibility ? (type: boolean)\n\treference => null, // Reference (type: string)\n\treferenceType => null, // Reference type (type: connectivity.eligibility.ReferenceTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:connectivity/eligibility/recall/create","required":true}]}},"/connectivity/eligibility/recall/{id}":{"delete":{"summary":"Delete an eligibility recall","description":"Deletes the eligibility recall of an address or building reference.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Recall@@@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(\"/connectivity/eligibility/recall/{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->delete(\"/connectivity/eligibility/recall/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:connectivity/eligibility/recall/delete","required":true}]},"get":{"summary":"Get an eligibility recall","description":"Returns an eligibility recall: its address or building reference, the fiber offers it checks (Pro Fiber FTTH, Dedicated Fiber FTTO/FTTE), and its creation, update and completion dates.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.EligibilityRecall"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Recall@@@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(\"/connectivity/eligibility/recall/{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(\"/connectivity/eligibility/recall/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:connectivity/eligibility/recall/get","required":true}],"x-response-identifier":"id"},"put":{"summary":"Update an eligibility recall","description":"Updates the reference and the fiber offers to check of an eligibility recall. Returns the updated recall.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.EligibilityRecall.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.EligibilityRecall"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Recall@@@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: connectivity.eligibility.EligibilityRecall.post\nresult = client.put(\"/connectivity/eligibility/recall/{id}\",\n\tdedicatedfiberRequest = None, # Check for Dedicated Fiber FTTO/FTTE eligibility ? (type: boolean)\n\tprofiberRequest = None, # Check for Pro Fiber FTTH eligibility ? (type: boolean)\n\treference = None, # Reference (type: string)\n\treferenceType = None, # Reference type (type: connectivity.eligibility.ReferenceTypeEnum)\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: connectivity.eligibility.EligibilityRecall.post\n$result = $ovh->put(\"/connectivity/eligibility/recall/{id}\", array(\n\tdedicatedfiberRequest => null, // Check for Dedicated Fiber FTTO/FTTE eligibility ? (type: boolean)\n\tprofiberRequest => null, // Check for Pro Fiber FTTH eligibility ? (type: boolean)\n\treference => null, // Reference (type: string)\n\treferenceType => null, // Reference type (type: connectivity.eligibility.ReferenceTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:connectivity/eligibility/recall/edit","required":true}]}}}}