{"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"},"license.office.LicenceEnum":{"type":"string","description":"Office Licence","enum":["officeBusiness","officeProPlus"]},"license.office.LicenseEnum":{"type":"string","description":"Office tenant type","enum":["officeBusiness","officeProPlus"]},"license.office.OfficeCurrentStatisticsNative":{"type":"object","description":"Office Current Statisitics","properties":{"date":{"type":"string","description":"Date of the statistics","format":"date","readOnly":true},"lines":{"type":"array","description":"List of lines associated to this statistics entity.","items":{"$ref":"#/components/schemas/license.office.StatisticsLineNative"},"readOnly":true}}},"license.office.Statistics":{"type":"object","description":"License usage statistics.","properties":{"date":{"type":"string","description":"Date of the statistics.","format":"date"},"lines":{"type":"array","description":"List of lines associated to this statistics entity.","items":{"$ref":"#/components/schemas/license.office.StatisticsLine"}}}},"license.office.StatisticsLine":{"type":"object","description":"License usage statistics line.","properties":{"endOfDayCount":{"type":"integer","description":"Count of activated licenses at the end of the day."},"licenceType":{"allOf":[{"$ref":"#/components/schemas/license.office.LicenceEnum"}],"description":"Type of the Office license."},"peakCount":{"type":"integer","description":"Maximum count of simultaneous activated licences."}}},"license.office.StatisticsLineNative":{"type":"object","description":"License usage statistics line.","properties":{"endOfDayCount":{"type":"integer","description":"Count of activated licenses at the end of the day.","readOnly":true},"licenceType":{"allOf":[{"$ref":"#/components/schemas/license.office.LicenseEnum"}],"description":"Type of the Office license.","readOnly":true},"peakCount":{"type":"integer","description":"Maximum count of simultaneous activated licences.","readOnly":true}}},"license.officePrepaid.LicenseEnum":{"type":"string","description":"Office tenant type","enum":["officeBusiness","officeProPlus"]},"license.officePrepaid.OfficeCurrentStatisticsNative":{"type":"object","description":"Office Current Statisitics","properties":{"date":{"type":"string","description":"Date of the statistics","format":"date","readOnly":true},"lines":{"type":"array","description":"List of lines associated to this statistics entity.","items":{"$ref":"#/components/schemas/license.officePrepaid.StatisticsLineNative"},"readOnly":true}}},"license.officePrepaid.StatisticsLineNative":{"type":"object","description":"License usage statistics line.","properties":{"endOfDayCount":{"type":"integer","description":"Count of activated licenses at the end of the day.","readOnly":true},"licenceType":{"allOf":[{"$ref":"#/components/schemas/license.officePrepaid.LicenseEnum"}],"description":"Type of the Office license.","readOnly":true},"peakCount":{"type":"integer","description":"Maximum count of simultaneous activated licences.","readOnly":true}}},"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":{"/license/office/{serviceName}/usageStatistics":{"get":{"summary":"Get tenant usage statistics","description":"Returns, for each day between `from` and `to`, the peak and end-of-day counts of activated licenses of the tenant, by license type.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"from","description":"Period's start point","schema":{"type":"string","format":"date-time"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","description":"Period's end point","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/license.office.OfficeCurrentStatisticsNative"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft 365","Usage@@@10"]],"x-badges":[{"color":"blue","label":"Alpha 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(\"/license/office/{serviceName}/usageStatistics\")\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(\"/license/office/{serviceName}/usageStatistics\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"licenseOffice:apiovh:usageStatistics/get","required":true}]}},"/license/officePrepaid/{serviceName}/tenantUsageStatistics":{"get":{"summary":"Get parent tenant usage statistics","description":"Returns, for each day between `from` and `to`, the peak and end-of-day counts of activated licenses of the parent tenant, by license type.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"from","description":"Period's start point.","schema":{"type":"string","format":"date-time"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"query","name":"to","description":"Period's end point.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/license.officePrepaid.OfficeCurrentStatisticsNative"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft 365","Usage@@@20"]],"x-badges":[{"color":"blue","label":"Alpha 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(\"/license/officePrepaid/{serviceName}/tenantUsageStatistics\")\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(\"/license/officePrepaid/{serviceName}/tenantUsageStatistics\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"licenseOfficePrepaid:apiovh:tenantUsageStatistics/get","required":true}]}}}}