{"apiVersion":"1.0","apis":[{"path":"/hosting/web","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"iamTags","dataType":"map[string][]iam.resource.TagFilter","paramType":"query","required":false,"description":"Filter resources on IAM tags"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List web hostings","longDescription":"Returns the service names of the web hostings of the account.","iamActions":[{"name":"webHosting:apiovh:get","required":true}]}],"description":""},{"path":"/hosting/web/attachedDomain","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domain","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"Domain used into web hosting attached domains"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"Find hostings by attached domain","longDescription":"Returns the service names of the hostings that have the given domain attached.","iamActions":[{"name":"account:apiovh:webHosting/attachedDomain/get","required":true}]}],"description":""},{"path":"/hosting/web/availableOffer","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domain","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"Domain you want to add or upgrade a hosting"}],"responseType":"hosting.web.OfferEnum[]","responseTypes":{"200":"hosting.web.OfferEnum[]"},"noAuthentication":false,"description":"List available offers","iamActions":[{"name":"account:apiovh:webHosting/availableOffer/get","required":true}]}],"description":"List available offers"},{"path":"/hosting/web/cdn/log/kind","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List available log kinds"}],"description":"Access to available log kind"},{"path":"/hosting/web/cdn/log/kind/{name}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Name"}],"responseType":"dbaas.logs.LogKind","responseTypes":{"200":"dbaas.logs.LogKind"},"noAuthentication":false,"description":"Get a log kind"}],"description":"Access to available log kind"},{"path":"/hosting/web/incident","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List current incidents","iamActions":[{"name":"account:apiovh:webHosting/incident/get","required":true}]}],"description":"List current incidents"},{"path":"/hosting/web/localSeo/directoriesList","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"country","dataType":"hosting.web.localSeo.location.CountryEnum","paramType":"query","fullType":"hosting.web.localSeo.location.CountryEnum","required":true,"description":"Country of the location"},{"name":"offer","dataType":"hosting.web.localSeo.location.OfferEnum","paramType":"query","fullType":"hosting.web.localSeo.location.OfferEnum","required":true,"description":"Local SEO offer"}],"responseType":"hosting.web.localSeo.DirectoriesList","responseTypes":{"200":"hosting.web.localSeo.DirectoriesList"},"noAuthentication":true,"description":"List local SEO directories","longDescription":"List local SEO directories. Returns the search engines, navigation systems and social networks covered by a local SEO offer in a country."}],"description":"List local SEO directories. Returns the search engines, navigation systems and social networks covered by a local SEO offer in a country."},{"path":"/hosting/web/localSeo/emailAvailability","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"email","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"The email address to check"}],"responseType":"hosting.web.localSeo.EmailAvailability","responseTypes":{"200":"hosting.web.localSeo.EmailAvailability"},"noAuthentication":true,"description":"Check local SEO email availability","longDescription":"Check local SEO email availability. Returns whether an email address can be used for a local SEO order, and the hosting already using it."}],"description":"Check local SEO email availability. Returns whether an email address can be used for a local SEO order, and the hosting already using it."},{"path":"/hosting/web/localSeo/visibilityCheck","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"country","dataType":"hosting.web.localSeo.location.CountryEnum","paramType":"body","fullType":"hosting.web.localSeo.location.CountryEnum","required":true,"description":"Country of the location"},{"name":"name","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Name of the location"},{"name":"street","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Address line 1 of the location"},{"name":"zip","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Zipcode of the location"}],"responseType":"hosting.web.localSeo.VisibilityCheckResponse","responseTypes":{"200":"hosting.web.localSeo.VisibilityCheckResponse"},"noAuthentication":true,"description":"Check location visibility","longDescription":"Check location visibility. Starts a visibility check for a location from its name, street, zip code and country. Returns whether the location is already managed."}],"description":"Check location visibility. Starts a visibility check for a location from its name, street, zip code and country. Returns whether the location is already managed."},{"path":"/hosting/web/localSeo/visibilityCheckResult","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"directory","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"Get the result only for one directory"},{"name":"id","dataType":"long","paramType":"query","fullType":"long","required":true,"description":"Id of the check"},{"name":"token","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"Token received when requesting the check"}],"responseType":"hosting.web.localSeo.VisibilityCheckResultResponse[]","responseTypes":{"200":"hosting.web.localSeo.VisibilityCheckResultResponse[]"},"noAuthentication":true,"description":"Get visibility check results","longDescription":"Get visibility check results. Returns the listings found for the location in each directory, with the sync status of each field."}],"description":"Get visibility check results. Returns the listings found for the location in each directory, with the sync status of each field."},{"path":"/hosting/web/moduleList","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"active","dataType":"boolean","paramType":"query","fullType":"boolean","required":false,"description":"Filter the value of active property (=)"},{"name":"branch","dataType":"hosting.web.module.BranchEnum","paramType":"query","fullType":"hosting.web.module.BranchEnum","required":false,"description":"Filter the value of branch property (=)"},{"name":"latest","dataType":"boolean","paramType":"query","fullType":"boolean","required":false,"description":"Filter the value of latest property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":true,"description":"List available modules","longDescription":"List available modules. Returns the IDs of the modules that can be installed. Filter them by active, branch or latest."}],"description":"List the hosting.web.ModuleList objects"},{"path":"/hosting/web/moduleList/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"The ID of the module"}],"responseType":"hosting.web.ModuleList","responseTypes":{"200":"hosting.web.ModuleList"},"noAuthentication":true,"description":"Get an available module","longDescription":"Get an available module. Returns the name, version, branch, languages and requirements of the module, and the modules it can be upgraded to."}],"description":"A module specifically packaged by OVH"},{"path":"/hosting/web/offerCapabilities","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"offer","dataType":"hosting.web.OfferCapabilitiesEnum","paramType":"query","fullType":"hosting.web.OfferCapabilitiesEnum","required":true,"description":"Describe offer capabilities"}],"responseType":"hosting.web.Capabilities","responseTypes":{"200":"hosting.web.Capabilities"},"noAuthentication":true,"description":"Get offer capabilities","longDescription":"Get offer capabilities. Returns what an offer includes: attached domains, databases, disk, traffic, SSH, cron, modules and runtimes."}],"description":"Get offer capabilities. Returns what an offer includes: attached domains, databases, disk, traffic, SSH, cron, modules and runtimes."},{"path":"/hosting/web/vcs/supported","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[],"responseType":"hosting.web.SupportedVcsEnum[]","responseTypes":{"200":"hosting.web.SupportedVcsEnum[]"},"noAuthentication":false,"description":"List supported VCS platforms","longDescription":"Returns the VCS platforms a website can be deployed from."}],"description":""},{"path":"/hosting/web/{serviceName}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.ServiceWithIAM","responseTypes":{"200":"hosting.web.ServiceWithIAM"},"noAuthentication":false,"description":"Get a web hosting","longDescription":"Returns the offer, state, cluster, recommended IPs, disk and traffic quotas, and PHP versions of the web hosting.","iamActions":[{"name":"webHosting:apiovh:get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.Service","paramType":"body","fullType":"hosting.web.Service","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a web hosting","longDescription":"Updates the display name of the web hosting.","iamActions":[{"name":"webHosting:apiovh:edit","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/abuseState","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.AbuseState","responseTypes":{"200":"hosting.web.AbuseState"},"noAuthentication":false,"description":"Get the abuse state","longDescription":"Returns the access, web, outgoing email and outgoing TCP states of the hosting.","iamActions":[{"name":"webHosting:apiovh:abuseState/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/attachedDomain","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domain","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of domain property (like)"},{"name":"path","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of path property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List attached domains","longDescription":"Returns the domains and subdomains attached to the hosting. Filter them by domain or path.","iamActions":[{"name":"webHosting:apiovh:attachedDomain/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"hosting.web.AttachedDomain","paramType":"body","fullType":"hosting.web.AttachedDomain","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"description":"Attach a domain","longDescription":"Attaches a domain to a folder of the hosting, with its CDN, firewall, SSL and IP location settings, and returns the task. Set bypassDNSConfiguration to true to leave the DNS zone unchanged.","iamActions":[{"name":"webHosting:apiovh:attachedDomain/create","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/attachedDomain/{domain}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"bypassDNSConfiguration","dataType":"boolean","paramType":"query","fullType":"boolean","required":false,"description":"If set to true, DNS zone will not be updated by the operation"},{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"description":"Detach a domain","longDescription":"Detaches the domain from the hosting and returns the task. Set bypassDNSConfiguration to true to leave the DNS zone unchanged.","iamActions":[{"name":"webHosting:apiovh:attachedDomain/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.attachedDomain.PublicAttachedDomain","responseTypes":{"200":"hosting.web.attachedDomain.PublicAttachedDomain"},"noAuthentication":false,"description":"Get an attached domain","longDescription":"Returns the path, CDN, firewall, SSL, IP location and status of the attached domain.","iamActions":[{"name":"webHosting:apiovh:attachedDomain/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.AttachedDomain","paramType":"body","fullType":"hosting.web.AttachedDomain","required":true,"description":"Request Body"},{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update an attached domain","longDescription":"Updates the path, CDN, firewall, SSL, IP location or log domain of the attached domain.","iamActions":[{"name":"webHosting:apiovh:attachedDomain/edit","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/attachedDomain/{domain}/digStatus","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.attachedDomain.DigStatus","responseTypes":{"200":"hosting.web.attachedDomain.DigStatus"},"noAuthentication":false,"description":"Get attached domain DNS status","longDescription":"Returns the DNS records of the attached domain, their status and the recommended IPs to point them to.","iamActions":[{"name":"webHosting:apiovh:attachedDomain/digStatus/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/attachedDomain/{domain}/purgeCache","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain linked (fqdn)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Purge the attached domain cache","iamActions":[{"name":"webHosting:apiovh:attachedDomain/purgeCache","required":true}]}],"description":"purgeCache operations"},{"path":"/hosting/web/{serviceName}/attachedDomain/{domain}/restart","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain linked (fqdn)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Restart the attached domain virtual host","longDescription":"Restart the attached domain virtual host. Restarts the virtual host serving the attached domain and returns the task.","iamActions":[{"name":"webHosting:apiovh:attachedDomain/restart","required":true}]}],"description":"restart operations"},{"path":"/hosting/web/{serviceName}/attachedDomain/{domain}/ssl","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.SSL","responseTypes":{"200":"hosting.web.SSL"},"noAuthentication":false,"description":"Delete the SSL certificate","longDescription":"Deletes the SSL certificate of the attached domain.","iamActions":[{"name":"webHosting:apiovh:ssl/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.SSL","responseTypes":{"200":"hosting.web.SSL"},"noAuthentication":false,"description":"Get the SSL certificate","longDescription":"Returns the provider, type and status of the SSL certificate of the attached domain.","iamActions":[{"name":"webHosting:apiovh:ssl/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.SSL","responseTypes":{"200":"hosting.web.SSL"},"noAuthentication":false,"description":"Create a free SSL certificate","longDescription":"Creates the free Let's Encrypt SSL certificate of the attached domain.","iamActions":[{"name":"webHosting:apiovh:ssl/create","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.SSLUpdateInput","paramType":"body","fullType":"hosting.web.SSLUpdateInput","required":true,"description":"Request Body"},{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.SSL","responseTypes":{"200":"hosting.web.SSL"},"noAuthentication":false,"description":"Update the SSL certificate","longDescription":"Updates the SSL certificate of the attached domain. Set regenerate to true to regenerate it.","iamActions":[{"name":"webHosting:apiovh:ssl/edit","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/attachedDomain/{domain}/ssl/regenerate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.SSL","responseTypes":{"200":"hosting.web.SSL"},"noAuthentication":false,"description":"Regenerate the SSL certificate","longDescription":"Regenerates the SSL certificate of the attached domain.","iamActions":[{"name":"webHosting:apiovh:ssl/regenerate","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/attachedDomain/{domain}/ssl/report","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domain","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.ssl.Report","responseTypes":{"200":"hosting.web.ssl.Report"},"noAuthentication":false,"description":"Get the SSL certificate report","longDescription":"Returns the status of each validation check run by the certification authority for the certificate of the attached domain.","iamActions":[{"name":"webHosting:apiovh:ssl/report/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/availableConfigurations","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"language","dataType":"hosting.web.configuration.LanguageEnum","paramType":"query","fullType":"hosting.web.configuration.LanguageEnum","required":false,"description":"Filter on language name"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.configuration.VersionEnum[]","responseTypes":{"200":"hosting.web.configuration.VersionEnum[]"},"noAuthentication":false,"description":"List available configurations","longDescription":"List available configurations. Returns the language versions available for the application configuration. Filter them by language.","iamActions":[{"name":"webHosting:apiovh:availableConfigurations/get","required":true}]}],"description":"availableConfigurations operations"},{"path":"/hosting/web/{serviceName}/boostHistory","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"date","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of date property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"datetime[]","responseTypes":{"200":"datetime[]"},"noAuthentication":false,"description":"List boost history","longDescription":"Returns the dates of the boost changes of the hosting. Filter them by date.","iamActions":[{"name":"webHosting:apiovh:boostHistory/get","required":true}]}],"description":"Boost history records when a hosting is upgraded to a higher plan temporarily"},{"path":"/hosting/web/{serviceName}/boostHistory/{date}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"date","dataType":"datetime","paramType":"path","fullType":"datetime","required":true,"description":"Date"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.BoostHistory","responseTypes":{"200":"hosting.web.BoostHistory"},"noAuthentication":false,"description":"Get a boost history entry","longDescription":"Returns the boost offer, the hosting offer at that time, the requesting account and the request date.","iamActions":[{"name":"webHosting:apiovh:boostHistory/get","required":true}]}],"description":"Boost history records when a hosting is upgraded to a higher plan temporarily"},{"path":"/hosting/web/{serviceName}/cdn","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.CDN","responseTypes":{"200":"hosting.web.CDN"},"noAuthentication":false,"description":"Get the CDN","longDescription":"Returns the domain, type, version and status of the CDN option, and whether it is free with the hosting.","iamActions":[{"name":"webHosting:apiovh:cdn/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/availableOptions","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.availableOptions[]","responseTypes":{"200":"cdn.availableOptions[]"},"noAuthentication":false,"description":"List available options for a Shared CDN service","iamActions":[{"name":"webHosting:apiovh:cdn/availableOptions/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/domain","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.domain[]","responseTypes":{"200":"cdn.domain[]"},"noAuthentication":false,"description":"List all domains for a Shared CDN service","iamActions":[{"name":"webHosting:apiovh:cdn/domain/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/domain/{domainName}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domainName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain name"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.domain","responseTypes":{"200":"cdn.domain"},"noAuthentication":false,"description":"Get details for a domain on a Shared CDN service","iamActions":[{"name":"webHosting:apiovh:cdn/domain/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/domain/{domainName}/logs","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"date","dataType":"date","paramType":"query","fullType":"date","required":false,"description":"Logs date (default is yesterday)"},{"name":"domainName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain name"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.logs","responseTypes":{"200":"cdn.logs"},"noAuthentication":false,"description":"Generate URL to logs archive","iamActions":[{"name":"webHosting:apiovh:cdn/domain/logs/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/domain/{domainName}/option","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domainName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain name"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.domain.option[]","responseTypes":{"200":"cdn.domain.option[]"},"noAuthentication":false,"description":"List all options for a domain","iamActions":[{"name":"webHosting:apiovh:cdn/domain/option/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"cdn.domain.add.option","paramType":"body","fullType":"cdn.domain.add.option","required":true,"description":"Request Body"},{"name":"domainName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain name"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.domain.option","responseTypes":{"200":"cdn.domain.option"},"noAuthentication":false,"description":"Add an option on a domain","iamActions":[{"name":"webHosting:apiovh:cdn/domain/option/create","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/domain/{domainName}/option/{optionName}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"domainName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain name"},{"name":"optionName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Option name"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Remove or Reset an option to his default value","iamActions":[{"name":"webHosting:apiovh:cdn/domain/option/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"domainName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain name"},{"name":"optionName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Option name"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.domain.option","responseTypes":{"200":"cdn.domain.option"},"noAuthentication":false,"description":"Get details for an option on a domain","iamActions":[{"name":"webHosting:apiovh:cdn/domain/option/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"cdn.domain.option","paramType":"body","fullType":"cdn.domain.option","required":true,"description":"Request Body"},{"name":"domainName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain name"},{"name":"optionName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Option name"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.domain.option","responseTypes":{"200":"cdn.domain.option"},"noAuthentication":false,"description":"Update an option on a domain","iamActions":[{"name":"webHosting:apiovh:cdn/domain/option/edit","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/domain/{domainName}/purge","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"domainName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain name"},{"name":"pattern","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Purge pattern"},{"name":"patternType","dataType":"cdn.PurgeTypeEnum","paramType":"query","fullType":"cdn.PurgeTypeEnum","required":false,"description":"Purge Pattern Type (default is regex)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.operation","responseTypes":{"200":"cdn.operation"},"noAuthentication":false,"description":"Flush cache content on CDN for a domain","iamActions":[{"name":"webHosting:apiovh:cdn/domain/purge","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/domain/{domainName}/refresh","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"domainName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain name"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.operation","responseTypes":{"200":"cdn.operation"},"noAuthentication":false,"description":"Trigger a refresh for a domain","iamActions":[{"name":"webHosting:apiovh:cdn/domain/refresh","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/domain/{domainName}/statistics","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2024-01-01T00:00:00Z","deprecatedDate":"2023-11-03T00:00:00Z"},"httpMethod":"GET","parameters":[{"name":"domainName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Domain name"},{"name":"period","dataType":"cdn.DomainStatisticsPeriodEnum","paramType":"query","fullType":"cdn.DomainStatisticsPeriodEnum","required":false,"description":"Period (default is day)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.domain.statistics[]","responseTypes":{"200":"cdn.domain.statistics[]"},"noAuthentication":false,"description":"Get CDN statistics for a domain","iamActions":[{"name":"webHosting:apiovh:cdn/domain/statistics/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/log/subscription","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"kind","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter on a specific kind (e.g., audit)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"uuid[]","responseTypes":{"200":"uuid[]"},"noAuthentication":false,"description":"List log subscriptions","longDescription":"Returns the identifiers of the CDN log subscriptions. Set `kind` to restrict the list to one log kind.","iamActions":[{"name":"webHosting:apiovh:cdn/log/subscription/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"dbaas.logs.LogSubscriptionCreation","paramType":"body","fullType":"dbaas.logs.LogSubscriptionCreation","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"dbaas.logs.LogSubscriptionResponse","responseTypes":{"200":"dbaas.logs.LogSubscriptionResponse"},"noAuthentication":false,"description":"Create a log subscription","longDescription":"Forwards CDN logs of one kind to a Logs Data Platform stream. The subscription is created asynchronously and the response returns the operation identifier.","iamActions":[{"name":"webHosting:apiovh:cdn/log/subscription/create","required":true},{"name":"ldp:apiovh:output/graylog/stream/forwardTo","description":"Required on the targeted LDP service","required":true}]}],"description":"Create a subscription from cdn-hosting logs to a pre-existing LDP stream"},{"path":"/hosting/web/{serviceName}/cdn/log/subscription/{subscriptionId}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"subscriptionId","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Subscription ID"}],"responseType":"dbaas.logs.LogSubscriptionResponse","responseTypes":{"200":"dbaas.logs.LogSubscriptionResponse"},"noAuthentication":false,"description":"Delete a log subscription","longDescription":"Deletes the subscription and stops forwarding CDN logs to the stream.","iamActions":[{"name":"webHosting:apiovh:cdn/log/subscription/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"subscriptionId","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Subscription ID"}],"responseType":"dbaas.logs.LogSubscription","responseTypes":{"200":"dbaas.logs.LogSubscription"},"noAuthentication":false,"description":"Get a log subscription","longDescription":"Returns the log kind and the destination stream of a subscription.","iamActions":[{"name":"webHosting:apiovh:cdn/log/subscription/get","required":true}]}],"description":"Create a subscription from cdn-hosting logs to a pre-existing LDP stream"},{"path":"/hosting/web/{serviceName}/cdn/log/url","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"dbaas.logs.LogUrlCreation","paramType":"body","fullType":"dbaas.logs.LogUrlCreation","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"dbaas.logs.TemporaryLogsLink","responseTypes":{"200":"dbaas.logs.TemporaryLogsLink"},"noAuthentication":false,"description":"Generate a temporary log URL","longDescription":"Generates a temporary URL to read the logs of one kind. The URL expires.","iamActions":[{"name":"webHosting:apiovh:cdn/log/url/create","required":true}]}],"description":"Generate a temporary URL to retrieve logs"},{"path":"/hosting/web/{serviceName}/cdn/operation","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.operation[]","responseTypes":{"200":"cdn.operation[]"},"noAuthentication":false,"description":"List all operations for a Shared CDN service","iamActions":[{"name":"webHosting:apiovh:cdn/operation/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/operation/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"cdn.operation","responseTypes":{"200":"cdn.operation"},"noAuthentication":false,"description":"Get details for a Shared CDN operation","iamActions":[{"name":"webHosting:apiovh:cdn/operation/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cdn/serviceInfos","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Get CDN service information","longDescription":"Get CDN service information. Returns the billing information of the CDN option: creation and expiration dates, renewal settings and contacts.","iamActions":[{"name":"webHosting:apiovh:cdn/serviceInfos/get","required":true}]}],"description":"serviceInfos operations"},{"path":"/hosting/web/{serviceName}/cdn/serviceInfosUpdate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"renew","dataType":"service.RenewType","paramType":"body","fullType":"service.RenewType","required":true,"description":"Renew type"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update CDN renewal","iamActions":[{"name":"webHosting:apiovh:cdn/serviceInfosUpdate/create","required":true}]}],"description":"serviceInfosUpdate operations"},{"path":"/hosting/web/{serviceName}/cdn/terminate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Terminate the CDN option","iamActions":[{"name":"webHosting:apiovh:cdn/terminate","required":true}]}],"description":"terminate operations"},{"path":"/hosting/web/{serviceName}/changeContact","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"services.changeContact","paramType":"body","fullType":"services.changeContact","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"Change contacts","longDescription":"Starts the contact change procedure of the service. Returns the identifiers of the created tasks.","iamActions":[{"name":"webHosting:apiovh:changeContact","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/configuration","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.configuration","responseTypes":{"200":"hosting.web.configuration"},"noAuthentication":false,"description":"Get the configuration","longDescription":"Get the configuration. Returns the language, version, environment, launch script and public directory of the application.","iamActions":[{"name":"webHosting:apiovh:configuration/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.configuration","paramType":"body","fullType":"hosting.web.configuration","required":true,"description":"New object properties"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update the configuration","longDescription":"Update the configuration. Updates the language, version, environment, launch script or public directory of the application.","iamActions":[{"name":"webHosting:apiovh:configuration/edit","required":true}]}],"description":"The Configuration of an hosting Power offer"},{"path":"/hosting/web/{serviceName}/confirmTermination","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"services.confirmTermination","paramType":"body","fullType":"services.confirmTermination","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Confirm termination","longDescription":"Confirms the termination of the service with the token sent by email.","iamActions":[{"name":"webHosting:apiovh:confirmTermination","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cron","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"command","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of command property (like)"},{"name":"description","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of description property (like)"},{"name":"email","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of email property (like)"},{"name":"language","dataType":"hosting.web.LanguagesEnum","paramType":"query","fullType":"hosting.web.LanguagesEnum","required":false,"description":"Filter the value of language property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List cron jobs","longDescription":"Returns the IDs of the cron jobs of the hosting. Filter them by command, description, email or language.","iamActions":[{"name":"webHosting:apiovh:cron/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"hosting.web.Cron","paramType":"body","fullType":"hosting.web.Cron","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"description":"Create a cron job","longDescription":"Creates a cron job that runs a script at a crontab frequency, and returns the task. Minutes in the frequency are ignored. Errors are sent to the email address.","iamActions":[{"name":"webHosting:apiovh:cron/create","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cron/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"description":"Delete a cron job","longDescription":"Deletes the cron job and returns the task.","iamActions":[{"name":"webHosting:apiovh:cron/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.Cron","responseTypes":{"200":"hosting.web.Cron"},"noAuthentication":false,"description":"Get a cron job","longDescription":"Returns the command, frequency, language, email and status of the cron job.","iamActions":[{"name":"webHosting:apiovh:cron/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.Cron","paramType":"body","fullType":"hosting.web.Cron","required":true,"description":"Request Body"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Update a cron job","longDescription":"Updates the command, frequency, language, email or description of the cron job. Minutes in the frequency are ignored.","iamActions":[{"name":"webHosting:apiovh:cron/edit","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/cronAvailableLanguage","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.LanguagesEnum[]","responseTypes":{"200":"hosting.web.LanguagesEnum[]"},"noAuthentication":false,"description":"List cron languages","longDescription":"Returns the languages a cron job can use on the hosting.","iamActions":[{"name":"webHosting:apiovh:cronAvailableLanguages/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/database","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"mode","dataType":"hosting.web.database.ModeEnum","paramType":"query","fullType":"hosting.web.database.ModeEnum","required":false,"description":"Filter the value of mode property (=)"},{"name":"name","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of name property (like)"},{"name":"server","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of server property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"},{"name":"type","dataType":"hosting.web.database.DatabaseTypeEnum","paramType":"query","fullType":"hosting.web.database.DatabaseTypeEnum","required":false,"description":"Filter the value of type property (=)"},{"name":"user","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of user property (like)"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List databases","longDescription":"List databases. Returns the names of the databases of the hosting. Filter them by mode, name, server, type or user.","iamActions":[{"name":"webHosting:apiovh:database/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"capabilitie","dataType":"hosting.web.database.DatabaseCapabilitiesTypeEnum","paramType":"body","fullType":"hosting.web.database.DatabaseCapabilitiesTypeEnum","required":true,"description":"Type of your database"},{"name":"password","dataType":"password","paramType":"body","fullType":"password","required":false,"description":"Database password"},{"name":"quota","dataType":"hosting.web.database.ExtraSqlQuotaEnum","paramType":"body","fullType":"hosting.web.database.ExtraSqlQuotaEnum","required":false,"description":"Quota assign to your database. Only for extraSql"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"},{"name":"type","dataType":"hosting.web.database.DatabaseCreationTypeEnum","paramType":"body","fullType":"hosting.web.database.DatabaseCreationTypeEnum","required":true,"description":"Type you want for your database"},{"name":"user","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Database user name. Must begin with your hosting login and must be in lower case"},{"name":"version","dataType":"hosting.web.database.VersionEnum","paramType":"body","fullType":"hosting.web.database.VersionEnum","required":false,"description":"Version you want for your database following the type"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Create a database","longDescription":"Create a database. Creates a MariaDB, MySQL, PostgreSQL or Redis database with its user, and returns the task. The quota applies only to extraSqlPerso databases.","iamActions":[{"name":"webHosting:apiovh:database/create","required":true}]}],"description":"List the hosting.web.database objects"},{"path":"/hosting/web/{serviceName}/database/{name}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Delete a database","iamActions":[{"name":"webHosting:apiovh:database/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.database","responseTypes":{"200":"hosting.web.database"},"noAuthentication":false,"description":"Get a database","iamActions":[{"name":"webHosting:apiovh:database/get","required":true}]}],"description":"Database"},{"path":"/hosting/web/{serviceName}/database/{name}/capabilities","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.database.DatabaseCapabilities","responseTypes":{"200":"hosting.web.database.DatabaseCapabilities"},"noAuthentication":false,"description":"Get database capabilities","longDescription":"Get database capabilities. Returns the functions available on the database, such as dump, restore or password change, and the URL of its management tool.","iamActions":[{"name":"webHosting:apiovh:database/capabilities/get","required":true}]}],"description":"capabilities operations"},{"path":"/hosting/web/{serviceName}/database/{name}/changePassword","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"password","dataType":"password","paramType":"body","fullType":"password","required":true,"description":"The new database password"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Change the database password","iamActions":[{"name":"webHosting:apiovh:database/changePassword","required":true}]}],"description":"changePassword operations"},{"path":"/hosting/web/{serviceName}/database/{name}/copy","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"uuid[]","responseTypes":{"200":"uuid[]"},"noAuthentication":false,"description":"List database copies","iamActions":[{"name":"webHosting:apiovh:database/copy/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.database.copy","responseTypes":{"200":"hosting.web.database.copy"},"noAuthentication":false,"description":"Create a database copy","iamActions":[{"name":"webHosting:apiovh:database/copy/create","required":true}]}],"description":"List the hosting.web.database.copy objects"},{"path":"/hosting/web/{serviceName}/database/{name}/copy/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Copy id"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a database copy","iamActions":[{"name":"webHosting:apiovh:database/copy/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Copy id"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.database.copy","responseTypes":{"200":"hosting.web.database.copy"},"noAuthentication":false,"description":"Get a database copy","iamActions":[{"name":"webHosting:apiovh:database/copy/get","required":true}]}],"description":"Copy"},{"path":"/hosting/web/{serviceName}/database/{name}/copyRestore","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"copyId","dataType":"uuid","paramType":"body","fullType":"uuid","required":true,"description":"UUID of the copy to restore"},{"name":"flushDatabase","dataType":"boolean","paramType":"body","fullType":"boolean","required":false,"description":"If database will be flushed before importing the dump. Default: false"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Restore a database copy","longDescription":"Restore a database copy. Restores a copy into the database and returns the task. Set flushDatabase to true to empty the database first.","iamActions":[{"name":"webHosting:apiovh:database/copyRestore","required":true}]}],"description":"copyRestore operations"},{"path":"/hosting/web/{serviceName}/database/{name}/dump","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"creationDate.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDate property (>=)"},{"name":"creationDate.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDate property (<=)"},{"name":"deletionDate.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of deletionDate property (>=)"},{"name":"deletionDate.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of deletionDate property (<=)"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"},{"name":"type","dataType":"hosting.web.database.dump.DateEnum","paramType":"query","fullType":"hosting.web.database.dump.DateEnum","required":false,"description":"Filter the value of type property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List database dumps","longDescription":"List database dumps. Returns the IDs of the dumps of the database. Filter them by creation or deletion date.","iamActions":[{"name":"webHosting:apiovh:database/dump/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"date","dataType":"hosting.web.database.dump.DateEnum","paramType":"body","fullType":"hosting.web.database.dump.DateEnum","required":true,"description":"The date you want to dump"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"sendEmail","dataType":"boolean","paramType":"body","fullType":"boolean","required":false,"description":"Send an email when dump will be available? Default: true"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Create a database dump","longDescription":"Create a database dump. Creates a dump of the current database or of a daily or weekly backup, and returns the task. An email is sent when the dump is ready, unless sendEmail is false.","iamActions":[{"name":"webHosting:apiovh:database/dump/create","required":true}]}],"description":"List the hosting.web.database.dump objects"},{"path":"/hosting/web/{serviceName}/database/{name}/dump/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Dump id"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Delete a database dump","iamActions":[{"name":"webHosting:apiovh:database/dump/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Dump id"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.database.dump","responseTypes":{"200":"hosting.web.database.dump"},"noAuthentication":false,"description":"Get a database dump","iamActions":[{"name":"webHosting:apiovh:database/dump/get","required":true}]}],"description":"Dump"},{"path":"/hosting/web/{serviceName}/database/{name}/dump/{id}/restore","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Dump id"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Restore a database dump","iamActions":[{"name":"webHosting:apiovh:database/dump/restore","required":true}]}],"description":"restore operations"},{"path":"/hosting/web/{serviceName}/database/{name}/import","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"documentId","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Documents ID of the dump from /me/documents"},{"name":"flushDatabase","dataType":"boolean","paramType":"body","fullType":"boolean","required":false,"description":"If database will be flushed before importing the dump. Default: false"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"sendEmail","dataType":"boolean","paramType":"body","fullType":"boolean","required":false,"description":"Send an email when the import will be done? Default: false"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Import a dump","longDescription":"Import a dump. Imports a dump file uploaded with /me/documents into the database, and returns the task. Set flushDatabase to true to empty the database first.","iamActions":[{"name":"webHosting:apiovh:database/import","required":true}]}],"description":"import operations"},{"path":"/hosting/web/{serviceName}/database/{name}/metricsToken","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.database.MetricsToken","responseTypes":{"200":"hosting.web.database.MetricsToken"},"noAuthentication":false,"description":"Get a database metrics token","longDescription":"Get a database metrics token. Generates a token to read the database metrics and returns it with the endpoint to query.","iamActions":[{"name":"webHosting:apiovh:database/metricsToken/get","required":true}]}],"description":"metricsToken operations"},{"path":"/hosting/web/{serviceName}/database/{name}/request","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"action","dataType":"hosting.web.database.RequestActionEnum","paramType":"body","fullType":"hosting.web.database.RequestActionEnum","required":true,"description":"Action you want to request"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Run a database action","longDescription":"Run a database action. Runs an action on the database and returns the task. CHECK_QUOTA refreshes the space used by the database.","iamActions":[{"name":"webHosting:apiovh:database/request/create","required":true}]}],"description":"request operations"},{"path":"/hosting/web/{serviceName}/database/{name}/restore","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"date","dataType":"hosting.web.database.dump.DateEnum","paramType":"body","fullType":"hosting.web.database.dump.DateEnum","required":true,"description":"The date you want to dump"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"sendEmail","dataType":"boolean","paramType":"body","fullType":"boolean","required":false,"description":"Send an email when the restore will be done? Default: false"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Restore a database backup","longDescription":"Restore a database backup. Restores the database from a daily or weekly backup and returns the task. Set sendEmail to true to receive an email when it is done.","iamActions":[{"name":"webHosting:apiovh:database/restore","required":true}]}],"description":"restore operations"},{"path":"/hosting/web/{serviceName}/database/{name}/statistics","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)"},{"name":"period","dataType":"hosting.web.StatisticsPeriodEnum","paramType":"query","fullType":"hosting.web.StatisticsPeriodEnum","required":true,"description":"Available periods for statistics"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"},{"name":"type","dataType":"hosting.web.database.StatisticsTypeEnum","paramType":"query","fullType":"hosting.web.database.StatisticsTypeEnum","required":true,"description":"Types of statistics available for the database"}],"responseType":"complexType.ChartSerie<complexType.ChartTimestampValue>[]","responseTypes":{"200":"complexType.ChartSerie<complexType.ChartTimestampValue>[]"},"noAuthentication":false,"description":"Get database statistics","longDescription":"Get database statistics. Returns the number of statements or their mean execution time over a period.","iamActions":[{"name":"webHosting:apiovh:database/statistics/get","required":true}]}],"description":"statistics operations"},{"path":"/hosting/web/{serviceName}/databaseAvailableType","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.database.DatabaseTypeEnum[]","responseTypes":{"200":"hosting.web.database.DatabaseTypeEnum[]"},"noAuthentication":false,"description":"List database types","iamActions":[{"name":"webHosting:apiovh:databaseAvailableType/get","required":true}]}],"description":"databaseAvailableType operations"},{"path":"/hosting/web/{serviceName}/databaseAvailableVersion","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"},{"name":"type","dataType":"hosting.web.database.DatabaseTypeEnum","paramType":"query","fullType":"hosting.web.database.DatabaseTypeEnum","required":true,"description":"Type of the database"}],"responseType":"hosting.web.database.AvailableVersionStruct","responseTypes":{"200":"hosting.web.database.AvailableVersionStruct"},"noAuthentication":false,"description":"List database versions","iamActions":[{"name":"webHosting:apiovh:databaseAvailableVersion/get","required":true}]}],"description":"databaseAvailableVersion operations"},{"path":"/hosting/web/{serviceName}/databaseCreationCapabilities","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.database.CreationDatabaseCapabilities[]","responseTypes":{"200":"hosting.web.database.CreationDatabaseCapabilities[]"},"noAuthentication":false,"description":"Get database creation capabilities","longDescription":"Get database creation capabilities. Returns, for each database offer of the hosting, the engines, the quota and the number of databases left to create.","iamActions":[{"name":"webHosting:apiovh:databaseCreationCapabilities/get","required":true}]}],"description":"databaseCreationCapabilities operations"},{"path":"/hosting/web/{serviceName}/dump","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"creationDate.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDate property (>=)"},{"name":"creationDate.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDate property (<=)"},{"name":"databaseName","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of databaseName property (=)"},{"name":"deletionDate.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of deletionDate property (>=)"},{"name":"deletionDate.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of deletionDate property (<=)"},{"name":"orphan","dataType":"boolean","paramType":"query","fullType":"boolean","required":false,"description":"Filter the value of orphan property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List dumps","longDescription":"List dumps. Returns the IDs of the database dumps of the hosting, including those of deleted databases. Filter them by database, date or orphan.","iamActions":[{"name":"webHosting:apiovh:dump/get","required":true}]}],"description":"List the hosting.web.dump objects"},{"path":"/hosting/web/{serviceName}/dump/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Dump id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Delete a dump","iamActions":[{"name":"webHosting:apiovh:dump/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Dump id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.dump","responseTypes":{"200":"hosting.web.dump"},"noAuthentication":false,"description":"Get a dump","longDescription":"Get a dump. Returns the source database, status, type, download URL and automatic deletion date of the dump.","iamActions":[{"name":"webHosting:apiovh:dump/get","required":true}]}],"description":"Dump"},{"path":"/hosting/web/{serviceName}/email","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.email","responseTypes":{"200":"hosting.web.email"},"noAuthentication":false,"description":"Get the email state","longDescription":"Get the email state. Returns the state of the emails sent by the hosting scripts, with the volumes sent, the bounces and the daily limit.","iamActions":[{"name":"webHosting:apiovh:email/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.email","paramType":"body","fullType":"hosting.web.email","required":true,"description":"New object properties"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update the email settings","iamActions":[{"name":"webHosting:apiovh:email/edit","required":true}]}],"description":"Hosting automated emails"},{"path":"/hosting/web/{serviceName}/email/bounces","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"limit","dataType":"long","paramType":"query","fullType":"long","required":true,"description":"Maximum bounces limit ( default : 20 / max : 100 )"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.mail.Bounce[]","responseTypes":{"200":"hosting.web.mail.Bounce[]"},"noAuthentication":false,"description":"List email bounces","longDescription":"List email bounces. Returns the last bounces of the emails sent by the hosting: 20 by default, 100 at most with limit.","iamActions":[{"name":"webHosting:apiovh:email/bounces/get","required":true}]}],"description":"bounces operations"},{"path":"/hosting/web/{serviceName}/email/request","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"action","dataType":"hosting.web.mail.ActionEnum","paramType":"body","fullType":"hosting.web.mail.ActionEnum","required":true,"description":"Action you want to request"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Run an email action","longDescription":"Run an email action. Blocks or unblocks the emails sent by the hosting scripts, or purges the queue of emails waiting to be sent.","iamActions":[{"name":"webHosting:apiovh:email/request/create","required":true}]}],"description":"request operations"},{"path":"/hosting/web/{serviceName}/email/volumes","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.mail.VolumeHistory[]","responseTypes":{"200":"hosting.web.mail.VolumeHistory[]"},"noAuthentication":false,"description":"Get email volume history","iamActions":[{"name":"webHosting:apiovh:email/volumes/get","required":true}]}],"description":"volumes operations"},{"path":"/hosting/web/{serviceName}/emailOption","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List email options","iamActions":[{"name":"webHosting:apiovh:emailOption/get","required":true}]}],"description":"List the hosting.web.emailoption objects"},{"path":"/hosting/web/{serviceName}/emailOption/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.emailoption","responseTypes":{"200":"hosting.web.emailoption"},"noAuthentication":false,"description":"Get an email option","iamActions":[{"name":"webHosting:apiovh:emailOption/get","required":true}]}],"description":"Mail service linked to webhosting"},{"path":"/hosting/web/{serviceName}/emailOption/{id}/serviceInfos","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Get email option service information","longDescription":"Get email option service information. Returns the billing information of the email option: creation and expiration dates, renewal settings and contacts.","iamActions":[{"name":"webHosting:apiovh:emailOption/serviceInfos/get","required":true}]}],"description":"serviceInfos operations"},{"path":"/hosting/web/{serviceName}/emailOption/{id}/terminate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Terminate an email option","iamActions":[{"name":"webHosting:apiovh:emailOption/terminate","required":true}]}],"description":"terminate operations"},{"path":"/hosting/web/{serviceName}/envVar","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"type","dataType":"hosting.web.envVar.TypeEnum","paramType":"query","fullType":"hosting.web.envVar.TypeEnum","required":false,"description":"Filter the value of type property (=)"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"iamActions":[{"name":"webHosting:apiovh:envVar/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"hosting.web.EnvVarInput","paramType":"body","fullType":"hosting.web.EnvVarInput","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"iamActions":[{"name":"webHosting:apiovh:envVar/create","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/envVar/{key}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"key","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Key"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"iamActions":[{"name":"webHosting:apiovh:envVar/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"key","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Key"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.EnvVar","responseTypes":{"200":"hosting.web.EnvVar"},"noAuthentication":false,"iamActions":[{"name":"webHosting:apiovh:envVar/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.EnvVar","paramType":"body","fullType":"hosting.web.EnvVar","required":true,"description":"Request Body"},{"name":"key","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Key"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"iamActions":[{"name":"webHosting:apiovh:envVar/edit","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/extraSqlPerso","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List extra SQL options","iamActions":[{"name":"webHosting:apiovh:extraSqlPerso/get","required":true}]}],"description":"List the hosting.web.extrasqlperso objects"},{"path":"/hosting/web/{serviceName}/extraSqlPerso/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Identifier of the (additional) SQL slot"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.extrasqlperso","responseTypes":{"200":"hosting.web.extrasqlperso"},"noAuthentication":false,"description":"Get an extra SQL option","longDescription":"Get an extra SQL option. Returns the number of databases allowed, the quota per database, the linked databases and the status of the option.","iamActions":[{"name":"webHosting:apiovh:extraSqlPerso/get","required":true}]}],"description":"Sqlperso service"},{"path":"/hosting/web/{serviceName}/extraSqlPerso/{id}/databases","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Identifier of the (additional) SQL slot"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List extra SQL option databases","iamActions":[{"name":"webHosting:apiovh:extraSqlPerso/databases/get","required":true}]}],"description":"databases operations"},{"path":"/hosting/web/{serviceName}/extraSqlPerso/{id}/serviceInfos","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Identifier of the (additional) SQL slot"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Get extra SQL option service information","longDescription":"Get extra SQL option service information. Returns the billing information of the option: creation and expiration dates, renewal settings and contacts.","iamActions":[{"name":"webHosting:apiovh:extraSqlPerso/serviceInfos/get","required":true}]}],"description":"serviceInfos operations"},{"path":"/hosting/web/{serviceName}/extraSqlPerso/{id}/serviceInfosUpdate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Identifier of the (additional) SQL slot"},{"name":"renew","dataType":"service.RenewType","paramType":"body","fullType":"service.RenewType","required":true,"description":"Renew type"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update extra SQL option renewal","iamActions":[{"name":"webHosting:apiovh:extraSqlPerso/serviceInfosUpdate/create","required":true}]}],"description":"serviceInfosUpdate operations"},{"path":"/hosting/web/{serviceName}/extraSqlPerso/{id}/terminate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Identifier of the (additional) SQL slot"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Terminate an extra SQL option","iamActions":[{"name":"webHosting:apiovh:extraSqlPerso/terminate","required":true}]}],"description":"terminate operations"},{"path":"/hosting/web/{serviceName}/freedom","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"status","dataType":"hosting.web.freedom.StatusEnum","paramType":"query","fullType":"hosting.web.freedom.StatusEnum","required":false,"description":"Filter the freedom status (=)"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List free domains","longDescription":"Returns the free domain names included with the hosting offer. Filter them by status.","iamActions":[{"name":"webHosting:apiovh:freedom/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/indy","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of login property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List independent users","longDescription":"List independent users. Returns the logins of the independent multidomain users of the hosting. Filter them by login.","iamActions":[{"name":"webHosting:apiovh:indy/get","required":true}]}],"description":"List the hosting.web.indy objects"},{"path":"/hosting/web/{serviceName}/indy/{login}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Login of the multidomain independent user"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.indy","responseTypes":{"200":"hosting.web.indy"},"noAuthentication":false,"description":"Get an independent user","longDescription":"Get an independent user. Returns the home directory, state and attached domains of the independent multidomain user.","iamActions":[{"name":"webHosting:apiovh:indy/get","required":true}]}],"description":"Hosting indys"},{"path":"/hosting/web/{serviceName}/key/ssh","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.Key","responseTypes":{"200":"hosting.web.Key"},"noAuthentication":false,"description":"Get the SSH public key","longDescription":"Returns the SSH public key of the hosting.","iamActions":[{"name":"webHosting:apiovh:key/ssh/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.Key","responseTypes":{"200":"hosting.web.Key"},"noAuthentication":false,"description":"Generate an SSH key pair","longDescription":"Generates an SSH key pair for the hosting and returns its public key.","iamActions":[{"name":"webHosting:apiovh:key/ssh/create","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/localSeo/account","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"email","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of email property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List local SEO accounts","longDescription":"List local SEO accounts. Returns the IDs of the local SEO accounts of the hosting. Filter them by email.","iamActions":[{"name":"webHosting:apiovh:localSeo/account/get","required":true}]}],"description":"List the hosting.web.localSeo.account objects"},{"path":"/hosting/web/{serviceName}/localSeo/account/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Account id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.localSeo.account","responseTypes":{"200":"hosting.web.localSeo.account"},"noAuthentication":false,"description":"Get a local SEO account","iamActions":[{"name":"webHosting:apiovh:localSeo/account/get","required":true}]}],"description":"Local SEO accounts"},{"path":"/hosting/web/{serviceName}/localSeo/account/{id}/login","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Account id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Log in to a local SEO account","longDescription":"Log in to a local SEO account. Returns a single sign-on URL, with an authentication token, to log in to the local SEO account.","iamActions":[{"name":"webHosting:apiovh:localSeo/account/login","required":true}]}],"description":"login operations"},{"path":"/hosting/web/{serviceName}/localSeo/emailAvailability","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"email","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"The email address to check"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.localSeo.EmailAvailability","responseTypes":{"200":"hosting.web.localSeo.EmailAvailability"},"noAuthentication":false,"description":"Check local SEO email availability","longDescription":"Check local SEO email availability. Returns whether an email address can be used for a local SEO order, and the hosting already using it.","iamActions":[{"name":"webHosting:apiovh:localSeo/emailAvailability/get","required":true}]}],"description":"emailAvailability operations"},{"path":"/hosting/web/{serviceName}/localSeo/location","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List local SEO locations","iamActions":[{"name":"webHosting:apiovh:localSeo/location/get","required":true}]}],"description":"List the hosting.web.localSeo.location objects"},{"path":"/hosting/web/{serviceName}/localSeo/location/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Location id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.localSeo.location","responseTypes":{"200":"hosting.web.localSeo.location"},"noAuthentication":false,"description":"Get a local SEO location","iamActions":[{"name":"webHosting:apiovh:localSeo/location/get","required":true}]}],"description":"Local SEO locations"},{"path":"/hosting/web/{serviceName}/localSeo/location/{id}/serviceInfos","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Location id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Get location service information","longDescription":"Get location service information. Returns the billing information of the location: creation and expiration dates, renewal settings and contacts.","iamActions":[{"name":"webHosting:apiovh:localSeo/location/serviceInfos/get","required":true}]}],"description":"serviceInfos operations"},{"path":"/hosting/web/{serviceName}/localSeo/location/{id}/serviceInfosUpdate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Location id"},{"name":"renew","dataType":"service.RenewType","paramType":"body","fullType":"service.RenewType","required":true,"description":"Renew type"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update location renewal","iamActions":[{"name":"webHosting:apiovh:localSeo/location/serviceInfosUpdate","required":true}]}],"description":"serviceInfosUpdate operations"},{"path":"/hosting/web/{serviceName}/localSeo/location/{id}/terminate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Location id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Terminate a local SEO location","iamActions":[{"name":"webHosting:apiovh:localSeo/location/terminate","required":true}]}],"description":"terminate operations"},{"path":"/hosting/web/{serviceName}/log/kind","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List log kinds","longDescription":"Returns the names of the log kinds Web Hosting emits, which can be forwarded to a stream.","iamActions":[{"name":"webHosting:apiovh:log/kind/get","required":true}]}],"description":"Access to available log kind"},{"path":"/hosting/web/{serviceName}/log/kind/{name}","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Name"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"dbaas.logs.LogKind","responseTypes":{"200":"dbaas.logs.LogKind"},"noAuthentication":false,"description":"Get a log kind","longDescription":"Returns a log kind and the additional fields its logs carry.","iamActions":[{"name":"webHosting:apiovh:log/kind/get","required":true}]}],"description":"Access to available log kind"},{"path":"/hosting/web/{serviceName}/log/subscription","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"httpMethod":"GET","parameters":[{"name":"kind","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter on a specific kind (e.g., audit)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"uuid[]","responseTypes":{"200":"uuid[]"},"noAuthentication":false,"description":"List log subscriptions","longDescription":"Returns the identifiers of the Web Hosting log subscriptions. Set `kind` to restrict the list to one log kind.","iamActions":[{"name":"webHosting:apiovh:log/subscription/get","required":true}]},{"apiStatus":{"description":"Beta version","value":"BETA"},"httpMethod":"POST","parameters":[{"dataType":"dbaas.logs.LogSubscriptionCreation","paramType":"body","fullType":"dbaas.logs.LogSubscriptionCreation","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"dbaas.logs.LogSubscriptionResponse","responseTypes":{"200":"dbaas.logs.LogSubscriptionResponse"},"noAuthentication":false,"description":"Create a log subscription","longDescription":"Forwards Web Hosting logs of one kind to a Logs Data Platform stream. The subscription is created asynchronously and the response returns the operation identifier.","iamActions":[{"name":"webHosting:apiovh:log/subscription/create","required":true},{"name":"ldp:apiovh:output/graylog/stream/forwardTo","description":"Required on the targeted LDP service","required":true}]}],"description":"Create a subscription from Web Hosting logs to a pre-existing LDP stream"},{"path":"/hosting/web/{serviceName}/log/subscription/{subscriptionId}","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"httpMethod":"DELETE","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"subscriptionId","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Subscription ID"}],"responseType":"dbaas.logs.LogSubscriptionResponse","responseTypes":{"200":"dbaas.logs.LogSubscriptionResponse"},"noAuthentication":false,"description":"Delete a log subscription","longDescription":"Deletes the subscription and stops forwarding Web Hosting logs to the stream.","iamActions":[{"name":"webHosting:apiovh:log/subscription/delete","required":true}]},{"apiStatus":{"description":"Beta version","value":"BETA"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"subscriptionId","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Subscription ID"}],"responseType":"dbaas.logs.LogSubscription","responseTypes":{"200":"dbaas.logs.LogSubscription"},"noAuthentication":false,"description":"Get a log subscription","longDescription":"Returns the log kind and the destination stream of a subscription.","iamActions":[{"name":"webHosting:apiovh:log/subscription/get","required":true}]}],"description":"Create a subscription from Web Hosting logs to a pre-existing LDP stream"},{"path":"/hosting/web/{serviceName}/log/url","operations":[{"apiStatus":{"description":"Beta version","value":"BETA"},"httpMethod":"POST","parameters":[{"dataType":"dbaas.logs.LogUrlCreation","paramType":"body","fullType":"dbaas.logs.LogUrlCreation","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"dbaas.logs.TemporaryLogsLink","responseTypes":{"200":"dbaas.logs.TemporaryLogsLink"},"noAuthentication":false,"description":"Generate a temporary log URL","longDescription":"Generates a temporary URL to read the logs of one kind. The URL expires.","iamActions":[{"name":"webHosting:apiovh:log/url/create","required":true}]}],"description":"Generate a temporary URL to retrieve logs"},{"path":"/hosting/web/{serviceName}/metricsToken","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.MetricsToken","responseTypes":{"200":"hosting.web.MetricsToken"},"noAuthentication":false,"description":"Get a metrics token","longDescription":"Returns a token to read the hosting metrics, the endpoint to query and the token expiration date.","iamActions":[{"name":"webHosting:apiovh:metricsToken/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/module","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List installed modules","iamActions":[{"name":"webHosting:apiovh:module/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"adminName","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The login for the admin account (may be a standard string or your email)"},{"name":"adminPassword","dataType":"password","paramType":"body","fullType":"password","required":false,"description":"The password for the admin account (at least 8 characters)"},{"name":"dependencies","dataType":"hosting.web.module.DependencyType[]","paramType":"body","fullType":"hosting.web.module.DependencyType[]","required":false,"description":"The dependencies that we have to configure on your module. A dependency can be a standard database (like MySQL or PostgreSQL) or a key-value store (like Redis or Memcached) for example"},{"name":"domain","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"On which domain the module has to be available (it can be a multidomain or a subdomain) - if not set, the module will be available on your serviceName domain"},{"name":"language","dataType":"hosting.web.module.LanguageEnum","paramType":"body","fullType":"hosting.web.module.LanguageEnum","required":false,"description":"The language to set to your module"},{"name":"moduleId","dataType":"long","paramType":"body","fullType":"long","required":true,"description":"ID of the module you want to install"},{"name":"path","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"Where to install the module, relative to your home directory"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Install a module","longDescription":"Install a module. Installs a module from the available modules in a folder of the hosting, with its admin account and dependencies, and returns the task. The admin password needs at least 8 characters.","iamActions":[{"name":"webHosting:apiovh:module/create","required":true}]}],"description":"List the hosting.web.module objects"},{"path":"/hosting/web/{serviceName}/module/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Installation ID"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Delete an installed module","iamActions":[{"name":"webHosting:apiovh:module/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Installation ID"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.module","responseTypes":{"200":"hosting.web.module"},"noAuthentication":false,"description":"Get an installed module","longDescription":"Get an installed module. Returns the path, URL, admin login, language, dependencies and status of the installed module.","iamActions":[{"name":"webHosting:apiovh:module/get","required":true}]}],"description":"Hosting modules installed"},{"path":"/hosting/web/{serviceName}/ovhConfig","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"historical","dataType":"boolean","paramType":"query","fullType":"boolean","required":false,"description":"Filter the value of historical property (=)"},{"name":"path","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of path property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List .ovhconfig files","longDescription":"List .ovhconfig files. Returns the IDs of the .ovhconfig configurations of the hosting. Filter them by path, or by historical to include old ones.","iamActions":[{"name":"webHosting:apiovh:ovhConfig/get","required":true}]}],"description":"List the hosting.web.ovhConfig objects"},{"path":"/hosting/web/{serviceName}/ovhConfig/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Configuration's id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.ovhConfig","responseTypes":{"200":"hosting.web.ovhConfig"},"noAuthentication":false,"description":"Get a .ovhconfig file","longDescription":"Get a .ovhconfig file. Returns the engine, version, container, environment, HTTP firewall and status of the configuration of a folder.","iamActions":[{"name":"webHosting:apiovh:ovhConfig/get","required":true}]}],"description":"Virtual service"},{"path":"/hosting/web/{serviceName}/ovhConfig/{id}/changeConfiguration","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"container","dataType":"hosting.web.ovhconfig.ContainerEnum","paramType":"body","fullType":"hosting.web.ovhconfig.ContainerEnum","required":false,"description":"Container to run this website"},{"name":"engineName","dataType":"hosting.web.ovhConfig.EngineNameEnum","paramType":"body","fullType":"hosting.web.ovhConfig.EngineNameEnum","required":false,"description":"Version of engine you want"},{"name":"engineVersion","dataType":"hosting.web.ovhConfig.AvailableEngineVersionEnum","paramType":"body","fullType":"hosting.web.ovhConfig.AvailableEngineVersionEnum","required":false,"description":"Name of engine you want"},{"name":"environment","dataType":"hosting.web.ovhConfig.EnvironmentEnum","paramType":"body","fullType":"hosting.web.ovhConfig.EnvironmentEnum","required":false,"description":"Environment configuration you want"},{"name":"httpFirewall","dataType":"hosting.web.ovhConfig.HttpFirewallEnum","paramType":"body","fullType":"hosting.web.ovhConfig.HttpFirewallEnum","required":false,"description":"Configuration you want for http firewall"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Configuration's id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Change a .ovhconfig file","longDescription":"Change a .ovhconfig file. Applies a new engine, version, container, environment or HTTP firewall setting to the folder, and returns the task.","iamActions":[{"name":"webHosting:apiovh:ovhConfig/changeConfiguration","required":true}]}],"description":"changeConfiguration operations"},{"path":"/hosting/web/{serviceName}/ovhConfig/{id}/rollback","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Configuration's id"},{"name":"rollbackId","dataType":"long","paramType":"body","fullType":"long","required":true,"description":"The configuration's id you want to rollback"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Roll back a .ovhconfig file","longDescription":"Roll back a .ovhconfig file. Restores the old configuration given by rollbackId and returns the task.","iamActions":[{"name":"webHosting:apiovh:ovhConfig/rollback","required":true}]}],"description":"rollback operations"},{"path":"/hosting/web/{serviceName}/ovhConfigCapabilities","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.OvhConfigCapabilities[]","responseTypes":{"200":"hosting.web.OvhConfigCapabilities[]"},"noAuthentication":false,"description":"List .ovhconfig capabilities","longDescription":"List .ovhconfig capabilities. Returns the PHP versions and container images available on the hosting.","iamActions":[{"name":"webHosting:apiovh:ovhConfigCapabilities/get","required":true}]}],"description":"ovhConfigCapabilities operations"},{"path":"/hosting/web/{serviceName}/ovhConfigRecommendedValues","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.OvhConfigRecommendedValues","responseTypes":{"200":"hosting.web.OvhConfigRecommendedValues"},"noAuthentication":false,"description":"Get recommended .ovhconfig values","longDescription":"Get recommended .ovhconfig values. Returns the recommended engine, version, container, environment and HTTP firewall for the .ovhconfig file.","iamActions":[{"name":"webHosting:apiovh:ovhConfigRecommendedValues/get","required":true}]}],"description":"ovhConfigRecommendedValues operations"},{"path":"/hosting/web/{serviceName}/ovhConfigRefresh","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Refresh .ovhconfig files","longDescription":"Refresh .ovhconfig files. Synchronizes the list of configurations with the .ovhconfig files on the hosting, and returns the task.","iamActions":[{"name":"webHosting:apiovh:ovhConfig/refresh","required":true}]}],"description":"ovhConfigRefresh operations"},{"path":"/hosting/web/{serviceName}/ownLogs","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"fqdn","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of fqdn property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List own logs","longDescription":"List own logs. Returns the IDs of the own logs of the hosting, which separate the logs and statistics of a domain. Filter them by FQDN.","iamActions":[{"name":"webHosting:apiovh:ownLogs/get","required":true}]}],"description":"List the hosting.web.ownLogs objects"},{"path":"/hosting/web/{serviceName}/ownLogs/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.ownLogs","responseTypes":{"200":"hosting.web.ownLogs"},"noAuthentication":false,"description":"Get own logs","iamActions":[{"name":"webHosting:apiovh:ownLogs/get","required":true}]}],"description":"Hosting own logs"},{"path":"/hosting/web/{serviceName}/ownLogs/{id}/userLogs","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of login property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List log users","longDescription":"List log users. Returns the logins of the users allowed to access the logs interface. Filter them by login.","iamActions":[{"name":"webHosting:apiovh:ownLogs/userLogs/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"description","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Description field for you"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"The userLogs login used to connect to logs.ovh.net"},{"name":"ownLogsId","dataType":"long","paramType":"body","fullType":"long","required":false,"description":"OwnLogs where this userLogs will be enable. Default : main domain ownlogs"},{"name":"password","dataType":"password","paramType":"body","fullType":"password","required":true,"description":"The new userLogs password"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Create a log user","longDescription":"Create a log user. Creates a user allowed to access the logs interface. Without ownLogsId, the user accesses the logs of the main domain.","iamActions":[{"name":"webHosting:apiovh:ownLogs/userLogs/create","required":true}]}],"description":"List the hosting.web.userLogs objects"},{"path":"/hosting/web/{serviceName}/ownLogs/{id}/userLogs/{login}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The userLogs login used to connect to logs.ovh.net"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Delete a log user","iamActions":[{"name":"webHosting:apiovh:ownLogs/userLogs/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The userLogs login used to connect to logs.ovh.net"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.userLogs","responseTypes":{"200":"hosting.web.userLogs"},"noAuthentication":false,"description":"Get a log user","iamActions":[{"name":"webHosting:apiovh:ownLogs/userLogs/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.userLogs","paramType":"body","fullType":"hosting.web.userLogs","required":true,"description":"New object properties"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The userLogs login used to connect to logs.ovh.net"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a log user","iamActions":[{"name":"webHosting:apiovh:ownLogs/userLogs/edit","required":true}]}],"description":"Hosting users logs"},{"path":"/hosting/web/{serviceName}/ownLogs/{id}/userLogs/{login}/changePassword","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The userLogs login used to connect to logs.ovh.net"},{"name":"password","dataType":"password","paramType":"body","fullType":"password","required":true,"description":"The new userLogs password"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Change a log user password","iamActions":[{"name":"webHosting:apiovh:ownLogs/userLogs/changePassword","required":true}]}],"description":"changePassword operations"},{"path":"/hosting/web/{serviceName}/privateDatabaseCreationCapabilities","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.database.CreationDatabaseCapabilities[]","responseTypes":{"200":"hosting.web.database.CreationDatabaseCapabilities[]"},"noAuthentication":false,"description":"Get private database creation capabilities","longDescription":"Get private database creation capabilities. Returns, for each private database offer, the engines, the quota and the number of databases left to create.","iamActions":[{"name":"webHosting:apiovh:privateDatabaseCreationCapabilities/get","required":true}]}],"description":"privateDatabaseCreationCapabilities operations"},{"path":"/hosting/web/{serviceName}/privateDatabases","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List linked private databases","longDescription":"List linked private databases. Returns the service names of the private databases linked to the hosting.","iamActions":[{"name":"webHosting:apiovh:privateDatabases/get","required":true}]}],"description":"privateDatabases operations"},{"path":"/hosting/web/{serviceName}/request","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"action","dataType":"hosting.web.RequestActionEnum","paramType":"body","fullType":"hosting.web.RequestActionEnum","required":true,"description":"Action you want to request"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Run an action","longDescription":"Run an action. Checks the quota, flushes the cache or runs an antihack scan on the hosting, and returns the task.","iamActions":[{"name":"webHosting:apiovh:request","required":true}]}],"description":"request operations"},{"path":"/hosting/web/{serviceName}/requestBoost","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"hosting.web.RequestBoostInput","paramType":"body","fullType":"hosting.web.RequestBoostInput","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"description":"Request a boost","longDescription":"Applies the requested boost offer to the hosting and returns the task. Send a null offer to disable the boost.","iamActions":[{"name":"webHosting:apiovh:requestBoost","required":true}]}],"description":"Request to boost a hosting"},{"path":"/hosting/web/{serviceName}/restoreSnapshot","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"backup","dataType":"hosting.web.backup.TypeEnum","paramType":"body","fullType":"hosting.web.backup.TypeEnum","required":true,"description":"The backup you want to restore"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Restore a backup","longDescription":"Restore a backup. Restores the files of the hosting from a daily or weekly backup and returns the task. All current files are replaced by the backup. Databases are not restored.","iamActions":[{"name":"webHosting:apiovh:restoreSnapshot","required":true}]}],"description":"restoreSnapshot operations"},{"path":"/hosting/web/{serviceName}/runtime","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of name property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"},{"name":"type","dataType":"hosting.web.runtime.TypeEnum","paramType":"query","fullType":"hosting.web.runtime.TypeEnum","required":false,"description":"Filter the value of type property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List runtime configurations","longDescription":"List runtime configurations. Returns the IDs of the runtime configurations of the hosting. Filter them by name or type.","iamActions":[{"name":"webHosting:apiovh:runtime/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"appBootstrap","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The client application bootstrap script"},{"name":"appEnv","dataType":"hosting.web.runtime.EnvEnum","paramType":"body","fullType":"hosting.web.runtime.EnvEnum","required":false,"description":"The client application environment"},{"name":"attachedDomains","dataType":"string[]","paramType":"body","fullType":"string[]","required":false,"description":"The attached domains fqdn to link to this runtime configuration"},{"name":"isDefault","dataType":"boolean","paramType":"body","fullType":"boolean","required":false,"description":"Set if the runtime configuration is the one by default for the hosting"},{"name":"name","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The custom display name of the runtime configuration"},{"name":"publicDir","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The client application public directory"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"},{"name":"type","dataType":"hosting.web.runtime.TypeEnum","paramType":"body","fullType":"hosting.web.runtime.TypeEnum","required":false,"description":"The backend type of a runtime configuration"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Create a runtime configuration","longDescription":"Create a runtime configuration. Creates a runtime configuration with a backend type, an environment, a bootstrap script and a public directory, linked to attached domains, and returns the task.","iamActions":[{"name":"webHosting:apiovh:runtime/create","required":true}]}],"description":"List the hosting.web.runtime objects"},{"path":"/hosting/web/{serviceName}/runtime/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"The runtime configuration ID"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Delete a runtime configuration","longDescription":"Delete a runtime configuration. Deletes the runtime configuration and returns the task. Only a configuration with isDeletable set to true can be deleted.","iamActions":[{"name":"webHosting:apiovh:runtime/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"The runtime configuration ID"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.runtime","responseTypes":{"200":"hosting.web.runtime"},"noAuthentication":false,"description":"Get a runtime configuration","longDescription":"Get a runtime configuration. Returns the backend type, environment, bootstrap script, public directory and status of the runtime configuration.","iamActions":[{"name":"webHosting:apiovh:runtime/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.runtime","paramType":"body","fullType":"hosting.web.runtime","required":true,"description":"New object properties"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"The runtime configuration ID"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a runtime configuration","longDescription":"Update a runtime configuration. Updates the name, backend type, environment, bootstrap script, public directory or default status of the runtime configuration.","iamActions":[{"name":"webHosting:apiovh:runtime/edit","required":true}]}],"description":"The runtime configuration of an attached domain for cloud web offer"},{"path":"/hosting/web/{serviceName}/runtime/{id}/attachedDomains","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"The runtime configuration ID"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List runtime configuration domains","iamActions":[{"name":"webHosting:apiovh:runtime/attachedDomains/get","required":true}]}],"description":"attachedDomains operations"},{"path":"/hosting/web/{serviceName}/runtimeAvailableTypes","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"language","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Specific programming language to filter"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.runtime.TypeEnum[]","responseTypes":{"200":"hosting.web.runtime.TypeEnum[]"},"noAuthentication":false,"description":"List runtime backend types","longDescription":"List runtime backend types. Returns the backend types available for runtime configurations. Filter them by programming language.","iamActions":[{"name":"webHosting:apiovh:runtimeAvailableTypes/get","required":true}]}],"description":"runtimeAvailableTypes operations"},{"path":"/hosting/web/{serviceName}/serviceInfos","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Get service information","longDescription":"Returns the billing information of the service: creation and expiration dates, renewal settings and contacts.","iamActions":[{"name":"webHosting:apiovh:serviceInfos/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"services.Service","paramType":"body","fullType":"services.Service","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update service information","longDescription":"Updates the renewal settings of the service.","iamActions":[{"name":"webHosting:apiovh:serviceInfos/edit","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/ssl","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.SSL","responseTypes":{"200":"hosting.web.SSL"},"noAuthentication":false,"description":"Delete the SSL certificate","longDescription":"Deletes the SSL certificate of the hosting.","iamActions":[{"name":"webHosting:apiovh:ssl/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.SSL","responseTypes":{"200":"hosting.web.SSL"},"noAuthentication":false,"description":"Get the SSL certificate","longDescription":"Returns the provider, type and status of the SSL certificate of the hosting.","iamActions":[{"name":"webHosting:apiovh:ssl/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"hosting.web.SSLInput","paramType":"body","fullType":"hosting.web.SSLInput","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.SSL","responseTypes":{"200":"hosting.web.SSL"},"noAuthentication":false,"description":"Create or import an SSL certificate","longDescription":"Creates the free Let's Encrypt SSL certificate of the hosting. To import a custom certificate instead, send the certificate, its private key and its chain.","iamActions":[{"name":"webHosting:apiovh:ssl/create","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/ssl/domains","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List SSL certificate domains","longDescription":"Returns the domains covered by the SSL certificate of the hosting.","iamActions":[{"name":"webHosting:apiovh:ssl/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/ssl/regenerate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.SSL","responseTypes":{"200":"hosting.web.SSL"},"noAuthentication":false,"description":"Regenerate the SSL certificate","longDescription":"Regenerates the SSL certificate of the hosting.","iamActions":[{"name":"webHosting:apiovh:ssl/regenerate","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/ssl/report","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.ssl.Report","responseTypes":{"200":"hosting.web.ssl.Report"},"noAuthentication":false,"description":"Get the SSL certificate report","longDescription":"Returns the status of each validation check run by the certification authority for the certificate of the hosting.","iamActions":[{"name":"webHosting:apiovh:ssl/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/statistics","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"period","dataType":"hosting.web.StatisticsPeriodEnum","paramType":"query","fullType":"hosting.web.StatisticsPeriodEnum","required":true,"description":""},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"},{"name":"type","dataType":"hosting.web.StatisticsTypeEnum","paramType":"query","fullType":"hosting.web.StatisticsTypeEnum","required":true,"description":""}],"responseType":"complexType.ChartSerie<complexType.ChartTimestampValue>[]","responseTypes":{"200":"complexType.ChartSerie<complexType.ChartTimestampValue>[]"},"noAuthentication":false,"description":"Get statistics","longDescription":"Get statistics. Returns one statistic of the hosting over a period: HTTP hits, mean response time, FTP commands, outgoing TCP connections, CPU usage or worker overload.","iamActions":[{"name":"webHosting:apiovh:statistics/get","required":true}]}],"description":"statistics operations"},{"path":"/hosting/web/{serviceName}/tasks","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"function","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter tasks by function (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"status","dataType":"hosting.web.task.StatusEnum","paramType":"query","fullType":"hosting.web.task.StatusEnum","required":false,"description":"Filter tasks by status (like)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List tasks","longDescription":"Returns the IDs of the tasks of the hosting. Filter them by function or status.","iamActions":[{"name":"webHosting:apiovh:tasks/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/tasks/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"description":"Get a task","longDescription":"Returns the function, status and dates of the task.","iamActions":[{"name":"webHosting:apiovh:tasks/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/terminate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Request termination","longDescription":"Requests the termination of the service. Confirm it with confirmTermination and the token sent by email.","iamActions":[{"name":"webHosting:apiovh:terminate","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/token","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Get the domain ownership token","longDescription":"Get the domain ownership token. Returns the token that proves the ownership of an external domain. Add it in a TXT record of the ovhcontrol subdomain in the DNS zone.","iamActions":[{"name":"webHosting:apiovh:token/get","required":true}]}],"description":"token operations"},{"path":"/hosting/web/{serviceName}/unblockTCPOut","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Unblock outgoing TCP","longDescription":"Requests the unblocking of the outgoing TCP connections of the hosting, blocked after an abuse. Their current state is outState in the abuse state.","iamActions":[{"name":"webHosting:apiovh:unblockTCPOut","required":true}]}],"description":"Request to unblock TCP out function"},{"path":"/hosting/web/{serviceName}/user","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"home","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of home property (like)"},{"name":"login","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of login property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List users","longDescription":"List users. Returns the logins of the FTP and SSH users of the hosting. Filter them by home or login.","iamActions":[{"name":"webHosting:apiovh:user/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"home","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Home directory"},{"name":"login","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Login use for your new user"},{"name":"password","dataType":"password","paramType":"body","fullType":"password","required":true,"description":"Password"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"},{"name":"sshState","dataType":"hosting.web.user.SshStateEnum","paramType":"body","fullType":"hosting.web.user.SshStateEnum","required":false,"description":"Ssh state for this user. Default: none"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Create a user","longDescription":"Create a user. Creates an FTP and SSH user with a login, a password and a home directory, and returns the task. sshState is none by default.","iamActions":[{"name":"webHosting:apiovh:user/create","required":true}]}],"description":"List the hosting.web.user objects"},{"path":"/hosting/web/{serviceName}/user/{login}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Login used to connect on FTP and SSH"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Delete a user","longDescription":"Delete a user. Permanently deletes the user and returns the task. The files in its home folder are kept.","iamActions":[{"name":"webHosting:apiovh:user/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Login used to connect on FTP and SSH"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.user","responseTypes":{"200":"hosting.web.user"},"noAuthentication":false,"description":"Get a user","iamActions":[{"name":"webHosting:apiovh:user/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.user","paramType":"body","fullType":"hosting.web.user","required":true,"description":"New object properties"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Login used to connect on FTP and SSH"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a user","longDescription":"Update a user. Updates the home directory, SSH state or state of the user. Set state to off to disable the FTP and SSH access of the user.","iamActions":[{"name":"webHosting:apiovh:user/edit","required":true}]}],"description":"Hosting users"},{"path":"/hosting/web/{serviceName}/user/{login}/changePassword","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2026-11-01T00:00:00+01:00","deprecatedDate":"2026-09-01T00:00:00+01:00","replacement":"/hosting/web/{serviceName}/user/{login}"},"httpMethod":"POST","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Login used to connect on FTP and SSH"},{"name":"password","dataType":"password","paramType":"body","fullType":"password","required":true,"description":"The user's new password"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.task","responseTypes":{"200":"hosting.web.task"},"noAuthentication":false,"description":"Change a user password","iamActions":[{"name":"webHosting:apiovh:user/changePassword","required":true}]}],"description":"changePassword operations"},{"path":"/hosting/web/{serviceName}/userLogs","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2024-03-01T00:00:00+01:00","deprecatedDate":"2023-11-03T00:00:00+01:00","replacement":"/hosting/web/{serviceName}/ownLogs/{id}/userLogs"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of login property (like)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List log users","longDescription":"List log users. Returns the logins of the users allowed to access the logs interface. Filter them by login.","iamActions":[{"name":"webHosting:apiovh:userLogs/get","required":true}]},{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2024-03-01T00:00:00+01:00","deprecatedDate":"2023-11-03T00:00:00+01:00","replacement":"/hosting/web/{serviceName}/ownLogs/{id}/userLogs"},"httpMethod":"POST","parameters":[{"name":"description","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Description field for you"},{"name":"login","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"The userLogs login used to connect to logs.ovh.net"},{"name":"ownLogsId","dataType":"long","paramType":"body","fullType":"long","required":false,"description":"OwnLogs where this userLogs will be enable. Default : main domain ownlogs"},{"name":"password","dataType":"password","paramType":"body","fullType":"password","required":true,"description":"The new userLogs password"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Create a log user","longDescription":"Create a log user. Creates a user allowed to access the logs interface. Without ownLogsId, the user accesses the logs of the main domain.","iamActions":[{"name":"webHosting:apiovh:userLogs/create","required":true}]}],"description":"List the hosting.web.userLogs objects"},{"path":"/hosting/web/{serviceName}/userLogs/{login}","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2024-03-01T00:00:00+01:00","deprecatedDate":"2023-11-03T00:00:00+01:00","replacement":"/hosting/web/{serviceName}/ownLogs/{id}/userLogs/{login}"},"httpMethod":"DELETE","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The userLogs login used to connect to logs.ovh.net"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Delete a log user","iamActions":[{"name":"webHosting:apiovh:userLogs/delete","required":true}]},{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2024-03-01T00:00:00+01:00","deprecatedDate":"2023-11-03T00:00:00+01:00","replacement":"/hosting/web/{serviceName}/ownLogs/{id}/userLogs/{login}"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The userLogs login used to connect to logs.ovh.net"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"hosting.web.userLogs","responseTypes":{"200":"hosting.web.userLogs"},"noAuthentication":false,"description":"Get a log user","iamActions":[{"name":"webHosting:apiovh:userLogs/get","required":true}]},{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2024-03-01T00:00:00+01:00","deprecatedDate":"2023-11-03T00:00:00+01:00","replacement":"/hosting/web/{serviceName}/ownLogs/{id}/userLogs/{login}"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.userLogs","paramType":"body","fullType":"hosting.web.userLogs","required":true,"description":"New object properties"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The userLogs login used to connect to logs.ovh.net"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a log user","iamActions":[{"name":"webHosting:apiovh:userLogs/edit","required":true}]}],"description":"Hosting users logs"},{"path":"/hosting/web/{serviceName}/userLogs/{login}/changePassword","operations":[{"apiStatus":{"description":"Deprecated, will be removed","value":"DEPRECATED","deletionDate":"2024-03-01T00:00:00+01:00","deprecatedDate":"2023-11-03T00:00:00+01:00","replacement":"/hosting/web/{serviceName}/ownLogs/{id}/userLogs/{login}"},"httpMethod":"POST","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The userLogs login used to connect to logs.ovh.net"},{"name":"password","dataType":"password","paramType":"body","fullType":"password","required":true,"description":"The new userLogs password"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Change a log user password","iamActions":[{"name":"webHosting:apiovh:userLogs/changePassword","required":true}]}],"description":"changePassword operations"},{"path":"/hosting/web/{serviceName}/userLogsToken","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"attachedDomain","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Specific attached domain to be included in the scope of your token"},{"name":"remoteCheck","dataType":"boolean","paramType":"query","fullType":"boolean","required":false,"description":"Whether to limit the use of the token to the remote IPv4 of API caller"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your hosting"},{"name":"ttl","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Expiration of your token (in seconds)"}],"responseType":"password","responseTypes":{"200":"password"},"noAuthentication":false,"description":"Get a logs interface token","longDescription":"Get a logs interface token. Returns a temporary token to access the logs interface. Set its lifetime in seconds with ttl, its scope with attachedDomain, and remoteCheck to limit it to the caller IP.","iamActions":[{"name":"webHosting:apiovh:userLogsToken/get","required":true}]}],"description":"userLogsToken operations"},{"path":"/hosting/web/{serviceName}/vcs/webhooks","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"path","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"Filter on hosting path"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"},{"name":"vcs","dataType":"hosting.web.SupportedVcsEnum","paramType":"query","fullType":"hosting.web.SupportedVcsEnum","required":true,"description":"Filter on VCS platform"}],"responseType":"hosting.web.VcsWebhooks","responseTypes":{"200":"hosting.web.VcsWebhooks"},"noAuthentication":false,"description":"Get VCS webhook URLs","longDescription":"Returns the webhook URL to call on push events to deploy a website. Filter it by hosting path and VCS platform.","iamActions":[{"name":"webHosting:apiovh:vcs/webhooks/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/website","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"path","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of path property"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List websites","longDescription":"Returns the IDs of the websites of the hosting. Filter them by path.","iamActions":[{"name":"webHosting:apiovh:website/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"hosting.web.website.CreationRequest","paramType":"body","fullType":"hosting.web.website.CreationRequest","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"description":"Create a website","longDescription":"Creates a website in a folder of the hosting, deployed from a repository branch, and returns the task.","iamActions":[{"name":"webHosting:apiovh:website/create","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/website/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"deleteFiles","dataType":"boolean","paramType":"query","fullType":"boolean","required":true,"description":"Whether the website path should be emptied or not"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"description":"Delete a website","longDescription":"Deletes the website and returns the task. Set deleteFiles to true to also empty the website folder.","iamActions":[{"name":"webHosting:apiovh:website/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.Website","responseTypes":{"200":"hosting.web.Website"},"noAuthentication":false,"description":"Get a website","longDescription":"Returns the name, path, status, domains and repository of the website.","iamActions":[{"name":"webHosting:apiovh:website/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"hosting.web.website.Update","paramType":"body","fullType":"hosting.web.website.Update","required":true,"description":"Request Body"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.Website","responseTypes":{"200":"hosting.web.Website"},"noAuthentication":false,"description":"Update a website","longDescription":"Updates the repository branch deployed on the website.","iamActions":[{"name":"webHosting:apiovh:website/edit","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/website/{id}/deploy","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"hosting.web.website.DeploymentRequest","paramType":"body","fullType":"hosting.web.website.DeploymentRequest","required":true,"description":"Request Body"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.PublicTask","responseTypes":{"200":"hosting.web.PublicTask"},"noAuthentication":false,"description":"Deploy a website","longDescription":"Deploys the website from its repository branch and returns the task. Set reset to true to reset the website files before deploying.","iamActions":[{"name":"webHosting:apiovh:website/deploy","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/website/{id}/deployment","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List deployments","longDescription":"Returns the IDs of the deployments of the website.","iamActions":[{"name":"webHosting:apiovh:website/deployment/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/website/{id}/deployment/{deploymentId}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"deploymentId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Deployment ID"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.website.Deployment","responseTypes":{"200":"hosting.web.website.Deployment"},"noAuthentication":false,"description":"Get a deployment","longDescription":"Returns the status, source, branch and last commit of the deployment.","iamActions":[{"name":"webHosting:apiovh:website/deployment/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/website/{id}/deployment/{deploymentId}/logs","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"deploymentId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Deployment ID"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.website.deployment.LogsMessage[]","responseTypes":{"200":"hosting.web.website.deployment.LogsMessage[]"},"noAuthentication":false,"description":"Get deployment logs","longDescription":"Returns the dated log messages of the deployment.","iamActions":[{"name":"webHosting:apiovh:website/deployment/logs/get","required":true}]}],"description":""},{"path":"/hosting/web/{serviceName}/websiteCreationCapabilities","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Service name"}],"responseType":"hosting.web.WebsiteCreationCapabilities","responseTypes":{"200":"hosting.web.WebsiteCreationCapabilities"},"noAuthentication":false,"description":"Get website creation capabilities","longDescription":"Returns the number of existing websites and the number allowed by the offer, -1 meaning unlimited.","iamActions":[{"name":"webHosting:apiovh:websiteCreationCapabilities/get","required":true}]}],"description":""}],"resourcePath":"/hosting/web","basePath":"https://eu.api.ovh.com/1.0","models":{"cdn.DomainStatisticsNameEnum":{"id":"DomainStatisticsNameEnum","namespace":"cdn","description":"Serie Name","enum":["hit","miss"],"enumType":"string"},"cdn.DomainStatisticsPeriodEnum":{"id":"DomainStatisticsPeriodEnum","namespace":"cdn","description":"Statistics Period","enum":["day","month","week","year"],"enumType":"string"},"cdn.DomainStatisticsUnitEnum":{"id":"DomainStatisticsUnitEnum","namespace":"cdn","description":"Serie Unit","enum":["req/min"],"enumType":"string"},"cdn.DomainStatusEnum":{"id":"DomainStatusEnum","namespace":"cdn","description":"Domain status","enum":["deleting","disabled","disabling","ok","refreshing","to_delete","to_disable","to_refresh"],"enumType":"string"},"cdn.OperationFunctionEnum":{"id":"OperationFunctionEnum","namespace":"cdn","description":"Operation function","enum":["analytics_delete","analytics_recompute","domain_delete","domain_disable","domain_purge","domain_refresh","service_install","ssl_delete","ssl_install"],"enumType":"string"},"cdn.OperationOfferEnum":{"id":"OperationOfferEnum","namespace":"cdn","description":"Shared CDN offer","enum":["advanced","basic","security"],"enumType":"string"},"cdn.OperationStatusEnum":{"id":"OperationStatusEnum","namespace":"cdn","description":"Operation status","enum":["cancelled","doing","done","error","todo"],"enumType":"string"},"cdn.OptionCategoryEnum":{"id":"OptionCategoryEnum","namespace":"cdn","description":"Option category","enum":["cache","performance","security"],"enumType":"string"},"cdn.OptionConfigParamTypeEnum":{"id":"OptionConfigParamTypeEnum","namespace":"cdn","description":"Option Config Parameter type","enum":["bool","int","list","str"],"enumType":"string"},"cdn.OptionPatternTypeEnum":{"id":"OptionPatternTypeEnum","namespace":"cdn","description":"Option pattern type","enum":["extension","folder","regex","uri"],"enumType":"string"},"cdn.OptionQueryParametersEnum":{"id":"OptionQueryParametersEnum","namespace":"cdn","description":"Option query parameters","enum":["ignored","sorted"],"enumType":"string"},"cdn.OptionTypeEnum":{"id":"OptionTypeEnum","namespace":"cdn","description":"Option type","enum":["brotli","cache_rule","cors","devmode","geo_headers","hsts","https_redirect","mixed_content","mobile_redirect","prefetch","prewarm","querystring","waf"],"enumType":"string"},"cdn.OptionTypePostEnum":{"id":"OptionTypePostEnum","namespace":"cdn","description":"Option type","enum":["cache_rule"],"enumType":"string"},"cdn.PurgeTypeEnum":{"id":"PurgeTypeEnum","namespace":"cdn","description":"Purge type","enum":["extension","folder","regex","uri"],"enumType":"string"},"cdn.availableOptions":{"id":"availableOptions","namespace":"cdn","description":"Option type available","properties":{"category":{"type":"cdn.OptionCategoryEnum","fullType":"cdn.OptionCategoryEnum","canBeNull":true,"readOnly":true,"description":"Option category","required":false},"config":{"type":"cdn.availableOptions.config","fullType":"cdn.availableOptions.config","canBeNull":true,"readOnly":true,"description":"Option configuration","required":false},"maxItems":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Max option items","required":false},"type":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Option type","required":false}}},"cdn.availableOptions.config":{"id":"config","namespace":"cdn.availableOptions","description":"Option configuration","properties":{"destination":{"type":"cdn.availableOptions.config.constraints","fullType":"cdn.availableOptions.config.constraints","canBeNull":true,"readOnly":true,"description":"URL used for Mobile Redirect","required":false},"followUri":{"type":"cdn.availableOptions.config.constraints","fullType":"cdn.availableOptions.config.constraints","canBeNull":true,"readOnly":true,"description":"Follow Uri on Mobile Redirect","required":false},"origins":{"type":"cdn.availableOptions.config.constraints","fullType":"cdn.availableOptions.config.constraints","canBeNull":true,"readOnly":true,"description":"Authorized Origins separated by a comma","required":false},"patternType":{"type":"cdn.availableOptions.config.constraints","fullType":"cdn.availableOptions.config.constraints","canBeNull":true,"readOnly":true,"description":"Option pattern type","required":false},"priority":{"type":"cdn.availableOptions.config.constraints","fullType":"cdn.availableOptions.config.constraints","canBeNull":true,"readOnly":true,"description":"Cache Rule priority (lower is the strongest priority)","required":false},"queryParameters":{"type":"cdn.availableOptions.config.constraints","fullType":"cdn.availableOptions.config.constraints","canBeNull":true,"readOnly":true,"description":"Action to apply on query parameters","required":false},"resources":{"type":"cdn.availableOptions.config.constraints","fullType":"cdn.availableOptions.config.constraints","canBeNull":true,"readOnly":true,"description":"List of URI","required":false},"statusCode":{"type":"cdn.availableOptions.config.constraints","fullType":"cdn.availableOptions.config.constraints","canBeNull":true,"readOnly":true,"description":"Redirection HTTP Code","required":false},"ttl":{"type":"cdn.availableOptions.config.constraints","fullType":"cdn.availableOptions.config.constraints","canBeNull":true,"readOnly":true,"description":"Cache time in seconds","required":false}}},"cdn.availableOptions.config.constraints":{"id":"constraints","namespace":"cdn.availableOptions.config","description":"Option configuration constraints","properties":{"length":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Maximum number of items in value","required":false},"maximum":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Maximum value","required":false},"message":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Description of value","required":false},"minimum":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Minimum value","required":false},"type":{"type":"cdn.OptionConfigParamTypeEnum","fullType":"cdn.OptionConfigParamTypeEnum","canBeNull":true,"readOnly":true,"description":"Type of value","required":false}}},"cdn.domain":{"id":"domain","namespace":"cdn","description":"Domain details","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Domain name","required":false},"needRefresh":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"The domain configuration has been updated, it needs a refresh","required":false},"status":{"type":"cdn.DomainStatusEnum","fullType":"cdn.DomainStatusEnum","canBeNull":false,"readOnly":true,"description":"Domain status","required":false},"updatedDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last update date","required":false}}},"cdn.domain.add.option":{"id":"option","namespace":"cdn.domain.add","description":"Option details","properties":{"config":{"type":"cdn.domain.option.config","fullType":"cdn.domain.option.config","canBeNull":true,"readOnly":false,"description":"Option configuration","required":false},"enabled":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Enable / Disable the option","required":true},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Option name","required":true},"pattern":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Url pattern","required":false},"type":{"type":"cdn.OptionTypePostEnum","fullType":"cdn.OptionTypePostEnum","canBeNull":false,"readOnly":false,"description":"Option type","required":true}}},"cdn.domain.option":{"id":"option","namespace":"cdn.domain","description":"Option details","properties":{"config":{"type":"cdn.domain.option.config","fullType":"cdn.domain.option.config","canBeNull":true,"readOnly":false,"description":"Option configuration","required":false},"enabled":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Enable / Disable the option","required":true},"extra":{"type":"cdn.domain.option.extra","fullType":"cdn.domain.option.extra","canBeNull":true,"readOnly":false,"description":"Additional information about option","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Option name","required":false},"pattern":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Url pattern","required":false},"type":{"type":"cdn.OptionTypeEnum","fullType":"cdn.OptionTypeEnum","canBeNull":false,"readOnly":false,"description":"Option type","required":true}}},"cdn.domain.option.config":{"id":"config","namespace":"cdn.domain.option","description":"Option configuration","properties":{"destination":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"URL used for Mobile Redirect","required":false},"followUri":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"Follow Uri on Mobile Redirect","required":false},"origins":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Authorized Origins separated by a comma","required":false},"patternType":{"type":"cdn.OptionPatternTypeEnum","fullType":"cdn.OptionPatternTypeEnum","canBeNull":true,"readOnly":false,"description":"Option pattern type","required":false},"priority":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"Cache Rule priority (lower is the strongest priority)","required":false},"queryParameters":{"type":"cdn.OptionQueryParametersEnum","fullType":"cdn.OptionQueryParametersEnum","canBeNull":true,"readOnly":false,"description":"Action to apply on query parameters","required":false},"resources":{"type":"string[]","fullType":"string[]","canBeNull":true,"readOnly":false,"description":"List of URI","required":false},"statusCode":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"Redirection HTTP Code","required":false},"ttl":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"Cache time in seconds","required":false}}},"cdn.domain.option.extra":{"id":"extra","namespace":"cdn.domain.option","description":"Additional information about option","properties":{"quota":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"Maximum usage of the option","required":false},"usage":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"Current usage of the option","required":false}}},"cdn.domain.statistics":{"id":"statistics","namespace":"cdn.domain","description":"Domain Statistics Datapoints","properties":{"name":{"type":"cdn.DomainStatisticsNameEnum","fullType":"cdn.DomainStatisticsNameEnum","canBeNull":false,"readOnly":true,"description":"name of the serie","required":false},"points":{"type":"cdn.domain.statistics.point[]","fullType":"cdn.domain.statistics.point[]","canBeNull":false,"readOnly":true,"description":"List of DataPoints","required":false},"unit":{"type":"cdn.DomainStatisticsUnitEnum","fullType":"cdn.DomainStatisticsUnitEnum","canBeNull":false,"readOnly":true,"description":"Unit of the serie","required":false}}},"cdn.domain.statistics.point":{"id":"point","namespace":"cdn.domain.statistics","description":"Statistics Datapoint","properties":{"timestamp":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Timestamp","required":false},"value":{"type":"double","fullType":"double","canBeNull":true,"readOnly":true,"description":"Datapoint value","required":false}}},"cdn.logs":{"id":"logs","namespace":"cdn","description":"Logs archive URL","properties":{"url":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"URL to logs archive","required":false},"validity":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"URL validity","required":false}}},"cdn.operation":{"id":"operation","namespace":"cdn","description":"Operation details","properties":{"comment":{"type":"text","fullType":"text","canBeNull":true,"readOnly":true,"description":"Comment","required":false},"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date","required":false},"function":{"type":"cdn.OperationFunctionEnum","fullType":"cdn.OperationFunctionEnum","canBeNull":false,"readOnly":true,"description":"Operation function","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Operation id","required":false},"parameter":{"type":"cdn.operation.parameter","fullType":"cdn.operation.parameter","canBeNull":false,"readOnly":true,"description":"Operation parameter","required":false},"service":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Shared CDN service","required":false},"status":{"type":"cdn.OperationStatusEnum","fullType":"cdn.OperationStatusEnum","canBeNull":false,"readOnly":true,"description":"Operation status","required":false},"todoDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Next execution date","required":false},"updatedDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last execution date","required":false}}},"cdn.operation.parameter":{"id":"parameter","namespace":"cdn.operation","description":"Operation parameter","properties":{"anycastIp":{"type":"ipv4","fullType":"ipv4","canBeNull":true,"readOnly":true,"description":"CDN anycast IP","required":false},"cluster":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Cluster name","required":false},"date":{"type":"date","fullType":"date","canBeNull":true,"readOnly":true,"description":"Date","required":false},"domainName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Domain name","required":false},"fingerprint":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"CDN certificate fingerprint","required":false},"offer":{"type":"cdn.OperationOfferEnum","fullType":"cdn.OperationOfferEnum","canBeNull":true,"readOnly":true,"description":"Shared CDN offer","required":false},"pattern":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Pattern to purge on CDN","required":false},"service":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Service name","required":false},"sslId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"CDN ssl id","required":false}}},"complexType.ChartSerie<T>":{"id":"ChartSerie","namespace":"complexType","description":"A value set tagged with its unit and serie name","generics":["T"],"properties":{"serieName":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"unit":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"values":{"type":"T[]","canBeNull":false,"readOnly":false,"required":false}}},"complexType.ChartTimestampValue":{"id":"ChartTimestampValue","namespace":"complexType","description":"A timestamp associated to a value","properties":{"timestamp":{"type":"long","canBeNull":false,"readOnly":false,"required":false},"value":{"type":"double","canBeNull":true,"readOnly":false,"required":false}}},"complexType.UnitAndValue<T>":{"id":"UnitAndValue","namespace":"complexType","description":"A numeric value tagged with its unit","generics":["T"],"properties":{"unit":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Unit of the value","required":false},"value":{"type":"T","fullType":"T","canBeNull":false,"readOnly":true,"description":"Value","required":false}}},"complexType.UnitAndValue<double>":{"id":"UnitAndValue","namespace":"complexType","description":"A numeric value tagged with its unit","generics":["T"],"properties":{"unit":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Unit of the value","required":false},"value":{"type":"T","fullType":"T","canBeNull":false,"readOnly":true,"description":"Value","required":false}}},"complexType.UnitAndValue<long>":{"id":"UnitAndValue","namespace":"complexType","description":"A numeric value tagged with its unit","generics":["T"],"properties":{"unit":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"value":{"type":"T","canBeNull":false,"readOnly":false,"required":false}}},"complexType.UnitAndValue<string>":{"id":"UnitAndValue","namespace":"complexType","description":"A numeric value tagged with its unit","generics":["T"],"properties":{"unit":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"value":{"type":"T","canBeNull":false,"readOnly":false,"required":false}}},"dbaas.logs.LogKind":{"id":"LogKind","namespace":"dbaas.logs","description":"Log kind","properties":{"additionalReturnedFields":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"List of additional log fields managed in this log kind","required":false},"createdAt":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date of the log kind","required":false},"displayName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Log kind display name","required":false},"kindId":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Log kind ID","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Log kind name","required":false},"updatedAt":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last update date of the log kind","required":false}}},"dbaas.logs.LogSubscription":{"id":"LogSubscription","namespace":"dbaas.logs","description":"Log subscription","properties":{"createdAt":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date of the subscription","required":false},"kind":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Log kind name of this subscription","required":false},"resource":{"type":"dbaas.logs.SubscriptionResource","fullType":"dbaas.logs.SubscriptionResource","canBeNull":false,"readOnly":true,"description":"Subscribed resource, where the logs come from","required":false},"serviceName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of the destination log service","required":false},"streamId":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Id of the destination log stream","required":false},"subscriptionId":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Subscription ID","required":false},"updatedAt":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last update date of the subscription","required":false}}},"dbaas.logs.LogSubscriptionCreation":{"id":"LogSubscriptionCreation","namespace":"dbaas.logs","description":"Log subscription creation payload","properties":{"kind":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Log kind name to subscribe to","required":true},"streamId":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":false,"description":"Customer log stream ID","required":true}}},"dbaas.logs.LogSubscriptionResponse":{"id":"LogSubscriptionResponse","namespace":"dbaas.logs","description":"Asynchronous operation after subscribing or unsubscribing to a resource logs","properties":{"operationId":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Identifier of the operation","required":false},"serviceName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Operation owner's service name","required":false}}},"dbaas.logs.LogUrlCreation":{"id":"LogUrlCreation","namespace":"dbaas.logs","description":"Log temporary URL creation payload","properties":{"kind":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Log kind name","required":true}}},"dbaas.logs.SubscriptionResource":{"id":"SubscriptionResource","namespace":"dbaas.logs","description":"Log subscription resource","properties":{"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of subscribed resource","required":false},"type":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Type of subscribed resource","required":false}}},"dbaas.logs.TemporaryLogsLink":{"id":"TemporaryLogsLink","namespace":"dbaas.logs","description":"Temporary url information","properties":{"expirationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Temporary url expiration date","required":false},"url":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Temporary url","required":false}}},"hosting.web.AbuseState":{"id":"AbuseState","namespace":"hosting.web","description":"abuse state","properties":{"accessState":{"type":"hosting.web.AccessStateEnum","fullType":"hosting.web.AccessStateEnum","canBeNull":false,"readOnly":true,"description":"access state","required":false},"mailsoutState":{"type":"hosting.web.MailsoutStateEnum","fullType":"hosting.web.MailsoutStateEnum","canBeNull":false,"readOnly":true,"description":"mailsout state","required":false},"outState":{"type":"hosting.web.OutStateEnum","fullType":"hosting.web.OutStateEnum","canBeNull":false,"readOnly":true,"description":"TCP out state","required":false},"webState":{"type":"hosting.web.StateEnum","fullType":"hosting.web.StateEnum","canBeNull":false,"readOnly":true,"description":"web state","required":false}}},"hosting.web.AccessStateEnum":{"id":"AccessStateEnum","namespace":"hosting.web","description":"Hosting's web state","enum":["active","blocked","hardBlocked","hardMaintenance","maintenance"],"enumType":"string"},"hosting.web.Address":{"id":"Address","namespace":"hosting.web","description":"Url and port of a service","properties":{"port":{"type":"long","fullType":"long","canBeNull":false,"readOnly":false,"description":"Port to use to access to the service","required":false},"url":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Url to contact the service","required":false}}},"hosting.web.AttachedDomain":{"id":"AttachedDomain","namespace":"hosting.web","description":"Attached domain","properties":{"bypassDNSConfiguration":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"If set to true, DNS zone will not be updated by the operation","required":false},"cdn":{"type":"hosting.web.attachedDomain.CdnEnum","fullType":"hosting.web.attachedDomain.CdnEnum","canBeNull":true,"readOnly":false,"description":"Whether the attached domain is linked to the hosting CDN","required":false},"domain":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Domain to link","required":false},"firewall":{"type":"hosting.web.attachedDomain.FirewallEnum","fullType":"hosting.web.attachedDomain.FirewallEnum","canBeNull":true,"readOnly":false,"description":"Whether the firewall is active for this domain","required":false},"ipLocation":{"type":"hosting.web.CountryEnum","fullType":"hosting.web.CountryEnum","canBeNull":true,"readOnly":false,"description":"Change attached domain's DNS to the IP of the country","required":false},"ownLog":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Domain to separate the logs on","required":false},"path":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Path of the attached domain","required":false},"runtimeId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"The runtime configuration ID used on this domain","required":false},"ssl":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"Whether to put the attached domain in the SSL certificate","required":false}}},"hosting.web.AvailableOfferStruct":{"id":"AvailableOfferStruct","namespace":"hosting.web","description":"Struct which describs an boost offer from a service","properties":{"offer":{"type":"hosting.web.OfferEnum","fullType":"hosting.web.OfferEnum","canBeNull":false,"readOnly":false,"description":"Available boost offer","required":false},"price":{"type":"order.Price","fullType":"order.Price","canBeNull":false,"readOnly":false,"description":"The price in month for this boost offer","required":false}}},"hosting.web.BoostHistory":{"id":"BoostHistory","namespace":"hosting.web","description":"Boost History","properties":{"accountId":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":" Account who requested the change","required":false},"boostOffer":{"type":"hosting.web.OfferEnum","fullType":"hosting.web.OfferEnum","canBeNull":true,"readOnly":true,"description":"Boost offer used","required":false},"date":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"The date when the change has been requested","required":false},"offer":{"type":"hosting.web.OfferEnum","fullType":"hosting.web.OfferEnum","canBeNull":false,"readOnly":true,"description":"Offer when the change was made","required":false}}},"hosting.web.CDN":{"id":"CDN","namespace":"hosting.web","description":"CDN properties","properties":{"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Domain of this CDN","required":false},"free":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether CDN is free with the hosting","required":false},"status":{"type":"hosting.web.cdn.StatusEnum","fullType":"hosting.web.cdn.StatusEnum","canBeNull":false,"readOnly":true,"description":"Status of the CDN option","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this CDN","required":false},"type":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Type of the CDN","required":false},"version":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Version of the CDN","required":false}}},"hosting.web.Capabilities":{"id":"Capabilities","namespace":"hosting.web","description":"Struct which describs an offer","properties":{"attachedDomains":{"type":"long","canBeNull":false,"readOnly":false,"description":"Number of domains you can attach to your hosting","required":false},"crontab":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Does the offer allow crontab","required":false},"databaseEngines":{"type":"long","canBeNull":false,"readOnly":false,"description":"Number of database engines allowed for your hosting","required":false},"databases":{"type":"hosting.web.database.CreationDatabaseCapabilities[]","canBeNull":false,"readOnly":false,"description":"Describe all databases type you can have","required":false},"disk":{"type":"hosting.web.DiskType","canBeNull":true,"readOnly":false,"description":"Disk capacity and type available for your hosting ( null for unlimited )","required":false},"emails":{"type":"hosting.web.CreationEmailCapabilities","canBeNull":false,"readOnly":false,"description":"Describe all email offer you can have","required":false},"envVars":{"type":"long","canBeNull":false,"readOnly":false,"description":"Number of environment variables allowed for your hosting","required":false},"extraUsers":{"type":"long","canBeNull":false,"readOnly":false,"description":"Number of ftp user you can create","required":false},"filesBrowser":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Does the offer allow access to web files browser?","required":false},"highlight":{"type":"hosting.web.HighLightEnum","canBeNull":true,"readOnly":false,"description":"Marketing information about the current offer","required":false},"languages":{"type":"hosting.web.CronLanguageAvailable","canBeNull":false,"readOnly":false,"description":"Language available for cron script","required":false},"moduleOneClick":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Does the offer allow 1-click modules?","required":false},"privateDatabases":{"type":"hosting.web.database.CreationDatabaseCapabilities[]","canBeNull":false,"readOnly":false,"description":"Describe all privateDatabases type you can have","required":false},"runtimes":{"type":"long","canBeNull":false,"readOnly":false,"description":"Number of runtimes allowed for your hosting","required":false},"sitesRecommended":{"type":"long","canBeNull":true,"readOnly":false,"description":"Number of sites recommended for your hosting ( -1 for unlimited )","required":false},"ssh":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Does the offer allow SSH access","required":false},"traffic":{"type":"complexType.UnitAndValue<double>","canBeNull":true,"readOnly":false,"description":"Traffic quota size for your hosting ( null for unlimited )","required":false}}},"hosting.web.CountriesIp":{"id":"CountriesIp","namespace":"hosting.web","description":"Available clusterIp by country","properties":{"country":{"type":"hosting.web.CountryEnum","fullType":"hosting.web.CountryEnum","canBeNull":false,"readOnly":true,"description":"The whois country of the ip","required":false},"ip":{"type":"ipv4","fullType":"ipv4","canBeNull":true,"readOnly":true,"description":"The cluster ip","required":false},"ipv6":{"type":"ipv6","fullType":"ipv6","canBeNull":true,"readOnly":true,"description":"The cluster ipv6","required":false}}},"hosting.web.CountryEnum":{"id":"CountryEnum","namespace":"hosting.web","description":"Available cluster countries","enum":["BE","CA","CZ","DE","ES","FI","FR","IE","IT","LT","NL","PL","PT","UK"],"enumType":"string"},"hosting.web.CreationEmailCapabilities":{"id":"CreationEmailCapabilities","namespace":"hosting.web","description":"Struct which describes mail offer available and his quota","properties":{"available":{"type":"long","canBeNull":false,"readOnly":false,"description":"Number of email available for creation","required":false},"quota":{"type":"complexType.UnitAndValue<long>","canBeNull":false,"readOnly":false,"description":"Email account capacity","required":false}}},"hosting.web.Cron":{"id":"Cron","namespace":"hosting.web","description":"Cron","properties":{"command":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Command to execute","required":true},"description":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Description field for you","required":false},"email":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Email used to receive error log (stderr)","required":false},"frequency":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Frequency (crontab format) defined for the script (minutes are ignored)","required":true},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Cron's id","required":false},"language":{"type":"hosting.web.LanguagesEnum","fullType":"hosting.web.LanguagesEnum","canBeNull":false,"readOnly":false,"description":"Cron language","required":true},"state":{"type":"hosting.web.cron.StateEnum","fullType":"hosting.web.cron.StateEnum","canBeNull":false,"readOnly":true,"description":"Cron language","required":false},"status":{"type":"hosting.web.cron.StatusEnum","fullType":"hosting.web.cron.StatusEnum","canBeNull":false,"readOnly":false,"description":"Cron status","required":false}}},"hosting.web.CronLanguageAvailable":{"id":"CronLanguageAvailable","namespace":"hosting.web","description":"Language available for cron script","properties":{"nodejs":{"type":"hosting.web.NodejsVersionAvailableEnum[]","canBeNull":false,"readOnly":false,"description":"NodeJS versions","required":false},"php":{"type":"hosting.web.PhpVersionAvailableEnum[]","canBeNull":false,"readOnly":false,"description":"Php versions","required":false},"python":{"type":"hosting.web.PythonVersionAvailableEnum[]","canBeNull":false,"readOnly":false,"description":"Python versions","required":false},"ruby":{"type":"hosting.web.RubyVersionAvailableEnum[]","canBeNull":false,"readOnly":false,"description":"Ruby versions","required":false}}},"hosting.web.DatacenterEnum":{"id":"DatacenterEnum","namespace":"hosting.web","description":"Available datacenters","enum":["bhs","bhs1","gra","gra1","gra2","gra3","p19"],"enumType":"string"},"hosting.web.DiskType":{"id":"DiskType","namespace":"hosting.web","description":"Disk properties (size and type of disk)","properties":{"type":{"type":"hosting.web.DiskTypeEnum","canBeNull":false,"readOnly":false,"description":"Type of the disk","required":false},"unit":{"type":"string","canBeNull":false,"readOnly":false,"description":"Unit for disk size","required":false},"value":{"type":"double","canBeNull":false,"readOnly":false,"description":"Size of the disk","required":false}}},"hosting.web.DiskTypeEnum":{"id":"DiskTypeEnum","namespace":"hosting.web","description":"Disk type available","enum":["HDD","SSD"],"enumType":"string"},"hosting.web.EnvVar":{"id":"EnvVar","namespace":"hosting.web","description":"Environment variables set into your webhosting account","properties":{"key":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of the variable","required":false},"status":{"type":"hosting.web.envVar.StatusEnum","fullType":"hosting.web.envVar.StatusEnum","canBeNull":false,"readOnly":true,"description":"The environnement variable status","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this variable","required":false},"type":{"type":"hosting.web.envVar.TypeEnum","fullType":"hosting.web.envVar.TypeEnum","canBeNull":false,"readOnly":true,"description":"Type of variable set","required":false},"value":{"type":"password","fullType":"password","canBeNull":false,"readOnly":false,"description":"Value of the variable","required":false}}},"hosting.web.EnvVarInput":{"id":"EnvVarInput","namespace":"hosting.web","description":"Environment variables set into your webhosting account","properties":{"key":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Name of the variable","required":true},"type":{"type":"hosting.web.envVar.TypeEnum","fullType":"hosting.web.envVar.TypeEnum","canBeNull":false,"readOnly":false,"description":"Type of variable set","required":true},"value":{"type":"password","fullType":"password","canBeNull":false,"readOnly":false,"description":"Value of the variable","required":true}}},"hosting.web.HighLightEnum":{"id":"HighLightEnum","namespace":"hosting.web","description":"Highlight tips for offer","enum":["best-seller","new"],"enumType":"string"},"hosting.web.Key":{"id":"Key","namespace":"hosting.web","description":"Key information","properties":{"publicKey":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Public key","required":false}}},"hosting.web.LanguagesEnum":{"id":"LanguagesEnum","namespace":"hosting.web","description":"Web supported languages","enum":["node10","node11","node12","node14","node8","node9","other","php4","php5.2","php5.3","php5.4","php5.5","php5.6","php7.0","php7.1","php7.2","php7.3","php7.4","php8.0","php8.1","php8.2","php8.3","php8.4","php8.5","python2","python3","ruby2.6"],"enumType":"string"},"hosting.web.MailsoutStateEnum":{"id":"MailsoutStateEnum","namespace":"hosting.web","description":"Hosting's mailsout state","enum":["bounce","ko","ok","spam","spamLegalBlocked"],"enumType":"string"},"hosting.web.MetricsToken":{"id":"MetricsToken","namespace":"hosting.web","description":"Metrics token","properties":{"endpoint":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Backend url","required":false},"expiry":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Token expiration date","required":false},"token":{"type":"password","fullType":"password","canBeNull":false,"readOnly":true,"description":"Generated token","required":false}}},"hosting.web.ModuleList":{"id":"ModuleList","namespace":"hosting.web","description":"A module specifically packaged by OVH","properties":{"active":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is the module available?","required":false},"adminNameType":{"type":"hosting.web.module.AdminNameTypeEnum","fullType":"hosting.web.module.AdminNameTypeEnum","canBeNull":false,"readOnly":true,"description":"The type of the admin name","required":false},"author":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The packager of this module for OVH","required":false},"branch":{"type":"hosting.web.module.BranchEnum","fullType":"hosting.web.module.BranchEnum","canBeNull":false,"readOnly":true,"description":"The branch of the module","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"The ID of the module","required":false},"keywords":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"The keywords for this module","required":false},"language":{"type":"hosting.web.module.LanguageEnum[]","fullType":"hosting.web.module.LanguageEnum[]","canBeNull":false,"readOnly":true,"description":"All available languages for this module","required":false},"languageRequirement":{"type":"complexType.UnitAndValue<string>","fullType":"complexType.UnitAndValue<string>","canBeNull":false,"readOnly":true,"description":"Minimal language version required to run this module","required":false},"latest":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is this the latest version available?","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The name of the module","required":false},"size":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":false,"readOnly":true,"description":"Size of the module","required":false},"upgradeFrom":{"type":"long[]","fullType":"long[]","canBeNull":false,"readOnly":true,"description":"The IDs of the module you can upgrade to","required":false},"version":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The version of the module","required":false}}},"hosting.web.NodejsVersionAvailableEnum":{"id":"NodejsVersionAvailableEnum","namespace":"hosting.web","description":"Different NodeJs versions available","enum":["nodejs-10","nodejs-11","nodejs-12","nodejs-8","nodejs-9"],"enumType":"string"},"hosting.web.OfferCapabilitiesEnum":{"id":"OfferCapabilitiesEnum","namespace":"hosting.web","description":"Hosting's offer","enum":["1000gp","20gp","240gp","240pack","240plan","300gp","60gp","720pack","720plan","90pack","90plan","CLOUDWEB_1","CLOUDWEB_2","CLOUDWEB_3","KS","PERFORMANCE_1","PERFORMANCE_2","PERFORMANCE_3","PERFORMANCE_4","PERSO","POWER_BETA_1","PRO","START","business","cloudweb1","cloudweb2","cloudweb3","cloudwebbetax1","depro2012","deprol2012","deproxl2012","deproxxl2012","destart2012","destartl2012","destartxl2012","domainpack","hosting-agency","hosting-agency-max","hosting-agency-plus","hosting-free-100m","hosting-performance-1","hosting-performance-2","hosting-performance-3","hosting-performance-4","hosting-perso","hosting-pro","hosting-starter","hosting-starter-ovh","hosting-startup","hostingAtScaleX128","hostingAtScaleX16","hostingAtScaleX20","hostingAtScaleX24","hostingAtScaleX32","hostingAtScaleX64","hostingAtScaleX8","itbusiness2012","itperso2012","itpremium2012","kimsufi2015","mailpack","mailplan","mediapack","mediaplan","ovhpro1To","ovhpro2To","ovhpro5To","paas2014beta","perf2014x1","perf2014x2","perf2014x3","perf2014x4","perso2010","perso2014","powerBeta1","powerbeta1","premium","pro2010","pro2014","start10g","start10m","start1g","start1ges","start1m","start5g","starter","xxlpack","xxlplan"],"enumType":"string"},"hosting.web.OfferEnum":{"id":"OfferEnum","namespace":"hosting.web","description":"Hosting's offer","enum":["1000gp","20gp","240gp","240pack","240plan","300gp","60gp","720pack","720plan","90pack","90plan","CLOUDWEB_1","CLOUDWEB_2","CLOUDWEB_3","KS","PERFORMANCE_1","PERFORMANCE_2","PERFORMANCE_3","PERFORMANCE_4","PERSO","POWER_BETA_1","PRO","START","business","cloudweb1","cloudweb2","cloudweb3","cloudwebbetax1","depro2012","deprol2012","deproxl2012","deproxxl2012","destart2012","destartl2012","destartxl2012","domainpack","hosting-agency","hosting-agency-max","hosting-agency-plus","hosting-free-100m","hosting-performance-1","hosting-performance-2","hosting-performance-3","hosting-performance-4","hosting-perso","hosting-pro","hosting-starter","hosting-starter-ovh","hosting-startup","hostingAtScaleX128","hostingAtScaleX16","hostingAtScaleX20","hostingAtScaleX24","hostingAtScaleX32","hostingAtScaleX64","hostingAtScaleX8","itbusiness2012","itperso2012","itpremium2012","kimsufi2015","mailpack","mailplan","mediapack","mediaplan","ovhpro1To","ovhpro2To","ovhpro5To","paas2014beta","perf2014x1","perf2014x2","perf2014x3","perf2014x4","perso2010","perso2014","powerBeta1","powerbeta1","premium","pro2010","pro2014","start10g","start10m","start1g","start1ges","start1m","start5g","starter","xxlpack","xxlplan"],"enumType":"string"},"hosting.web.OperatingSystemEnum":{"id":"OperatingSystemEnum","namespace":"hosting.web","description":"Hosting's OS","enum":["linux"],"enumType":"string"},"hosting.web.OutStateEnum":{"id":"OutStateEnum","namespace":"hosting.web","description":"Hosting's out state","enum":["active","blocked","hardBlocked"],"enumType":"string"},"hosting.web.OvhConfigCapabilities":{"id":"OvhConfigCapabilities","namespace":"hosting.web","description":"Struct which describes version and container image available","properties":{"containerImage":{"type":"string[]","canBeNull":false,"readOnly":false,"description":"Container image available","required":false},"version":{"type":"hosting.web.ovhConfig.AvailableEngineVersionEnum","canBeNull":false,"readOnly":false,"description":"PHP version","required":false}}},"hosting.web.OvhConfigRecommendedValues":{"id":"OvhConfigRecommendedValues","namespace":"hosting.web","description":"Struct which recommend default values on ovhConfig file","properties":{"container":{"type":"hosting.web.ovhconfig.ContainerEnum","canBeNull":false,"readOnly":false,"description":"Container to run this website","required":false},"engineName":{"type":"hosting.web.ovhConfig.EngineNameEnum","canBeNull":false,"readOnly":false,"description":"Engine name","required":false},"engineVersion":{"type":"hosting.web.ovhConfig.AvailableEngineVersionEnum","canBeNull":false,"readOnly":false,"description":"PHP version","required":false},"environment":{"type":"hosting.web.ovhConfig.EnvironmentEnum","canBeNull":false,"readOnly":false,"description":"Environment configuration","required":false},"httpFirewall":{"type":"hosting.web.ovhConfig.HttpFirewallEnum","canBeNull":false,"readOnly":false,"description":"Configuration for http firewall","required":false}}},"hosting.web.PhpVersion":{"id":"PhpVersion","namespace":"hosting.web","description":"State of available php versions for this account","properties":{"support":{"type":"hosting.web.PhpVersionStateEnum","fullType":"hosting.web.PhpVersionStateEnum","canBeNull":false,"readOnly":false,"description":"Current support of this php version","required":false},"version":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"PHP version","required":false}}},"hosting.web.PhpVersionAvailableEnum":{"id":"PhpVersionAvailableEnum","namespace":"hosting.web","description":"Different PHP versions available","enum":["phpfpm-5.6","phpfpm-7.0","phpfpm-7.1","phpfpm-7.2","phpfpm-7.3","phpfpm-7.4","phpfpm-8.0","phpfpm-8.1","phpfpm-8.2","phpfpm-8.3","phpfpm-8.4","phpfpm-8.5"],"enumType":"string"},"hosting.web.PhpVersionStateEnum":{"id":"PhpVersionStateEnum","namespace":"hosting.web","description":"Different support of PHP versions","enum":["BETA","END_OF_LIFE","SECURITY_FIXES","SUPPORTED"],"enumType":"string"},"hosting.web.PublicTask":{"id":"PublicTask","namespace":"hosting.web","description":"Public task","properties":{"doneDate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Done date","required":false},"function":{"type":"hosting.web.task.FunctionEnum","fullType":"hosting.web.task.FunctionEnum","canBeNull":false,"readOnly":true,"description":"Task function","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Task's id","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Last update date","required":false},"objectId":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Task object id","required":false},"objectType":{"type":"hosting.web.task.ObjectTypeEnum","fullType":"hosting.web.task.ObjectTypeEnum","canBeNull":true,"readOnly":true,"description":"Task object type","required":false},"startDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Start date","required":false},"status":{"type":"hosting.web.task.StatusEnum","fullType":"hosting.web.task.StatusEnum","canBeNull":false,"readOnly":true,"description":"Task status","required":false}}},"hosting.web.PythonVersionAvailableEnum":{"id":"PythonVersionAvailableEnum","namespace":"hosting.web","description":"Different Python versions available","enum":["python-2","python-3"],"enumType":"string"},"hosting.web.RequestActionEnum":{"id":"RequestActionEnum","namespace":"hosting.web","description":"Types of action you can request for your web hosting","enum":["CHECK_QUOTA","FLUSH_CACHE","SCAN_ANTIHACK"],"enumType":"string"},"hosting.web.RequestBoostInput":{"id":"RequestBoostInput","namespace":"hosting.web","description":"RequestBoost input properties","properties":{"offer":{"type":"hosting.web.OfferEnum","fullType":"hosting.web.OfferEnum","canBeNull":true,"readOnly":false,"description":"Requested boost offer","required":false}}},"hosting.web.ResourceEnum":{"id":"ResourceEnum","namespace":"hosting.web","description":"Hosting's type","enum":["bestEffort","cloud","dedicated","shared"],"enumType":"string"},"hosting.web.RubyVersionAvailableEnum":{"id":"RubyVersionAvailableEnum","namespace":"hosting.web","description":"Different Ruby versions available","enum":["ruby-2.6"],"enumType":"string"},"hosting.web.SSL":{"id":"SSL","namespace":"hosting.web","description":"Hosted SSL properties","properties":{"isReportable":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"If the hostedssl is currently bound to a report","required":false},"provider":{"type":"hosting.web.hostedssl.ProviderEnum","fullType":"hosting.web.hostedssl.ProviderEnum","canBeNull":false,"readOnly":true,"description":"Provider of the Hosted SSL","required":false},"regenerable":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Regenerable flag","required":false},"status":{"type":"hosting.web.hostedssl.StatusEnum","fullType":"hosting.web.hostedssl.StatusEnum","canBeNull":false,"readOnly":true,"description":"Status of the Hosted SSL","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this Hosted SSL","required":false},"type":{"type":"hosting.web.hostedssl.TypeEnum","fullType":"hosting.web.hostedssl.TypeEnum","canBeNull":false,"readOnly":true,"description":"Type of the Hosted SSL","required":false}}},"hosting.web.SSLInput":{"id":"SSLInput","namespace":"hosting.web","description":"SSL input properties","properties":{"certificate":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"certificate","required":false},"chain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"certificate chain","required":false},"key":{"type":"password","fullType":"password","canBeNull":false,"readOnly":false,"description":"private key","required":false}}},"hosting.web.SSLUpdateInput":{"id":"SSLUpdateInput","namespace":"hosting.web","description":"SSL update input properties","properties":{"regenerate":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"true to regenerate the certificate","required":false}}},"hosting.web.Service":{"id":"Service","namespace":"hosting.web","description":"Web Hosting","properties":{"availableBoostOffer":{"type":"hosting.web.AvailableOfferStruct[]","fullType":"hosting.web.AvailableOfferStruct[]","canBeNull":false,"readOnly":true,"description":"Available offers for boost option","required":false},"boostOffer":{"type":"hosting.web.OfferEnum","fullType":"hosting.web.OfferEnum","canBeNull":true,"readOnly":true,"description":"Current boost offer","required":false},"cluster":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Cluster name","required":false},"clusterIp":{"type":"ipv4","fullType":"ipv4","canBeNull":true,"readOnly":true,"description":"This direct ip to your cluster ( usefull for application like api )","required":false},"clusterIpv6":{"type":"ipv6","fullType":"ipv6","canBeNull":true,"readOnly":true,"description":"This direct ipv6 to your cluster ( usefull for application like api )","required":false},"countriesIp":{"type":"hosting.web.CountriesIp[]","fullType":"hosting.web.CountriesIp[]","canBeNull":true,"readOnly":true,"description":"Available clusterIp by countries","required":false},"datacenter":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Datacenter where this account is located","required":false},"defaultAttachedDomain":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"The default attached domain created along with your hosting","required":false},"displayName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Set the name displayed in ManagerV6 for your hosting (max 50 chars)","required":false},"filer":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Filer name","required":false},"hasCdn":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":true,"description":"Has a CDN service linked on the hosting","required":false},"hasHostedSsl":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":true,"description":"Has a HostedSSL service linked on the hosting","required":false},"home":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Path of your home","required":false},"hostingIp":{"type":"ipv4","fullType":"ipv4","canBeNull":true,"readOnly":true,"description":"The recommended ip for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )","required":false},"hostingIpv6":{"type":"ipv6","fullType":"ipv6","canBeNull":true,"readOnly":true,"description":"The recommended ipv6 for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )","required":false},"lastOvhConfigScan":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"/hosting/web/{serviceName}/ovhConfig is stored in cache. This date is the last refresh of this data","required":false},"multipleSSL":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"If set to true, service can manage more than only one certificate","required":false},"objectQuota":{"type":"double","fullType":"double","canBeNull":true,"readOnly":true,"description":"objects allowed","required":false},"objectUsed":{"type":"double","fullType":"double","canBeNull":true,"readOnly":true,"description":"objects used","required":false},"offer":{"type":"hosting.web.OfferEnum","fullType":"hosting.web.OfferEnum","canBeNull":false,"readOnly":true,"description":"Hosting offer","required":false},"operatingSystem":{"type":"hosting.web.OperatingSystemEnum","fullType":"hosting.web.OperatingSystemEnum","canBeNull":false,"readOnly":true,"description":"Hosting's OS","required":false},"phpVersions":{"type":"hosting.web.PhpVersion[]","fullType":"hosting.web.PhpVersion[]","canBeNull":false,"readOnly":true,"description":"State of available php versions for this account","required":false},"primaryLogin":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Hosting's main login","required":false},"quotaSize":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":false,"readOnly":true,"description":"Space allowed","required":false},"quotaUsed":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":true,"readOnly":true,"description":"Space used","required":false},"recommendedOffer":{"type":"hosting.web.OfferEnum","fullType":"hosting.web.OfferEnum","canBeNull":true,"readOnly":true,"description":"If your offer is old, return a recommended offer to migrate on","required":false},"resourceType":{"type":"hosting.web.ResourceEnum","fullType":"hosting.web.ResourceEnum","canBeNull":false,"readOnly":true,"description":"Hosting resource type","required":false},"serviceManagementAccess":{"type":"hosting.web.ServiceAccess","fullType":"hosting.web.ServiceAccess","canBeNull":false,"readOnly":true,"description":"URLs to use to manage your webhosting","required":false},"serviceName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Service name","required":false},"state":{"type":"hosting.web.StateEnum","fullType":"hosting.web.StateEnum","canBeNull":false,"readOnly":true,"description":"State of your hosting","required":false},"token":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Use to link an external domain. ( This token has to be insert into a TXT field on your dns zone with ovhcontrol subdomain )","required":false},"trafficQuotaSize":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":true,"readOnly":true,"description":"Traffic quota allowed ( null = unlimited )","required":false},"trafficQuotaUsed":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":true,"readOnly":true,"description":"Traffic quota used","required":false},"updates":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"List of updates on your hosting","required":false}}},"hosting.web.ServiceAccess":{"id":"ServiceAccess","namespace":"hosting.web","description":"Different url to manage your service","properties":{"ftp":{"type":"hosting.web.Address","fullType":"hosting.web.Address","canBeNull":false,"readOnly":false,"description":"Address with url and port to manage files by ftp","required":false},"http":{"type":"hosting.web.Address","fullType":"hosting.web.Address","canBeNull":false,"readOnly":false,"description":"Address to see your webhosting without domain","required":false},"ssh":{"type":"hosting.web.Address","fullType":"hosting.web.Address","canBeNull":false,"readOnly":false,"description":"Address with url and port to manage webhosting by ssh","required":false}}},"hosting.web.ServiceWithIAM":{"id":"Service","namespace":"hosting.web","description":"Web Hosting","properties":{"availableBoostOffer":{"type":"hosting.web.AvailableOfferStruct[]","fullType":"hosting.web.AvailableOfferStruct[]","canBeNull":false,"readOnly":true,"description":"Available offers for boost option","required":false},"boostOffer":{"type":"hosting.web.OfferEnum","fullType":"hosting.web.OfferEnum","canBeNull":true,"readOnly":true,"description":"Current boost offer","required":false},"cluster":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Cluster name","required":false},"clusterIp":{"type":"ipv4","fullType":"ipv4","canBeNull":true,"readOnly":true,"description":"This direct ip to your cluster ( usefull for application like api )","required":false},"clusterIpv6":{"type":"ipv6","fullType":"ipv6","canBeNull":true,"readOnly":true,"description":"This direct ipv6 to your cluster ( usefull for application like api )","required":false},"countriesIp":{"type":"hosting.web.CountriesIp[]","fullType":"hosting.web.CountriesIp[]","canBeNull":true,"readOnly":true,"description":"Available clusterIp by countries","required":false},"datacenter":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Datacenter where this account is located","required":false},"defaultAttachedDomain":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"The default attached domain created along with your hosting","required":false},"displayName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Set the name displayed in ManagerV6 for your hosting (max 50 chars)","required":false},"filer":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Filer name","required":false},"hasCdn":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":true,"description":"Has a CDN service linked on the hosting","required":false},"hasHostedSsl":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":true,"description":"Has a HostedSSL service linked on the hosting","required":false},"home":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Path of your home","required":false},"hostingIp":{"type":"ipv4","fullType":"ipv4","canBeNull":true,"readOnly":true,"description":"The recommended ip for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )","required":false},"hostingIpv6":{"type":"ipv6","fullType":"ipv6","canBeNull":true,"readOnly":true,"description":"The recommended ipv6 for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )","required":false},"iam":{"type":"iam.ResourceMetadata","canBeNull":true,"readOnly":true,"description":"IAM resource metadata","required":false},"lastOvhConfigScan":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"/hosting/web/{serviceName}/ovhConfig is stored in cache. This date is the last refresh of this data","required":false},"multipleSSL":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"If set to true, service can manage more than only one certificate","required":false},"objectQuota":{"type":"double","fullType":"double","canBeNull":true,"readOnly":true,"description":"objects allowed","required":false},"objectUsed":{"type":"double","fullType":"double","canBeNull":true,"readOnly":true,"description":"objects used","required":false},"offer":{"type":"hosting.web.OfferEnum","fullType":"hosting.web.OfferEnum","canBeNull":false,"readOnly":true,"description":"Hosting offer","required":false},"operatingSystem":{"type":"hosting.web.OperatingSystemEnum","fullType":"hosting.web.OperatingSystemEnum","canBeNull":false,"readOnly":true,"description":"Hosting's OS","required":false},"phpVersions":{"type":"hosting.web.PhpVersion[]","fullType":"hosting.web.PhpVersion[]","canBeNull":false,"readOnly":true,"description":"State of available php versions for this account","required":false},"primaryLogin":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Hosting's main login","required":false},"quotaSize":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":false,"readOnly":true,"description":"Space allowed","required":false},"quotaUsed":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":true,"readOnly":true,"description":"Space used","required":false},"recommendedOffer":{"type":"hosting.web.OfferEnum","fullType":"hosting.web.OfferEnum","canBeNull":true,"readOnly":true,"description":"If your offer is old, return a recommended offer to migrate on","required":false},"resourceType":{"type":"hosting.web.ResourceEnum","fullType":"hosting.web.ResourceEnum","canBeNull":false,"readOnly":true,"description":"Hosting resource type","required":false},"serviceManagementAccess":{"type":"hosting.web.ServiceAccess","fullType":"hosting.web.ServiceAccess","canBeNull":false,"readOnly":true,"description":"URLs to use to manage your webhosting","required":false},"serviceName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Service name","required":false},"state":{"type":"hosting.web.StateEnum","fullType":"hosting.web.StateEnum","canBeNull":false,"readOnly":true,"description":"State of your hosting","required":false},"token":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Use to link an external domain. ( This token has to be insert into a TXT field on your dns zone with ovhcontrol subdomain )","required":false},"trafficQuotaSize":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":true,"readOnly":true,"description":"Traffic quota allowed ( null = unlimited )","required":false},"trafficQuotaUsed":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":true,"readOnly":true,"description":"Traffic quota used","required":false},"updates":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"List of updates on your hosting","required":false}}},"hosting.web.StateEnum":{"id":"StateEnum","namespace":"hosting.web","description":"Hosting's state","enum":["active","blocked","bloqued","hardBlocked","hardBloqued","maintenance"],"enumType":"string"},"hosting.web.StatisticsPeriodEnum":{"id":"StatisticsPeriodEnum","namespace":"hosting.web","description":"Available periods for statistics","enum":["daily","monthly","weekly","yearly"],"enumType":"string"},"hosting.web.StatisticsTypeEnum":{"id":"StatisticsTypeEnum","namespace":"hosting.web","description":"Types of statistics available for the web hosting","enum":["in.ftpCommands","in.httpHits","in.httpMeanResponseTime","out.tcpConn","sys.cpuUsage","sys.workerSpawnOverload"],"enumType":"string"},"hosting.web.SupportedVcsEnum":{"id":"SupportedVcsEnum","namespace":"hosting.web","description":"Supported VCS platforms","enum":["github"],"enumType":"string"},"hosting.web.VcsWebhooks":{"id":"VcsWebhooks","namespace":"hosting.web","description":"VCS webhooks URLs for given hosting and VCS platform","properties":{"push":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Webhook URL for push events","required":false}}},"hosting.web.Website":{"id":"Website","namespace":"hosting.web","description":"A website on your hosting","properties":{"domains":{"type":"hosting.web.website.Domain[]","fullType":"hosting.web.website.Domain[]","canBeNull":false,"readOnly":true,"description":"Domains of the website","required":false},"hostingDisplayName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Display name of the hosting","required":false},"hostingServiceName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of the hosting service","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Website numeric identifier","required":false},"name":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Customizable name of the website","required":false},"path":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Relative path on the hosting filesystem the website is deployed into","required":false},"status":{"type":"hosting.web.website.StatusEnum","fullType":"hosting.web.website.StatusEnum","canBeNull":false,"readOnly":true,"description":"Current status of the website","required":false},"vcsBranch":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Branch of the repository containing the website source code to deploy","required":false},"vcsUrl":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"URL of the repository containing the website source code to deploy","required":false}}},"hosting.web.WebsiteCreationCapabilities":{"id":"WebsiteCreationCapabilities","namespace":"hosting.web","description":"Website creation capabilities of your hosting","properties":{"allowedWebsites":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of websites allowed by your hosting offer, -1 meaning unlimited","required":false},"existingWebsites":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of existing websites on your hosting","required":false}}},"hosting.web.attachedDomain":{"id":"attachedDomain","namespace":"hosting.web","description":"Virtual service","properties":{"capabilities":{"type":"hosting.web.attachedDomain.Capabilities[]","fullType":"hosting.web.attachedDomain.Capabilities[]","canBeNull":false,"readOnly":true,"description":"Provides the capabilities related to your attachedDomain","required":false},"cdn":{"type":"hosting.web.attachedDomain.CdnEnum","fullType":"hosting.web.attachedDomain.CdnEnum","canBeNull":false,"readOnly":false,"description":"Is linked to the hosting cdn","required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Domain linked (fqdn)","required":false},"firewall":{"type":"hosting.web.attachedDomain.FirewallEnum","fullType":"hosting.web.attachedDomain.FirewallEnum","canBeNull":false,"readOnly":false,"description":"Firewall state for this path","required":false},"ipLocation":{"type":"hosting.web.CountryEnum","fullType":"hosting.web.CountryEnum","canBeNull":true,"readOnly":true,"description":"IP location of the domain linked","required":false},"isFlushable":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Provides information if your Cdn can be flushed or not","required":false},"ownLog":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Put domain for separate the logs","required":false},"path":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Domain path, relative to your home directory","required":false},"runtimeId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"The runtime configuration ID used on this domain","required":false},"ssl":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"Put domain in ssl certificate","required":false},"status":{"type":"hosting.web.attachedDomain.StatusEnum","fullType":"hosting.web.attachedDomain.StatusEnum","canBeNull":false,"readOnly":true,"description":"The domain status","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this domain","required":false}}},"hosting.web.attachedDomain.Capabilities":{"id":"Capabilities","namespace":"hosting.web.attachedDomain","description":"Attached domain Capability","properties":{"description":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Capability description","required":false},"href":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Capability href","required":false},"key":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Capability key","required":false},"method":{"type":"hosting.web.attachedDomain.CapabilityMethodEnum","fullType":"hosting.web.attachedDomain.CapabilityMethodEnum","canBeNull":false,"readOnly":true,"description":"Capability method","required":false}}},"hosting.web.attachedDomain.CapabilityMethodEnum":{"id":"CapabilityMethodEnum","namespace":"hosting.web.attachedDomain","description":"allowed attachedDomain's capabilities methods","enum":["DELETE","GET","POST","PUT"],"enumType":"string"},"hosting.web.attachedDomain.CdnEnum":{"id":"CdnEnum","namespace":"hosting.web.attachedDomain","description":"whether or not the attachedDomain is linked to the hosting cdn","enum":["active","none"],"enumType":"string"},"hosting.web.attachedDomain.DigStatus":{"id":"DigStatus","namespace":"hosting.web.attachedDomain","description":"Attached domain DNS status","properties":{"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Attached domain","required":false},"recommendedIps":{"type":"hosting.web.attachedDomain.RecommendedIps","fullType":"hosting.web.attachedDomain.RecommendedIps","canBeNull":false,"readOnly":true,"required":false},"records":{"type":"map[string]hosting.web.attachedDomain.RecordStatus","fullType":"map[string]hosting.web.attachedDomain.RecordStatus","canBeNull":false,"readOnly":true,"required":false}}},"hosting.web.attachedDomain.FirewallEnum":{"id":"FirewallEnum","namespace":"hosting.web.attachedDomain","description":"Firewall state for this path","enum":["active","none"],"enumType":"string"},"hosting.web.attachedDomain.MethodEnum":{"id":"MethodEnum","namespace":"hosting.web.attachedDomain","description":"Method type","enum":["DELETE","GET","POST","PUT"],"enumType":"string"},"hosting.web.attachedDomain.PublicAttachedDomain":{"id":"PublicAttachedDomain","namespace":"hosting.web.attachedDomain","description":"Public attached domain","properties":{"capabilities":{"type":"hosting.web.attachedDomain.Capabilities[]","fullType":"hosting.web.attachedDomain.Capabilities[]","canBeNull":false,"readOnly":true,"description":"Provides the capabilities related to your attachedDomain","required":false},"cdn":{"type":"hosting.web.attachedDomain.CdnEnum","fullType":"hosting.web.attachedDomain.CdnEnum","canBeNull":false,"readOnly":true,"description":"whether or not attachedDomain is linked to the hosting cdn","required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Domain linked (fqdn)","required":false},"firewall":{"type":"hosting.web.attachedDomain.FirewallEnum","fullType":"hosting.web.attachedDomain.FirewallEnum","canBeNull":false,"readOnly":true,"description":"Firewall state for this path","required":false},"ipLocation":{"type":"hosting.web.CountryEnum","fullType":"hosting.web.CountryEnum","canBeNull":true,"readOnly":true,"description":"IP location of the domain linked","required":false},"isFlushable":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether your CDN can be flushed","required":false},"ownLog":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Domain for separate the logs","required":false},"path":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Attached domain path","required":false},"runtimeId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The runtime configuration ID used on this domain","required":false},"ssl":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":true,"description":"Put domain in SSL certificate","required":false},"status":{"type":"hosting.web.attachedDomain.StatusEnum","fullType":"hosting.web.attachedDomain.StatusEnum","canBeNull":false,"readOnly":true,"description":"Domain status","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this domain","required":false},"vcsStatus":{"type":"hosting.web.attachedDomain.VcsStatusEnum","fullType":"hosting.web.attachedDomain.VcsStatusEnum","canBeNull":false,"readOnly":true,"description":"The status of the VCS synchronization","required":false}}},"hosting.web.attachedDomain.RecommendedIps":{"id":"RecommendedIps","namespace":"hosting.web.attachedDomain","description":"Recommended IPs for DNS records configuration","properties":{"recommendedIpV4":{"type":"ipv4[]","fullType":"ipv4[]","canBeNull":false,"readOnly":true,"description":"Recommended IPV4","required":false},"recommendedIpV6":{"type":"ipv6[]","fullType":"ipv6[]","canBeNull":false,"readOnly":true,"description":"Recommended IPV6","required":false}}},"hosting.web.attachedDomain.RecordStatus":{"id":"RecordStatus","namespace":"hosting.web.attachedDomain","description":"Attached domain record status","properties":{"dnsConfigured":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether DNS is configured","required":false},"isOvhIp":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether IP is an OVH one","required":false},"type":{"type":"hosting.web.attachedDomain.RecordTypeEnum","fullType":"hosting.web.attachedDomain.RecordTypeEnum","canBeNull":false,"readOnly":true,"description":"DNS record type","required":false}}},"hosting.web.attachedDomain.RecordTypeEnum":{"id":"RecordTypeEnum","namespace":"hosting.web.attachedDomain","description":"DNS Record type","enum":["A","AAAA","CAA"],"enumType":"string"},"hosting.web.attachedDomain.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.attachedDomain","description":"attachedDomain status","enum":["created","creating","deleting","updating"],"enumType":"string"},"hosting.web.attachedDomain.VcsStatusEnum":{"id":"VcsStatusEnum","namespace":"hosting.web.attachedDomain","description":"AttachedDomain vcs status","enum":["created","creating","deleting","deploying","disabled","error","initialError"],"enumType":"string"},"hosting.web.backup.TypeEnum":{"id":"TypeEnum","namespace":"hosting.web.backup","description":"List of backup types","enum":["daily.1","daily.2","daily.3","weekly.1","weekly.2"],"enumType":"string"},"hosting.web.boostHistory":{"id":"boostHistory","namespace":"hosting.web","description":"History of your boost requests","properties":{"accountId":{"type":"string","fullType":"coreTypes.AccountId:string","canBeNull":false,"readOnly":true,"description":"Account who requested the change","required":false},"boostOffer":{"type":"hosting.web.OfferCapabilitiesEnum","fullType":"hosting.web.OfferCapabilitiesEnum","canBeNull":true,"readOnly":true,"description":"Boost offer used","required":false},"date":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"The date when the change has been requested","required":false},"offer":{"type":"hosting.web.OfferCapabilitiesEnum","fullType":"hosting.web.OfferCapabilitiesEnum","canBeNull":false,"readOnly":true,"description":"Offer when the change was made","required":false}}},"hosting.web.cdn":{"id":"cdn","namespace":"hosting.web","description":"CDN service","properties":{"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Domain of this CDN","required":false},"free":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Option CDN free with the hosting ?","required":false},"status":{"type":"hosting.web.cdn.StatusEnum","fullType":"hosting.web.cdn.StatusEnum","canBeNull":false,"readOnly":true,"description":"Status of the CDN option","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this CDN","required":false},"type":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Type of the CDN","required":false},"version":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Version of the CDN","required":false}}},"hosting.web.cdn.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.cdn","description":"CDN status","enum":["created","creating","deleting","flushing","reopening","suspended","suspending"],"enumType":"string"},"hosting.web.configuration":{"id":"configuration","namespace":"hosting.web","description":"The Configuration of an hosting Power offer","properties":{"appEnv":{"type":"hosting.web.configuration.EnvEnum","fullType":"hosting.web.configuration.EnvEnum","canBeNull":false,"readOnly":false,"description":"Application environment","required":false},"entryPoint":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Application launch script","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Id of the current configuration","required":false},"language":{"type":"hosting.web.configuration.LanguageEnum","fullType":"hosting.web.configuration.LanguageEnum","canBeNull":false,"readOnly":false,"description":"language chosen for the current hosting","required":false},"publicDir":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Directory of the application","required":false},"status":{"type":"hosting.web.configuration.StateEnum","fullType":"hosting.web.configuration.StateEnum","canBeNull":false,"readOnly":true,"description":"Status of current configuration","required":false},"version":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"version of the language chosen for the current hosting","required":false}}},"hosting.web.configuration.EnvEnum":{"id":"EnvEnum","namespace":"hosting.web.configuration","description":"Configuration env enum","enum":["development","production"],"enumType":"string"},"hosting.web.configuration.LanguageEnum":{"id":"LanguageEnum","namespace":"hosting.web.configuration","description":"Configuration languages enum","enum":["nodejs","python","ruby"],"enumType":"string"},"hosting.web.configuration.StateEnum":{"id":"StateEnum","namespace":"hosting.web.configuration","description":"Configuration state enum","enum":["created","creating","deleting","updating"],"enumType":"string"},"hosting.web.configuration.VersionEnum":{"id":"VersionEnum","namespace":"hosting.web.configuration","description":"Configuration language versions enum","enum":["nodejs-12","nodejs-14","python-3.7","python-3.8","python-3.9","ruby-2.6","ruby-2.7"],"enumType":"string"},"hosting.web.cron":{"id":"cron","namespace":"hosting.web","description":"Hosting crons","properties":{"command":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Command to execute","required":false},"description":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Description field for you","required":false},"email":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Email used to receive error log ( stderr )","required":false},"frequency":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Frequency ( crontab format ) defined for the script ( minutes are ignored )","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Cron's id","required":false},"language":{"type":"hosting.web.cron.LanguageEnum","fullType":"hosting.web.cron.LanguageEnum","canBeNull":false,"readOnly":false,"description":"Cron language","required":false},"state":{"type":"hosting.web.cron.StateEnum","fullType":"hosting.web.cron.StateEnum","canBeNull":false,"readOnly":true,"description":"Cron state","required":false},"status":{"type":"hosting.web.cron.StatusEnum","fullType":"hosting.web.cron.StatusEnum","canBeNull":false,"readOnly":false,"description":"Cron status","required":false}}},"hosting.web.cron.LanguageEnum":{"id":"LanguageEnum","namespace":"hosting.web.cron","description":"Cron's language","enum":["node10","node11","node12","node14","node8","node9","other","php4","php5.2","php5.3","php5.4","php5.5","php5.6","php7.0","php7.1","php7.2","php7.3","php7.4","php8.0","php8.1","php8.2","php8.3","php8.4","php8.5","python2","python3","ruby2.6"],"enumType":"string"},"hosting.web.cron.StateEnum":{"id":"StateEnum","namespace":"hosting.web.cron","description":"Cron state","enum":["created","creating","deleting","updating"],"enumType":"string"},"hosting.web.cron.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.cron","description":"Cron status","enum":["disabled","enabled","suspended"],"enumType":"string"},"hosting.web.database":{"id":"database","namespace":"hosting.web","description":"Database","properties":{"databaseServiceDeprecated":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether service database is deprecated","required":false},"databaseType":{"type":"hosting.web.database.DatabaseServiceTypeEnum","fullType":"hosting.web.database.DatabaseServiceTypeEnum","canBeNull":true,"readOnly":true,"description":"Database service type","required":false},"dumps":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"The number of available dumps associated to this database","required":false},"guiURL":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"URL for the graphical user interface","required":false},"lastCheck":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Date of the last check quota","required":false},"mode":{"type":"hosting.web.database.ModeEnum","fullType":"hosting.web.database.ModeEnum","canBeNull":false,"readOnly":true,"description":"Mode of your database","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":false},"port":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"The port on where to contact this database","required":false},"quotaSize":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":false,"readOnly":true,"description":"Space allowed","required":false},"quotaUsed":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":false,"readOnly":true,"description":"Space used","required":false},"server":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Your database server name","required":false},"sqlpersoId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Which SQLPerso this database is linked to (if any)","required":false},"state":{"type":"hosting.web.database.StateEnum","fullType":"hosting.web.database.StateEnum","canBeNull":false,"readOnly":true,"description":"Database state","required":false},"status":{"type":"hosting.web.database.StatusEnum","fullType":"hosting.web.database.StatusEnum","canBeNull":false,"readOnly":true,"description":"The database status","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this database","required":false},"type":{"type":"hosting.web.database.DatabaseTypeEnum","fullType":"hosting.web.database.DatabaseTypeEnum","canBeNull":false,"readOnly":true,"description":"Type of your database","required":false},"user":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Database user name","required":false},"version":{"type":"hosting.web.database.VersionEnum","fullType":"hosting.web.database.VersionEnum","canBeNull":false,"readOnly":true,"description":"Database version following the database type","required":false},"versionSupport":{"type":"hosting.web.database.SupportedVersionEnum","fullType":"hosting.web.database.SupportedVersionEnum","canBeNull":false,"readOnly":true,"description":"Indicates the current support state of your database version","required":false}}},"hosting.web.database.AvailableVersionStruct":{"id":"AvailableVersionStruct","namespace":"hosting.web.database","description":"Database Available and Default version","properties":{"default":{"type":"hosting.web.database.VersionEnum","canBeNull":false,"readOnly":false,"description":"Database default version","required":false},"list":{"type":"hosting.web.database.VersionEnum[]","canBeNull":false,"readOnly":false,"description":"Database available version","required":false}}},"hosting.web.database.CreationDatabaseCapabilities":{"id":"CreationDatabaseCapabilities","namespace":"hosting.web.database","description":"Struct which describs quota and available for a specific type of database","properties":{"available":{"type":"long","canBeNull":false,"readOnly":false,"description":"Number of database left for creation","required":false},"engines":{"type":"hosting.web.database.DatabaseTypeEnum[]","canBeNull":false,"readOnly":false,"description":"Database software available on this platform","required":false},"isolation":{"type":"hosting.web.database.DatabaseIsolationEnum","canBeNull":false,"readOnly":false,"description":"Technology use to isolate differents webhosting accounts","required":false},"quota":{"type":"complexType.UnitAndValue<long>","canBeNull":false,"readOnly":false,"description":"Size of data can be used","required":false},"type":{"type":"hosting.web.database.DatabaseCapabilitiesTypeEnum","canBeNull":false,"readOnly":false,"description":"Database offer name","required":false}}},"hosting.web.database.DatabaseCapabilities":{"id":"DatabaseCapabilities","namespace":"hosting.web.database","description":"Struct which describe available features for a database","properties":{"changePassword":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Availability of the changePassword function","required":false},"changeRight":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Availability of the changeRight function","required":false},"delete":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Availability of the delete function","required":false},"dump":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Availability of the dump function","required":false},"getQuota":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Availability of the getQuota function","required":false},"getRight":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Availability of the getQuota function","required":false},"guiURL":{"type":"string","canBeNull":false,"readOnly":false,"description":"URL of the database management tool","required":false},"optimize":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Availability of the optimize function","required":false},"restore":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Availability of the restore function","required":false}}},"hosting.web.database.DatabaseCapabilitiesTypeEnum":{"id":"DatabaseCapabilitiesTypeEnum","namespace":"hosting.web.database","description":"Database capabitities type enum","enum":["extraSqlPerso","local","privateDatabase","sqlLocal","sqlPerso","sqlPro"],"enumType":"string"},"hosting.web.database.DatabaseCreationTypeEnum":{"id":"DatabaseCreationTypeEnum","namespace":"hosting.web.database","description":"Database Type enum","enum":["mariadb","mysql","postgresql","redis"],"enumType":"string"},"hosting.web.database.DatabaseIsolationEnum":{"id":"DatabaseIsolationEnum","namespace":"hosting.web.database","description":"Database Isolation enum","enum":["dedicated","local","shared"],"enumType":"string"},"hosting.web.database.DatabaseServiceTypeEnum":{"id":"DatabaseServiceTypeEnum","namespace":"hosting.web.database","description":"Database Service Type enum","enum":["extra","included","optional"],"enumType":"string"},"hosting.web.database.DatabaseTypeEnum":{"id":"DatabaseTypeEnum","namespace":"hosting.web.database","description":"Database Type enum","enum":["mariadb","mongodb","mysql","postgresql","redis"],"enumType":"string"},"hosting.web.database.ExtraSqlQuotaEnum":{"id":"ExtraSqlQuotaEnum","namespace":"hosting.web.database","description":"ExtraSqlPerso quota enum","enum":["25","100","200","256","400","512","800","1024"],"enumType":"long"},"hosting.web.database.MetricsToken":{"id":"MetricsToken","namespace":"hosting.web.database","description":"A structure describing the metrics token result","properties":{"endpoint":{"type":"string","canBeNull":false,"readOnly":false,"description":"The url of the endpoint","required":false},"token":{"type":"password","canBeNull":false,"readOnly":false,"description":"The token value","required":false}}},"hosting.web.database.ModeEnum":{"id":"ModeEnum","namespace":"hosting.web.database","description":"Database mode","enum":["besteffort","classic","module"],"enumType":"string"},"hosting.web.database.RequestActionEnum":{"id":"RequestActionEnum","namespace":"hosting.web.database","description":"Types of action you can request for your database","enum":["CHECK_QUOTA"],"enumType":"string"},"hosting.web.database.StateEnum":{"id":"StateEnum","namespace":"hosting.web.database","description":"Database state","enum":["close","ok","readonly"],"enumType":"string"},"hosting.web.database.StatisticsTypeEnum":{"id":"StatisticsTypeEnum","namespace":"hosting.web.database","description":"Types of statistics available for the database","enum":["statement","statementMeanTime"],"enumType":"string"},"hosting.web.database.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.database","description":"Database status","enum":["checking","created","creating","deleting","dumping","importing","locked","optimizing","restoring","updating"],"enumType":"string"},"hosting.web.database.SupportedVersionEnum":{"id":"SupportedVersionEnum","namespace":"hosting.web.database","description":"Indicates the current support state of your database version","enum":["beta","deprecated","stable"],"enumType":"string"},"hosting.web.database.VersionEnum":{"id":"VersionEnum","namespace":"hosting.web.database","description":"Database Version enum","enum":["10","10.1","10.11","10.2","10.3","10.4","10.5","10.6","11","12","13","15","3.2","3.4","4.0","5.1","5.5","5.6","5.7","6.0","7.0","8.0","8.4","9.4","9.5","9.6"],"enumType":"string"},"hosting.web.database.copy":{"id":"database.copy","namespace":"hosting.web","description":"Copy","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date","required":false},"expirationDate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Expiration date","required":false},"id":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Copy id","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last update date","required":false},"status":{"type":"hosting.web.database.copy.StatusEnum","fullType":"hosting.web.database.copy.StatusEnum","canBeNull":false,"readOnly":true,"description":"Copy status","required":false}}},"hosting.web.database.copy.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.database.copy","description":"Database copy status","enum":["doing","done","error","todo"],"enumType":"string"},"hosting.web.database.dump":{"id":"database.dump","namespace":"hosting.web","description":"Dump","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date of the dump","required":false},"deletionDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Automatic deletion date of the dump","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Dump id","required":false},"status":{"type":"hosting.web.database.dump.StatusEnum","fullType":"hosting.web.database.dump.StatusEnum","canBeNull":false,"readOnly":true,"description":"The dump status","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this dump","required":false},"type":{"type":"hosting.web.database.dump.DateEnum","fullType":"hosting.web.database.dump.DateEnum","canBeNull":false,"readOnly":true,"description":"Dump type","required":false},"url":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Dump url access","required":false}}},"hosting.web.database.dump.DateEnum":{"id":"DateEnum","namespace":"hosting.web.database.dump","description":"List of dump types","enum":["daily.1","now","weekly.1"],"enumType":"string"},"hosting.web.database.dump.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.database.dump","description":"Database dump status","enum":["created","creating","deleting"],"enumType":"string"},"hosting.web.dump":{"id":"dump","namespace":"hosting.web","description":"Dump","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date of the dump","required":false},"databaseName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Source database name","required":false},"deletionDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Automatic deletion date of the dump","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Dump id","required":false},"orphan":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"If source database was deleted","required":false},"status":{"type":"hosting.web.database.dump.StatusEnum","fullType":"hosting.web.database.dump.StatusEnum","canBeNull":false,"readOnly":true,"description":"The dump status","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this dump","required":false},"type":{"type":"hosting.web.database.dump.DateEnum","fullType":"hosting.web.database.dump.DateEnum","canBeNull":false,"readOnly":true,"description":"Dump type","required":false},"url":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Dump url access","required":false}}},"hosting.web.email":{"id":"email","namespace":"hosting.web","description":"Hosting automated emails","properties":{"bounce":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Bounce","required":false},"email":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Email used to receive errors","required":false},"maxPerDay":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Max email to sent per day","required":false},"sent":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Email sent since hosting creation","required":false},"sentToday":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Email sent today","required":false},"spoofing":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Spoofing Bounce","required":false},"state":{"type":"hosting.web.mail.StateEnum","fullType":"hosting.web.mail.StateEnum","canBeNull":false,"readOnly":true,"description":"Email state","required":false}}},"hosting.web.emailoption":{"id":"emailoption","namespace":"hosting.web","description":"Mail service linked to webhosting","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date","required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Email service domain","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Account id","required":false}}},"hosting.web.envVar":{"id":"envVar","namespace":"hosting.web","description":"Environment variables set into your webhosting account","properties":{"key":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Name of the variable","required":false},"status":{"type":"hosting.web.envVar.StatusEnum","fullType":"hosting.web.envVar.StatusEnum","canBeNull":false,"readOnly":true,"description":"The environnement variable status","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this variable","required":false},"type":{"type":"hosting.web.envVar.TypeEnum","fullType":"hosting.web.envVar.TypeEnum","canBeNull":false,"readOnly":true,"description":"Type of variable set","required":false},"value":{"type":"password","fullType":"password","canBeNull":false,"readOnly":false,"description":"Value of the variable","required":false}}},"hosting.web.envVar.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.envVar","description":"EnvVar status","enum":["created","creating","deleting","updating"],"enumType":"string"},"hosting.web.envVar.TypeEnum":{"id":"TypeEnum","namespace":"hosting.web.envVar","description":"Filter the value of type property (=)","enum":["integer","password","string"],"enumType":"string"},"hosting.web.extrasqlperso":{"id":"extrasqlperso","namespace":"hosting.web","description":"Sqlperso service","properties":{"database":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of database allowed by this option","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Identifier of the (additional) SQL slot","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The extraSqlPerso option name","required":false},"serviceName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Billing name of the matching subscription (or internal naming otherwise)","required":false},"size":{"type":"complexType.UnitAndValue<double>","fullType":"complexType.UnitAndValue<double>","canBeNull":false,"readOnly":true,"description":"Quota size allowed per each database by this option","required":false},"status":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The extraSqlPerso option status","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this extraSqlPerso","required":false},"usage":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"Linked databases","required":false}}},"hosting.web.freedom.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.freedom","description":"FreeDom status","enum":["blockedByCustomer","blockedBySystem","ok","preset"],"enumType":"string"},"hosting.web.hostedssl.ProviderEnum":{"id":"ProviderEnum","namespace":"hosting.web.hostedssl","description":"Hosted SSL Provider","enum":["COMODO","CUSTOM","LETSENCRYPT","SECTIGO"],"enumType":"string"},"hosting.web.hostedssl.ReportStatusEnum":{"id":"ReportStatusEnum","namespace":"hosting.web.hostedssl","description":"Hosted SSL report status","enum":["completed","in-progress","non-completed","non-required","not-applicable","not-provided"],"enumType":"string"},"hosting.web.hostedssl.ReportValueEnum":{"id":"ReportValueEnum","namespace":"hosting.web.hostedssl","description":"Hostedssl report value","enum":["completed","in-progress","non-completed","non-required","not-applicable","not-provided"],"enumType":"string"},"hosting.web.hostedssl.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.hostedssl","description":"Hosted SSL status","enum":["created","creating","deleting","importing","regenerating"],"enumType":"string"},"hosting.web.hostedssl.TypeEnum":{"id":"TypeEnum","namespace":"hosting.web.hostedssl","description":"Hosted SSL type","enum":["CUSTOM","DV","EV"],"enumType":"string"},"hosting.web.indy":{"id":"indy","namespace":"hosting.web","description":"Hosting indys","properties":{"attachedDomains":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"AttachedDomain IDs linked to this multidomain","required":false},"home":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Home directory","required":false},"login":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Login of the multidomain independent user","required":false},"state":{"type":"hosting.web.user.StateEnum","fullType":"hosting.web.user.StateEnum","canBeNull":false,"readOnly":true,"description":"User status","required":false}}},"hosting.web.localSeo.DirectoriesList":{"id":"DirectoriesList","namespace":"hosting.web.localSeo","description":"Struct describing a list of directories ordered by type","properties":{"navigationSystems":{"type":"hosting.web.localSeo.Directory[]","canBeNull":false,"readOnly":false,"description":"Navigation systems","required":false},"searchEngines":{"type":"hosting.web.localSeo.Directory[]","canBeNull":false,"readOnly":false,"description":"Search engines","required":false},"socialNetworks":{"type":"hosting.web.localSeo.Directory[]","canBeNull":false,"readOnly":false,"description":"Social networks","required":false}}},"hosting.web.localSeo.Directory":{"id":"Directory","namespace":"hosting.web.localSeo","description":"Struct describing a directory","properties":{"code":{"type":"string","canBeNull":false,"readOnly":false,"description":"Identifier to use to get the result of a visibility check for the directory","required":false},"displayName":{"type":"string","canBeNull":false,"readOnly":false,"description":"Human-readable name of the directory","required":false}}},"hosting.web.localSeo.EmailAvailability":{"id":"EmailAvailability","namespace":"hosting.web.localSeo","description":"Struct describing the availability of an email address for a local SEO order","properties":{"availability":{"type":"hosting.web.localSeo.account.EmailAvailabilityEnum","canBeNull":false,"readOnly":false,"description":"Availability of the email address","required":false},"serviceName":{"type":"string","canBeNull":true,"readOnly":false,"description":"Hosting on which the email address is used","required":false}}},"hosting.web.localSeo.FieldStatusEnum":{"id":"FieldStatusEnum","namespace":"hosting.web.localSeo","description":"Sync status of a location field","enum":["MATCH","MISMATCH","MISSING","NOT_APPLICABLE","PRESENT"],"enumType":"string"},"hosting.web.localSeo.FlowStatusEnum":{"id":"FlowStatusEnum","namespace":"hosting.web.localSeo","description":"Status of a listing","enum":["ALL_INFORMATION_SUBMITTED","DONT_REMOVE","INACTIVE","MANUALLY_DEACTIVATED","NEEDS_REVIEW","NOT_SUPPORTED","NO_ACTION_NEEDED","REMOVAL_NEEDED","REMOVAL_REVIEW_NEEDED","REMOVAL_SUBMITTED","REMOVED","SUBMISSION_NEEDED","WAITING_DIRECTORY_ACTION","WAITING_USER_ACTION"],"enumType":"string"},"hosting.web.localSeo.ListingStatusEnum":{"id":"ListingStatusEnum","namespace":"hosting.web.localSeo","description":"Sync status of a listing","enum":["IN_SYNC","NOT_FOUND","NOT_IN_SYNC","NOT_SUPPORTED","NO_ONLINE_LISTING","TECHNICAL_PROBLEMS"],"enumType":"string"},"hosting.web.localSeo.SearchData":{"id":"SearchData","namespace":"hosting.web.localSeo","description":"Struct describing a location being checked for visibility","properties":{"city":{"type":"string","canBeNull":false,"readOnly":false,"description":"City of the location","required":false},"country":{"type":"string","canBeNull":false,"readOnly":false,"description":"Country of the location","required":false},"id":{"type":"long","canBeNull":false,"readOnly":false,"description":"Id of the search","required":false},"name":{"type":"string","canBeNull":false,"readOnly":false,"description":"Name of the location","required":false},"province":{"type":"string","canBeNull":true,"readOnly":false,"description":"Province of the location","required":false},"street":{"type":"string","canBeNull":false,"readOnly":false,"description":"Street of the location","required":false},"streetNo":{"type":"string","canBeNull":false,"readOnly":false,"description":"Street numero of the location","required":false},"token":{"type":"string","canBeNull":false,"readOnly":false,"description":"Token to use to get the results of the search","required":false},"zip":{"type":"string","canBeNull":false,"readOnly":false,"description":"Zipcode of the location","required":false}}},"hosting.web.localSeo.VisibilityCheckResponse":{"id":"VisibilityCheckResponse","namespace":"hosting.web.localSeo","description":"Struct describing the response for a visibility check request","properties":{"alreadyManaged":{"type":"boolean","canBeNull":true,"readOnly":false,"description":"Is the searched location already managed ?","required":false},"searchData":{"type":"hosting.web.localSeo.SearchData","canBeNull":false,"readOnly":false,"description":"Searched location data","required":false}}},"hosting.web.localSeo.VisibilityCheckResultResponse":{"id":"VisibilityCheckResultResponse","namespace":"hosting.web.localSeo","description":"Struct describing a visibility check result","properties":{"city":{"type":"string","canBeNull":true,"readOnly":false,"description":"City of the location","required":false},"cityStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"City of the location (sync status)","required":false},"country":{"type":"string","canBeNull":true,"readOnly":false,"description":"Country of the location","required":false},"countryStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"Country of the location (sync status)","required":false},"dateCreated":{"type":"datetime","canBeNull":true,"readOnly":false,"description":"The date and time the listing was created in database","required":false},"directoryType":{"type":"string","canBeNull":true,"readOnly":false,"description":"The directory where this listing appears","required":false},"email":{"type":"string","canBeNull":true,"readOnly":false,"description":"A contact email for the location","required":false},"emailStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"A contact email for the location (sync status)","required":false},"flowStatus":{"type":"hosting.web.localSeo.FlowStatusEnum","canBeNull":true,"readOnly":false,"description":"The status of the current listing","required":false},"listingId":{"type":"string","canBeNull":true,"readOnly":false,"description":"The listing id in the directory database","required":false},"listingUrl":{"type":"string","canBeNull":true,"readOnly":false,"description":"The listing url on the directory website","required":false},"name":{"type":"string","canBeNull":true,"readOnly":false,"description":"The location's name used for this listing","required":false},"nameStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"The location's name used for this listing (sync status)","required":false},"phone":{"type":"string","canBeNull":true,"readOnly":false,"description":"The location's contact phone number","required":false},"phoneStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"The location's contact phone number (sync status)","required":false},"province":{"type":"string","canBeNull":true,"readOnly":false,"description":"Province of the location","required":false},"provinceStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"Province of the location (sync status)","required":false},"street":{"type":"string","canBeNull":true,"readOnly":false,"description":"The location's street address","required":false},"streetAndNo":{"type":"string","canBeNull":true,"readOnly":false,"description":"A localized combination of street and streetNo","required":false},"streetAndNoStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"A localized combination of street and streetNo (sync status)","required":false},"streetNo":{"type":"string","canBeNull":true,"readOnly":false,"description":"The location's street number","required":false},"streetNoStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"The location's street number (sync status)","required":false},"streetStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"The location's street address (sync status)","required":false},"streetType":{"type":"string","canBeNull":true,"readOnly":false,"description":"The street type for Spain","required":false},"streetTypeStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"The street type for Spain (sync status)","required":false},"syncStatus":{"type":"hosting.web.localSeo.ListingStatusEnum","canBeNull":true,"readOnly":false,"description":"The sync status of the listing","required":false},"website":{"type":"string","canBeNull":true,"readOnly":false,"description":"A valid url for the location's website","required":false},"websiteStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"A valid url for the location's website (sync status)","required":false},"zip":{"type":"string","canBeNull":true,"readOnly":false,"description":"Zipcode of the location","required":false},"zipStatus":{"type":"hosting.web.localSeo.FieldStatusEnum","canBeNull":true,"readOnly":false,"description":"Zipcode of the location (sync status)","required":false}}},"hosting.web.localSeo.account":{"id":"localSeo.account","namespace":"hosting.web","description":"Local SEO accounts","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date of creation of the account","required":false},"email":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Email address associated to the account","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Account id","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date of the last account's update","required":false},"status":{"type":"hosting.web.localSeo.account.StatusEnum","fullType":"hosting.web.localSeo.account.StatusEnum","canBeNull":false,"readOnly":true,"description":"Current status of the account","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Running task associated to the account","required":false}}},"hosting.web.localSeo.account.EmailAvailabilityEnum":{"id":"EmailAvailabilityEnum","namespace":"hosting.web.localSeo.account","description":"Availability of an email address for a local SEO order","enum":["available","merge","nic","taken"],"enumType":"string"},"hosting.web.localSeo.account.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.localSeo.account","description":"Account status","enum":["created","creating","deleting","updating"],"enumType":"string"},"hosting.web.localSeo.location":{"id":"localSeo.location","namespace":"hosting.web","description":"Local SEO locations","properties":{"accountId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Account id","required":false},"address":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Address of the location","required":false},"country":{"type":"hosting.web.localSeo.location.CountryEnum","fullType":"hosting.web.localSeo.location.CountryEnum","canBeNull":false,"readOnly":true,"description":"Country of the location","required":false},"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date of the installation of the location","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Location id","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date of the last location's update","required":false},"name":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Name of the location","required":false},"offer":{"type":"hosting.web.localSeo.location.OfferEnum","fullType":"hosting.web.localSeo.location.OfferEnum","canBeNull":false,"readOnly":true,"description":"Local SEO offer for this location","required":false},"status":{"type":"hosting.web.localSeo.location.StatusEnum","fullType":"hosting.web.localSeo.location.StatusEnum","canBeNull":false,"readOnly":true,"description":"Current status of the location","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Running task associated to the location","required":false}}},"hosting.web.localSeo.location.CountryEnum":{"id":"CountryEnum","namespace":"hosting.web.localSeo.location","description":"Location country","enum":["FR"],"enumType":"string"},"hosting.web.localSeo.location.OfferEnum":{"id":"OfferEnum","namespace":"hosting.web.localSeo.location","description":"Location offer","enum":["normal"],"enumType":"string"},"hosting.web.localSeo.location.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.localSeo.location","description":"Location status","enum":["created","creating","deleting","updating"],"enumType":"string"},"hosting.web.mail.ActionEnum":{"id":"ActionEnum","namespace":"hosting.web.mail","description":"Types of action you can request for your mail","enum":["BLOCK","PURGE","UNBLOCK"],"enumType":"string"},"hosting.web.mail.Bounce":{"id":"Bounce","namespace":"hosting.web.mail","description":"The volume history type","properties":{"date":{"type":"datetime","canBeNull":false,"readOnly":false,"description":"The datetime of this bounce","required":false},"isSpoofing":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"Whether this bounce is spoofing or not","required":false},"message":{"type":"string","canBeNull":true,"readOnly":false,"description":"The return message for this bounce","required":false},"to":{"type":"string","canBeNull":true,"readOnly":false,"description":"The email where you have the bounce","required":false}}},"hosting.web.mail.StateEnum":{"id":"StateEnum","namespace":"hosting.web.mail","description":"Mail state enum","enum":["bounce","force","ko","ok","purging","spam"],"enumType":"string"},"hosting.web.mail.VolumeHistory":{"id":"VolumeHistory","namespace":"hosting.web.mail","description":"The volume history type","properties":{"date":{"type":"datetime","canBeNull":false,"readOnly":false,"description":"The datetime of this volume history point","required":false},"volume":{"type":"long","canBeNull":true,"readOnly":false,"description":"The volume history size","required":false}}},"hosting.web.module":{"id":"module","namespace":"hosting.web","description":"Hosting modules installed","properties":{"adminFolder":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The admin folder, relative to the module's installation path","required":false},"adminName":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Login for the admin account","required":false},"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date of the installation of the module","required":false},"dependencies":{"type":"hosting.web.module.DependencyType[]","fullType":"hosting.web.module.DependencyType[]","canBeNull":false,"readOnly":true,"description":"The dependencies to which the module has access. A dependency can be a standard database (like MySQL or PostgreSQL) or a key-value store (like Redis or Memcached) for example","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Installation ID","required":false},"language":{"type":"hosting.web.module.LanguageEnum","fullType":"hosting.web.module.LanguageEnum","canBeNull":false,"readOnly":true,"description":"The language of the module","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date of the last module's upgrade","required":false},"moduleId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"ID of the module associated with this installation","required":false},"path":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Where the module is installed, relative to your home directory","required":false},"status":{"type":"hosting.web.module.StatusEnum","fullType":"hosting.web.module.StatusEnum","canBeNull":false,"readOnly":true,"description":"The module status","required":false},"targetUrl":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The URL from where your module can be reached","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this module","required":false}}},"hosting.web.module.AdminNameTypeEnum":{"id":"AdminNameTypeEnum","namespace":"hosting.web.module","description":"The type of the admin name","enum":["email","string"],"enumType":"string"},"hosting.web.module.BranchEnum":{"id":"BranchEnum","namespace":"hosting.web.module","description":"Branch enum","enum":["old","stable","testing"],"enumType":"string"},"hosting.web.module.DependencyType":{"id":"DependencyType","namespace":"hosting.web.module","description":"Dependency parameters. A dependency can be a standard database (like MySQL or PostgreSQL) or a key-value store (like Redis or Memcached) for example","properties":{"name":{"type":"string","canBeNull":true,"readOnly":false,"description":"The name of this dependency","required":false},"password":{"type":"password","canBeNull":true,"readOnly":false,"description":"The password associated with the user","required":false},"port":{"type":"long","canBeNull":true,"readOnly":false,"description":"The port on where to contact this dependency","required":false},"prefix":{"type":"string","canBeNull":true,"readOnly":false,"description":"The prefix to set to the data to distinguish between the data from the module and the rest","required":false},"server":{"type":"string","canBeNull":true,"readOnly":false,"description":"The server on where your dependency is hosted","required":false},"type":{"type":"hosting.web.module.DependencyTypeEnum","canBeNull":false,"readOnly":false,"description":"Type","required":false},"user":{"type":"string","canBeNull":true,"readOnly":false,"description":"The user to use to connect to this dependency","required":false}}},"hosting.web.module.DependencyTypeEnum":{"id":"DependencyTypeEnum","namespace":"hosting.web.module","description":"The type of the dependency. A dependency can be a standard database (like MySQL or PostgreSQL) or a key-value store (like Redis or Memcached) for example","enum":["mysql"],"enumType":"string"},"hosting.web.module.LanguageEnum":{"id":"LanguageEnum","namespace":"hosting.web.module","description":"Install language","enum":["cz","de","en","es","fi","fr","it","lt","nl","pl","pt"],"enumType":"string"},"hosting.web.module.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.module","description":"Module status","enum":["created","creating","deleting","updating"],"enumType":"string"},"hosting.web.ovhConfig":{"id":"ovhConfig","namespace":"hosting.web","description":"Virtual service","properties":{"container":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Container to run this website","required":false},"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"When ovhconfig was created, or found for the first time, on the hosting servers","required":false},"engineName":{"type":"hosting.web.ovhConfig.EngineNameEnum","fullType":"hosting.web.ovhConfig.EngineNameEnum","canBeNull":false,"readOnly":true,"description":"Version of engine you want","required":false},"engineVersion":{"type":"hosting.web.ovhConfig.EngineVersionEnum","fullType":"hosting.web.ovhConfig.EngineVersionEnum","canBeNull":false,"readOnly":true,"description":"Name of engine you want","required":false},"environment":{"type":"hosting.web.ovhConfig.EnvironmentEnum","fullType":"hosting.web.ovhConfig.EnvironmentEnum","canBeNull":false,"readOnly":true,"description":"Environment configuration you want","required":false},"fileExist":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"If .ovhConfig exists","required":false},"historical":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":true,"description":"If this configuration is an old configuration","required":false},"httpFirewall":{"type":"hosting.web.ovhConfig.HttpFirewallEnum","fullType":"hosting.web.ovhConfig.HttpFirewallEnum","canBeNull":false,"readOnly":true,"description":"Configuration you want for http firewall","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Configuration's id","required":false},"path":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Config path, relative to your home directory","required":false},"status":{"type":"hosting.web.ovhConfig.StatusEnum","fullType":"hosting.web.ovhConfig.StatusEnum","canBeNull":false,"readOnly":true,"description":"The configuration status","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this configuration","required":false}}},"hosting.web.ovhConfig.AvailableEngineVersionEnum":{"id":"AvailableEngineVersionEnum","namespace":"hosting.web.ovhConfig","description":"Hosting available configuration version","enum":["5.4","5.5","5.6","7.0","7.1","7.2","7.3","7.4","8.0","8.1","8.2","8.3","8.4","8.5"],"enumType":"string"},"hosting.web.ovhConfig.EngineNameEnum":{"id":"EngineNameEnum","namespace":"hosting.web.ovhConfig","description":"Hosting configuration engine","enum":["php","phpcgi"],"enumType":"string"},"hosting.web.ovhConfig.EngineVersionEnum":{"id":"EngineVersionEnum","namespace":"hosting.web.ovhConfig","description":"Hosting configuration version","enum":["4.4","5.0","5.1","5.2","5.3","5.4","5.5","5.6","7.0","7.1","7.2","7.3","7.4","8.0","8.1","8.2","8.3","8.4","8.5","AUTO"],"enumType":"string"},"hosting.web.ovhConfig.EnvironmentEnum":{"id":"EnvironmentEnum","namespace":"hosting.web.ovhConfig","description":"Hosting configuration environment","enum":["development","production"],"enumType":"string"},"hosting.web.ovhConfig.HttpFirewallEnum":{"id":"HttpFirewallEnum","namespace":"hosting.web.ovhConfig","description":"Hosting configuration firewall","enum":["none","security"],"enumType":"string"},"hosting.web.ovhConfig.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.ovhConfig","description":"Ovhconfig status","enum":["created","rollbacking","updating"],"enumType":"string"},"hosting.web.ovhconfig.ContainerEnum":{"id":"ContainerEnum","namespace":"hosting.web.ovhconfig","description":"Hosting configuration image to run website","enum":["jessie.i386","legacy","stable","stable64","testing"],"enumType":"string"},"hosting.web.ownLogs":{"id":"ownLogs","namespace":"hosting.web","description":"Hosting own logs","properties":{"fqdn":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The ownlogs fqdn available on logs.clusterXX.hosting.ovh.net","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Identifier of this ownLogs","required":false},"logs":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"URL to access this ownLogs logs","required":false},"stats":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"URL to access this ownLogs stats","required":false},"status":{"type":"hosting.web.ownLogs.StatusEnum","fullType":"hosting.web.ownLogs.StatusEnum","canBeNull":false,"readOnly":true,"description":"Status of this ownLogs","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this ownLogs","required":false}}},"hosting.web.ownLogs.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.ownLogs","description":"OwnLogs status","enum":["created","creating","deleting"],"enumType":"string"},"hosting.web.runtime":{"id":"runtime","namespace":"hosting.web","description":"The runtime configuration of an attached domain for cloud web offer","properties":{"appBootstrap":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"The client application bootstrap script","required":false},"appEnv":{"type":"hosting.web.runtime.EnvEnum","fullType":"hosting.web.runtime.EnvEnum","canBeNull":false,"readOnly":false,"description":"The client application environment","required":false},"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"The creation date of the runtime configuration","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"The runtime configuration ID","required":false},"isDefault":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Is the runtime configuration is the one by default for the hosting","required":false},"isDeletable":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Return if the runtime configuration can be deleted","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"The last update date of the runtime configuration","required":false},"name":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"The custom display name of the runtime configuration","required":false},"publicDir":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"The client application public directory","required":false},"status":{"type":"hosting.web.runtime.StateEnum","fullType":"hosting.web.runtime.StateEnum","canBeNull":false,"readOnly":true,"description":"The status of the runtime","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The link current task for the runtime configuration","required":false},"type":{"type":"hosting.web.runtime.TypeEnum","fullType":"hosting.web.runtime.TypeEnum","canBeNull":false,"readOnly":false,"description":"The backend type of the runtime","required":false}}},"hosting.web.runtime.EnvEnum":{"id":"EnvEnum","namespace":"hosting.web.runtime","description":"Runtime env enum","enum":["development","production"],"enumType":"string"},"hosting.web.runtime.StateEnum":{"id":"StateEnum","namespace":"hosting.web.runtime","description":"Runtime state enum","enum":["created","creating","deleting","updating"],"enumType":"string"},"hosting.web.runtime.TypeEnum":{"id":"TypeEnum","namespace":"hosting.web.runtime","description":"Runtime backend type enum","enum":["nodejs-10","nodejs-11","nodejs-12","nodejs-14","nodejs-8","nodejs-9","phpfpm-5.6","phpfpm-7.0","phpfpm-7.1","phpfpm-7.2","phpfpm-7.3","phpfpm-7.4","phpfpm-8.0","python-2","python-3","ruby-2.6"],"enumType":"string"},"hosting.web.ssl":{"id":"ssl","namespace":"hosting.web","description":"Hostedssl","properties":{"isReportable":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"If the hostedssl is currently bound to a report","required":false},"provider":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Provider of the HostedSsl","required":false},"regenerable":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Regenerable flag","required":false},"status":{"type":"hosting.web.hostedssl.StatusEnum","fullType":"hosting.web.hostedssl.StatusEnum","canBeNull":false,"readOnly":true,"description":"Status of the HostedSsl","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this HostedSsl","required":false},"type":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Type of the HostedSsl","required":false}}},"hosting.web.ssl.Report":{"id":"Report","namespace":"hosting.web.ssl","description":"Hosted SSL report","properties":{"certificateSigningRequestStatus":{"type":"hosting.web.hostedssl.ReportStatusEnum","fullType":"hosting.web.hostedssl.ReportStatusEnum","canBeNull":false,"readOnly":true,"description":"\"Certificate signing request\" test status done by certification authority","required":false},"domainControlValidationStatus":{"type":"hosting.web.hostedssl.ReportStatusEnum","fullType":"hosting.web.hostedssl.ReportStatusEnum","canBeNull":false,"readOnly":true,"description":"\"Domain control validation\" test status done by certification authority","required":false},"organizationValidationStatus":{"type":"hosting.web.hostedssl.ReportStatusEnum","fullType":"hosting.web.hostedssl.ReportStatusEnum","canBeNull":false,"readOnly":true,"description":"Applicant's legal status obtained or verified directly with registration agency","required":false},"phoneCallApprovalStatus":{"type":"hosting.web.hostedssl.ReportStatusEnum","fullType":"hosting.web.hostedssl.ReportStatusEnum","canBeNull":false,"readOnly":true,"description":"Approval verified through a phone call to the contract signer","required":false},"providerOrderId":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The order ID from given hostedssl provider","required":false},"termsAndConditionsAcceptanceStatus":{"type":"hosting.web.hostedssl.ReportStatusEnum","fullType":"hosting.web.hostedssl.ReportStatusEnum","canBeNull":false,"readOnly":true,"description":"Terms and conditions agreements acceptance","required":false},"tradeNameVerificationStatus":{"type":"hosting.web.hostedssl.ReportStatusEnum","fullType":"hosting.web.hostedssl.ReportStatusEnum","canBeNull":false,"readOnly":true,"description":"Trade name verified directly with registration agency or through a verified third party","required":false}}},"hosting.web.ssl.report":{"id":"ssl.report","namespace":"hosting.web","description":"Hostedssl Report","properties":{"certificateSigningRequestStatus":{"type":"hosting.web.hostedssl.ReportValueEnum","fullType":"hosting.web.hostedssl.ReportValueEnum","canBeNull":false,"readOnly":true,"description":"\"Certificate signing request\" test status done by certification authority","required":false},"domainControlValidationStatus":{"type":"hosting.web.hostedssl.ReportValueEnum","fullType":"hosting.web.hostedssl.ReportValueEnum","canBeNull":false,"readOnly":true,"description":"\"Domain control validation\" test status done by certification authority","required":false},"organizationValidationStatus":{"type":"hosting.web.hostedssl.ReportValueEnum","fullType":"hosting.web.hostedssl.ReportValueEnum","canBeNull":false,"readOnly":true,"description":"Applicant's legal status obtained or verified directly with registration agency","required":false},"phoneCallApprovalStatus":{"type":"hosting.web.hostedssl.ReportValueEnum","fullType":"hosting.web.hostedssl.ReportValueEnum","canBeNull":false,"readOnly":true,"description":"Approval verified through a phone call to the contract signer","required":false},"providerOrderId":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The order ID from given hostedssl provider","required":false},"termsAndConditionsAcceptanceStatus":{"type":"hosting.web.hostedssl.ReportValueEnum","fullType":"hosting.web.hostedssl.ReportValueEnum","canBeNull":false,"readOnly":true,"description":"Terms and conditions agreements acceptance","required":false},"tradeNameVerificationStatus":{"type":"hosting.web.hostedssl.ReportValueEnum","fullType":"hosting.web.hostedssl.ReportValueEnum","canBeNull":false,"readOnly":true,"description":"Trade name verified directly with registration agency or through a verified third party","required":false}}},"hosting.web.task":{"id":"task","namespace":"hosting.web","description":"Tasks","properties":{"doneDate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Completion date","required":false},"function":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Function name","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"the id of the task","required":false},"lastUpdate":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"last update","required":false},"objectId":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Task related object ID","required":false},"objectType":{"type":"hosting.web.task.ObjectTypeEnum","fullType":"hosting.web.task.ObjectTypeEnum","canBeNull":true,"readOnly":true,"description":"Task object type","required":false},"startDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Task Creation date","required":false},"status":{"type":"hosting.web.task.StatusEnum","fullType":"hosting.web.task.StatusEnum","canBeNull":false,"readOnly":true,"description":"Task status","required":false}}},"hosting.web.task.FunctionEnum":{"id":"FunctionEnum","namespace":"hosting.web.task","description":"Task function enum","enum":["abuse/close","abuse/create","abuse/create/web","abuse/delete/web","abuse/update","abuse/update/web","agora/AnycastUpdateReference","agora/DnsAddonUpdateReference","agora/DnsUpdateReference","agora/updateReference","attachedDomain/create","attachedDomain/delete","attachedDomain/restart","attachedDomain/update","cdn/delete","cdn/domain/create","cdn/domain/delete","cdn/domain/flush","cdn/domain/suspend","cdn/flush","cdn/install","cdn/reopen","cdn/suspend","cdn/upgrade","cluster/setDevelopment","cluster/setTesting","cluster/ssl/deploy","cluster/ssl/renew","cluster/test/attachedDomains","cluster/test/cdn","cluster/test/crons","cluster/test/emails","cluster/test/fileBrowser","cluster/test/hostedssl","cluster/test/modules","cluster/test/ovhConfig","cluster/test/userLogs","cluster/test/users","configuration/create","configuration/delete","configuration/update","cron/create","cron/delete","cron/update","database/changePassword","database/changePasswordTest","database/changeRight","database/changeRightTest","database/checkQuotaNow","database/copy","database/copyRestore","database/create","database/delete","database/deleteTest","database/dumpAnyDay","database/hostUpdate","database/import","database/optimize","database/restore","dedicatedIp/delete","dedicatedIp/reopen","dedicatedIp/suspend","depc/push","dump/create","dump/delete","envVar/create","envVar/delete","envVar/update","envVar/upgrade","eventbus/push","filerz/customerMonitoring","filerz/delete","hostedssl/assignFreeKey","hostedssl/cdn/update","hostedssl/create","hostedssl/delete","hostedssl/globalsign/delete","hostedssl/htaccess/install","hostedssl/import","hostedssl/install","hostedssl/install/sectigo","hostedssl/iplb/reload","hostedssl/push","hostedssl/pushDcvFile","hostedssl/regenerate","hostedssl/repush","hosting/activate/privateDatabase","hosting/basculement","hosting/changeOffer/cloud","hosting/changeOffer/shared","hosting/changement","hosting/delete","hosting/delete_start1m","hosting/install","hosting/reopen","hosting/suspend","indy/reopen","indy/suspend","infra/certificate/deploy","infra/certificate/generate","infra/certificate/install","infra/sharedsql/upgrade","infra/ssl/deploy","infra/ssl/renew","ip/move","ip/park","localSeoAccount/create","localSeoAccount/delete","localSeoLocation/delete","localSeoLocation/install","localSeoLocation/reopen","localSeoLocation/suspend","localSeoVisibilityCheck/process","mailsout/checkMailsoutQueue","mailsout/flushMailsoutQueue","mailsout/updateUserInRedis","migration/copyUsers","migration/dday/filerz","migration/dday/listPrivateDatabases","migration/dday/lot","migration/dday/updateInfra/crons","migration/dday/updateInfra/dedicated","migration/dday/updateInfra/migratedFqdn","migration/updateOrt","module/changePassword","module/create","module/delete","module/install","monitoring/remotewrite","notification/send","ovhConfig/refresh","ovhConfig/rollback","ovhConfig/update","ovhOrg/delete","ownLogs/create","ownLogs/delete","provisionning/cdn","provisionning/cluster","provisionning/filerz","provisionning/filerz_log","provisionning/hosting","provisionning/ipfo","provisionning/ipifo","provisionning/iplb","provisionning/privatesql","provisionning/sharedsql","provisionning/ssl","provisionning/web","provisionning/webapp","runtime/create","runtime/delete","runtime/setDefault","runtime/update","scan/create","sqlperso/delete","sqlperso/install","sqlperso/reopen","sqlperso/suspend","synchronizeDepc/attachedDomain","synchronizeDepc/cluster","synchronizeDepc/database","synchronizeDepc/filer","synchronizeDepc/offer","synchronizeDepc/webd","test/migration","user/changePassword","user/create","user/delete","user/update","userLogs/changePassword","userLogs/create","userLogs/delete","uster/setTesting","web/changeDns","web/changeFilerz","web/changeFilerzWithCallback","web/changeJailState","web/changeOutState","web/changeState","web/changeWebState","web/checkQuotaNow","web/create","web/delete","web/deleteUser","web/restoreSnapshot","webProvisionning","webd/changeSlots","website/create","website/delete","website/deploy","website/vcs/create","website/vcs/delete","website/vcs/deploy"],"enumType":"string"},"hosting.web.task.ObjectTypeEnum":{"id":"ObjectTypeEnum","namespace":"hosting.web.task","description":"Object type enum","enum":["Abuse","AttachedDomain","BlockedIp","Cdn","Cron","Database","Deployment","Dump","EnvVar","Filerz","Hostedssl","Hosting","Indy","Infra","Minor","Module","Other","OvhConfig","OvhOrg","OwnLogs","Runtime","Scan","Sqlperso","User","UserLogs","Web","Webd","Website"],"enumType":"string"},"hosting.web.task.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.task","description":"Task status enum","enum":["cancelled","doing","done","init","todo"],"enumType":"string"},"hosting.web.user":{"id":"user","namespace":"hosting.web","description":"Hosting users","properties":{"home":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Home directory","required":false},"isPrimaryAccount":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is this user primary","required":false},"login":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Login used to connect on FTP and SSH","required":false},"serviceManagementCredentials":{"type":"hosting.web.user.ServiceCredentials","fullType":"hosting.web.user.ServiceCredentials","canBeNull":false,"readOnly":true,"description":"Credentials to manage your webhosting","required":false},"sshState":{"type":"hosting.web.user.SshStateEnum","fullType":"hosting.web.user.SshStateEnum","canBeNull":false,"readOnly":false,"description":"User ssh status","required":false},"state":{"type":"hosting.web.user.StateEnum","fullType":"hosting.web.user.StateEnum","canBeNull":false,"readOnly":false,"description":"User state","required":false},"status":{"type":"hosting.web.user.StatusEnum","fullType":"hosting.web.user.StatusEnum","canBeNull":false,"readOnly":true,"description":"The user status","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this user","required":false}}},"hosting.web.user.Credentials":{"id":"Credentials","namespace":"hosting.web.user","description":"User, url and port of a service","properties":{"port":{"type":"long","canBeNull":false,"readOnly":false,"description":"Port to use to access to the service","required":false},"url":{"type":"string","canBeNull":false,"readOnly":false,"description":"Url to contact the service","required":false},"user":{"type":"string","canBeNull":false,"readOnly":false,"description":"Login to authentificate you on the service","required":false}}},"hosting.web.user.ServiceCredentials":{"id":"ServiceCredentials","namespace":"hosting.web.user","description":"Different credentials to manage your service","properties":{"ftp":{"type":"hosting.web.user.Credentials","canBeNull":false,"readOnly":false,"description":"Credentials to manage files by ftp","required":false},"ssh":{"type":"hosting.web.user.Credentials","canBeNull":false,"readOnly":false,"description":"Credentials to manage webhosting by ssh","required":false}}},"hosting.web.user.SshStateEnum":{"id":"SshStateEnum","namespace":"hosting.web.user","description":"Account's ssh state","enum":["active","none","sftponly"],"enumType":"string"},"hosting.web.user.StateEnum":{"id":"StateEnum","namespace":"hosting.web.user","description":"Account's state","enum":["off","rw"],"enumType":"string"},"hosting.web.user.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.user","description":"User status","enum":["created","creating","deleting","updating"],"enumType":"string"},"hosting.web.userLogs":{"id":"userLogs","namespace":"hosting.web","description":"Hosting users logs","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date of the user creation","required":false},"description":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Description field for you","required":false},"login":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The userLogs login used to connect to logs.ovh.net","required":false},"ownLogsId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"OwnLogs where this userLogs will be enable. Default : main domain ownlogs","required":false},"status":{"type":"hosting.web.userLogs.StatusEnum","fullType":"hosting.web.userLogs.StatusEnum","canBeNull":false,"readOnly":true,"description":"Status of this userLogs","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"The task ID working on this userLogs","required":false}}},"hosting.web.userLogs.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.userLogs","description":"UserLogs status","enum":["created","creating","deleting","updating"],"enumType":"string"},"hosting.web.website.CreationRequest":{"id":"CreationRequest","namespace":"hosting.web.website","description":"Information needed to create a new website","properties":{"path":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Relative path on the hosting filesystem the website will be deployed into","required":true},"vcsBranch":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Branch of the repository containing the website source code to deploy","required":true},"vcsUrl":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Clone URL of the repository containing the website source code to deploy","required":true}}},"hosting.web.website.Deployment":{"id":"Deployment","namespace":"hosting.web.website","description":"A website deployment","properties":{"date":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date of the deployment","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Deployment numeric identifier","required":false},"reset":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether a reset was requested before deploying","required":false},"source":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Source which triggered the deployment","required":false},"status":{"type":"hosting.web.website.deployment.StatusEnum","fullType":"hosting.web.website.deployment.StatusEnum","canBeNull":false,"readOnly":true,"description":"Current status of the deployment","required":false},"vcsBranch":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Which branch of the repository is deployed","required":false},"vcsCommitId":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Identifier of the last commit after deployment","required":false},"vcsCommitMessage":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Message of the last commit after deployment","required":false},"websiteId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Website numeric identifier","required":false}}},"hosting.web.website.DeploymentRequest":{"id":"DeploymentRequest","namespace":"hosting.web.website","description":"Information needed to request deployment of a website","properties":{"reset":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Whether a reset was requested before deploying","required":false}}},"hosting.web.website.Domain":{"id":"Domain","namespace":"hosting.web.website","description":"A website domain","properties":{"cdn":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"If the CDN is currently active","required":false},"fqdn":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"FQDN of the website domain","required":false},"ssl":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"If the SSL is currently active","required":false}}},"hosting.web.website.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.website","description":"Website status","enum":["created","creating","deleting","deploying","error","initialError"],"enumType":"string"},"hosting.web.website.Update":{"id":"Update","namespace":"hosting.web.website","description":"Information to update on a website","properties":{"vcsBranch":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Branch of the repository containing the website source code to deploy","required":false}}},"hosting.web.website.deployment.LogsMessage":{"id":"LogsMessage","namespace":"hosting.web.website.deployment","description":"Message from logs of a website deployment","properties":{"date":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Date of the message","required":false},"message":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Content of the message","required":false}}},"hosting.web.website.deployment.StatusEnum":{"id":"StatusEnum","namespace":"hosting.web.website.deployment","description":"Website deployment status","enum":["doing","failed","successful"],"enumType":"string"},"iam.ResourceMetadata":{"id":"ResourceMetadata","namespace":"iam","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Resource display name","required":false},"id":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Unique identifier of the resource","required":false},"state":{"type":"iam.ResourceMetadata.StateEnum","fullType":"iam.ResourceMetadata.StateEnum","canBeNull":true,"readOnly":true,"description":"Resource state","required":false},"tags":{"type":"map[string]string","fullType":"map[string]string","canBeNull":true,"readOnly":true,"description":"Resource tags. Tags that were internally computed are prefixed with ovh:","required":false},"urn":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Unique resource name used in policies","required":false}}},"iam.ResourceMetadata.StateEnum":{"id":"StateEnum","namespace":"iam.ResourceMetadata","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"],"enumType":"string"},"iam.resource.TagFilter":{"id":"TagFilter","namespace":"iam.resource","description":"Resource tag filter","properties":{"operator":{"type":"iam.resource.TagFilter.OperatorEnum","fullType":"iam.resource.TagFilter.OperatorEnum","canBeNull":true,"readOnly":true,"description":"Operator to use in order to filter on the value (defaults to 'EQ')","required":false},"value":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Value to use in order to filter tags","required":false}}},"iam.resource.TagFilter.OperatorEnum":{"id":"OperatorEnum","namespace":"iam.resource.TagFilter","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"],"enumType":"string"},"order.CurrencyCodeEnum":{"id":"CurrencyCodeEnum","namespace":"order","description":"Currency code","enum":["AUD","CAD","CZK","EUR","GBP","INR","LTL","MAD","N/A","PLN","SGD","TND","USD","XOF","points"],"enumType":"string"},"order.Price":{"id":"Price","namespace":"order","description":"Price with its currency and textual representation","properties":{"currencyCode":{"type":"order.CurrencyCodeEnum","fullType":"order.CurrencyCodeEnum","canBeNull":false,"readOnly":true,"description":"Currency code","required":false},"priceInUcents":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"Price in microcents","required":false},"text":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Textual representation","required":false},"value":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"description":"The effective price","required":false}}},"service.RenewType":{"id":"RenewType","namespace":"service","description":"Map a possible renew for a specific service","properties":{"automatic":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"The service is automatically renewed","required":false},"deleteAtExpiration":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"The service will be deleted at expiration","required":false},"forced":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"The service forced to be renewed","required":false},"manualPayment":{"type":"boolean","fullType":"boolean","canBeNull":true,"readOnly":false,"description":"The service needs to be manually renewed and paid","required":false},"period":{"type":"long","fullType":"long","canBeNull":true,"readOnly":false,"description":"period of renew in month","required":false}}},"service.RenewalTypeEnum":{"id":"RenewalTypeEnum","namespace":"service","description":"Detailed renewal type of a service","enum":["automaticForcedProduct","automaticV2012","automaticV2014","automaticV2016","manual","oneShot","option"],"enumType":"string"},"service.StateEnum":{"id":"StateEnum","namespace":"service","description":"service.StateEnum","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"],"enumType":"string"},"service.TerminationFutureUseEnum":{"id":"TerminationFutureUseEnum","namespace":"service","description":"All future uses you can provide for a service termination","enum":["NOT_REPLACING_SERVICE","OTHER","SUBSCRIBE_AN_OTHER_SERVICE","SUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITOR","SUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITOR"],"enumType":"string"},"service.TerminationReasonEnum":{"id":"TerminationReasonEnum","namespace":"service","description":"All reasons you can provide for a service termination","enum":["FEATURES_DONT_SUIT_ME","LACK_OF_PERFORMANCES","MIGRATED_TO_ANOTHER_OVH_PRODUCT","MIGRATED_TO_COMPETITOR","NOT_ENOUGH_RECOGNITION","NOT_NEEDED_ANYMORE","NOT_RELIABLE","NO_ANSWER","OTHER","PRODUCT_DIMENSION_DONT_SUIT_ME","PRODUCT_TOOLS_DONT_SUIT_ME","TOO_EXPENSIVE","TOO_HARD_TO_USE","UNSATIFIED_BY_CUSTOMER_SUPPORT"],"enumType":"string"},"services.Service":{"id":"Service","namespace":"services","description":"Details about a Service","properties":{"canDeleteAtExpiration":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Indicates that the service can be set up to be deleted at expiration","required":false},"contactAdmin":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"contactBilling":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"contactTech":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"creation":{"type":"date","fullType":"date","canBeNull":false,"readOnly":true,"required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"engagedUpTo":{"type":"date","fullType":"date","canBeNull":true,"readOnly":true,"required":false},"expiration":{"type":"date","fullType":"date","canBeNull":false,"readOnly":true,"required":false},"possibleRenewPeriod":{"type":"long[]","fullType":"long[]","canBeNull":true,"readOnly":true,"description":"All the possible renew period of your service in month","required":false},"renew":{"type":"service.RenewType","fullType":"service.RenewType","canBeNull":true,"readOnly":false,"description":"Way of handling the renew","required":false},"renewalType":{"type":"service.RenewalTypeEnum","fullType":"service.RenewalTypeEnum","canBeNull":false,"readOnly":true,"required":false},"serviceId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"status":{"type":"service.StateEnum","fullType":"service.StateEnum","canBeNull":false,"readOnly":true,"required":false}}},"services.changeContact":{"id":"changeContact","namespace":"services","description":"Service change contact payload","properties":{"contactAdmin":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"The contact to set as admin contact","required":false},"contactBilling":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"The contact to set as billing contact","required":false},"contactTech":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"The contact to set as tech contact","required":false}}},"services.confirmTermination":{"id":"confirmTermination","namespace":"services","description":"Service confirm termination payload","properties":{"commentary":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Commentary about your termination request","required":false},"commentaryFutureUse":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Commentary about your future use","required":false},"commentaryReason":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Commentary about your reason for termination request","required":false},"futureUse":{"type":"service.TerminationFutureUseEnum","fullType":"service.TerminationFutureUseEnum","canBeNull":false,"readOnly":false,"description":"All future uses you can provide for a service termination","required":false},"reason":{"type":"service.TerminationReasonEnum","fullType":"service.TerminationReasonEnum","canBeNull":false,"readOnly":false,"description":"All reasons you can provide for a service termination","required":false},"token":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"The termination token sent by email to the admin contact","required":true}}}}}