{"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.OperatorEnum":{"type":"string","description":"Operator","enum":["AXIONE","BOUYGUES","KOSC","ORANGE","OVH","SFR"]},"connectivity.maintenance.InterventionTypeEnum":{"type":"string","description":"Intervention type","enum":["BACKBONE_MAINTENANCE","CARD_SWAP_WITH_IMPACT","CLUSTER_AN_ROUTER_MIGRATION","CORRECTIVE_MAINTENANCE","DSLAM_LINK_UPGRADE_WITHOUT_CARD_SWAP","DSLAM_UPGRADE_WITH_IMPACT","FIBER_CABLE_LINK_SWAP","FIBER_CONNECTION_WITH_IMPACT","FIBER_MAINTENANCE","FIBER_THIRD_PARTY_WORK_WITH_IMPACT","IP_BACKBONE_LINK_MIGRATION_WITH_IMPACT","IP_BACKBONE_SWITCH_UPGRADE_WITH_IMPACT","IP_MAINTENANCE","LEVEL2_DSLAM_MIGRATION","LINK_MIGRATION_WITH_DSL_IMPACT","LL_THIRD_PARTY_MAINTENANCE_WITH_IMPACT","LOOP_AN_ROUTER_MIGRATION","LOOP_AN_ROUTER_UPGRADE","MAINTENANCE","OPTIC_FIBER_WORK_WITH_OUTAGE_DURING_NON_WORKING_HOURS","PLANNED_CORRECTIVE_MAINTENANCE","SENSITIVE_LOOP_LINK_UPGRADE","TRANSMISSION_CORRECTIVE_MAINTENANCE","TRANSMISSION_CUSTOMER_TRANSFERT_MIGRATION_WITH_IMPACT","TRANSMISSION_FIBRE_MAINTENANCE","TRANSMISSION_LINK_COMMISSIONING_PRODUCTION_DECOMMISSIONING_WORK_WITH_IMPACT","TRANSMISSION_LINK_TRANSFERT_MIGRATION_WITH_IMPACT","TRANSMISSION_MAINTENANCE","TRANSMISSION_MOVING_WITH_IMPACT","TRANSMISSION_SWITCH_UPGRADE_WITH_IMPACT","WITH_IMPACT"]},"connectivity.maintenance.WorkPlanned":{"type":"object","description":"Work Planned operation structure","properties":{"dateBegin":{"type":"string","description":"Begin date, the work planned operation starts at this time","readOnly":true},"dateEnd":{"type":"string","description":"End date, the work planned operation finishes at the time","readOnly":true},"departments":{"type":"array","description":"List of impacted department codes","nullable":true,"items":{"type":"string"},"readOnly":true},"description":{"type":"string","description":"Description of the work planned operation","nullable":true,"readOnly":true},"duration":{"type":"string","description":"Duration of the work planned operation","nullable":true,"format":"duration","readOnly":true},"fallback":{"type":"boolean","description":"Fallback planned for the operation","nullable":true,"readOnly":true},"fallbackDateBegin":{"type":"string","description":"Fallback operation starts at this time","nullable":true,"format":"date-time","readOnly":true},"fallbackDateEnd":{"type":"string","description":"Fallback operation ends at this time","nullable":true,"format":"date-time","readOnly":true},"id":{"type":"integer","description":"Work Planned operation id","readOnly":true},"impact":{"type":"string","description":"Impact of the work planned operation","nullable":true,"readOnly":true},"interventionType":{"allOf":[{"$ref":"#/components/schemas/connectivity.maintenance.InterventionTypeEnum"}],"description":"Intervention type","readOnly":true},"nras":{"type":"array","description":"List of impacted NRA/NRO","nullable":true,"items":{"type":"string"},"readOnly":true},"operator":{"allOf":[{"$ref":"#/components/schemas/connectivity.OperatorEnum"}],"description":"Operator","readOnly":true},"technology":{"type":"string","description":"Technology impacted by the work planned operation","readOnly":true},"zone":{"type":"string","description":"Zone of the work planned operation","nullable":true,"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"}},"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/maintenance/workPlanned/partners":{"get":{"operationId":"getPartnersPlannedWork","summary":"List the work planned by operators for a partner","description":"Returns the planned work operations of network operators, with their dates, duration, impact, impacted NRA/NRO and departments. Reserved for partners.","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/connectivity.maintenance.WorkPlanned"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Maintenance@@@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/maintenance/workPlanned/partners\")\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/maintenance/workPlanned/partners\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:connectivity/maintenance/workPlanned/partners/get","required":true}]}},"/connectivity/maintenance/workPlanned/public":{"get":{"operationId":"getPlannedWork","summary":"List the work planned by operators","description":"Returns the planned work operations of network operators, with their dates, duration, impact, impacted NRA/NRO and departments. Filter on the begin and end dates.","parameters":[{"in":"query","name":"beginDate","description":"List only work planned started after this date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"endDate","description":"List only work planned ending prior to this date","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/connectivity.maintenance.WorkPlanned"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Maintenance@@@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/maintenance/workPlanned/public\")\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/maintenance/workPlanned/public\");\n\nprint_r($result);\n?>"}]}}}}