{"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 !"},"cdn.DomainStatisticsNameEnum":{"type":"string","description":"Serie Name","enum":["hit","miss"]},"cdn.DomainStatisticsPeriodEnum":{"type":"string","description":"Statistics Period","enum":["day","month","week","year"]},"cdn.DomainStatisticsUnitEnum":{"type":"string","description":"Serie Unit","enum":["req/min"]},"cdn.DomainStatusEnum":{"type":"string","description":"Domain status","enum":["deleting","disabled","disabling","ok","refreshing","to_delete","to_disable","to_refresh"]},"cdn.OperationFunctionEnum":{"type":"string","description":"Operation function","enum":["analytics_delete","analytics_recompute","domain_delete","domain_disable","domain_purge","domain_refresh","service_install","ssl_delete","ssl_install"]},"cdn.OperationOfferEnum":{"type":"string","description":"Shared CDN offer","enum":["advanced","basic","security"]},"cdn.OperationStatusEnum":{"type":"string","description":"Operation status","enum":["cancelled","doing","done","error","todo"]},"cdn.OptionCategoryEnum":{"type":"string","description":"Option category","enum":["cache","performance","security"]},"cdn.OptionConfigParamTypeEnum":{"type":"string","description":"Option Config Parameter type","enum":["bool","int","list","str"]},"cdn.OptionPatternTypeEnum":{"type":"string","description":"Option pattern type","enum":["extension","folder","regex","uri"]},"cdn.OptionQueryParametersEnum":{"type":"string","description":"Option query parameters","enum":["ignored","sorted"]},"cdn.OptionTypeEnum":{"type":"string","description":"Option type","enum":["brotli","cache_rule","cors","devmode","geo_headers","hsts","https_redirect","mixed_content","mobile_redirect","prefetch","prewarm","querystring","waf"]},"cdn.OptionTypePostEnum":{"type":"string","description":"Option type","enum":["cache_rule"]},"cdn.PurgeTypeEnum":{"type":"string","description":"Purge type","enum":["extension","folder","regex","uri"]},"cdn.availableOptions":{"type":"object","description":"Option type available","properties":{"category":{"allOf":[{"$ref":"#/components/schemas/cdn.OptionCategoryEnum"}],"description":"Option category","nullable":true,"readOnly":true},"config":{"allOf":[{"$ref":"#/components/schemas/cdn.availableOptions.config"}],"description":"Option configuration","nullable":true,"readOnly":true},"maxItems":{"type":"integer","description":"Max option items","readOnly":true},"type":{"type":"string","description":"Option type","readOnly":true}}},"cdn.availableOptions.config":{"type":"object","description":"Option configuration","properties":{"destination":{"allOf":[{"$ref":"#/components/schemas/cdn.availableOptions.config.constraints"}],"description":"URL used for Mobile Redirect","nullable":true,"readOnly":true},"followUri":{"allOf":[{"$ref":"#/components/schemas/cdn.availableOptions.config.constraints"}],"description":"Follow Uri on Mobile Redirect","nullable":true,"readOnly":true},"origins":{"allOf":[{"$ref":"#/components/schemas/cdn.availableOptions.config.constraints"}],"description":"Authorized Origins separated by a comma","nullable":true,"readOnly":true},"patternType":{"allOf":[{"$ref":"#/components/schemas/cdn.availableOptions.config.constraints"}],"description":"Option pattern type","nullable":true,"readOnly":true},"priority":{"allOf":[{"$ref":"#/components/schemas/cdn.availableOptions.config.constraints"}],"description":"Cache Rule priority (lower is the strongest priority)","nullable":true,"readOnly":true},"queryParameters":{"allOf":[{"$ref":"#/components/schemas/cdn.availableOptions.config.constraints"}],"description":"Action to apply on query parameters","nullable":true,"readOnly":true},"resources":{"allOf":[{"$ref":"#/components/schemas/cdn.availableOptions.config.constraints"}],"description":"List of URI","nullable":true,"readOnly":true},"statusCode":{"allOf":[{"$ref":"#/components/schemas/cdn.availableOptions.config.constraints"}],"description":"Redirection HTTP Code","nullable":true,"readOnly":true},"ttl":{"allOf":[{"$ref":"#/components/schemas/cdn.availableOptions.config.constraints"}],"description":"Cache time in seconds","nullable":true,"readOnly":true}}},"cdn.availableOptions.config.constraints":{"type":"object","description":"Option configuration constraints","properties":{"length":{"type":"integer","description":"Maximum number of items in value","nullable":true,"readOnly":true},"maximum":{"type":"integer","description":"Maximum value","nullable":true,"readOnly":true},"message":{"type":"string","description":"Description of value","nullable":true,"readOnly":true},"minimum":{"type":"integer","description":"Minimum value","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/cdn.OptionConfigParamTypeEnum"}],"description":"Type of value","nullable":true,"readOnly":true}}},"cdn.domain":{"type":"object","description":"Domain details","properties":{"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"name":{"type":"string","description":"Domain name","readOnly":true},"needRefresh":{"type":"boolean","description":"The domain configuration has been updated, it needs a refresh","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/cdn.DomainStatusEnum"}],"description":"Domain status","readOnly":true},"updatedDate":{"type":"string","description":"Last update date","format":"date-time","readOnly":true}}},"cdn.domain.add.option":{"type":"object","description":"Option details","properties":{"config":{"allOf":[{"$ref":"#/components/schemas/cdn.domain.option.config"}],"description":"Option configuration","nullable":true},"enabled":{"type":"boolean","description":"Enable / Disable the option"},"name":{"type":"string","description":"Option name"},"pattern":{"type":"string","description":"Url pattern","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/cdn.OptionTypePostEnum"}],"description":"Option type"}},"required":["enabled","name","type"]},"cdn.domain.option":{"type":"object","description":"Option details","properties":{"config":{"allOf":[{"$ref":"#/components/schemas/cdn.domain.option.config"}],"description":"Option configuration","nullable":true},"enabled":{"type":"boolean","description":"Enable / Disable the option"},"extra":{"allOf":[{"$ref":"#/components/schemas/cdn.domain.option.extra"}],"description":"Additional information about option","nullable":true},"name":{"type":"string","description":"Option name","readOnly":true},"pattern":{"type":"string","description":"Url pattern","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/cdn.OptionTypeEnum"}],"description":"Option type"}},"required":["enabled","type"]},"cdn.domain.option.config":{"type":"object","description":"Option configuration","properties":{"destination":{"type":"string","description":"URL used for Mobile Redirect","nullable":true},"followUri":{"type":"boolean","description":"Follow Uri on Mobile Redirect","nullable":true},"origins":{"type":"string","description":"Authorized Origins separated by a comma","nullable":true},"patternType":{"allOf":[{"$ref":"#/components/schemas/cdn.OptionPatternTypeEnum"}],"description":"Option pattern type","nullable":true},"priority":{"type":"integer","description":"Cache Rule priority (lower is the strongest priority)","nullable":true},"queryParameters":{"allOf":[{"$ref":"#/components/schemas/cdn.OptionQueryParametersEnum"}],"description":"Action to apply on query parameters","nullable":true},"resources":{"type":"array","description":"List of URI","nullable":true,"items":{"type":"string"}},"statusCode":{"type":"integer","description":"Redirection HTTP Code","nullable":true},"ttl":{"type":"integer","description":"Cache time in seconds","nullable":true}}},"cdn.domain.option.extra":{"type":"object","description":"Additional information about option","properties":{"quota":{"type":"integer","description":"Maximum usage of the option","nullable":true},"usage":{"type":"integer","description":"Current usage of the option","nullable":true}}},"cdn.domain.statistics":{"type":"object","description":"Domain Statistics Datapoints","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/cdn.DomainStatisticsNameEnum"}],"description":"name of the serie","readOnly":true},"points":{"type":"array","description":"List of DataPoints","items":{"$ref":"#/components/schemas/cdn.domain.statistics.point"},"readOnly":true},"unit":{"allOf":[{"$ref":"#/components/schemas/cdn.DomainStatisticsUnitEnum"}],"description":"Unit of the serie","readOnly":true}}},"cdn.domain.statistics.point":{"type":"object","description":"Statistics Datapoint","properties":{"timestamp":{"type":"integer","description":"Timestamp","readOnly":true},"value":{"type":"number","description":"Datapoint value","nullable":true,"readOnly":true}}},"cdn.logs":{"type":"object","description":"Logs archive URL","properties":{"url":{"type":"string","description":"URL to logs archive","readOnly":true},"validity":{"type":"string","description":"URL validity","format":"date-time","readOnly":true}}},"cdn.operation":{"type":"object","description":"Operation details","properties":{"comment":{"type":"string","description":"Comment","nullable":true,"readOnly":true},"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/cdn.OperationFunctionEnum"}],"description":"Operation function","readOnly":true},"id":{"type":"integer","description":"Operation id","readOnly":true},"parameter":{"allOf":[{"$ref":"#/components/schemas/cdn.operation.parameter"}],"description":"Operation parameter","readOnly":true},"service":{"type":"string","description":"Shared CDN service","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/cdn.OperationStatusEnum"}],"description":"Operation status","readOnly":true},"todoDate":{"type":"string","description":"Next execution date","format":"date-time","readOnly":true},"updatedDate":{"type":"string","description":"Last execution date","format":"date-time","readOnly":true}}},"cdn.operation.parameter":{"type":"object","description":"Operation parameter","properties":{"anycastIp":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"CDN anycast IP","nullable":true,"readOnly":true},"cluster":{"type":"string","description":"Cluster name","nullable":true,"readOnly":true},"date":{"type":"string","description":"Date","nullable":true,"format":"date","readOnly":true},"domainName":{"type":"string","description":"Domain name","nullable":true,"readOnly":true},"fingerprint":{"type":"string","description":"CDN certificate fingerprint","nullable":true,"readOnly":true},"offer":{"allOf":[{"$ref":"#/components/schemas/cdn.OperationOfferEnum"}],"description":"Shared CDN offer","nullable":true,"readOnly":true},"pattern":{"type":"string","description":"Pattern to purge on CDN","nullable":true,"readOnly":true},"service":{"type":"string","description":"Service name","nullable":true,"readOnly":true},"sslId":{"type":"integer","description":"CDN ssl id","nullable":true,"readOnly":true}}},"dbaas.logs.LogKind":{"type":"object","description":"Log kind","properties":{"additionalReturnedFields":{"type":"array","description":"List of additional log fields managed in this log kind","items":{"type":"string"},"readOnly":true},"createdAt":{"type":"string","description":"Creation date of the log kind","format":"date-time","readOnly":true},"displayName":{"type":"string","description":"Log kind display name","readOnly":true},"kindId":{"type":"string","description":"Log kind ID","format":"uuid","readOnly":true},"name":{"type":"string","description":"Log kind name","readOnly":true},"updatedAt":{"type":"string","description":"Last update date of the log kind","format":"date-time","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":{"/hosting/web/cdn/log/kind":{"get":{"summary":"List available log kinds","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/cdn/log/kind\")\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(\"/hosting/web/cdn/log/kind\");\n\nprint_r($result);\n?>"}],"x-expanded-response":"DbaasLogsLogKind"}},"/hosting/web/cdn/log/kind/{name}":{"get":{"summary":"Get a log kind","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.LogKind"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/cdn/log/kind/{name}\")\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(\"/hosting/web/cdn/log/kind/{name}\");\n\nprint_r($result);\n?>"}],"x-response-identifier":"name"}},"/hosting/web/{serviceName}/cdn/availableOptions":{"get":{"summary":"List available options for a Shared CDN service","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":{"$ref":"#/components/schemas/cdn.availableOptions"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/availableOptions\")\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(\"/hosting/web/{serviceName}/cdn/availableOptions\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/availableOptions/get","required":true}]}},"/hosting/web/{serviceName}/cdn/domain":{"get":{"summary":"List all domains for a Shared CDN service","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":{"$ref":"#/components/schemas/cdn.domain"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/domain\")\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(\"/hosting/web/{serviceName}/cdn/domain\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/get","required":true}],"x-response-identifier":"name","x-expanded-response":"CdnDomain"}},"/hosting/web/{serviceName}/cdn/domain/{domainName}":{"get":{"summary":"Get details for a domain on a Shared CDN service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","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/cdn.domain"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}\")\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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/get","required":true}],"x-response-identifier":"name"}},"/hosting/web/{serviceName}/cdn/domain/{domainName}/logs":{"get":{"summary":"Generate URL to logs archive","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"date","description":"Logs date (default is yesterday)","schema":{"type":"string","format":"date"}},{"in":"path","name":"domainName","description":"Domain name","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/cdn.logs"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/logs\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/logs/get","required":true}]}},"/hosting/web/{serviceName}/cdn/domain/{domainName}/option":{"get":{"summary":"List all options for a domain","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","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/cdn.domain.option"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/option\")\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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/option\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/option/get","required":true}],"x-response-identifier":"name","x-expanded-response":"CdnDomainOption"},"post":{"summary":"Add an option on a domain","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","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/cdn.domain.add.option"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cdn.domain.option"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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: cdn.domain.add.option\nresult = client.post(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/option\",\n\tconfig = None, # Option configuration (type: cdn.domain.option.config, nullable)\n\tenabled = None, # Enable / Disable the option (type: boolean)\n\tname = None, # Option name (type: string)\n\tpattern = None, # Url pattern (type: string, nullable)\n\ttype = None, # Option type (type: cdn.OptionTypePostEnum)\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: cdn.domain.add.option\n$result = $ovh->post(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/option\", array(\n\tconfig => null, // Option configuration (type: cdn.domain.option.config, nullable)\n\tenabled => null, // Enable / Disable the option (type: boolean)\n\tname => null, // Option name (type: string)\n\tpattern => null, // Url pattern (type: string, nullable)\n\ttype => null, // Option type (type: cdn.OptionTypePostEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/option/create","required":true}]}},"/hosting/web/{serviceName}/cdn/domain/{domainName}/option/{optionName}":{"delete":{"summary":"Remove or Reset an option to his default value","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"optionName","description":"Option name","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","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/option/{optionName}\")\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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/option/{optionName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/option/delete","required":true}]},"get":{"summary":"Get details for an option on a domain","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"optionName","description":"Option name","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/cdn.domain.option"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/option/{optionName}\")\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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/option/{optionName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/option/get","required":true}],"x-response-identifier":"name"},"put":{"summary":"Update an option on a domain","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"path","name":"optionName","description":"Option name","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/cdn.domain.option"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cdn.domain.option"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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: cdn.domain.option\nresult = client.put(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/option/{optionName}\",\n\tconfig = None, # Option configuration (type: cdn.domain.option.config, nullable)\n\tenabled = None, # Enable / Disable the option (type: boolean)\n\textra = None, # Additional information about option (type: cdn.domain.option.extra, nullable)\n\tpattern = None, # Url pattern (type: string, nullable)\n\ttype = None, # Option type (type: cdn.OptionTypeEnum)\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: cdn.domain.option\n$result = $ovh->put(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/option/{optionName}\", array(\n\tconfig => null, // Option configuration (type: cdn.domain.option.config, nullable)\n\tenabled => null, // Enable / Disable the option (type: boolean)\n\textra => null, // Additional information about option (type: cdn.domain.option.extra, nullable)\n\tpattern => null, // Url pattern (type: string, nullable)\n\ttype => null, // Option type (type: cdn.OptionTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/option/edit","required":true}]}},"/hosting/web/{serviceName}/cdn/domain/{domainName}/purge":{"post":{"summary":"Flush cache content on CDN for a domain","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"query","name":"pattern","description":"Purge pattern","schema":{"type":"string"}},{"in":"query","name":"patternType","description":"Purge Pattern Type (default is regex)","schema":{"$ref":"#/components/schemas/cdn.PurgeTypeEnum"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cdn.operation"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/purge\")\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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/purge\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/purge","required":true}]}},"/hosting/web/{serviceName}/cdn/domain/{domainName}/refresh":{"post":{"summary":"Trigger a refresh for a domain","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","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/cdn.operation"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/refresh\")\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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/refresh\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/refresh","required":true}]}},"/hosting/web/{serviceName}/cdn/domain/{domainName}/statistics":{"get":{"summary":"Get CDN statistics for a domain","deprecated":true,"x-deprecation-date":"2023-11-03T00:00:00Z","x-deletion-date":"2024-01-01T00:00:00Z","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domainName","description":"Domain name","required":true,"schema":{"type":"string"}},{"in":"query","name":"period","description":"Period (default is day)","schema":{"$ref":"#/components/schemas/cdn.DomainStatisticsPeriodEnum"}},{"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/cdn.domain.statistics"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"x-badges":[{"color":"red","label":"Deprecated, will be removed"}],"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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/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(\"/hosting/web/{serviceName}/cdn/domain/{domainName}/statistics\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/domain/statistics/get","required":true}]}},"/hosting/web/{serviceName}/cdn/operation":{"get":{"summary":"List all operations for a Shared CDN service","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":{"$ref":"#/components/schemas/cdn.operation"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/operation\")\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(\"/hosting/web/{serviceName}/cdn/operation\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/operation/get","required":true}],"x-response-identifier":"id","x-expanded-response":"CdnOperation"}},"/hosting/web/{serviceName}/cdn/operation/{id}":{"get":{"summary":"Get details for a Shared CDN operation","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"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cdn.operation"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","CDN"]],"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(\"/hosting/web/{serviceName}/cdn/operation/{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(\"/hosting/web/{serviceName}/cdn/operation/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/operation/get","required":true}],"x-response-identifier":"id"}}}}
